BaseClient::setResource() - Code Metrics - Inspection of "Fix request" - CloudyCity/tencent-marketing-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b4333d...9d639e )

by CloudyCity

created 2020-03-18 07:03 UTC

BaseClient::setResource() A

↳ Parent: BaseClient

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	9
rs	10
cc	3
nc	2
nop	2

<?php

namespace CloudyCity\TencentMarketingSDK\Kernel;

use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\ApiException;
use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\Exception;
use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\InvalidActionException;
use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\InvalidResourceException;
use CloudyCity\TencentMarketingSDK\Kernel\Http\Parameters\Params;
use CloudyCity\TencentMarketingSDK\Kernel\Traits\HasHttpRequests;
use CloudyCity\TencentMarketingSDK\Kernel\Traits\HasSdkBaseInfo;
use CloudyCity\TencentMarketingSDK\Resources;

class BaseClient
{
    use HasHttpRequests, HasSdkBaseInfo {
        request as performRequest;
        HasHttpRequests::getResponseType insteadof HasSdkBaseInfo;
        HasHttpRequests::setResponseType insteadof HasSdkBaseInfo;
    }

    /**
     * The base url of official environmental.
     *
     * @var string
     */
    protected $baseUrl = 'https://api.e.qq.com';

    /**
     * The base url of sandbox environmental.
     *
     * @var string
     */
    protected $sandboxBaseUrl = 'https://sandbox-api.e.qq.com';

    /**
     * The version of API.
     *
     * @var string
     */
    protected $version = 'v1.1';

    /**
     * Whether it is a sandbox environment.
     *
     * @var bool
     */
    protected $sandbox = false;

    /**
     * Resource.
     *
     * @var string
     */
    protected $resource;

    /**
     * Fields.
     *
     * @var array
     */
    protected $fields = [];

    /**
     * Client constructor.
     *
     * @param $advertiserId
     * @param $accessToken
     * @param string $responseType
     */
    public function __construct($advertiserId, $accessToken, $responseType = 'array')
    {
        $this->setAdvertiserId($advertiserId);
        $this->setAccessToken($accessToken);
        $this->setResponseType($responseType);
    }

    /**
     * Set Fields.
     *
     * @param array $fields
     *
     * @return $this
     */
    public function setFields(array $fields)
    {
        $this->fields = $fields;

        return $this;
    }

    /**
     * Get fields.
     *
     * @return array
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * Set env.
     *
     * @param bool $sandbox
     *
     * @return $this
     */
    public function setSandbox($sandbox = true)
    {
        $this->sandbox = boolval($sandbox);

        return $this;
    }

    /**
     * Set version.
     *
     * @param $version
     *
     * @return $this
     */
    public function setVersion($version)
    {
        $this->version = $version;

        return $this;
    }

    /**
     * Get Version.
     *
     * @return string
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * Whether it is a sandbox environment.
     *
     * @return bool
     */
    public function isSandbox()
    {
        return $this->sandbox;
    }

    /**
     * Get base url for request.
     *
     * @return string
     */
    public function getBaseUrl()
    {
        return $this->isSandbox() ? $this->sandboxBaseUrl : $this->baseUrl;
    }

    /**
     * Set resource name.
     *
     * @param $resource
     * @param bool $checkValid
     *
     * @throws InvalidResourceException
     *
     * @return $this
     */
    public function setResource($resource, $checkValid = true)
    {
        if ($checkValid && !Resources::checkResource($resource)) {
            throw new InvalidResourceException('Invalid resource:'.$resource);
        }

        $this->resource = $resource;

        return $this;
    }

    /**
     * Get resource name.
     *
     * @return string
     */
    public function getResource()
    {
        return $this->resource;
    }

    /**
     * Get url for request.
     *
     * @param $action
     *
     * @throws InvalidResourceException
     *
     * @return string
     */
    public function getRequestUrl($action)
    {
        if (!Resources::checkResource($resource = $this->getResource())) {
            throw new InvalidResourceException('Invalid resource:'.$resource);
        }

        return sprintf('%s/%s/%s/%s', $this->getBaseUrl(), $this->getVersion(), $resource, $action);
    }

    /**
     * Request.
     *
     * @param $action
     * @param array $params
     * @param array $headers
     * @param bool  $returnRaw
     *
     * @throws ApiException
     * @throws Exception
     * @throws Exceptions\InvalidArgumentException
     * @throws InvalidActionException
     * @throws InvalidResourceException
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function request($action, $params = [], $headers = [], $returnRaw = false)
    {
        if (!$this->checkAction($action)) {
            throw new InvalidActionException("resource {$this->getResource()} does not support action:".
                "{$action}, please check the official documentation");
        }

        $method = $action === 'get' ? 'get' : 'post';

        $url = $this->getRequestUrl($action);

        $options = [
            'headers' => $headers,
            'query' => $this->getBaseQuery()
        ];

        $params = Params::make($params);

        if ($params->isMultipart()) {
            $options['multipart'] = $params->toArray();
        } elseif ($method === 'get') {
            $options['query'] += $params->toArray();
        } else {
            $options['form_params'] = $params->toArray();
        }

        $response = $this->performRequest($method, $url, $options);

        $responseType = $this->getResponseType();

        $result = $this->castResponseToType($response);
        $formatted = $this->castResponseToType($response, $responseType);

        if (!isset($result['code']) || $result['code'] != 0) {
            $message = isset($result['message']) ? $result['message'] : '';
            $code = isset($result['code']) ? $result['code'] : 0;

            throw new ApiException($message, $response, $formatted, $code);
        }

        return $returnRaw ? $response : $this->castResponseToType($response, $responseType);
    }

    /**
     * Check Action for resource.
     *
     * @param $action
     *
     * @return bool
     */
    public function checkAction($action)
    {
        return in_array($action, $this->getValidActions());
    }

    /**
     * Get all valid actions for resource.
     *
     * @return array
     */
    public function getValidActions()
    {
        return ['get', 'add', 'update', 'delete'];
    }

    /**
     * Get resource.
     *
     * @param mixed $params
     *
     * @throws ApiException
     * @throws Exception
     * @throws Exceptions\InvalidArgumentException
     * @throws InvalidActionException
     * @throws InvalidResourceException
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function get($params = [])
    {
        return $this->request('get', $params);
    }

    /**
     * Add resource.
     *
     * @param $params
     *
     * @throws ApiException
     * @throws Exception
     * @throws Exceptions\InvalidArgumentException
     * @throws InvalidActionException
     * @throws InvalidResourceException
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function add($params)
    {
        return $this->request('add', $params);
    }

    /**
     * Update resource.
     *
     * @param $params
     *
     * @throws ApiException
     * @throws Exception
     * @throws Exceptions\InvalidArgumentException
     * @throws InvalidActionException
     * @throws InvalidResourceException
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function update($params)
    {
        return $this->request('update', $params);
    }

    /**
     * Delete resource.
     *
     * @param $params
     *
     * @throws ApiException
     * @throws Exception
     * @throws Exceptions\InvalidArgumentException
     * @throws InvalidActionException
     * @throws InvalidResourceException
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function delete($params)
    {
        return $this->request('delete', $params);
    }

    /**
     * Get all records by Generator. Each iteration of the loop is a response of singe page.
     *
     * @param Params $params
     * @param int    $pageSize
     *
     * @throws ApiException
     * @throws Exception
     * @throws Exceptions\InvalidArgumentException
     * @throws InvalidActionException
     * @throws InvalidResourceException
     *
     * @return \Generator
     */
    public function getAllPages(Params $params = null, $pageSize = 100)
    {
        $params = Params::make($params);
        $params->set('page_size', $pageSize);

        $page = $params->get('page') ?: 1;
        $params->set('page', $page);

        do {
            $result = $this->get($params);

            $data = $this->detectAndCastResponseToType($result, 'collection')->get('data');

            $totalPage = $data['page_info']['total_page'];

            yield $result;

            $params->set('page', ++$page);
        } while ($page <= $totalPage);
    }

    /**
     * Get required auth info for request.
     *
     * @return array
     */
    protected function getBaseQuery()
    {
        return [
            'access_token' => $this->getAccessToken(),
            'timestamp' => time(),
            'nonce' => Support\generate_nonce(),
            'account_id' => $this->getAdvertiserId(),
        ];
    }
}


1			<?php
2
3			namespace CloudyCity\TencentMarketingSDK\Kernel;
4
5			use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\ApiException;
6			use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\Exception;
7			use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\InvalidActionException;
8			use CloudyCity\TencentMarketingSDK\Kernel\Exceptions\InvalidResourceException;
9			use CloudyCity\TencentMarketingSDK\Kernel\Http\Parameters\Params;
10			use CloudyCity\TencentMarketingSDK\Kernel\Traits\HasHttpRequests;
11			use CloudyCity\TencentMarketingSDK\Kernel\Traits\HasSdkBaseInfo;
12			use CloudyCity\TencentMarketingSDK\Resources;
13
14			class BaseClient
15			{
16			use HasHttpRequests, HasSdkBaseInfo {
17			request as performRequest;
18			HasHttpRequests::getResponseType insteadof HasSdkBaseInfo;
19			HasHttpRequests::setResponseType insteadof HasSdkBaseInfo;
20			}
21
22			/**
23			* The base url of official environmental.
24			*
25			* @var string
26			*/
27			protected $baseUrl = 'https://api.e.qq.com';
28
29			/**
30			* The base url of sandbox environmental.
31			*
32			* @var string
33			*/
34			protected $sandboxBaseUrl = 'https://sandbox-api.e.qq.com';
35
36			/**
37			* The version of API.
38			*
39			* @var string
40			*/
41			protected $version = 'v1.1';
42
43			/**
44			* Whether it is a sandbox environment.
45			*
46			* @var bool
47			*/
48			protected $sandbox = false;
49
50			/**
51			* Resource.
52			*
53			* @var string
54			*/
55			protected $resource;
56
57			/**
58			* Fields.
59			*
60			* @var array
61			*/
62			protected $fields = [];
63
64			/**
65			* Client constructor.
66			*
67			* @param $advertiserId
68			* @param $accessToken
69			* @param string $responseType
70			*/
71			public function __construct($advertiserId, $accessToken, $responseType = 'array')
72			{
73			$this->setAdvertiserId($advertiserId);
74			$this->setAccessToken($accessToken);
75			$this->setResponseType($responseType);
76			}
77
78			/**
79			* Set Fields.
80			*
81			* @param array $fields
82			*
83			* @return $this
84			*/
85			public function setFields(array $fields)
86			{
87			$this->fields = $fields;
88
89			return $this;
90			}
91
92			/**
93			* Get fields.
94			*
95			* @return array
96			*/
97			public function getFields()
98			{
99			return $this->fields;
100			}
101
102			/**
103			* Set env.
104			*
105			* @param bool $sandbox
106			*
107			* @return $this
108			*/
109			public function setSandbox($sandbox = true)
110			{
111			$this->sandbox = boolval($sandbox);
112
113			return $this;
114			}
115
116			/**
117			* Set version.
118			*
119			* @param $version
120			*
121			* @return $this
122			*/
123			public function setVersion($version)
124			{
125			$this->version = $version;
126
127			return $this;
128			}
129
130			/**
131			* Get Version.
132			*
133			* @return string
134			*/
135			public function getVersion()
136			{
137			return $this->version;
138			}
139
140			/**
141			* Whether it is a sandbox environment.
142			*
143			* @return bool
144			*/
145			public function isSandbox()
146			{
147			return $this->sandbox;
148			}
149
150			/**
151			* Get base url for request.
152			*
153			* @return string
154			*/
155			public function getBaseUrl()
156			{
157			return $this->isSandbox() ? $this->sandboxBaseUrl : $this->baseUrl;
158			}
159
160			/**
161			* Set resource name.
162			*
163			* @param $resource
164			* @param bool $checkValid
165			*
166			* @throws InvalidResourceException
167			*
168			* @return $this
169			*/
170			public function setResource($resource, $checkValid = true)
171			{
172			if ($checkValid && !Resources::checkResource($resource)) {
173			throw new InvalidResourceException('Invalid resource:'.$resource);
174			}
175
176			$this->resource = $resource;
177
178			return $this;
179			}
180
181			/**
182			* Get resource name.
183			*
184			* @return string
185			*/
186			public function getResource()
187			{
188			return $this->resource;
189			}
190
191			/**
192			* Get url for request.
193			*
194			* @param $action
195			*
196			* @throws InvalidResourceException
197			*
198			* @return string
199			*/
200			public function getRequestUrl($action)
201			{
202			if (!Resources::checkResource($resource = $this->getResource())) {
203			throw new InvalidResourceException('Invalid resource:'.$resource);
204			}
205
206			return sprintf('%s/%s/%s/%s', $this->getBaseUrl(), $this->getVersion(), $resource, $action);
207			}
208
209			/**
210			* Request.
211			*
212			* @param $action
213			* @param array $params
214			* @param array $headers
215			* @param bool $returnRaw
216			*
217			* @throws ApiException
218			* @throws Exception
219			* @throws Exceptions\InvalidArgumentException
220			* @throws InvalidActionException
221			* @throws InvalidResourceException
222			*
223			* @return \Psr\Http\Message\ResponseInterface
224			*/
225			public function request($action, $params = [], $headers = [], $returnRaw = false)
226			{
227			if (!$this->checkAction($action)) {
228			throw new InvalidActionException("resource {$this->getResource()} does not support action:".
229			"{$action}, please check the official documentation");
230			}
231
232			$method = $action === 'get' ? 'get' : 'post';
233
234			$url = $this->getRequestUrl($action);
235
236			$options = [
237			'headers' => $headers,
238			'query' => $this->getBaseQuery()
239			];
240
241			$params = Params::make($params);
242
243			if ($params->isMultipart()) {
244			$options['multipart'] = $params->toArray();
245			} elseif ($method === 'get') {
246			$options['query'] += $params->toArray();
247			} else {
248			$options['form_params'] = $params->toArray();
249			}
250
251			$response = $this->performRequest($method, $url, $options);
252
253			$responseType = $this->getResponseType();
254
255			$result = $this->castResponseToType($response);
256			$formatted = $this->castResponseToType($response, $responseType);
257
258			if (!isset($result['code']) \|\| $result['code'] != 0) {
259			$message = isset($result['message']) ? $result['message'] : '';
260			$code = isset($result['code']) ? $result['code'] : 0;
261
262			throw new ApiException($message, $response, $formatted, $code);
263			}
264
265			return $returnRaw ? $response : $this->castResponseToType($response, $responseType);
266			}
267
268			/**
269			* Check Action for resource.
270			*
271			* @param $action
272			*
273			* @return bool
274			*/
275			public function checkAction($action)
276			{
277			return in_array($action, $this->getValidActions());
278			}
279
280			/**
281			* Get all valid actions for resource.
282			*
283			* @return array
284			*/
285			public function getValidActions()
286			{
287			return ['get', 'add', 'update', 'delete'];
288			}
289
290			/**
291			* Get resource.
292			*
293			* @param mixed $params
294			*
295			* @throws ApiException
296			* @throws Exception
297			* @throws Exceptions\InvalidArgumentException
298			* @throws InvalidActionException
299			* @throws InvalidResourceException
300			*
301			* @return \Psr\Http\Message\ResponseInterface
302			*/
303			public function get($params = [])
304			{
305			return $this->request('get', $params);
306			}
307
308			/**
309			* Add resource.
310			*
311			* @param $params
312			*
313			* @throws ApiException
314			* @throws Exception
315			* @throws Exceptions\InvalidArgumentException
316			* @throws InvalidActionException
317			* @throws InvalidResourceException
318			*
319			* @return \Psr\Http\Message\ResponseInterface
320			*/
321			public function add($params)
322			{
323			return $this->request('add', $params);
324			}
325
326			/**
327			* Update resource.
328			*
329			* @param $params
330			*
331			* @throws ApiException
332			* @throws Exception
333			* @throws Exceptions\InvalidArgumentException
334			* @throws InvalidActionException
335			* @throws InvalidResourceException
336			*
337			* @return \Psr\Http\Message\ResponseInterface
338			*/
339			public function update($params)
340			{
341			return $this->request('update', $params);
342			}
343
344			/**
345			* Delete resource.
346			*
347			* @param $params
348			*
349			* @throws ApiException
350			* @throws Exception
351			* @throws Exceptions\InvalidArgumentException
352			* @throws InvalidActionException
353			* @throws InvalidResourceException
354			*
355			* @return \Psr\Http\Message\ResponseInterface
356			*/
357			public function delete($params)
358			{
359			return $this->request('delete', $params);
360			}
361
362			/**
363			* Get all records by Generator. Each iteration of the loop is a response of singe page.
364			*
365			* @param Params $params
366			* @param int $pageSize
367			*
368			* @throws ApiException
369			* @throws Exception
370			* @throws Exceptions\InvalidArgumentException
371			* @throws InvalidActionException
372			* @throws InvalidResourceException
373			*
374			* @return \Generator
375			*/
376			public function getAllPages(Params $params = null, $pageSize = 100)
377			{
378			$params = Params::make($params);
379			$params->set('page_size', $pageSize);
380
381			$page = $params->get('page') ?: 1;
382			$params->set('page', $page);
383
384			do {
385			$result = $this->get($params);
386
387			$data = $this->detectAndCastResponseToType($result, 'collection')->get('data');
388
389			$totalPage = $data['page_info']['total_page'];
390
391			yield $result;
392
393			$params->set('page', ++$page);
394			} while ($page <= $totalPage);
395			}
396
397			/**
398			* Get required auth info for request.
399			*
400			* @return array
401			*/
402			protected function getBaseQuery()
403			{
404			return [
405			'access_token' => $this->getAccessToken(),
406			'timestamp' => time(),
407			'nonce' => Support\generate_nonce(),
408			'account_id' => $this->getAdvertiserId(),
409			];
410			}
411			}
412

CloudyCity / tencent-marketing-sdk

Push — master ( b4333d...9d639e )

BaseClient::setResource() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like