ContentClient::sendRequest() - Code Metrics - Inspection of "Yandex Market Content API" - nixsolutions/yandex-php-library - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#139)

unknown

created 2016-01-09 22:45 UTC

ContentClient::sendRequest() C

↳ Parent: ContentClient

Complexity

Conditions	8
Paths	10

Size

Total Lines	35
Code Lines	21

Duplication

Lines	35
Ratio	100 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	35
loc	35
rs	5.3846
cc	8
eloc	21
nc	10
nop	3

<?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 Psr\Http\Message\UriInterface;
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;
use Yandex\Market\Content\Models;


/**
 * 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|UriInterface $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 $header) {
            if (in_array($header->getName(), $limitHeaders, true))
                $this->limits[$header->getName()] = (int) $header->__toString();

        }
    }

    /**
     * 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 $numericPrefix
     * @param string $argSeparator
     * @param int $encType
     *
     * @return string $queryString
     */
    protected function buildQueryString($queryData, $numericPrefix = '', $argSeparator = '&', $encType = PHP_QUERY_RFC3986)
    {
        foreach($queryData as $k=>&$v)
            if (!is_scalar($v))
                $v = implode(',', $v);

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

nixsolutions / yandex-php-library

Pull Request — master (#139)

ContentClient::sendRequest() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like