simplified code and removed stream factory from constructor (bc break)

Author: loevgaard

README.md

@@ -33,7 +33,7 @@ use Setono\DAO\Client\Client;
 $psr17Factory = new Psr17Factory();
 $httpClient = new Curl($psr17Factory);
 
-$client = new Client($httpClient, $psr17Factory, $psr17Factory, 'INSERT CUSTOMER ID', 'INSERT PASSWORD');
+$client = new Client($httpClient, $psr17Factory, 'INSERT CUSTOMER ID', 'INSERT PASSWORD');
 $client->get('/DAOPakkeshop/FindPakkeshop.php', [
     'postnr' => '9000', // zip code
     'adresse' => 'Hansenvej 10', // address

composer.json

@@ -14,14 +14,16 @@
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
         "psr/http-message": "^1.0",
-        "thecodingmachine/safe": "^0.1.15"
+        "thecodingmachine/safe": "^0.1.15",
+        "webmozart/assert": "^1.4"
     },
     "require-dev": {
         "kriswallsmith/buzz": "^1.0",
         "localheinz/composer-normalize": "^1.1",
         "nyholm/psr7": "^1.1",
         "phpspec/phpspec": "^5.1",
-        "phpstan/phpstan": "^0.10.3",
+        "phpstan/phpstan": "^0.11",
+        "phpstan/phpstan-strict-rules": "^0.11",
         "phpunit/phpunit": "^8.0",
         "symplify/easy-coding-standard": "^5.1",
         "thecodingmachine/phpstan-safe-rule": "^0.1.3"
@@ -31,7 +33,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0-dev"
+            "dev-master": "2.1-dev"
         }
     },
     "autoload": {

easy-coding-standard.yaml

@@ -4,3 +4,5 @@ imports:
 services:
     PhpCsFixer\Fixer\Import\OrderedImportsFixer: ~
     PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer: ~
+    PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer: ~
+    PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer: ~

spec/Client/ClientSpec.php

@@ -6,26 +6,30 @@
 
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
+use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface as HttpClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
+use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Http\Message\StreamInterface;
+use Safe\Exceptions\JsonException;
+use Safe\Exceptions\StringsException;
 use Setono\DAO\Client\Client;
 use Setono\DAO\Client\ClientInterface;
+use Setono\DAO\Exception\ApiException;
+use Setono\DAO\Exception\NotOkStatusCodeException;
 
 class ClientSpec extends ObjectBehavior
 {
     private const CUSTOMER_ID = '123456';
+
     private const PASSWORD = 'p4ssw0rd';
+
     private const BASE_URL = 'https://api.dao.as';
 
-    public function let(
-        HttpClientInterface $httpClient,
-        RequestFactoryInterface $requestFactory,
-        StreamFactoryInterface $streamFactory
-    ): void {
-        $this->beConstructedWith($httpClient, $requestFactory, $streamFactory, self::CUSTOMER_ID, self::PASSWORD);
+    public function let(HttpClientInterface $httpClient, RequestFactoryInterface $requestFactory): void
+    {
+        $this->beConstructedWith($httpClient, $requestFactory, self::CUSTOMER_ID, self::PASSWORD);
     }
 
     public function it_is_initializable(): void
@@ -38,6 +42,11 @@ public function it_implements_client_interface(): void
         $this->shouldImplement(ClientInterface::class);
     }
 
+    /**
+     * @throws ClientExceptionInterface
+     * @throws JsonException
+     * @throws StringsException
+     */
     public function it_gets(
         HttpClientInterface $httpClient,
         RequestFactoryInterface $requestFactory,
@@ -60,4 +69,48 @@ public function it_gets(
             'items' => [1, 2, 3],
         ]);
     }
+
+    /**
+     * @throws ClientExceptionInterface
+     */
+    public function it_throws_not_ok_status_code_exception(
+        HttpClientInterface $httpClient,
+        RequestFactoryInterface $requestFactory,
+        ResponseInterface $response
+    ): void {
+        $requestFactory
+            ->createRequest('GET', Argument::any())
+            ->shouldBeCalled();
+
+        $response->getStatusCode()->willReturn(500);
+        $httpClient->sendRequest(Argument::any())->willReturn($response);
+
+        $this->shouldThrow(NotOkStatusCodeException::class)->during('get', ['endpoint']);
+    }
+
+    /**
+     * @throws ClientExceptionInterface
+     * @throws StringsException
+     */
+    public function it_throws_api_exception(
+        HttpClientInterface $httpClient,
+        RequestFactoryInterface $requestFactory,
+        RequestInterface $request,
+        ResponseInterface $response,
+        StreamInterface $stream
+    ): void {
+        $requestFactory
+            ->createRequest('GET', Argument::any())
+            ->willReturn($request)
+        ;
+
+        $response->getStatusCode()->willReturn(200);
+        $response->getBody()->willReturn($stream);
+        $stream->__toString()->willReturn('{"status":"FEJL", "fejlkode": 101, "fejltekst": "Wrong login"}');
+        $httpClient->sendRequest($request)->willReturn($response);
+
+        $exception = new ApiException($request->getWrappedObject(), $response->getWrappedObject(), 200, 101, 'Wrong login');
+
+        $this->shouldThrow($exception)->during('get', ['endpoint']);
+    }
 }

src/Client/Client.php

@@ -4,14 +4,16 @@
 
 namespace Setono\DAO\Client;
 
+use InvalidArgumentException;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface as HttpClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
-use Psr\Http\Message\StreamFactoryInterface;
 use Safe\Exceptions\JsonException;
 use Safe\Exceptions\StringsException;
 use function Safe\json_decode;
-use Setono\DAO\Exception\RequestFailedException;
+use Setono\DAO\Exception\ApiException;
+use Setono\DAO\Exception\NotOkStatusCodeException;
+use Webmozart\Assert\Assert;
 
 final class Client implements ClientInterface
 {
@@ -25,11 +27,6 @@ final class Client implements ClientInterface
      */
     private $requestFactory;
 
-    /**
-     * @var StreamFactoryInterface
-     */
-    private $streamFactory;
-
     /**
      * @var string
      */
@@ -48,47 +45,29 @@ final class Client implements ClientInterface
     public function __construct(
         HttpClientInterface $httpClient,
         RequestFactoryInterface $requestFactory,
-        StreamFactoryInterface $streamFactory,
         string $customerId,
         string $password,
         string $baseUrl = 'https://api.dao.as'
     ) {
         $this->httpClient = $httpClient;
         $this->requestFactory = $requestFactory;
-        $this->streamFactory = $streamFactory;
         $this->customerId = $customerId;
         $this->password = $password;
         $this->baseUrl = $baseUrl;
     }
 
     /**
-     * @param string $endpoint
-     * @param array  $params
-     *
-     * @return array
+     * {@inheritdoc}
      *
      * @throws ClientExceptionInterface
      * @throws JsonException
      * @throws StringsException
+     * @throws InvalidArgumentException
      */
     public function get(string $endpoint, array $params = []): array
     {
-        return $this->sendRequest('GET', $endpoint, $params);
-    }
+        Assert::notContains($endpoint, '?', 'Do not add query parameters to the endpoint. Instead use the third argument, $params');
 
-    /**
-     * @param string $method
-     * @param string $endpoint
-     * @param array  $params
-     *
-     * @return array
-     *
-     * @throws ClientExceptionInterface
-     * @throws JsonException
-     * @throws StringsException
-     */
-    private function sendRequest(string $method, string $endpoint, array $params = []): array
-    {
         $params = array_merge([
             'kundeid' => $this->customerId,
             'kode' => $this->password,
@@ -99,18 +78,18 @@ private function sendRequest(string $method, string $endpoint, array $params = [
 
         $url = $this->baseUrl.'/'.$endpoint.'?'.http_build_query($params, '', '&', PHP_QUERY_RFC3986);
 
-        $request = $this->requestFactory->createRequest($method, $url);
+        $request = $this->requestFactory->createRequest('GET', $url);
 
         $response = $this->httpClient->sendRequest($request);
 
         if (200 !== $response->getStatusCode()) {
-            throw new RequestFailedException($request, $response, $response->getStatusCode());
+            throw new NotOkStatusCodeException($request, $response, $response->getStatusCode());
         }
 
         $data = (array) json_decode((string) $response->getBody(), true);
 
         if (isset($data['status']) && 'FEJL' === $data['status']) {
-            throw new RequestFailedException($request, $response, $response->getStatusCode());
+            throw new ApiException($request, $response, $response->getStatusCode(), $data['fejlkode'], $data['fejltekst']);
         }
 
         return $data;

src/Client/ClientInterface.php

@@ -4,15 +4,16 @@
 
 namespace Setono\DAO\Client;
 
+use Setono\DAO\Exception\ApiException;
+use Setono\DAO\Exception\NotOkStatusCodeException;
+
 interface ClientInterface
 {
     /**
      * Sends a GET request to the specified endpoint with the given query params.
      *
-     * @param string $endpoint
-     * @param array  $params
-     *
-     * @return array
+     * @throws NotOkStatusCodeException
+     * @throws ApiException
      */
     public function get(string $endpoint, array $params = []): array;
 }

src/Exception/ApiException.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\DAO\Exception;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+final class ApiException extends RequestException
+{
+    /**
+     * @var int|null
+     */
+    private $errorCode;
+
+    /**
+     * @var string|null
+     */
+    private $errorMessage;
+
+    public function __construct(RequestInterface $request, ResponseInterface $response, int $statusCode, int $errorCode, string $errorMessage)
+    {
+        $this->errorCode = $errorCode;
+        $this->errorMessage = $errorMessage;
+
+        parent::__construct($request, $response, $statusCode);
+    }
+
+    public function getErrorCode(): ?int
+    {
+        return $this->errorCode;
+    }
+
+    public function getErrorMessage(): ?string
+    {
+        return $this->errorMessage;
+    }
+}

src/Exception/NotOkStatusCodeException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\DAO\Exception;
+
+final class NotOkStatusCodeException extends RequestException
+{
+}

src/Exception/RequestFailedException.php renamed to src/Exception/RequestException.php

@@ -10,17 +10,24 @@
 use Safe\Exceptions\StringsException;
 use function Safe\sprintf;
 
-final class RequestFailedException extends RuntimeException
+abstract class RequestException extends RuntimeException
 {
+    /**
+     * @var RequestInterface
+     */
     private $request;
+
+    /**
+     * @var ResponseInterface
+     */
     private $response;
+
+    /**
+     * @var int
+     */
     private $statusCode;
 
     /**
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @param int               $statusCode
-     *
      * @throws StringsException
      */
     public function __construct(RequestInterface $request, ResponseInterface $response, int $statusCode)

tests/Exception/ApiExceptionTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\DAO\Exception;
+
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+final class ApiExceptionTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_returns_correct_values(): void
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $response = $this->createMock(ResponseInterface::class);
+
+        $exception = new ApiException($request, $response, 200, 101, 'error');
+
+        $this->assertSame($request, $exception->getRequest());
+        $this->assertSame($response, $exception->getResponse());
+        $this->assertSame(200, $exception->getStatusCode());
+        $this->assertSame(101, $exception->getErrorCode());
+        $this->assertSame('error', $exception->getErrorMessage());
+    }
+}