AbstractBaseProvider::getBoolOption() - Code Metrics - Inspection of "[Provider] Feature: Improve code quality for reque..." - SocialConnect/auth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.x ( e636ad...7bb25c )

by Дмитрий

created 2019-09-15 09:21 UTC

AbstractBaseProvider::getBoolOption() A

↳ Parent: AbstractBaseProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	3
c	2
b	0
f	0
nc	2
nop	2
dl	0
loc	7
ccs	4
cts	4
cp	1
crap	2
rs	10

<?php
/**
 * SocialConnect project
 * @author: Patsura Dmitry https://github.com/ovr <[email protected]>
 */
declare(strict_types=1);

namespace SocialConnect\Provider;

use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestFactoryInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use SocialConnect\Provider\Exception\InvalidProviderConfiguration;
use SocialConnect\Common\HttpStack;
use SocialConnect\Provider\Exception\InvalidRequest;
use SocialConnect\Provider\Exception\InvalidResponse;
use SocialConnect\Provider\Session\SessionInterface;

abstract class AbstractBaseProvider
{
    /**
     * @var Consumer
     */
    protected $consumer;

    /**
     * @var array
     */
    protected $scope = [];

    /**
     * @var HttpStack
     */
    protected $httpStack;

    /**
     * @var string
     */
    protected $redirectUri;

    /**
     * @var SessionInterface
     */
    protected $session;

    /**
     * @var array
     */
    protected $options = [];

    /**
     * @param HttpStack $httpStack
     * @param SessionInterface $session
     * @param array $parameters
     * @throws InvalidProviderConfiguration
     */
    public function __construct(HttpStack $httpStack, SessionInterface $session, array $parameters)
    {
        if (isset($parameters['scope'])) {
            $this->setScope($parameters['scope']);
        }

        if (isset($parameters['redirectUri'])) {
            $this->redirectUri = $parameters['redirectUri'];
        }

        if (isset($parameters['options'])) {
            $this->options = $parameters['options'];
        }

        $this->consumer = $this->createConsumer($parameters);
        $this->httpStack = $httpStack;
        $this->session = $session;
    }

    /**
     * @param int $bytes Default it's 16 bytes / 128 bit / 16 symbols / 32 symbols in hex
     * @return string
     * @throws \Exception
     */
    protected function generateState(int $bytes = 16): string
    {
        return bin2hex(random_bytes($bytes));
    }

    /**
     * @param array $parameters
     * @return Consumer
     * @throws InvalidProviderConfiguration
     */
    protected function createConsumer(array $parameters): Consumer
    {
        return new Consumer(
            $this->getRequiredStringParameter('applicationId', $parameters),
            $this->getRequiredStringParameter('applicationSecret', $parameters)
        );
    }

    /**
     * @param string $key
     * @param array $parameters
     * @return string
     * @throws InvalidProviderConfiguration
     */
    protected function getRequiredStringParameter(string $key, array $parameters): string
    {
        if (!isset($parameters[$key])) {
            throw new InvalidProviderConfiguration(
                "Parameter '{$key}' doesn`t exists for '{$this->getName()}' provider configuration"
            );
        }

        if (!is_string($parameters[$key])) {
            throw new InvalidProviderConfiguration(
                "Parameter '{$key}' must be string inside '{$this->getName()}' provider configuration"
            );
        }

        return $parameters[$key];
    }

    /**
     * @param string $key
     * @param bool $default
     * @return bool
     */
    public function getBoolOption($key, $default): bool
    {
        if (array_key_exists($key, $this->options)) {
            return (bool) $this->options[$key];
        }

        return $default;
    }

    /**
     * @param string $key
     * @param array $default
     * @return array
     */
    public function getArrayOption($key, array $default = []): array
    {
        if (array_key_exists($key, $this->options)) {
            return (array) $this->options[$key];
        }

        return $default;
    }

    /**
     * @return string
     */
    public function getRedirectUrl(): string
    {
        return str_replace('${provider}', $this->getName(), $this->redirectUri);
    }

    /**
     * Default parameters for auth url, can be redeclared inside implementation of the Provider
     *
     * @return array
     */
    public function getAuthUrlParameters(): array
    {
        return $this->getArrayOption('auth.parameters', []);
    }

    /**
     * @return string
     */
    abstract public function getBaseUri();

    /**
     * Return Provider's name
     *
     * @return string
     */
    abstract public function getName();

    /**
     * @param array $requestParameters
     * @return \SocialConnect\Provider\AccessTokenInterface
     */
    abstract public function getAccessTokenByRequestParameters(array $requestParameters);

    /**
     * @return string
     */
    abstract public function makeAuthUrl(): string;

    /**
     * Get current user identity from social network by $accessToken
     *
     * @param AccessTokenInterface $accessToken
     * @return \SocialConnect\Common\Entity\User
     *
     * @throws \Psr\Http\Client\ClientExceptionInterface
     * @throws \SocialConnect\Provider\Exception\InvalidResponse
     */
    abstract public function getIdentity(AccessTokenInterface $accessToken);

    /**
     * @param RequestInterface $request
     * @return ResponseInterface
     * @throws InvalidResponse
     * @throws \Psr\Http\Client\ClientExceptionInterface
     */
    protected function executeRequest(RequestInterface $request): ResponseInterface
    {
        $response = $this->httpStack->sendRequest($request);

        $statusCode = $response->getStatusCode();
        if (200 <= $statusCode && 300 > $statusCode) {
            return $response;
        }

        throw new InvalidResponse(
            'API response with error code',
            $response
        );
    }

    /**
     * @param ResponseInterface $response
     * @return array
     * @throws InvalidResponse
     */
    protected function hydrateResponse(ResponseInterface $response): array
    {
        $result = json_decode($response->getBody()->getContents(), true);
        if (!$result) {
            throw new InvalidResponse(
                'API response is not a valid JSON object',
                $response
            );
        }

        return $result;
    }

    /**
     * This is a lifecycle method, should be redeclared inside Provider when it's needed to mutate $query or $headers
     *
     * @param string $method
     * @param string $uri
     * @param array $headers
     * @param array $query
     * @param AccessTokenInterface|null $accessToken Null is needed to allow send request for not OAuth
     */
    public function prepareRequest(string $method, string $uri, array &$headers, array &$query, AccessTokenInterface $accessToken = null): void
    {
        if ($accessToken) {
            $query['access_token'] = $accessToken->getToken();
        }
    }

    /**
     * @param string $method
     * @param string $url
     * @param array $query
     * @param AccessTokenInterface|null $accessToken
     * @param array|null $payload
     * @return array
     * @throws \Psr\Http\Client\ClientExceptionInterface
     */
    public function request(string $method, string $url, array $query, AccessTokenInterface $accessToken = null, array $payload = null)
    {
        $headers = [];

        $this->prepareRequest(
            $method,
            $this->getBaseUri() . $url,
            $headers,
            $query,
            $accessToken
        );

        return $this->hydrateResponse(
            $this->executeRequest(
                $this->createRequest(
                    $method,
                    $this->getBaseUri() . $url,
                    $query,
                    $headers,
                    $payload
                )
            )
        );
    }

    /**
     * @return array
     */
    public function getScope()
    {
        return $this->scope;
    }

    /**
     * @param array $scope
     */
    public function setScope(array $scope)
    {
        $this->scope = $scope;
    }

    /**
     * @return string
     */
    public function getScopeInline()
    {
        return implode(',', $this->scope);
    }

    /**
     * @return \SocialConnect\Provider\Consumer
     */
    public function getConsumer()
    {
        return $this->consumer;
    }

    /**
     * @param string $method
     * @param string $uri
     * @param array $query
     * @param array $headers
     * @param array|null $payload
     * @return RequestInterface
     */
    protected function createRequest(string $method, string $uri, array $query, array $headers, array $payload = null): RequestInterface
    {
        $url = $uri;

        if (count($query) > 0) {
            $url .= '?' . http_build_query($query);
        }

        $request = $this->httpStack->createRequest($method, $url);

        foreach ($headers as $k => $v) {
            $request = $request->withHeader($k, $v);
        }

        $method = strtoupper($request->getMethod());
        $withPayload = $method === 'POST' || $method === 'PUT';

        if ($payload) {
            if ($withPayload) {
                $payloadAsString = http_build_query($payload);
                $contentLength = mb_strlen($payloadAsString);

                $request = $request
                    ->withHeader('Content-Length', $contentLength)
                    ->withHeader('Content-Type', 'application/x-www-form-urlencoded')
                ;

                return $request->withBody(
                    $this->httpStack->createStream(
                        $payloadAsString
                    )
                );
            }

            throw new InvalidRequest('You are not able to send payload on HTTP method without body');
        }

        return $request;
    }
}


1		<?php
2		/**
3		* SocialConnect project
4		* @author: Patsura Dmitry https://github.com/ovr <[email protected]>
5		*/
6		declare(strict_types=1);
7
8		namespace SocialConnect\Provider;
9
10		use Psr\Http\Client\ClientInterface;
11		use Psr\Http\Message\RequestFactoryInterface;
12		use Psr\Http\Message\RequestInterface;
13		use Psr\Http\Message\ResponseInterface;
14		use SocialConnect\Provider\Exception\InvalidProviderConfiguration;
15		use SocialConnect\Common\HttpStack;
16		use SocialConnect\Provider\Exception\InvalidRequest;
17		use SocialConnect\Provider\Exception\InvalidResponse;
18		use SocialConnect\Provider\Session\SessionInterface;
19
20		abstract class AbstractBaseProvider
21		{
22		/**
23		* @var Consumer
24		*/
25		protected $consumer;
26
27		/**
28		* @var array
29		*/
30		protected $scope = [];
31
32		/**
33		* @var HttpStack
34		*/
35		protected $httpStack;
36
37		/**
38		* @var string
39		*/
40		protected $redirectUri;
41
42		/**
43		* @var SessionInterface
44		*/
45		protected $session;
46
47		/**
48		* @var array
49		*/
50		protected $options = [];
51
52		/**
53		* @param HttpStack $httpStack
54		* @param SessionInterface $session
55		* @param array $parameters
56		* @throws InvalidProviderConfiguration
57		*/
58	445	public function __construct(HttpStack $httpStack, SessionInterface $session, array $parameters)
59		{
60	445	if (isset($parameters['scope'])) {
61	443	$this->setScope($parameters['scope']);
62		}
63
64	445	if (isset($parameters['redirectUri'])) {
65	443	$this->redirectUri = $parameters['redirectUri'];
66		}
67
68	445	if (isset($parameters['options'])) {
69		$this->options = $parameters['options'];
70		}
71
72	445	$this->consumer = $this->createConsumer($parameters);
73	445	$this->httpStack = $httpStack;
74	445	$this->session = $session;
75	445	}
76
77		/**
78		* @param int $bytes Default it's 16 bytes / 128 bit / 16 symbols / 32 symbols in hex
79		* @return string
80		* @throws \Exception
81		*/
82	52	protected function generateState(int $bytes = 16): string
83		{
84	52	return bin2hex(random_bytes($bytes));
85		}
86
87		/**
88		* @param array $parameters
89		* @return Consumer
90		* @throws InvalidProviderConfiguration
91		*/
92	438	protected function createConsumer(array $parameters): Consumer
93		{
94	438	return new Consumer(
95	438	$this->getRequiredStringParameter('applicationId', $parameters),
96	438	$this->getRequiredStringParameter('applicationSecret', $parameters)
97		);
98		}
99
100		/**
101		* @param string $key
102		* @param array $parameters
103		* @return string
104		* @throws InvalidProviderConfiguration
105		*/
106	445	protected function getRequiredStringParameter(string $key, array $parameters): string
107		{
108	445	if (!isset($parameters[$key])) {
109		throw new InvalidProviderConfiguration(
110		"Parameter '{$key}' doesn`t exists for '{$this->getName()}' provider configuration"
111		);
112		}
113
114	445	if (!is_string($parameters[$key])) {
115		throw new InvalidProviderConfiguration(
116		"Parameter '{$key}' must be string inside '{$this->getName()}' provider configuration"
117		);
118		}
119
120	445	return $parameters[$key];
121		}
122
123		/**
124		* @param string $key
125		* @param bool $default
126		* @return bool
127		*/
128	24	public function getBoolOption($key, $default): bool
129		{
130	24	if (array_key_exists($key, $this->options)) {
131	1	return (bool) $this->options[$key];
132		}
133
134	23	return $default;
135		}
136
137		/**
138		* @param string $key
139		* @param array $default
140		* @return array
141		*/
142	32	public function getArrayOption($key, array $default = []): array
143		{
144	32	if (array_key_exists($key, $this->options)) {
145		return (array) $this->options[$key];
146		}
147
148	32	return $default;
149		}
150
151		/**
152		* @return string
153		*/
154	80	public function getRedirectUrl(): string
155		{
156	80	return str_replace('${provider}', $this->getName(), $this->redirectUri);
157		}
158
159		/**
160		* Default parameters for auth url, can be redeclared inside implementation of the Provider
161		*
162		* @return array
163		*/
164	23	public function getAuthUrlParameters(): array
165		{
166	23	return $this->getArrayOption('auth.parameters', []);
167		}
168
169		/**
170		* @return string
171		*/
172		abstract public function getBaseUri();
173
174		/**
175		* Return Provider's name
176		*
177		* @return string
178		*/
179		abstract public function getName();
180
181		/**
182		* @param array $requestParameters
183		* @return \SocialConnect\Provider\AccessTokenInterface
184		*/
185		abstract public function getAccessTokenByRequestParameters(array $requestParameters);
186
187		/**
188		* @return string
189		*/
190		abstract public function makeAuthUrl(): string;
191
192		/**
193		* Get current user identity from social network by $accessToken
194		*
195		* @param AccessTokenInterface $accessToken
196		* @return \SocialConnect\Common\Entity\User
197		*
198		* @throws \Psr\Http\Client\ClientExceptionInterface
199		* @throws \SocialConnect\Provider\Exception\InvalidResponse
200		*/
201		abstract public function getIdentity(AccessTokenInterface $accessToken);
202
203		/**
204		* @param RequestInterface $request
205		* @return ResponseInterface
206		* @throws InvalidResponse
207		* @throws \Psr\Http\Client\ClientExceptionInterface
208		*/
209	103	protected function executeRequest(RequestInterface $request): ResponseInterface
210		{
211	103	$response = $this->httpStack->sendRequest($request);
212
213	103	$statusCode = $response->getStatusCode();
214	103	if (200 <= $statusCode && 300 > $statusCode) {
215	56	return $response;
216		}
217
218	47	throw new InvalidResponse(
219	47	'API response with error code',
220		$response
221		);
222		}
223
224		/**
225		* @param ResponseInterface $response
226		* @return array
227		* @throws InvalidResponse
228		*/
229	54	protected function hydrateResponse(ResponseInterface $response): array
230		{
231	54	$result = json_decode($response->getBody()->getContents(), true);
232	54	if (!$result) {
233	23	throw new InvalidResponse(
234	23	'API response is not a valid JSON object',
235		$response
236		);
237		}
238
239	31	return $result;
240		}
241
242		/**
243		* This is a lifecycle method, should be redeclared inside Provider when it's needed to mutate $query or $headers
244		*
245		* @param string $method
246		* @param string $uri
247		* @param array $headers
248		* @param array $query
249		* @param AccessTokenInterface\|null $accessToken Null is needed to allow send request for not OAuth
250		*/
251	32	public function prepareRequest(string $method, string $uri, array &$headers, array &$query, AccessTokenInterface $accessToken = null): void
252		{
253	32	if ($accessToken) {
254	32	$query['access_token'] = $accessToken->getToken();
255		}
256	32	}
257
258		/**
259		* @param string $method
260		* @param string $url
261		* @param array $query
262		* @param AccessTokenInterface\|null $accessToken
263		* @param array\|null $payload
264		* @return array
265		* @throws \Psr\Http\Client\ClientExceptionInterface
266		*/
267	76	public function request(string $method, string $url, array $query, AccessTokenInterface $accessToken = null, array $payload = null)
268		{
269	76	$headers = [];
270
271	76	$this->prepareRequest(
272	76	$method,
273	76	$this->getBaseUri() . $url,
274		$headers,
275		$query,
276		$accessToken
277		);
278
279	76	return $this->hydrateResponse(
280	76	$this->executeRequest(
281	76	$this->createRequest(
282	76	$method,
283	76	$this->getBaseUri() . $url,
284		$query,
285		$headers,
286		$payload
287		)
288		)
289		);
290		}
291
292		/**
293		* @return array
294		*/
295		public function getScope()
296		{
297		return $this->scope;
298		}
299
300		/**
301		* @param array $scope
302		*/
303	411	public function setScope(array $scope)
304		{
305	411	$this->scope = $scope;
306	411	}
307
308		/**
309		* @return string
310		*/
311	18	public function getScopeInline()
312		{
313	18	return implode(',', $this->scope);
314		}
315
316		/**
317		* @return \SocialConnect\Provider\Consumer
318		*/
319	1	public function getConsumer()
320		{
321	1	return $this->consumer;
322		}
323
324		/**
325		* @param string $method
326		* @param string $uri
327		* @param array $query
328		* @param array $headers
329		* @param array\|null $payload
330		* @return RequestInterface
331		*/
332	77	protected function createRequest(string $method, string $uri, array $query, array $headers, array $payload = null): RequestInterface
333		{
334	77	$url = $uri;
335
336	77	if (count($query) > 0) {
337	65	$url .= '?' . http_build_query($query);
338		}
339
340	77	$request = $this->httpStack->createRequest($method, $url);
341
342	77	foreach ($headers as $k => $v) {
343	29	$request = $request->withHeader($k, $v);
344		}
345
346	77	$method = strtoupper($request->getMethod());
347	77	$withPayload = $method === 'POST' \|\| $method === 'PUT';
348
349	77	if ($payload) {
350		if ($withPayload) {
351		$payloadAsString = http_build_query($payload);
352		$contentLength = mb_strlen($payloadAsString);
353
354		$request = $request
355		->withHeader('Content-Length', $contentLength)
356		->withHeader('Content-Type', 'application/x-www-form-urlencoded')
357		;
358
359		return $request->withBody(
360		$this->httpStack->createStream(
361		$payloadAsString
362		)
363		);
364		}
365
366		throw new InvalidRequest('You are not able to send payload on HTTP method without body');
367		}
368
369	77	return $request;
370		}
371		}
372

SocialConnect / auth

Push — 3.x ( e636ad...7bb25c )

AbstractBaseProvider::getBoolOption() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like