Capture the request data to the response to enable logging and troubleshooting

phpstan.neon

@@ -1,5 +1,4 @@
 parameters:
-    checkMissingIterableValueType: false
     customRulesetUsed: true
     level: 1
     reportUnmatchedIgnoredErrors: true

src/Http/Client.php

@@ -41,11 +41,9 @@ class Client
     public $oauth2;
 
     /**
-     * Client instance.
-     *
-     * @var \GuzzleHttp\Client
+     * The http request client.
      */
-    public $client;
+    public GuzzleClient $httpClient;
 
     /**
      * Guzzle allows options into its request method. Prepare for some defaults.
@@ -59,14 +57,14 @@ class Client
      *
      * @var string
      */
-    protected $user_agent = 'Chromatic_OrangeDam_PHP/1.0.0 (https://github.com/ChromaticHQ/orange-dam-php)';
+    protected $user_agent = 'Chromatic_OrangeDam_PHP (https://github.com/ChromaticHQ/orange-dam-php)';
 
     /**
      * Constructor.
      *
      * @throws \Chromatic\OrangeDam\Exceptions\OrangeDamException
      */
-    public function __construct(array $config = [], GuzzleClient $client = null, array $clientOptions = [])
+    public function __construct(array $config = [], GuzzleClient $httpClient = null, array $clientOptions = [])
     {
         // Set default property values.
         $this->token = null;
@@ -80,14 +78,14 @@ public function __construct(array $config = [], GuzzleClient $client = null, arr
         }
 
         // Creates a new instance
-        if (is_null($client)) {
-            $client = new GuzzleClient([
+        if (is_null($httpClient)) {
+            $httpClient = new GuzzleClient([
                 'cookies' => true,
                 'timeout' => self::REQUEST_TIMEOUT,
                 'base_uri' => $config['base_path'],
             ]);
         }
-        $this->client = $client;
+        $this->httpClient = $httpClient;
     }
 
     /**
@@ -128,7 +126,7 @@ public function request(
 
         try {
             // Make a request with given parameters.
-            return new Response($this->client->request($method, $url, $options));
+            return new Response($this->httpClient, $method, $url, $options);
         } catch (ServerException $e) {
             throw OrangeDamException::create($e);
         } catch (ClientException $e) {

src/Http/Response.php

@@ -15,6 +15,10 @@ class Response implements ResponseInterface
      */
     public $data;
 
+    protected string $request;
+
+    protected array $requestOptions;
+
     /**
      * Response instance.
      *
@@ -26,9 +30,11 @@ class Response implements ResponseInterface
      * Constructor.
      *
      */
-    public function __construct(ResponseInterface $response)
+    public function __construct(\GuzzleHttp\ClientInterface $client, string $method, string $url, array $options = [])
     {
-        $this->response = $response;
+        $this->response = $client->request($method, $url, $options);
+        $this->request = sprintf('%s %s', $method, $url);
+        $this->requestOptions = $options;
     }
 
     /**
@@ -99,6 +105,22 @@ public function isEmpty(): bool
         return is_null($this->response->getBody()->getSize());
     }
 
+    /**
+     * Returns the request string that created this response.
+     */
+    public function getRequest(): string
+    {
+        return $this->request;
+    }
+
+    /**
+     * Returns the request options array that created this response.
+     */
+    public function getRequestOptions(): array
+    {
+        return $this->requestOptions;
+    }
+
     /**
      * {@inheritdoc}
      */

tests/Http/ClientTest.php

@@ -17,7 +17,7 @@ public function testClientCreation(): void
         $client = new Client([
             'base_path' => 'https://test.com',
         ]);
-        $this->assertInstanceOf(GuzzleClient::class, $client->client);
+        $this->assertInstanceOf(GuzzleClient::class, $client->httpClient);
     }
 
     /**

tests/Http/ResponseTest.php

@@ -2,6 +2,8 @@
 
 namespace Chromatic\OrangeDam\Http;
 
+use Chromatic\OrangeDam\Endpoints\Search;
+use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Psr7\Response as GuzzleResponse;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\MessageInterface;
@@ -15,7 +17,11 @@ final class ResponseTest extends TestCase
      */
     public function testDefaultConstructor(): void
     {
-        $response = new Response(new GuzzleResponse());
+        $clientMock = $this->getMockBuilder(GuzzleClient::class)
+            ->onlyMethods(['request'])
+            ->getMock();
+        $clientMock->method('request')->willReturn(new GuzzleResponse());
+        $response = new Response($clientMock, 'GET', '');
         $this->assertNull($response->getData());
         $this->assertNull($response->toArray());
         $this->assertInstanceOf(StreamInterface::class, $response->getBody());
@@ -35,7 +41,11 @@ public function testDefaultConstructor(): void
      */
     public function testHeaders(): void
     {
-        $response = new Response(new GuzzleResponse(200, ['Foo' => 'Bar']));
+        $clientMock = $this->getMockBuilder(GuzzleClient::class)
+            ->onlyMethods(['request'])
+            ->getMock();
+        $clientMock->method('request')->willReturn(new GuzzleResponse(200, ['Foo' => 'Bar']));
+        $response = new Response($clientMock, 'POST', '/');
         $headers = $response->getHeaders();
         $this->assertTrue($response->hasHeader('Foo'));
         $this->assertSame('Bar', $response->getHeaderLine('Foo'));