wip: Keep field and sort direction in pojo class. Use List instead of Map

Author: korzol

src/main/java/com/crowdin/client/core/http/impl/util/SortOrderGenerator.java

@@ -0,0 +1,31 @@
+package com.crowdin.client.core.model;
+
+import com.crowdin.client.core.http.impl.util.RequestEncoder;
+import lombok.Data;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+@Data
+public class OrderByField {
+    private String fieldName;
+    private SortOrder orderBy;
+
+    public static String generateSortParam(List<OrderByField> fields) {
+        if (fields == null || fields.isEmpty()) {
+            return null;
+        }
+
+        String sortParam = fields.stream()
+                .map(field -> {
+                    if (field.getOrderBy() == null) {
+                        field.setOrderBy(SortOrder.ASC);
+                    }
+
+                    return field.getFieldName() + " " + field.getOrderBy().to(field.getOrderBy());
+                })
+                .collect(Collectors.joining(","));
+
+        return RequestEncoder.encodeSpaces(sortParam);
+    }
+}

src/main/java/com/crowdin/client/core/model/OrderByField.java

@@ -4,7 +4,6 @@
 import com.crowdin.client.core.http.HttpRequestConfig;
 import com.crowdin.client.core.http.exceptions.HttpBadRequestException;
 import com.crowdin.client.core.http.exceptions.HttpException;
-import com.crowdin.client.core.http.impl.util.SortOrderGenerator;
 import com.crowdin.client.core.model.*;
 import com.crowdin.client.tasks.model.*;
 
@@ -52,20 +51,20 @@ public ResponseList<Task> listTasks(Long projectId, Integer limit, Integer offse
      * @param offset starting offset in the collection (default 0)
      * @param status filter by status
      * @param assigneeId filter by assignee id
-     * @param orderBy sort keys and strategy
+     * @param orderBy list of OrderByField
      * @return list of tasks
      * @see <ul>
      * <li><a href="https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.getMany" target="_blank"><b>API Documentation</b></a></li>
      * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.tasks.getMany" target="_blank"><b>Enterprise API Documentation</b></a></li>
      * </ul>
      */
-    public ResponseList<Task> listTasks(Long projectId, Integer limit, Integer offset, Status status, Integer assigneeId, Map<String, SortOrder> orderBy) throws HttpException, HttpBadRequestException {
+    public ResponseList<Task> listTasks(Long projectId, Integer limit, Integer offset, Status status, Integer assigneeId, List<OrderByField> orderBy) throws HttpException, HttpBadRequestException {
         Map<String, Optional<Object>> queryParams = HttpRequestConfig.buildUrlParams(
                 "status", Optional.ofNullable(status),
                 "assigneeId", Optional.ofNullable(assigneeId),
                 "limit", Optional.ofNullable(limit),
                 "offset", Optional.ofNullable(offset),
-                "orderBy",  Optional.ofNullable(SortOrderGenerator.generateSortParam(orderBy))
+                "orderBy",  Optional.ofNullable(OrderByField.generateSortParam(orderBy))
         );
         TaskResponseList taskResponseList = this.httpClient.get(this.url + "/projects/" + projectId + "/tasks", new HttpRequestConfig(queryParams), TaskResponseList.class);
         return TaskResponseList.to(taskResponseList);

src/main/java/com/crowdin/client/tasks/TasksApi.java

@@ -95,9 +95,13 @@ public void listTasksTest_noSortDefined() {
 
     @Test
     public void listTasksTest_testSortByIdDefault() {
-        Map<String, SortOrder> orderBy = new LinkedHashMap<>();
-        orderBy.put("id", null);
-        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdAsc, null, null, null, null, orderBy);
+        OrderByField orderBy = new OrderByField();
+        orderBy.setFieldName("id");
+
+        List<OrderByField> orderByFields = new ArrayList<>();
+        orderByFields.add(orderBy);
+
+        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdAsc, null, null, null, null, orderByFields);
 
         assertNotNull(taskResponseList.getData().get(0).getData());
         assertEquals(2, taskResponseList.getData().size());
@@ -108,9 +112,14 @@ public void listTasksTest_testSortByIdDefault() {
 
     @Test
     public void listTasksTest_testSortByIdAsc() {
-        Map<String, SortOrder> orderBy = new LinkedHashMap<>();
-        orderBy.put("id", SortOrder.ASC);
-        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdAsc, null, null, null, null, orderBy);
+        OrderByField orderBy = new OrderByField();
+        orderBy.setFieldName("id");
+        orderBy.setOrderBy(SortOrder.ASC);
+
+        List<OrderByField> orderByFields = new ArrayList<>();
+        orderByFields.add(orderBy);
+
+        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdAsc, null, null, null, null, orderByFields);
 
         assertNotNull(taskResponseList.getData().get(0).getData());
         assertEquals(2, taskResponseList.getData().size());
@@ -121,10 +130,14 @@ public void listTasksTest_testSortByIdAsc() {
 
     @Test
     public void listTasksTest_testSortByIdDesc() {
-        Map<String, SortOrder> orderBy = new LinkedHashMap<>();
-        orderBy.put("id", SortOrder.DESC);
+        OrderByField orderBy = new OrderByField();
+        orderBy.setFieldName("id");
+        orderBy.setOrderBy(SortOrder.DESC);
 
-        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdDesc, null, null, null, null, orderBy);
+        List<OrderByField> orderByFields = new ArrayList<>();
+        orderByFields.add(orderBy);
+
+        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdDesc, null, null, null, null, orderByFields);
 
         assertNotNull(taskResponseList.getData().get(0).getData());
         assertEquals(2, taskResponseList.getData().size());
@@ -135,11 +148,18 @@ public void listTasksTest_testSortByIdDesc() {
 
     @Test
     public void listTasksTest_testSortByIdDescTitleAsc() {
-        Map<String, SortOrder> orderBy = new LinkedHashMap<>();
-        orderBy.put("id", SortOrder.DESC);
-        orderBy.put("title", null);
+        OrderByField orderByIdDesc = new OrderByField();
+        orderByIdDesc.setFieldName("id");
+        orderByIdDesc.setOrderBy(SortOrder.DESC);
+
+        OrderByField orderByTitleNull = new OrderByField();
+        orderByTitleNull.setFieldName("title");
+
+        List<OrderByField> orderByFields = new ArrayList<>();
+        orderByFields.add(orderByIdDesc);
+        orderByFields.add(orderByTitleNull);
 
-        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdDescTitleAsc, null, null, null, null, orderBy);
+        ResponseList<Task> taskResponseList = this.getTasksApi().listTasks(tasksProjectIdSortByIdDescTitleAsc, null, null, null, null, orderByFields);
 
         assertNotNull(taskResponseList.getData().get(0).getData());
         assertEquals(2, taskResponseList.getData().size());