Client::getLastResponse() - Code Metrics - Inspection of "added getter/setter for last response" - loevgaard/pakkelabels-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cd5217...cab1ff )

by Joachim

created 2017-10-31 10:27 UTC

Client::getLastResponse() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
namespace Loevgaard\Pakkelabels;

use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\ClientInterface as GuzzleClientInterface;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class Client
{
    /**
     * @var GuzzleClientInterface
     */
    protected $httpClient;

    /**
     * This is the API username which you find/generate under Settings > API
     *
     * @var string
     */
    private $username;

    /**
     * This is the API password which you find/generate under Settings > API
     *
     * @var string
     */
    private $password;

    /**
     * This is the base url for the API
     *
     * @var string
     */
    private $baseUrl = 'https://app.pakkelabels.dk/api/public/v3';

    /**
     * @var array
     */
    private $defaultOptions;

    /**
     * @var ResponseInterface
     */
    private $lastResponse;

    public function __construct($username, $password)
    {
        $this->username = $username;
        $this->password = $password;
        $this->defaultOptions = [];
    }

    /**
     * @param string $method
     * @param string $uri
     * @param array $options
     * @return array
     */
    public function doRequest($method, $uri, array $options = []) : array
    {
        $optionsResolver = new OptionsResolver();
        $this->configureOptions($optionsResolver);

        $url = $this->baseUrl . $uri;
        $options = $optionsResolver->resolve(array_replace($this->defaultOptions, $options));
        $this->lastResponse = $this->getHttpClient()->request($method, $url, $options);
        try {
            $res = \GuzzleHttp\json_decode((string)$this->lastResponse->getBody(), true);
        } catch (\InvalidArgumentException $e) {
            $res = ['error' => '['.$this->lastResponse->getStatusCode().'] The response body was not correctly formatted JSON. Inspect the last response to figure out the reason for this.'];
        }

        return $res;
    }

    /**
     * @return GuzzleClientInterface
     */
    public function getHttpClient() : GuzzleClientInterface
    {
        if (!$this->httpClient) {
            $this->httpClient = new GuzzleClient();
        }
        return $this->httpClient;
    }

    /**
     * @param GuzzleClientInterface $httpClient
     * @return Client
     */
    public function setHttpClient(GuzzleClientInterface $httpClient) : self
    {
        $this->httpClient = $httpClient;
        return $this;
    }

    /**
     * @return string
     */
    public function getUsername(): string
    {
        return $this->username;
    }

    /**
     * @param string $username
     * @return Client
     */
    public function setUsername(string $username) : self
    {
        $this->username = $username;
        return $this;
    }

    /**
     * @return string
     */
    public function getPassword(): string
    {
        return $this->password;
    }

    /**
     * @param string $password
     * @return Client
     */
    public function setPassword(string $password) : self
    {
        $this->password = $password;
        return $this;
    }

    /**
     * @return string
     */
    public function getBaseUrl() : string
    {
        return $this->baseUrl;
    }

    /**
     * @param string $baseUrl
     * @return Client
     */
    public function setBaseUrl(string $baseUrl) : self
    {
        $this->baseUrl = rtrim($baseUrl, '/');
        return $this;
    }

    /**
     * @return array
     */
    public function getDefaultOptions() : array
    {
        return $this->defaultOptions;
    }

    /**
     * @param array $options
     * @return Client
     */
    public function setDefaultOptions(array $options) : self
    {
        $this->defaultOptions = $options;
        return $this;
    }

    /**
     * @return ResponseInterface
     */
    public function getLastResponse(): ResponseInterface
    {
        return $this->lastResponse;
    }

    /**
     * @param ResponseInterface $lastResponse
     * @return Client
     */
    public function setLastResponse(ResponseInterface $lastResponse) : self
    {
        $this->lastResponse = $lastResponse;
        return $this;
    }

    protected function configureOptions(OptionsResolver $optionsResolver)
    {
        // add request options from Guzzle
        $reflection = new \ReflectionClass(RequestOptions::class);
        $optionsResolver->setDefined($reflection->getConstants());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        // set defaults
        $optionsResolver->setDefaults([
            'allow_redirects' => false,
            'cookies' => false,
            'timeout' => 60,
            'http_errors' => false,
            'auth' => [
                $this->username,
                $this->password
            ]
        ]);
    }
}


1		<?php
2		namespace Loevgaard\Pakkelabels;
3
4		use GuzzleHttp\Client as GuzzleClient;
5		use GuzzleHttp\ClientInterface as GuzzleClientInterface;
6		use GuzzleHttp\RequestOptions;
7		use Psr\Http\Message\ResponseInterface;
8		use Symfony\Component\OptionsResolver\OptionsResolver;
9
10		class Client
11		{
12		/**
13		* @var GuzzleClientInterface
14		*/
15		protected $httpClient;
16
17		/**
18		* This is the API username which you find/generate under Settings > API
19		*
20		* @var string
21		*/
22		private $username;
23
24		/**
25		* This is the API password which you find/generate under Settings > API
26		*
27		* @var string
28		*/
29		private $password;
30
31		/**
32		* This is the base url for the API
33		*
34		* @var string
35		*/
36		private $baseUrl = 'https://app.pakkelabels.dk/api/public/v3';
37
38		/**
39		* @var array
40		*/
41		private $defaultOptions;
42
43		/**
44		* @var ResponseInterface
45		*/
46		private $lastResponse;
47
48	15	public function __construct($username, $password)
49		{
50	15	$this->username = $username;
51	15	$this->password = $password;
52	15	$this->defaultOptions = [];
53	15	}
54
55		/**
56		* @param string $method
57		* @param string $uri
58		* @param array $options
59		* @return array
60		*/
61	3	public function doRequest($method, $uri, array $options = []) : array
62		{
63	3	$optionsResolver = new OptionsResolver();
64	3	$this->configureOptions($optionsResolver);
65
66	3	$url = $this->baseUrl . $uri;
67	3	$options = $optionsResolver->resolve(array_replace($this->defaultOptions, $options));
68	3	$this->lastResponse = $this->getHttpClient()->request($method, $url, $options);
69		try {
70	3	$res = \GuzzleHttp\json_decode((string)$this->lastResponse->getBody(), true);
71	3	} catch (\InvalidArgumentException $e) {
72	3	$res = ['error' => '['.$this->lastResponse->getStatusCode().'] The response body was not correctly formatted JSON. Inspect the last response to figure out the reason for this.'];
73		}
74
75	3	return $res;
76		}
77
78		/**
79		* @return GuzzleClientInterface
80		*/
81	9	public function getHttpClient() : GuzzleClientInterface
82		{
83	9	if (!$this->httpClient) {
84	6	$this->httpClient = new GuzzleClient();
85		}
86	9	return $this->httpClient;
87		}
88
89		/**
90		* @param GuzzleClientInterface $httpClient
91		* @return Client
92		*/
93	3	public function setHttpClient(GuzzleClientInterface $httpClient) : self
94		{
95	3	$this->httpClient = $httpClient;
96	3	return $this;
97		}
98
99		/**
100		* @return string
101		*/
102	6	public function getUsername(): string
103		{
104	6	return $this->username;
105		}
106
107		/**
108		* @param string $username
109		* @return Client
110		*/
111	3	public function setUsername(string $username) : self
112		{
113	3	$this->username = $username;
114	3	return $this;
115		}
116
117		/**
118		* @return string
119		*/
120	6	public function getPassword(): string
121		{
122	6	return $this->password;
123		}
124
125		/**
126		* @param string $password
127		* @return Client
128		*/
129	3	public function setPassword(string $password) : self
130		{
131	3	$this->password = $password;
132	3	return $this;
133		}
134
135		/**
136		* @return string
137		*/
138	3	public function getBaseUrl() : string
139		{
140	3	return $this->baseUrl;
141		}
142
143		/**
144		* @param string $baseUrl
145		* @return Client
146		*/
147	3	public function setBaseUrl(string $baseUrl) : self
148		{
149	3	$this->baseUrl = rtrim($baseUrl, '/');
150	3	return $this;
151		}
152
153		/**
154		* @return array
155		*/
156	6	public function getDefaultOptions() : array
157		{
158	6	return $this->defaultOptions;
159		}
160
161		/**
162		* @param array $options
163		* @return Client
164		*/
165	3	public function setDefaultOptions(array $options) : self
166		{
167	3	$this->defaultOptions = $options;
168	3	return $this;
169		}
170
171		/**
172		* @return ResponseInterface
173		*/
174		public function getLastResponse(): ResponseInterface
175		{
176		return $this->lastResponse;
177		}
178
179		/**
180		* @param ResponseInterface $lastResponse
181		* @return Client
182		*/
183		public function setLastResponse(ResponseInterface $lastResponse) : self
184		{
185		$this->lastResponse = $lastResponse;
186		return $this;
187		}
188
189	3	protected function configureOptions(OptionsResolver $optionsResolver)
190		{
191		// add request options from Guzzle
192	3	$reflection = new \ReflectionClass(RequestOptions::class);
193	3	$optionsResolver->setDefined($reflection->getConstants());
		0 ignored issues – show Documentation introduced 2017-10-16 09:06 UTC by Report Bug Copy Issue Report `$reflection->getConstants()` is of type `array<string,integer\|double\|string\|boolean>`, but the function expects a `string\|array<integer,string>`. 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...
194
195		// set defaults
196	3	$optionsResolver->setDefaults([
197	3	'allow_redirects' => false,
198		'cookies' => false,
199	3	'timeout' => 60,
200		'http_errors' => false,
201		'auth' => [
202	3	$this->username,
203	3	$this->password
204		]
205		]);
206	3	}
207		}
208

loevgaard / pakkelabels-php-sdk

Push — master ( cd5217...cab1ff )

Client::getLastResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like