Added plugin feature

Author: Nyholm

ClientFactory/PluginClientFactory.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Http\HttplugBundle\ClientFactory;
+
+use Http\Client\Plugin\PluginClient;
+
+/**
+ * This factory creates a PluginClient.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class PluginClientFactory
+{
+    /**
+     * @param array $plugins
+     * @param ClientFactoryInterface $factory
+     * @param array $config
+     *
+     * @return PluginClient
+     */
+    static public function createPluginClient(array $plugins, ClientFactoryInterface $factory, array $config)
+    {
+        return new PluginClient($factory->createClient($config), $plugins);
+    }
+}

DependencyInjection/Configuration.php

@@ -90,6 +90,10 @@ protected function configureClients(ArrayNodeDefinition $root)
                         ->cannotBeEmpty()
                         ->info('The service id of a factory to use when creating the adapter.')
                     ->end()
+                    ->arrayNode('plugins')
+                        ->info('A list of service ids of plugins. The order is imortant.')
+                        ->prototype('scalar')->end()
+                    ->end()
                     ->variableNode('config')->end()
                 ->end()
             ->end();

DependencyInjection/HttplugExtension.php

@@ -25,6 +25,7 @@ public function load(array $configs, ContainerBuilder $container)
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
 
         $loader->load('services.xml');
+        $loader->load('plugins.xml');
         $loader->load('discovery.xml');
         foreach ($config['classes'] as $service => $class) {
             if (!empty($class)) {
@@ -36,19 +37,42 @@ public function load(array $configs, ContainerBuilder $container)
         foreach ($config['main_alias'] as $type => $id) {
             $container->setAlias(sprintf('httplug.%s', $type), $id);
         }
+        $this->configureClients($container, $config);
 
-        // Configure client services
+
+    }
+
+    /**
+     * Configure client services
+     *
+     * @param ContainerBuilder $container
+     * @param array $config
+     */
+    protected function configureClients(ContainerBuilder $container, array $config)
+    {
         $first = isset($config['clients']['default']) ? 'default' : null;
         foreach ($config['clients'] as $name => $arguments) {
             if ($first === null) {
                 $first = $name;
             }
 
             $def = $container->register('httplug.client.'.$name, DummyClient::class);
-            $def->setFactory([new Reference($arguments['factory']), 'createClient'])
-                ->addArgument($arguments['config']);
+
+            if (empty($arguments['plugins'])) {
+                $def->setFactory([new Reference($arguments['factory']), 'createClient'])
+                    ->addArgument($arguments['config']);
+            } else {
+                $def->setFactory('Http\HttplugBundle\ClientFactory\PluginClientFactory::createPluginClient')
+                    ->addArgument(array_map(function($id) {
+                        return new Reference($id);
+                    }, $arguments['plugins']))
+                    ->addArgument(new Reference($arguments['factory']))
+                    ->addArgument($arguments['config']);
+            }
+
         }
 
+        // Alias the first client to httplug.client.default
         if ($first !== null) {
             $container->setAlias('httplug.client.default', 'httplug.client.'.$first);
         }

README.md

@@ -99,6 +99,27 @@ $httpClient = $this->container->get('httplug.client.my_guzzle5');
 $httpClient = $this->container->get('httplug.client.acme');
 ```
 
+#### Plugins
+
+You can configure the clients with plugins. 
+
+```yaml
+// services.yml
+my_cache_plugin:
+  class: Http\Client\Plugin\CachePlugin 
+  arguments: ["@cache", "@stream_factory"]
+```
+```yaml
+// config.yml
+httpug:
+  clients: 
+    acme: 
+      factory: 'httplug.factory.guzzle6'
+      plugins: ['my_cache_plugin' , 'httplug.plugin.logger']
+      config:
+        base_uri: 'http://google.se/'
+```
+
 ### Use for Reusable Bundles
 
 Rather than code against specific HTTP clients, you want to use the Httplug `Client` interface. To avoid building your own infrastructure to define services for the client, simply `require: php-http/httplug-bundle` in your bundles `composer.json`. You SHOULD provide configuration for each of your services that needs an HTTP client to specify the service to use, defaulting to `httplug.client`. This way, the default case needs no additional configuration for your users.

Resources/config/plugins.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="httplug.plugin.cache" class="Http\Client\Plugin\CachePlugin" public="false">
+            <argument />
+            <argument type="service" id="httplug.stream_factory"/>
+            <argument />
+        </service>
+        <service id="httplug.plugin.content_length" class="Http\Client\Plugin\ContentLengthPlugin" public="false" />
+        <service id="httplug.plugin.decoder" class="Http\Client\Plugin\DecoderPlugin" public="false">
+            <argument />
+        </service>
+        <service id="httplug.plugin.error" class="Http\Client\Plugin\ErrorPlugin" public="false" />
+        <service id="httplug.plugin.logger" class="Http\Client\Plugin\LoggerPlugin" public="false">
+            <argument type="service" id="logger"/>
+            <argument />
+        </service>
+        <service id="httplug.plugin.redirect" class="Http\Client\Plugin\RedirectPlugin" public="false" />
+        <service id="httplug.plugin.retry" class="Http\Client\Plugin\RetryPlugin" public="false" />
+    </services>
+</container>