feat(v3): add SDK config bag

Author: andrepimpao

src/Api.php

@@ -32,6 +32,8 @@ class Api
 
     private array $headerDefaults = [];
 
+    private Config $config;
+
     private ClientBuilder $clientBuilder;
 
     private ?CacheBuilder $cacheBuilder = null;
@@ -46,6 +48,7 @@ class Api
 
     public function __construct()
     {
+        $this->config = new Config();
         $this->clientBuilder ??= new ClientBuilder();
         $this->responseBuilder = new ResponseBuilder();
         $this->eventDispatcher = new EventDispatcher();
@@ -141,6 +144,15 @@ protected function responses(): ResponseBuilder
         return $this->responseBuilder;
     }
 
+    protected function config(?array $values = null): Config
+    {
+        if ($values !== null) {
+            $this->config->merge($values);
+        }
+
+        return $this->config;
+    }
+
     private function configurePlugins(): void
     {
         // https://docs.php-http.org/en/latest/plugins/content-type.html

src/Config.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace ProgrammatorDev\Api;
+
+class Config
+{
+    public function __construct(
+        private array $values = []
+    ) {}
+
+    public function all(): array
+    {
+        return $this->values;
+    }
+
+    public function has(string $key): bool
+    {
+        return array_key_exists($key, $this->values);
+    }
+
+    public function get(string $key, mixed $default = null): mixed
+    {
+        if (!$this->has($key)) {
+            return $default;
+        }
+
+        return $this->values[$key];
+    }
+
+    public function set(string $key, mixed $value): self
+    {
+        $this->values[$key] = $value;
+
+        return $this;
+    }
+
+    public function merge(array $values): self
+    {
+        foreach ($values as $key => $value) {
+            $this->set($key, $value);
+        }
+
+        return $this;
+    }
+}

tests/Integration/ApiTest.php

@@ -88,6 +88,40 @@ public function testHeaderDefaults()
         $this->assertNull($this->api->getHeaderDefault('X-Test'));
     }
 
+    public function testConfigCanBeSetAndReadBySdkApi(): void
+    {
+        $api = new class extends Api {
+            public function setOptions(array $options): self
+            {
+                $this->config($options);
+
+                return $this;
+            }
+
+            public function option(string $key, mixed $default = null): mixed
+            {
+                return $this->config()->get($key, $default);
+            }
+
+            public function options(): array
+            {
+                return $this->config()->all();
+            }
+        };
+
+        $api
+            ->setOptions(['timezone' => 'UTC'])
+            ->setOptions(['units' => 'metric']);
+
+        $this->assertSame('UTC', $api->option('timezone'));
+        $this->assertSame('metric', $api->option('units'));
+        $this->assertSame('en', $api->option('locale', 'en'));
+        $this->assertSame([
+            'timezone' => 'UTC',
+            'units' => 'metric',
+        ], $api->options());
+    }
+
     public function testCache()
     {
         $this->assertNull($this->api->getCacheBuilder());
@@ -238,4 +272,4 @@ public function testBuildPath()
 
         $this->assertSame('/path/with/multiple/parameters', $path);
     }
-}
+}

tests/Unit/ConfigTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace ProgrammatorDev\Api\Test\Unit;
+
+use ProgrammatorDev\Api\Config;
+use ProgrammatorDev\Api\Test\AbstractTestCase;
+
+class ConfigTest extends AbstractTestCase
+{
+    public function testConfigReturnsValues(): void
+    {
+        $config = new Config(['timezone' => 'UTC']);
+
+        $this->assertTrue($config->has('timezone'));
+        $this->assertSame('UTC', $config->get('timezone'));
+        $this->assertSame(['timezone' => 'UTC'], $config->all());
+    }
+
+    public function testConfigReturnsDefaultForMissingValue(): void
+    {
+        $config = new Config();
+
+        $this->assertFalse($config->has('timezone'));
+        $this->assertSame('Europe/Lisbon', $config->get('timezone', 'Europe/Lisbon'));
+    }
+
+    public function testConfigCanStoreNullValues(): void
+    {
+        $config = new Config(['timezone' => null]);
+
+        $this->assertTrue($config->has('timezone'));
+        $this->assertNull($config->get('timezone', 'Europe/Lisbon'));
+    }
+
+    public function testConfigCanBeUpdated(): void
+    {
+        $config = new Config(['timezone' => 'UTC']);
+
+        $config
+            ->set('timezone', 'Europe/Lisbon')
+            ->merge(['units' => 'metric']);
+
+        $this->assertSame([
+            'timezone' => 'Europe/Lisbon',
+            'units' => 'metric',
+        ], $config->all());
+    }
+}