OAuth\OAuth2\Service\BattleNet

Complexity

Total Complexity

16

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	4
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	2
B	GetOAuthBaseUri()	0	13	7
A	getAuthorizationEndpoint()	0	3	1
A	getAccessTokenEndpoint()	0	3	1
A	getAuthorizationMethod()	0	4	1
A	parseAccessTokenResponse()	0	21	4

<?php

namespace OAuth\OAuth2\Service;

//-----------------------------------------------------------------------------
use OAuth\OAuth2\Token\StdOAuth2Token;
use OAuth\Common\Http\Exception\TokenResponseException;
use OAuth\Common\Http\Uri\Uri;
use OAuth\Common\Consumer\CredentialsInterface;
use OAuth\Common\Http\Client\ClientInterface;
use OAuth\Common\Storage\TokenStorageInterface;
use OAuth\Common\Http\Uri\UriInterface;

//-----------------------------------------------------------------------------
class BattleNet extends AbstractService { 
    
    /** -----------------------------------------------------------------------
     * Defined scopes.
     *
     * @link https://dev.battle.net/docs
     */
    const SCOPE_WOW_PROFILE = "wow.profile";
    const SCOPE_SC2_PROFILE = "sc2.profile";
    
    /** -----------------------------------------------------------------------
     * Defined API URIs.
     *
     * @link https://dev.battle.net/docs
     */
    const API_URI_US  = 'https://us.api.battle.net/';
    const API_URI_EU  = 'https://eu.api.battle.net/';
    const API_URI_KR  = 'https://kr.api.battle.net/';
    const API_URI_TW  = 'https://tw.api.battle.net/';
    const API_URI_CN  = 'https://api.battlenet.com.cn/';
    const API_URI_SEA = 'https://sea.api.battle.net/';
    
    public function __construct( CredentialsInterface $credentials,

The first parameter of a multi-line function declaration must be on the line after the opening bracket

                                 ClientInterface $httpClient,

Multi-line function declaration not indented correctly; expected 8 spaces but found 33

                                 TokenStorageInterface $storage,

Multi-line function declaration not indented correctly; expected 8 spaces but found 33

                                 $scopes = array(),

Multi-line function declaration not indented correctly; expected 8 spaces but found 33

                                 UriInterface $baseApiUri = null ) {

Multi-line function declaration not indented correctly; expected 8 spaces but found 33

The closing parenthesis of a multi-line function declaration must be on a new line

                                 
        parent::__construct( $credentials, $httpClient, $storage, 
                             $scopes, $baseApiUri );
        
        if( $baseApiUri === null ) {

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

            $this->baseApiUri = new Uri( self::API_URI_US );
        }
    }
    
    /** -----------------------------------------------------------------------
     * Translates the current base API URI into an OAuth base URI. 
     *
     * @returns string Base URI of oauth services.
     */
    private function GetOAuthBaseUri() {

Method name "BattleNet::GetOAuthBaseUri" is not in camel caps format

    
        // i love china
        switch( $this->baseApiUri ) {

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after SWITCH keyword; 0 found

            case self::API_URI_US:  return 'https://us.battle.net/oauth/';

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case self::API_URI_EU:  return 'https://eu.battle.net/oauth/';

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case self::API_URI_KR:  return 'https://kr.battle.net/oauth/';

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case self::API_URI_TW:  return 'https://tw.battle.net/oauth/';

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case self::API_URI_CN:  return 'https://www.battlenet.com.cn/oauth/';

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case self::API_URI_SEA: return 'https://sea.battle.net/oauth/'; 

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

        }
        
    }
    
    /** -----------------------------------------------------------------------
     * {@inheritdoc}
     */
    public function getAuthorizationEndpoint() {
        return new Uri( $this->GetOAuthBaseUri() . 'authorize' );
    }
    
    /** -----------------------------------------------------------------------
     * {@inheritdoc}
     */
    public function getAccessTokenEndpoint() {
        return new Uri( $this->GetOAuthBaseUri() . 'token' );
    }
    
    /** -----------------------------------------------------------------------
     * {@inheritdoc}
     */
    protected function getAuthorizationMethod()
    {
        return static::AUTHORIZATION_METHOD_QUERY_STRING;
    }
    
    /** -----------------------------------------------------------------------
     * {@inheritdoc}
     */
    protected function parseAccessTokenResponse( $responseBody )

Expected 0 spaces between opening bracket and argument "$responseBody"; 1 found

Expected 0 spaces between argument "$responseBody" and closing bracket; 1 found

    {
        $data = json_decode($responseBody, true);
        if( $data === null || !is_array($data) ) {

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

            throw new TokenResponseException( 'Unable to parse response.' );
        } elseif( isset($data['error']) ) {

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after ELSEIF keyword; 0 found

            $err = $data['error'];
            throw new TokenResponseException( 
                                "Error in retrieving token: \"$err\"" );
        }
        
        $token = new StdOAuth2Token( $data['access_token'], null, 
                                     $data['expires_in'] );
        
        unset( $data['access_token'] );
        unset( $data['expires_in'] );
        
        $token->setExtraParams( $data );
        
        return $token;
    }
}