SDK-1954 Add IbvOptions for session specigfication

Rodion Liuborets · LuborRod · commit 091ed0f870a5 · 2021-12-10T14:42:44.000+02:00
diff --git a/src/DocScan/Constants.php b/src/DocScan/Constants.php
@@ -22,6 +22,9 @@ class Constants
     public const FUZZY = 'FUZZY';
     public const FACE_CAPTURE = 'FACE_CAPTURE';
 
+    public const MANDATORY = "MANDATORY";
+    public const NOT_ALLOWED = "NOT_ALLOWED";
+
 
     public const ADVERSE_MEDIA = 'ADVERSE-MEDIA';
     public const SANCTIONS = 'SANCTIONS';
diff --git a/src/DocScan/Session/Create/IbvOptions.php b/src/DocScan/Session/Create/IbvOptions.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Yoti\DocScan\Session\Create;
+
+class IbvOptions
+{
+    /**
+     * @var string
+     */
+    private $support;
+
+    /**
+     * @var string|null
+     */
+    private $guidanceUrl;
+
+    /**
+     * @param string $support
+     * @param string|null $guidanceUrl
+     */
+    public function __construct(string $support, ?string $guidanceUrl = null)
+    {
+        $this->support = $support;
+        $this->guidanceUrl = $guidanceUrl;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSupport(): string
+    {
+        return $this->support;
+    }
+
+    /**
+     * @return string
+     */
+    public function getGuidanceUrl(): ?string
+    {
+        return $this->guidanceUrl;
+    }
+}
diff --git a/src/DocScan/Session/Create/IbvOptionsBuilder.php b/src/DocScan/Session/Create/IbvOptionsBuilder.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace Yoti\DocScan\Session\Create;
+
+use Yoti\DocScan\Constants;
+
+class IbvOptionsBuilder
+{
+    /**
+     * @var string
+     */
+    private $support;
+
+    /**
+     * @var string|null
+     */
+    private $guidanceUrl;
+
+    /**
+     * @return $this
+     */
+    public function withIbvNotAllowed(): IbvOptionsBuilder
+    {
+        return $this->withSupport(Constants::NOT_ALLOWED);
+    }
+
+    /**
+     * @return $this
+     */
+    public function withIbvMandatory(): IbvOptionsBuilder
+    {
+        return $this->withSupport(Constants::MANDATORY);
+    }
+
+    /**
+     * @param string $support
+     * @return $this
+     */
+    public function withSupport(string $support): IbvOptionsBuilder
+    {
+        $this->support = $support;
+        return $this;
+    }
+
+    /**
+     * @param string $guidanceUrl
+     * @return $this
+     */
+    public function withGuidanceUrl(string $guidanceUrl): IbvOptionsBuilder
+    {
+        $this->guidanceUrl = $guidanceUrl;
+        return $this;
+    }
+
+    /**
+     * @return IbvOptions
+     */
+    public function build(): IbvOptions
+    {
+        return new IbvOptions($this->support, $this->guidanceUrl);
+    }
+}
diff --git a/src/DocScan/Session/Create/SessionSpecification.php b/src/DocScan/Session/Create/SessionSpecification.php
@@ -63,7 +63,11 @@ class SessionSpecification implements JsonSerializable
     private $blockBiometricConsent;
 
     /**
-     * SessionSpecification constructor.
+     * @var IbvOptions|null
+     */
+    private $ibvOptions;
+
+    /**
      * @param int|null $clientSessionTokenTtl
      * @param string|null $sessionDeadline
      * @param int|null $resourcesTtl
@@ -74,6 +78,7 @@ class SessionSpecification implements JsonSerializable
      * @param SdkConfig|null $sdkConfig
      * @param RequiredDocument[] $requiredDocuments
      * @param bool|null $blockBiometricConsent
+     * @param IbvOptions|null $ibvOptions
      */
     public function __construct(
         ?int $clientSessionTokenTtl,
@@ -85,7 +90,8 @@ public function __construct(
         array $requestedTasks,
         ?SdkConfig $sdkConfig,
         array $requiredDocuments = [],
-        ?bool $blockBiometricConsent = null
+        ?bool $blockBiometricConsent = null,
+        ?IbvOptions $ibvOptions = null
     ) {
         $this->clientSessionTokenTtl = $clientSessionTokenTtl;
         $this->sessionDeadline = $sessionDeadline;
@@ -97,6 +103,7 @@ public function __construct(
         $this->sdkConfig = $sdkConfig;
         $this->requiredDocuments = $requiredDocuments;
         $this->blockBiometricConsent = $blockBiometricConsent;
+        $this->ibvOptions = $ibvOptions;
     }
 
     /**
@@ -115,6 +122,7 @@ public function jsonSerialize(): array
             'sdk_config' => $this->getSdkConfig(),
             'required_documents' => $this->getRequiredDocuments(),
             'block_biometric_consent' => $this->getBlockBiometricConsent(),
+            'ibv_options' => $this->getIbvOptions(),
         ]);
     }
 
@@ -199,4 +207,15 @@ public function getBlockBiometricConsent(): ?bool
     {
         return $this->blockBiometricConsent;
     }
+
+    /**
+     * The options that define if a session will be required to be performed
+     * using In-Branch Verification
+     *
+     * @return IbvOptions|null
+     */
+    public function getIbvOptions(): ?IbvOptions
+    {
+        return $this->ibvOptions;
+    }
 }
diff --git a/src/DocScan/Session/Create/SessionSpecificationBuilder.php b/src/DocScan/Session/Create/SessionSpecificationBuilder.php
@@ -62,6 +62,11 @@ class SessionSpecificationBuilder
      */
     private $blockBiometricConsent;
 
+    /**
+     * @var IbvOptions|null
+     */
+    private $ibvOptions;
+
     /**
      * @param int $clientSessionTokenTtl
      * @return $this
@@ -188,6 +193,20 @@ public function withBlockBiometricConsent(bool $blockBiometricConsent): self
         return $this;
     }
 
+    /**
+     * Sets the options that define if a session will be required to be performed
+     * using In-Branch Verification
+     *
+     * @param IbvOptions $ibvOptions
+     *
+     * @return $this
+     */
+    public function withIbvOptions(IbvOptions $ibvOptions): self
+    {
+        $this->ibvOptions = $ibvOptions;
+        return $this;
+    }
+
     /**
      * @return SessionSpecification
      */
@@ -203,7 +222,8 @@ public function build(): SessionSpecification
             $this->requestedTasks,
             $this->sdkConfig,
             $this->requiredDocuments,
-            $this->blockBiometricConsent
+            $this->blockBiometricConsent,
+            $this->ibvOptions
         );
     }
 }
diff --git a/tests/DocScan/Session/Create/IbvOptionsBuilderTest.php b/tests/DocScan/Session/Create/IbvOptionsBuilderTest.php
@@ -0,0 +1,81 @@
+<?php
+
+namespace Yoti\Test\DocScan\Session\Create;
+
+use Yoti\DocScan\Session\Create\IbvOptionsBuilder;
+use Yoti\Test\TestCase;
+
+/**
+ * @coversDefaultClass \Yoti\DocScan\Session\Create\IbvOptionsBuilder
+ */
+class IbvOptionsBuilderTest extends TestCase
+{
+    private const SOME_SUPPORT_VALUE = "someSupportValue";
+    private const SOME_GUIDANCE_URL = "someGuidanceUrl";
+
+    /**
+     * @test
+     * @covers ::build
+     * @covers ::withIbvMandatory
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::__construct
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::getSupport
+     */
+    public function builderWithMandatorySupportShouldSetCorrectSupportValue()
+    {
+        $result = (new IbvOptionsBuilder())
+            ->withIbvMandatory()
+            ->build();
+
+        $this->assertEquals('MANDATORY', $result->getSupport());
+    }
+
+    /**
+     * @test
+     * @covers ::build
+     * @covers ::withIbvNotAllowed
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::__construct
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::getSupport
+     */
+    public function builderWithNotAllowedSupportShouldSetCorrectSupportValue()
+    {
+        $result = (new IbvOptionsBuilder())
+            ->withIbvNotAllowed()
+            ->build();
+
+        $this->assertEquals('NOT_ALLOWED', $result->getSupport());
+    }
+
+    /**
+     * @test
+     * @covers ::build
+     * @covers ::withSupport
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::__construct
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::getSupport
+     */
+    public function builderShouldAllowUserOverrideOfSupportValue()
+    {
+        $result = (new IbvOptionsBuilder())
+            ->withSupport(self::SOME_SUPPORT_VALUE)
+            ->build();
+
+        $this->assertEquals(self::SOME_SUPPORT_VALUE, $result->getSupport());
+    }
+
+    /**
+     * @test
+     * @covers ::build
+     * @covers ::withIbvMandatory
+     * @covers ::withGuidanceUrl
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::__construct
+     * @covers \Yoti\DocScan\Session\Create\IbvOptions::getGuidanceUrl
+     */
+    public function builderShouldSetCorrectGuidanceUrlValue()
+    {
+        $result = (new IbvOptionsBuilder())
+            ->withIbvMandatory()
+            ->withGuidanceUrl(self::SOME_GUIDANCE_URL)
+            ->build();
+
+        $this->assertEquals(self::SOME_GUIDANCE_URL, $result->getGuidanceUrl());
+    }
+}
diff --git a/tests/DocScan/Session/Create/SessionSpecificationBuilderTest.php b/tests/DocScan/Session/Create/SessionSpecificationBuilderTest.php
@@ -6,6 +6,7 @@
 
 use Yoti\DocScan\Session\Create\Check\RequestedCheck;
 use Yoti\DocScan\Session\Create\Filters\RequiredDocument;
+use Yoti\DocScan\Session\Create\IbvOptions;
 use Yoti\DocScan\Session\Create\NotificationConfig;
 use Yoti\DocScan\Session\Create\SdkConfig;
 use Yoti\DocScan\Session\Create\SessionSpecificationBuilder;
@@ -46,6 +47,11 @@ class SessionSpecificationBuilderTest extends TestCase
      */
     private $requiredDocumentMock;
 
+    /**
+     * @var IbvOptions
+     */
+    private $ibvOptionsMock;
+
     public function setup(): void
     {
         $this->sdkConfigMock = $this->createMock(SdkConfig::class);
@@ -62,6 +68,8 @@ public function setup(): void
 
         $this->requiredDocumentMock = $this->createMock(RequiredDocument::class);
         $this->requiredDocumentMock->method('jsonSerialize')->willReturn((object)['requiredDocument']);
+
+        $this->ibvOptionsMock = $this->createMock(IbvOptions::class);
     }
 
     /**
@@ -273,4 +281,43 @@ public function shouldSetTheSessionDeadline()
 
         $this->assertEquals($correctDateFormatValue, $sessionSpecificationResult->getSessionDeadline());
     }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::getIbvOptions
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::__construct
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withIbvOptions
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function withIbvOptionsShouldSetTheIbvOptions()
+    {
+        $sessionSpecificationResult = (new SessionSpecificationBuilder())
+            ->withIbvOptions($this->ibvOptionsMock)
+            ->build();
+
+        $this->assertEquals($this->ibvOptionsMock, $sessionSpecificationResult->getIbvOptions());
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecification::jsonSerialize
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::withIbvOptions
+     * @covers \Yoti\DocScan\Session\Create\SessionSpecificationBuilder::build
+     */
+    public function shouldReturnCorrectJsonStringWithIbvOptions()
+    {
+        $sessionSpecification = (new SessionSpecificationBuilder())
+            ->withIbvOptions($this->ibvOptionsMock)
+            ->build();
+
+        $this->assertJsonStringEqualsJsonString(
+            json_encode([
+                'requested_checks' => [],
+                'requested_tasks' => [],
+                'required_documents' => [],
+                'ibv_options' => $this->ibvOptionsMock,
+            ]),
+            json_encode($sessionSpecification)
+        );
+    }
 }
