SDK-2197 Add support for requesting the profile preview + SDK-2202 Add support to fetch the identity profile preview (#309)

Author: LuborRod

src/DocScan/Session/Create/SessionSpecification.php

@@ -78,6 +78,8 @@ class SessionSpecification implements JsonSerializable
      */
     private $identityProfileRequirements;
 
+    private ?bool $createIdentityProfilePreview;
+
     /**
      * @param int|null $clientSessionTokenTtl
      * @param string|null $sessionDeadline
@@ -92,6 +94,7 @@ class SessionSpecification implements JsonSerializable
      * @param IbvOptions|null $ibvOptions
      * @param object|null $subject
      * @param object|null $identityProfileRequirements
+     * @param bool $createIdentityProfilePreview
      */
     public function __construct(
         ?int $clientSessionTokenTtl,
@@ -106,7 +109,8 @@ public function __construct(
         ?bool $blockBiometricConsent = null,
         ?IbvOptions $ibvOptions = null,
         $subject = null,
-        $identityProfileRequirements = null
+        $identityProfileRequirements = null,
+        ?bool $createIdentityProfilePreview = null
     ) {
         $this->clientSessionTokenTtl = $clientSessionTokenTtl;
         $this->sessionDeadline = $sessionDeadline;
@@ -121,6 +125,7 @@ public function __construct(
         $this->ibvOptions = $ibvOptions;
         $this->subject = $subject;
         $this->identityProfileRequirements = $identityProfileRequirements;
+        $this->createIdentityProfilePreview = $createIdentityProfilePreview;
     }
 
     /**
@@ -142,6 +147,7 @@ public function jsonSerialize(): stdClass
             'ibv_options' => $this->getIbvOptions(),
             'subject' => $this->getSubject(),
             'identity_profile_requirements' => $this->getIdentityProfileRequirements(),
+            'create_identity_profile_preview' => $this->getCreateIdentityProfilePreview(),
         ]);
     }
 
@@ -253,4 +259,9 @@ public function getIdentityProfileRequirements()
     {
         return $this->identityProfileRequirements;
     }
+
+    public function getCreateIdentityProfilePreview(): ?bool
+    {
+        return $this->createIdentityProfilePreview;
+    }
 }

src/DocScan/Session/Create/SessionSpecificationBuilder.php

@@ -77,6 +77,11 @@ class SessionSpecificationBuilder
      */
     private $identityProfileRequirements;
 
+    /**
+     * @var bool
+     */
+    private bool $createIdentityProfilePreview = false;
+
     /**
      * @param int $clientSessionTokenTtl
      * @return $this
@@ -243,6 +248,15 @@ public function withIdentityProfileRequirements($identityProfileRequirements): s
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    public function withCreateIdentityProfilePreview(): self
+    {
+        $this->createIdentityProfilePreview = true;
+        return $this;
+    }
+
     /**
      * @return SessionSpecification
      */
@@ -261,7 +275,8 @@ public function build(): SessionSpecification
             $this->blockBiometricConsent,
             $this->ibvOptions,
             $this->subject,
-            $this->identityProfileRequirements
+            $this->identityProfileRequirements,
+            $this->createIdentityProfilePreview,
         );
     }
 }

src/DocScan/Session/Retrieve/GetSessionResult.php

@@ -49,10 +49,9 @@ class GetSessionResult
      */
     private $biometricConsent;
 
-    /**
-     * @var IdentityProfileResponse
-     */
-    private $identityProfile;
+    private ?IdentityProfileResponse $identityProfile;
+
+    private ?IdentityProfilePreviewResponse $identityProfilePreview;
 
     /**
      * DocScanSession constructor.
@@ -85,6 +84,12 @@ public function __construct(array $sessionData)
         if (isset($sessionData['identity_profile'])) {
             $this->identityProfile = new IdentityProfileResponse($sessionData['identity_profile']);
         }
+
+        if (isset($sessionData['identity_profile_preview'])) {
+            $this->identityProfilePreview = new IdentityProfilePreviewResponse(
+                $sessionData['identity_profile_preview']
+            );
+        }
     }
 
     /**
@@ -300,11 +305,13 @@ function ($checkResponse) use ($class): bool {
         return array_values($filtered);
     }
 
-    /**
-     * @return IdentityProfileResponse
-     */
-    public function getIdentityProfile(): IdentityProfileResponse
+    public function getIdentityProfile(): ?IdentityProfileResponse
     {
         return $this->identityProfile;
     }
+
+    public function getIdentityProfilePreview(): ?IdentityProfilePreviewResponse
+    {
+        return $this->identityProfilePreview;
+    }
 }

src/DocScan/Session/Retrieve/IdentityProfilePreviewResponse.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve;
+
+class IdentityProfilePreviewResponse
+{
+    private ?MediaResponse $media = null;
+
+    public function __construct(array $sessionData)
+    {
+        if (isset($sessionData['media'])) {
+            $this->media = new MediaResponse($sessionData['media']);
+        }
+    }
+
+    /**
+     * @return MediaResponse|null
+     */
+    public function getMedia(): ?MediaResponse
+    {
+        return $this->media;
+    }
+}

tests/DocScan/Session/Create/SessionSpecificationBuilderTest.php

@@ -219,6 +219,7 @@ public function shouldReturnCorrectJsonString()
                 'requested_tasks' => [$this->requestedTaskMock],
                 'required_documents' => [$this->requiredDocumentMock],
                 'block_biometric_consent' => true,
+                'create_identity_profile_preview' => false,
             ]),
             json_encode($sessionSpecification)
         );
@@ -237,6 +238,7 @@ public function shouldReturnCorrectJsonStringWithoutOptionalProperties()
                 'requested_checks' => [],
                 'requested_tasks' => [],
                 'required_documents' => [],
+                'create_identity_profile_preview' => false,
             ]),
             json_encode($sessionSpecification)
         );
@@ -257,6 +259,7 @@ public function shouldReturnCorrectJsonStringWithBlockBiometricConsentTrue()
                 'requested_checks' => [],
                 'requested_tasks' => [],
                 'required_documents' => [],
+                'create_identity_profile_preview' => false,
                 'block_biometric_consent' => true,
             ]),
             json_encode($sessionSpecification)
@@ -278,6 +281,7 @@ public function shouldReturnCorrectJsonStringWithBlockBiometricConsentFalse()
                 'requested_checks' => [],
                 'requested_tasks' => [],
                 'required_documents' => [],
+                'create_identity_profile_preview' => false,
                 'block_biometric_consent' => false,
             ]),
             json_encode($sessionSpecification)
@@ -335,6 +339,7 @@ public function shouldReturnCorrectJsonStringWithIbvOptions()
                 'requested_checks' => [],
                 'requested_tasks' => [],
                 'required_documents' => [],
+                'create_identity_profile_preview' => false,
                 'ibv_options' => $this->ibvOptionsMock,
             ]),
             json_encode($sessionSpecification)
@@ -389,6 +394,7 @@ public function shouldReturnCorrectJsonStringWithSubject()
                 'requested_checks' => [],
                 'requested_tasks' => [],
                 'required_documents' => [],
+                'create_identity_profile_preview' => false,
                 'subject' => $this->subject,
             ]),
             json_encode($sessionSpecification)
@@ -446,9 +452,36 @@ public function shouldReturnCorrectJsonStringWithIdentityProfileRequirements()
                 'requested_checks' => [],
                 'requested_tasks' => [],
                 'required_documents' => [],
+                'create_identity_profile_preview' => false,
                 'identity_profile_requirements' => $this->identityProfileRequirements,
             ]),
             json_encode($sessionSpecification)
         );
     }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::jsonSerialize
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::getCreateIdentityProfilePreview
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::__construct
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::jsonSerialize
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withCreateIdentityProfilePreview
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldReturnCorrectJsonStringWithIdentityProfilePreviewTrue()
+    {
+        $sessionSpecification = (new SessionSpecificationBuilder())
+            ->withCreateIdentityProfilePreview()
+            ->build();
+
+        $this->assertJsonStringEqualsJsonString(
+            json_encode([
+                'requested_checks' => [],
+                'requested_tasks' => [],
+                'required_documents' => [],
+                'create_identity_profile_preview' => true,
+            ]),
+            json_encode($sessionSpecification)
+        );
+    }
 }

tests/DocScan/Session/Retrieve/GetSessionResultTest.php

@@ -7,6 +7,7 @@
 use Yoti\DocScan\Session\Retrieve\AuthenticityCheckResponse;
 use Yoti\DocScan\Session\Retrieve\CheckResponse;
 use Yoti\DocScan\Session\Retrieve\GetSessionResult;
+use Yoti\DocScan\Session\Retrieve\IdentityProfilePreviewResponse;
 use Yoti\DocScan\Session\Retrieve\IdentityProfileResponse;
 use Yoti\DocScan\Session\Retrieve\ThirdPartyIdentityFraudOneCheckResponse;
 use Yoti\Test\TestCase;
@@ -234,4 +235,27 @@ public function thirdPartyIdentityFraudOneChecksShouldReturnEmptyCollectionWhenN
 
         $this->assertCount(0, $result->getThirdPartyIdentityFraudOneChecks());
     }
+
+    /**
+     * @test
+     * @covers ::getIdentityProfilePreview
+     * @covers ::__construct
+     */
+    public function shouldParseIdentityProfilePreviewResponse()
+    {
+        $input = [
+            'identity_profile_preview' => [
+                'media' => [
+                    'id' => 'SOME_ID',
+                    'type' => 'JSON',
+                    'created' => '2021-06-11T11:39:24Z',
+                    'last_updated' => '2021-06-11T11:39:24Z',
+                ]
+            ],
+        ];
+
+        $result = new GetSessionResult($input);
+
+        $this->assertInstanceOf(IdentityProfilePreviewResponse::class, $result->getIdentityProfilePreview());
+    }
 }

tests/DocScan/Session/Retrieve/IdentityProfilePreviewResponseTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Yoti\Test\DocScan\Session\Retrieve;
+
+use Yoti\DocScan\Session\Retrieve\IdentityProfilePreviewResponse;
+use Yoti\DocScan\Session\Retrieve\MediaResponse;
+use Yoti\Test\TestCase;
+
+/**
+ * @coversDefaultClass \Yoti\DocScan\Session\Retrieve\IdentityProfilePreviewResponse
+ */
+class IdentityProfilePreviewResponseTest extends TestCase
+{
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::getMedia
+     */
+    public function shouldCreatedCorrectly(): void
+    {
+        $data = [
+            'media' => [
+                    'id' => 'SOME_ID',
+                    'type' => 'JSON',
+                    'created' => '2021-06-11T11:39:24Z',
+                    'last_updated' => '2021-06-11T11:39:24Z',
+                ]
+        ];
+
+        $result = new IdentityProfilePreviewResponse($data);
+
+        $this->assertInstanceOf(IdentityProfilePreviewResponse::class, $result);
+        $this->assertInstanceOf(MediaResponse::class, $result->getMedia());
+    }
+}