SDK-2050 Add non-latin to DocumentRestrictionsFilter (#261)

Co-authored-by: Rodion Liuborets <[email protected]>

Author: LuborRod

src/DocScan/Session/Create/Filters/Document/DocumentRestrictionsFilter.php

@@ -20,11 +20,17 @@ class DocumentRestrictionsFilter extends DocumentFilter implements \JsonSerializ
      */
     private $documents;
 
+    /**
+     * @var bool|null
+     */
+    private $allowNonLatinDocuments;
+
     /**
      * @param string $inclusion
      * @param DocumentRestriction[] $documents
+     * @param bool|null $allowNonLatinDocuments
      */
-    public function __construct(string $inclusion, array $documents)
+    public function __construct(string $inclusion, array $documents, ?bool $allowNonLatinDocuments)
     {
         parent::__construct(Constants::DOCUMENT_RESTRICTIONS);
 
@@ -34,6 +40,7 @@ public function __construct(string $inclusion, array $documents)
         Validation::notEmptyArray($documents, 'documents');
         Validation::isArrayOfType($documents, [DocumentRestriction::class], 'documents');
         $this->documents = $documents;
+        $this->allowNonLatinDocuments = $allowNonLatinDocuments;
     }
 
     /**
@@ -44,6 +51,19 @@ public function jsonSerialize(): \stdClass
         $jsonData = parent::jsonSerialize();
         $jsonData->inclusion = $this->inclusion;
         $jsonData->documents = $this->documents;
+
+        if (isset($this->allowNonLatinDocuments)) {
+            $jsonData->allow_non_latin_documents = $this->allowNonLatinDocuments;
+        }
+
         return $jsonData;
     }
+
+    /**
+     * @return bool|null
+     */
+    public function isAllowNonLatinDocuments(): ?bool
+    {
+        return $this->allowNonLatinDocuments;
+    }
 }

src/DocScan/Session/Create/Filters/Document/DocumentRestrictionsFilterBuilder.php

@@ -20,6 +20,11 @@ class DocumentRestrictionsFilterBuilder
      */
     private $documents = [];
 
+    /**
+     * @var bool|null
+     */
+    private $allowNonLatinDocuments;
+
     /**
      * @return $this
      */
@@ -49,12 +54,25 @@ public function withDocumentRestriction(DocumentRestriction $documentRestriction
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    public function withAllowNonLatinDocuments(): self
+    {
+        $this->allowNonLatinDocuments = true;
+        return $this;
+    }
+
     /**
      * @return DocumentRestrictionsFilter
      */
     public function build(): DocumentFilter
     {
         Validation::notEmptyString($this->inclusion, 'inclusion');
-        return new DocumentRestrictionsFilter($this->inclusion, $this->documents);
+        return new DocumentRestrictionsFilter(
+            $this->inclusion,
+            $this->documents,
+            $this->allowNonLatinDocuments
+        );
     }
 }

tests/DocScan/Session/Create/Filters/Document/DocumentRestrictionsFilterBuilderTest.php

@@ -66,12 +66,14 @@ public function shouldBuildDocumentRestrictionsFilterForBlacklist()
         $filter = (new DocumentRestrictionsFilterBuilder())
             ->forBlacklist()
             ->withDocumentRestriction($this->documentRestrictionMock)
+            ->withAllowNonLatinDocuments()
             ->build();
 
         $this->assertJsonStringEqualsJsonString(
             json_encode(
                 (object) [
                     'type' => 'DOCUMENT_RESTRICTIONS',
+                    'allow_non_latin_documents' => true,
                     'inclusion' => 'BLACKLIST',
                     'documents' => [ $this->documentRestrictionMock ],
                 ]
@@ -109,4 +111,46 @@ public function shouldThrowExceptionWithoutDocumentRestriction()
             ->forWhitelist()
             ->build();
     }
+
+    /**
+     * @test
+     *
+     * @covers ::build
+     * @covers \Yoti\DocScan\Session\Create\Filters\Document\DocumentRestrictionsFilter::__construct
+     * @covers \Yoti\DocScan\Session\Create\Filters\Document\DocumentRestrictionsFilter::isAllowNonLatinDocuments
+     * @covers ::forBlacklist
+     * @covers ::withAllowNonLatinDocuments
+     * @covers ::withDocumentRestriction
+     * @covers ::build
+     */
+    public function shouldBuildWithAllowNonLatinDocuments(): void
+    {
+        $filter = (new DocumentRestrictionsFilterBuilder())
+            ->forBlacklist()
+            ->withDocumentRestriction($this->documentRestrictionMock)
+            ->withAllowNonLatinDocuments()
+            ->build();
+
+        $this->assertTrue($filter->isAllowNonLatinDocuments());
+    }
+
+    /**
+     * @test
+     *
+     * @covers ::build
+     * @covers \Yoti\DocScan\Session\Create\Filters\Document\DocumentRestrictionsFilter::__construct
+     * @covers \Yoti\DocScan\Session\Create\Filters\Document\DocumentRestrictionsFilter::isAllowNonLatinDocuments
+     * @covers ::forBlacklist
+     * @covers ::withDocumentRestriction
+     * @covers ::build
+     */
+    public function shouldBuildAndAllowNonLatinDocumentsEqualsNull(): void
+    {
+        $filter = (new DocumentRestrictionsFilterBuilder())
+            ->forBlacklist()
+            ->withDocumentRestriction($this->documentRestrictionMock)
+            ->build();
+
+        $this->assertNull($filter->isAllowNonLatinDocuments());
+    }
 }