SDK-2159 Face Comparison Check (#302)

Author: LuborRod

src/DocScan/Constants.php

@@ -14,6 +14,7 @@ class Constants
     public const LIVENESS = 'LIVENESS';
     public const WATCHLIST_SCREENING = 'WATCHLIST_SCREENING';
     public const WATCHLIST_ADVANCED_CA = 'WATCHLIST_ADVANCED_CA';
+    public const FACE_COMPARISON = 'FACE_COMPARISON';
 
     public const WITH_YOTI_ACCOUNT = 'WITH_YOTI_ACCOUNT';
     public const WITH_CUSTOM_ACCOUNT = 'WITH_CUSTOM_ACCOUNT';

src/DocScan/Session/Create/Check/RequestedFaceComparisonCheck.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Yoti\DocScan\Session\Create\Check;
+
+use Yoti\DocScan\Constants;
+
+class RequestedFaceComparisonCheck extends RequestedCheck
+{
+    /**
+     * @var RequestedFaceComparisonCheckConfig
+     */
+    private $config;
+
+    public function __construct(RequestedFaceComparisonCheckConfig $config)
+    {
+        $this->config = $config;
+    }
+
+    protected function getType(): string
+    {
+        return Constants::FACE_COMPARISON;
+    }
+
+    protected function getConfig(): ?RequestedCheckConfigInterface
+    {
+        return $this->config;
+    }
+}

src/DocScan/Session/Create/Check/RequestedFaceComparisonCheckBuilder.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Yoti\DocScan\Session\Create\Check;
+
+use Yoti\DocScan\Session\Create\Traits\Builder\ManualCheckTrait;
+use Yoti\Util\Validation;
+
+class RequestedFaceComparisonCheckBuilder
+{
+    use ManualCheckTrait;
+
+    public function build(): RequestedFaceComparisonCheck
+    {
+        Validation::notEmptyString($this->manualCheck, 'manualCheck');
+
+        $config = new RequestedFaceComparisonCheckConfig($this->manualCheck);
+        return new RequestedFaceComparisonCheck($config);
+    }
+}

src/DocScan/Session/Create/Check/RequestedFaceComparisonCheckConfig.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Yoti\DocScan\Session\Create\Check;
+
+use stdClass;
+
+class RequestedFaceComparisonCheckConfig implements RequestedCheckConfigInterface
+{
+    /**
+     * @var string
+     */
+    private $manualCheck;
+
+    public function __construct(string $manualCheck)
+    {
+        $this->manualCheck = $manualCheck;
+    }
+
+    /**
+     * @return stdClass
+     */
+    public function jsonSerialize(): stdClass
+    {
+        return (object) [
+            'manual_check' => $this->getManualCheck(),
+        ];
+    }
+
+    /**
+     * @return string
+     */
+    public function getManualCheck(): string
+    {
+        return $this->manualCheck;
+    }
+}

tests/DocScan/Session/Create/Check/RequestedFaceComparisonCheckBuilderTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Yoti\Test\DocScan\Session\Create\Check;
+
+use Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheck;
+use Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheckBuilder;
+use Yoti\Test\TestCase;
+
+/**
+ * @coversDefaultClass \Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheckBuilder
+ */
+class RequestedFaceComparisonCheckBuilderTest extends TestCase
+{
+    /**
+     * @test
+     * @covers ::withManualCheckAlways
+     * @covers ::setManualCheck
+     * @covers ::build
+     */
+    public function shouldCorrectlyBuildRequestedFaceMatchCheck()
+    {
+        $result = (new RequestedFaceComparisonCheckBuilder())
+            ->withManualCheckNever()
+            ->build();
+
+        $this->assertInstanceOf(RequestedFaceComparisonCheck::class, $result);
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheck::jsonSerialize
+     * @covers ::withManualCheckNever
+     * @covers ::setManualCheck
+     * @covers ::build
+     * @covers \Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheck::__construct
+     * @covers \Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheck::getConfig
+     * @covers \Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheck::getType
+     */
+    public function shouldReturnTheCorrectValuesWhenManualCheckIsNever()
+    {
+        $result = (new RequestedFaceComparisonCheckBuilder())
+            ->withManualCheckNever()
+            ->build();
+
+        $expected = [
+            'type' => 'FACE_COMPARISON',
+            'config' => [
+                'manual_check' => 'NEVER',
+            ],
+        ];
+
+        $this->assertJsonStringEqualsJsonString(json_encode($expected), json_encode($result));
+    }
+}

tests/DocScan/Session/Create/Check/RequestedFaceComparisonCheckConfigTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Yoti\Test\DocScan\Session\Create\Check;
+
+use Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheckConfig;
+use Yoti\Test\TestCase;
+
+/**
+ * @coversDefaultClass \Yoti\DocScan\Session\Create\Check\RequestedFaceComparisonCheckConfig
+ */
+class RequestedFaceComparisonCheckConfigTest extends TestCase
+{
+    private const SOME_MANUAL_CHECK = 'someManualCheck';
+
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::getManualCheck
+     */
+    public function shouldHoldValuesCorrectly()
+    {
+        $result = new RequestedFaceComparisonCheckConfig(self::SOME_MANUAL_CHECK);
+
+        $this->assertEquals(self::SOME_MANUAL_CHECK, $result->getManualCheck());
+    }
+
+    /**
+     * @test
+     * @covers ::jsonSerialize
+     */
+    public function shouldSerializeToJsonCorrectly()
+    {
+        $result = new RequestedFaceComparisonCheckConfig(self::SOME_MANUAL_CHECK);
+
+        $expected = [
+            'manual_check' => self::SOME_MANUAL_CHECK,
+        ];
+
+        $this->assertJsonStringEqualsJsonString(json_encode($expected), json_encode($result));
+    }
+}