AbstractClient::credential() - Code Metrics - 24Slides/auth-connector - Measure and Improve Code Quality continuously with Scrutinizer

AbstractClient::credential() A
last analyzed 2020-10-26 19:06 UTC

↳ Parent: AbstractClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Slides\Connector\Auth\Clients;

use GuzzleHttp\Client;
use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Psr7\Response;
use Illuminate\Support\Arr;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface;
use RuntimeException;

/**
 * Class AbstractClient
 *
 * @package Slides\Connector\Auth\Clients
 */
abstract class AbstractClient
{
    /**
     * HTTP client
     *
     * @var Client
     */
    protected $client;

    /**
     * Base URL of resource
     *
     * @var string
     */
    protected $baseUrl;

    /**
     * Client's request
     *
     * @var Request
     */
    protected $request;

    /**
     * Client's response
     *
     * @var Response
     */
    protected $response;

    /**
     * HTTP request headers
     *
     * @var array
     */
    protected $headers = [];

    /**
     * The query parameters.
     *
     * @var array
     */
    protected $query = [];

    /**
     * The body of an entity enclosing request.
     *
     * @var array
     */
    protected $body;

    /**
     * The composed credentials.
     *
     * @var array
     */
    protected $credentials = [];

    /**
     * Whether client is aborted to perform requests
     *
     * @var bool
     */
    protected $isAborted = false;

    /**
     * List of supported requests
     *
     * @return array
     */
    abstract public function requests(): array;

    /**
     * Authorize the client
     *
     * @return void
     */
    abstract protected function authorize();

    /**
     * Get client's credentials
     *
     * @return array
     */
    abstract protected function credentials(): array;

    /**
     * BaseClient constructor.
     *
     * @param array $config
     * @param array $credentials
     */
    public function __construct(array $config = [], array $credentials = [])
    {
        $this->credentials = array_merge($this->credentials(), $credentials);

        $this->client = new Client(array_merge([
            'base_uri' => $this->baseUrl,
            'handler' => $this->createClientHandler(),
            'http_errors' => false,
            'headers' => [
                'User-Agent' => null
            ]
        ], $config));

        $this->boot();
    }

    /**
     * Boot the client
     */
    protected function boot()
    {
        if (!$this->baseUrl) {
            throw new InvalidArgumentException('Base URL should be defined');
        }

        $this->authorize();
    }

    /**
     * Send a request
     *
     * @param AbstractRequest $request
     * @param array $options Request options
     *
     * @return mixed
     *
     * @throws RuntimeException
     */
    public function request(AbstractRequest $request, array $options = [])
    {
        if (!$this->resolveRequest($request)) {
            throw new InvalidArgumentException(static::class . ': ' . get_class($request) . ' should be registered');
        }

        $request->mergeOptions($options)
            ->mergeOptions(array_filter([
                'query' => $this->query,
                'json' => $this->body
            ]))
            ->compose();

        $response = $this->send(
            $request->getMethod(),
            $request->getUri(),
            $request->getOptions()
        );

        $request->setResponse($response);

        // Validate a response
        if (!$request->success()) {
            throw new RuntimeException(json_encode($response, JSON_PRETTY_PRINT));
        }

        return $response;
    }

    /**
     * Send a request
     *
     * @param string $method
     * @param string $url
     * @param array $options
     *
     * @return array|null|string
     *
     * @throws
     */
    public function send(string $method, string $url, array $options = [])
    {
        if ($this->isAborted) {
            throw new RuntimeException('Cannot send a request while client is aborted');
        }

        $this->request = new Request($method, $url, $this->headers);

        if (!$this->response = $this->client->send($this->request, $options)) {
            return null;
        }

        $contents = (string) $this->response->getBody();

        return json_decode($contents, true) ?: $contents;
    }

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

    /**
     * Add query parameters.
     *
     * @param array $parameters
     *
     * @return void
     */
    public function query(array $parameters)
    {
        $this->query = array_merge($this->query, $parameters);
    }

    /**
     * Add body parameters.
     *
     * @param array $parameters
     */
    public function body(array $parameters)
    {
        $this->body = array_merge((array) $this->body, $parameters);
    }

    /**
     * Get credentials parameter
     *
     * @param string $key
     * @param mixed $default
     *
     * @return mixed
     */
    public function credential(string $key, $default = null)
    {
        return Arr::get($this->credentials, $key, $default);
    }

    /**
     * Set the client as aborted and send notification
     *
     * @return void
     */
    public function abort()
    {
        $this->isAborted = true;
    }

    /**
     * Get response
     *
     * @return Response
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * Create a handler for Guzzle HTTP Client
     *
     * @return HandlerStack
     */
    private function createClientHandler()
    {
        $stack = HandlerStack::create();

        $stack->push(Middleware::mapRequest(function (RequestInterface $request) {
            return $this->request = $request;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        }));

        return $stack;
    }

    /**
     * Resolve request
     *
     * @param AbstractRequest $request
     *
     * @return AbstractRequest|null
     */
    private function resolveRequest(AbstractRequest $request)
    {
        foreach ($this->requests() as $class) {
            if (class_basename($class) !== class_basename($request)) {
                continue;
            }

            return $request;
        }

        return null;
    }
}

1			<?php
2
3			namespace Slides\Connector\Auth\Clients;
4
5			use GuzzleHttp\Client;
6			use GuzzleHttp\Middleware;
7			use GuzzleHttp\Psr7\Request;
8			use GuzzleHttp\HandlerStack;
9			use GuzzleHttp\Psr7\Response;
10			use Illuminate\Support\Arr;
11			use InvalidArgumentException;
12			use Psr\Http\Message\RequestInterface;
13			use RuntimeException;
14
15			/**
16			* Class AbstractClient
17			*
18			* @package Slides\Connector\Auth\Clients
19			*/
20			abstract class AbstractClient
21			{
22			/**
23			* HTTP client
24			*
25			* @var Client
26			*/
27			protected $client;
28
29			/**
30			* Base URL of resource
31			*
32			* @var string
33			*/
34			protected $baseUrl;
35
36			/**
37			* Client's request
38			*
39			* @var Request
40			*/
41			protected $request;
42
43			/**
44			* Client's response
45			*
46			* @var Response
47			*/
48			protected $response;
49
50			/**
51			* HTTP request headers
52			*
53			* @var array
54			*/
55			protected $headers = [];
56
57			/**
58			* The query parameters.
59			*
60			* @var array
61			*/
62			protected $query = [];
63
64			/**
65			* The body of an entity enclosing request.
66			*
67			* @var array
68			*/
69			protected $body;
70
71			/**
72			* The composed credentials.
73			*
74			* @var array
75			*/
76			protected $credentials = [];
77
78			/**
79			* Whether client is aborted to perform requests
80			*
81			* @var bool
82			*/
83			protected $isAborted = false;
84
85			/**
86			* List of supported requests
87			*
88			* @return array
89			*/
90			abstract public function requests(): array;
91
92			/**
93			* Authorize the client
94			*
95			* @return void
96			*/
97			abstract protected function authorize();
98
99			/**
100			* Get client's credentials
101			*
102			* @return array
103			*/
104			abstract protected function credentials(): array;
105
106			/**
107			* BaseClient constructor.
108			*
109			* @param array $config
110			* @param array $credentials
111			*/
112			public function __construct(array $config = [], array $credentials = [])
113			{
114			$this->credentials = array_merge($this->credentials(), $credentials);
115
116			$this->client = new Client(array_merge([
117			'base_uri' => $this->baseUrl,
118			'handler' => $this->createClientHandler(),
119			'http_errors' => false,
120			'headers' => [
121			'User-Agent' => null
122			]
123			], $config));
124
125			$this->boot();
126			}
127
128			/**
129			* Boot the client
130			*/
131			protected function boot()
132			{
133			if (!$this->baseUrl) {
134			throw new InvalidArgumentException('Base URL should be defined');
135			}
136
137			$this->authorize();
138			}
139
140			/**
141			* Send a request
142			*
143			* @param AbstractRequest $request
144			* @param array $options Request options
145			*
146			* @return mixed
147			*
148			* @throws RuntimeException
149			*/
150			public function request(AbstractRequest $request, array $options = [])
151			{
152			if (!$this->resolveRequest($request)) {
153			throw new InvalidArgumentException(static::class . ': ' . get_class($request) . ' should be registered');
154			}
155
156			$request->mergeOptions($options)
157			->mergeOptions(array_filter([
158			'query' => $this->query,
159			'json' => $this->body
160			]))
161			->compose();
162
163			$response = $this->send(
164			$request->getMethod(),
165			$request->getUri(),
166			$request->getOptions()
167			);
168
169			$request->setResponse($response);
170
171			// Validate a response
172			if (!$request->success()) {
173			throw new RuntimeException(json_encode($response, JSON_PRETTY_PRINT));
174			}
175
176			return $response;
177			}
178
179			/**
180			* Send a request
181			*
182			* @param string $method
183			* @param string $url
184			* @param array $options
185			*
186			* @return array\|null\|string
187			*
188			* @throws
189			*/
190			public function send(string $method, string $url, array $options = [])
191			{
192			if ($this->isAborted) {
193			throw new RuntimeException('Cannot send a request while client is aborted');
194			}
195
196			$this->request = new Request($method, $url, $this->headers);
197
198			if (!$this->response = $this->client->send($this->request, $options)) {
199			return null;
200			}
201
202			$contents = (string) $this->response->getBody();
203
204			return json_decode($contents, true) ?: $contents;
205			}
206
207			/**
208			* Set headers
209			*
210			* @param array $headers
211			*/
212			public function headers(array $headers)
213			{
214			$this->headers = $headers;
215			}
216
217			/**
218			* Add query parameters.
219			*
220			* @param array $parameters
221			*
222			* @return void
223			*/
224			public function query(array $parameters)
225			{
226			$this->query = array_merge($this->query, $parameters);
227			}
228
229			/**
230			* Add body parameters.
231			*
232			* @param array $parameters
233			*/
234			public function body(array $parameters)
235			{
236			$this->body = array_merge((array) $this->body, $parameters);
237			}
238
239			/**
240			* Get credentials parameter
241			*
242			* @param string $key
243			* @param mixed $default
244			*
245			* @return mixed
246			*/
247			public function credential(string $key, $default = null)
248			{
249			return Arr::get($this->credentials, $key, $default);
250			}
251
252			/**
253			* Set the client as aborted and send notification
254			*
255			* @return void
256			*/
257			public function abort()
258			{
259			$this->isAborted = true;
260			}
261
262			/**
263			* Get response
264			*
265			* @return Response
266			*/
267			public function getResponse()
268			{
269			return $this->response;
270			}
271
272			/**
273			* Create a handler for Guzzle HTTP Client
274			*
275			* @return HandlerStack
276			*/
277			private function createClientHandler()
278			{
279			$stack = HandlerStack::create();
280
281			$stack->push(Middleware::mapRequest(function (RequestInterface $request) {
282			return $this->request = $request;
			0 ignored issues – show Documentation Bug introduced 2020-03-10 10:40 UTC by Report Bug Copy Issue Report `$request` is of type `Psr\Http\Message\RequestInterface`, but the property `$request` was declared to be of type `GuzzleHttp\Psr7\Request`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
283			}));
284
285			return $stack;
286			}
287
288			/**
289			* Resolve request
290			*
291			* @param AbstractRequest $request
292			*
293			* @return AbstractRequest\|null
294			*/
295			private function resolveRequest(AbstractRequest $request)
296			{
297			foreach ($this->requests() as $class) {
298			if (class_basename($class) !== class_basename($request)) {
299			continue;
300			}
301
302			return $request;
303			}
304
305			return null;
306			}
307			}

24Slides / auth-connector

AbstractClient::credential() A last analyzed 2020-10-26 19:06 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AbstractClient::credential() A
last analyzed 2020-10-26 19:06 UTC