AbstractAPI::accessTokenMiddleware() - Code Metrics - Inspection of "Merge Develop" - overtrue/wechat - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#249)

by Carlos

created 2016-01-15 08:55 UTC

AbstractAPI::accessTokenMiddleware() A

↳ Parent: AbstractAPI

Complexity

Conditions	2
Paths	1

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

overtrue / wechat

Pull Request — master (#249)

AbstractAPI::accessTokenMiddleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like