Add BaseUriPlugin support. fix #235 (#240)

Author: llaakkkk

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 1.9.0 (unreleased) - 2017-01-12 
+- Allow to configure the `BaseUriPlugin` per client, under the `base_uri` configuration key.
+
 ## 1.8.1 - 2017-12-06
 
 ### Fixed

DependencyInjection/Configuration.php

@@ -298,6 +298,22 @@ private function createClientPluginNode()
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('base_uri')
+                    ->canBeEnabled()
+                    ->addDefaultsIfNotSet()
+                    ->info('Set a base URI to the request.')
+                    ->children()
+                        ->scalarNode('uri')
+                            ->info('Base Uri including protocol, optionally the port number and prepend path, e.g. https://api.local:8000/api')
+                            ->isRequired()
+                            ->cannotBeEmpty()
+                        ->end()
+                        ->scalarNode('replace')
+                            ->info('Whether to replace the host if request already specifies one')
+                            ->defaultValue(false)
+                        ->end()
+                    ->end()
+                ->end()
                 ->arrayNode('header_append')
                     ->canBeEnabled()
                     ->info('Append headers to the request. If the header already exists the value will be appended to the current value.')

DependencyInjection/HttplugExtension.php

@@ -199,9 +199,18 @@ private function configurePluginByName($name, Definition $definition, array $con
             /* client specific plugins */
 
             case 'add_host':
-                $uriService = $serviceId.'.host_uri';
-                $this->createUri($container, $uriService, $config['host']);
-                $definition->replaceArgument(0, new Reference($uriService));
+                $hostUriService = $serviceId.'.host_uri';
+                $this->createUri($container, $hostUriService, $config['host']);
+                $definition->replaceArgument(0, new Reference($hostUriService));
+                $definition->replaceArgument(1, [
+                    'replace' => $config['replace'],
+                ]);
+
+                break;
+            case 'base_uri':
+                $baseUriService = $serviceId.'.base_uri';
+                $this->createUri($container, $baseUriService, $config['uri']);
+                $definition->replaceArgument(0, new Reference($baseUriService));
                 $definition->replaceArgument(1, [
                     'replace' => $config['replace'],
                 ]);

Resources/config/plugins.xml

@@ -34,6 +34,10 @@
             <argument/>
             <argument/>
         </service>
+        <service id="httplug.plugin.base_uri" class="Http\Client\Common\Plugin\BaseUriPlugin" public="false" abstract="true">
+            <argument/>
+            <argument/>
+        </service>
         <service id="httplug.plugin.header_append" class="Http\Client\Common\Plugin\HeaderAppendPlugin" public="false" abstract="true">
             <argument/>
         </service>

Tests/Resources/Fixtures/config/full.php

@@ -24,6 +24,11 @@
                         'host' => 'http://localhost',
                     ],
                 ],
+                [
+                    'base_uri' => [
+                        'uri' => 'http://localhost',
+                    ],
+                ],
                 [
                     'header_set' => [
                         'headers' => [

Tests/Resources/Fixtures/config/full.xml

@@ -19,6 +19,9 @@
             <plugin>
                 <add-host host="http://localhost"/>
             </plugin>
+            <plugin>
+                <base-uri uri="http://localhost"/>
+            </plugin>
             <plugin>
                 <header-set>
                     <header name="X-FOO">bar</header>

Tests/Resources/Fixtures/config/full.yml

@@ -18,6 +18,9 @@ httplug:
                 -
                     add_host:
                         host: http://localhost
+                -
+                    base_uri:
+                        uri: http://localhost
                 -
                     header_set:
                         headers:

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -134,6 +134,13 @@ public function testSupportsAllConfigFormats()
                                 'replace' => false,
                             ],
                         ],
+                        [
+                            'base_uri' => [
+                                'enabled' => true,
+                                'uri' => 'http://localhost',
+                                'replace' => false,
+                            ],
+                        ],
                         [
                             'header_set' => [
                                 'enabled' => true,

composer.json

@@ -81,7 +81,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.8-dev"
+            "dev-master": "1.9-dev"
         }
     }
 }