RandomOrgAPI::withEndPoint() - Code Metrics - Inspection of "Update php codesniffer version." - drupol/yaroc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a12696...8cd4aa )

by Pol

created 2018-05-17 21:34 UTC

RandomOrgAPI::withEndPoint() A

↳ Parent: RandomOrgAPI

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

namespace drupol\Yaroc;

use drupol\Yaroc\Plugin\ProviderInterface;
use Http\Client\Common\Plugin\HeaderDefaultsPlugin;
use Http\Client\Common\Plugin\RetryPlugin;
use Http\Client\Common\PluginClient;
use Http\Client\HttpClient;
use Http\Discovery\HttpClientDiscovery;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\Dotenv\Dotenv;

/**
 * Class RandomOrgAPI.
 */
class RandomOrgAPI implements RandomOrgAPIInterface
{
    /**
     * The default Random.org endpoint.
     *
     * @var string;
     */
    private $endpoint = 'https://api.random.org/json-rpc/1/invoke';

    /**
     * The configuration.
     *
     * @var array
     */
    private $configuration;

    /**
     * The HTTP client.
     *
     * @var \Http\Client\HttpClient
     */
    private $httpClient;

    /**
     * RandomOrgAPI constructor.
     *
     * @param \Http\Client\HttpClient $httpClient

     *   The HTTP client.
     * @param array $configuration
     *   The configuration array.
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    public function __construct(HttpClient $httpClient = null, array $configuration = [])
    {
        if (null === $httpClient) {
            $defaultPlugins = [
                new HeaderDefaultsPlugin([
                    'Content-Type' => 'application/json',
                    'User-Agent' => 'YAROC (http://github.com/drupol/yaroc)',
                ]),
                new RetryPlugin([
                    'retries' => 5,
                ]),
            ];

            $httpClient = new PluginClient(HttpClientDiscovery::find(), $defaultPlugins);
        }

        $this->httpClient = $httpClient;

        $dotenv = new Dotenv();

        $files = array_filter(
            [
                __DIR__ . '/../.env.dist',
                __DIR__ . '/../.env'
            ],
            'file_exists'
        );
        $dotenv->load(...$files);

        if ($apikey = getenv('RANDOM_ORG_APIKEY')) {
            $configuration += ['apiKey' => $apikey];
        }

        $this->configuration = $configuration;
    }

    /**
     * {@inheritdoc}
     */
    public function withApiKey(string $apikey) :RandomOrgAPIInterface
    {
        $clone = clone $this;

        $configuration = $clone->getConfiguration();
        $configuration['apiKey'] = $apikey;
        $clone->configuration = $configuration;

        return $clone;
    }

    /**
     * {@inheritdoc}
     */
    public function withEndPoint(string $endpoint) :RandomOrgAPIInterface
    {
        $clone = clone $this;
        $clone->endpoint = $endpoint;

        return $clone;
    }

    /**
     * {@inheritdoc}
     */
    public function withHttpClient(HttpClient $client) :RandomOrgAPIInterface
    {
        $clone = clone $this;
        $clone->httpClient = $client;

        return $clone;
    }

    /**
     * {@inheritdoc}
     */
    public function getEndPoint() :string
    {
        return $this->endpoint;
    }

    /**
     * {@inheritdoc}
     */
    public function getApiKey() :string
    {
        $configuration = $this->getConfiguration();

        return isset($configuration['apiKey']) ? $configuration['apiKey'] : '';
    }

    /**
     * {@inheritdoc}
     */
    public function call(ProviderInterface $methodPlugin) :ResponseInterface
    {
        $parameters = $methodPlugin->getParameters() +
            ['apiKey' => $this->getApiKey()];

        return $this->validateResponse(
            $methodPlugin
                ->withEndPoint($this->getEndPoint())
                ->withHttpClient($this->getHttpClient())
                ->withParameters($parameters)
                ->request()
        );
    }

    /**
     * {@inheritdoc}
     */
    public function get(ProviderInterface $methodPlugin) :array
    {
        return json_decode(
            (string) $this
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                ->call($methodPlugin)
                ->getBody()
                ->getContents(),
            true
        );
    }

    /**
     * {@inheritdoc}
     */
    public function getData(ProviderInterface $methodPlugin)
    {
        $data = $this->get($methodPlugin);

        if (!isset($data['result'])) {
            return false;
        }

        if (isset($data['result']['random']['data'])) {
            return $data['result']['random']['data'];
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfiguration() :array
    {
        return $this->configuration;
    }

    /**
     * {@inheritdoc}
     */
    public function getHttpClient() :HttpClient
    {
        return $this->httpClient;
    }

    /**
     * Validate the response.
     *
     * @param \Psr\Http\Message\ResponseInterface $response
     *
     * @return \Exception|ResponseInterface
     */
    private function validateResponse(ResponseInterface $response) :ResponseInterface
    {
        if (200 === $response->getStatusCode()) {
            $body = json_decode((string) $response->getBody()->getContents(), true);

            if (isset($body['error']['code'])) {
                switch ($body['error']['code']) {
                    case -32600:

                        throw new \InvalidArgumentException(
                            'Invalid Request: ' . $body['error']['message'],
                            $body['error']['code']
                        );
                    case -32601:
                        throw new \BadFunctionCallException(
                            'Procedure not found: ' . $body['error']['message'],
                            $body['error']['code']
                        );
                    case -32602:

                        throw new \InvalidArgumentException(
                            'Invalid arguments: ' . $body['error']['message'],
                            $body['error']['code']
                        );
                    case -32603:

                        throw new \RuntimeException(
                            'Internal Error: ' . $body['error']['message'],
                            $body['error']['code']
                        );
                    default:

                        throw new \RuntimeException(
                            'Invalid request/response: ' . $body['error']['message'],
                            $body['error']['code']
                        );
                }
            }
        }

        $response->getBody()->rewind();

        return $response;
    }
}


1			<?php
2
3			namespace drupol\Yaroc;
4
5			use drupol\Yaroc\Plugin\ProviderInterface;
6			use Http\Client\Common\Plugin\HeaderDefaultsPlugin;
7			use Http\Client\Common\Plugin\RetryPlugin;
8			use Http\Client\Common\PluginClient;
9			use Http\Client\HttpClient;
10			use Http\Discovery\HttpClientDiscovery;
11			use Psr\Http\Message\ResponseInterface;
12			use Symfony\Component\Dotenv\Dotenv;
13
14			/**
15			* Class RandomOrgAPI.
16			*/
17			class RandomOrgAPI implements RandomOrgAPIInterface
18			{
19			/**
20			* The default Random.org endpoint.
21			*
22			* @var string;
23			*/
24			private $endpoint = 'https://api.random.org/json-rpc/1/invoke';
25
26			/**
27			* The configuration.
28			*
29			* @var array
30			*/
31			private $configuration;
32
33			/**
34			* The HTTP client.
35			*
36			* @var \Http\Client\HttpClient
37			*/
38			private $httpClient;
39
40			/**
41			* RandomOrgAPI constructor.
42			*
43			* @param \Http\Client\HttpClient $httpClient
			0 ignored issues – show Documentation introduced 2018-05-16 21:24 UTC by Report Bug Copy Issue Report Should the type for parameter `$httpClient` not be `null\|HttpClient`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
44			* The HTTP client.
45			* @param array $configuration
46			* The configuration array.
47			*
48			* @SuppressWarnings(PHPMD.StaticAccess)
49			*/
50	10		public function __construct(HttpClient $httpClient = null, array $configuration = [])
51			{
52	10		if (null === $httpClient) {
53			$defaultPlugins = [
54	10		new HeaderDefaultsPlugin([
55	10		'Content-Type' => 'application/json',
56			'User-Agent' => 'YAROC (http://github.com/drupol/yaroc)',
57			]),
58	10		new RetryPlugin([
59	10		'retries' => 5,
60			]),
61			];
62
63	10		$httpClient = new PluginClient(HttpClientDiscovery::find(), $defaultPlugins);
64			}
65
66	10		$this->httpClient = $httpClient;
67
68	10		$dotenv = new Dotenv();
69
70	10		$files = array_filter(
71			[
72	10		__DIR__ . '/../.env.dist',
73			__DIR__ . '/../.env'
74			],
75	10		'file_exists'
76			);
77	10		$dotenv->load(...$files);
78
79	10		if ($apikey = getenv('RANDOM_ORG_APIKEY')) {
80	10		$configuration += ['apiKey' => $apikey];
81			}
82
83	10		$this->configuration = $configuration;
84	10		}
85
86			/**
87			* {@inheritdoc}
88			*/
89	3		public function withApiKey(string $apikey) :RandomOrgAPIInterface
90			{
91	3		$clone = clone $this;
92
93	3		$configuration = $clone->getConfiguration();
94	3		$configuration['apiKey'] = $apikey;
95	3		$clone->configuration = $configuration;
96
97	3		return $clone;
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103	2		public function withEndPoint(string $endpoint) :RandomOrgAPIInterface
104			{
105	2		$clone = clone $this;
106	2		$clone->endpoint = $endpoint;
107
108	2		return $clone;
109			}
110
111			/**
112			* {@inheritdoc}
113			*/
114	1		public function withHttpClient(HttpClient $client) :RandomOrgAPIInterface
115			{
116	1		$clone = clone $this;
117	1		$clone->httpClient = $client;
118
119	1		return $clone;
120			}
121
122			/**
123			* {@inheritdoc}
124			*/
125	6		public function getEndPoint() :string
126			{
127	6		return $this->endpoint;
128			}
129
130			/**
131			* {@inheritdoc}
132			*/
133	6		public function getApiKey() :string
134			{
135	6		$configuration = $this->getConfiguration();
136
137	6		return isset($configuration['apiKey']) ? $configuration['apiKey'] : '';
138			}
139
140			/**
141			* {@inheritdoc}
142			*/
143	5		public function call(ProviderInterface $methodPlugin) :ResponseInterface
144			{
145	5		$parameters = $methodPlugin->getParameters() +
146	5		['apiKey' => $this->getApiKey()];
147
148	5		return $this->validateResponse(
149			$methodPlugin
150	5		->withEndPoint($this->getEndPoint())
151	5		->withHttpClient($this->getHttpClient())
152	5		->withParameters($parameters)
153	5		->request()
154			);
155			}
156
157			/**
158			* {@inheritdoc}
159			*/
160	3		public function get(ProviderInterface $methodPlugin) :array
161			{
162	3		return json_decode(
163			(string) $this
			0 ignored issues – show Bug introduced 2018-05-16 16:37 UTC by Report Bug Copy Issue Report The method `getBody` does only exist in `Psr\Http\Message\ResponseInterface`, but not in `Exception`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
164	3		->call($methodPlugin)
165	3		->getBody()
166	3		->getContents(),
167	3		true
168			);
169			}
170
171			/**
172			* {@inheritdoc}
173			*/
174	2		public function getData(ProviderInterface $methodPlugin)
175			{
176	2		$data = $this->get($methodPlugin);
177
178	2		if (!isset($data['result'])) {
179			return false;
180			}
181
182	2		if (isset($data['result']['random']['data'])) {
183	2		return $data['result']['random']['data'];
184			}
185
186			return false;
187			}
188
189			/**
190			* {@inheritdoc}
191			*/
192	7		public function getConfiguration() :array
193			{
194	7		return $this->configuration;
195			}
196
197			/**
198			* {@inheritdoc}
199			*/
200	6		public function getHttpClient() :HttpClient
201			{
202	6		return $this->httpClient;
203			}
204
205			/**
206			* Validate the response.
207			*
208			* @param \Psr\Http\Message\ResponseInterface $response
209			*
210			* @return \Exception\|ResponseInterface
211			*/
212	5		private function validateResponse(ResponseInterface $response) :ResponseInterface
213			{
214	5		if (200 === $response->getStatusCode()) {
215	5		$body = json_decode((string) $response->getBody()->getContents(), true);
216
217	5		if (isset($body['error']['code'])) {
218	1		switch ($body['error']['code']) {
219	1	View Code Duplication	case -32600:
			0 ignored issues – show Duplication introduced 2018-05-16 16:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
220			throw new \InvalidArgumentException(
221			'Invalid Request: ' . $body['error']['message'],
222			$body['error']['code']
223			);
224	1		case -32601:
225	1		throw new \BadFunctionCallException(
226	1		'Procedure not found: ' . $body['error']['message'],
227	1		$body['error']['code']
228			);
229	1	View Code Duplication	case -32602:
			0 ignored issues – show Duplication introduced 2018-05-16 16:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
230	1		throw new \InvalidArgumentException(
231	1		'Invalid arguments: ' . $body['error']['message'],
232	1		$body['error']['code']
233			);
234	1	View Code Duplication	case -32603:
			0 ignored issues – show Duplication introduced 2018-05-16 16:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
235			throw new \RuntimeException(
236			'Internal Error: ' . $body['error']['message'],
237			$body['error']['code']
238			);
239		View Code Duplication	default:
			0 ignored issues – show Duplication introduced 2018-05-16 16:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
240	1		throw new \RuntimeException(
241	1		'Invalid request/response: ' . $body['error']['message'],
242	1		$body['error']['code']
243			);
244			}
245			}
246			}
247
248	4		$response->getBody()->rewind();
249
250	4		return $response;
251			}
252			}
253

drupol / yaroc

Push — master ( a12696...8cd4aa )

RandomOrgAPI::withEndPoint() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like