Master -> Development (#308)

LuborRod · web-flow · commit e1c7807c0adb · 2022-12-09T16:46:19.000+02:00
* Release 4.1.0 * Add helper method to GetSessionResult getFaceComparisonChecks * Add several fixes, update php8.0 -> 8.1, guzzlehttp/guzzle -> 7.0, guzzlehttp/psr7 -> 2.4 * Update github actions php8.0 -> 8.1 * Update github actions for sonar check php8.0 -> 8.1 * Remove support of php7.1 * Modify sonar config for php8.1 * Add php7.4, php8.0 support * Add php7.4, php8.0 support * Update README.md (#306)
diff --git a/.github/workflows/sonar.yaml b/.github/workflows/sonar.yaml
@@ -19,7 +19,7 @@ jobs:
           fetch-depth: 0
       - uses: shivammathur/setup-php@2.9.0
         with:
-          php-version: 8.0
+          php-version: 8.1
 
       - run: composer install
       - run: composer coverage-clover
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -2,8 +2,8 @@ name: Unit Tests
 on: [ push, pull_request_target ]
 
 jobs:
-  php8compat:
-    name: Unit Tests PHP8 Compatibility (php ${{ matrix.php-version }})
+  php8-1:
+    name: Unit Tests php8.1 (php ${{ matrix.php-version }})
     runs-on: ubuntu-latest
     # always run on push events
     # only run on pull_request_target event when pull request pulls from fork repository
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: [ 8.0 ]
+        php-version: [ 8.1 ]
 
     steps:
       - uses: actions/checkout@v2
@@ -31,14 +31,14 @@ jobs:
 
       - run: composer test
 
-  php7:
-    name: Unit Tests (php ${{ matrix.php-version }})
+  php7-4:
+    name: Unit Tests php7.4 (php ${{ matrix.php-version }})
     runs-on: ubuntu-latest
     # always run on push events
     # only run on pull_request_target event when pull request pulls from fork repository
     if: >
       github.event_name == 'push' || 
-      github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name != github.repository 
+      github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       fail-fast: false
       matrix:
@@ -57,6 +57,32 @@ jobs:
 
       - run: composer test
 
+  php8-0:
+    name: Unit Tests php8.0 (php ${{ matrix.php-version }})
+    runs-on: ubuntu-latest
+    # always run on push events
+    # only run on pull_request_target event when pull request pulls from fork repository
+    if: >
+      github.event_name == 'push' || 
+      github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name != github.repository
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: [ 8.0 ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: shivammathur/setup-php@2.9.0
+        with:
+          php-version: ${{ matrix.php-version }}
+
+      - run: composer self-update
+
+      - run: composer install --no-interaction --prefer-source --dev
+
+      - run: composer test
+
   protobuf:
     name: Unit Tests With Protobuf C Extension 3.13 (php ${{ matrix.php-version }})
     runs-on: ubuntu-latest
@@ -68,7 +94,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: [ 7.4 ]
+        php-version: [ 8.1 ]
 
     steps:
       - uses: actions/checkout@v2
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -5,7 +5,9 @@
     ->in(__DIR__ . '/tests')
 ;
 
-return PhpCsFixer\Config::create()
+$config = new PhpCsFixer\Config();
+$config
+    ->setRiskyAllowed(true)
     ->setRules([
         'array_syntax' => ['syntax' => 'short'],
         'no_unused_imports' => true,
@@ -22,3 +24,5 @@
     ])
     ->setFinder($finder)
 ;
+
+return $config;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -32,7 +32,7 @@ composer coverage-clover
 We follow the [PSR-12 Style Guide](https://www.php-fig.org/psr/psr-12/), which
 is configured in [.phpcs.xml.dist](.phpcs.xml.dist).
 
-Additional checks are configured in [.php_cs.dist](.php_cs.dist) - See
+Additional checks are configured in [.php-cs-fixer.dist.php](.php-cs-fixer.dist.php) - See
 <https://cs.symfony.com/> for further information.
 
 Coding style can be verified by running:
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Please feel free to reach out
 
 ## Requirements
 
-* PHP ^7.1
+* PHP ^7.4 || ^8.0 || ^8.1
 * CURL PHP extension (must support TLSv1.2)
 
 ### Recommended (optional)
@@ -42,13 +42,13 @@ Add the Yoti SDK dependency:
 
 ```json
 "require": {
-    "yoti/yoti-php-sdk" : "^3.0"
+    "yoti/yoti-php-sdk" : "^4.1"
 }
 ```
 
 Or run this Composer command
 ```console
-$ composer require yoti/yoti-php-sdk "^3.0"
+$ composer require yoti/yoti-php-sdk "^4.1"
 ```
 
 ## Setup
diff --git a/composer.json b/composer.json
@@ -1,22 +1,22 @@
 {
   "name": "yoti/yoti-php-sdk",
   "description": "Yoti SDK for quickly integrating your PHP backend with Yoti",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "keywords": [
     "yoti",
     "sdk"
   ],
   "homepage": "https://yoti.com",
   "license": "MIT",
   "require": {
-    "php": "^7.1 || ^8.0",
+    "php": "^7.4 || ^8.0 || ^8.1",
     "ext-json": "*",
     "google/protobuf": "^3.10",
     "phpseclib/phpseclib": "^3.0",
-    "guzzlehttp/guzzle": "^6.4 || ^7.0",
+    "guzzlehttp/guzzle": "^7.0",
     "psr/http-client": "^1.0",
     "psr/http-message": "^1.0",
-    "guzzlehttp/psr7": "^2.0",
+    "guzzlehttp/psr7": "^2.4",
     "ext-openssl": "*"
   },
   "autoload": {
@@ -27,7 +27,7 @@
   "require-dev": {
     "phpunit/phpunit": "^9.5.13",
     "squizlabs/php_codesniffer": "^3.4",
-    "friendsofphp/php-cs-fixer": "^2.15",
+    "friendsofphp/php-cs-fixer": "^3.4",
     "brainmaestro/composer-git-hooks": "^2.8",
     "phpstan/phpstan-strict-rules": "^0.12.1",
     "phpstan/extension-installer": "^1.0",
@@ -45,12 +45,12 @@
     "coverage-clover": "phpunit --coverage-clover ./coverage/coverage.xml",
     "coverage-html": "phpunit --coverage-html ./coverage/report",
     "fix": [
-      "php-cs-fixer fix --config=.php_cs.dist -v --using-cache=no --diff-format=udiff --ansi",
+      "php-cs-fixer fix --config=.php-cs-fixer.dist.php -v --using-cache=no",
       "phpcbf"
     ],
     "lint": [
       "phpcs",
-      "php-cs-fixer fix --config=.php_cs.dist -v --dry-run --using-cache=no --diff-format=udiff --ansi",
+      "php-cs-fixer fix --config=.php-cs-fixer.dist.php -v --dry-run --using-cache=no",
       "phpstan analyse"
     ],
     "post-install-cmd": "cghooks add --ignore-lock",
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 = '4.0.0';
+    public const SDK_VERSION = '4.1.0';
 
     /** 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/Filters/Document/DocumentRestrictionsFilter.php b/src/DocScan/Session/Create/Filters/Document/DocumentRestrictionsFilter.php
@@ -32,7 +32,7 @@ class DocumentRestrictionsFilter extends DocumentFilter implements \JsonSerializ
 
     /**
      * @param string $inclusion
-     * @param array $documents
+     * @param DocumentRestriction[] $documents
      * @param bool|null $allowNonLatinDocuments
      * @param bool|null $allowExpiredDocuments
      */
diff --git a/src/DocScan/Session/Retrieve/FaceCaptureImageResponse.php b/src/DocScan/Session/Retrieve/FaceCaptureImageResponse.php
@@ -2,17 +2,30 @@
 
 namespace Yoti\DocScan\Session\Retrieve;
 
+use Yoti\Exception\DateTimeException;
+
 class FaceCaptureImageResponse
 {
     /**
-     * @var MediaResponse $media
+     * @var null|MediaResponse $media
      */
     private $media;
 
     /**
-     * @return MediaResponse
+     * @param array<string,mixed> $image
+     * @throws DateTimeException
+     */
+    public function __construct(array $image)
+    {
+        if (isset($image['media'])) {
+            $this->media = new MediaResponse($image['media']);
+        }
+    }
+
+    /**
+     * @return null|MediaResponse
      */
-    public function getMedia(): MediaResponse
+    public function getMedia(): ?MediaResponse
     {
         return $this->media;
     }
diff --git a/src/DocScan/Session/Retrieve/FaceCaptureResourceResponse.php b/src/DocScan/Session/Retrieve/FaceCaptureResourceResponse.php
@@ -2,13 +2,29 @@
 
 namespace Yoti\DocScan\Session\Retrieve;
 
+use Yoti\Exception\DateTimeException;
+
 class FaceCaptureResourceResponse extends ResourceResponse
 {
     /**
      * @var FaceCaptureImageResponse $image
      */
     private $image;
 
+    /**
+     * FaceCaptureResourceResponse constructor.
+     * @param array<string, mixed> $faceCaptures
+     * @throws DateTimeException
+     */
+    public function __construct(array $faceCaptures)
+    {
+        parent::__construct($faceCaptures);
+
+        if (isset($faceCaptures['image'])) {
+            $this->image = new FaceCaptureImageResponse($faceCaptures['image']);
+        }
+    }
+
     /**
      * @return FaceCaptureImageResponse
      */
diff --git a/src/DocScan/Session/Retrieve/FaceComparisonCheckResponse.php b/src/DocScan/Session/Retrieve/FaceComparisonCheckResponse.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yoti\DocScan\Session\Retrieve;
+
+class FaceComparisonCheckResponse extends CheckResponse
+{
+}
diff --git a/src/DocScan/Session/Retrieve/GetSessionResult.php b/src/DocScan/Session/Retrieve/GetSessionResult.php
@@ -191,6 +191,14 @@ public function getFaceMatchChecks(): array
         return $this->filterCheckByType(FaceMatchCheckResponse::class);
     }
 
+    /**
+     * @return FaceComparisonCheckResponse[]
+     */
+    public function getFaceComparisonChecks(): array
+    {
+        return $this->filterCheckByType(FaceComparisonCheckResponse::class);
+    }
+
     /**
      * @deprecated replaced by ::getIdDocumentTextDataChecks()
      *
@@ -255,6 +263,8 @@ private function createCheckFromArray(array $check): CheckResponse
                 return new IdDocumentComparisonCheckResponse($check);
             case Constants::ID_DOCUMENT_FACE_MATCH:
                 return new FaceMatchCheckResponse($check);
+            case Constants::FACE_COMPARISON:
+                return new FaceComparisonCheckResponse($check);
             case Constants::ID_DOCUMENT_TEXT_DATA_CHECK:
                 return new TextDataCheckResponse($check);
             case Constants::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK:
diff --git a/src/DocScan/Session/Retrieve/ResourceResponse.php b/src/DocScan/Session/Retrieve/ResourceResponse.php
@@ -4,6 +4,10 @@
 
 use Yoti\DocScan\Constants;
 use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Source\AllowedSourceResponse;
+use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Source\EndUserAllowedSourceResponse;
+use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Source\IbvAllowedSourceResponse;
+use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Source\RelyingBusinessAllowedSourceResponse;
+use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Source\UnknownAllowedSourceResponse;
 
 class ResourceResponse
 {
@@ -35,6 +39,10 @@ public function __construct(array $resource)
                 $this->tasks[] = $this->createTaskFromArray($task);
             }
         }
+
+        if (isset($resource['source']['type'])) {
+            $this->source = $this->createSourceFromType($resource['source']['type']);
+        }
     }
 
     /**
@@ -100,4 +108,22 @@ private function createTaskFromArray(array $task): TaskResponse
                 return new TaskResponse($task);
         }
     }
+
+    /**
+     * @param string $type
+     * @return AllowedSourceResponse
+     */
+    private function createSourceFromType(string $type): AllowedSourceResponse
+    {
+        switch ($type ?? null) {
+            case Constants::END_USER:
+                return new EndUserAllowedSourceResponse();
+            case Constants::IBV:
+                return new IbvAllowedSourceResponse();
+            case Constants::RELYING_BUSINESS:
+                return new RelyingBusinessAllowedSourceResponse();
+            default:
+                return new UnknownAllowedSourceResponse();
+        }
+    }
 }
diff --git a/tests/DocScan/Session/Retrieve/FaceCaptureResourceResponseTest.php b/tests/DocScan/Session/Retrieve/FaceCaptureResourceResponseTest.php
diff --git a/tests/DocScan/Session/Retrieve/GetSessionResultTest.php b/tests/DocScan/Session/Retrieve/GetSessionResultTest.php
diff --git a/tests/DocScan/Session/Retrieve/ResourceResponseTest.php b/tests/DocScan/Session/Retrieve/ResourceResponseTest.php
