SDK-2099 Add builder method for creating sessionwith identity profile (#278)

Co-authored-by: Rodion Liuborets <[email protected]>

Author: LuborRod

src/DocScan/Session/Create/SessionSpecification.php

@@ -73,6 +73,11 @@ class SessionSpecification implements JsonSerializable
      */
     private $subject;
 
+    /**
+     * @var object|null
+     */
+    private $identityProfileRequirements;
+
     /**
      * @param int|null $clientSessionTokenTtl
      * @param string|null $sessionDeadline
@@ -86,6 +91,7 @@ class SessionSpecification implements JsonSerializable
      * @param bool|null $blockBiometricConsent
      * @param IbvOptions|null $ibvOptions
      * @param object|null $subject
+     * @param object|null $identityProfileRequirements
      */
     public function __construct(
         ?int $clientSessionTokenTtl,
@@ -99,7 +105,8 @@ public function __construct(
         array $requiredDocuments = [],
         ?bool $blockBiometricConsent = null,
         ?IbvOptions $ibvOptions = null,
-        $subject = null
+        $subject = null,
+        $identityProfileRequirements = null
     ) {
         $this->clientSessionTokenTtl = $clientSessionTokenTtl;
         $this->sessionDeadline = $sessionDeadline;
@@ -113,6 +120,7 @@ public function __construct(
         $this->blockBiometricConsent = $blockBiometricConsent;
         $this->ibvOptions = $ibvOptions;
         $this->subject = $subject;
+        $this->identityProfileRequirements = $identityProfileRequirements;
     }
 
     /**
@@ -133,6 +141,7 @@ public function jsonSerialize(): stdClass
             'block_biometric_consent' => $this->getBlockBiometricConsent(),
             'ibv_options' => $this->getIbvOptions(),
             'subject' => $this->getSubject(),
+            'identity_profile_requirements' => $this->getIdentityProfileRequirements(),
         ]);
     }
 
@@ -236,4 +245,12 @@ public function getSubject()
     {
         return $this->subject;
     }
+
+    /**
+     * @return object|null
+     */
+    public function getIdentityProfileRequirements()
+    {
+        return $this->identityProfileRequirements;
+    }
 }

src/DocScan/Session/Create/SessionSpecificationBuilder.php

@@ -72,6 +72,11 @@ class SessionSpecificationBuilder
      */
     private $subject;
 
+    /**
+     * @var object|null
+     */
+    private $identityProfileRequirements;
+
     /**
      * @param int $clientSessionTokenTtl
      * @return $this
@@ -225,6 +230,19 @@ public function withSubject($subject): self
         return $this;
     }
 
+    /**
+     * Sets the Identity Profile Requirements for the session
+     *
+     * @param object $identityProfileRequirements
+     *
+     * @return $this
+     */
+    public function withIdentityProfileRequirements($identityProfileRequirements): self
+    {
+        $this->identityProfileRequirements = $identityProfileRequirements;
+        return $this;
+    }
+
     /**
      * @return SessionSpecification
      */
@@ -242,7 +260,8 @@ public function build(): SessionSpecification
             $this->requiredDocuments,
             $this->blockBiometricConsent,
             $this->ibvOptions,
-            $this->subject
+            $this->subject,
+            $this->identityProfileRequirements
         );
     }
 }

tests/DocScan/Session/Create/SessionSpecificationBuilderTest.php

@@ -57,6 +57,11 @@ class SessionSpecificationBuilderTest extends TestCase
      */
     private $subject;
 
+    /**
+     * @var object
+     */
+    private $identityProfileRequirements;
+
     public function setup(): void
     {
         $this->sdkConfigMock = $this->createMock(SdkConfig::class);
@@ -75,7 +80,16 @@ public function setup(): void
         $this->requiredDocumentMock->method('jsonSerialize')->willReturn((object)['requiredDocument']);
 
         $this->ibvOptionsMock = $this->createMock(IbvOptions::class);
+
         $this->subject = (object)[1 => 'some'];
+
+        $this->identityProfileRequirements = (object)[
+            'trust_framework' => 'UK_TFIDA',
+            'scheme' => [
+                'type' => 'DBS',
+                'objective' => 'STANDARD'
+            ]
+        ];
     }
 
     /**
@@ -380,4 +394,61 @@ public function shouldReturnCorrectJsonStringWithSubject()
             json_encode($sessionSpecification)
         );
     }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::getIdentityProfileRequirements
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::__construct
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withIdentityProfileRequirements
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldBuildWithIdentityProfileRequirements()
+    {
+        $sessionSpecificationResult = (new SessionSpecificationBuilder())
+            ->withIdentityProfileRequirements($this->identityProfileRequirements)
+            ->build();
+
+        $this->assertEquals(
+            $this->identityProfileRequirements,
+            $sessionSpecificationResult->getIdentityProfileRequirements()
+        );
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::getIdentityProfileRequirements
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::__construct
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withIdentityProfileRequirements
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldNotImplicitlySetAValueForIdentityProfileRequirements()
+    {
+        $sessionSpecificationResult = (new SessionSpecificationBuilder())
+            ->build();
+
+        $this->assertNull($sessionSpecificationResult->getIdentityProfileRequirements());
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::jsonSerialize
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withIdentityProfileRequirements
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldReturnCorrectJsonStringWithIdentityProfileRequirements()
+    {
+        $sessionSpecification = (new SessionSpecificationBuilder())
+            ->withIdentityProfileRequirements($this->identityProfileRequirements)
+            ->build();
+
+        $this->assertJsonStringEqualsJsonString(
+            json_encode([
+                'requested_checks' => [],
+                'requested_tasks' => [],
+                'required_documents' => [],
+                'identity_profile_requirements' => $this->identityProfileRequirements,
+            ]),
+            json_encode($sessionSpecification)
+        );
+    }
 }