Configuration::configureClients() - Code Metrics - Inspection of "Discovery bugfixes and more flexible. (#87)" - php-http/HttplugBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c516a4...1e806a )

by Márk

created 2016-07-18 21:16 UTC

Configuration::configureClients() B

↳ Parent: Configuration

Complexity

Conditions	3
Paths	1

Size

Total Lines	37
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	30
CRAP Score	3.0146

Importance

Changes	3
Bugs	0	Features	2

Metric	Value
c	3
b	0
f	2
dl	0
loc	37
ccs	30
cts	34
cp	0.8824
rs	8.8571
cc	3
eloc	32
nc	1
nop	1
crap	3.0146

<?php

namespace Http\HttplugBundle\DependencyInjection;

use Symfony\Component\Config\Definition\ArrayNode;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;

/**
 * This class contains the configuration information for the bundle.
 *
 * This information is solely responsible for how the different configuration
 * sections are normalized, and merged.
 *
 * @author David Buchmann <[email protected]>
 * @author Tobias Nyholm <[email protected]>
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('httplug');

        $this->configureClients($rootNode);
        $this->configurePlugins($rootNode);

        $rootNode
            ->validate()
                ->ifTrue(function ($v) {
                    return !empty($v['classes']['client'])
                        || !empty($v['classes']['message_factory'])
                        || !empty($v['classes']['uri_factory'])
                        || !empty($v['classes']['stream_factory']);
                })
                ->then(function ($v) {
                    foreach ($v['classes'] as $key => $class) {
                        if (null !== $class && !class_exists($class)) {
                            throw new InvalidConfigurationException(sprintf(
                                'Class %s specified for httplug.classes.%s does not exist.',
                                $class,
                                $key
                            ));
                        }
                    }

                    return $v;
                })
            ->end()
            ->children()
                ->arrayNode('main_alias')
                    ->addDefaultsIfNotSet()
                    ->info('Configure which service the main alias point to.')
                    ->children()
                        ->scalarNode('client')->defaultValue('httplug.client.default')->end()
                        ->scalarNode('message_factory')->defaultValue('httplug.message_factory.default')->end()
                        ->scalarNode('uri_factory')->defaultValue('httplug.uri_factory.default')->end()
                        ->scalarNode('stream_factory')->defaultValue('httplug.stream_factory.default')->end()
                    ->end()
                ->end()
                ->arrayNode('classes')
                    ->addDefaultsIfNotSet()
                    ->info('Overwrite a service class instead of using the discovery mechanism.')
                    ->children()
                        ->scalarNode('client')->defaultNull()->end()
                        ->scalarNode('message_factory')->defaultNull()->end()
                        ->scalarNode('uri_factory')->defaultNull()->end()
                        ->scalarNode('stream_factory')->defaultNull()->end()
                    ->end()
                ->end()
                ->arrayNode('toolbar')
                    ->addDefaultsIfNotSet()
                    ->info('Extend the debug profiler with inforation about requests.')
                    ->children()
                        ->enumNode('enabled')
                            ->info('If "auto" (default), the toolbar is activated when kernel.debug is true. You can force the toolbar on and off by changing this option.')
                            ->values([true, false, 'auto'])
                            ->defaultValue('auto')
                        ->end()
                        ->scalarNode('formatter')->defaultNull()->end()
                        ->scalarNode('captured_body_length')
                            ->defaultValue(0)
                            ->canNotBeEmpty()
                            ->info('Limit long HTTP message bodies to x characters. If set to 0 we do not read the message body. Only available with the default formatter (FullHttpMessageFormatter).')
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('discovery')
                    ->addDefaultsIfNotSet()
                    ->info('Control what clients should be found by the discovery.')
                    ->children()
                        ->scalarNode('client')
                            ->defaultValue('auto')
                            ->info('Set to "auto" to see auto discovered client in the web profiler. If provided a service id for a client then this client will be found by auto discovery.')
                        ->end()
                        ->scalarNode('async_client')
                            ->defaultNull()
                            ->info('Set to "auto" to see auto discovered client in the web profiler. If provided a service id for a client then this client will be found by auto discovery.')
                        ->end()
                    ->end()
                ->end()
            ->end();

        return $treeBuilder;
    }

    protected function configureClients(ArrayNodeDefinition $root)
    {
        $root->children()
            ->arrayNode('clients')
                ->validate()
                    ->ifTrue(function ($clients) {
                        foreach ($clients as $name => $config) {
                            return $config['flexible_client'] && $config['http_methods_client'];
                        }

                        return false;
                    })
                    ->thenInvalid('A http client can\'t be decorated with both FlexibleHttpClient and HttpMethodsClient. Only one of the following options can be true. ("flexible_client", "http_methods_client")')->end()
                ->useAttributeAsKey('name')
                ->prototype('array')
                ->children()
                    ->scalarNode('factory')
                        ->isRequired()
                        ->cannotBeEmpty()
                        ->info('The service id of a factory to use when creating the adapter.')
                    ->end()
                    ->booleanNode('flexible_client')
                        ->defaultFalse()
                        ->info('Set to true to get the client wrapped in a FlexibleHttpClient which emulates async or sync behavior.')
                    ->end()
                    ->booleanNode('http_methods_client')
                        ->defaultFalse()
                        ->info('Set to true to get the client wrapped in a HttpMethodsClient which emulates provides functions for HTTP verbs.')
                    ->end()
                    ->arrayNode('plugins')
                        ->info('A list of service ids of plugins. The order is important.')
                        ->prototype('scalar')->end()
                    ->end()
                    ->variableNode('config')->defaultValue([])->end()
                ->end()
            ->end();
    }

    /**
     * @param ArrayNodeDefinition $root
     */
    protected function configurePlugins(ArrayNodeDefinition $root)
    {
        $root->children()
            ->arrayNode('plugins')
                ->addDefaultsIfNotSet()
                ->children()
                    ->append($this->addAuthenticationPluiginNode())

                    ->arrayNode('cache')
                    ->canBeEnabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('cache_pool')
                                ->info('This must be a service id to a service implementing Psr\Cache\CacheItemPoolInterface')
                                ->isRequired()
                                ->cannotBeEmpty()
                            ->end()
                            ->scalarNode('stream_factory')
                                ->info('This must be a service id to a service implementing Http\Message\StreamFactory')
                                ->defaultValue('httplug.stream_factory')
                                ->cannotBeEmpty()
                            ->end()
                            ->arrayNode('config')
                                ->addDefaultsIfNotSet()
                                ->children()
                                    ->scalarNode('default_ttl')->defaultNull()->end()
                                    ->scalarNode('respect_cache_headers')->defaultTrue()->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end() // End cache plugin

                    ->arrayNode('cookie')
                    ->canBeEnabled()
                        ->children()
                            ->scalarNode('cookie_jar')
                                ->info('This must be a service id to a service implementing Http\Message\CookieJar')
                                ->isRequired()
                                ->cannotBeEmpty()
                            ->end()
                        ->end()
                    ->end() // End cookie plugin

                    ->arrayNode('decoder')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('use_content_encoding')->defaultTrue()->end()
                        ->end()
                    ->end() // End decoder plugin

                    ->arrayNode('history')
                    ->canBeEnabled()
                        ->children()
                            ->scalarNode('journal')
                                ->info('This must be a service id to a service implementing Http\Client\Plugin\Journal')
                                ->isRequired()
                                ->cannotBeEmpty()
                            ->end()
                        ->end()
                    ->end() // End history plugin

                    ->arrayNode('logger')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('logger')
                                ->info('This must be a service id to a service implementing Psr\Log\LoggerInterface')
                                ->defaultValue('logger')
                                ->cannotBeEmpty()
                            ->end()
                            ->scalarNode('formatter')
                                ->info('This must be a service id to a service implementing Http\Message\Formatter')
                                ->defaultNull()
                            ->end()
                        ->end()
                    ->end() // End logger plugin

                    ->arrayNode('redirect')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('preserve_header')->defaultTrue()->end()
                            ->scalarNode('use_default_for_multiple')->defaultTrue()->end()
                        ->end()
                    ->end() // End redirect plugin

                    ->arrayNode('retry')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('retry')->defaultValue(1)->end()
                        ->end()
                    ->end() // End retry plugin

                    ->arrayNode('stopwatch')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('stopwatch')
                                ->info('This must be a service id to a service extending Symfony\Component\Stopwatch\Stopwatch')
                                ->defaultValue('debug.stopwatch')
                                ->cannotBeEmpty()
                            ->end()
                        ->end()
                    ->end() // End stopwatch plugin

                ->end()
            ->end()
        ->end();
    }

    /**
     * Add configuration for authentication plugin.
     *
     * @return ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
     */
    private function addAuthenticationPluiginNode()
    {
        $builder = new TreeBuilder();
        $node = $builder->root('authentication');
        $node
            ->useAttributeAsKey('name')
            ->prototype('array')
                ->validate()
                    ->always()
                    ->then(function ($config) {
                        switch ($config['type']) {
                            case 'basic':
                                $this->validateAuthenticationType(['username', 'password'], $config, 'basic');
                                break;
                            case 'bearer':
                                $this->validateAuthenticationType(['token'], $config, 'bearer');
                                break;
                            case 'service':
                                $this->validateAuthenticationType(['service'], $config, 'service');
                                break;
                            case 'wsse':
                                $this->validateAuthenticationType(['username', 'password'], $config, 'wsse');
                                break;
                        }

                        return $config;
                    })
                ->end()
                ->children()
                    ->enumNode('type')
                        ->values(['basic', 'bearer', 'wsse', 'service'])
                        ->isRequired()
                        ->cannotBeEmpty()
                    ->end()
                    ->scalarNode('username')->end()
                    ->scalarNode('password')->end()
                    ->scalarNode('token')->end()
                    ->scalarNode('service')->end()
                    ->end()
                ->end()
            ->end(); // End authentication plugin

        return $node;
    }

    /**
     * Validate that the configuration fragment has the specified keys and none other.
     *
     * @param array  $expected Fields that must exist
     * @param array  $actual   Actual configuration hashmap
     * @param string $authName Name of authentication method for error messages
     *
     * @throws InvalidConfigurationException If $actual does not have exactly the keys specified in $expected (plus 'type')
     */
    private function validateAuthenticationType(array $expected, array $actual, $authName)
    {
        unset($actual['type']);
        $actual = array_keys($actual);
        sort($actual);
        sort($expected);

        if ($expected === $actual) {
            return;
        }

        throw new InvalidConfigurationException(sprintf(
            'Authentication "%s" requires %s but got %s',
            $authName,
            implode(', ', $expected),
            implode(', ', $actual)
        ));
    }
}


1		<?php
2
3		namespace Http\HttplugBundle\DependencyInjection;
4
5		use Symfony\Component\Config\Definition\ArrayNode;
6		use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
7		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
8		use Symfony\Component\Config\Definition\ConfigurationInterface;
9		use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
10
11		/**
12		* This class contains the configuration information for the bundle.
13		*
14		* This information is solely responsible for how the different configuration
15		* sections are normalized, and merged.
16		*
17		* @author David Buchmann <[email protected]>
18		* @author Tobias Nyholm <[email protected]>
19		*/
20		class Configuration implements ConfigurationInterface
21		{
22		/**
23		* {@inheritdoc}
24		*/
25	7	public function getConfigTreeBuilder()
26		{
27	7	$treeBuilder = new TreeBuilder();
28	7	$rootNode = $treeBuilder->root('httplug');
29
30	7	$this->configureClients($rootNode);
31	7	$this->configurePlugins($rootNode);
32
33		$rootNode
34	7	->validate()
35		->ifTrue(function ($v) {
36	6	return !empty($v['classes']['client'])
37	6	\|\| !empty($v['classes']['message_factory'])
38	3	\|\| !empty($v['classes']['uri_factory'])
39	6	\|\| !empty($v['classes']['stream_factory']);
40	7	})
41		->then(function ($v) {
42	3	foreach ($v['classes'] as $key => $class) {
43	3	if (null !== $class && !class_exists($class)) {
44	1	throw new InvalidConfigurationException(sprintf(
45	1	'Class %s specified for httplug.classes.%s does not exist.',
46	1	$class,
47		$key
48	1	));
49		}
50	2	}
51
52	2	return $v;
53	7	})
54	7	->end()
55	7	->children()
56	7	->arrayNode('main_alias')
57	7	->addDefaultsIfNotSet()
58	7	->info('Configure which service the main alias point to.')
59	7	->children()
60	7	->scalarNode('client')->defaultValue('httplug.client.default')->end()
61	7	->scalarNode('message_factory')->defaultValue('httplug.message_factory.default')->end()
62	7	->scalarNode('uri_factory')->defaultValue('httplug.uri_factory.default')->end()
63	7	->scalarNode('stream_factory')->defaultValue('httplug.stream_factory.default')->end()
64	7	->end()
65	7	->end()
66	7	->arrayNode('classes')
67	7	->addDefaultsIfNotSet()
68	7	->info('Overwrite a service class instead of using the discovery mechanism.')
69	7	->children()
70	7	->scalarNode('client')->defaultNull()->end()
71	7	->scalarNode('message_factory')->defaultNull()->end()
72	7	->scalarNode('uri_factory')->defaultNull()->end()
73	7	->scalarNode('stream_factory')->defaultNull()->end()
74	7	->end()
75	7	->end()
76	7	->arrayNode('toolbar')
77	7	->addDefaultsIfNotSet()
78	7	->info('Extend the debug profiler with inforation about requests.')
79	7	->children()
80	7	->enumNode('enabled')
81	7	->info('If "auto" (default), the toolbar is activated when kernel.debug is true. You can force the toolbar on and off by changing this option.')
82	7	->values([true, false, 'auto'])
83	7	->defaultValue('auto')
84	7	->end()
85	7	->scalarNode('formatter')->defaultNull()->end()
86	7	->scalarNode('captured_body_length')
87	7	->defaultValue(0)
88	7	->canNotBeEmpty()
89	7	->info('Limit long HTTP message bodies to x characters. If set to 0 we do not read the message body. Only available with the default formatter (FullHttpMessageFormatter).')
90	7	->end()
91	7	->end()
92	7	->end()
93	7	->arrayNode('discovery')
94	7	->addDefaultsIfNotSet()
95	7	->info('Control what clients should be found by the discovery.')
96	7	->children()
97	7	->scalarNode('client')
98	7	->defaultValue('auto')
99	7	->info('Set to "auto" to see auto discovered client in the web profiler. If provided a service id for a client then this client will be found by auto discovery.')
100	7	->end()
101	7	->scalarNode('async_client')
102	7	->defaultNull()
103	7	->info('Set to "auto" to see auto discovered client in the web profiler. If provided a service id for a client then this client will be found by auto discovery.')
104	7	->end()
105	7	->end()
106	7	->end()
107	7	->end();
108
109	7	return $treeBuilder;
110		}
111
112	7	protected function configureClients(ArrayNodeDefinition $root)
113		{
114	7	$root->children()
115	7	->arrayNode('clients')
116	7	->validate()
117		->ifTrue(function ($clients) {
118		foreach ($clients as $name => $config) {
119		return $config['flexible_client'] && $config['http_methods_client'];
120		}
121
122		return false;
123	7	})
124	7	->thenInvalid('A http client can\'t be decorated with both FlexibleHttpClient and HttpMethodsClient. Only one of the following options can be true. ("flexible_client", "http_methods_client")')->end()
125	7	->useAttributeAsKey('name')
126	7	->prototype('array')
127	7	->children()
128	7	->scalarNode('factory')
129	7	->isRequired()
130	7	->cannotBeEmpty()
131	7	->info('The service id of a factory to use when creating the adapter.')
132	7	->end()
133	7	->booleanNode('flexible_client')
134	7	->defaultFalse()
135	7	->info('Set to true to get the client wrapped in a FlexibleHttpClient which emulates async or sync behavior.')
136	7	->end()
137	7	->booleanNode('http_methods_client')
138	7	->defaultFalse()
139	7	->info('Set to true to get the client wrapped in a HttpMethodsClient which emulates provides functions for HTTP verbs.')
140	7	->end()
141	7	->arrayNode('plugins')
142	7	->info('A list of service ids of plugins. The order is important.')
143	7	->prototype('scalar')->end()
144	7	->end()
145	7	->variableNode('config')->defaultValue([])->end()
146	7	->end()
147	7	->end();
148	7	}
149
150		/**
151		* @param ArrayNodeDefinition $root
152		*/
153	7	protected function configurePlugins(ArrayNodeDefinition $root)
154		{
155	7	$root->children()
156	7	->arrayNode('plugins')
157	7	->addDefaultsIfNotSet()
158	7	->children()
159	7	->append($this->addAuthenticationPluiginNode())
160
161	7	->arrayNode('cache')
162	7	->canBeEnabled()
163	7	->addDefaultsIfNotSet()
164	7	->children()
165	7	->scalarNode('cache_pool')
166	7	->info('This must be a service id to a service implementing Psr\Cache\CacheItemPoolInterface')
167	7	->isRequired()
168	7	->cannotBeEmpty()
169	7	->end()
170	7	->scalarNode('stream_factory')
171	7	->info('This must be a service id to a service implementing Http\Message\StreamFactory')
172	7	->defaultValue('httplug.stream_factory')
173	7	->cannotBeEmpty()
174	7	->end()
175	7	->arrayNode('config')
176	7	->addDefaultsIfNotSet()
177	7	->children()
178	7	->scalarNode('default_ttl')->defaultNull()->end()
179	7	->scalarNode('respect_cache_headers')->defaultTrue()->end()
180	7	->end()
181	7	->end()
182	7	->end()
183	7	->end() // End cache plugin
184
185	7	->arrayNode('cookie')
186	7	->canBeEnabled()
187	7	->children()
188	7	->scalarNode('cookie_jar')
189	7	->info('This must be a service id to a service implementing Http\Message\CookieJar')
190	7	->isRequired()
191	7	->cannotBeEmpty()
192	7	->end()
193	7	->end()
194	7	->end() // End cookie plugin
195
196	7	->arrayNode('decoder')
197	7	->canBeDisabled()
198	7	->addDefaultsIfNotSet()
199	7	->children()
200	7	->scalarNode('use_content_encoding')->defaultTrue()->end()
201	7	->end()
202	7	->end() // End decoder plugin
203
204	7	->arrayNode('history')
205	7	->canBeEnabled()
206	7	->children()
207	7	->scalarNode('journal')
208	7	->info('This must be a service id to a service implementing Http\Client\Plugin\Journal')
209	7	->isRequired()
210	7	->cannotBeEmpty()
211	7	->end()
212	7	->end()
213	7	->end() // End history plugin
214
215	7	->arrayNode('logger')
216	7	->canBeDisabled()
217	7	->addDefaultsIfNotSet()
218	7	->children()
219	7	->scalarNode('logger')
220	7	->info('This must be a service id to a service implementing Psr\Log\LoggerInterface')
221	7	->defaultValue('logger')
222	7	->cannotBeEmpty()
223	7	->end()
224	7	->scalarNode('formatter')
225	7	->info('This must be a service id to a service implementing Http\Message\Formatter')
226	7	->defaultNull()
227	7	->end()
228	7	->end()
229	7	->end() // End logger plugin
230
231	7	->arrayNode('redirect')
232	7	->canBeDisabled()
233	7	->addDefaultsIfNotSet()
234	7	->children()
235	7	->scalarNode('preserve_header')->defaultTrue()->end()
236	7	->scalarNode('use_default_for_multiple')->defaultTrue()->end()
237	7	->end()
238	7	->end() // End redirect plugin
239
240	7	->arrayNode('retry')
241	7	->canBeDisabled()
242	7	->addDefaultsIfNotSet()
243	7	->children()
244	7	->scalarNode('retry')->defaultValue(1)->end()
245	7	->end()
246	7	->end() // End retry plugin
247
248	7	->arrayNode('stopwatch')
249	7	->canBeDisabled()
250	7	->addDefaultsIfNotSet()
251	7	->children()
252	7	->scalarNode('stopwatch')
253	7	->info('This must be a service id to a service extending Symfony\Component\Stopwatch\Stopwatch')
254	7	->defaultValue('debug.stopwatch')
255	7	->cannotBeEmpty()
256	7	->end()
257	7	->end()
258	7	->end() // End stopwatch plugin
259
260	7	->end()
261	7	->end()
262	7	->end();
263	7	}
264
265		/**
266		* Add configuration for authentication plugin.
267		*
268		* @return ArrayNodeDefinition\|\Symfony\Component\Config\Definition\Builder\NodeDefinition
269		*/
270	7	private function addAuthenticationPluiginNode()
271		{
272	7	$builder = new TreeBuilder();
273	7	$node = $builder->root('authentication');
274		$node
275	7	->useAttributeAsKey('name')
276	7	->prototype('array')
277	7	->validate()
278	7	->always()
279	7	->then(function ($config) {
280	2	switch ($config['type']) {
281	2	case 'basic':
282	1	$this->validateAuthenticationType(['username', 'password'], $config, 'basic');
283	1	break;
284	2	case 'bearer':
285	1	$this->validateAuthenticationType(['token'], $config, 'bearer');
286	1	break;
287	2	case 'service':
288	2	$this->validateAuthenticationType(['service'], $config, 'service');
289	1	break;
290	1	case 'wsse':
291	1	$this->validateAuthenticationType(['username', 'password'], $config, 'wsse');
292	1	break;
293	1	}
294
295	1	return $config;
296	7	})
297	7	->end()
298	7	->children()
299	7	->enumNode('type')
300	7	->values(['basic', 'bearer', 'wsse', 'service'])
301	7	->isRequired()
302	7	->cannotBeEmpty()
303	7	->end()
304	7	->scalarNode('username')->end()
305	7	->scalarNode('password')->end()
306	7	->scalarNode('token')->end()
307	7	->scalarNode('service')->end()
308	7	->end()
309	7	->end()
310	7	->end(); // End authentication plugin
311
312	7	return $node;
313		}
314
315		/**
316		* Validate that the configuration fragment has the specified keys and none other.
317		*
318		* @param array $expected Fields that must exist
319		* @param array $actual Actual configuration hashmap
320		* @param string $authName Name of authentication method for error messages
321		*
322		* @throws InvalidConfigurationException If $actual does not have exactly the keys specified in $expected (plus 'type')
323		*/
324	2	private function validateAuthenticationType(array $expected, array $actual, $authName)
325		{
326	2	unset($actual['type']);
327	2	$actual = array_keys($actual);
328	2	sort($actual);
329	2	sort($expected);
330
331	2	if ($expected === $actual) {
332	1	return;
333		}
334
335	1	throw new InvalidConfigurationException(sprintf(
336	1	'Authentication "%s" requires %s but got %s',
337	1	$authName,
338	1	implode(', ', $expected),
339	1	implode(', ', $actual)
340	1	));
341		}
342		}
343

php-http / HttplugBundle

Push — master ( c516a4...1e806a )

Configuration::configureClients() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like