feat(Client): add possibility for additional headers when executing request

Author: Jens Schulze

src/Client.php

@@ -224,17 +224,17 @@ protected function getBaseUrl()
      * Executes an API request synchronously
      *
      * @param ClientRequestInterface $request
+     * @param array $headers
      * @return ApiResponseInterface
-     * @throws InvalidTokenException
      * @throws ApiException
-     * @throws \Exception
+     * @throws InvalidTokenException
      */
-    public function execute(ClientRequestInterface $request)
+    public function execute(ClientRequestInterface $request, array $headers = null)
     {
         if ($request instanceof ContextAwareInterface) {
             $request->setContextIfNull($this->getConfig()->getContext());
         }
-        $httpRequest = $this->createHttpRequest($request);
+        $httpRequest = $this->createHttpRequest($request, $headers);
 
         try {
             $httpResponse = $this->getHttpClient()->execute($httpRequest);
@@ -263,12 +263,12 @@ public function execute(ClientRequestInterface $request)
      * @param ClientRequestInterface $request
      * @return ApiResponseInterface
      */
-    public function executeAsync(ClientRequestInterface $request)
+    public function executeAsync(ClientRequestInterface $request, array $headers = null)
     {
         if ($request instanceof ContextAwareInterface) {
             $request->setContextIfNull($this->getConfig()->getContext());
         }
-        $httpRequest = $this->createHttpRequest($request);
+        $httpRequest = $this->createHttpRequest($request, $headers);
         $response = $request->buildResponse($this->getHttpClient()->executeAsync($httpRequest));
 
         $response = $response->then(
@@ -283,27 +283,36 @@ function ($httpResponse) use ($httpRequest) {
 
     /**
      * @param ClientRequestInterface $request
+     * @param array $headers
      * @return RequestInterface
      */
-    protected function createHttpRequest(ClientRequestInterface $request)
+    protected function createHttpRequest(ClientRequestInterface $request, array $headers = null)
     {
         $token = $this->getOauthManager()->getToken();
-
         $httpRequest = $request->httpRequest();
         $httpRequest = $httpRequest
             ->withHeader('Authorization', 'Bearer ' . $token->getToken())
         ;
+        if (is_array($headers)) {
+            foreach ($headers as $headerName => $headerValues) {
+                $httpRequest = $httpRequest
+                    ->withAddedHeader($headerName, $headerValues)
+                ;
+            }
+        }
+
         return $httpRequest;
     }
 
     /**
      * Executes API requests in batch
-     * @return Response\ApiResponseInterface[]
+     * @param array $headers
+     * @return ApiResponseInterface[]
      * @throws ApiException
      */
-    public function executeBatch()
+    public function executeBatch(array $headers = null)
     {
-        $requests = $this->getBatchHttpRequests();
+        $requests = $this->getBatchHttpRequests($headers);
         $httpResponses = $this->getHttpClient()->executeBatch($requests);
 
         $responses = [];
@@ -398,13 +407,14 @@ protected function format(RequestInterface $request, ResponseInterface $response
     }
 
     /**
+     * @param array $headers
      * @return array
      */
-    protected function getBatchHttpRequests()
+    protected function getBatchHttpRequests(array $headers = null)
     {
         $requests = array_map(
-            function ($request) {
-                return $this->createHttpRequest($request);
+            function ($request) use ($headers) {
+                return $this->createHttpRequest($request, $headers);
             },
             $this->batchRequests
         );

src/Request/AbstractApiRequest.php

@@ -228,10 +228,11 @@ public function map(array $data, Context $context = null, MapperInterface $mappe
 
     /**
      * @param Client $client
+     * @param array $headers
      * @return ApiResponseInterface
      */
-    public function executeWithClient(Client $client)
+    public function executeWithClient(Client $client, array $headers = null)
     {
-        return $client->execute($this);
+        return $client->execute($this, $headers);
     }
 }

tests/integration/Cart/CartQueryRequestTest.php

@@ -96,7 +96,7 @@ public function testGetByCustomerId()
         $cart = $this->createCart($draft);
 
         $request = CartByCustomerIdGetRequest::ofCustomerId($cart->getCustomerId());
-        $response = $request->executeWithClient($this->getClient());
+        $response = $request->executeWithClient($this->getClient(), ['X-Vrap-Disable-Validation' => 'response']);
         $result = $request->mapResponse($response);
 
         $this->assertInstanceOf(Cart::class, $result);

tests/integration/ShippingMethod/ShippingMethodQueryRequestTest.php

@@ -92,7 +92,7 @@ public function testByLocation()
         $shippingMethod = $this->createShippingMethod($draft);
 
         $request = ShippingMethodByLocationGetRequest::ofCountry('DE')->withState($this->getRegion());
-        $response = $request->executeWithClient($this->getClient());
+        $response = $request->executeWithClient($this->getClient(), ['X-Vrap-Disable-Validation' => 'response']);
         $result = $request->mapResponse($response);
 
         $this->assertInstanceOf(ShippingMethodCollection::class, $result);