Merge pull request #44 from chadicus/master

Add and use custom API exception

Author: chadicus

.scrutinizer.yml

@@ -9,7 +9,7 @@ tools:
     php_mess_detector: true
     php_code_sniffer:
         config:
-            standard: PSR1
+            standard: PSR2
     sensiolabs_security_checker: true
     php_loc:
         excluded_dirs:

src/Collection.php

@@ -156,7 +156,12 @@ public function next()
         $indexResponse = $this->client->index($this->resource, $this->filters);
 
         $httpCode = $indexResponse->getHttpCode();
-        Util::ensure(200, $httpCode, "Did not receive 200 from API. Instead received {$httpCode}");
+        Util::ensure(
+            200,
+            $httpCode,
+            Exception::class,
+            ["Did not receive 200 from API. Instead received {$httpCode}", $indexResponse]
+        );
 
         $response = $indexResponse->getResponse();
         $this->limit = $response['pagination']['limit'];

src/Exception.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace TraderInteractive\Api;
+
+class Exception extends \Exception
+{
+    /**
+     * @var Response
+     */
+    private $response;
+
+    public function __construct(string $message, Response $response)
+    {
+        parent::__construct($message);
+        $this->response = $response;
+    }
+
+    public function getResponse() : Response
+    {
+        return $this->response;
+    }
+}

tests/CacheHelperTest.php

@@ -20,8 +20,8 @@ public function getCacheKey()
     {
         $request = new Psr7\Request('GET', 'http://localhost:8080/id', []);
         $this->assertSame(
-           'GET|http_COLON__FSLASH__FSLASH_localhost_COLON_8080_FSLASH_id|',
-           CacheHelper::getCacheKey($request)
+            'GET|http_COLON__FSLASH__FSLASH_localhost_COLON_8080_FSLASH_id|',
+            CacheHelper::getCacheKey($request)
         );
     }
 }

tests/CollectionTest.php

@@ -300,6 +300,44 @@ public function selectMissingKeys()
         );
     }
 
+    /**
+     * @test
+     * @covers ::next
+     */
+    public function collectionThrowsApiExceptionWith400Response()
+    {
+        $response = new Response(400, ['Content-Type' => ['application/json']], []);
+        $mockClient = $this->getMockBuilder(ClientInterface::class)->getMock();
+        $mockClient->method('index')->willReturn($response);
+        $collection = new Collection($mockClient, 'basic', []);
+        try {
+            $collection->next();
+            $this->fail('No Exception throw');
+        } catch (Exception $e) {
+            $this->assertSame('Did not receive 200 from API. Instead received 400', $e->getMessage());
+            $this->assertSame($response, $e->getResponse());
+        }
+    }
+
+    /**
+     * @test
+     * @covers ::next
+     */
+    public function collectionThrowsApiExceptionWith500Response()
+    {
+        $response = new Response(500, ['Content-Type' => ['application/json']], []);
+        $mockClient = $this->getMockBuilder(ClientInterface::class)->getMock();
+        $mockClient->method('index')->willReturn($response);
+        $collection = new Collection($mockClient, 'basic', []);
+        try {
+            $collection->next();
+            $this->fail('No Exception throw');
+        } catch (Exception $e) {
+            $this->assertSame('Did not receive 200 from API. Instead received 500', $e->getMessage());
+            $this->assertSame($response, $e->getResponse());
+        }
+    }
+
     private function getClient(array $items = self::DEFAULT_RESULT_SET) : ClientInterface
     {
         $callback = function (string $resource, array $filters) use ($items) {

tests/ExceptionTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace TraderInteractive\Api;
+
+use GuzzleHttp\Psr7;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Defines unit tests for the Exception class
+ *
+ * @coversDefaultClass \TraderInteractive\Api\Exception
+ * @covers ::__construct
+ */
+final class ExceptionTest extends TestCase
+{
+    /**
+     * @test
+     * @covers ::getResponse
+     */
+    public function getResponseReturnsResponse()
+    {
+        $httpCode = 200;
+        $body = ['doesnt' => 'matter'];
+        $headers = ['Content-Type' => ['text/json']];
+        $response = new Response($httpCode, $headers, $body);
+        $exception = new Exception('the error message', $response);
+        $this->assertSame($response, $exception->getResponse());
+    }
+}