Client::getEndpointUrl() - Code Metrics - Inspection of "added user agent to the request" - coinpaprika/coinpaprika-api-php-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 497cfe...ca65ce )

by Krzysztof

created 2018-09-26 14:10 UTC

Client::getEndpointUrl() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Coinpaprika;

use Coinpaprika\Exception\RateLimitExceededException;
use Coinpaprika\Exception\ResponseErrorException;
use Coinpaprika\Model\Coin;
use Coinpaprika\Model\GlobalStats;
use Coinpaprika\Model\Ticker;
use JMS\Serializer\SerializerBuilder;
use JMS\Serializer\Serializer;
use GuzzleHttp\Exception\GuzzleException;
use Psr\Http\Message\ResponseInterface;

/**
 * Class Client
 *
 * @package Coinpaprika
 *
 * @author Krzysztof Przybyszewski <[email protected]>
 */
class Client
{
    const BASE_URL = 'https://api.coinpaprika.com/%ver%/';

    /**
     * @var string
     */
    private $apiVersion;

    /**
     * @var \GuzzleHttp\Client
     */
    private $httpClient;

    /**
     * @var Serializer
     */
    private $serializer;

    /**
     * Client constructor.
     *
     * @param string|null        $cacheDir
     * @param \GuzzleHttp\Client $httpClient
     */
    public function __construct(
        string $cacheDir = null,
        \GuzzleHttp\Client $httpClient = null
    ) {
        $serializerBuilder = SerializerBuilder::create()
            ->addMetadataDir(__DIR__.'/Resource/config/serializer');

        if ($cacheDir !== null) {
            $serializerBuilder->setCacheDir($cacheDir);
        }

        $this->apiVersion = 'v1';
        $this->serializer = $serializerBuilder->build();

        if ($httpClient === null) {
            $httpClient = new \GuzzleHttp\Client();
        }

        $this->httpClient = $httpClient;
    }

    /**
     * Get global stats
     *
     * @throws GuzzleException
     * @throws ResponseErrorException
     * @throws RateLimitExceededException
     *
     * @return GlobalStats
     */
    public function getGlobalStats(): GlobalStats
    {
        $response = $this->sendRequest('GET', $this->getEndpointUrl('global'));

        return $this->deserializeResponse($response, GlobalStats::class);
    }

    /**
     * Get tickers
     *
     * @throws GuzzleException
     * @throws ResponseErrorException
     * @throws RateLimitExceededException
     *
     * @return array|Ticker[]
     */
    public function getTickers(): array
    {
        $response = $this->sendRequest('GET', $this->getEndpointUrl('ticker'));

        return $this->deserializeResponse($response, sprintf('array<%s>', Ticker::class));
    }

    /**
     * Get coin`s ticker data
     *
     * @param string $id
     *
     * @throws GuzzleException
     * @throws ResponseErrorException
     * @throws RateLimitExceededException
     *
     * @return Ticker
     */
    public function getTickerByCoinId(string $id): Ticker
    {
        $response = $this->sendRequest(
            'GET',
            $this->getEndpointUrl(sprintf('ticker/%s', $id))
        );

        return $this->deserializeResponse($response, Ticker::class);
    }

    /**
     * Get coins list
     *
     * @throws GuzzleException
     * @throws ResponseErrorException
     * @throws RateLimitExceededException
     *
     * @return array|Coin[]
     */
    public function getCoins(): array
    {
        $response = $this->sendRequest('GET', $this->getEndpointUrl('coins'));

        return $this->deserializeResponse($response, sprintf('array<%s>', Coin::class));

    }

    /**
     * Get the endpoint URL.
     *
     * @param string $endpoint
     *
     * @return string
     */
    protected function getEndpointUrl(string $endpoint): string
    {
        return str_replace('%ver%', $this->getApiVersion(), static::BASE_URL).$endpoint;
    }

    /**
     * Get the API version
     *
     * @return string
     */
    public function getApiVersion(): string
    {
        return $this->apiVersion;
    }

    /**
     * Get the latest tag from git repository.
     *
     * @return string
     */
    public function getClientVersion(): string
    {
        $version = trim(`git describe --tags --abbrev=0`);

        return $version;
    }

    /**
     * @param string $method
     * @param string $url
     * @param array  $headers
     *
     * @return ResponseInterface
     * @throws GuzzleException
     */
    protected function sendRequest(string $method, string $url, array $headers = []): ResponseInterface
    {
        $defaultHeaders = [
            'User-Agent' => sprintf('Coinpaprika API Client - PHP (%s)', $this->getClientVersion())
        ];

        return $this->httpClient->request($method, $url, [
            'headers' => array_merge($defaultHeaders, $headers)
        ]);
    }

    /**
     * Unmarshal JSON
     *
     * @param ResponseInterface $response
     * @param string            $type
     *
     * @throws ResponseErrorException
     * @throws RateLimitExceededException
     *
     * @return mixed
     */
    protected function deserializeResponse(ResponseInterface $response, string $type)
    {
        $body = $response->getBody();

        // rate limit exceeded
        if ($response->getStatusCode() === 429) {
            throw new RateLimitExceededException('Response code from API 429. Rate limit exceeded.');
        }

        if (array_key_exists('error', $e = json_decode($body, true))) {
            throw new ResponseErrorException($e['error']);
        }

        return $this->serializer->deserialize($body, $type, 'json');
    }
}


1		<?php
2
3		namespace Coinpaprika;
4
5		use Coinpaprika\Exception\RateLimitExceededException;
6		use Coinpaprika\Exception\ResponseErrorException;
7		use Coinpaprika\Model\Coin;
8		use Coinpaprika\Model\GlobalStats;
9		use Coinpaprika\Model\Ticker;
10		use JMS\Serializer\SerializerBuilder;
11		use JMS\Serializer\Serializer;
12		use GuzzleHttp\Exception\GuzzleException;
13		use Psr\Http\Message\ResponseInterface;
14
15		/**
16		* Class Client
17		*
18		* @package Coinpaprika
19		*
20		* @author Krzysztof Przybyszewski <[email protected]>
21		*/
22		class Client
23		{
24		const BASE_URL = 'https://api.coinpaprika.com/%ver%/';
25
26		/**
27		* @var string
28		*/
29		private $apiVersion;
30
31		/**
32		* @var \GuzzleHttp\Client
33		*/
34		private $httpClient;
35
36		/**
37		* @var Serializer
38		*/
39		private $serializer;
40
41		/**
42		* Client constructor.
43		*
44		* @param string\|null $cacheDir
45		* @param \GuzzleHttp\Client $httpClient
46		*/
47	7	public function __construct(
48		string $cacheDir = null,
49		\GuzzleHttp\Client $httpClient = null
50		) {
51	7	$serializerBuilder = SerializerBuilder::create()
52	7	->addMetadataDir(__DIR__.'/Resource/config/serializer');
53
54	7	if ($cacheDir !== null) {
55	1	$serializerBuilder->setCacheDir($cacheDir);
56		}
57
58	7	$this->apiVersion = 'v1';
59	7	$this->serializer = $serializerBuilder->build();
60
61	7	if ($httpClient === null) {
62	1	$httpClient = new \GuzzleHttp\Client();
63		}
64
65	7	$this->httpClient = $httpClient;
66	7	}
67
68		/**
69		* Get global stats
70		*
71		* @throws GuzzleException
72		* @throws ResponseErrorException
73		* @throws RateLimitExceededException
74		*
75		* @return GlobalStats
76		*/
77	1	public function getGlobalStats(): GlobalStats
78		{
79	1	$response = $this->sendRequest('GET', $this->getEndpointUrl('global'));
80
81	1	return $this->deserializeResponse($response, GlobalStats::class);
82		}
83
84		/**
85		* Get tickers
86		*
87		* @throws GuzzleException
88		* @throws ResponseErrorException
89		* @throws RateLimitExceededException
90		*
91		* @return array\|Ticker[]
92		*/
93	1	public function getTickers(): array
94		{
95	1	$response = $this->sendRequest('GET', $this->getEndpointUrl('ticker'));
96
97	1	return $this->deserializeResponse($response, sprintf('array<%s>', Ticker::class));
98		}
99
100		/**
101		* Get coin`s ticker data
102		*
103		* @param string $id
104		*
105		* @throws GuzzleException
106		* @throws ResponseErrorException
107		* @throws RateLimitExceededException
108		*
109		* @return Ticker
110		*/
111	3	public function getTickerByCoinId(string $id): Ticker
112		{
113	3	$response = $this->sendRequest(
114	3	'GET',
115	3	$this->getEndpointUrl(sprintf('ticker/%s', $id))
116		);
117
118	3	return $this->deserializeResponse($response, Ticker::class);
119		}
120
121		/**
122		* Get coins list
123		*
124		* @throws GuzzleException
125		* @throws ResponseErrorException
126		* @throws RateLimitExceededException
127		*
128		* @return array\|Coin[]
129		*/
130	1	public function getCoins(): array
131		{
132	1	$response = $this->sendRequest('GET', $this->getEndpointUrl('coins'));
133
134	1	return $this->deserializeResponse($response, sprintf('array<%s>', Coin::class));
135
136		}
137
138		/**
139		* Get the endpoint URL.
140		*
141		* @param string $endpoint
142		*
143		* @return string
144		*/
145	6	protected function getEndpointUrl(string $endpoint): string
146		{
147	6	return str_replace('%ver%', $this->getApiVersion(), static::BASE_URL).$endpoint;
148		}
149
150		/**
151		* Get the API version
152		*
153		* @return string
154		*/
155	7	public function getApiVersion(): string
156		{
157	7	return $this->apiVersion;
158		}
159
160		/**
161		* Get the latest tag from git repository.
162		*
163		* @return string
164		*/
165	6	public function getClientVersion(): string
166		{
167	6	$version = trim(`git describe --tags --abbrev=0`);
168
169	6	return $version;
170		}
171
172		/**
173		* @param string $method
174		* @param string $url
175		* @param array $headers
176		*
177		* @return ResponseInterface
178		* @throws GuzzleException
179		*/
180	6	protected function sendRequest(string $method, string $url, array $headers = []): ResponseInterface
181		{
182		$defaultHeaders = [
183	6	'User-Agent' => sprintf('Coinpaprika API Client - PHP (%s)', $this->getClientVersion())
184		];
185
186	6	return $this->httpClient->request($method, $url, [
187	6	'headers' => array_merge($defaultHeaders, $headers)
188		]);
189		}
190
191		/**
192		* Unmarshal JSON
193		*
194		* @param ResponseInterface $response
195		* @param string $type
196		*
197		* @throws ResponseErrorException
198		* @throws RateLimitExceededException
199		*
200		* @return mixed
201		*/
202	6	protected function deserializeResponse(ResponseInterface $response, string $type)
203		{
204	6	$body = $response->getBody();
205
206		// rate limit exceeded
207	6	if ($response->getStatusCode() === 429) {
208	1	throw new RateLimitExceededException('Response code from API 429. Rate limit exceeded.');
209		}
210
211	5	if (array_key_exists('error', $e = json_decode($body, true))) {
212	1	throw new ResponseErrorException($e['error']);
213		}
214
215	4	return $this->serializer->deserialize($body, $type, 'json');
216		}
217		}
218

coinpaprika / coinpaprika-api-php-client

GitHub Access Token became invalid

Push — master ( 497cfe...ca65ce )

Client::getEndpointUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like