Merge pull request #23 from sashirestela/22-adding-unit-tests-for-recent-changes

Adding unit tests for recent changes

Author: sashirestela

README.md

@@ -137,22 +137,25 @@ var cleverClient = CleverClient.builder()
 | POST       | Method    | POST endpoint's url         | optional       |
 | PUT        | Method    | PUT endpoint's url          | optional       |
 | DELETE     | Method    | DELETE endpoint's url       | optional       |
+| Header     | Method    | Header's name and value     | mandatory      |
 | Multipart  | Method    | (None)                      | none           |
 | Path       | Parameter | Path parameter name in url  | mandatory      |
 | Query      | Parameter | Query parameter name in url | mandatory      |
+| Query      | Parameter | (None for Pojos)            | none           |
 | Body       | Parameter | (None)                      | none           |
 
 * ```Resource``` could be used to separate the repeated part of the endpoints' url in an interface.
 * ```GET, POST, PUT, DELETE``` are used to mark the typical http methods (endpoints).
+* ```Header``` Used to include more headers (pairs of name and value) at method level.
 * ```Multipart``` is used to mark an endpoint with a multipart/form-data request. This is required when you need to upload files.
 * ```Path``` is used to replace the path parameter name in url with the matched method parameter's value.
-* ```Query``` is used to add a query parameter to the url in the way: [?]queryValue=parameterValue[&...].
+* ```Query``` is used to add a query parameter to the url in the way: [?]queryValue=parameterValue[&...] for scalar parameters. Also it can be used for Pojos using its properties and values.
 * ```Body``` is used to mark a method parameter as the endpoint's payload request, so the request will be application/json at least the endpoint is annotated with Multipart.
 * Check the above [Description's example](#💡-description) or the [Test](https://github.com/sashirestela/cleverclient/tree/main/src/test/java/io/github/sashirestela/cleverclient) folder to see more of these interface annotations in action.
 
 ### Supported Response Types
 
-The reponse types are determined from the method responses. We don't need any annotation for that. We have five response types: [Stream](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/stream/Stream.html) of objects, [List](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html) of objects, Generic of object, Single object, [Binary](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html) object, and Plain Text, and all of them can be asynchronous or synchronous. For async responses you have to use the Java class [CompletableFuture](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html).
+The reponse types are determined from the method responses. We don't need any annotation for that. We have six response types: [Stream](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/stream/Stream.html) of objects, [List](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html) of objects, Generic of object, Single object, [Binary](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html) object, and Plain Text, and all of them can be asynchronous or synchronous. For async responses you have to use the Java class [CompletableFuture](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html).
 
 | Method Response                     | Sync/Async | Response Type                           |
 |-------------------------------------|------------|-----------------------------------------|

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>io.github.sashirestela</groupId>
   <artifactId>cleverclient</artifactId>
-  <version>0.9.1</version>
+  <version>0.10.0</version>
   <packaging>jar</packaging>
 
   <name>cleverclient</name>

src/main/java/io/github/sashirestela/cleverclient/http/HttpProcessor.java

@@ -37,8 +37,7 @@ public HttpProcessor(HttpClient httpClient, String urlBase, List<String> headers
 
     /**
      * Creates a generic dynamic proxy with a new {@link HttpInvocationHandler
-     * HttpInvocationHandler}
-     * object which will resolve the requests.
+     * HttpInvocationHandler} object which will resolve the requests.
      * 
      * @param <T>            A generic interface.
      * @param interfaceClass Service of a generic interface

src/main/java/io/github/sashirestela/cleverclient/util/JsonUtil.java

@@ -2,7 +2,6 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -26,15 +25,6 @@ public class JsonUtil {
     private JsonUtil() {
     }
 
-    public static String objectsToJson(List<?> objects) {
-        Map<String, Object> jsonProperties = new HashMap<>();
-        for (Object obj : objects) {
-            jsonProperties.putAll(objectMapperStrict.convertValue(obj, jsonPropertiesTypeRef));
-        }
-
-        return objectToJson(jsonProperties);
-    }
-
     public static <T> Map<String, Object> objectToMap(T object) {
         try {
             return objectMapperStrict.convertValue(object, jsonPropertiesTypeRef);

src/test/java/io/github/sashirestela/cleverclient/http/ITest.java

@@ -8,6 +8,7 @@
 
 import io.github.sashirestela.cleverclient.annotation.Body;
 import io.github.sashirestela.cleverclient.annotation.GET;
+import io.github.sashirestela.cleverclient.annotation.Header;
 import io.github.sashirestela.cleverclient.annotation.Multipart;
 import io.github.sashirestela.cleverclient.annotation.POST;
 import io.github.sashirestela.cleverclient.annotation.Path;
@@ -58,6 +59,7 @@ interface AsyncService {
         CompletableFuture<Generic<Demo>> getGenericDemo(@Path("genericDemoId") Integer genericDemoId);
 
         @GET
+        @Header(name = "MyHeader", value = "MyValue")
         CompletableFuture<List<Demo>> getDemos();
 
         @POST
@@ -88,6 +90,7 @@ interface SyncService {
         Generic<Demo> getGenericDemo(@Path("genericDemoId") Integer genericDemoId);
 
         @GET
+        @Header(name = "MyHeader", value = "MyValue")
         List<Demo> getDemos();
 
         @POST

src/test/java/io/github/sashirestela/cleverclient/http/URLBuilderTest.java

@@ -9,6 +9,9 @@
 import java.util.Map;
 
 import io.github.sashirestela.cleverclient.metadata.MethodSignature;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+
 import org.junit.jupiter.api.Test;
 
 import io.github.sashirestela.cleverclient.metadata.Metadata;
@@ -103,4 +106,41 @@ void shouldReturnReplacedUrlWithQueryParamsWhenMethodContainsQueryParams() {
         var expectedUrl = "/api/domain/entities?sortedBy=name&rowsPerPage=20";
         assertEquals(expectedUrl, actualUrl);
     }
+
+    @Test
+    void shouldReturnReplacedUrlWithQueryParamsWhenMethodContainsQueryParamsForPojos() {
+        var methodName = "testMethod";
+        var url = "/api/domain/entities";
+        var paramsList = List.of(
+                Metadata.Parameter.builder()
+                        .index(0)
+                        .annotationValue("")
+                        .build(),
+                Metadata.Parameter.builder()
+                        .index(1)
+                        .annotationValue("sortedBy")
+                        .build());
+        var paramsMap = Map.of(
+                "Path", new ArrayList<Metadata.Parameter>(),
+                "Query", paramsList);
+        var methodMetadata = Metadata.Method.builder()
+                .name(methodName)
+                .url(url)
+                .parametersByType(paramsMap)
+                .build();
+        var mapMethods = Map.of(methodSign, methodMetadata);
+
+        when(metadata.getMethods()).thenReturn(mapMethods);
+
+        var actualUrl = urlBuilder.build(methodSign, new Object[] { new Pagination(10, 3), "fullname" });
+        var expectedUrl = "/api/domain/entities?size=10&page=3&sortedBy=fullname";
+        assertEquals(expectedUrl, actualUrl);
+    }
+
+    @Data
+    @AllArgsConstructor
+    static class Pagination {
+        private Integer size;
+        private Integer page;
+    }
 }

src/test/java/io/github/sashirestela/cleverclient/util/UnixTimestampDeserializerTest.java

@@ -0,0 +1,40 @@
+package io.github.sashirestela.cleverclient.util;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.time.Instant;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
+
+import org.junit.jupiter.api.Test;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+public class UnixTimestampDeserializerTest {
+
+    @Test
+    void testDeserialize() {
+        var jsonData = "{\"id\":1,\"description\":\"sample data\",\"time\":1700671053}";
+        var expectedTime = ZonedDateTime.ofInstant(Instant.ofEpochSecond(1700671053), ZoneId.systemDefault());
+        var actualObject = JsonUtil.jsonToObject(jsonData, SampleClass.class);
+        assertEquals(expectedTime, actualObject.getTime());
+    }
+
+    @AllArgsConstructor
+    @NoArgsConstructor
+    @Getter
+    static class SampleClass {
+
+        private Integer id;
+
+        private String description;
+
+        @JsonDeserialize(using = UnixTimestampDeserializer.class)
+        private ZonedDateTime time;
+
+    }
+}