Github::checkResponse() - Code Metrics - Inspection of "Update code organization for checkResponse" - thephpleague/oauth2-github - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a47a6...2fc2a6 )

by Steven

created 2016-04-14 01:36 UTC

Github::checkResponse() A

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes	4
Bugs	0	Features	1

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

<?php

namespace League\OAuth2\Client\Provider;

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

class Github extends AbstractProvider
{
    use BearerAuthorizationTrait;

    /**
     * Domain
     *
     * @var string
     */
    public $domain = 'https://github.com';

    /**
     * Api domain
     *
     * @var string
     */
    public $apiDomain = 'https://api.github.com';

    /**
     * Get authorization url to begin OAuth flow
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        return $this->domain.'/login/oauth/authorize';
    }

    /**
     * Get access token url to retrieve token
     *
     * @param  array $params
     *
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return $this->domain.'/login/oauth/access_token';
    }

    /**
     * Get provider url to fetch user details
     *
     * @param  AccessToken $token
     *
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        if ($this->domain === 'https://github.com') {
            return $this->apiDomain.'/user';
        }
        return $this->domain.'/api/v3/user';
    }

    /**
     * Get the default scopes used by this provider.
     *
     * This should not be a complete list of all scopes, but the minimum
     * required for the provider user interface!
     *
     * @return array
     */
    protected function getDefaultScopes()
    {
        return [];
    }

    /**
     * Check a provider response for errors.
     *
     * @link   https://developer.github.com/v3/#client-errors
     * @throws IdentityProviderException
     * @param  ResponseInterface $response
     * @param  string $data Parsed response data
     * @return void
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        if ($response->getStatusCode() >= 400) {
            $errorMessage = isset($data['message']) ? $data['message'] : $response->getReasonPhrase();
            throw new IdentityProviderException($errorMessage, $response->getStatusCode(), $response);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } elseif (isset($data['error'], $data['error_description'])) {
            $errorMessage = $data['error'] . ': ' . $data['error_description'];
            throw new IdentityProviderException($errorMessage, $response->getStatusCode(), $response);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    /**
     * Generate a user object from a successful user details request.
     *
     * @param array $response
     * @param AccessToken $token
     * @return League\OAuth2\Client\Provider\ResourceOwnerInterface
     */
    protected function createResourceOwner(array $response, AccessToken $token)
    {
        $user = new GithubResourceOwner($response);

        return $user->setDomain($this->domain);
    }
}


1		<?php
2
3		namespace League\OAuth2\Client\Provider;
4
5		use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
6		use League\OAuth2\Client\Token\AccessToken;
7		use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
8		use Psr\Http\Message\ResponseInterface;
9
10		class Github extends AbstractProvider
11		{
12		use BearerAuthorizationTrait;
13
14		/**
15		* Domain
16		*
17		* @var string
18		*/
19		public $domain = 'https://github.com';
20
21		/**
22		* Api domain
23		*
24		* @var string
25		*/
26		public $apiDomain = 'https://api.github.com';
27
28		/**
29		* Get authorization url to begin OAuth flow
30		*
31		* @return string
32		*/
33	12	public function getBaseAuthorizationUrl()
34		{
35	12	return $this->domain.'/login/oauth/authorize';
36		}
37
38		/**
39		* Get access token url to retrieve token
40		*
41		* @param array $params
42		*
43		* @return string
44		*/
45	18	public function getBaseAccessTokenUrl(array $params)
46		{
47	18	return $this->domain.'/login/oauth/access_token';
48		}
49
50		/**
51		* Get provider url to fetch user details
52		*
53		* @param AccessToken $token
54		*
55		* @return string
56		*/
57	6	public function getResourceOwnerDetailsUrl(AccessToken $token)
58		{
59	6	if ($this->domain === 'https://github.com') {
60	3	return $this->apiDomain.'/user';
61		}
62	3	return $this->domain.'/api/v3/user';
63		}
64
65		/**
66		* Get the default scopes used by this provider.
67		*
68		* This should not be a complete list of all scopes, but the minimum
69		* required for the provider user interface!
70		*
71		* @return array
72		*/
73	6	protected function getDefaultScopes()
74		{
75	6	return [];
76		}
77
78		/**
79		* Check a provider response for errors.
80		*
81		* @link https://developer.github.com/v3/#client-errors
82		* @throws IdentityProviderException
83		* @param ResponseInterface $response
84		* @param string $data Parsed response data
85		* @return void
86		*/
87	15	protected function checkResponse(ResponseInterface $response, $data)
88		{
89	15	if ($response->getStatusCode() >= 400) {
90	3	$errorMessage = isset($data['message']) ? $data['message'] : $response->getReasonPhrase();
91	3	throw new IdentityProviderException($errorMessage, $response->getStatusCode(), $response);
		0 ignored issues – show Documentation introduced 2016-04-14 01:33 UTC by Report Bug Copy Issue Report `$response` is of type `object<Psr\Http\Message\ResponseInterface>`, but the function expects a `array\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
92	12	} elseif (isset($data['error'], $data['error_description'])) {
93	3	$errorMessage = $data['error'] . ': ' . $data['error_description'];
94	3	throw new IdentityProviderException($errorMessage, $response->getStatusCode(), $response);
		0 ignored issues – show Documentation introduced 2016-04-14 01:38 UTC by Report Bug Copy Issue Report `$response` is of type `object<Psr\Http\Message\ResponseInterface>`, but the function expects a `array\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
95		}
96	9	}
97
98		/**
99		* Generate a user object from a successful user details request.
100		*
101		* @param array $response
102		* @param AccessToken $token
103		* @return League\OAuth2\Client\Provider\ResourceOwnerInterface
104		*/
105	3	protected function createResourceOwner(array $response, AccessToken $token)
106		{
107	3	$user = new GithubResourceOwner($response);
108
109	3	return $user->setDomain($this->domain);
110		}
111		}
112

thephpleague / oauth2-github

Push — master ( 6a47a6...2fc2a6 )

Github::checkResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like