Add default headers

Author: guywithnose

src/Client.php

@@ -94,6 +94,13 @@ final class Client
      */
     private $_handles = [];
 
+    /**
+     * Array of headers that are passed on every request unless they are overridden
+     *
+     * @var array
+     */
+    private $_defaultHeaders = [];
+
     /**
      * Create a new instance of Client
      *
@@ -304,6 +311,18 @@ public function end($handle)
         return $response;
     }
 
+    /**
+     * Set the default headers
+     *
+     * @param array The default headers
+     *
+     * @return void
+     */
+    public function setDefaultHeaders($defaultHeaders)
+    {
+        $this->_defaultHeaders = $defaultHeaders;
+    }
+
     private static function _isExpiredToken(Response $response)
     {
         if ($response->getHttpCode() !== 401) {
@@ -382,6 +401,7 @@ private function _setTokenFromCache()
      */
     private function _start($url, $method, $body = null, array $headers = [])
     {
+        $headers += $this->_defaultHeaders;
         $headers['Accept-Encoding'] = 'gzip';
         if ($this->_accessToken === null) {
             $this->_setTokenFromCache();

tests/ClientTest.php

@@ -77,6 +77,34 @@ public function invalidTokenIsRefreshed()
         $this->assertSame(200, $client->end($client->startIndex('a resource', []))->getHttpCode());
     }
 
+    /**
+     * @test
+     * @group unit
+     * @covers ::setDefaultHeaders
+     * @uses \DominionEnterprises\Api\Client::setDefaultHeaders
+     * @uses \DominionEnterprises\Api\Client::startIndex
+     * @uses \DominionEnterprises\Api\Client::end
+     */
+    public function defaultHeadersArePassed()
+    {
+        $adapter = $this->getMockBuilder('\DominionEnterprises\Api\Adapter')->setMethods(['start', 'end'])->getMock();
+        $adapter->expects($this->once())->method('start')->with(
+            $this->callback(
+                function($request) {
+                    $this->assertEquals('foo', $request->getHeaders()['testHeader']);
+                    return true;
+                }
+            )
+        );
+        $adapter->expects($this->once())->method('end')->will(
+            $this->returnValue(new Response(200, ['Content-Type' => ['application/json']], []))
+        );
+        $authentication = Authentication::createClientCredentials('not under test', 'not under test');
+        $client = new Client($adapter, $authentication, 'a url', Client::CACHE_MODE_NONE, null, 'foo');
+        $client->setDefaultHeaders(['testHeader' => 'foo']);
+        $this->assertSame(200, $client->end($client->startIndex('a resource', []))->getHttpCode());
+    }
+
     /**
      * @test
      * @group unit