: add task comments tests; docs: add API links to new methods

Author: FaizaJibril

crowdin_api/api_resources/tasks/resource.py

@@ -958,6 +958,9 @@ def list_task_comments(
     ):
         """
         List Task Comments.
+
+        Link to documentation:
+        https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.comments.getMany
         """
 
         projectId = projectId or self.get_project_id()
@@ -978,6 +981,9 @@ def add_task_comment(
     ):
         """
         Add Task Comment.
+
+        Link to documentation:
+        https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.comments.post
         """
 
         projectId = projectId or self.get_project_id()
@@ -996,6 +1002,9 @@ def get_task_comment(
     ):
         """
         Get Task Comment.
+
+        Link to documentation:
+        https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.comments.get
         """
 
         projectId = projectId or self.get_project_id()
@@ -1015,6 +1024,9 @@ def delete_task_comment(
     ):
         """
         Delete Task Comment.
+
+        Link to documentation:
+        https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.comments.delete
         """
 
         projectId = projectId or self.get_project_id()
@@ -1035,6 +1047,9 @@ def edit_task_comment(
     ):
         """
         Edit Task Comment.
+
+        Link to documentation:
+        https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.comments.patch
         """
 
         projectId = projectId or self.get_project_id()

crowdin_api/api_resources/tasks/tests/test_tasks_resources.py

@@ -1327,6 +1327,97 @@ def test_edit_task_archived_status(self, m_request, base_absolut_url):
             request_data=[{"op": "replace", "path": "/isArchived", "value": False}],
         )
 
+    # --- Task comments ---
+    @pytest.mark.parametrize(
+        "incoming_data, path",
+        (
+            ({"projectId": 1, "taskId": 2}, "projects/1/tasks/2/comments"),
+            (
+                {"projectId": 1, "taskId": 2, "taskCommentId": 3},
+                "projects/1/tasks/2/comments/3",
+            ),
+        ),
+    )
+    def test_get_task_comments_path(self, incoming_data, path, base_absolut_url):
+        resource = self.get_resource(base_absolut_url)
+        assert resource.get_task_comments_path(**incoming_data) == path
+
+    @pytest.mark.parametrize(
+        "incoming_data, request_params",
+        (
+            ({}, {"orderBy": None, "offset": 0, "limit": 25}),
+            ({"orderBy": Sorting([])}, {"orderBy": Sorting([]), "offset": 0, "limit": 25}),
+        ),
+    )
+    @mock.patch("crowdin_api.requester.APIRequester.request")
+    def test_list_task_comments(self, m_request, incoming_data, request_params, base_absolut_url):
+        m_request.return_value = "response"
+
+        resource = self.get_resource(base_absolut_url)
+        assert resource.list_task_comments(projectId=1, taskId=2, **incoming_data) == "response"
+        m_request.assert_called_once_with(
+            method="get",
+            params=request_params,
+            path=resource.get_task_comments_path(projectId=1, taskId=2),
+        )
+
+    @mock.patch("crowdin_api.requester.APIRequester.request")
+    def test_add_task_comment(self, m_request, base_absolut_url):
+        m_request.return_value = "response"
+
+        resource = self.get_resource(base_absolut_url)
+        assert resource.add_task_comment(projectId=1, taskId=2, text="hello") == "response"
+        m_request.assert_called_once_with(
+            method="post",
+            path=resource.get_task_comments_path(projectId=1, taskId=2),
+            request_data={"text": "hello"},
+        )
+
+    @mock.patch("crowdin_api.requester.APIRequester.request")
+    def test_get_task_comment(self, m_request, base_absolut_url):
+        m_request.return_value = "response"
+
+        resource = self.get_resource(base_absolut_url)
+        assert resource.get_task_comment(projectId=1, taskId=2, taskCommentId=3) == "response"
+        m_request.assert_called_once_with(
+            method="get",
+            path=resource.get_task_comments_path(projectId=1, taskId=2, taskCommentId=3),
+        )
+
+    @mock.patch("crowdin_api.requester.APIRequester.request")
+    def test_delete_task_comment(self, m_request, base_absolut_url):
+        m_request.return_value = "response"
+
+        resource = self.get_resource(base_absolut_url)
+        assert resource.delete_task_comment(projectId=1, taskId=2, taskCommentId=3) == "response"
+        m_request.assert_called_once_with(
+            method="delete",
+            path=resource.get_task_comments_path(projectId=1, taskId=2, taskCommentId=3),
+        )
+
+    @mock.patch("crowdin_api.requester.APIRequester.request")
+    def test_edit_task_comment(self, m_request, base_absolut_url):
+        m_request.return_value = "response"
+
+        data = [
+            {
+                "value": "new text",
+                "op": PatchOperation.REPLACE,
+                "path": "/text",
+            }
+        ]
+
+        resource = self.get_resource(base_absolut_url)
+        assert (
+            resource.edit_task_comment(projectId=1, taskId=2, taskCommentId=3, data=data)
+            == "response"
+        )
+        m_request.assert_called_once_with(
+            method="patch",
+            path=resource.get_task_comments_path(projectId=1, taskId=2, taskCommentId=3),
+            request_data=data,
+        )
+
 
 class TestEnterpriseTasksResource:
     resource_class = EnterpriseTasksResource