Skip to content

Make it possible to create public httplug clients #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 25, 2018
Merged

Make it possible to create public httplug clients #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,10 @@ private function configureClients(ArrayNodeDefinition $root)
->defaultNull()
->info('The service id of the client to use.')
->end()
->booleanNode('public')
->defaultNull()
->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.')
Expand Down
12 changes: 8 additions & 4 deletions DependencyInjection/HttplugExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ private function configureClient(ContainerBuilder $container, $clientName, array
->setAlias($serviceId.'.client', new Alias($arguments['service'], false));
}

$container
$definition = $container
->register($serviceId, PluginClient::class)
->setFactory([new Reference(PluginClientFactory::class), 'createClient'])
->addArgument(new Reference($serviceId.'.client'))
Expand All @@ -340,14 +340,18 @@ function ($id) {
])
;

if (is_bool($arguments['public'])) {
$definition->setPublic($arguments['public']);
}

/*
* Decorate the client with clients from client-common
*/
if ($arguments['flexible_client']) {
$container
->register($serviceId.'.flexible', FlexibleHttpClient::class)
->addArgument(new Reference($serviceId.'.flexible.inner'))
->setPublic(false)
->setPublic($arguments['public'] ? true : false)
->setDecoratedService($serviceId)
;
}
Expand All @@ -356,7 +360,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'] ? true : false)
->setDecoratedService($serviceId)
;
}
Expand All @@ -365,7 +369,7 @@ function ($id) {
$container
->register($serviceId.'.batch_client', BatchClient::class)
->setArguments([new Reference($serviceId.'.batch_client.inner')])
->setPublic(false)
->setPublic($arguments['public'] ? true : false)
->setDecoratedService($serviceId)
;
}
Expand Down
1 change: 1 addition & 0 deletions Tests/Unit/DependencyInjection/ConfigurationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ public function testSupportsAllConfigFormats()
'factory' => 'httplug.factory.guzzle6',
'http_methods_client' => true,
'service' => null,
'public' => null,
'flexible_client' => false,
'batch_client' => false,
'plugins' => [
Expand Down
142 changes: 142 additions & 0 deletions Tests/Unit/DependencyInjection/HttplugExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use Http\HttplugBundle\DependencyInjection\HttplugExtension;
use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\Kernel;

/**
* @author David Buchmann <mail@davidbu.ch>
Expand Down Expand Up @@ -267,4 +268,145 @@ private function verifyProfilingDisabled()
);
}
}

public function testClientShouldHaveDefaultVisibility()
{
$this->load([
'clients' => [
'acme' => [],
],
]);

$this->assertContainerBuilderHasService('httplug.client.acme');

if (version_compare(Kernel::VERSION, '3.4', '>=')) {
// Symfony made services private by default starting from 3.4
$this->assertTrue($this->container->getDefinition('httplug.client.acme')->isPublic());
$this->assertTrue($this->container->getDefinition('httplug.client.acme')->isPrivate());
} else {
// Legacy Symfony
$this->assertTrue($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());

if (version_compare(Kernel::VERSION, '3.4', '>=')) {
// Symfony made services private by default starting from 3.4
$this->assertFalse($this->container->getDefinition('httplug.client.acme')->isPrivate());
}
}

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());

if (version_compare(Kernel::VERSION, '3.4', '>=')) {
// Symfony made services private by default starting from 3.4
$this->assertFalse($this->container->getDefinition('httplug.client.acme.flexible')->isPrivate());
}
}

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());

if (version_compare(Kernel::VERSION, '3.4', '>=')) {
// Symfony made services private by default starting from 3.4
$this->assertFalse($this->container->getDefinition('httplug.client.acme.http_methods')->isPrivate());
}
}

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());

if (version_compare(Kernel::VERSION, '3.4', '>=')) {
// Symfony made services private by default starting from 3.4
$this->assertFalse($this->container->getDefinition('httplug.client.acme.batch_client')->isPrivate());
}
}
}