feat(tasks): add support for task comments (#114)

Author: vorobeyme

crowdin/model/tasks.go

@@ -980,3 +980,45 @@ func (r *TaskSettingsTemplateAddRequest) Validate() error {
 
 	return nil
 }
+
+// TaskComment represents a comment on a task.
+type TaskComment struct {
+	ID        int    `json:"id"`
+	UserID    int    `json:"userId"`
+	TaskID    int    `json:"taskId"`
+	Text      string `json:"text"`
+	TimeSpent int    `json:"timeSpent"`
+	CreatedAt string `json:"createdAt"`
+	UpdatedAt string `json:"updatedAt"`
+}
+
+// TaskCommentResponse defines the structure of the response
+// when getting a task comment.
+type TaskCommentResponse struct {
+	Data *TaskComment `json:"data"`
+}
+
+// TaskCommentsListResponse defines the structure of the response
+// when getting a list of task comments.
+type TaskCommentsListResponse struct {
+	Data []*TaskCommentResponse `json:"data"`
+}
+
+// TaskCommentAddRequest defines the structure of the request
+// when adding a new comment to a task.
+type TaskCommentAddRequest struct {
+	// Comment text
+	Text string `json:"text,omitempty"`
+	// Specifies the time spent on the task in seconds
+	TimeSpent int `json:"timeSpent,omitempty"`
+}
+
+// Validate checks if the request is valid.
+// It implements the crowdin.Validator interface.
+func (r *TaskCommentAddRequest) Validate() error {
+	if r == nil {
+		return ErrNilRequest
+	}
+
+	return nil
+}

crowdin/model/tasks_test.go

@@ -765,3 +765,36 @@ func TestTasksService_Add_EnterprisePendingTaskCreateForm_WithRequestValidation(
 		})
 	}
 }
+
+func TestTaskCommentAddRequestValidate(t *testing.T) {
+	tests := []struct {
+		name  string
+		req   *TaskCommentAddRequest
+		err   string
+		valid bool
+	}{
+		{
+			name: "nil request",
+			req:  nil,
+			err:  "request cannot be nil",
+		},
+		{
+			name: "valid request",
+			req: &TaskCommentAddRequest{
+				Text:      "Work in task",
+				TimeSpent: 3600,
+			},
+			valid: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if err := tt.req.Validate(); tt.valid {
+				assert.NoError(t, err)
+			} else {
+				assert.EqualError(t, err, tt.err)
+			}
+		})
+	}
+}

crowdin/tasks.go

@@ -214,3 +214,67 @@ func (s *TasksService) EditSettingsTemplate(ctx context.Context, projectID, task
 func (s *TasksService) DeleteSettingsTemplate(ctx context.Context, projectID, taskSettingTemplateID int) (*Response, error) {
 	return s.client.Delete(ctx, fmt.Sprintf("/api/v2/projects/%d/tasks/settings-templates/%d", projectID, taskSettingTemplateID), nil)
 }
+
+// ListComments returns a list of task comments in a project.
+//
+// https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.getMany
+func (s *TasksService) ListComments(ctx context.Context, projectID, taskID int, opts *model.ListOptions) (
+	[]*model.TaskComment, *Response, error,
+) {
+	res := new(model.TaskCommentsListResponse)
+	resp, err := s.client.Get(ctx, fmt.Sprintf("/api/v2/projects/%d/tasks/%d/comments", projectID, taskID), opts, res)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	list := make([]*model.TaskComment, 0, len(res.Data))
+	for _, task := range res.Data {
+		list = append(list, task.Data)
+	}
+
+	return list, resp, err
+}
+
+// GetComment returns a single task comment in a project by its identifier.
+//
+// https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.get
+func (s *TasksService) GetComment(ctx context.Context, projectID, taskID, commentID int) (
+	*model.TaskComment, *Response, error,
+) {
+	path := fmt.Sprintf("/api/v2/projects/%d/tasks/%d/comments/%d", projectID, taskID, commentID)
+	res := new(model.TaskCommentResponse)
+	resp, err := s.client.Get(ctx, path, nil, res)
+
+	return res.Data, resp, err
+}
+
+// AddComment creates a new comment for a specific task in a project.
+//
+// https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.post
+func (s *TasksService) AddComment(ctx context.Context, projectID, taskID int, req *model.TaskCommentAddRequest) (
+	*model.TaskComment, *Response, error,
+) {
+	res := new(model.TaskCommentResponse)
+	resp, err := s.client.Post(ctx, fmt.Sprintf("/api/v2/projects/%d/tasks/%d/comments", projectID, taskID), req, res)
+
+	return res.Data, resp, err
+}
+
+// EditComment updates a comment for a specific task in a project by its identifier.
+//
+// https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.patch
+func (s *TasksService) EditComment(ctx context.Context, projectID, taskID, commentID int, req []*model.UpdateRequest) (
+	*model.TaskComment, *Response, error,
+) {
+	res := new(model.TaskCommentResponse)
+	resp, err := s.client.Patch(ctx, fmt.Sprintf("/api/v2/projects/%d/tasks/%d/comments/%d", projectID, taskID, commentID), req, res)
+
+	return res.Data, resp, err
+}
+
+// DeleteComment removes a comment from a specific task in a project by its identifier.
+//
+// https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.delete
+func (s *TasksService) DeleteComment(ctx context.Context, projectID, taskID, commentID int) (*Response, error) {
+	return s.client.Delete(ctx, fmt.Sprintf("/api/v2/projects/%d/tasks/%d/comments/%d", projectID, taskID, commentID), nil)
+}