feat!: use response model

composer.json

@@ -25,7 +25,8 @@
         "php": "^8.1",
         "ext-json": "*",
         "brokeyourbike/http-client": "^1.0",
-        "brokeyourbike/resolve-uri": "^1.0"
+        "brokeyourbike/resolve-uri": "^1.0",
+        "brokeyourbike/data-transfer-object": "^0.1.1"
     },
     "require-dev": {
         "bamarni/composer-bin-plugin": "^1.4",

phpstan.neon

@@ -1,5 +1,4 @@
 parameters:
-    checkMissingIterableValueType: false
     level: max
     paths:
         - src

src/Client.php

@@ -8,8 +8,8 @@
 
 namespace BrokeYourBike\Paystack;
 
-use Psr\Http\Message\ResponseInterface;
 use BrokeYourBike\ResolveUri\ResolveUriTrait;
+use BrokeYourBike\Paystack\ResolveAccountNumberResponse;
 use BrokeYourBike\Paystack\ConfigInterface;
 use BrokeYourBike\HttpClient\HttpClientTrait;
 use BrokeYourBike\HttpClient\HttpClientInterface;
@@ -30,10 +30,14 @@ public function __construct(ConfigInterface $config, \GuzzleHttp\ClientInterface
         $this->httpClient = $httpClient;
     }
 
-    public function resolveAccountNumberRaw(string $bankCode, string $accountNumber): ResponseInterface
+    public function getConfig(): ConfigInterface
+    {
+        return $this->config;
+    }
+
+    public function resolveAccountNumberRaw(string $bankCode, string $accountNumber): ResolveAccountNumberResponse
     {
         $options = [
-            \GuzzleHttp\RequestOptions::HTTP_ERRORS => false,
             \GuzzleHttp\RequestOptions::HEADERS => [
                 'Accept' => 'application/json',
                 'Authorization' => 'Bearer ' . $this->config->getSecretKey(),
@@ -45,6 +49,8 @@ public function resolveAccountNumberRaw(string $bankCode, string $accountNumber)
         ];
 
         $uri = (string) $this->resolveUriFor($this->config->getUrl(), 'bank/resolve');
-        return $this->httpClient->request('GET', $uri, $options);
+        $response = $this->httpClient->request('GET', $uri, $options);
+
+        return new ResolveAccountNumberResponse($response);
     }
 }

src/ResolveAccountNumberResponse.php

@@ -0,0 +1,27 @@
+<?php
+
+// Copyright (C) 2021 Ivan Stasiuk <brokeyourbike@gmail.com>.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this file,
+// You can obtain one at https://mozilla.org/MPL/2.0/.
+
+namespace BrokeYourBike\Paystack;
+
+use Spatie\DataTransferObject\Attributes\MapFrom;
+use BrokeYourBike\DataTransferObject\JsonResponse;
+
+/**
+ * @author Ivan Stasiuk <brokeyourbike@gmail.com>
+ */
+class ResolveAccountNumberResponse extends JsonResponse
+{
+    public bool $status;
+    public string $message;
+
+    #[MapFrom('data.account_number')]
+    public ?string $accountNumber;
+
+    #[MapFrom('data.account_name')]
+    public ?string $accountName;
+}

tests/ClientTest.php

@@ -23,9 +23,16 @@ class ClientTest extends TestCase
     /** @test */
     public function it_implemets_http_client_interface(): void
     {
-        $api = new Client(new ConfigFixture(), new \GuzzleHttp\Client());
+        /** @var ConfigInterface */
+        $mockedConfig = $this->getMockBuilder(ConfigInterface::class)->getMock();
+
+        /** @var \GuzzleHttp\ClientInterface */
+        $mockedHttpClient = $this->getMockBuilder(\GuzzleHttp\ClientInterface::class)->getMock();
+
+        $api = new Client($mockedConfig, $mockedHttpClient);
 
         $this->assertInstanceOf(HttpClientInterface::class, $api);
+        $this->assertSame($mockedConfig, $api->getConfig());
     }
 
     /** @test */

tests/ResolveAccountNumberResponseTest.php

@@ -0,0 +1,26 @@
+<?php
+
+// Copyright (C) 2021 Ivan Stasiuk <brokeyourbike@gmail.com>.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this file,
+// You can obtain one at https://mozilla.org/MPL/2.0/.
+
+namespace BrokeYourBike\Paystack\Tests;
+
+use PHPUnit\Framework\TestCase;
+use BrokeYourBike\Paystack\ResolveAccountNumberResponse;
+
+/**
+ * @author Ivan Stasiuk <brokeyourbike@gmail.com>
+ */
+class ResolveAccountNumberResponseTest extends TestCase
+{
+    /** @test */
+    public function it_extends_json_response()
+    {
+        $parent = get_parent_class(ResolveAccountNumberResponse::class);
+
+        $this->assertSame(\BrokeYourBike\DataTransferObject\JsonResponse::class, $parent);
+    }
+}

tests/ResolveAccountNumberTest.php

@@ -8,24 +8,24 @@
 
 namespace BrokeYourBike\Paystack\Tests;
 
-use Psr\Http\Message\UriInterface;
 use Psr\Http\Message\ResponseInterface;
 use PHPUnit\Framework\TestCase;
+use BrokeYourBike\Paystack\ResolveAccountNumberResponse;
 use BrokeYourBike\Paystack\ConfigInterface;
 use BrokeYourBike\Paystack\Client;
 
 class ResolveAccountNumberTest extends TestCase
 {
+    private string $secretKey = 'super-secure-secret-key';
+
     /**
      * @test
      */
     public function it_can_prepare_request(): void
     {
-        $secretKey = 'super-secure-secret-key';
-
         $mockedConfig = $this->getMockBuilder(ConfigInterface::class)->getMock();
         $mockedConfig->method('getUrl')->willReturn('https://api.example/');
-        $mockedConfig->method('getSecretKey')->willReturn($secretKey);
+        $mockedConfig->method('getSecretKey')->willReturn($this->secretKey);
 
         $mockedResponse = $this->getMockBuilder(ResponseInterface::class)->getMock();
         $mockedResponse->method('getStatusCode')->willReturn(200);
@@ -46,10 +46,9 @@ public function it_can_prepare_request(): void
             'GET',
             'https://api.example/bank/resolve',
             [
-                \GuzzleHttp\RequestOptions::HTTP_ERRORS => false,
                 \GuzzleHttp\RequestOptions::HEADERS => [
                     'Accept' => 'application/json',
-                    'Authorization' => "Bearer {$secretKey}",
+                    'Authorization' => "Bearer {$this->secretKey}",
                 ],
                 \GuzzleHttp\RequestOptions::QUERY => [
                     'account_number' => '123456789',
@@ -65,7 +64,6 @@ public function it_can_prepare_request(): void
         $api = new Client($mockedConfig, $mockedClient);
         $requestResult = $api->resolveAccountNumberRaw('111', '123456789');
 
-        $this->assertInstanceOf(ResponseInterface::class, $requestResult);
-        $this->assertSame(200, $requestResult->getStatusCode());
+        $this->assertInstanceOf(ResolveAccountNumberResponse::class, $requestResult);
     }
 }