Make sure you can configure clients and register them as services

Author: Nyholm

ClientFactory/ClientFactoryInterface.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Http\HttplugBundle\ClientFactory;
+
+use Http\Client\HttpClient;
+
+/**
+ * Interface ClientFactoryInterface.
+ */
+interface ClientFactoryInterface
+{
+    /**
+     * Configure and return a client.
+     *
+     * @param array $config
+     *
+     * @return HttpClient
+     */
+    public function configure(array $config = array());
+
+    /**
+     * Return the name of the client.
+     *
+     * @return string
+     */
+    public function getName();
+}

ClientFactory/DummyFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Http\HttplugBundle\ClientFactory;
+
+use Http\Client\HttpClient;
+
+/**
+ * This class is used with the dependency injection when we register the service. It acts like a place holder and
+ * is needed for the framework to be able to bind method class to it.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class DummyFactory implements ClientFactoryInterface
+{
+    /**
+     * Configure and return a client.
+     *
+     * @param array $config
+     *
+     * @return HttpClient
+     */
+    public function configure(array $config = array())
+    {
+        return;
+    }
+
+    /**
+     * Return the name of the client.
+     *
+     * @return string
+     */
+    public function getName()
+    {
+        return 'dummy';
+    }
+}

ClientFactory/GenericClientFactory.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Http\HttplugBundle\ClientFactory;
+
+use Http\Client\HttpClient;
+
+/**
+ * This is a client factory that will help you instantiate any client.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class GenericClientFactory
+{
+    /**
+     * @var ClientFactoryInterface[]
+     */
+    private $clientFactories;
+
+    /**
+     * @param string $adapter
+     * @param array  $config
+     *
+     * @return HttpClient
+     */
+    public function getClient($adapter, array $config = [])
+    {
+        if (!isset($this->clientFactories[$adapter])) {
+            throw new \InvalidArgumentException(sprintf('No configurator named %s was found.', $adapter));
+        }
+
+        return $this->clientFactories[$adapter]->configure($config);
+    }
+
+    /**
+     * @param ClientFactoryInterface $factory
+     *
+     * @return $this
+     */
+    public function addInstance(ClientFactoryInterface $factory)
+    {
+        $this->clientFactories[$factory->getName()] = $factory;
+
+        return $this;
+    }
+}

ClientFactory/Guzzle5Factory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Http\HttplugBundle\ClientFactory;
+
+use GuzzleHttp\Client;
+use Http\Adapter\Guzzle5HttpAdapter;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class Guzzle5Factory implements ClientFactoryInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function configure(array $config = array())
+    {
+        $client = new Client($config);
+
+        return new Guzzle5HttpAdapter($client);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'guzzle5';
+    }
+}

ClientFactory/Guzzle6Factory.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Http\HttplugBundle\ClientFactory;
+
+use GuzzleHttp\Client;
+use Http\Adapter\Guzzle6HttpAdapter;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class Guzzle6Factory implements ClientFactoryInterface
+{
+    public function configure(array $config = array())
+    {
+        $client = new Client($config);
+
+        return new Guzzle6HttpAdapter($client);
+    }
+
+    public function getName()
+    {
+        return 'guzzle6';
+    }
+}

DependencyInjection/CompilerPass/ClientFactoryPass.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Http\HttplugBundle\DependencyInjection\CompilerPass;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class ClientFactoryPass implements CompilerPassInterface
+{
+    /**
+     * Make sure all services tagged with 'httplug.configurator' gets added to the ClientFactory.
+     *
+     * @param ContainerBuilder $container
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->has('httplug.client.factory')) {
+            return;
+        }
+
+        $definition = $container->findDefinition('httplug.client.factory');
+
+        $taggedServices = $container->findTaggedServiceIds('httplug.client_factory');
+        foreach ($taggedServices as $id => $tags) {
+            $definition->addMethodCall('addInstance', [new Reference($id)]);
+        }
+    }
+}

DependencyInjection/Configuration.php

@@ -2,6 +2,9 @@
 
 namespace Http\HttplugBundle\DependencyInjection;
 
+use Symfony\Component\Config\Definition\ArrayNode;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
@@ -24,6 +27,8 @@ public function getConfigTreeBuilder()
         $treeBuilder = new TreeBuilder();
         $rootNode = $treeBuilder->root('httplug');
 
+        $this->configureClients($rootNode);
+
         $rootNode
             ->validate()
                 ->ifTrue(function ($v) {
@@ -70,4 +75,20 @@ public function getConfigTreeBuilder()
 
         return $treeBuilder;
     }
+
+    protected function configureClients(ArrayNodeDefinition $root)
+    {
+        $validAdapters = ['guzzle5', 'guzzle6'];
+
+        $root->children()
+            ->arrayNode('clients')
+                ->useAttributeAsKey('name')
+                ->prototype('array')
+                ->children()
+                    ->enumNode('adapter')->values($validAdapters)->isRequired()->cannotBeEmpty()->end()
+                    ->variableNode('config')->end()
+                ->end()
+            ->end();
+
+    }
 }

DependencyInjection/HttplugExtension.php

@@ -2,9 +2,11 @@
 
 namespace Http\HttplugBundle\DependencyInjection;
 
+use Http\HttplugBundle\ClientFactory\DummyFactory;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
@@ -22,6 +24,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
 
+        $loader->load('services.xml');
         $loader->load('discovery.xml');
         foreach ($config['classes'] as $service => $class) {
             if (!empty($class)) {
@@ -33,5 +36,31 @@ public function load(array $configs, ContainerBuilder $container)
         foreach ($config['main_alias'] as $type => $id) {
             $container->setAlias(sprintf('httplug.%s', $type), $id);
         }
+
+        // Configure services
+        foreach ($config['clients'] as $name => $arguments) {
+            $this->verifyDependencies($arguments['adapter']);
+            $def = $container->register('httplug.'.$name, DummyFactory::class);
+            $def->setFactory([new Reference('httplug.client.factory'), 'getClient'])
+                ->addArgument($arguments['adapter'])
+                ->addArgument($arguments['config']);
+        }
+    }
+
+    /**
+     * Make sure we got all the dependencies installed.
+     *
+     * @param $adapterName
+     */
+    protected function verifyDependencies($adapterName)
+    {
+        $map = [
+            'guzzle5'=>['package'=>'php-http/guzzle5-adapter', 'class'=>'Http\Adapter\Guzzle5HttpAdapter'],
+            'guzzle6'=>['package'=>'php-http/guzzle6-adapter', 'class'=>'Http\Adapter\Guzzle6HttpAdapter'],
+        ];
+
+        if (!class_exists($map[$adapterName]['class'])) {
+            throw new \LogicException(sprintf('In order to use %s adapter you need to install package %s', $adapterName, $map[$adapterName]['package']));
+        }
     }
 }

HttplugBundle.php

@@ -2,11 +2,22 @@
 
 namespace Http\HttplugBundle;
 
+use Http\HttplugBundle\DependencyInjection\CompilerPass\ClientFactoryPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 /**
  * @author David Buchmann <[email protected]>
  */
 class HttplugBundle extends Bundle
 {
+    /**
+     * {@inheritdoc}
+     */
+    public function build(ContainerBuilder $container)
+    {
+        parent::build($container);
+        $container->addCompilerPass(new ClientFactoryPass());
+
+    }
 }

README.md

@@ -61,6 +61,17 @@ httplug:
         client: ~ # uses discovery if not specified
         message_factory: ~
         uri_factory: ~
+    clients: 
+        acme: 
+            adapter: guzzle5
+            config:
+                timeout: 2
+                verify: false
+```
+
+```php
+
+$httpClient = $this->container->get('httplug.acme');
 ```
 
 ### Use for Reusable Bundles

Resources/config/services.xml

@@ -0,0 +1,16 @@
+<?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.client.factory" class="Http\HttplugBundle\ClientFactory\GenericClientFactory" />
+
+        <!-- ClientFactories -->
+        <service id="httplug.client.factory.guzzle5" class="Http\HttplugBundle\ClientFactory\Guzzle5Factory" public="false">
+            <tag name="httplug.client_factory" />
+        </service>
+        <service id="httplug.client.factory.guzzle6" class="Http\HttplugBundle\ClientFactory\Guzzle6Factory" public="false">
+            <tag name="httplug.client_factory" /></service>
+    </services>
+</container>

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -34,6 +34,7 @@ public function testEmptyConfiguration()
                 'message_factory' => null,
                 'uri_factory' => null,
             ),
+            'clients'=>array(),
         );
 
         $formats = array_map(function ($path) {
@@ -62,6 +63,7 @@ public function testSupportsAllConfigFormats()
                 'message_factory' => 'Http\Discovery\MessageFactory\GuzzleFactory',
                 'uri_factory' => 'Http\Discovery\UriFactory\GuzzleFactory',
             ),
+            'clients'=>array(),
         );
 
         $formats = array_map(function ($path) {