API-1853: Add capability to change user-agent header

Author: LevFlavien

README.md

@@ -148,6 +148,18 @@ $client->getProductApi()->upsertList([
 ]);
 ```
 
+### Headers option
+
+You can make the client send requests with additional headers. Default client headers can be overriden.
+
+```php
+$clientBuilder = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder(
+    'http://localhost',
+    ['headers' => ['X-HEADER-NAME' => 'content']]
+);
+$client = $clientBuilder->buildAuthenticatedByToken('token');
+```
+
 ## Testing
 
 Do note that you have to delete the `composer.lock` because Doctrine dependencies are loaded.

spec/Client/HttpClientSpec.php

@@ -4,6 +4,7 @@
 
 use Akeneo\Pim\ApiClient\Client\HttpClient;
 use Akeneo\Pim\ApiClient\Client\HttpClientInterface;
+use Akeneo\Pim\ApiClient\Client\Options;
 use Akeneo\Pim\ApiClient\Exception\HttpException;
 use PhpSpec\ObjectBehavior;
 use Psr\Http\Client\ClientInterface;
@@ -18,9 +19,10 @@ class HttpClientSpec extends ObjectBehavior
     function let(
         ClientInterface $httpClient,
         RequestFactoryInterface $requestFactory,
-        StreamFactoryInterface $streamFactory
+        StreamFactoryInterface $streamFactory,
+        Options $options
     ) {
-        $this->beConstructedWith($httpClient, $requestFactory, $streamFactory);
+        $this->beConstructedWith($httpClient, $requestFactory, $streamFactory, $options);
     }
 
     function it_is_initializable()
@@ -35,7 +37,8 @@ function it_sends_a_successful_request(
         StreamFactoryInterface $streamFactory,
         StreamInterface $stream,
         RequestInterface $request,
-        ResponseInterface $response
+        ResponseInterface $response,
+        Options $options
     ) {
         $requestFactory->createRequest(
             'POST',
@@ -53,6 +56,7 @@ function it_sends_a_successful_request(
 
         $response->getStatusCode()->willReturn(HttpClient::HTTP_OK);
 
+        $options->hasHeaders()->willReturn(false);
         $request->withBody($stream)->willReturn($request);
         $request->withHeader('Content-Type', 'application/json')->willReturn($request);
 
@@ -73,7 +77,8 @@ function it_throws_an_exception_when_failing_request(
         StreamInterface $stream,
         RequestInterface $request,
         ResponseInterface $response,
-        StreamInterface $responseBody
+        StreamInterface $responseBody,
+        Options $options
     ) {
         $requestFactory->createRequest(
             'POST',
@@ -89,6 +94,7 @@ function it_throws_an_exception_when_failing_request(
             'http://akeneo.com/api/rest/v1/products/foo'
         )->willReturn($request);
 
+        $options->hasHeaders()->willReturn(false);
         $request->withBody($stream)->willReturn($request);
         $request->withHeader('Content-Type', 'application/json')->willReturn($request);
 

src/AkeneoPimClientBuilder.php

@@ -40,6 +40,7 @@
 use Akeneo\Pim\ApiClient\Client\AuthenticatedHttpClient;
 use Akeneo\Pim\ApiClient\Client\CachedResourceClient;
 use Akeneo\Pim\ApiClient\Client\HttpClient;
+use Akeneo\Pim\ApiClient\Client\Options;
 use Akeneo\Pim\ApiClient\Client\ResourceClient;
 use Akeneo\Pim\ApiClient\FileSystem\FileSystemInterface;
 use Akeneo\Pim\ApiClient\FileSystem\LocalFileSystem;
@@ -80,14 +81,17 @@ class AkeneoPimClientBuilder
     /** @var FileSystemInterface */
     protected $fileSystem;
 
+    protected Options $options;
+
     protected bool $cacheEnabled = false;
 
     /**
      * @param string $baseUri Base uri to request the API
      */
-    public function __construct(string $baseUri)
+    public function __construct(string $baseUri, array $options = [])
     {
         $this->baseUri = $baseUri;
+        $this->options = Options::fromArray($options);
     }
 
     /**
@@ -255,7 +259,7 @@ protected function setUp(Authentication $authentication): array
     {
         $uriGenerator = new UriGenerator($this->baseUri);
 
-        $httpClient = new HttpClient($this->getHttpClient(), $this->getRequestFactory(), $this->getStreamFactory());
+        $httpClient = new HttpClient($this->getHttpClient(), $this->getRequestFactory(), $this->getStreamFactory(), $this->options);
         $authenticationApi = new AuthenticationApi($httpClient, $uriGenerator);
         $authenticatedHttpClient = new AuthenticatedHttpClient($httpClient, $authenticationApi, $authentication);
 

src/Client/HttpClient.php

@@ -34,16 +34,19 @@ class HttpClient implements HttpClientInterface
     protected RequestFactoryInterface $requestFactory;
     protected HttpExceptionHandler $httpExceptionHandler;
     private StreamFactoryInterface $streamFactory;
+    private Options $options;
 
     public function __construct(
         ClientInterface $httpClient,
         RequestFactoryInterface $requestFactory,
-        StreamFactoryInterface $streamFactory
+        StreamFactoryInterface $streamFactory,
+        Options $options
     ) {
         $this->httpClient = $httpClient;
         $this->requestFactory = $requestFactory;
         $this->streamFactory = $streamFactory;
         $this->httpExceptionHandler = new HttpExceptionHandler();
+        $this->options = $options;
     }
 
     /**
@@ -64,6 +67,12 @@ public function sendRequest(string $httpMethod, $uri, array $headers = [], $body
             $request = $request->withHeader($header, $content);
         }
 
+        if ($this->options->hasHeaders()) {
+            foreach ($this->options->getHeaders() as $header => $content) {
+                $request = $request->withHeader($header, $content);
+            }
+        }
+
         $response = $this->httpClient->sendRequest($request);
         $response = $this->httpExceptionHandler->transformResponseToException($request, $response);
 

src/Client/Options.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Akeneo\Pim\ApiClient\Client;
+
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class Options
+{
+    private array $options;
+
+    private function __construct(array $options)
+    {
+        $this->options = $options;
+    }
+
+    public static function fromArray(array $options): self
+    {
+        $resolver = new OptionsResolver();
+
+        $resolver->setDefaults([
+            'headers' => [],
+        ]);
+        $resolver->setAllowedTypes('headers', 'string[]');
+
+        $options = $resolver->resolve($options);
+
+        return new self($options);
+    }
+
+    public function hasHeaders(): bool
+    {
+        return [] !== $this->options['headers'];
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getHeaders(): array
+    {
+        return $this->options['headers'];
+    }
+}

tests/Client/OptionsTest.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\tests\Client;
+
+use Akeneo\Pim\ApiClient\Client\Options;
+use Akeneo\Pim\ApiClient\tests\Api\ApiTestCase;
+
+class OptionsTest extends ApiTestCase
+{
+    public function testInvalidOption(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        Options::fromArray(['unknown_option' => 'unknown_value']);
+    }
+
+    /**
+     * @dataProvider validHeadersOptionProvider
+     */
+    public function testHeadersOption(array $inputOptions, array $expectedHeadersOption, bool $hasHeaders): void
+    {
+        $options = Options::fromArray($inputOptions);
+
+        $this->assertSame($hasHeaders, $options->hasHeaders());
+        $this->assertSame($expectedHeadersOption, $options->getHeaders());
+    }
+
+    public function validHeadersOptionProvider(): array
+    {
+        return [
+            'empty array' => [
+                [],
+                [],
+                false,
+            ],
+            'empty headers option' => [
+                ['headers' => []],
+                [],
+                false,
+            ],
+            'filled headers option' => [
+                ['headers' => ['X-HEADER' => 'content']],
+                ['X-HEADER' => 'content'],
+                true,
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider invalidHeadersOptionProvider
+     */
+    public function testInvalidHeadersOption($invalidValue): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        Options::fromArray(['headers' => $invalidValue]);
+    }
+
+    public function invalidHeadersOptionProvider(): array
+    {
+        return [
+            [10],
+            [10.45],
+            [true],
+            [new \StdClass()],
+            [['X-HEADER' => 10]],
+            [['X-HEADER' => 10.45]],
+            [['X-HEADER' => true]],
+            [['X-HEADER' => new \StdClass()]],
+        ];
+    }
+}