Client::createAuthStack() - Code Metrics - Inspection of "Version2.0" - polidog/esa-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Ryota

created 2018-01-28 16:12 UTC

Client::createAuthStack() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	1

<?php

namespace Polidog\Esa\Client;

use GuzzleHttp\ClientInterface as HttpClientInterface;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use Polidog\Esa\Exception\ApiErrorException;
use Psr\Http\Message\RequestInterface;

final class Client implements ClientInterface
{
    /**
     * @var string
     */
    private $accessToken;

    /**
     * @var HttpClientInterface
     */
    private $httpClient;

    /**
     * @var array
     */
    private static $httpOptions = [
        'base_uri' => 'https://api.esa.io/v1/',
        'timeout' => 60,
        'allow_redirect' => false,
        'headers' => [
            'User-Agent' => 'esa-php-api v2',
            'Accept' => 'application/json',
        ],
    ];

    /**
     * @param string              $accessToken
     * @param HttpClientInterface $httpClient
     */
    public function __construct($accessToken, HttpClientInterface $httpClient)
    {
        $this->accessToken = $accessToken;
        $this->httpClient = $httpClient;
    }

    /**
     * @param string $method
     * @param string $path
     * @param array  $data
     *
     * @return array
     *
     * @throws ApiErrorException
     */
    public function request($method, $path, array $data = [])
    {
        try {
            $response = $this->httpClient->request($method, $path, $data);

            return json_decode($response->getBody()->getContents(), true);
        } catch (GuzzleException $e) {
            throw ApiErrorException::newException($e, $path, $data);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    public static function factory($accessToken, $httpOptions = [])
    {
        $httpOptions = array_merge(static::$httpOptions, $httpOptions);

        $httpOptions['handler'] = static::createAuthStack($accessToken);


        return new self($accessToken, new \GuzzleHttp\Client($httpOptions));
    }

    private static function createAuthStack($accessToken)
    {
        $stack = HandlerStack::create();
        $stack->push(Middleware::mapRequest(function (RequestInterface $request) use ($accessToken) {
            return $request->withHeader('Authorization', 'Bearer '.$accessToken);
        }));

        return $stack;
    }
}


1			<?php
2
3			namespace Polidog\Esa\Client;
4
5			use GuzzleHttp\ClientInterface as HttpClientInterface;
6			use GuzzleHttp\Exception\GuzzleException;
7			use GuzzleHttp\HandlerStack;
8			use GuzzleHttp\Middleware;
9			use Polidog\Esa\Exception\ApiErrorException;
10			use Psr\Http\Message\RequestInterface;
11
12			final class Client implements ClientInterface
13			{
14			/**
15			* @var string
16			*/
17			private $accessToken;
18
19			/**
20			* @var HttpClientInterface
21			*/
22			private $httpClient;
23
24			/**
25			* @var array
26			*/
27			private static $httpOptions = [
28			'base_uri' => 'https://api.esa.io/v1/',
29			'timeout' => 60,
30			'allow_redirect' => false,
31			'headers' => [
32			'User-Agent' => 'esa-php-api v2',
33			'Accept' => 'application/json',
34			],
35			];
36
37			/**
38			* @param string $accessToken
39			* @param HttpClientInterface $httpClient
40			*/
41			public function __construct($accessToken, HttpClientInterface $httpClient)
42			{
43			$this->accessToken = $accessToken;
44			$this->httpClient = $httpClient;
45			}
46
47			/**
48			* @param string $method
49			* @param string $path
50			* @param array $data
51			*
52			* @return array
53			*
54			* @throws ApiErrorException
55			*/
56			public function request($method, $path, array $data = [])
57			{
58			try {
59			$response = $this->httpClient->request($method, $path, $data);
60
61			return json_decode($response->getBody()->getContents(), true);
62			} catch (GuzzleException $e) {
63			throw ApiErrorException::newException($e, $path, $data);
			0 ignored issues – show Documentation introduced 2018-01-28 16:16 UTC by Report Bug Copy Issue Report `$e` is of type `object<GuzzleHttp\Exception\GuzzleException>`, but the function expects a `object<Exception>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
64			}
65			}
66
67			public static function factory($accessToken, $httpOptions = [])
68			{
69			$httpOptions = array_merge(static::$httpOptions, $httpOptions);
			0 ignored issues – show Comprehensibility introduced 2018-01-28 16:16 UTC by Report Bug Copy Issue Report Since `Polidog\Esa\Client\Client` is declared final, using late-static binding will have no effect. You might want to replace `static` with `self` instead. Late static binding only has effect in subclasses. A `final` class cannot be extended anymore so late static binding cannot occurr. Consider replacing `static::` with `self::`. To learn more about late static binding, please refer to the PHP core documentation. Loading history...
70			$httpOptions['handler'] = static::createAuthStack($accessToken);
			0 ignored issues – show Comprehensibility introduced 2018-01-28 16:16 UTC by Report Bug Copy Issue Report Since `Polidog\Esa\Client\Client` is declared final, using late-static binding will have no effect. You might want to replace `static` with `self` instead. Late static binding only has effect in subclasses. A `final` class cannot be extended anymore so late static binding cannot occurr. Consider replacing `static::` with `self::`. To learn more about late static binding, please refer to the PHP core documentation. Loading history...
71
72			return new self($accessToken, new \GuzzleHttp\Client($httpOptions));
73			}
74
75			private static function createAuthStack($accessToken)
76			{
77			$stack = HandlerStack::create();
78			$stack->push(Middleware::mapRequest(function (RequestInterface $request) use ($accessToken) {
79			return $request->withHeader('Authorization', 'Bearer '.$accessToken);
80			}));
81
82			return $stack;
83			}
84			}
85

polidog / esa-php

Pull Request — master (#6)

Client::createAuthStack() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like