Merge pull request #7 from Sammyjo20/feature/v2-overwrite-cacheable-methods

Feature | V2 Allow users to overwrite cacheable methods

Author: Sammyjo20

composer.json

@@ -18,7 +18,7 @@
     "minimum-stability": "stable",
     "require": {
         "php": "^8.1",
-        "sammyjo20/saloon": "2.0.0-beta3"
+        "sammyjo20/saloon": "2.0.0-beta5"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.13",

src/Traits/HasCaching.php

@@ -46,7 +46,7 @@ public function bootHasCaching(PendingRequest $pendingRequest): void
             return;
         }
 
-        if (! in_array($pendingRequest->getMethod(), [Method::GET, Method::OPTIONS], true)) {
+        if (! in_array($pendingRequest->getMethod(), $this->getCacheableMethods(), true)) {
             return;
         }
 
@@ -112,4 +112,14 @@ public function invalidateCache(): static
 
         return $this;
     }
+
+    /**
+     * Define the cacheable methods that can be used
+     *
+     * @return array<\Saloon\Enums\Method>
+     */
+    protected function getCacheableMethods(): array
+    {
+        return [Method::GET, Method::OPTIONS];
+    }
 }

tests/Feature/CacheTest.php

@@ -12,6 +12,7 @@
 use Saloon\CachePlugin\Tests\Fixtures\Requests\CachedPostRequest;
 use Saloon\CachePlugin\Tests\Fixtures\Requests\CachedUserRequest;
 use Saloon\CachePlugin\Tests\Fixtures\Requests\CachedConnectorRequest;
+use Saloon\CachePlugin\Tests\Fixtures\Requests\AllowedCachedPostRequest;
 use Saloon\CachePlugin\Tests\Fixtures\Requests\CustomKeyCachedUserRequest;
 use Saloon\CachePlugin\Tests\Fixtures\Requests\ShortLivedCachedUserRequest;
 use Saloon\CachePlugin\Tests\Fixtures\Requests\CachedUserRequestWithoutCacheable;
@@ -109,6 +110,22 @@
     expect($responseB->json())->toEqual(['name' => 'Gareth']);
 });
 
+test('it will cache post requests if you customise the cacheableMethods method', function () {
+    $mockClient = new MockClient([
+        MockResponse::make(['name' => 'Sam']),
+    ]);
+
+    $responseA = TestConnector::make()->send(new AllowedCachedPostRequest, $mockClient);
+
+    expect($responseA->isCached())->toBeFalse();
+    expect($responseA->json())->toEqual(['name' => 'Sam']);
+
+    $responseB = TestConnector::make()->send(new AllowedCachedPostRequest, $mockClient);
+
+    expect($responseB->isCached())->toBeTrue();
+    expect($responseB->json())->toEqual(['name' => 'Sam']);
+});
+
 test('a response will not be cached if the response was not 2xx', function () {
     $mockClient = new MockClient([
         MockResponse::make(['name' => 'Sam'], 422),

tests/Fixtures/Requests/AllowedCachedPostRequest.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Saloon\CachePlugin\Tests\Fixtures\Requests;
+
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use League\Flysystem\Filesystem;
+use Saloon\Contracts\Body\HasBody;
+use Saloon\Traits\Body\HasJsonBody;
+use Saloon\CachePlugin\Contracts\Driver;
+use Saloon\CachePlugin\Traits\HasCaching;
+use Saloon\CachePlugin\Contracts\Cacheable;
+use Saloon\CachePlugin\Drivers\FlysystemDriver;
+use League\Flysystem\Local\LocalFilesystemAdapter;
+
+class AllowedCachedPostRequest extends Request implements Cacheable, HasBody
+{
+    use HasCaching;
+    use HasJsonBody;
+
+    protected Method $method = Method::POST;
+
+    public function resolveEndpoint(): string
+    {
+        return '/data';
+    }
+
+    public function defaultData(): array
+    {
+        return [
+            'name' => 'Sammy',
+        ];
+    }
+
+    public function resolveCacheDriver(): Driver
+    {
+        return new FlysystemDriver(new Filesystem(new LocalFilesystemAdapter(cachePath())));
+    }
+
+    public function cacheExpiryInSeconds(): int
+    {
+        return 60;
+    }
+
+    /**
+     * Define the cacheable methods that can be used
+     *
+     * @return array<\Saloon\Enums\Method>
+     */
+    protected function getCacheableMethods(): array
+    {
+        return [Method::GET, Method::OPTIONS, Method::POST];
+    }
+}