Provider::getResourceOwnerDetailsUrl() - Code Metrics - Inspection of "Adding mod_pleio to Elgg" - gctools-outilsgc/gcconnex - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add-pleio-mod ( 6d68a5 )

unknown

created 2018-03-13 15:32 UTC

Provider::getResourceOwnerDetailsUrl() A

↳ Parent: Provider

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	4
cp	0
crap	2

<?php
namespace ModPleio;

require_once(dirname(__FILE__) . "/../../vendor/autoload.php");

use InvalidArgumentException;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Token\AccessToken;
use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
use Psr\Http\Message\ResponseInterface;

class Provider extends AbstractProvider {
    use BearerAuthorizationTrait;

    /**
     * @var string
     */
    private $urlAuthorize;


    /**
     * @var string
     */
    private $urlAccessToken;


    /**
     * @var string
     */
    private $urlResourceOwnerDetails;


    /**
     * @var string
     */
    private $accessTokenMethod;

    /**
     * @var string
     */
    private $accessTokenResourceOwnerId;

    /**
     * @var array|null
     */
    private $scopes = null;

    /**
     * @var string
     */
    private $scopeSeparator;

    /**
     * @var string
     */
    private $responseError = 'error';

    /**
     * @var string
     */
    private $responseCode;

    /**
     * @var string
     */
    private $responseResourceOwnerId = 'id';

    /**
     * @param array $options
     * @param array $collaborators
     */
    public function __construct(array $options = [], array $collaborators = [])
    {
        $this->assertRequiredOptions($options);

        $possible   = $this->getConfigurableOptions();
        $configured = array_intersect_key($options, array_flip($possible));

        foreach ($configured as $key => $value) {
            $this->$key = $value;
        }

        // Remove all options that are only used locally
        $options = array_diff_key($options, $configured);

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

    /**
     * Returns all options that can be configured.
     *
     * @return array
     */
    protected function getConfigurableOptions()
    {
        return array_merge($this->getRequiredOptions(), [
            'accessTokenMethod',
            'accessTokenResourceOwnerId',
            'scopeSeparator',
            'responseError',
            'responseCode',
            'responseResourceOwnerId',
            'scopes',
        ]);
    }

    /**
     * Returns all options that are required.
     *
     * @return array
     */
    protected function getRequiredOptions()
    {
        return ['url'];
    }

    /**
     * Verifies that all required options have been passed.
     *
     * @param  array $options
     * @return void
     * @throws InvalidArgumentException
     */
    private function assertRequiredOptions(array $options)
    {
        $missing = array_diff_key(array_flip($this->getRequiredOptions()), $options);

        if (!empty($missing)) {
            throw new InvalidArgumentException(
                'Required options not defined: ' . implode(', ', array_keys($missing))
            );
        }
    }

    /**
     * @inheritdoc
     */
    public function getBaseAuthorizationUrl()
    {
        return $this->url . "oauth/v2/authorize";
    }

    /**
     * @inheritdoc
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return $this->url . "oauth/v2/token";
    }

    /**
     * @inheritdoc
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        return $this->url . "api/users/me";
    }

    /**
     * @inheritdoc
     */
    public function getDefaultScopes()
    {
        return $this->scopes;
    }

    /**
     * @inheritdoc
     */
    protected function getAccessTokenMethod()
    {
        return $this->accessTokenMethod ?: parent::getAccessTokenMethod();
    }

    /**
     * @inheritdoc
     */
    protected function getAccessTokenResourceOwnerId()
    {
        return $this->accessTokenResourceOwnerId ?: parent::getAccessTokenResourceOwnerId();
    }

    /**
     * @inheritdoc
     */
    protected function getScopeSeparator()
    {
        return $this->scopeSeparator ?: parent::getScopeSeparator();
    }

    /**
     * @inheritdoc
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        if (!empty($data[$this->responseError])) {
            $error = $data[$this->responseError];
            $code  = $this->responseCode ? $data[$this->responseCode] : 0;
            throw new IdentityProviderException($error, $code, $data);
        }
    }

    /**
     * @inheritdoc
     */
    protected function createResourceOwner(array $response, AccessToken $token)
    {
        return new ResourceOwner($response, $this->responseResourceOwnerId);
    }
}


1			<?php
2			namespace ModPleio;
3
4			require_once(dirname(__FILE__) . "/../../vendor/autoload.php");
5
6			use InvalidArgumentException;
7			use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
8			use League\OAuth2\Client\Provider\AbstractProvider;
9			use League\OAuth2\Client\Token\AccessToken;
10			use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
11			use Psr\Http\Message\ResponseInterface;
12
13			class Provider extends AbstractProvider {
14			use BearerAuthorizationTrait;
15
16			/**
17			* @var string
18			*/
19			private $urlAuthorize;
			0 ignored issues – show Unused Code introduced 2018-03-13 15:59 UTC by Report Bug Copy Issue Report The property `$urlAuthorize` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
20
21			/**
22			* @var string
23			*/
24			private $urlAccessToken;
			0 ignored issues – show Unused Code introduced 2018-03-13 15:59 UTC by Report Bug Copy Issue Report The property `$urlAccessToken` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
25
26			/**
27			* @var string
28			*/
29			private $urlResourceOwnerDetails;
			0 ignored issues – show Unused Code introduced 2018-03-13 15:59 UTC by Report Bug Copy Issue Report The property `$urlResourceOwnerDetails` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
30
31			/**
32			* @var string
33			*/
34			private $accessTokenMethod;
35
36			/**
37			* @var string
38			*/
39			private $accessTokenResourceOwnerId;
40
41			/**
42			* @var array\|null
43			*/
44			private $scopes = null;
45
46			/**
47			* @var string
48			*/
49			private $scopeSeparator;
50
51			/**
52			* @var string
53			*/
54			private $responseError = 'error';
55
56			/**
57			* @var string
58			*/
59			private $responseCode;
60
61			/**
62			* @var string
63			*/
64			private $responseResourceOwnerId = 'id';
65
66			/**
67			* @param array $options
68			* @param array $collaborators
69			*/
70			public function __construct(array $options = [], array $collaborators = [])
71			{
72			$this->assertRequiredOptions($options);
73
74			$possible = $this->getConfigurableOptions();
75			$configured = array_intersect_key($options, array_flip($possible));
76
77			foreach ($configured as $key => $value) {
78			$this->$key = $value;
79			}
80
81			// Remove all options that are only used locally
82			$options = array_diff_key($options, $configured);
83
84			parent::__construct($options, $collaborators);
85			}
86
87			/**
88			* Returns all options that can be configured.
89			*
90			* @return array
91			*/
92			protected function getConfigurableOptions()
93			{
94			return array_merge($this->getRequiredOptions(), [
95			'accessTokenMethod',
96			'accessTokenResourceOwnerId',
97			'scopeSeparator',
98			'responseError',
99			'responseCode',
100			'responseResourceOwnerId',
101			'scopes',
102			]);
103			}
104
105			/**
106			* Returns all options that are required.
107			*
108			* @return array
109			*/
110			protected function getRequiredOptions()
111			{
112			return ['url'];
113			}
114
115			/**
116			* Verifies that all required options have been passed.
117			*
118			* @param array $options
119			* @return void
120			* @throws InvalidArgumentException
121			*/
122			private function assertRequiredOptions(array $options)
123			{
124			$missing = array_diff_key(array_flip($this->getRequiredOptions()), $options);
125
126			if (!empty($missing)) {
127			throw new InvalidArgumentException(
128			'Required options not defined: ' . implode(', ', array_keys($missing))
129			);
130			}
131			}
132
133			/**
134			* @inheritdoc
135			*/
136			public function getBaseAuthorizationUrl()
137			{
138			return $this->url . "oauth/v2/authorize";
139			}
140
141			/**
142			* @inheritdoc
143			*/
144			public function getBaseAccessTokenUrl(array $params)
145			{
146			return $this->url . "oauth/v2/token";
147			}
148
149			/**
150			* @inheritdoc
151			*/
152			public function getResourceOwnerDetailsUrl(AccessToken $token)
153			{
154			return $this->url . "api/users/me";
155			}
156
157			/**
158			* @inheritdoc
159			*/
160			public function getDefaultScopes()
161			{
162			return $this->scopes;
163			}
164
165			/**
166			* @inheritdoc
167			*/
168			protected function getAccessTokenMethod()
169			{
170			return $this->accessTokenMethod ?: parent::getAccessTokenMethod();
171			}
172
173			/**
174			* @inheritdoc
175			*/
176			protected function getAccessTokenResourceOwnerId()
177			{
178			return $this->accessTokenResourceOwnerId ?: parent::getAccessTokenResourceOwnerId();
179			}
180
181			/**
182			* @inheritdoc
183			*/
184			protected function getScopeSeparator()
185			{
186			return $this->scopeSeparator ?: parent::getScopeSeparator();
187			}
188
189			/**
190			* @inheritdoc
191			*/
192			protected function checkResponse(ResponseInterface $response, $data)
193			{
194			if (!empty($data[$this->responseError])) {
195			$error = $data[$this->responseError];
196			$code = $this->responseCode ? $data[$this->responseCode] : 0;
197			throw new IdentityProviderException($error, $code, $data);
198			}
199			}
200
201			/**
202			* @inheritdoc
203			*/
204			protected function createResourceOwner(array $response, AccessToken $token)
205			{
206			return new ResourceOwner($response, $this->responseResourceOwnerId);
207			}
208			}
209

gctools-outilsgc / gcconnex

Push — add-pleio-mod ( 6d68a5 )

Provider::getResourceOwnerDetailsUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like