Add JSON serialize methods

Rodion Liuborets · Rodion Liuborets · commit 5fe44d720015 · 2022-02-18T12:55:27.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ composer.lock
 phpcs.xml
 
 .phpunit.result.cache
+phpunit.xml.bak
 
 .php_cs.cache
 
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "yoti/yoti-php-sdk",
   "description": "Yoti SDK for quickly integrating your PHP backend with Yoti",
-  "version": "3.9.0",
+  "version": "3.9.1",
   "keywords": [
     "yoti",
     "sdk"
diff --git a/examples/doc-scan/app/Http/Controllers/HomeController.php b/examples/doc-scan/app/Http/Controllers/HomeController.php
@@ -5,8 +5,11 @@
 use Illuminate\Http\Request;
 use Illuminate\Routing\Controller as BaseController;
 use Yoti\DocScan\DocScanClient;
-use Yoti\DocScan\Session\Create\Check\Advanced\RequestedFuzzyMatchingStrategy;
-use Yoti\DocScan\Session\Create\Check\Advanced\RequestedSearchProfileSources;
+use Yoti\DocScan\Session\Create\Check\Advanced\RequestedExactMatchingStrategyBuilder;
+use Yoti\DocScan\Session\Create\Check\Advanced\RequestedFuzzyMatchingStrategyBuilder;
+use Yoti\DocScan\Session\Create\Check\Advanced\RequestedSearchProfileSourcesBuilder;
+use Yoti\DocScan\Session\Create\Check\Advanced\RequestedTypeListSourcesBuilder;
+use Yoti\DocScan\Session\Create\Check\RequestedCustomAccountWatchlistAdvancedCaConfigBuilder;
 use Yoti\DocScan\Session\Create\Check\RequestedDocumentAuthenticityCheckBuilder;
 use Yoti\DocScan\Session\Create\Check\RequestedFaceMatchCheckBuilder;
 use Yoti\DocScan\Session\Create\Check\RequestedIdDocumentComparisonCheckBuilder;
@@ -15,7 +18,6 @@
 use Yoti\DocScan\Session\Create\Check\RequestedWatchlistAdvancedCaCheckBuilder;
 use Yoti\DocScan\Session\Create\Check\RequestedWatchlistScreeningCheckBuilder;
 use Yoti\DocScan\Session\Create\Check\RequestedWatchlistScreeningConfigBuilder;
-use Yoti\DocScan\Session\Create\Check\RequestedYotiAccountWatchlistAdvancedCaConfigBuilder;
 use Yoti\DocScan\Session\Create\Filters\Orthogonal\OrthogonalRestrictionsFilterBuilder;
 use Yoti\DocScan\Session\Create\Filters\RequiredIdDocumentBuilder;
 use Yoti\DocScan\Session\Create\Filters\RequiredSupplementaryDocumentBuilder;
@@ -29,11 +31,43 @@ class HomeController extends BaseController
 {
     public function show(Request $request, DocScanClient $client)
     {
+        //WatchScreening Config
         $watchScreeningConfig = (new RequestedWatchlistScreeningConfigBuilder())
             ->withSanctionsCategory()
             ->withAdverseMediaCategory()
             ->build();
 
+        //Search Profiles Sources
+        $searchProfileSources = (new RequestedSearchProfileSourcesBuilder())
+            ->withSearchProfile("5c62a621-ed6a-4f07-89a1-a941c1733b7c")
+            ->build();
+
+        //TypeListSources
+        $typeListSources = (new RequestedTypeListSourcesBuilder())
+            ->withTypes(['type1', 'type2'])
+            ->build();
+
+        //FuzzyMatchingStrategy
+        $fuzzyMatchingStrategy = (new RequestedFuzzyMatchingStrategyBuilder())
+            ->withFuzziness(0.5)
+            ->build();
+
+        //ExactMatchingStrategy
+        $exactMatchingStrategy = (new RequestedExactMatchingStrategyBuilder())
+            ->build();
+
+        $customConfig = (new RequestedCustomAccountWatchlistAdvancedCaConfigBuilder())
+            ->withMatchingStrategy($exactMatchingStrategy)
+            ->withSources($searchProfileSources)
+            ->withShareUrl(false)
+            ->withRemoveDeceased(true)
+            ->withApiKey('qiKTHG7Mgqj31mK2d21F7QPpaVBp9zKc')
+            ->withClientRef("string")
+            ->withMonitoring(true)
+            ->withTags(['tag1'])
+            ->build();
+
+
         $sessionSpec = (new SessionSpecificationBuilder())
             ->withClientSessionTokenTtl(600)
             ->withResourcesTtl(90000)
@@ -47,6 +81,11 @@ public function show(Request $request, DocScanClient $client)
                     ->forZoomLiveness()
                     ->build()
             )
+            ->withRequestedCheck(
+                (new RequestedWatchlistAdvancedCaCheckBuilder())
+                    ->withConfig($customConfig)
+                    ->build()
+            )
             ->withRequestedCheck(
                 (new RequestedFaceMatchCheckBuilder())
                     ->withManualCheckAlways()
@@ -78,17 +117,17 @@ public function show(Request $request, DocScanClient $client)
             )
             ->withSdkConfig(
                 (new SdkConfigBuilder())
-                  ->withAllowsCameraAndUpload()
-                  ->withPrimaryColour('#2d9fff')
-                  ->withSecondaryColour('#FFFFFF')
-                  ->withFontColour('#FFFFFF')
-                  ->withLocale('en-GB')
-                  ->withPresetIssuingCountry('GBR')
-                  ->withSuccessUrl(config('app.url') . '/success')
-                  ->withErrorUrl(config('app.url') . '/error')
-                  ->withPrivacyPolicyUrl(config('app.url') . '/privacy-policy')
-                  ->build()
-              )
+                    ->withAllowsCameraAndUpload()
+                    ->withPrimaryColour('#2d9fff')
+                    ->withSecondaryColour('#FFFFFF')
+                    ->withFontColour('#FFFFFF')
+                    ->withLocale('en-GB')
+                    ->withPresetIssuingCountry('GBR')
+                    ->withSuccessUrl(config('app.url') . '/success')
+                    ->withErrorUrl(config('app.url') . '/error')
+                    ->withPrivacyPolicyUrl(config('app.url') . '/privacy-policy')
+                    ->build()
+            )
             ->withRequiredDocument(
                 (new RequiredIdDocumentBuilder())
                     ->withFilter(
@@ -118,9 +157,9 @@ public function show(Request $request, DocScanClient $client)
 
         return view('home', [
             'iframeUrl' => config('yoti')['doc.scan.iframe.url'] . '?' . http_build_query([
-                'sessionID' => $session->getSessionId(),
-                'sessionToken' => $session->getClientSessionToken(),
-            ])
+                    'sessionID' => $session->getSessionId(),
+                    'sessionToken' => $session->getClientSessionToken(),
+                ])
         ]);
     }
 }
diff --git a/src/Constants.php b/src/Constants.php
@@ -25,7 +25,7 @@ class Constants
     public const SDK_IDENTIFIER = 'PHP';
 
     /** Default SDK version */
-    public const SDK_VERSION = '3.9.0';
+    public const SDK_VERSION = '3.9.1';
 
     /** Base url for connect page (user will be redirected to this page eg. baseurl/app-id) */
     public const CONNECT_BASE_URL = 'https://www.yoti.com/connect';
diff --git a/src/DocScan/Session/Create/Check/Advanced/RequestedExactMatchingStrategy.php b/src/DocScan/Session/Create/Check/Advanced/RequestedExactMatchingStrategy.php
@@ -4,6 +4,7 @@
 
 namespace Yoti\DocScan\Session\Create\Check\Advanced;
 
+use Yoti\DocScan\Constants;
 use Yoti\DocScan\Session\Create\Check\Contracts\Advanced\RequestedCaMatchingStrategy;
 
 class RequestedExactMatchingStrategy extends RequestedCaMatchingStrategy
@@ -15,4 +16,12 @@ public function isExactMatch(): bool
     {
         return true;
     }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return Constants::EXACT;
+    }
 }
diff --git a/src/DocScan/Session/Create/Check/Advanced/RequestedFuzzyMatchingStrategy.php b/src/DocScan/Session/Create/Check/Advanced/RequestedFuzzyMatchingStrategy.php
@@ -4,6 +4,8 @@
 
 namespace Yoti\DocScan\Session\Create\Check\Advanced;
 
+use stdClass;
+use Yoti\DocScan\Constants;
 use Yoti\DocScan\Session\Create\Check\Contracts\Advanced\RequestedCaMatchingStrategy;
 
 class RequestedFuzzyMatchingStrategy extends RequestedCaMatchingStrategy
@@ -13,6 +15,9 @@ class RequestedFuzzyMatchingStrategy extends RequestedCaMatchingStrategy
      */
     private $fuzziness;
 
+    /**
+     * @param float $fuzziness
+     */
     public function __construct(float $fuzziness)
     {
         $this->fuzziness = $fuzziness;
@@ -25,4 +30,23 @@ public function getFuzziness(): float
     {
         return $this->fuzziness;
     }
+
+    /**
+     * @return stdClass
+     */
+    public function jsonSerialize(): stdClass
+    {
+        $json = parent::jsonSerialize();
+        $json->fuzziness = $this->getFuzziness();
+
+        return $json;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return Constants::FUZZY;
+    }
 }
diff --git a/src/DocScan/Session/Create/Check/Advanced/RequestedSearchProfileSources.php b/src/DocScan/Session/Create/Check/Advanced/RequestedSearchProfileSources.php
@@ -4,6 +4,8 @@
 
 namespace Yoti\DocScan\Session\Create\Check\Advanced;
 
+use stdClass;
+use Yoti\DocScan\Constants;
 use Yoti\DocScan\Session\Create\Check\Contracts\Advanced\RequestedCaSources;
 
 class RequestedSearchProfileSources extends RequestedCaSources
@@ -13,6 +15,9 @@ class RequestedSearchProfileSources extends RequestedCaSources
      */
     private $searchProfile;
 
+    /**
+     * @param string $searchProfile
+     */
     public function __construct(string $searchProfile)
     {
         $this->searchProfile = $searchProfile;
@@ -25,4 +30,23 @@ public function getSearchProfile(): string
     {
         return $this->searchProfile;
     }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return Constants::PROFILE;
+    }
+
+    /**
+     * @return stdClass
+     */
+    public function jsonSerialize(): stdClass
+    {
+        $json = parent::jsonSerialize();
+        $json->search_profile = $this->getSearchProfile();
+
+        return $json;
+    }
 }
diff --git a/src/DocScan/Session/Create/Check/Advanced/RequestedTypeListSources.php b/src/DocScan/Session/Create/Check/Advanced/RequestedTypeListSources.php
@@ -4,6 +4,8 @@
 
 namespace Yoti\DocScan\Session\Create\Check\Advanced;
 
+use stdClass;
+use Yoti\DocScan\Constants;
 use Yoti\DocScan\Session\Create\Check\Contracts\Advanced\RequestedCaSources;
 
 class RequestedTypeListSources extends RequestedCaSources
@@ -29,4 +31,23 @@ public function getTypes(): array
     {
         return $this->types;
     }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return Constants::TYPE_LIST;
+    }
+
+    /**
+     * @return stdClass
+     */
+    public function jsonSerialize(): stdClass
+    {
+        $json = parent::jsonSerialize();
+        $json->types = $this->getTypes();
+
+        return $json;
+    }
 }
diff --git a/src/DocScan/Session/Create/Check/Contracts/Advanced/RequestedCaMatchingStrategy.php b/src/DocScan/Session/Create/Check/Contracts/Advanced/RequestedCaMatchingStrategy.php
@@ -4,6 +4,28 @@
 
 namespace Yoti\DocScan\Session\Create\Check\Contracts\Advanced;
 
-abstract class RequestedCaMatchingStrategy
+use stdClass;
+use Yoti\Util\Json;
+
+abstract class RequestedCaMatchingStrategy implements \JsonSerializable
 {
+    /**
+     * @var string
+     */
+    public $type;
+
+    /**
+     * @return string
+     */
+    abstract public function getType(): string;
+
+    /**
+     * @return stdClass
+     */
+    public function jsonSerialize(): stdClass
+    {
+        return (object)Json::withoutNullValues([
+            'type' => $this->getType(),
+        ]);
+    }
 }
diff --git a/src/DocScan/Session/Create/Check/Contracts/Advanced/RequestedCaSources.php b/src/DocScan/Session/Create/Check/Contracts/Advanced/RequestedCaSources.php
@@ -4,6 +4,28 @@
 
 namespace Yoti\DocScan\Session\Create\Check\Contracts\Advanced;
 
-abstract class RequestedCaSources
+use stdClass;
+use Yoti\Util\Json;
+
+abstract class RequestedCaSources implements \JsonSerializable
 {
+    /**
+     * @var string
+     */
+    public $type;
+
+    /**
+     * @return string
+     */
+    abstract public function getType(): string;
+
+    /**
+     * @return stdClass
+     */
+    public function jsonSerialize(): stdClass
+    {
+        return (object)Json::withoutNullValues([
+            'type' => $this->getType(),
+        ]);
+    }
 }
diff --git a/src/DocScan/Session/Create/Check/Contracts/RequestedWatchlistAdvancedCaConfig.php b/src/DocScan/Session/Create/Check/Contracts/RequestedWatchlistAdvancedCaConfig.php
@@ -4,6 +4,7 @@
 
 namespace Yoti\DocScan\Session\Create\Check\Contracts;
 
+use stdClass;
 use Yoti\DocScan\Session\Create\Check\Contracts\Advanced\RequestedCaMatchingStrategy;
 use Yoti\DocScan\Session\Create\Check\Contracts\Advanced\RequestedCaSources;
 use Yoti\DocScan\Session\Create\Check\RequestedCheckConfigInterface;
@@ -30,6 +31,17 @@ abstract class RequestedWatchlistAdvancedCaConfig implements RequestedCheckConfi
      */
     private $matchingStrategy;
 
+    /**
+     * @return string
+     */
+    abstract public function getType(): string;
+
+    /**
+     * @param bool $removeDeceased
+     * @param bool $shareUrl
+     * @param RequestedCaSources $sources
+     * @param RequestedCaMatchingStrategy $matchingStrategy
+     */
     public function __construct(
         bool $removeDeceased,
         bool $shareUrl,
@@ -42,6 +54,7 @@ public function __construct(
         $this->matchingStrategy = $matchingStrategy;
     }
 
+
     /**
      * @return bool
      */
@@ -75,15 +88,16 @@ public function getMatchingStrategy(): RequestedCaMatchingStrategy
     }
 
     /**
-     * @return array<string, mixed>
+     * @return stdClass
      */
-    public function jsonSerialize(): array
+    public function jsonSerialize(): stdClass
     {
-        return [
+        return (object)[
             'remove_deceased' => $this->getRemoveDeceased(),
             'share_url' => $this->getShareUrl(),
             'sources' => $this->getSources(),
             'matching_strategy' => $this->getMatchingStrategy(),
+            'type' => $this->getType(),
         ];
     }
 }
diff --git a/src/DocScan/Session/Create/Check/RequestedCustomAccountWatchlistAdvancedCaConfig.php b/src/DocScan/Session/Create/Check/RequestedCustomAccountWatchlistAdvancedCaConfig.php
diff --git a/src/DocScan/Session/Create/Check/RequestedCustomAccountWatchlistAdvancedCaConfigBuilder.php b/src/DocScan/Session/Create/Check/RequestedCustomAccountWatchlistAdvancedCaConfigBuilder.php
diff --git a/src/DocScan/Session/Create/Check/RequestedYotiAccountWatchlistAdvancedCaConfig.php b/src/DocScan/Session/Create/Check/RequestedYotiAccountWatchlistAdvancedCaConfig.php
diff --git a/tests/DocScan/Session/Create/Check/RequestedCustomAccountWatchlistAdvancedCaConfigTest.php b/tests/DocScan/Session/Create/Check/RequestedCustomAccountWatchlistAdvancedCaConfigTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "yoti/yoti-php-sdk",`
`3`	`3`	`"description": "Yoti SDK for quickly integrating your PHP backend with Yoti",`
`4`		`- "version": "3.9.0",`
	`4`	`+ "version": "3.9.1",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"yoti",`
`7`	`7`	`"sdk"`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Yoti\DocScan\Session\Create\Check\Advanced;`
`6`	`6`
	`7`	`+use Yoti\DocScan\Constants;`
`7`	`8`	`use Yoti\DocScan\Session\Create\Check\Contracts\Advanced\RequestedCaMatchingStrategy;`
`8`	`9`
`9`	`10`	`class RequestedExactMatchingStrategy extends RequestedCaMatchingStrategy`
`@@ -15,4 +16,12 @@ public function isExactMatch(): bool`
`15`	`16`	`{`
`16`	`17`	`return true;`
`17`	`18`	`}`
	`19`	`+`
	`20`	`+ /**`
	`21`	`+ * @return string`
	`22`	`+ */`
	`23`	`+ public function getType(): string`
	`24`	`+ {`
	`25`	`+ return Constants::EXACT;`
	`26`	`+ }`
`18`	`27`	`}`