Return null when we receive 204 (#263)

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

Author: LuborRod

src/DocScan/DocScanClient.php

@@ -109,10 +109,10 @@ public function deleteSession(string $sessionId): void
      *
      * @param string $sessionId
      * @param string $mediaId
-     * @return Media
+     * @return Media|null
      * @throws Exception\DocScanException
      */
-    public function getMediaContent(string $sessionId, string $mediaId): Media
+    public function getMediaContent(string $sessionId, string $mediaId): ?Media
     {
         return $this->docScanService->getMediaContent($sessionId, $mediaId);
     }

src/DocScan/Service.php

@@ -28,6 +28,9 @@
 
 class Service
 {
+    /** @const int */
+    private const HTTP_STATUS_NO_CONTENT = 204;
+
     /**
      * @var string
      */
@@ -142,10 +145,10 @@ public function deleteSession(string $sessionId): void
      *
      * @param string $sessionId
      * @param string $mediaId
-     * @return Media
+     * @return Media|null if 204 No Content
      * @throws DocScanException
      */
-    public function getMediaContent(string $sessionId, string $mediaId): Media
+    public function getMediaContent(string $sessionId, string $mediaId): ?Media
     {
         $response = (new RequestBuilder($this->config))
             ->withBaseUrl($this->apiUrl)
@@ -158,6 +161,10 @@ public function getMediaContent(string $sessionId, string $mediaId): Media
 
         self::assertResponseIsSuccess($response);
 
+        if ($response->getStatusCode() == self::HTTP_STATUS_NO_CONTENT) {
+            return null;
+        }
+
         $content = (string)$response->getBody();
         $mimeType = $response->getHeader("Content-Type")[0] ?? '';
 

tests/DocScan/DocScanClientTest.php

@@ -226,6 +226,31 @@ public function testGetMedia()
         );
     }
 
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::getMediaContent
+     */
+    public function testGetMediaIfNoContent()
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->method('getStatusCode')->willReturn(204);
+        $response->method('getHeader')->willReturn([ 'image/png' ]);
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))
+            ->method('sendRequest')
+            ->willReturn($response);
+
+        $docScanClient = new DocScanClient(TestData::SDK_ID, TestData::PEM_FILE, [
+            Config::HTTP_CLIENT => $httpClient,
+        ]);
+
+        $this->assertNull(
+            $docScanClient->getMediaContent(TestData::DOC_SCAN_SESSION_ID, TestData::DOC_SCAN_MEDIA_ID)
+        );
+    }
+
     /**
      * @test
      * @covers ::__construct

tests/DocScan/ServiceTest.php

@@ -395,7 +395,7 @@ function (RequestInterface $requestMessage) {
      * @covers ::getMediaContent
      * @covers ::assertResponseIsSuccess
      */
-    public function getMediaContentShouldReturnMediaObjectWithNoContent()
+    public function getMediaContentShouldReturnNullWhenResponseWithNoContent()
     {
         $httpClient = $this->createMock(ClientInterface::class);
         $httpClient->expects($this->exactly(1))
@@ -419,9 +419,7 @@ public function getMediaContentShouldReturnMediaObjectWithNoContent()
         );
 
         $media = $docScanService->getMediaContent(TestData::DOC_SCAN_SESSION_ID, TestData::DOC_SCAN_MEDIA_ID);
-        $this->assertInstanceOf(Media::class, $media);
-        $this->assertEquals('', $media->getMimeType());
-        $this->assertEquals('', $media->getContent());
+        $this->assertNull($media);
     }
 
     /**