Merge pull request #255 from getyoti/master

LuborRod · web-flow · commit 8e468bea45e0 · 2022-01-10T15:10:31.000+02:00
Master -&gt; Development
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -57,8 +57,6 @@ jobs:
 
       - run: composer test
 
-      - run: composer lint
-
   guzzle:
     name: Unit Tests With Guzzle 6 (php ${{ matrix.php-version }})
     runs-on: ubuntu-latest
@@ -87,8 +85,6 @@ jobs:
 
       - run: composer test
 
-      - run: composer lint
-
   protobuf:
     name: Unit Tests With Protobuf C Extension 3.13 (php ${{ matrix.php-version }})
     runs-on: ubuntu-latest
@@ -116,5 +112,3 @@ jobs:
 
       - run: composer test
 
-      - run: composer lint
-
diff --git a/examples/doc-scan/app/Http/Controllers/HomeController.php b/examples/doc-scan/app/Http/Controllers/HomeController.php
@@ -34,13 +34,6 @@ public function show(Request $request, DocScanClient $client)
             ->withAdverseMediaCategory()
             ->build();
 
-        $watchlistAdvancedConfig = (new RequestedYotiAccountWatchlistAdvancedCaConfigBuilder())
-            ->withRemoveDeceased(true)
-            ->withShareUrl(false)
-            ->withSources(new RequestedSearchProfileSources('SOME_PROFILE'))
-            ->withMatchingStrategy(new RequestedFuzzyMatchingStrategy(0.5))
-            ->build();
-
         $sessionSpec = (new SessionSpecificationBuilder())
             ->withClientSessionTokenTtl(600)
             ->withResourcesTtl(90000)
@@ -72,11 +65,6 @@ public function show(Request $request, DocScanClient $client)
                     ->withConfig($watchScreeningConfig)
                     ->build()
             )
-            ->withRequestedCheck(
-                (new RequestedWatchlistAdvancedCaCheckBuilder())
-                    ->withConfig($watchlistAdvancedConfig)
-                    ->build()
-            )
             ->withRequestedTask(
                 (new RequestedTextExtractionTaskBuilder())
                     ->withManualCheckAlways()
diff --git a/examples/doc-scan/composer.json b/examples/doc-scan/composer.json
@@ -3,12 +3,12 @@
     "description": "Yoti SDK Profile Demo",
     "license": "MIT",
     "require": {
-        "php": "^7.2.5",
+        "php": "^8.0",
         "fideloper/proxy": "^4.2",
         "fruitcake/laravel-cors": "^1.0",
         "guzzlehttp/guzzle": "^6.3",
-        "laravel/framework": "^7.0",
-        "laravel/tinker": "^2.0",
+        "laravel/framework": "^8.0",
+        "laravel/tinker": "^2.3.0",
         "yoti/yoti-php-sdk": "^3.0"
     },
     "require-dev": {
diff --git a/examples/docker/php.dockerfile b/examples/docker/php.dockerfile
@@ -1,3 +1,3 @@
-FROM php:7-fpm-alpine
+FROM php:8-fpm-alpine
 
 COPY php.ini /usr/local/etc/php/conf.d/php.ini
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -3,7 +3,7 @@ sonar.organization = getyoti
 
 sonar.projectKey = getyoti:php
 sonar.projectName = PHP SDK
-sonar.projectVersion = 3.6.0
+sonar.projectVersion = 3.7.0
 
 sonar.language = php
 sonar.sources=src
diff --git a/src/DocScan/DocScanClient.php b/src/DocScan/DocScanClient.php
@@ -129,6 +129,8 @@ public function deleteMediaContent(string $sessionId, string $mediaId): void
     }
 
     /**
+     * Gets a list of supported documents.
+     *
      * @param bool $isStrictlyLatin
      * @return SupportedDocumentsResponse
      * @throws Exception\DocScanException
@@ -139,6 +141,9 @@ public function getSupportedDocuments(bool $isStrictlyLatin = false): SupportedD
     }
 
     /**
+     * Creates a Face Capture resource, that will be linked using
+     * the supplied requirement ID
+     *
      * @param string $sessionId
      * @param CreateFaceCaptureResourcePayload $createFaceCaptureResourcePayload
      * @return Session\Retrieve\CreateFaceCaptureResourceResponse
@@ -152,6 +157,8 @@ public function createFaceCaptureResource(
     }
 
     /**
+     * Uploads an image to the specified Face Capture resource
+     *
      * @param string $sessionId
      * @param string $resourceId
      * @param UploadFaceCaptureImagePayload $uploadFaceCaptureImagePayload
@@ -178,6 +185,8 @@ public function getSessionConfiguration(string $sessionId): SessionConfiguration
     }
 
     /**
+     * Sets the IBV instructions for the given session
+     *
      * @throws Exception\DocScanException
      */
     public function putIbvInstructions(string $sessionId, Instructions $instructions): void
diff --git a/src/DocScan/Session/Retrieve/Contracts/WatchlistAdvancedCaSearchConfigResponse.php b/src/DocScan/Session/Retrieve/Contracts/WatchlistAdvancedCaSearchConfigResponse.php
@@ -62,4 +62,12 @@ public function getMatchingStrategy(): CaMatchingStrategyResponse
     {
         return $this->matchingStrategy;
     }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
 }
diff --git a/src/Http/MultipartEntity.php b/src/Http/MultipartEntity.php
@@ -17,6 +17,9 @@ class MultipartEntity
      */
     private $multipartData;
 
+    /**
+     *  This constructor is private, because of you have to create objects only by static method 'create'
+     */
     private function __construct()
     {
     }
@@ -62,4 +65,20 @@ public function createStream(): StreamInterface
     {
         return new MultipartStream($this->multipartData, $this->multipartBoundary);
     }
+
+    /**
+     * @return string
+     */
+    public function getMultipartBoundary(): string
+    {
+        return $this->multipartBoundary;
+    }
+
+    /**
+     * @return array[]
+     */
+    public function getMultipartData(): array
+    {
+        return $this->multipartData;
+    }
 }
diff --git a/tests/DocScan/Session/Create/Check/IssuingAuthoritySubCheckTest.php b/tests/DocScan/Session/Create/Check/IssuingAuthoritySubCheckTest.php
@@ -15,6 +15,7 @@ class IssuingAuthoritySubCheckTest extends TestCase
      * @test
      * @covers ::__construct
      * @covers ::isRequested
+     * @covers ::getFilter
      * @covers \Yoti\DocScan\Session\Create\Check\IssuingAuthoritySubCheckBuilder::withDocumentFilter
      * @covers \Yoti\DocScan\Session\Create\Check\IssuingAuthoritySubCheckBuilder::withRequested
      * @covers \Yoti\DocScan\Session\Create\Check\IssuingAuthoritySubCheckBuilder::build
@@ -30,5 +31,6 @@ public function withRequestedAndDocumentFilterShouldSetTheValueCorrectly()
 
         $this->assertTrue($result->isRequested());
         $this->assertInstanceOf(DocumentFilter::class, $result->getFilter());
+        $this->assertEquals($documentFilterMock, $result->getFilter());
     }
 }
diff --git a/tests/DocScan/Session/Retrieve/Configuration/Capture/CaptureResponseTest.php b/tests/DocScan/Session/Retrieve/Configuration/Capture/CaptureResponseTest.php
@@ -97,7 +97,9 @@ public function shouldFilterRequiredSources(): void
         $result = new CaptureResponse($input);
 
         $this->assertCount(4, $result->getRequiredResources());
+        $this->assertCount(2, $result->getDocumentResourceRequirements());
         $this->assertCount(1, $result->getIdDocumentResourceRequirements());
+        $this->assertCount(1, $result->getLivenessResourceRequirements());
         $this->assertCount(1, $result->getSupplementaryResourceRequirements());
         $this->assertCount(1, $result->getZoomLivenessResourceRequirements());
         $this->assertCount(1, $result->getFaceCaptureResourceRequirements());
diff --git a/tests/DocScan/Session/Retrieve/Configuration/Capture/Document/RequiredDocumentResponsesTest.php b/tests/DocScan/Session/Retrieve/Configuration/Capture/Document/RequiredDocumentResponsesTest.php
@@ -6,6 +6,9 @@
 use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Document\ObjectiveResponse;
 use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Document\RequiredIdDocumentResourceResponse;
 use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Document\RequiredSupplementaryDocumentResourceResponse;
+use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Task\RequestedIdDocTaskResponse;
+use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Task\RequestedSupplementaryDocTaskResponse;
+use Yoti\DocScan\Session\Retrieve\Configuration\Capture\Task\UnknownRequestedTaskResponse;
 use Yoti\Test\TestCase;
 
 /**
@@ -81,6 +84,12 @@ public function shouldBuildCorrectly()
         $this->assertEquals(self::SOME_ATTEMPTS, $requiredIdDocumentResourceResponse->getAttemptsRemaining());
         $this->assertCount(1, $requiredIdDocumentResourceResponse->getSupportedCountries());
 
+        $expectedRequestedTasks = [
+            new RequestedIdDocTaskResponse(['type' => 'ID_DOCUMENT_TEXT_DATA_EXTRACTION']),
+            new RequestedSupplementaryDocTaskResponse(['type' => 'SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION']),
+            new UnknownRequestedTaskResponse(),
+        ];
+
         $inputForSupplementary = [
             'type' => self::SOME_TYPE,
             'id' => self::SOME_ID,
@@ -113,5 +122,9 @@ public function shouldBuildCorrectly()
             ObjectiveResponse::class,
             $requiredSupplementaryDocumentResourceResponse->getObjective()
         );
+        $this->assertEquals(
+            $expectedRequestedTasks,
+            $requiredSupplementaryDocumentResourceResponse->getRequestedTasks()
+        );
     }
 }
diff --git a/tests/DocScan/Session/Retrieve/Configuration/Capture/RequiredResourceResponseTest.php b/tests/DocScan/Session/Retrieve/Configuration/Capture/RequiredResourceResponseTest.php
@@ -7,6 +7,7 @@
 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;
 use Yoti\Test\TestCase;
 
 /**
@@ -62,4 +63,29 @@ public function shouldBuildCorrectly()
 
         $this->assertTrue($result->isRelyingBusinessAllowed());
     }
+
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::isRelyingBusinessAllowed
+     * @covers ::createAllowedSourceFromArray
+     */
+    public function shouldHaveIsRelyingBusinessFalseAndUnknownSource()
+    {
+        $input = [
+            'type' => self::SOME_TYPE,
+            'id' => self::SOME_ID,
+            'state' => self::SOME_STATE,
+            'allowed_sources' => [
+                [
+                    'type' => 'Unknown',
+                ],
+            ]
+        ];
+
+        $result = new RequiredResourceResponse($input);
+
+        $this->assertFalse($result->isRelyingBusinessAllowed());
+        $this->assertInstanceOf(UnknownAllowedSourceResponse::class, $result->getAllowedSources()[0]);
+    }
 }
diff --git a/tests/DocScan/Session/Retrieve/ResourceContainerTest.php b/tests/DocScan/Session/Retrieve/ResourceContainerTest.php
@@ -20,6 +20,8 @@ class ResourceContainerTest extends TestCase
      * @covers ::parseLivenessCapture
      * @covers ::getIdDocuments
      * @covers ::getLivenessCapture
+     * @covers ::getFaceCapture
+     * @covers ::parseFaceCapture
      * @covers ::parseSupplementaryDocuments
      * @covers ::getSupplementaryDocuments
      */
@@ -38,6 +40,9 @@ public function shouldBuildCorrectly()
                 [ 'liveness_type' => 'ZOOM' ],
                 [ 'liveness_type' => 'someUnknownType' ],
             ],
+            'face_capture' => [
+                ['id' => 'SOME_ID']
+            ]
         ];
 
         $result = new ResourceContainer($input);
@@ -46,6 +51,7 @@ public function shouldBuildCorrectly()
         $this->assertCount(2, $result->getLivenessCapture());
         $this->assertCount(1, $result->getZoomLivenessResources());
         $this->assertCount(2, $result->getSupplementaryDocuments());
+        $this->assertCount(1, $result->getFaceCapture());
     }
 
     /**
diff --git a/tests/Http/MultipartEntityTest.php b/tests/Http/MultipartEntityTest.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace Yoti\Test\Http;
+
+use Psr\Http\Message\StreamInterface;
+use Yoti\Http\MultipartEntity;
+use Yoti\Test\TestCase;
+
+/**
+ * @coversDefaultClass \Yoti\Http\MultipartEntity
+ */
+class MultipartEntityTest extends TestCase
+{
+    /**
+     * @test
+     * @covers ::create
+     */
+    public function shouldCorrectlyCreateObjectTest()
+    {
+        $newEntity = MultipartEntity::create();
+
+        $this->assertInstanceOf(MultipartEntity::class, $newEntity);
+    }
+
+    /**
+     * @test
+     * @covers ::setBoundary
+     * @covers ::getMultipartBoundary
+     * @covers ::addBinaryBody
+     * @covers ::getMultipartData
+     * @covers ::createStream
+     */
+    public function shouldCorrectCreateStream()
+    {
+        $name = 'SOME_NAME';
+        $payload = ['SOME_PAYLOAD'];
+        $contentType = 'SOME_TYPE';
+        $fileName = 'SOME_FILENAME';
+
+        $multipartBoundary = 'SOME';
+
+        $multipartData = [
+            [
+                'name' => $name,
+                'contents' => json_encode($payload),
+                'filename' => $fileName,
+                'headers' => ['Content-type' => $contentType]
+            ]
+        ];
+
+
+        $newEntity = MultipartEntity::create();
+        $newEntity->setBoundary($multipartBoundary);
+        $newEntity->addBinaryBody($name, $payload, $contentType, $fileName);
+
+        $stream = $newEntity->createStream();
+
+        $this->assertEquals($multipartBoundary, $newEntity->getMultipartBoundary());
+        $this->assertEquals($multipartData, $newEntity->getMultipartData());
+        $this->assertInstanceOf(StreamInterface::class, $stream);
+    }
+}
diff --git a/tests/Http/RequestBuilderTest.php b/tests/Http/RequestBuilderTest.php
@@ -121,6 +121,22 @@ public function testWithPost()
         $this->assertEquals('POST', $message->getMethod());
     }
 
+    /**
+     * @covers ::build
+     * @covers ::withPut
+     */
+    public function testWithPut()
+    {
+        $request = (new RequestBuilder())
+            ->withBaseUrl(self::SOME_BASE_URL)
+            ->withPemFilePath(TestData::PEM_FILE)
+            ->withPut()
+            ->build();
+
+        $message = $request->getMessage();
+        $this->assertEquals('PUT', $message->getMethod());
+    }
+
     /**
      * @covers ::build
      * @covers ::withGet

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-FROM php:7-fpm-alpine`
	`1`	`+FROM php:8-fpm-alpine`
`2`	`2`
`3`	`3`	`COPY php.ini /usr/local/etc/php/conf.d/php.ini`
Original file line number	Diff line number	Diff line change
`@@ -62,4 +62,12 @@ public function getMatchingStrategy(): CaMatchingStrategyResponse`
`62`	`62`	`{`
`63`	`63`	`return $this->matchingStrategy;`
`64`	`64`	`}`
	`65`	`+`
	`66`	`+ /**`
	`67`	`+ * @return string`
	`68`	`+ */`
	`69`	`+ public function getType(): string`
	`70`	`+ {`
	`71`	`+ return $this->type;`
	`72`	`+ }`
`65`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,9 @@ class MultipartEntity`
`17`	`17`	`*/`
`18`	`18`	`private $multipartData;`
`19`	`19`
	`20`	`+ /**`
	`21`	`+ * This constructor is private, because of you have to create objects only by static method 'create'`
	`22`	`+ */`
`20`	`23`	`private function __construct()`
`21`	`24`	`{`
`22`	`25`	`}`
`@@ -62,4 +65,20 @@ public function createStream(): StreamInterface`
`62`	`65`	`{`
`63`	`66`	`return new MultipartStream($this->multipartData, $this->multipartBoundary);`
`64`	`67`	`}`
	`68`	`+`
	`69`	`+ /**`
	`70`	`+ * @return string`
	`71`	`+ */`
	`72`	`+ public function getMultipartBoundary(): string`
	`73`	`+ {`
	`74`	`+ return $this->multipartBoundary;`
	`75`	`+ }`
	`76`	`+`
	`77`	`+ /**`
	`78`	`+ * @return array[]`
	`79`	`+ */`
	`80`	`+ public function getMultipartData(): array`
	`81`	`+ {`
	`82`	`+ return $this->multipartData;`
	`83`	`+ }`
`65`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ class IssuingAuthoritySubCheckTest extends TestCase`
`15`	`15`	`* @test`
`16`	`16`	`* @covers ::__construct`
`17`	`17`	`* @covers ::isRequested`
	`18`	`+ * @covers ::getFilter`
`18`	`19`	`* @covers \Yoti\DocScan\Session\Create\Check\IssuingAuthoritySubCheckBuilder::withDocumentFilter`
`19`	`20`	`* @covers \Yoti\DocScan\Session\Create\Check\IssuingAuthoritySubCheckBuilder::withRequested`
`20`	`21`	`* @covers \Yoti\DocScan\Session\Create\Check\IssuingAuthoritySubCheckBuilder::build`
`@@ -30,5 +31,6 @@ public function withRequestedAndDocumentFilterShouldSetTheValueCorrectly()`
`30`	`31`
`31`	`32`	`$this->assertTrue($result->isRequested());`
`32`	`33`	`$this->assertInstanceOf(DocumentFilter::class, $result->getFilter());`
	`34`	`+ $this->assertEquals($documentFilterMock, $result->getFilter());`
`33`	`35`	`}`
`34`	`36`	`}`