ContentClient::setLimits() - Code Metrics - nixsolutions/yandex-php-library - Measure and Improve Code Quality continuously with Scrutinizer

ContentClient::setLimits() A
last analyzed 2021-05-31 12:34 UTC

↳ Parent: ContentClient

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	0
cts	7
cp	0
rs	9.584
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	12

<?php
/**
 * Yandex PHP Library
 *
 * @copyright NIX Solutions Ltd.
 * @link      https://github.com/nixsolutions/yandex-php-library
 */

/**
 * @namespace
 */
namespace Yandex\Market\Content;

use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use Yandex\Common\AbstractServiceClient;
use GuzzleHttp\Psr7\Response;
use GuzzleHttp\Exception\ClientException;
use Yandex\Common\Exception\ForbiddenException;
use Yandex\Common\Exception\UnauthorizedException;
use Yandex\Market\Content\Exception\ContentRequestException;

/**
 * Class ContentClient
 *
 * @category Yandex
 * @package  MarketContent
 *
 * @author  Oleg Scherbakov <[email protected]>
 * @created 27.12.15 19:50
 */
class ContentClient extends AbstractServiceClient
{
    /**
     * Requested version of API
     *
     * @var string
     */
    private $version = 'v1';

    /**
     * API domain
     *
     * @var string
     */
    protected $serviceDomain = 'api.content.market.yandex.ru';

    /**
     * Store limits information during each API request
     *
     * @var array
     */
    private $limits = array();

    /**
     * Get url to service resource with parameters
     *
     * @param  string $resource
     * @see    http://api.yandex.ru/market/partner/doc/dg/concepts/method-call.xml
     * @return string
     */
    public function getServiceUrl($resource = '')
    {
        return $this->serviceScheme . '://' . $this->serviceDomain . '/'
        . $this->version . '/' . $resource;
    }

    /**
     * @param string $token access token
     */
    public function __construct($token = '')
    {
        $this->setAccessToken($token);
    }

    /**
     * @return ClientInterface
     */
    protected function getClient()

    {
        if (is_null($this->client)) {
            $defaultOptions = [
                'base_uri' => $this->getServiceUrl(),
                'headers' => [
                    'Host' => $this->getServiceDomain(),
                    'Accept' => '*/*',
                    'Authorization' => $this->getAccessToken(),
                ]
            ];
            if ($this->getProxy()) {
                $defaultOptions['proxy'] = $this->getProxy();
            }
            if ($this->getDebug()) {
                $defaultOptions['debug'] = $this->getDebug();
            }
            $this->client = new Client($defaultOptions);

        }

        return $this->client;
    }

    /**
     * Sends a request
     *
     * @param string              $method  HTTP method
     * @param string $uri     URI object or string.
     * @param array               $options Request options to apply.
     *
     * @return Response
     *
     * @throws ForbiddenException
     * @throws UnauthorizedException
     * @throws ContentRequestException
     */
    protected function sendRequest($method, $uri, array $options = [])

    {
        try {
            $response = $this->getClient()->request($method, $uri, $options);
        } catch (ClientException $ex) {
            $result = $ex->getResponse();
            $code = $result->getStatusCode();
            $message = $result->getReasonPhrase();

            $body = $result->getBody();
            if ($body) {
                $jsonBody = json_decode($body);
                if ($jsonBody && isset($jsonBody->error) && isset($jsonBody->error->message)) {
                    $message = $jsonBody->error->message;
                }
            }

            if ($code === 403) {
                throw new ForbiddenException($message);
            }

            if ($code === 401) {
                throw new UnauthorizedException($message);
            }

            throw new ContentRequestException(
                'Service responded with error code: "' . $code . '" and message: "' . $message . '"',
                $code
            );
        }
        // @note: Finally? php >= 5.5
        $this->setLimits($response->getHeaders());

        return $response;
    }

    private function setLimits($headers)
    {
        // const as header name?
        $limitHeaders = [
            'X-RateLimit-Daily-Limit',
            'X-RateLimit-Daily-Remaining',
            'X-RateLimit-Global-Limit',
            'X-RateLimit-Global-Remaining',
            'X-RateLimit-Method-Limit',
            'X-RateLimit-Method-Remaining',
            'X-RateLimit-Until'
        ];

        $this->limits = array();

        foreach ($headers as $key => $value) {
            if (in_array($key, $limitHeaders, true)) {
                $this->limits[$key] = (int) $value[0];
            }
        }
    }

    /**
     * Get information about API limits
     *
     * @return array|false
     */
    public function getLimits()
    {
        return $this->limits;
    }

    /**
     * Get information about specified API limit
     *
     * @return array|false
     */
    public function getLimit($name)
    {
        if (isset($this->limits[$name])) {
            return $this->limits[$name];
        }

        return false;
    }

    /**
     * Returns API service response.
     *
     * @param  string $resource
     * @return array
     * @throws ContentRequestException
     * @throws ForbiddenException
     * @throws UnauthorizedException
     */
    protected function getServiceResponse($resource)
    {
        $response = $this->sendRequest('GET', $this->getServiceUrl($resource));
        $decodedResponseBody = $this->getDecodedBody($response->getBody());

        return $decodedResponseBody;
    }

    /**
     * Returns URL-encoded query string
     *
     * @note: similar to http_build_query(),
     * but transform key=>value where key == value to "?key" param.
     *
     * @param array|object $queryData
     * @param string       $prefix
     * @param string       $argSeparator
     * @param int          $encType
     *
     * @return string $queryString
     */
    protected function buildQueryString($queryData, $prefix = '', $argSeparator = '&', $encType = PHP_QUERY_RFC3986)
    {
        foreach ($queryData as $k => &$v) {
            if (!is_scalar($v)) {
                $v = implode(',', $v);
            }
        }

        $queryString = http_build_query($queryData, $prefix, $argSeparator, $encType);

        foreach ($queryData as $k => $v) {
            if ($k==$v) {
                $queryString = str_replace("$k=$v", $v, $queryString);
            }
        }

        return $queryString;
    }
}


1			<?php
2			/**
3			* Yandex PHP Library
4			*
5			* @copyright NIX Solutions Ltd.
6			* @link https://github.com/nixsolutions/yandex-php-library
7			*/
8
9			/**
10			* @namespace
11			*/
12			namespace Yandex\Market\Content;
13
14			use GuzzleHttp\Client;
15			use GuzzleHttp\ClientInterface;
16			use Yandex\Common\AbstractServiceClient;
17			use GuzzleHttp\Psr7\Response;
18			use GuzzleHttp\Exception\ClientException;
19			use Yandex\Common\Exception\ForbiddenException;
20			use Yandex\Common\Exception\UnauthorizedException;
21			use Yandex\Market\Content\Exception\ContentRequestException;
22
23			/**
24			* Class ContentClient
25			*
26			* @category Yandex
27			* @package MarketContent
28			*
29			* @author Oleg Scherbakov <[email protected]>
30			* @created 27.12.15 19:50
31			*/
32			class ContentClient extends AbstractServiceClient
33			{
34			/**
35			* Requested version of API
36			*
37			* @var string
38			*/
39			private $version = 'v1';
40
41			/**
42			* API domain
43			*
44			* @var string
45			*/
46			protected $serviceDomain = 'api.content.market.yandex.ru';
47
48			/**
49			* Store limits information during each API request
50			*
51			* @var array
52			*/
53			private $limits = array();
54
55			/**
56			* Get url to service resource with parameters
57			*
58			* @param string $resource
59			* @see http://api.yandex.ru/market/partner/doc/dg/concepts/method-call.xml
60			* @return string
61			*/
62	29		public function getServiceUrl($resource = '')
63			{
64	29		return $this->serviceScheme . '://' . $this->serviceDomain . '/'
65	29		. $this->version . '/' . $resource;
66			}
67
68			/**
69			* @param string $token access token
70			*/
71	29		public function __construct($token = '')
72			{
73	29		$this->setAccessToken($token);
74	29		}
75
76			/**
77			* @return ClientInterface
78			*/
79		View Code Duplication	protected function getClient()
			0 ignored issues – show Duplication introduced 2017-10-22 15:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
80			{
81			if (is_null($this->client)) {
82			$defaultOptions = [
83			'base_uri' => $this->getServiceUrl(),
84			'headers' => [
85			'Host' => $this->getServiceDomain(),
86			'Accept' => '/',
87			'Authorization' => $this->getAccessToken(),
88			]
89			];
90			if ($this->getProxy()) {
91			$defaultOptions['proxy'] = $this->getProxy();
92			}
93			if ($this->getDebug()) {
94			$defaultOptions['debug'] = $this->getDebug();
95			}
96			$this->client = new Client($defaultOptions);
			0 ignored issues – show Documentation Bug introduced 2016-01-09 22:55 UTC by Report Bug Copy Issue Report It seems like `new \GuzzleHttp\Client($defaultOptions)` of type `object<GuzzleHttp\Client>` is incompatible with the declared type `null` of property `$client`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
97			}
98
99			return $this->client;
100			}
101
102			/**
103			* Sends a request
104			*
105			* @param string $method HTTP method
106			* @param string $uri URI object or string.
107			* @param array $options Request options to apply.
108			*
109			* @return Response
110			*
111			* @throws ForbiddenException
112			* @throws UnauthorizedException
113			* @throws ContentRequestException
114			*/
115		View Code Duplication	protected function sendRequest($method, $uri, array $options = [])
			0 ignored issues – show Duplication introduced 2017-10-22 15:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
116			{
117			try {
118			$response = $this->getClient()->request($method, $uri, $options);
119			} catch (ClientException $ex) {
120			$result = $ex->getResponse();
121			$code = $result->getStatusCode();
122			$message = $result->getReasonPhrase();
123
124			$body = $result->getBody();
125			if ($body) {
126			$jsonBody = json_decode($body);
127			if ($jsonBody && isset($jsonBody->error) && isset($jsonBody->error->message)) {
128			$message = $jsonBody->error->message;
129			}
130			}
131
132			if ($code === 403) {
133			throw new ForbiddenException($message);
134			}
135
136			if ($code === 401) {
137			throw new UnauthorizedException($message);
138			}
139
140			throw new ContentRequestException(
141			'Service responded with error code: "' . $code . '" and message: "' . $message . '"',
142			$code
143			);
144			}
145			// @note: Finally? php >= 5.5
146			$this->setLimits($response->getHeaders());
147
148			return $response;
149			}
150
151			private function setLimits($headers)
152			{
153			// const as header name?
154			$limitHeaders = [
155			'X-RateLimit-Daily-Limit',
156			'X-RateLimit-Daily-Remaining',
157			'X-RateLimit-Global-Limit',
158			'X-RateLimit-Global-Remaining',
159			'X-RateLimit-Method-Limit',
160			'X-RateLimit-Method-Remaining',
161			'X-RateLimit-Until'
162			];
163
164			$this->limits = array();
165
166			foreach ($headers as $key => $value) {
167			if (in_array($key, $limitHeaders, true)) {
168			$this->limits[$key] = (int) $value[0];
169			}
170			}
171			}
172
173			/**
174			* Get information about API limits
175			*
176			* @return array\|false
177			*/
178			public function getLimits()
179			{
180			return $this->limits;
181			}
182
183			/**
184			* Get information about specified API limit
185			*
186			* @return array\|false
187			*/
188			public function getLimit($name)
189			{
190			if (isset($this->limits[$name])) {
191			return $this->limits[$name];
192			}
193
194			return false;
195			}
196
197			/**
198			* Returns API service response.
199			*
200			* @param string $resource
201			* @return array
202			* @throws ContentRequestException
203			* @throws ForbiddenException
204			* @throws UnauthorizedException
205			*/
206	29		protected function getServiceResponse($resource)
207			{
208	29		$response = $this->sendRequest('GET', $this->getServiceUrl($resource));
209	29		$decodedResponseBody = $this->getDecodedBody($response->getBody());
210
211	29		return $decodedResponseBody;
212			}
213
214			/**
215			* Returns URL-encoded query string
216			*
217			* @note: similar to http_build_query(),
218			* but transform key=>value where key == value to "?key" param.
219			*
220			* @param array\|object $queryData
221			* @param string $prefix
222			* @param string $argSeparator
223			* @param int $encType
224			*
225			* @return string $queryString
226			*/
227	25		protected function buildQueryString($queryData, $prefix = '', $argSeparator = '&', $encType = PHP_QUERY_RFC3986)
228			{
229	25		foreach ($queryData as $k => &$v) {
230	22		if (!is_scalar($v)) {
231	22		$v = implode(',', $v);
232			}
233			}
234
235	25		$queryString = http_build_query($queryData, $prefix, $argSeparator, $encType);
236
237	25		foreach ($queryData as $k => $v) {
238	22		if ($k==$v) {
239	22		$queryString = str_replace("$k=$v", $v, $queryString);
240			}
241			}
242
243	25		return $queryString;
244			}
245			}
246

nixsolutions / yandex-php-library

ContentClient::setLimits() A last analyzed 2021-05-31 12:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ContentClient::setLimits() A
last analyzed 2021-05-31 12:34 UTC