#77 Workaround/Hotfix: Cannot set headers in config (#78)

8p · Dec 11, 2016 · 2f041eb · 2f041eb
1 parent cd72a5c
commit 2f041eb
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 280 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -81,18 +81,23 @@ private function createClientsNode()
                 ->children()
                     ->scalarNode('base_url')->defaultValue(null)->end()
 
+                    // @deprecated
                     ->arrayNode('headers')
                         ->prototype('scalar')
                         ->end()
                     ->end()
 
                     ->arrayNode('options')
                         ->children()
+                            ->arrayNode('headers')
+                                ->prototype('scalar')
+                                ->end()
+                            ->end()
                             ->arrayNode('auth')
                                 ->prototype('scalar')
                                 ->end()
                             ->end()
-                             ->arrayNode('query')
+                            ->arrayNode('query')
                                 ->prototype('scalar')
                                 ->end()
                             ->end()

diff --git a/DependencyInjection/GuzzleExtension.php b/DependencyInjection/GuzzleExtension.php
@@ -64,6 +64,12 @@ public function load(array $configs, ContainerBuilder $container)
                 }
             }
 
+            // header hotfix/workaround #77
+            // @deprecated
+            if (isset($options['headers'])) {
+                $argument['headers'] = $this->cleanUpHeaders($options['headers']);
+            }
+
             $client = new Definition('%guzzle.http_client.class%');
             $client->addArgument($argument);
 
@@ -90,16 +96,11 @@ protected function createHandler(ContainerBuilder $container, $name, array $conf
         $log = $this->createLogMiddleware();
         $container->setDefinition($logServiceName, $log);
 
-        $headerServiceName = sprintf('guzzle_bundle.middleware.request_header.%s', $name);
-        $requestHeader = $this->createRequestHeaderMiddleware($config['headers']);
-        $container->setDefinition($headerServiceName, $requestHeader);
-
         // Event Dispatching service
         $eventServiceName = sprintf('guzzle_bundle.middleware.event_dispatch.%s', $name);
         $eventService = $this->createEventMiddleware($name);
         $container->setDefinition($eventServiceName, $eventService);
 
-        $headerExpression = new Expression(sprintf("service('%s').attach()", $headerServiceName));
         $logExpression    = new Expression(sprintf("service('%s').log()", $logServiceName));
         // Create the event Dispatch Middleware
         $eventExpression  = new Expression(sprintf("service('%s').dispatchEvent()", $eventServiceName));
@@ -136,7 +137,6 @@ protected function createHandler(ContainerBuilder $container, $name, array $conf
             }
         }
 
-        $handler->addMethodCall('push', [$headerExpression]);
         $handler->addMethodCall('push', [$logExpression]);
         // goes on the end of the stack.
         $handler->addMethodCall('unshift', [$eventExpression]);
@@ -186,23 +186,6 @@ protected function createLogMiddleware()
         return $log;
     }
 
-    /**
-     * Create Middleware For Request Headers
-     *
-     * @since  2015-07
-     *
-     * @param  array $headers
-     *
-     * @return Definition
-     */
-    protected function createRequestHeaderMiddleware(array $headers)
-    {
-        $requestHeader = new Definition('%guzzle_bundle.middleware.request_header.class%');
-        $requestHeader->addArgument($this->cleanUpHeaders($headers));
-
-        return $requestHeader;
-    }
-
     /**
      * Create Middleware For dispatching events
      *

diff --git a/Middleware/RequestHeaderMiddleware.php b/Middleware/RequestHeaderMiddleware.php
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ guzzle:
         api_payment:
             base_url: "http://api.domain.tld"
 
-            # custom headers
+            # custom headers (@deprecated, will be removed in v5; new: set headers in options)
             headers:
                 Accept: "application/json"
 
@@ -76,6 +76,10 @@ guzzle:
                 auth:
                     - acme     # login
                     - pa55w0rd # password
+
+                headers:
+                    Accept: "application/json"
+
                 timeout: 30
 
             # plugin settings

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -11,7 +11,7 @@
         <parameter key="guzzle_bundle.data_collector.class">EightPoints\Bundle\GuzzleBundle\DataCollector\HttpDataCollector</parameter>
         <parameter key="guzzle_bundle.logger.class">EightPoints\Bundle\GuzzleBundle\Log\Logger</parameter>
 		<parameter key="guzzle_bundle.middleware.log.class">EightPoints\Bundle\GuzzleBundle\Middleware\LogMiddleware</parameter>
-		<parameter key="guzzle_bundle.middleware.request_header.class">EightPoints\Bundle\GuzzleBundle\Middleware\RequestHeaderMiddleware</parameter>
+
         <!-- Event MiddleWare Dispatcher class -->
         <parameter key="guzzle_bundle.middleware.event_dispatcher.class">EightPoints\Bundle\GuzzleBundle\Middleware\EventDispatchMiddleware</parameter>
 

diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -26,6 +26,9 @@ public function testSingleClientConfigWithOptions()
                                 'user',
                                 'pass'
                             ],
+                            'headers' => [
+                                'Accept' => 'application/json'
+                            ],
                             'query' => [
                             ],
                             'cert' => 'path/to/cert',

diff --git a/Tests/DependencyInjection/GuzzleExtensionTest.php b/Tests/DependencyInjection/GuzzleExtensionTest.php
@@ -29,7 +29,6 @@ public function testGuzzleExtension()
 
         // test Services
         $this->assertTrue($container->hasDefinition('guzzle_bundle.middleware.log.test_api'));
-        $this->assertTrue($container->hasDefinition('guzzle_bundle.middleware.request_header.test_api'));
         $this->assertTrue($container->hasDefinition('guzzle_bundle.middleware.event_dispatch.test_api'));
 
         // test WSSE Plugin

diff --git a/Tests/Middleware/RequestHeaderMiddlewareTest.php b/Tests/Middleware/RequestHeaderMiddlewareTest.php