Oakhope\OAuth2\Client\Provider\MiniProgramProvider

Complexity

Total Complexity

14

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

90.91%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	getBaseAuthorizationUrl()	0	4	1
A	getBaseAccessTokenUrl()	0	4	1
A	getAccessToken()	0	19	1
A	createAccessToken()	0	6	1
A	getResourceOwnerDetailsUrl()	0	6	1
A	getDefaultScopes()	0	4	1
A	checkResponse()	0	9	3
A	createResourceOwner()	0	4	1
A	getResourceOwner()	0	10	2
A	setResponseUserInfo()	0	4	1

<?php


namespace Oakhope\OAuth2\Client\Provider;

use League\OAuth2\Client\Grant\AbstractGrant;
use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Provider\ResourceOwnerInterface;
use League\OAuth2\Client\Tool\ArrayAccessorTrait;
use League\OAuth2\Client\Tool\RequiredParameterTrait;
use League\OAuth2\Client\Token\AccessToken;
use Oakhope\OAuth2\Client\Grant\MiniProgram\AuthorizationCode;
use Psr\Http\Message\ResponseInterface;

class MiniProgramProvider extends AbstractProvider
{
    use ArrayAccessorTrait;
    use RequiredParameterTrait;

    protected $appid;
    protected $secret;
    protected $jscode;
    protected $responseUserInfo;

    /**
     * Constructs an OAuth 2.0 service provider.
     *
     * @param array $options An array of options to set on this provider.
     *     Options include `clientId`, `clientSecret`, `redirectUri`, and `state`.
     *     Individual providers may introduce more options, as needed.
     * @param array $collaborators An array of collaborators that may be used to
     *     override this provider's default behavior. Collaborators include
     *     `grantFactory`, `requestFactory`, and `httpClient`.
     *     Individual providers may introduce more collaborators, as needed.
     */
    public function __construct(array $options = [], array $collaborators = [])
    {
        $this->checkRequiredParameters(
            [
                'appid',
                'secret',
            ],
            $options
        );

        $options['access_token'] = 'js_code';

        parent::__construct($options, $collaborators);
    }

    /**
     * Returns the base URL for authorizing a client.
     *
     * Eg. https://oauth.service.com/authorize
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        throw new \LogicException('use wx.login(OBJECT) to get js_code');
    }

    /**
     * Returns the base URL for requesting an access token.
     *
     * Eg. https://oauth.service.com/token
     *
     * @param array $params
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return 'https://api.weixin.qq.com/sns/jscode2session';
    }

    /**
     * Requests an access token using a specified grant and option set.
     *
     * @param  string $jsCode
     * @param  array $options
     * @return AccessToken
     */
    public function getAccessToken($jsCode, array $options = [])
    {
        $this->jscode = $jsCode;
        $grant = new AuthorizationCode();
        $grant = $this->verifyGrant($grant);
        $params = [
            'appid' => $this->appid,
            'secret' => $this->secret,
            'js_code' => $jsCode,
        ];

        $params = $grant->prepareRequestParameters($params, $options);
        $request = $this->getAccessTokenRequest($params);
        $response = $this->getParsedResponse($request);
        $prepared = $this->prepareAccessTokenResponse($response);

It seems like $response defined by $this->getParsedResponse($request) on line 97 can also be of type null or string; however, League\OAuth2\Client\Provider\AbstractProvider::prepareAccessTokenResponse() does only seem to accept array, maybe add an additional type check?

        $token = $this->createAccessToken($prepared, $grant);

        return $token;
    }

    /**
     * Creates an access token from a response.
     *
     * The grant that was used to fetch the response can be used to provide
     * additional context.
     *
     * @param  array $response
     * @param  AbstractGrant $grant
     * @return AccessToken
     */
    protected function createAccessToken(array $response, AbstractGrant $grant)
    {
        return new \Oakhope\OAuth2\Client\Token\MiniProgram\AccessToken(
            $response
        );
    }

    /**
     * Returns the URL for requesting the resource owner's details.
     *
     * @param AccessToken $token
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        throw new \LogicException(
            'use wx.getUserInfo(OBJECT) to get ResourceOwnerDetails'
        );
    }

    /**
     * Returns the default scopes used by this provider.
     *
     * This should only be the scopes that are required to request the details
     * of the resource owner, rather than all the available scopes.
     *
     * @return array
     */
    protected function getDefaultScopes()
    {
        return [];
    }

    /**
     * Checks a provider response for errors.
     *
     * @throws IdentityProviderException
     * @param  ResponseInterface $response
     * @param  array|string $data Parsed response data
     * @return void
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        $errcode = $this->getValueByKey($data, 'errcode');

It seems like $data defined by parameter $data on line 155 can also be of type string; however, League\OAuth2\Client\Tool\ArrayAccessorTrait::getValueByKey() does only seem to accept array, maybe add an additional type check?

        $errmsg = $this->getValueByKey($data, 'errmsg');

It seems like $data defined by parameter $data on line 155 can also be of type string; however, League\OAuth2\Client\Tool\ArrayAccessorTrait::getValueByKey() does only seem to accept array, maybe add an additional type check?

        if ($errcode || $errmsg) {
            throw new IdentityProviderException($errmsg, $errcode, $response);

$response is of type object<Psr\Http\Message\ResponseInterface>, but the function expects a array|string.

        };
    }

    /**
     * Generates a resource owner object from a successful resource owner
     * details request.
     *
     * @param  array $response
     * @param  AccessToken $token
     * @return ResourceOwnerInterface
     */
    public function createResourceOwner(array $response, AccessToken $token)
    {
        return new MiniProgramResourceOwner($response, $token, $this->appid);
    }

    /**
     * Requests and returns the resource owner of given access token.
     *
     * @param  AccessToken $token
     * @return ResourceOwnerInterface
     */
    public function getResourceOwner(AccessToken $token)
    {
        if (null == $this->responseUserInfo) {
            throw new \InvalidArgumentException(
                "setResponseUserInfo by wx.getUserInfo(OBJECT)'s response data first"
            );
        }

        return $this->createResourceOwner($this->responseUserInfo, $token);
    }

    /**
     * set by wx.getUserInfo(OBJECT)'s response data
     *
     * @param array $response
     */
    public function setResponseUserInfo($response)
    {
        $this->responseUserInfo = $response;
    }
}