Merge pull request #196 from censys/adh/update-delete-comments

feat(api): Update and Delete Comment Support

Author: thehappydinoa

censys/search/v2/api.py

@@ -317,6 +317,34 @@ def add_comment(self, document_id: str, contents: str) -> dict:
             self.view_path + document_id + "/comments", data={"contents": contents}
         )["result"]
 
+    def delete_comment(self, document_id: str, comment_id: str) -> dict:
+        """Delete comment from a document.
+
+        Args:
+            document_id (str): The ID of the document you are requesting.
+            comment_id (str): The ID of the comment you are requesting.
+
+        Returns:
+            dict: The result set returned.
+        """
+        return self._delete(self.view_path + document_id + "/comments/" + comment_id)
+
+    def update_comment(self, document_id: str, comment_id: str, contents: str) -> dict:
+        """Update comment from a document.
+
+        Args:
+            document_id (str): The ID of the document you are requesting.
+            comment_id (str): The ID of the comment you are requesting.
+            contents (str): The contents of the comment.
+
+        Returns:
+            dict: The result set returned.
+        """
+        return self._put(
+            self.view_path + document_id + "/comments/" + comment_id,
+            data={"contents": contents},
+        )
+
     # Tags
 
     def list_all_tags(self) -> List[dict]:

docs/usage-v2.rst

@@ -197,6 +197,34 @@ Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHo
     comment = h.add_comment("1.1.1.1", "This is a test comment")
     print(comment)
 
+``update_comment``
+^^^^^^^^^^^^^^^^^^
+
+Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
+
+.. code:: python
+
+    from censys.search import CensysHosts
+
+    h = CensysHosts()
+
+    # Update a comment to a host.
+    comment = h.update_comment("1.1.1.1", 101, "This is an updated test comment")
+
+``delete_comment``
+^^^^^^^^^^^^^^^^^^
+
+Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
+
+.. code:: python
+
+    from censys.search import CensysCerts
+
+    c = CensysCerts()
+
+    # Delete a comment for a certificate.
+    c.delete_comment("fb444eb8e68437bae06232b9f5091bccff62a768ca09e92eb5c9c2cf9d17c426", 102)
+
 Tags
 ----
 

tests/search/v2/test_comments.py

@@ -78,3 +78,22 @@ def test_add_comment(self):
         )
         results = self.api.add_comment(self.document_id, TEST_COMMENT)
         assert results == ADD_COMMENTS_RESPONSE["result"]
+
+    def test_delete_comment(self):
+        self.responses.add(
+            responses.DELETE,
+            f"{self.base_url}/{self.index}/{self.document_id}/comments/comment-id",
+            status=209,
+        )
+        self.api.delete_comment(self.document_id, "comment-id")
+
+    def test_update_comment(self):
+        self.responses.add(
+            responses.PUT,
+            f"{self.base_url}/{self.index}/{self.document_id}/comments/comment-id",
+            status=200,
+            json={"code": 200, "status": "OK"},
+            match=[responses.json_params_matcher({"contents": TEST_COMMENT})],
+        )
+        results = self.api.update_comment(self.document_id, "comment-id", TEST_COMMENT)
+        assert results == {"code": 200, "status": "OK"}