feat: added cache trait

Author: andrepimpao

composer.json

@@ -13,6 +13,7 @@
     ],
     "require": {
         "php": ">=8.1",
+        "myclabs/deep-copy": "^1.11",
         "programmatordev/php-api-sdk": "^0.2.0",
         "programmatordev/yet-another-php-validator": "^1.1"
     },

docs/04-error-handling.md

@@ -23,7 +23,7 @@ try {
         $coordinate->getLongitude()
     );
 }
-// bad request to the api
+// bad request to the API
 catch (BadRequestException $exception) {
     echo $exception->getCode(); // 400
     echo $exception->getMessage();
@@ -39,7 +39,7 @@ catch (NotFoundException $exception) {
     echo $exception->getCode(); // 404
     echo $exception->getMessage();
 }
-// api key requests quota exceeded
+// API key requests quota exceeded
 catch (TooManyRequestsException $exception) {
     echo $exception->getCode(); // 429
     echo $exception->getMessage();
@@ -65,7 +65,7 @@ try {
         $coordinate->getLongitude()
     );
 }
-// catches all api response errors
+// catches all API response errors
 catch (ApiErrorException $exception) {
     echo $exception->getCode();
     echo $exception->getMessage();

src/Endpoint/Util/CacheTtlTrait.php

@@ -20,7 +20,7 @@ class OpenWeatherMap extends Api
     private array $options;
 
     public function __construct(
-        #[\SensitiveParameter] private readonly string $apiKey,
+        #[\SensitiveParameter] private string $apiKey,
         array $options = []
     )
     {

src/OpenWeatherMap.php

@@ -5,19 +5,21 @@
 use ProgrammatorDev\Api\Method;
 use ProgrammatorDev\OpenWeatherMap\Entity\Location;
 use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
+use ProgrammatorDev\OpenWeatherMap\Resource\Util\CacheTrait;
 use ProgrammatorDev\OpenWeatherMap\Resource\Util\ValidationTrait;
 use ProgrammatorDev\OpenWeatherMap\Util\EntityTrait;
 use ProgrammatorDev\Validator\Exception\ValidationException;
 use Psr\Http\Client\ClientExceptionInterface;
 
 class GeocodingResource
 {
+    use CacheTrait;
     use EntityTrait;
     use ValidationTrait;
 
     private const NUM_RESULTS = 5;
 
-    public function __construct(private readonly OpenWeatherMap $api) {}
+    public function __construct(private OpenWeatherMap $api) {}
 
     /**
      * @return Location[]

src/Resource/GeocodingResource.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace ProgrammatorDev\OpenWeatherMap\Resource\Util;
+
+use function DeepCopy\deep_copy;
+
+trait CacheTrait
+{
+    public function withCacheTtl(?int $ttl): static
+    {
+        $clone = deep_copy($this);
+        $clone->api->getCacheBuilder()?->setTtl($ttl);
+
+        return $clone;
+    }
+}