Make it possible to create public httplug clients

Author: ruudk

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 1.12.0 - 2018-10-24
+
+### Added
+
+- Add configuration option to create public clients
+
 ## 1.11.0 - 2018-07-07
 
 ### Added

DependencyInjection/Configuration.php

@@ -195,6 +195,10 @@ private function configureClients(ArrayNodeDefinition $root)
                         ->defaultNull()
                         ->info('The service id of the client to use.')
                     ->end()
+                    ->booleanNode('public')
+                        ->defaultFalse()
+                        ->info('Set to true if you really cannot use dependency injection and need to make the client service public.')
+                    ->end()
                     ->booleanNode('flexible_client')
                         ->defaultFalse()
                         ->info('Set to true to get the client wrapped in a FlexibleHttpClient which emulates async or sync behavior.')

DependencyInjection/HttplugExtension.php

@@ -325,6 +325,7 @@ private function configureClient(ContainerBuilder $container, $clientName, array
 
         $container
             ->register($serviceId, PluginClient::class)
+            ->setPublic($arguments['public'])
             ->setFactory([new Reference(PluginClientFactory::class), 'createClient'])
             ->addArgument(new Reference($serviceId.'.client'))
             ->addArgument(
@@ -347,7 +348,7 @@ function ($id) {
             $container
                 ->register($serviceId.'.flexible', FlexibleHttpClient::class)
                 ->addArgument(new Reference($serviceId.'.flexible.inner'))
-                ->setPublic(false)
+                ->setPublic($arguments['public'])
                 ->setDecoratedService($serviceId)
             ;
         }
@@ -356,7 +357,7 @@ function ($id) {
             $container
                 ->register($serviceId.'.http_methods', HttpMethodsClient::class)
                 ->setArguments([new Reference($serviceId.'.http_methods.inner'), new Reference('httplug.message_factory')])
-                ->setPublic(false)
+                ->setPublic($arguments['public'])
                 ->setDecoratedService($serviceId)
             ;
         }
@@ -365,7 +366,7 @@ function ($id) {
             $container
                 ->register($serviceId.'.batch_client', BatchClient::class)
                 ->setArguments([new Reference($serviceId.'.batch_client.inner')])
-                ->setPublic(false)
+                ->setPublic($arguments['public'])
                 ->setDecoratedService($serviceId)
             ;
         }

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -119,6 +119,7 @@ public function testSupportsAllConfigFormats()
                     'factory' => 'httplug.factory.guzzle6',
                     'http_methods_client' => true,
                     'service' => null,
+                    'public' => false,
                     'flexible_client' => false,
                     'batch_client' => false,
                     'plugins' => [

Tests/Unit/DependencyInjection/HttplugExtensionTest.php

@@ -267,4 +267,117 @@ private function verifyProfilingDisabled()
             );
         }
     }
+
+    public function testClientShouldBePrivateByDefault()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertFalse($this->container->getDefinition('httplug.client.acme')->isPublic());
+    }
+
+    public function testFlexibleClientShouldBePrivateByDefault()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [
+                    'flexible_client' => true,
+                ],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertFalse($this->container->getDefinition('httplug.client.acme.flexible')->isPublic());
+    }
+
+    public function testHttpMethodsClientShouldBePrivateByDefault()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [
+                    'http_methods_client' => true,
+                ],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertFalse($this->container->getDefinition('httplug.client.acme.http_methods')->isPublic());
+    }
+
+    public function testBatchClientShouldBePrivateByDefault()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [
+                    'batch_client' => true,
+                ],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertFalse($this->container->getDefinition('httplug.client.acme.batch_client')->isPublic());
+    }
+
+    public function testClientCanBePublic()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [
+                    'public' => true,
+                ],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertTrue($this->container->getDefinition('httplug.client.acme')->isPublic());
+    }
+
+    public function testFlexibleClientCanBePublic()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [
+                    'public' => true,
+                    'flexible_client' => true,
+                ],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertTrue($this->container->getDefinition('httplug.client.acme.flexible')->isPublic());
+    }
+
+    public function testHttpMethodsClientCanBePublic()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [
+                    'public' => true,
+                    'http_methods_client' => true,
+                ],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertTrue($this->container->getDefinition('httplug.client.acme.http_methods')->isPublic());
+    }
+
+    public function testBatchClientCanBePublic()
+    {
+        $this->load([
+            'clients' => [
+                'acme' => [
+                    'public' => true,
+                    'batch_client' => true,
+                ],
+            ],
+        ]);
+
+        $this->assertContainerBuilderHasService('httplug.client.acme');
+        $this->assertTrue($this->container->getDefinition('httplug.client.acme.batch_client')->isPublic());
+    }
 }