AbstractAPI::logMiddleware() - Code Metrics - Inspection of "CS." - overtrue/wechat - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (966c07)

by Carlos

created 2016-01-15 08:49 UTC

AbstractAPI::logMiddleware() A

↳ Parent: AbstractAPI

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	0

<?php

/*
 * This file is part of the overtrue/wechat.
 *
 * (c) overtrue <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

/**
 * AbstractAPI.php.
 *
 * This file is part of the wechat-components.
 *
 * (c) overtrue <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */
namespace EasyWeChat\Core;

use EasyWeChat\Core\Exceptions\HttpException;
use EasyWeChat\Support\Collection;
use EasyWeChat\Support\Log;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Uri;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * Class AbstractAPI.
 */
abstract class AbstractAPI
{
    /**
     * Http instance.
     *
     * @var \EasyWeChat\Core\Http
     */
    protected $http;

    /**
     * The reqeust token.
     *
     * @var \EasyWeChat\Core\AccessToken
     */
    protected $accessToken;

    const GET = 'get';
    const POST = 'post';
    const JSON = 'json';

    /**
     * Constructor.
     *
     * @param \EasyWeChat\Core\AccessToken $accessToken
     */
    public function __construct(AccessToken $accessToken)
    {
        $this->setAccessToken($accessToken);

        $this->registerHttpMiddleware();
    }

    /**
     * Return the http instance.
     *
     * @return \EasyWeChat\Core\Http
     */
    public function getHttp()
    {
        return $this->http ?: $this->http = new Http();
    }

    /**
     * Set the http instance.
     *
     * @param \EasyWeChat\Core\Http $http
     *
     * @return $this
     */
    public function setHttp(Http $http)
    {
        $this->http = $http;

        return $this;
    }

    /**
     * Return the current accessToken.
     *
     * @return \EasyWeChat\Core\AccessToken
     */
    public function getAccessToken()
    {
        return $this->accessToken;
    }

    /**
     * Set the request token.
     *
     * @param \EasyWeChat\Core\AccessToken $accessToken
     *
     * @return $this
     */
    public function setAccessToken(AccessToken $accessToken)
    {
        $this->accessToken = $accessToken;

        return $this;
    }

    /**
     * Parse JSON from response and check error.
     *
     * @param string $method
     * @param array  $args
     * @param bool   $throws
     *
     * @return \EasyWeChat\Support\Collection
     */
    public function parseJSON($method, $args, $throws = true)

    {
        $http = $this->getHttp();

        $args = (array) $args;

        $contents = $http->parseJSON(call_user_func_array([$http, $method], $args));

        $this->checkAndThrow($contents);

        return new Collection($contents);
    }

    /**
     * Set request access_token query.
     */
    protected function registerHttpMiddleware()
    {
        // access token
        $this->getHttp()->addMiddleware($this->accessTokenMiddleware());
        // log
        $this->getHttp()->addMiddleware($this->logMiddleware());
        // retry
        $this->getHttp()->addMiddleware($this->retryMiddleware());
    }

    /**
     * Attache access token to request query.
     *
     * @return Closure
     */
    public function accessTokenMiddleware()
    {
        return function (callable $handler) {
            return function (RequestInterface $request, array $options) use ($handler) {
                if (!$this->accessToken) {
                    return $handler($request, $options);
                }

                $field = $this->accessToken->getQueryName();
                $token = $this->accessToken->getToken();

                $request = $request->withUri(Uri::withQueryValue($request->getUri(), $field, $token));

                return $handler($request, $options);
            };
        };
    }

    /**
     * Log the request.
     *
     * @return \GuzzleHttp\Middleware
     */
    public function logMiddleware()
    {
        return Middleware::tap(function (RequestInterface $request) {
            Log::debug("Request: {$request->getMethod()} {$request->getUri()}");
            Log::debug("Request Body: {$request->getBody()}");
        });
    }

    /**
     * Return retry middleware.
     *
     * @return \GuzzleHttp\RetryMiddleware
     */
    protected function retryMiddleware()
    {
        return Middleware::retry(function (
                                          $retries,
                                          RequestInterface $request,
                                          ResponseInterface $response = null
                                       ) {
            // Limit the number of retries to 2
            if ($retries <= 2 && $response && $body = $response->getBody()) {
                // Retry on server errors
                if (stripos($body, 'errcode') && (stripos($body, '40001') || stripos($body, '42001'))) {
                    $field = $this->accessToken->getQueryName();
                    $token = $this->accessToken->getToken();

                    $request = $request->withUri($newUri = Uri::withQueryValue($request->getUri(), $field, $token));

                    Log::debug("Retry with Request Token: {$token}");
                    Log::debug("Retry with Request Uri: {$newUri}");

                    return true;
                }
            }

            return false;
        });
    }

    /**
     * Check the array data erros, and Throw expcetion when the contents cotnains error.
     *
     * @param array $contents
     *
     * @throws \EasyWeChat\Core\Exceptions\HttpException
     */
    protected function checkAndThrow(array $contents)
    {
        if (isset($contents['errcode']) && 0 !== $contents['errcode']) {
            if (empty($contents['errmsg'])) {
                $contents['errmsg'] = 'Unknown';
            }

            throw new HttpException($contents['errmsg'], $contents['errcode']);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the overtrue/wechat.
5			*
6			* (c) overtrue <[email protected]>
7			*
8			* This source file is subject to the MIT license that is bundled
9			* with this source code in the file LICENSE.
10			*/
11
12			/**
13			* AbstractAPI.php.
14			*
15			* This file is part of the wechat-components.
16			*
17			* (c) overtrue <[email protected]>
18			*
19			* This source file is subject to the MIT license that is bundled
20			* with this source code in the file LICENSE.
21			*/
22			namespace EasyWeChat\Core;
23
24			use EasyWeChat\Core\Exceptions\HttpException;
25			use EasyWeChat\Support\Collection;
26			use EasyWeChat\Support\Log;
27			use GuzzleHttp\Exception\RequestException;
28			use GuzzleHttp\Middleware;
29			use GuzzleHttp\Psr7\Uri;
30			use Psr\Http\Message\RequestInterface;
31			use Psr\Http\Message\ResponseInterface;
32
33			/**
34			* Class AbstractAPI.
35			*/
36			abstract class AbstractAPI
37			{
38			/**
39			* Http instance.
40			*
41			* @var \EasyWeChat\Core\Http
42			*/
43			protected $http;
44
45			/**
46			* The reqeust token.
47			*
48			* @var \EasyWeChat\Core\AccessToken
49			*/
50			protected $accessToken;
51
52			const GET = 'get';
53			const POST = 'post';
54			const JSON = 'json';
55
56			/**
57			* Constructor.
58			*
59			* @param \EasyWeChat\Core\AccessToken $accessToken
60			*/
61			public function __construct(AccessToken $accessToken)
62			{
63			$this->setAccessToken($accessToken);
64
65			$this->registerHttpMiddleware();
66			}
67
68			/**
69			* Return the http instance.
70			*
71			* @return \EasyWeChat\Core\Http
72			*/
73			public function getHttp()
74			{
75			return $this->http ?: $this->http = new Http();
76			}
77
78			/**
79			* Set the http instance.
80			*
81			* @param \EasyWeChat\Core\Http $http
82			*
83			* @return $this
84			*/
85			public function setHttp(Http $http)
86			{
87			$this->http = $http;
88
89			return $this;
90			}
91
92			/**
93			* Return the current accessToken.
94			*
95			* @return \EasyWeChat\Core\AccessToken
96			*/
97			public function getAccessToken()
98			{
99			return $this->accessToken;
100			}
101
102			/**
103			* Set the request token.
104			*
105			* @param \EasyWeChat\Core\AccessToken $accessToken
106			*
107			* @return $this
108			*/
109			public function setAccessToken(AccessToken $accessToken)
110			{
111			$this->accessToken = $accessToken;
112
113			return $this;
114			}
115
116			/**
117			* Parse JSON from response and check error.
118			*
119			* @param string $method
120			* @param array $args
121			* @param bool $throws
122			*
123			* @return \EasyWeChat\Support\Collection
124			*/
125			public function parseJSON($method, $args, $throws = true)
			0 ignored issues – show Unused Code introduced 2016-01-14 05:10 UTC by Report Bug Copy Issue Report The parameter `$throws` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
126			{
127			$http = $this->getHttp();
128
129			$args = (array) $args;
130
131			$contents = $http->parseJSON(call_user_func_array([$http, $method], $args));
132
133			$this->checkAndThrow($contents);
134
135			return new Collection($contents);
136			}
137
138			/**
139			* Set request access_token query.
140			*/
141			protected function registerHttpMiddleware()
142			{
143			// access token
144			$this->getHttp()->addMiddleware($this->accessTokenMiddleware());
145			// log
146			$this->getHttp()->addMiddleware($this->logMiddleware());
147			// retry
148			$this->getHttp()->addMiddleware($this->retryMiddleware());
149			}
150
151			/**
152			* Attache access token to request query.
153			*
154			* @return Closure
155			*/
156			public function accessTokenMiddleware()
157			{
158			return function (callable $handler) {
159			return function (RequestInterface $request, array $options) use ($handler) {
160			if (!$this->accessToken) {
161			return $handler($request, $options);
162			}
163
164			$field = $this->accessToken->getQueryName();
165			$token = $this->accessToken->getToken();
166
167			$request = $request->withUri(Uri::withQueryValue($request->getUri(), $field, $token));
168
169			return $handler($request, $options);
170			};
171			};
172			}
173
174			/**
175			* Log the request.
176			*
177			* @return \GuzzleHttp\Middleware
178			*/
179			public function logMiddleware()
180			{
181			return Middleware::tap(function (RequestInterface $request) {
182			Log::debug("Request: {$request->getMethod()} {$request->getUri()}");
183			Log::debug("Request Body: {$request->getBody()}");
184			});
185			}
186
187			/**
188			* Return retry middleware.
189			*
190			* @return \GuzzleHttp\RetryMiddleware
191			*/
192			protected function retryMiddleware()
193			{
194			return Middleware::retry(function (
195			$retries,
196			RequestInterface $request,
197			ResponseInterface $response = null
198			) {
199			// Limit the number of retries to 2
200			if ($retries <= 2 && $response && $body = $response->getBody()) {
201			// Retry on server errors
202			if (stripos($body, 'errcode') && (stripos($body, '40001') \|\| stripos($body, '42001'))) {
203			$field = $this->accessToken->getQueryName();
204			$token = $this->accessToken->getToken();
205
206			$request = $request->withUri($newUri = Uri::withQueryValue($request->getUri(), $field, $token));
207
208			Log::debug("Retry with Request Token: {$token}");
209			Log::debug("Retry with Request Uri: {$newUri}");
210
211			return true;
212			}
213			}
214
215			return false;
216			});
217			}
218
219			/**
220			* Check the array data erros, and Throw expcetion when the contents cotnains error.
221			*
222			* @param array $contents
223			*
224			* @throws \EasyWeChat\Core\Exceptions\HttpException
225			*/
226			protected function checkAndThrow(array $contents)
227			{
228			if (isset($contents['errcode']) && 0 !== $contents['errcode']) {
229			if (empty($contents['errmsg'])) {
230			$contents['errmsg'] = 'Unknown';
231			}
232
233			throw new HttpException($contents['errmsg'], $contents['errcode']);
234			}
235			}
236			}
237

overtrue / wechat

Branch — develop (966c07)

AbstractAPI::logMiddleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like