AccessToken::setScope() - Code Metrics - fkooman/php-oauth2-client - Measure and Improve Code Quality continuously with Scrutinizer

AccessToken::setScope() A
last analyzed 2017-09-01 21:26 UTC

↳ Parent: AccessToken

Complexity

Conditions	4
Paths	3

Size

Total Lines	15
Code Lines	7

Duplication

Lines	15
Ratio	100 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	15
loc	15
rs	9.2
cc	4
eloc	7
nc	3
nop	1

<?php

/**
 * Copyright (c) 2016, 2017 François Kooman <[email protected]>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace fkooman\OAuth\Client;

use DateInterval;
use DateTime;
use fkooman\OAuth\Client\Exception\AccessTokenException;

class AccessToken
{
    /** @var string */
    private $providerId;

    /** @var \DateTime */
    private $issuedAt;

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

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

    /** @var int|null */
    private $expiresIn = null;

    /** @var string|null */
    private $refreshToken = null;

    /** @var string|null */
    private $scope = null;

    /**
     * @param array $tokenData
     */
    public function __construct(array $tokenData)
    {
        $requiredKeys = ['provider_id', 'issued_at', 'access_token', 'token_type'];
        foreach ($requiredKeys as $requiredKey) {
            if (!array_key_exists($requiredKey, $tokenData)) {
                throw new AccessTokenException(sprintf('missing key "%s"', $requiredKey));
            }
        }

        // set required keys
        $this->setProviderId($tokenData['provider_id']);
        $this->setIssuedAt($tokenData['issued_at']);
        $this->setAccessToken($tokenData['access_token']);
        $this->setTokenType($tokenData['token_type']);

        // set optional keys
        if (array_key_exists('expires_in', $tokenData)) {
            $this->setExpiresIn($tokenData['expires_in']);
        }
        if (array_key_exists('refresh_token', $tokenData)) {
            $this->setRefreshToken($tokenData['refresh_token']);
        }
        if (array_key_exists('scope', $tokenData)) {
            $this->setScope($tokenData['scope']);
        }
    }

    /**
     * @param Provider  $provider
     * @param \DateTime $dateTime
     * @param array     $tokenData
     * @param string    $scope
     */
    public static function fromCodeResponse(Provider $provider, DateTime $dateTime, array $tokenData, $scope)
    {
        $tokenData['provider_id'] = $provider->getProviderId();

        // if the scope was not part of the response, add the request scope,
        // because according to the RFC, if the scope is ommitted the requested
        // scope was granted!
        if (!array_key_exists('scope', $tokenData)) {
            $tokenData['scope'] = $scope;
        }
        // add the current DateTime as well to be able to figure out if the
        // token expired
        $tokenData['issued_at'] = $dateTime->format('Y-m-d H:i:s');

        return new self($tokenData);
    }

    /**
     * @param Provider    $provider
     * @param \DateTime   $dateTime
     * @param array       $tokenData
     * @param AccessToken $accessToken to steal the old scope and refresh_token from!
     */
    public static function fromRefreshResponse(Provider $provider, DateTime $dateTime, array $tokenData, AccessToken $accessToken)
    {
        $tokenData['provider_id'] = $provider->getProviderId();

        // if the scope is not part of the response, add the request scope,
        // because according to the RFC, if the scope is ommitted the requested
        // scope was granted!
        if (!array_key_exists('scope', $tokenData)) {
            $tokenData['scope'] = $accessToken->getScope();
        }
        // if the refresh_token is not part of the response, we wil reuse the
        // existing refresh_token for future refresh_token requests
        if (!array_key_exists('refresh_token', $tokenData)) {
            $tokenData['refresh_token'] = $accessToken->getRefreshToken();
        }
        // add the current DateTime as well to be able to figure out if the
        // token expired
        $tokenData['issued_at'] = $dateTime->format('Y-m-d H:i:s');

        return new self($tokenData);
    }

    public function getProviderId()
    {
        return $this->providerId;
    }

    /**
     * @return \DateTime
     */
    public function getIssuedAt()
    {
        return $this->issuedAt;
    }

    /**
     * @return string
     *
     * @see https://tools.ietf.org/html/rfc6749#section-5.1
     */
    public function getToken()
    {
        return $this->accessToken;
    }

    /**
     * @return string
     *
     * @see https://tools.ietf.org/html/rfc6749#section-7.1
     */
    public function getTokenType()
    {
        return $this->tokenType;
    }

    /**
     * @return int|null
     *
     * @see https://tools.ietf.org/html/rfc6749#section-5.1
     */
    public function getExpiresIn()
    {
        return $this->expiresIn;
    }

    /**
     * @return string|null the refresh token
     *
     * @see https://tools.ietf.org/html/rfc6749#section-1.5
     */
    public function getRefreshToken()
    {
        return $this->refreshToken;
    }

    /**
     * @return string|null
     *
     * @see https://tools.ietf.org/html/rfc6749#section-3.3
     */
    public function getScope()
    {
        return $this->scope;
    }

    /**
     * @param \DateTime $dateTime
     *
     * @return bool
     */
    public function isExpired(DateTime $dateTime)
    {
        if (is_null($this->getExpiresIn())) {
            // if no expiry was indicated, assume it is valid
            return false;
        }

        // check to see if issuedAt + expiresIn > provided DateTime
        $issuedAt = clone $this->issuedAt; // XXX do we need to clone here?
        $expiresAt = date_add($issuedAt, new DateInterval(sprintf('PT%dS', $this->getExpiresIn())));

        return $dateTime >= $expiresAt;
    }

    /**
     * @param string $jsonString
     */
    public static function fromJson($jsonString)
    {
        $tokenData = json_decode($jsonString, true);
        if (is_null($tokenData) && JSON_ERROR_NONE !== json_last_error()) {

            $errorMsg = function_exists('json_last_error_msg') ? json_last_error_msg() : json_last_error();
            throw new AccessTokenException(sprintf('unable to decode JSON from storage: %s', $errorMsg));
        }

        return new self($tokenData);
    }

    /**
     * @return string
     */
    public function toJson()
    {
        return json_encode(
            [
                'provider_id' => $this->getProviderId(),
                'issued_at' => $this->issuedAt->format('Y-m-d H:i:s'),
                'access_token' => $this->getToken(),
                'token_type' => $this->getTokenType(),
                'expires_in' => $this->getExpiresIn(),
                'refresh_token' => $this->getRefreshToken(),
                'scope' => $this->getScope(),
            ]
        );
    }

    /**
     * @param string $providerId
     */
    private function setProviderId($providerId)
    {
        $this->providerId = $providerId;
    }

    /**
     * @param string $issuedAt
     */
    private function setIssuedAt($issuedAt)
    {
        self::requireString('expires_at', $issuedAt);
        if (1 !== preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$/', $issuedAt)) {
            throw new AccessTokenException('invalid "expires_at"');
        }
        $this->issuedAt = new DateTime($issuedAt);
    }

    /**
     * @param string $accessToken
     */
    private function setAccessToken($accessToken)
    {
        self::requireString('access_token', $accessToken);
        // access-token = 1*VSCHAR
        // VSCHAR       = %x20-7E
        if (1 !== preg_match('/^[\x20-\x7E]+$/', $accessToken)) {
            throw new AccessTokenException('invalid "access_token"');
        }
        $this->accessToken = $accessToken;
    }

    /**
     * @param string $tokenType
     */
    private function setTokenType($tokenType)
    {
        self::requireString('token_type', $tokenType);
        if ('bearer' !== $tokenType) {
            throw new AccessTokenException('unsupported "token_type"');
        }
        $this->tokenType = $tokenType;
    }

    /**
     * @param int|null $expiresIn
     */
    private function setExpiresIn($expiresIn)
    {
        if (!is_null($expiresIn)) {
            self::requireInt('expires_in', $expiresIn);
            if (0 >= $expiresIn) {
                throw new AccessTokenException('invalid "expires_in"');
            }
        }
        $this->expiresIn = $expiresIn;
    }

    /**
     * @param string|null $refreshToken
     */
    private function setRefreshToken($refreshToken)

    {
        if (!is_null($refreshToken)) {
            self::requireString('refresh_token', $refreshToken);
            // refresh-token = 1*VSCHAR
            // VSCHAR        = %x20-7E
            if (1 !== preg_match('/^[\x20-\x7E]+$/', $refreshToken)) {
                throw new AccessTokenException('invalid "refresh_token"');
            }
        }
        $this->refreshToken = $refreshToken;
    }

    /**
     * @param string|null $scope
     */
    private function setScope($scope)

    {
        if (!is_null($scope)) {
            self::requireString('scope', $scope);
            // scope       = scope-token *( SP scope-token )
            // scope-token = 1*NQCHAR
            // NQCHAR      = %x21 / %x23-5B / %x5D-7E
            foreach (explode(' ', $scope) as $scopeToken) {
                if (1 !== preg_match('/^[\x21\x23-\x5B\x5D-\x7E]+$/', $scopeToken)) {
                    throw new AccessTokenException('invalid "scope"');
                }
            }
        }
        $this->scope = $scope;
    }

    /**
     * @param string $k
     * @param string $v
     */
    private static function requireString($k, $v)
    {
        if (!is_string($v)) {
            throw new AccessTokenException(sprintf('"%s" must be string', $k));
        }
    }

    /**
     * @param string $k
     * @param int    $v
     */
    private static function requireInt($k, $v)
    {
        if (!is_int($v)) {
            throw new AccessTokenException(sprintf('"%s" must be int', $k));
        }
    }
}


1		<?php
2
3		/**
4		* Copyright (c) 2016, 2017 François Kooman <[email protected]>.
5		*
6		* Permission is hereby granted, free of charge, to any person obtaining a copy
7		* of this software and associated documentation files (the "Software"), to deal
8		* in the Software without restriction, including without limitation the rights
9		* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10		* copies of the Software, and to permit persons to whom the Software is
11		* furnished to do so, subject to the following conditions:
12		*
13		* The above copyright notice and this permission notice shall be included in all
14		* copies or substantial portions of the Software.
15		*
16		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22		* SOFTWARE.
23		*/
24
25		namespace fkooman\OAuth\Client;
26
27		use DateInterval;
28		use DateTime;
29		use fkooman\OAuth\Client\Exception\AccessTokenException;
30
31		class AccessToken
32		{
33		/** @var string */
34		private $providerId;
35
36		/** @var \DateTime */
37		private $issuedAt;
38
39		/** @var string */
40		private $accessToken;
41
42		/** @var string */
43		private $tokenType;
44
45		/** @var int\|null */
46		private $expiresIn = null;
47
48		/** @var string\|null */
49		private $refreshToken = null;
50
51		/** @var string\|null */
52		private $scope = null;
53
54		/**
55		* @param array $tokenData
56		*/
57		public function __construct(array $tokenData)
58		{
59		$requiredKeys = ['provider_id', 'issued_at', 'access_token', 'token_type'];
60		foreach ($requiredKeys as $requiredKey) {
61		if (!array_key_exists($requiredKey, $tokenData)) {
62		throw new AccessTokenException(sprintf('missing key "%s"', $requiredKey));
63		}
64		}
65
66		// set required keys
67		$this->setProviderId($tokenData['provider_id']);
68		$this->setIssuedAt($tokenData['issued_at']);
69		$this->setAccessToken($tokenData['access_token']);
70		$this->setTokenType($tokenData['token_type']);
71
72		// set optional keys
73		if (array_key_exists('expires_in', $tokenData)) {
74		$this->setExpiresIn($tokenData['expires_in']);
75		}
76		if (array_key_exists('refresh_token', $tokenData)) {
77		$this->setRefreshToken($tokenData['refresh_token']);
78		}
79		if (array_key_exists('scope', $tokenData)) {
80		$this->setScope($tokenData['scope']);
81		}
82		}
83
84		/**
85		* @param Provider $provider
86		* @param \DateTime $dateTime
87		* @param array $tokenData
88		* @param string $scope
89		*/
90		public static function fromCodeResponse(Provider $provider, DateTime $dateTime, array $tokenData, $scope)
91		{
92		$tokenData['provider_id'] = $provider->getProviderId();
93
94		// if the scope was not part of the response, add the request scope,
95		// because according to the RFC, if the scope is ommitted the requested
96		// scope was granted!
97		if (!array_key_exists('scope', $tokenData)) {
98		$tokenData['scope'] = $scope;
99		}
100		// add the current DateTime as well to be able to figure out if the
101		// token expired
102		$tokenData['issued_at'] = $dateTime->format('Y-m-d H:i:s');
103
104		return new self($tokenData);
105		}
106
107		/**
108		* @param Provider $provider
109		* @param \DateTime $dateTime
110		* @param array $tokenData
111		* @param AccessToken $accessToken to steal the old scope and refresh_token from!
112		*/
113		public static function fromRefreshResponse(Provider $provider, DateTime $dateTime, array $tokenData, AccessToken $accessToken)
114		{
115		$tokenData['provider_id'] = $provider->getProviderId();
116
117		// if the scope is not part of the response, add the request scope,
118		// because according to the RFC, if the scope is ommitted the requested
119		// scope was granted!
120		if (!array_key_exists('scope', $tokenData)) {
121		$tokenData['scope'] = $accessToken->getScope();
122		}
123		// if the refresh_token is not part of the response, we wil reuse the
124		// existing refresh_token for future refresh_token requests
125		if (!array_key_exists('refresh_token', $tokenData)) {
126		$tokenData['refresh_token'] = $accessToken->getRefreshToken();
127		}
128		// add the current DateTime as well to be able to figure out if the
129		// token expired
130		$tokenData['issued_at'] = $dateTime->format('Y-m-d H:i:s');
131
132		return new self($tokenData);
133		}
134
135		public function getProviderId()
136		{
137		return $this->providerId;
138		}
139
140		/**
141		* @return \DateTime
142		*/
143		public function getIssuedAt()
144		{
145		return $this->issuedAt;
146		}
147
148		/**
149		* @return string
150		*
151		* @see https://tools.ietf.org/html/rfc6749#section-5.1
152		*/
153		public function getToken()
154		{
155		return $this->accessToken;
156		}
157
158		/**
159		* @return string
160		*
161		* @see https://tools.ietf.org/html/rfc6749#section-7.1
162		*/
163		public function getTokenType()
164		{
165		return $this->tokenType;
166		}
167
168		/**
169		* @return int\|null
170		*
171		* @see https://tools.ietf.org/html/rfc6749#section-5.1
172		*/
173		public function getExpiresIn()
174		{
175		return $this->expiresIn;
176		}
177
178		/**
179		* @return string\|null the refresh token
180		*
181		* @see https://tools.ietf.org/html/rfc6749#section-1.5
182		*/
183		public function getRefreshToken()
184		{
185		return $this->refreshToken;
186		}
187
188		/**
189		* @return string\|null
190		*
191		* @see https://tools.ietf.org/html/rfc6749#section-3.3
192		*/
193		public function getScope()
194		{
195		return $this->scope;
196		}
197
198		/**
199		* @param \DateTime $dateTime
200		*
201		* @return bool
202		*/
203		public function isExpired(DateTime $dateTime)
204		{
205		if (is_null($this->getExpiresIn())) {
206		// if no expiry was indicated, assume it is valid
207		return false;
208		}
209
210		// check to see if issuedAt + expiresIn > provided DateTime
211		$issuedAt = clone $this->issuedAt; // XXX do we need to clone here?
212		$expiresAt = date_add($issuedAt, new DateInterval(sprintf('PT%dS', $this->getExpiresIn())));
213
214		return $dateTime >= $expiresAt;
215		}
216
217		/**
218		* @param string $jsonString
219		*/
220		public static function fromJson($jsonString)
221		{
222		$tokenData = json_decode($jsonString, true);
223	View Code Duplication	if (is_null($tokenData) && JSON_ERROR_NONE !== json_last_error()) {
		0 ignored issues – show Duplication introduced 2017-04-22 22:22 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
224		$errorMsg = function_exists('json_last_error_msg') ? json_last_error_msg() : json_last_error();
225		throw new AccessTokenException(sprintf('unable to decode JSON from storage: %s', $errorMsg));
226		}
227
228		return new self($tokenData);
229		}
230
231		/**
232		* @return string
233		*/
234		public function toJson()
235		{
236		return json_encode(
237		[
238		'provider_id' => $this->getProviderId(),
239		'issued_at' => $this->issuedAt->format('Y-m-d H:i:s'),
240		'access_token' => $this->getToken(),
241		'token_type' => $this->getTokenType(),
242		'expires_in' => $this->getExpiresIn(),
243		'refresh_token' => $this->getRefreshToken(),
244		'scope' => $this->getScope(),
245		]
246		);
247		}
248
249		/**
250		* @param string $providerId
251		*/
252		private function setProviderId($providerId)
253		{
254		$this->providerId = $providerId;
255		}
256
257		/**
258		* @param string $issuedAt
259		*/
260		private function setIssuedAt($issuedAt)
261		{
262		self::requireString('expires_at', $issuedAt);
263		if (1 !== preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$/', $issuedAt)) {
264		throw new AccessTokenException('invalid "expires_at"');
265		}
266		$this->issuedAt = new DateTime($issuedAt);
267		}
268
269		/**
270		* @param string $accessToken
271		*/
272		private function setAccessToken($accessToken)
273		{
274		self::requireString('access_token', $accessToken);
275		// access-token = 1*VSCHAR
276		// VSCHAR = %x20-7E
277		if (1 !== preg_match('/^[\x20-\x7E]+$/', $accessToken)) {
278		throw new AccessTokenException('invalid "access_token"');
279		}
280		$this->accessToken = $accessToken;
281		}
282
283		/**
284		* @param string $tokenType
285		*/
286		private function setTokenType($tokenType)
287		{
288		self::requireString('token_type', $tokenType);
289		if ('bearer' !== $tokenType) {
290		throw new AccessTokenException('unsupported "token_type"');
291		}
292		$this->tokenType = $tokenType;
293		}
294
295		/**
296		* @param int\|null $expiresIn
297		*/
298		private function setExpiresIn($expiresIn)
299		{
300		if (!is_null($expiresIn)) {
301		self::requireInt('expires_in', $expiresIn);
302		if (0 >= $expiresIn) {
303		throw new AccessTokenException('invalid "expires_in"');
304		}
305		}
306		$this->expiresIn = $expiresIn;
307		}
308
309		/**
310		* @param string\|null $refreshToken
311		*/
312	View Code Duplication	private function setRefreshToken($refreshToken)
		0 ignored issues – show Duplication introduced 2017-09-01 21:26 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
313		{
314		if (!is_null($refreshToken)) {
315		self::requireString('refresh_token', $refreshToken);
316		// refresh-token = 1*VSCHAR
317		// VSCHAR = %x20-7E
318		if (1 !== preg_match('/^[\x20-\x7E]+$/', $refreshToken)) {
319		throw new AccessTokenException('invalid "refresh_token"');
320		}
321		}
322		$this->refreshToken = $refreshToken;
323		}
324
325		/**
326		* @param string\|null $scope
327		*/
328	View Code Duplication	private function setScope($scope)
		0 ignored issues – show Duplication introduced 2017-09-01 21:26 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
329		{
330		if (!is_null($scope)) {
331		self::requireString('scope', $scope);
332		// scope = scope-token *( SP scope-token )
333		// scope-token = 1*NQCHAR
334		// NQCHAR = %x21 / %x23-5B / %x5D-7E
335		foreach (explode(' ', $scope) as $scopeToken) {
336		if (1 !== preg_match('/^[\x21\x23-\x5B\x5D-\x7E]+$/', $scopeToken)) {
337		throw new AccessTokenException('invalid "scope"');
338		}
339		}
340		}
341		$this->scope = $scope;
342		}
343
344		/**
345		* @param string $k
346		* @param string $v
347		*/
348		private static function requireString($k, $v)
349		{
350		if (!is_string($v)) {
351		throw new AccessTokenException(sprintf('"%s" must be string', $k));
352		}
353		}
354
355		/**
356		* @param string $k
357		* @param int $v
358		*/
359		private static function requireInt($k, $v)
360		{
361		if (!is_int($v)) {
362		throw new AccessTokenException(sprintf('"%s" must be int', $k));
363		}
364		}
365		}
366

fkooman / php-oauth2-client

GitHub Access Token became invalid

AccessToken::setScope() A last analyzed 2017-09-01 21:26 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AccessToken::setScope() A
last analyzed 2017-09-01 21:26 UTC