OAuthProtocolHelper - Code Metrics - Inspection of "OAuth library switchout, minor tweaks" - enwikipedia-acc/waca - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — newinternal (#552)

by Simon

created 2020-05-29 22:02 UTC

OAuthProtocolHelper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	9
eloc	27
c	1
b	0
f	0
dl	0
loc	92
rs	10

6 Methods

Rating	Name	Size	Complexity
A	apiCall()	22	4
A	getIdentityTicket()	3	1
A	callbackCompleted()	5	1
A	getRequestToken()	6	1
A	getAuthoriseUrl()	3	1
A	__construct()	12	1

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Helpers;

use MediaWiki\OAuthClient\Client;
use MediaWiki\OAuthClient\ClientConfig;
use MediaWiki\OAuthClient\Consumer;
use MediaWiki\OAuthClient\Token;
use Waca\Exceptions\CurlException;

class OAuthProtocolHelper implements Interfaces\IOAuthProtocolHelper
{
    private $oauthClient;

    private $mediawikiWebServiceEndpoint;

    private $authUrl;

    /**
     * OAuthHelper constructor.
     *
     * @param string     $oauthEndpoint
     * @param string     $consumerKey
     * @param string     $consumerSecret
     * @param string     $mediawikiWebServiceEndpoint
     */
    public function __construct(
        $oauthEndpoint,
        $consumerKey,
        $consumerSecret,
        $mediawikiWebServiceEndpoint
    ) {
        $this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;

        $oauthClientConfig = new ClientConfig($oauthEndpoint);
        $oauthClientConfig->setConsumer(new Consumer($consumerKey, $consumerSecret));

        $this->oauthClient = new Client($oauthClientConfig);
    }

    /**
     * @inheritDoc
     */
    public function getRequestToken()
    {
        /** @var Token $requestToken */
        list($authUrl, $requestToken) = $this->oauthClient->initiate();
        $this->authUrl = $authUrl;
        return $requestToken;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * @inheritDoc
     */
    public function getAuthoriseUrl($requestToken)
    {
        return $this->authUrl;
    }

    /**
     * @inheritDoc
     */
    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
    {
        $requestToken = new Token($oauthRequestToken, $oauthRequestSecret);

        return $this->oauthClient->complete($requestToken, $oauthVerifier);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * @inheritDoc
     */
    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
    {
        return $this->oauthClient->identify(new Token($oauthAccessToken, $oauthAccessSecret));
    }

    /**
     * @inheritDoc
     */
    public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
    {
        $userToken = new Token($accessToken, $accessSecret);

        $apiParams['format'] = 'json';

        if ($apiParams === null || ! is_array($apiParams)) {
            throw new CurlException("Invalid API call");
        }

        $url = $this->mediawikiWebServiceEndpoint;
        $isPost = ($method === 'POST');

        if ($method === 'GET') {
            $query = http_build_query($apiParams);
            $url .= '?' . $query;
            $apiParams = null;
        }

        $data = $this->oauthClient->makeOAuthCall($userToken, $url, $isPost, $apiParams);

        return json_decode($data);
    }
}

1			<?php
2			/******************************************************************************
3			* Wikipedia Account Creation Assistance tool *
4			* *
5			* All code in this file is released into the public domain by the ACC *
6			* Development Team. Please see team.json for a list of contributors. *
7			******************************************************************************/
8
9			namespace Waca\Helpers;
10
11			use MediaWiki\OAuthClient\Client;
12			use MediaWiki\OAuthClient\ClientConfig;
13			use MediaWiki\OAuthClient\Consumer;
14			use MediaWiki\OAuthClient\Token;
15			use Waca\Exceptions\CurlException;
16
17			class OAuthProtocolHelper implements Interfaces\IOAuthProtocolHelper
18			{
19			private $oauthClient;
20
21			private $mediawikiWebServiceEndpoint;
22
23			private $authUrl;
24
25			/**
26			* OAuthHelper constructor.
27			*
28			* @param string $oauthEndpoint
29			* @param string $consumerKey
30			* @param string $consumerSecret
31			* @param string $mediawikiWebServiceEndpoint
32			*/
33			public function __construct(
34			$oauthEndpoint,
35			$consumerKey,
36			$consumerSecret,
37			$mediawikiWebServiceEndpoint
38			) {
39			$this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
40
41			$oauthClientConfig = new ClientConfig($oauthEndpoint);
42			$oauthClientConfig->setConsumer(new Consumer($consumerKey, $consumerSecret));
43
44			$this->oauthClient = new Client($oauthClientConfig);
45			}
46
47			/**
48			* @inheritDoc
49			*/
50			public function getRequestToken()
51			{
52			/** @var Token $requestToken */
53			list($authUrl, $requestToken) = $this->oauthClient->initiate();
54			$this->authUrl = $authUrl;
55			return $requestToken;
			0 ignored issues – show Bug Best Practice introduced 2020-05-29 00:09 UTC by Report Bug Copy Issue Report The expression `return $requestToken` returns the type `MediaWiki\OAuthClient\Token` which is incompatible with the return type mandated by `Waca\Helpers\Interfaces\...lper::getRequestToken()` of `stdClass`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
56			}
57
58			/**
59			* @inheritDoc
60			*/
61			public function getAuthoriseUrl($requestToken)
62			{
63			return $this->authUrl;
64			}
65
66			/**
67			* @inheritDoc
68			*/
69			public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
70			{
71			$requestToken = new Token($oauthRequestToken, $oauthRequestSecret);
72
73			return $this->oauthClient->complete($requestToken, $oauthVerifier);
			0 ignored issues – show Bug Best Practice introduced 2020-05-29 00:09 UTC by Report Bug Copy Issue Report The expression `return $this->oauthClien...tToken, $oauthVerifier)` returns the type `MediaWiki\OAuthClient\Token` which is incompatible with the return type mandated by `Waca\Helpers\Interfaces\...er::callbackCompleted()` of `stdClass`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
74			}
75
76			/**
77			* @inheritDoc
78			*/
79			public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
80			{
81			return $this->oauthClient->identify(new Token($oauthAccessToken, $oauthAccessSecret));
82			}
83
84			/**
85			* @inheritDoc
86			*/
87			public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
88			{
89			$userToken = new Token($accessToken, $accessSecret);
90
91			$apiParams['format'] = 'json';
92
93			if ($apiParams === null \|\| ! is_array($apiParams)) {
94			throw new CurlException("Invalid API call");
95			}
96
97			$url = $this->mediawikiWebServiceEndpoint;
98			$isPost = ($method === 'POST');
99
100			if ($method === 'GET') {
101			$query = http_build_query($apiParams);
102			$url .= '?' . $query;
103			$apiParams = null;
104			}
105
106			$data = $this->oauthClient->makeOAuthCall($userToken, $url, $isPost, $apiParams);
107
108			return json_decode($data);
109			}
110			}

enwikipedia-acc / waca

Pull Request — newinternal (#552)

OAuthProtocolHelper A

Complexity

Size/Duplication

Importance

6 Methods

Duplication Side-by-Side

Filter issues like