SDK-2101 Add subject to IDV request (#277)

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

Author: LuborRod

src/DocScan/Session/Create/SessionSpecification.php

@@ -68,6 +68,11 @@ class SessionSpecification implements JsonSerializable
      */
     private $ibvOptions;
 
+    /**
+     * @var object|null
+     */
+    private $subject;
+
     /**
      * @param int|null $clientSessionTokenTtl
      * @param string|null $sessionDeadline
@@ -80,6 +85,7 @@ class SessionSpecification implements JsonSerializable
      * @param RequiredDocument[] $requiredDocuments
      * @param bool|null $blockBiometricConsent
      * @param IbvOptions|null $ibvOptions
+     * @param object|null $subject
      */
     public function __construct(
         ?int $clientSessionTokenTtl,
@@ -92,7 +98,8 @@ public function __construct(
         ?SdkConfig $sdkConfig,
         array $requiredDocuments = [],
         ?bool $blockBiometricConsent = null,
-        ?IbvOptions $ibvOptions = null
+        ?IbvOptions $ibvOptions = null,
+        $subject = null
     ) {
         $this->clientSessionTokenTtl = $clientSessionTokenTtl;
         $this->sessionDeadline = $sessionDeadline;
@@ -105,6 +112,7 @@ public function __construct(
         $this->requiredDocuments = $requiredDocuments;
         $this->blockBiometricConsent = $blockBiometricConsent;
         $this->ibvOptions = $ibvOptions;
+        $this->subject = $subject;
     }
 
     /**
@@ -124,6 +132,7 @@ public function jsonSerialize(): stdClass
             'required_documents' => $this->getRequiredDocuments(),
             'block_biometric_consent' => $this->getBlockBiometricConsent(),
             'ibv_options' => $this->getIbvOptions(),
+            'subject' => $this->getSubject(),
         ]);
     }
 
@@ -219,4 +228,12 @@ public function getIbvOptions(): ?IbvOptions
     {
         return $this->ibvOptions;
     }
+
+    /**
+     * @return object|null
+     */
+    public function getSubject()
+    {
+        return $this->subject;
+    }
 }

src/DocScan/Session/Create/SessionSpecificationBuilder.php

@@ -67,6 +67,11 @@ class SessionSpecificationBuilder
      */
     private $ibvOptions;
 
+    /**
+     * @var object|null
+     */
+    private $subject;
+
     /**
      * @param int $clientSessionTokenTtl
      * @return $this
@@ -207,6 +212,19 @@ public function withIbvOptions(IbvOptions $ibvOptions): self
         return $this;
     }
 
+    /**
+     * Sets the Subject object for the session
+     *
+     * @param object $subject
+     *
+     * @return $this
+     */
+    public function withSubject($subject): self
+    {
+        $this->subject = $subject;
+        return $this;
+    }
+
     /**
      * @return SessionSpecification
      */
@@ -223,7 +241,8 @@ public function build(): SessionSpecification
             $this->sdkConfig,
             $this->requiredDocuments,
             $this->blockBiometricConsent,
-            $this->ibvOptions
+            $this->ibvOptions,
+            $this->subject
         );
     }
 }

tests/DocScan/Session/Create/SessionSpecificationBuilderTest.php

@@ -52,6 +52,11 @@ class SessionSpecificationBuilderTest extends TestCase
      */
     private $ibvOptionsMock;
 
+    /**
+     * @var object
+     */
+    private $subject;
+
     public function setup(): void
     {
         $this->sdkConfigMock = $this->createMock(SdkConfig::class);
@@ -70,6 +75,7 @@ public function setup(): void
         $this->requiredDocumentMock->method('jsonSerialize')->willReturn((object)['requiredDocument']);
 
         $this->ibvOptionsMock = $this->createMock(IbvOptions::class);
+        $this->subject = (object)[1 => 'some'];
     }
 
     /**
@@ -320,4 +326,58 @@ public function shouldReturnCorrectJsonStringWithIbvOptions()
             json_encode($sessionSpecification)
         );
     }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::getSubject
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::__construct
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withSubject
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldBuildWithSubject()
+    {
+        $sessionSpecificationResult = (new SessionSpecificationBuilder())
+            ->withSubject($this->subject)
+            ->build();
+
+        $this->assertEquals($this->subject, $sessionSpecificationResult->getSubject());
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::getSubject
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::__construct
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withSubject
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldNotImplicitlySetAValueForSubject()
+    {
+        $sessionSpecificationResult = (new SessionSpecificationBuilder())
+            ->build();
+
+        $this->assertNull($sessionSpecificationResult->getSubject());
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::jsonSerialize
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withSubject
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldReturnCorrectJsonStringWithSubject()
+    {
+        $sessionSpecification = (new SessionSpecificationBuilder())
+            ->withSubject($this->subject)
+            ->build();
+
+        $this->assertJsonStringEqualsJsonString(
+            json_encode([
+                'requested_checks' => [],
+                'requested_tasks' => [],
+                'required_documents' => [],
+                'subject' => $this->subject,
+            ]),
+            json_encode($sessionSpecification)
+        );
+    }
 }