Merge pull request #254 from inloco/v2.11.0

Add support to custom properties on v2.11.0.

Author: brunoekferrari

README.md

@@ -24,14 +24,14 @@ And then add the artifact `incognia-api-client` **or** `incognia-api-client-shad
 <dependency>
   <groupId>com.incognia</groupId>
   <artifactId>incognia-api-client</artifactId>
-  <version>2.10.0</version>
+  <version>2.11.0</version>
 </dependency>
 ```
 ```xml
 <dependency>
   <groupId>com.incognia</groupId>
   <artifactId>incognia-api-client-shaded</artifactId>
-  <version>2.10.0</version>
+  <version>2.11.0</version>
 </dependency>
 ```
 
@@ -48,13 +48,13 @@ repositories {
 And then add the dependency
 ```gradle
 dependencies {
-     implementation 'com.incognia:incognia-api-client:2.10.0'
+     implementation 'com.incognia:incognia-api-client:2.11.0'
 }
 ```
 OR
 ```gradle
 dependencies {
-     implementation 'com.incognia:incognia-api-client-shaded:2.10.0'
+     implementation 'com.incognia:incognia-api-client-shaded:2.11.0'
 }
 ```
 

build.gradle

@@ -8,7 +8,7 @@ plugins {
 }
 
 group = "com.incognia"
-version = "2.10.0"
+version = "2.11.0"
 
 task createProjectVersionFile {
     def projectVersionDir = "$projectDir/src/main/java/com/incognia/api"
@@ -135,4 +135,4 @@ publishing {
 
 tasks.withType(PublishToMavenLocal) {
     dependsOn jar
-}
+}

src/main/java/com/incognia/api/IncogniaAPI.java

@@ -120,6 +120,7 @@ public SignupAssessment registerSignup(RegisterSignupRequest request) throws Inc
             .policyId(request.getPolicyId())
             .accountId(request.getAccountId())
             .additionalLocations(request.getAdditionalLocations())
+            .customProperties(request.getCustomProperties())
             .build();
     return tokenAwareNetworkingClient.doPost(
         "api/v2/onboarding/signups", postSignupRequestBody, SignupAssessment.class);

src/main/java/com/incognia/onboarding/PostSignupRequestBody.java

@@ -1,9 +1,12 @@
 package com.incognia.onboarding;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.incognia.common.AdditionalLocation;
 import com.incognia.common.Coordinates;
 import com.incognia.common.StructuredAddress;
+import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -22,4 +25,8 @@ public class PostSignupRequestBody {
   String policyId;
   String accountId;
   List<AdditionalLocation> additionalLocations;
+
+  @JsonInclude(JsonInclude.Include.NON_EMPTY)
+  @Builder.Default
+  Map<String, Object> customProperties = Collections.emptyMap();
 }

src/main/java/com/incognia/onboarding/RegisterSignupRequest.java

@@ -3,6 +3,7 @@
 import com.incognia.common.AdditionalLocation;
 import com.incognia.common.Address;
 import java.util.List;
+import java.util.Map;
 import lombok.Builder;
 import lombok.Value;
 import org.jetbrains.annotations.Nullable;
@@ -17,4 +18,5 @@ public class RegisterSignupRequest {
   String policyId;
   String accountId;
   List<AdditionalLocation> additionalLocations;
+  Map<String, Object> customProperties;
 }

src/test/java/com/incognia/api/IncogniaAPITest.java

@@ -74,13 +74,16 @@ void testRegisterSignup_whenDataIsValid() {
     String policyId = UUID.randomUUID().toString();
     String externalId = "external-id";
     Address address = AddressFixture.ADDRESS_ADDRESS_LINE;
+    Map<String, Object> map = new HashMap<>();
+    map.put("custom-property", "custom-value");
 
     TokenAwareDispatcher dispatcher = new TokenAwareDispatcher(token, CLIENT_ID, CLIENT_SECRET);
     dispatcher.setExpectedAddressLine(address.getAddressLine());
     dispatcher.setExpectedRequestToken(requestToken);
     dispatcher.setExpectedExternalId(externalId);
     dispatcher.setExpectedPolicyId(policyId);
     dispatcher.setExpectedAccountId(accountId);
+    dispatcher.setExpectedCustomProperties(map);
     mockServer.setDispatcher(dispatcher);
     RegisterSignupRequest registerSignupRequest =
         RegisterSignupRequest.builder()
@@ -89,6 +92,7 @@ void testRegisterSignup_whenDataIsValid() {
             .policyId(policyId)
             .externalId(externalId)
             .address(address)
+            .customProperties(map)
             .build();
     SignupAssessment signupAssessment = client.registerSignup(registerSignupRequest);
     assertThat(signupAssessment)
@@ -143,13 +147,15 @@ void testRegisterSignup_withEmptyAddress() {
     dispatcher.setExpectedExternalId(externalId);
     dispatcher.setExpectedPolicyId(policyId);
     dispatcher.setExpectedAccountId(accountId);
+    dispatcher.setExpectedCustomProperties(null);
     mockServer.setDispatcher(dispatcher);
     RegisterSignupRequest registerSignupRequest =
         RegisterSignupRequest.builder()
             .requestToken(requestToken)
             .accountId(accountId)
             .policyId(policyId)
             .externalId(externalId)
+            .customProperties(null)
             .build();
     SignupAssessment signupAssessment = client.registerSignup(registerSignupRequest);
     assertThat(signupAssessment)
@@ -254,6 +260,7 @@ void testRegisterSignup_whenEmptyRequestToken() {
                     RegisterSignupRequest.builder()
                         .requestToken("")
                         .address(AddressFixture.ADDRESS_ADDRESS_LINE)
+                        .customProperties(null)
                         .build()))
         .isInstanceOf(IllegalArgumentException.class)
         .hasMessage("'request token' cannot be empty");

src/test/java/com/incognia/api/clients/TokenAwareDispatcher.java

@@ -9,6 +9,7 @@
 import com.incognia.transaction.PostTransactionRequestBody;
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
+import java.util.Map;
 import java.util.UUID;
 import lombok.Getter;
 import lombok.Setter;
@@ -37,6 +38,7 @@ public class TokenAwareDispatcher extends Dispatcher {
   @Setter private String expectedAccountId;
   @Setter private String expectedPolicyId;
   @Setter private String expectedAddressLine;
+  @Setter private Map<String, Object> expectedCustomProperties;
   @Setter private String expectedSessionToken;
   @Setter private String expectedRequestToken;
   @Setter private UUID expectedSignupId;
@@ -139,6 +141,7 @@ private MockResponse handlePostSignup(@NotNull RecordedRequest request)
     assertThat(postSignupRequestBody.getExternalId()).isEqualTo(expectedExternalId);
     assertThat(postSignupRequestBody.getPolicyId()).isEqualTo(expectedPolicyId);
     assertThat(postSignupRequestBody.getAddressLine()).isEqualTo(expectedAddressLine);
+    assertThat(postSignupRequestBody.getCustomProperties()).isEqualTo(expectedCustomProperties);
     String response =
         ResourceUtils.getResourceFileAsString(
             postSignupRequestBody.getAddressLine() != null