SDK-2532: Update SessionSpec to use strongly typed object for Identity Profile subject

Author: MrBurtyyy

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/IdentityProfileSubjectPayload.java

@@ -0,0 +1,45 @@
+package com.yoti.api.client.docs.session.create;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class IdentityProfileSubjectPayload {
+
+    @JsonProperty("subject_id")
+    private final String subjectId;
+
+    IdentityProfileSubjectPayload(String subjectId) {
+        this.subjectId = subjectId;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public String getSubjectId() {
+        return subjectId;
+    }
+
+    public static class Builder {
+
+        private String subjectId;
+
+        Builder() {}
+
+        /**
+         * Sets the subject ID for the Identity Profile requirement
+         *
+         * @param subjectId the subject ID
+         * @return the builder
+         */
+        public Builder withSubjectId(String subjectId) {
+            this.subjectId = subjectId;
+            return this;
+        }
+
+        public IdentityProfileSubjectPayload build() {
+            return new IdentityProfileSubjectPayload(subjectId);
+        }
+
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/SessionSpec.java

@@ -62,7 +62,7 @@ public class SessionSpec {
     private final AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements;
 
     @JsonProperty(Property.SUBJECT)
-    private final Map<String, Object> subject;
+    private final IdentityProfileSubjectPayload subject;
 
     @JsonProperty(Property.RESOURCES)
     private final ResourceCreationContainer resources;
@@ -83,7 +83,7 @@ public class SessionSpec {
             IbvOptions ibvOptions,
             ZonedDateTime sessionDeadline,
             IdentityProfileRequirementsPayload identityProfile,
-            Map<String, Object> subject,
+            IdentityProfileSubjectPayload subject,
             ResourceCreationContainer resources,
             Boolean createIdentityProfilePreview,
             AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements) {
@@ -233,7 +233,7 @@ public IdentityProfileRequirementsPayload getIdentityProfile() {
      *
      * @return subject
      */
-    public Map<String, Object> getSubject() {
+    public IdentityProfileSubjectPayload getSubject() {
         return subject;
     }
 
@@ -280,7 +280,7 @@ public static class Builder {
         private ZonedDateTime sessionDeadline;
         private IdentityProfileRequirementsPayload identityProfile;
         private AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirementsPayload;
-        private Map<String, Object> subject;
+        private IdentityProfileSubjectPayload subject;
         private ResourceCreationContainer resources;
         private Boolean createIdentityProfilePreview;
 
@@ -440,7 +440,7 @@ public Builder withIdentityProfile(IdentityProfileRequirementsPayload identityPr
          * @param subject the subject
          * @return the Builder
          */
-        public Builder withSubject(Map<String, Object> subject) {
+        public Builder withSubject(IdentityProfileSubjectPayload subject) {
             this.subject = subject;
             return this;
         }

yoti-sdk-api/src/test/java/com/yoti/api/client/docs/session/create/SessionSpecTest.java

@@ -1,21 +1,15 @@
 package com.yoti.api.client.docs.session.create;
 
-import static com.yoti.api.client.spi.remote.call.YotiConstants.DEFAULT_CHARSET;
-
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.contains;
-import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.hasItems;
 import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.instanceOf;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
 import static org.hamcrest.Matchers.nullValue;
 
-import java.io.IOException;
 import java.time.ZonedDateTime;
-import java.util.HashMap;
-import java.util.Map;
 
 import com.yoti.api.client.docs.session.create.check.RequestedDocumentAuthenticityCheck;
 import com.yoti.api.client.docs.session.create.check.RequestedLivenessCheck;
@@ -24,9 +18,6 @@
 import com.yoti.api.client.docs.session.create.resources.ResourceCreationContainer;
 import com.yoti.api.client.docs.session.create.task.RequestedIdDocTextExtractionTask;
 
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import org.hamcrest.Matchers;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
@@ -51,14 +42,13 @@ public class SessionSpecTest {
     private static final String SOME_SDK_CONFIG_SUCCESS_URL = "https://yourdomain.com/some/success/endpoint";
     private static final String SOME_SDK_CONFIG_ERROR_URL = "https://yourdomain.com/some/error/endpoint";
 
-    private static final ObjectMapper MAPPER = new ObjectMapper();
-
     @Mock RequiredDocument requiredDocumentMock;
     @Mock IbvOptions ibvOptionsMock;
     @Mock ZonedDateTime sessionDeadlineMock;
     @Mock ResourceCreationContainer resourceCreationContainerMock;
     @Mock ImportTokenPayload importTokenMock;
     @Mock IdentityProfileRequirementsPayload identityProfileRequirementsPayloadMock;
+    @Mock IdentityProfileSubjectPayload identityProfileSubjectPayloadMock;
 
     @Test
     public void shouldBuildWithMinimalConfiguration() {
@@ -226,21 +216,12 @@ public void withIdentityProfile_shouldSetTheIdentityProfile() {
     }
 
     @Test
-    public void shouldBuildWithSubject() throws IOException {
-        Map<String, Object> subject = new HashMap<>();
-        subject.put(SubjectProperty.SUBJECT_ID, "A_SUBJECT_ID");
-
-        SessionSpec session = SessionSpec.builder()
-                .withSubject(subject)
+    public void withSubject_shouldSetTheSubject() {
+        SessionSpec result = SessionSpec.builder()
+                .withSubject(identityProfileSubjectPayloadMock)
                 .build();
 
-        ObjectMapper mapper = new ObjectMapper();
-
-        JsonNode json = mapper.readTree(
-                mapper.writeValueAsString(session.getSubject()).getBytes(DEFAULT_CHARSET)
-        );
-
-        assertThat(json.get("subject_id").asText(), is(Matchers.equalTo(subject.get(SubjectProperty.SUBJECT_ID))));
+        assertThat(result.getSubject(), is(identityProfileSubjectPayloadMock));
     }
 
     @Test
@@ -270,23 +251,4 @@ public void shouldBuildWithImportToken() {
         assertThat(sessionSpec.getImportToken(), is(importTokenMock));
     }
 
-    private static final class IdentityProperty {
-
-        private static final String TYPE = "type";
-        private static final String SCHEME = "scheme";
-        private static final String OBJECTIVE = "objective";
-        private static final String TRUST_FRAMEWORK = "trust_framework";
-
-        private IdentityProperty() { }
-
-    }
-
-    private static final class SubjectProperty {
-
-        private static final String SUBJECT_ID = "subject_id";
-
-        private SubjectProperty() {}
-
-    }
-
 }