OAuth2Client::getAccessToken() - Code Metrics - Inspection of "bc fix" - ozo2003/HelperBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (a0cc06)

by Dāvis

created 2017-10-13 07:16 UTC

OAuth2Client::getAccessToken() B

↳ Parent: OAuth2Client

Complexity

Conditions	5
Paths	2

Size

Total Lines	21
Code Lines	13

Duplication

Lines	10
Ratio	47.62 %

Importance

Changes

Metric	Value
cc	5
eloc	13
nc	2
nop	1
dl	10
loc	21
rs	8.7624
c	0
b	0
f	0

<?php

namespace Sludio\HelperBundle\Oauth\Client;

use League\OAuth2\Client\Token\AccessToken;
use LogicException;
use Sludio\HelperBundle\Logger\SludioLogger;
use Sludio\HelperBundle\Oauth\Exception\InvalidStateException;
use Sludio\HelperBundle\Oauth\Exception\MissingAuthorizationCodeException;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\RequestStack;

class OAuth2Client
{
    const OAUTH2_SESSION_STATE_KEY = 'sludio_helper.oauth_client_state';

    protected $provider;
    protected $requestStack;
    protected $isStateless = true;
    protected $logger;

    public function __construct($provider, RequestStack $requestStack, SludioLogger $logger)
    {
        $this->provider = $provider;
        $this->requestStack = $requestStack;
        $this->logger = $logger;
    }

    public function setAsStateless()
    {
        $this->isStateless = true;
    }

    public function redirect(array $scopes = [], array $options = [], $token = null)

    {
        if (!empty($scopes)) {
            $options['scope'] = $scopes;
        }

        if ($token) {
            $options['token'] = $token;
        }

        $url = $this->provider->getAuthorizationUrl($options);

        if (!$this->isStateless) {
            $this->getSession()->set(self::OAUTH2_SESSION_STATE_KEY, $this->provider->getState());
        }

        return new RedirectResponse($url);
    }

    public function getAccessToken(array $attributes = [])
    {
        if (!$this->isStateless) {

            $expectedState = $this->getSession()->get(self::OAUTH2_SESSION_STATE_KEY);
            $actualState = $this->getCurrentRequest()->query->get('state');
            if (!$actualState || ($actualState !== $expectedState)) {
                $this->logger->error(__CLASS__.' ('.__LINE__.'): '.'Invalid state: '.var_export(var_export($actualState, 1).var_export($expectedState, 1), 1), 401);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
                throw new InvalidStateException('error_oauth_invalid_state');
            }
        }

        $code = $this->getCurrentRequest()->get('code');

        if (!$code) {
            $this->logger->error(__CLASS__.' ('.__LINE__.'): '.'No "code" parameter was found!', 401);
            throw new MissingAuthorizationCodeException('error_oauth_code_parameter_not_found');
        }

        return $this->provider->getAccessToken('authorization_code', [
            'code' => $code,
        ], $attributes);
    }

    public function fetchUserFromToken(AccessToken $accessToken)
    {
        return $this->provider->getResourceOwner($accessToken);
    }

    public function fetchUser(array $attributes = [])
    {
        $token = $this->getAccessToken($attributes);

        return $this->fetchUserFromToken($token);
    }

    public function getOAuth2Provider()
    {
        return $this->provider;
    }

    protected function getCurrentRequest()
    {
        $request = $this->requestStack->getCurrentRequest();

        if (!$request) {
            $this->logger->error(__CLASS__.' ('.__LINE__.'): '.'There is no "current request", and it is needed to perform this action', 400);
            throw new LogicException('error_oauth_current_request_not_found');
        }

        return $request;
    }

    protected function getSession()
    {
        $session = $this->getCurrentRequest()->getSession();

        if (!$session) {
            $this->logger->error(__CLASS__.' ('.__LINE__.'): '.'In order to use "state", you must have a session. Set the OAuth2Client to stateless to avoid stat$e', 400);
            throw new LogicException('error_oauth_session_not_found');
        }

        return $session;
    }
}


1		<?php
2
3		namespace Sludio\HelperBundle\Oauth\Client;
4
5		use League\OAuth2\Client\Token\AccessToken;
6		use LogicException;
7		use Sludio\HelperBundle\Logger\SludioLogger;
8		use Sludio\HelperBundle\Oauth\Exception\InvalidStateException;
9		use Sludio\HelperBundle\Oauth\Exception\MissingAuthorizationCodeException;
10		use Symfony\Component\HttpFoundation\RedirectResponse;
11		use Symfony\Component\HttpFoundation\RequestStack;
12
13		class OAuth2Client
14		{
15		const OAUTH2_SESSION_STATE_KEY = 'sludio_helper.oauth_client_state';
16
17		protected $provider;
18		protected $requestStack;
19		protected $isStateless = true;
20		protected $logger;
21
22		public function __construct($provider, RequestStack $requestStack, SludioLogger $logger)
23		{
24		$this->provider = $provider;
25		$this->requestStack = $requestStack;
26		$this->logger = $logger;
27		}
28
29		public function setAsStateless()
30		{
31		$this->isStateless = true;
32		}
33
34	View Code Duplication	public function redirect(array $scopes = [], array $options = [], $token = null)
		0 ignored issues – show Duplication introduced 2017-10-07 18:41 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...
35		{
36		if (!empty($scopes)) {
37		$options['scope'] = $scopes;
38		}
39
40		if ($token) {
41		$options['token'] = $token;
42		}
43
44		$url = $this->provider->getAuthorizationUrl($options);
45
46		if (!$this->isStateless) {
47		$this->getSession()->set(self::OAUTH2_SESSION_STATE_KEY, $this->provider->getState());
48		}
49
50		return new RedirectResponse($url);
51		}
52
53		public function getAccessToken(array $attributes = [])
54		{
55	View Code Duplication	if (!$this->isStateless) {
		0 ignored issues – show Duplication introduced 2017-10-07 18:41 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...
56		$expectedState = $this->getSession()->get(self::OAUTH2_SESSION_STATE_KEY);
57		$actualState = $this->getCurrentRequest()->query->get('state');
58		if (!$actualState \|\| ($actualState !== $expectedState)) {
59		$this->logger->error(__CLASS__.' ('.__LINE__.'): '.'Invalid state: '.var_export(var_export($actualState, 1).var_export($expectedState, 1), 1), 401);
		0 ignored issues – show Bug introduced 2017-10-12 11:53 UTC by Report Bug Copy Issue Report Are you sure the usage of `var_export($actualState, 1)` is correct as it seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history... Bug introduced 2017-10-12 11:53 UTC by Report Bug Copy Issue Report Are you sure the usage of `var_export(var_export($a...($expectedState, 1), 1)` is correct as it seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history... Bug introduced 2017-10-12 11:53 UTC by Report Bug Copy Issue Report Are you sure the usage of `var_export($expectedState, 1)` is correct as it seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
60		throw new InvalidStateException('error_oauth_invalid_state');
61		}
62		}
63
64		$code = $this->getCurrentRequest()->get('code');
65
66		if (!$code) {
67		$this->logger->error(__CLASS__.' ('.__LINE__.'): '.'No "code" parameter was found!', 401);
68		throw new MissingAuthorizationCodeException('error_oauth_code_parameter_not_found');
69		}
70
71		return $this->provider->getAccessToken('authorization_code', [
72		'code' => $code,
73		], $attributes);
74		}
75
76		public function fetchUserFromToken(AccessToken $accessToken)
77		{
78		return $this->provider->getResourceOwner($accessToken);
79		}
80
81		public function fetchUser(array $attributes = [])
82		{
83		$token = $this->getAccessToken($attributes);
84
85		return $this->fetchUserFromToken($token);
86		}
87
88		public function getOAuth2Provider()
89		{
90		return $this->provider;
91		}
92
93		protected function getCurrentRequest()
94		{
95		$request = $this->requestStack->getCurrentRequest();
96
97		if (!$request) {
98		$this->logger->error(__CLASS__.' ('.__LINE__.'): '.'There is no "current request", and it is needed to perform this action', 400);
99		throw new LogicException('error_oauth_current_request_not_found');
100		}
101
102		return $request;
103		}
104
105		protected function getSession()
106		{
107		$session = $this->getCurrentRequest()->getSession();
108
109		if (!$session) {
110		$this->logger->error(__CLASS__.' ('.__LINE__.'): '.'In order to use "state", you must have a session. Set the OAuth2Client to stateless to avoid stat$e', 400);
111		throw new LogicException('error_oauth_session_not_found');
112		}
113
114		return $session;
115		}
116		}
117

ozo2003 / HelperBundle

Branch — master (a0cc06)

OAuth2Client::getAccessToken() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like