Add AddPathPlugin support. ISSUE-255

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 1.10.0 (unreleased) - 2018-03-09
+
+### Added
+
+- Allow to configure the `AddPathPlugin` per client, under the `add_path` configuration key.
+
 ## 1.9.0 - 2018-03-06
 
 ### Added

DependencyInjection/Configuration.php

@@ -298,6 +298,18 @@ private function createClientPluginNode()
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('add_path')
+                    ->canBeEnabled()
+                    ->addDefaultsIfNotSet()
+                    ->info('Add a base path to the request.')
+                    ->children()
+                        ->scalarNode('path')
+                            ->info('Path to be added, e.g. /api/v1')
+                            ->isRequired()
+                            ->cannotBeEmpty()
+                        ->end()
+                    ->end()
+                ->end()
                 ->arrayNode('base_uri')
                     ->canBeEnabled()
                     ->addDefaultsIfNotSet()

DependencyInjection/HttplugExtension.php

@@ -207,6 +207,12 @@ private function configurePluginByName($name, Definition $definition, array $con
                     'replace' => $config['replace'],
                 ]);
 
+                break;
+            case 'add_path':
+                $pathUriService = $serviceId.'.path_uri';
+                $this->createUri($container, $pathUriService, $config['path']);
+                $definition->replaceArgument(0, new Reference($pathUriService));
+
                 break;
             case 'base_uri':
                 $baseUriService = $serviceId.'.base_uri';

Resources/config/plugins.xml

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

Tests/Resources/Fixtures/config/full.php

@@ -24,6 +24,11 @@
                         'host' => 'http://localhost',
                     ],
                 ],
+                [
+                    'add_path' => [
+                        'path' => '/api/v1',
+                    ],
+                ],
                 [
                     'base_uri' => [
                         'uri' => 'http://localhost',

Tests/Resources/Fixtures/config/full.xml

@@ -19,6 +19,9 @@
             <plugin>
                 <add-host host="http://localhost"/>
             </plugin>
+            <plugin>
+                <add-path path="/api/v1"/>
+            </plugin>
             <plugin>
                 <base-uri uri="http://localhost"/>
             </plugin>

Tests/Resources/Fixtures/config/full.yml

@@ -18,6 +18,9 @@ httplug:
                 -
                     add_host:
                         host: http://localhost
+                -
+                    add_path:
+                        path: /api/v1
                 -
                     base_uri:
                         uri: http://localhost

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -134,6 +134,12 @@ public function testSupportsAllConfigFormats()
                                 'replace' => false,
                             ],
                         ],
+                        [
+                            'add_path' => [
+                                'enabled' => true,
+                                'path' => '/api/v1',
+                            ],
+                        ],
                         [
                             'base_uri' => [
                                 'enabled' => true,

composer.json

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