SDK-2042 Add supporting for fetching supported documents (#250)

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

Author: LuborRod

src/DocScan/DocScanClient.php

@@ -129,13 +129,13 @@ public function deleteMediaContent(string $sessionId, string $mediaId): void
     }
 
     /**
-     * Gets a list of supported documents.
-     *
+     * @param bool $isStrictlyLatin
      * @return SupportedDocumentsResponse
+     * @throws Exception\DocScanException
      */
-    public function getSupportedDocuments(): SupportedDocumentsResponse
+    public function getSupportedDocuments(bool $isStrictlyLatin = false): SupportedDocumentsResponse
     {
-        return $this->docScanService->getSupportedDocuments();
+        return $this->docScanService->getSupportedDocuments($isStrictlyLatin);
     }
 
     /**

src/DocScan/Service.php

@@ -185,17 +185,23 @@ public function deleteMediaContent(string $sessionId, string $mediaId): void
     }
 
     /**
-     * Gets a list of supported documents.
-     *
+     * @param bool $isStrictlyLatin
      * @return SupportedDocumentsResponse
+     * @throws DocScanException
      */
-    public function getSupportedDocuments(): SupportedDocumentsResponse
+    public function getSupportedDocuments(bool $isStrictlyLatin): SupportedDocumentsResponse
     {
-        $response = (new RequestBuilder($this->config))
+        $requestBuilder = (new RequestBuilder($this->config))
             ->withBaseUrl($this->apiUrl)
             ->withEndpoint('/supported-documents')
             ->withPemFile($this->pemFile)
-            ->withGet()
+            ->withGet();
+
+        if ($isStrictlyLatin) {
+            $requestBuilder->withQueryParam('includeNonLatin', '1');
+        }
+
+        $response = $requestBuilder
             ->build()
             ->execute();
 

src/DocScan/Support/SupportedDocument.php

@@ -11,12 +11,18 @@ class SupportedDocument
      */
     private $type;
 
+    /**
+     * @var bool|null
+     */
+    private $isStrictlyLatin;
+
     /**
      * @param array<string, mixed> $document
      */
     public function __construct(array $document)
     {
         $this->type = $document['type'] ?? null;
+        $this->isStrictlyLatin = $document['is_strictly_latin'] ?? null;
     }
 
     /**
@@ -26,4 +32,12 @@ public function getType(): ?string
     {
         return $this->type;
     }
+
+    /**
+     * @return bool|null
+     */
+    public function getIsStrictlyLatin(): ?bool
+    {
+        return $this->isStrictlyLatin;
+    }
 }

tests/DocScan/ServiceTest.php

@@ -576,8 +576,9 @@ public function getSupportedDocumentsShouldReturnSupportedDocuments()
                 $this->callback(
                     function (RequestInterface $requestMessage) {
                         $expectedPathPattern = sprintf(
-                            '~^%s/supported-documents.*?~',
-                            TestData::DOC_SCAN_BASE_URL
+                            '~^%s/supported-documents\?includeNonLatin=%s.*?~',
+                            TestData::DOC_SCAN_BASE_URL,
+                            TestData::INCLUDE_NON_LATIN
                         );
 
                         $this->assertEquals('GET', $requestMessage->getMethod());
@@ -600,7 +601,7 @@ function (RequestInterface $requestMessage) {
 
         $this->assertInstanceOf(
             SupportedDocumentsResponse::class,
-            $docScanService->getSupportedDocuments()
+            $docScanService->getSupportedDocuments(TestData::INCLUDE_NON_LATIN)
         );
     }
 
@@ -619,8 +620,9 @@ public function getSupportedDocumentsShouldThrowExceptionOnFailedCall()
                 $this->callback(
                     function (RequestInterface $requestMessage) {
                         $expectedPathPattern = sprintf(
-                            '~^%s/supported-documents.*?~',
-                            TestData::DOC_SCAN_BASE_URL
+                            '~^%s/supported-documents\?includeNonLatin=%s.*?~',
+                            TestData::DOC_SCAN_BASE_URL,
+                            TestData::INCLUDE_NON_LATIN
                         );
 
                         $this->assertEquals('GET', $requestMessage->getMethod());
@@ -644,7 +646,7 @@ function (RequestInterface $requestMessage) {
         $this->expectException(DocScanException::class);
         $this->expectExceptionMessage("Server responded with 404");
 
-        $docScanService->getSupportedDocuments();
+        $docScanService->getSupportedDocuments(TestData::INCLUDE_NON_LATIN);
     }
 
     /**

tests/DocScan/Support/SupportedDocumentTest.php

@@ -27,4 +27,21 @@ public function shouldHaveType()
 
         $this->assertEquals(self::SOME_DOCUMENT_TYPE, $supportedDocument->getType());
     }
+
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::getType
+     * @covers ::getIsStrictlyLatin
+     */
+    public function shouldHaveIsStrictlyLatinFlag()
+    {
+        $supportedDocument = new SupportedDocument([
+            'type' => self::SOME_DOCUMENT_TYPE,
+            'is_strictly_latin' => true,
+        ]);
+
+        $this->assertEquals(self::SOME_DOCUMENT_TYPE, $supportedDocument->getType());
+        $this->assertTrue($supportedDocument->getIsStrictlyLatin());
+    }
 }

tests/TestData.php

@@ -36,4 +36,5 @@ class TestData
     public const SOME_IMAGE_CONTENT_TYPE = 'someImageContentType';
     public const SOME_ID = 'someId';
     public const SOME_FRAMES = 1;
+    public const INCLUDE_NON_LATIN = true;
 }