Code Coverage for /home/travis/build/in6pio/Incipio/src/FrontBundle/Services/Http/RequestBuilder.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	4 / 4	CRAP	100.00% covered (success)	100.00%	35 / 35
RequestBuilder	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	4 / 4	13	100.00% covered (success)	100.00%	35 / 35
__construct				100.00% covered (success)	100.00%	1 / 1	3	100.00% covered (success)	100.00%	13 / 13
createRequest				100.00% covered (success)	100.00%	1 / 1	6	100.00% covered (success)	100.00%	17 / 17
getBaseUrl				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	1 / 1
getHeaders				100.00% covered (success)	100.00%	1 / 1	3	100.00% covered (success)	100.00%	4 / 4

1	<?php
2
3	namespace FrontBundle\Services\Http;
4
5	use GuzzleHttp\Psr7\Request;
6	use Psr\Http\Message\RequestInterface;
7	use Symfony\Component\Routing\Exception\InvalidParameterException;
8	use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
9	use Symfony\Component\Routing\Exception\RouteNotFoundException;
10
11	/**
12	* Class RequestBuilder.
13	*
14	* @author Théo FIDRY <theo.fidry@gmail.com>
15	*/
16	class RequestBuilder
17	{
18	/**
19	* @var UrlBuilder
20	*/
21	private $urlBuilder;
22
23	/**
24	* @var string
25	*/
26	private $baseUrl;
27
28	/**
29	* @param UrlBuilder $urlBuilder
30	* @param string $baseUrl
31	*
32	* @throws \InvalidArgumentException
33	*/
34	public function __construct(UrlBuilder $urlBuilder, $baseUrl)
35	{
36	$this->urlBuilder = $urlBuilder;
37
38	$lastCharacter = strlen($baseUrl) - 1;
39	if ('/' === $baseUrl[$lastCharacter]) {
40	$baseUrl = substr($baseUrl, 0, $lastCharacter);
41	}
42
43	if ('http' !== substr($baseUrl, 0, 4)) {
44	throw new \InvalidArgumentException(
45	sprintf(
46	'Expected base URL to implement HTTP protocol. Should start with "http://" or "https://". Got "%s"'
47	.'instead.',
48	$baseUrl
49	)
50	);
51	}
52
53	$this->baseUrl = $baseUrl;
54	}
55
56	/**
57	* Creates and return a new request object. All get, head, etc. methods are generated via this method.
58	*
59	* @example
60	* If URL is empty, only the base URL will be used:
61	* ::createRequest('GET')
62	* => http://localhost
63	*
64	* If URI is used, add the base URL to generate the proper URL to request
65	* ::createRequest('GET', '/api/users')
66	* => http://localhost/api/users
67	*
68	* If route name is used, will first generate the URI before applying the base URL; can use parameters
69	* ::createRequest('GET', 'users_cget')
70	* => http://localhost/api/users
71	*
72	* ::createRequest('GET', 'users_get', null, ['parameters' => ['id' => 14]])
73	* => http://localhost/api/users/14
74	*
75	* Can also apply other options
76	* ::createRequest('GET', null, null, ['query' => ['id' => 14, 'filter' => ['order' => ['startAt' => 'desc']]])
77	* => http://localhost/api?id=14&filter[where][name]=john
78	*
79	* Or if you have just one query
80	* ::createRequest('GET', null, null, ['query' => 'filter[where][name]=john')
81	* => http://localhost/api?filter[where][name]=john
82	*
83	* @param string $method HTTP method.
84	* @param string\|null $url URL, URL, URI or route name.
85	* @param string\|null $token API token.
86	* @param array $options Array of request options to apply. can have the keys:
87	* - headers: array
88	* - parameters (route parameters if $url is a route and not an URI)
89	* - body: string\|null
90	*
91	* @return RequestInterface
92	*
93	* @throws RouteNotFoundException If the named route doesn't exist
94	* @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
95	* @throws InvalidParameterException When a parameter value for a placeholder is not correct because it
96	* does not match the requirement
97	*/
98	public function createRequest($method, $url = null, $token = null, array $options = [])
99	{
100	// Extract route parameters
101	$parameters = [];
102	if (true === array_key_exists('parameters', $options)) {
103	$parameters = $options['parameters'];
104	}
105
106	// If Query is an array cast it to string
107	$uri = null;
108	if (true === array_key_exists('query', $options)) {
109	if (true === is_array($options['query'])) {
110	$uri = http_build_query($options['query']);
111	} elseif (true === is_string($options['query'])) {
112	$uri = $options['query'];
113	}
114	}
115
116	// Build URL with query parameters
117	$url = (null === $uri)
118	? $this->urlBuilder->buildUrl($this->baseUrl, $url, $parameters)
119	: sprintf('%s?%s', $this->urlBuilder->buildUrl($this->baseUrl, $url, $parameters), $uri)
120	;
121
122	return new Request($method, $url, $this->getHeaders($token, $options));
123	}
124
125	/**
126	* @return string
127	*/
128	public function getBaseUrl()
129	{
130	return $this->baseUrl;
131	}
132
133	/**
134	* Gets the request headers from the headers given in the options and add the authorization header if the API
135	* token is provided.
136	*
137	* @param string\|null $token API token.
138	* @param array $options Array of request options
139	*
140	* @return string[]
141	*/
142	private function getHeaders($token = null, array $options = [])
143	{
144	if (null !== $token) {
145	$options['headers']['authorization'] = sprintf('Bearer %s', $token);
146	}
147
148	return (true === array_key_exists('headers', $options)) ? $options['headers'] : [];
149	}
150	}