Merge pull request #3 from DoclerLabs/remove-specific-payload-handling-in-response-handler

Removed data key handling from ResponseHandler when handling payload

Author: Mikhail Bakulin

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.0.0] - 2020-08-31
+### Changed
+- The response handling in `ResponseHandler`: Removed "data" key handling when handling payload.
+
 ## [2.0.1] - 2020-08-24
 ### Fixed
 - The superkey "data" handling in ResponseHandler.

src/Response/Handler/ResponseHandler.php

@@ -11,6 +11,7 @@
 use DoclerLabs\ApiClientBase\Json\JsonException;
 use DoclerLabs\ApiClientBase\Response\Response;
 use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
 
 class ResponseHandler implements ResponseHandlerInterface
 {
@@ -28,45 +29,47 @@ class ResponseHandler implements ResponseHandlerInterface
      */
     public function handle(ResponseInterface $response): Response
     {
-        $statusCode = $response->getStatusCode();
-        $body       = $response->getBody();
-        $headers    = $response->getHeaders();
+        $statusCode          = $response->getStatusCode();
+        $body                = $response->getBody();
+        $headers             = $response->getHeaders();
+        $isResponseBodyEmpty = $this->isResponseBodyEmpty($body);
+        $responseBody        = '';
+
+        if (!$isResponseBodyEmpty) {
+            $responseBody = (string)$body;
+        }
 
         if ($statusCode >= 200 && $statusCode < 300) {
-            if ($body === null || (int)$body->getSize() === 0) {
-                return new Response($statusCode, [], $headers);
+            if ($isResponseBodyEmpty) {
+                return new Response($statusCode, $headers);
             }
 
-            $payload = Json::decode($body->__toString(), true, 512, self::JSON_OPTIONS);
+            $decodedPayload = Json::decode($responseBody, true, 512, self::JSON_OPTIONS);
 
-            if (isset($payload['data']) && count(array_keys($payload)) === 1) {
-                $payload = $payload['data'];
-            }
-
-            return new Response($statusCode, $payload, $headers);
-        }
-
-        $errorPayload = '';
-        if ($body !== null) {
-            $errorPayload = (string)$body;
+            return new Response($statusCode, $headers, $decodedPayload);
         }
 
         if ($statusCode === 400) {
-            throw new BadRequestResponseException($errorPayload);
+            throw new BadRequestResponseException($responseBody);
         }
 
         if ($statusCode === 401) {
-            throw new UnauthorizedResponseException($errorPayload);
+            throw new UnauthorizedResponseException($responseBody);
         }
 
         if ($statusCode === 403) {
-            throw new ForbiddenResponseException($errorPayload);
+            throw new ForbiddenResponseException($responseBody);
         }
 
         if ($statusCode === 404) {
-            throw new NotFoundResponseException($errorPayload);
+            throw new NotFoundResponseException($responseBody);
         }
 
-        throw new UnexpectedResponseException($statusCode, $errorPayload);
+        throw new UnexpectedResponseException($statusCode, $responseBody);
+    }
+
+    private function isResponseBodyEmpty(StreamInterface $responseBody = null): bool
+    {
+        return $responseBody === null || (int)$responseBody->getSize() === 0;
     }
 }

src/Response/Response.php

@@ -8,30 +8,30 @@ class Response
     private $statusCode;
 
     /** @var array */
-    private $payload;
+    private $headers;
 
     /** @var array */
-    private $headers;
+    private $payload;
 
-    public function __construct(int $statusCode, array $payload = [], array $headers = [])
+    public function __construct(int $statusCode, array $headers = [], $payload = null)
     {
         $this->statusCode = $statusCode;
-        $this->payload    = $payload;
         $this->headers    = $headers;
+        $this->payload    = $payload;
     }
 
     public function getStatusCode(): int
     {
         return $this->statusCode;
     }
 
-    public function getPayload(): array
+    public function getHeaders(): array
     {
-        return $this->payload;
+        return $this->headers;
     }
 
-    public function getHeaders(): array
+    public function getPayload()
     {
-        return $this->headers;
+        return $this->payload;
     }
-}
+}

test/suite/unit/Response/Handler/ResponseHandlerTest.php

@@ -20,6 +20,7 @@ class ResponseHandlerTest extends TestCase
 {
     /**
      * @covers ::handle
+     * @covers ::isResponseBodyEmpty
      */
     public function testResponse()
     {
@@ -59,6 +60,7 @@ public function testResponse()
 
     /**
      * @covers ::handle
+     * @covers ::isResponseBodyEmpty
      */
     public function testResponseWithDataAndExtraFields()
     {
@@ -98,6 +100,7 @@ public function testResponseWithDataAndExtraFields()
 
     /**
      * @covers ::handle
+     * @covers ::isResponseBodyEmpty
      */
     public function testResponseWithData()
     {
@@ -107,7 +110,7 @@ public function testResponseWithData()
         $testRawBody     = '{"data":{"test-key":"test-value"}}';
         $testHeaders     = ['X-Foo' => 'bar'];
         $testBodySize    = 10;
-        $expectedBody    = ['test-key' => 'test-value'];
+        $expectedBody    = ['data' => ['test-key' => 'test-value']];
         $expectedHeaders = $testHeaders;
 
         $stream = $this->createMock(StreamInterface::class);
@@ -131,12 +134,13 @@ public function testResponseWithData()
 
         $result = $handler->handle($response);
 
-        self::assertEquals($expectedBody, $result->getPayload());
         self::assertEquals($expectedHeaders, $result->getHeaders());
+        self::assertEquals($expectedBody, $result->getPayload());
     }
 
     /**
      * @covers ::handle
+     * @covers ::isResponseBodyEmpty
      */
     public function testResponseEmpty()
     {
@@ -157,12 +161,13 @@ public function testResponseEmpty()
 
         $result = $handler->handle($response);
 
-        self::assertEquals([], $result->getPayload());
         self::assertEquals([], $result->getHeaders());
+        self::assertNull($result->getPayload());
     }
 
     /**
      * @covers ::handle
+     * @covers ::isResponseBodyEmpty
      */
     public function testResponseEmptyWhenBodySizeIsEmpty()
     {
@@ -189,13 +194,14 @@ public function testResponseEmptyWhenBodySizeIsEmpty()
 
         $result = $handler->handle($response);
 
-        self::assertEquals([], $result->getPayload());
         self::assertEquals([], $result->getHeaders());
+        self::assertNull($result->getPayload());
     }
 
     /**
      * @dataProvider exceptionsDataProvider
      * @covers ::handle
+     * @covers ::isResponseBodyEmpty
      */
     public function testHttpError(int $testStatusCode, string $exceptionClassName)
     {
@@ -207,9 +213,13 @@ public function testHttpError(int $testStatusCode, string $exceptionClassName)
             ->willReturn($testStatusCode);
 
         $body = $this->createMock(StreamInterface::class);
+        $body->expects(self::once())
+            ->method('getSize')
+            ->willReturn(20);
+
         $body->expects(self::once())
             ->method('__toString')
-            ->willReturn('');
+            ->willReturn(json_encode(['error' => 'something went wrong']));
 
         $response->expects(self::once())
             ->method('getBody')

test/suite/unit/Response/ResponseTest.php

@@ -35,10 +35,10 @@ public function testFilled()
     {
         $body         = ['foo'];
         $headers      = ['bar'];
-        $responseData = new Response(2000, $body, $headers);
+        $responseData = new Response(2000, $headers, $body);
 
         self::assertSame(2000, $responseData->getStatusCode());
-        self::assertSame($body, $responseData->getPayload());
         self::assertSame($headers, $responseData->getHeaders());
+        self::assertSame($body, $responseData->getPayload());
     }
-}
+}