Server::getTokenCredentials() - Code Metrics - Inspection of "Add the with & scopes methods for OAuth" - SocialiteProviders/Manager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 054f6d...b0bfec )

by Brian

created 2016-04-07 20:25 UTC

Server::getTokenCredentials() B

↳ Parent: Server

Complexity

Conditions	3
Paths	3

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	27
rs	8.8571
cc	3
eloc	15
nc	3
nop	3

<?php

namespace SocialiteProviders\Manager\OAuth1;

use GuzzleHttp\Exception\BadResponseException;
use League\OAuth1\Client\Credentials\TemporaryCredentials;
use League\OAuth1\Client\Credentials\TokenCredentials;

abstract class Server extends \League\OAuth1\Client\Server\Server
{
    /**
     * The custom parameters to be sent with the request.
     *
     * @var array
     */
    protected $parameters = [];

    /**
     * The scopes being requested.
     *
     * @var array
     */
    protected $scopes = [];

    /**
     * The separating character for the requested scopes.
     *
     * @var string
     */
    protected $scopeSeparator = ',';

    /**
     * Retrieves token credentials by passing in the temporary credentials,
     * the temporary credentials identifier as passed back by the server
     * and finally the verifier code.
     *
     * @param TemporaryCredentials $temporaryCredentials
     * @param string               $temporaryIdentifier
     * @param string               $verifier
     *
     * @return TokenCredentials
     */
    public function getTokenCredentials(TemporaryCredentials $temporaryCredentials, $temporaryIdentifier, $verifier)
    {
        if ($temporaryIdentifier !== $temporaryCredentials->getIdentifier()) {
            throw new \InvalidArgumentException(
                'Temporary identifier passed back by server does not match that of stored temporary credentials.
                Potential man-in-the-middle.'
            );
        }

        $uri = $this->urlTokenCredentials();
        $bodyParameters = array('oauth_verifier' => $verifier);

        $client = $this->createHttpClient();

        $headers = $this->getHeaders($temporaryCredentials, 'POST', $uri, $bodyParameters);

        try {
            $response = $client->post($uri, $headers, $bodyParameters)->send();
        } catch (BadResponseException $e) {
            return $this->handleTokenCredentialsBadResponse($e);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'tokenCredentials' => $this->createTokenCredentials($response->getBody()),
            'credentialsResponseBody' => $response->getBody(),
        ];
    }

    /**
     * Set the scopes of the requested access.
     *
     * @param  array  $scopes
     * @return $this
     */
    public function scopes(array $scopes)
    {
        $this->scopes = array_unique(array_merge($this->scopes, $scopes));

        return $this;
    }

    /**
     * Set the custom parameters of the request.
     *
     * @param  array  $parameters
     * @return $this
     */
    public function with(array $parameters)
    {
        $this->parameters = $parameters;

        return $this;
    }
    
    /**
     * Format the given scopes.
     *
     * @param  array  $scopes
     * @param  string  $scopeSeparator
     * @return string
     */
    protected function formatScopes(array $scopes, $scopeSeparator)
    {
        return implode($scopeSeparator, $scopes);
    }
}


1			<?php
2
3			namespace SocialiteProviders\Manager\OAuth1;
4
5			use GuzzleHttp\Exception\BadResponseException;
6			use League\OAuth1\Client\Credentials\TemporaryCredentials;
7			use League\OAuth1\Client\Credentials\TokenCredentials;
8
9			abstract class Server extends \League\OAuth1\Client\Server\Server
10			{
11			/**
12			* The custom parameters to be sent with the request.
13			*
14			* @var array
15			*/
16			protected $parameters = [];
17
18			/**
19			* The scopes being requested.
20			*
21			* @var array
22			*/
23			protected $scopes = [];
24
25			/**
26			* The separating character for the requested scopes.
27			*
28			* @var string
29			*/
30			protected $scopeSeparator = ',';
31
32			/**
33			* Retrieves token credentials by passing in the temporary credentials,
34			* the temporary credentials identifier as passed back by the server
35			* and finally the verifier code.
36			*
37			* @param TemporaryCredentials $temporaryCredentials
38			* @param string $temporaryIdentifier
39			* @param string $verifier
40			*
41			* @return TokenCredentials
42			*/
43			public function getTokenCredentials(TemporaryCredentials $temporaryCredentials, $temporaryIdentifier, $verifier)
44			{
45			if ($temporaryIdentifier !== $temporaryCredentials->getIdentifier()) {
46			throw new \InvalidArgumentException(
47			'Temporary identifier passed back by server does not match that of stored temporary credentials.
48			Potential man-in-the-middle.'
49			);
50			}
51
52			$uri = $this->urlTokenCredentials();
53			$bodyParameters = array('oauth_verifier' => $verifier);
54
55			$client = $this->createHttpClient();
56
57			$headers = $this->getHeaders($temporaryCredentials, 'POST', $uri, $bodyParameters);
58
59			try {
60			$response = $client->post($uri, $headers, $bodyParameters)->send();
61			} catch (BadResponseException $e) {
62			return $this->handleTokenCredentialsBadResponse($e);
			0 ignored issues – show Documentation introduced 2016-03-28 21:33 UTC by Report Bug Copy Issue Report `$e` is of type `object<GuzzleHttp\Exception\BadResponseException>`, but the function expects a `object<Guzzle\Http\Excep...n\BadResponseException>`. 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...
63			}
64
65			return [
			0 ignored issues – show Bug Best Practice introduced 2016-03-28 21:33 UTC by Report Bug Copy Issue Report The return type of `return array('tokenCrede... $response->getBody());` (`array`) is incompatible with the return type of the parent method `League\OAuth1\Client\Ser...er::getTokenCredentials` of type `League\OAuth1\Client\Credentials\TokenCredentials`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
66			'tokenCredentials' => $this->createTokenCredentials($response->getBody()),
67			'credentialsResponseBody' => $response->getBody(),
68			];
69			}
70
71			/**
72			* Set the scopes of the requested access.
73			*
74			* @param array $scopes
75			* @return $this
76			*/
77			public function scopes(array $scopes)
78			{
79			$this->scopes = array_unique(array_merge($this->scopes, $scopes));
80
81			return $this;
82			}
83
84			/**
85			* Set the custom parameters of the request.
86			*
87			* @param array $parameters
88			* @return $this
89			*/
90			public function with(array $parameters)
91			{
92			$this->parameters = $parameters;
93
94			return $this;
95			}
96
97			/**
98			* Format the given scopes.
99			*
100			* @param array $scopes
101			* @param string $scopeSeparator
102			* @return string
103			*/
104			protected function formatScopes(array $scopes, $scopeSeparator)
105			{
106			return implode($scopeSeparator, $scopes);
107			}
108			}
109

SocialiteProviders / Manager

Push — master ( 054f6d...b0bfec )

Server::getTokenCredentials() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like