Merge pull request #155 from Sammyjo20/fix/v1-encoded-files-in-fixtures

Fix | V1 Encoded Files In Fixtures

Author: Sammyjo20

src/Data/FixtureData.php

@@ -16,7 +16,7 @@ class FixtureData implements JsonSerializable
      * @param mixed $data
      */
     public function __construct(
-        public int $statusCode,
+        public int   $statusCode,
         public array $headers = [],
         public mixed $data = null,
     ) {
@@ -34,10 +34,16 @@ public static function fromFile(string $contents): static
     {
         $fileData = json_decode($contents, true, 512, JSON_THROW_ON_ERROR);
 
+        $data = $fileData['data'];
+
+        if (isset($fileData['encoding']) && $fileData['encoding'] === 'base64') {
+            $data = base64_decode($data);
+        }
+
         return new static(
             statusCode: $fileData['statusCode'],
             headers: $fileData['headers'],
-            data: $fileData['data']
+            data: $data
         );
     }
 
@@ -84,10 +90,17 @@ public function toMockResponse(): MockResponse
      */
     public function jsonSerialize(): array
     {
-        return [
+        $response = [
             'statusCode' => $this->statusCode,
             'headers' => $this->headers,
             'data' => $this->data,
         ];
+
+        if (mb_check_encoding($response['data'], 'UTF-8') === false) {
+            $response['data'] = base64_encode($response['data']);
+            $response['encoding'] = 'base64';
+        }
+
+        return $response;
     }
 }

tests/Feature/ConnectorRequestTest.php

@@ -125,7 +125,7 @@
     $connector = new InvalidServiceRequestConnector();
 
     $this->expectException(InvalidRequestKeyException::class);
-    $this->expectDeprecationMessage('Request groups must be keyed.');
+    $this->expectExceptionMessage('Request groups must be keyed.');
 
     $connector->custom();
 });

tests/Feature/MockRequestTest.php

@@ -10,6 +10,7 @@
 use Sammyjo20\Saloon\Tests\Fixtures\Requests\ErrorRequest;
 use Sammyjo20\Saloon\Tests\Fixtures\Connectors\TestConnector;
 use Sammyjo20\Saloon\Tests\Fixtures\Mocking\CallableMockResponse;
+use Sammyjo20\Saloon\Tests\Fixtures\Requests\FileDownloadRequest;
 use Sammyjo20\Saloon\Exceptions\SaloonNoMockResponsesProvidedException;
 use Sammyjo20\Saloon\Tests\Fixtures\Connectors\QueryParameterConnector;
 use Sammyjo20\Saloon\Tests\Fixtures\Requests\DifferentServiceUserRequest;
@@ -464,3 +465,19 @@ function (SaloonRequest $request): MockResponse {
         'message' => 'Fake Error',
     ]);
 });
+
+test('a fixture can record the file data from a request that returns a file download', function () {
+    $mockClient = new MockClient([
+        FileDownloadRequest::class => MockResponse::fixture('file'),
+    ]);
+
+    $requestA = new FileDownloadRequest;
+    $responseA = $requestA->send($mockClient);
+
+    expect($responseA->body())->toEqual(file_get_contents('tests/Fixtures/Files/test.pdf'));
+
+    $requestB = new FileDownloadRequest;
+    $responseB = $requestB->send($mockClient);
+
+    expect($responseB->body())->toEqual(file_get_contents('tests/Fixtures/Files/test.pdf'));
+});

tests/Fixtures/Files/test.pdf

@@ -0,0 +1,34 @@
+<?php
+
+namespace Sammyjo20\Saloon\Tests\Fixtures\Requests;
+
+use Sammyjo20\Saloon\Constants\Saloon;
+use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Tests\Fixtures\Connectors\TestConnector;
+
+class FileDownloadRequest extends SaloonRequest
+{
+    /**
+     * Define the method that the request will use.
+     *
+     * @var string|null
+     */
+    protected ?string $method = Saloon::GET;
+
+    /**
+     * The connector.
+     *
+     * @var string|null
+     */
+    protected ?string $connector = TestConnector::class;
+
+    /**
+     * Define the endpoint for the request.
+     *
+     * @return string
+     */
+    public function defineEndpoint(): string
+    {
+        return '/download-test-pdf';
+    }
+}