clients default request headers

Author: Triplkrypl

.github/README.md

@@ -33,7 +33,9 @@ Laravel config load automatically configuration from `services.php` config, with
 ```php
     'some_api_name' => [ // this key is value of first parameter ApiClient::request method
         'base_url' => 'https://some-host/some-base-url',
-        'token' => 'tokenexample', // optional default null, authentication token for https://swagger.io/docs/specification/authentication/bearer-authentication/
+        'default_headers' => [ // optional default [], http headers send in every request
+            'Authorization' => 'Bearer tokenexample', // https://swagger.io/docs/specification/authentication/bearer-authentication/
+        ],
         'verify' => true, // optional default true, turn on/off certificates verification
         'deprecated_header' => 'Deprecated', // optional default 'Deprecated', define name of deprecated response header logged into deprecation log
     ],

config/laravel/webhook.php

@@ -5,9 +5,8 @@
 return [
     /* configuration for webhook dispatcher */
     'dispatch' => [
-        // authentication token for https://swagger.io/docs/specification/authentication/bearer-authentication/
-        // if not null token is in every webhook call for authentication of application that serving event
-        'token' => null,
+        // http request headers send in every webhook call
+        'default_headers' => [],
         // connection name where are asynchronous webhook calls dispatched, if null default laravel queue connection is used
         'queue-connection' => null,
         // if connection support named queue, specific name for webhooks can be defined here, if null default queue name is used

src/Model/Client/Request.php

@@ -54,6 +54,19 @@ public function withBaseUrl(string $baseUrl): self
         return $request;
     }
 
+    /**
+     * @param string $name
+     * @param string|array<string> $value
+     */
+    public function withHeader(string $name, string|array $value): self
+    {
+        $headers = $this->headers;
+        $headers[$name] = $value;
+        $request = new self($this->method, $this->url, [], $this->body, $headers);
+        $request->baseUrl = $this->baseUrl;
+        return $request;
+    }
+
     /**
      * @template TData
      * @param TData $jsonData
@@ -79,6 +92,11 @@ public function hasBaseUrl(): bool
         return $this->baseUrl !== null;
     }
 
+    public function hasHeader(string $name): bool
+    {
+        return array_key_exists($name, $this->headers);
+    }
+
     public function createPsr(RequestFactoryInterface $factory): RequestInterface
     {
         if ($this->baseUrl === null) {

src/Service/Client/ApiClient.php

@@ -148,17 +148,19 @@ public function requestAsync(string $apiName, Request $request, array $options =
             $request = $request->withBaseUrl($this->config->getBaseUrl($apiName));
         }
 
-        $psrRequest = $request->createPsr($this->requestFactory);
-
-        $token = $this->config->getBearerToken($apiName);
-        if (! $psrRequest->hasHeader('Authorization') && $token !== null) {
-            $psrRequest = $psrRequest->withHeader('Authorization', 'Bearer '.$token);
+        $defaultHeaders = $this->config->getDefaultHeaders($apiName);
+        foreach ($defaultHeaders as $defaultHeader => $value) {
+            $defaultHeader = (string) $defaultHeader;
+            if (! $request->hasHeader($defaultHeader)) {
+                $request = $request->withHeader($defaultHeader, $value);
+            }
         }
 
+        $psrRequest = $request->createPsr($this->requestFactory);
+
         $defaultOptions = [
             RequestOptions::VERIFY => $this->config->getVerifyCerts($apiName),
         ];
-
         foreach ($defaultOptions as $key => $defaultOption) {
             if (! array_key_exists($key, $options)) {
                 $options[$key] = $defaultOption;

src/Service/Client/Config.php

@@ -13,11 +13,27 @@ abstract class Config
     abstract public function getBaseUrl(string $apiName): string;
 
     /**
+     * @deprecated in 0.6 will be removed use $this->getDefaultHeaders
      * @param non-empty-string $apiName
      * @return non-empty-string|null
      */
     abstract public function getBearerToken(string $apiName): ?string;
 
+    /**
+     * @param non-empty-string $apiName
+     * @return array<string>
+     */
+    public function getDefaultHeaders(string $apiName): array
+    {
+        /** @phpstan-ignore-next-line */
+        $token = $this->getBearerToken($apiName);
+        if ($token !== null) {
+            return ['Authorization' => 'Bearer '.$token];
+        }
+
+        return [];
+    }
+
     /**
      * @param non-empty-string $apiName
      */

src/Service/Client/LaravelConfig.php

@@ -4,14 +4,12 @@
 
 namespace SimpleAsFuck\ApiToolkit\Service\Client;
 
-use Illuminate\Contracts\Config\Repository;
-use SimpleAsFuck\Validator\Factory\Validator;
-use SimpleAsFuck\Validator\Rule\General\Rules;
+use SimpleAsFuck\ApiToolkit\Service\Config\LaravelAdapter;
 
 final class LaravelConfig extends Config
 {
     public function __construct(
-        private Repository $repository
+        private readonly LaravelAdapter $laravelAdapter
     ) {
     }
 
@@ -21,40 +19,45 @@ public function __construct(
      */
     public function getBaseUrl(string $apiName): string
     {
-        return $this->getValue('services.'.$apiName.'.base_url')->string()->notEmpty()->notNull();
+        return $this->laravelAdapter->get('services.'.$apiName.'.base_url')->string()->notEmpty()->notNull();
     }
 
     /**
+     * @deprecated in 0.6 will be removed use $this->getDefaultHeaders
      * @param non-empty-string $apiName
      * @return non-empty-string|null
      */
     public function getBearerToken(string $apiName): ?string
     {
-        return $this->getValue('services.'.$apiName.'.token')->string()->notEmpty()->nullable();
+        return $this->laravelAdapter->get('services.'.$apiName.'.token')->string()->notEmpty()->nullable();
     }
 
     /**
      * @param non-empty-string $apiName
+     * @return array<string>
      */
-    public function getVerifyCerts(string $apiName): bool
+    public function getDefaultHeaders(string $apiName): array
     {
-        return $this->getValue('services.'.$apiName.'.verify')->bool()->nullable() ?? parent::getVerifyCerts($apiName);
+        return [
+            ...parent::getDefaultHeaders($apiName),
+            ...$this->laravelAdapter->get('services.'.$apiName.'.default_headers')->array()->ofString()->nullable() ?? [],
+        ];
     }
 
     /**
      * @param non-empty-string $apiName
-     * @return non-empty-string
      */
-    public function getDeprecatedHeader(string $apiName): string
+    public function getVerifyCerts(string $apiName): bool
     {
-        return $this->getValue('services.'.$apiName.'deprecated_header')->string()->notEmpty()->nullable() ?? parent::getDeprecatedHeader($apiName);
+        return $this->laravelAdapter->get('services.'.$apiName.'.verify')->bool()->nullable() ?? parent::getVerifyCerts($apiName);
     }
 
     /**
-     * @param non-empty-string $key
+     * @param non-empty-string $apiName
+     * @return non-empty-string
      */
-    private function getValue(string $key): Rules
+    public function getDeprecatedHeader(string $apiName): string
     {
-        return Validator::make($this->repository->get($key), 'Config key '.$key);
+        return $this->laravelAdapter->get('services.'.$apiName.'deprecated_header')->string()->notEmpty()->nullable() ?? parent::getDeprecatedHeader($apiName);
     }
 }

src/Service/Webhook/Client.php

@@ -13,9 +13,9 @@
 abstract class Client
 {
     public function __construct(
-        private Config $config,
-        private \GuzzleHttp\Client $client,
-        private ?LoggerInterface $logger,
+        private readonly Config $config,
+        private readonly \GuzzleHttp\Client $client,
+        private readonly ?LoggerInterface $logger,
     ) {
     }
 
@@ -29,9 +29,12 @@ final public function callWebhooks(iterable $webhooks, int $tries, array $header
         $requestHeaders = $headers;
         $requestOptions = $options;
 
-        $token = $this->config->getBearerToken();
-        if (! array_key_exists('Authorization', $requestHeaders) && $token !== null) {
-            $requestHeaders['Authorization'] = 'Bearer '.$token;
+        $defaultHeaders = $this->config->getDefaultHeaders();
+        foreach ($defaultHeaders as $defaultHeader => $value) {
+            $defaultHeader = (string) $defaultHeader;
+            if (! array_key_exists($defaultHeader, $requestHeaders)) {
+                $requestHeaders[$defaultHeader] = $value;
+            }
         }
 
         $requestOptions[RequestOptions::HEADERS] = $requestHeaders;

src/Service/Webhook/Config.php

@@ -7,10 +7,25 @@
 abstract class Config
 {
     /**
+     * @deprecated in 0.6 will be removed use $this->getDefaultHeaders
      * @return non-empty-string|null
      */
     abstract public function getBearerToken(): ?string;
 
+    /**
+     * @return array<string>
+     */
+    public function getDefaultHeaders(): array
+    {
+        /** @phpstan-ignore-next-line */
+        $token = $this->getBearerToken();
+        if ($token !== null) {
+            return ['Authorization' => 'Bearer '.$token];
+        }
+
+        return [];
+    }
+
     /**
      * @return positive-int
      */

src/Service/Webhook/LaravelConfig.php

@@ -9,7 +9,7 @@
 final class LaravelConfig extends Config
 {
     public function __construct(
-        private LaravelAdapter $laravelAdapter,
+        private readonly LaravelAdapter $laravelAdapter,
     ) {
     }
 
@@ -21,6 +21,17 @@ public function getBearerToken(): ?string
         return $this->laravelAdapter->get('webhook.dispatch.token')->string()->notEmpty()->nullable();
     }
 
+    /**
+     * @return array<string>
+     */
+    public function getDefaultHeaders(): array
+    {
+        return [
+            ...parent::getDefaultHeaders(),
+            ...$this->laravelAdapter->get('webhook.dispatch.default_headers')->array()->ofString()->nullable() ?? [],
+        ];
+    }
+
     /**
      * @return positive-int
      */