Spotify::__construct() - Code Metrics - ker0x/oauth2-spotify - Measure and Improve Code Quality continuously with Scrutinizer

Spotify::__construct() A
last analyzed 2020-11-19 00:23 UTC

↳ Parent: Spotify

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	3

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Kerox\OAuth2\Client\Provider;

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

class Spotify extends AbstractProvider
{
    use BearerAuthorizationTrait;

    public const BASE_SPOTIFY_URL = 'https://accounts.spotify.com/';
    public const RESPONSE_TYPE = 'code';

    // Available scopes.

    // Images
    public const SCOPE_UGC_IMAGE_UPLOAD = 'ugc-image-upload';

    // Spotify Connect
    public const SCOPE_USER_MODIFY_PLAYBACK_STATE = 'user-modify-playback-state';
    public const SCOPE_USER_READ_PLAYBACK_STATE = 'user-read-playback-state';
    public const SCOPE_USER_READ_CURRENTLY_PLAYING = 'user-read-currently-playing';

    // Listening History
    public const SCOPE_USER_TOP_READ = 'user-top-read';
    public const SCOPE_USER_READ_RECENTLY_PLAYED = 'user-read-recently-played';

    // Library
    public const SCOPE_USER_LIBRARY_MODIFY = 'user-library-modify';
    public const SCOPE_USER_LIBRARY_READ = 'user-library-read';

    // Follow
    public const SCOPE_USER_FOLLOW_MODIFY = 'user-follow-modify';
    public const SCOPE_USER_FOLLOW_READ = 'user-follow-read';

    // Playlist
    public const SCOPE_PLAYLIST_READ_PRIVATE = 'playlist-read-private';
    public const SCOPE_PLAYLIST_MODIFY_PUBLIC = 'playlist-modify-public';
    public const SCOPE_PLAYLIST_MODIFY_PRIVATE = 'playlist-modify-private';
    public const SCOPE_PLAYLIST_READ_COLLABORATIVE = 'playlist-read-collaborative';

    // User
    public const SCOPE_USER_READ_PRIVATE = 'user-read-private';
    public const SCOPE_USER_READ_EMAIL = 'user-read-email';

    // Playback
    public const SCOPE_APP_REMOTE_CONTROL = 'app-remote-control';
    public const SCOPE_STREAMING = 'streaming';

    public function __construct(array $options = [], array $collaborators = [])
    {
        if (!isset($options['responseType']) || $options['responseType'] !== self::RESPONSE_TYPE) {
            $options['responseType'] = self::RESPONSE_TYPE;
        }

        parent::__construct($options, $collaborators);
    }

    /**
     * Returns the base URL for authorizing a client.
     */
    public function getBaseAuthorizationUrl(): string
    {
        return self::BASE_SPOTIFY_URL . 'authorize';
    }

    /**
     * Returns the base URL for requesting an access token.
     */
    public function getBaseAccessTokenUrl(array $params): string
    {
        return self::BASE_SPOTIFY_URL . 'api/token';
    }

    /**
     * Returns the URL for requesting the resource owner's details.
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token): string
    {
        return 'https://api.spotify.com/v1/me';
    }

    /**
     * Returns the default scopes used by this provider.
     *
     * This should only be the scopes that are required to request the details
     * of the resource owner, rather than all the available scopes.
     */
    protected function getDefaultScopes(): array
    {
        return [];
    }

    /**
     * Checks a provider response for errors.
     *
     * @param array|string $data Parsed response data
     *
     * @throws IdentityProviderException
     */
    protected function checkResponse(ResponseInterface $response, $data): void
    {
        if ($response->getStatusCode() >= 400) {
            $error = $data['error_description'] ?? $data['error'] ?? $response->getReasonPhrase();
            $statusCode = $response->getStatusCode();

            if (\is_array($data['error'])) {
                $error = $data['error']['message'];
                $statusCode = $data['error']['status'];
            }

            throw new SpotifyIdentityProviderException($error, $statusCode, $response);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * Generates a resource owner object from a successful resource owner
     * details request.
     */
    protected function createResourceOwner(array $response, AccessToken $token): ResourceOwnerInterface
    {
        return new SpotifyResourceOwner($response);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Kerox\OAuth2\Client\Provider;
6
7		use Kerox\OAuth2\Client\Provider\Exception\SpotifyIdentityProviderException;
8		use League\OAuth2\Client\Provider\AbstractProvider;
9		use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
10		use League\OAuth2\Client\Provider\ResourceOwnerInterface;
11		use League\OAuth2\Client\Token\AccessToken;
12		use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
13		use Psr\Http\Message\ResponseInterface;
14
15		class Spotify extends AbstractProvider
16		{
17		use BearerAuthorizationTrait;
18
19		public const BASE_SPOTIFY_URL = 'https://accounts.spotify.com/';
20		public const RESPONSE_TYPE = 'code';
21
22		// Available scopes.
23
24		// Images
25		public const SCOPE_UGC_IMAGE_UPLOAD = 'ugc-image-upload';
26
27		// Spotify Connect
28		public const SCOPE_USER_MODIFY_PLAYBACK_STATE = 'user-modify-playback-state';
29		public const SCOPE_USER_READ_PLAYBACK_STATE = 'user-read-playback-state';
30		public const SCOPE_USER_READ_CURRENTLY_PLAYING = 'user-read-currently-playing';
31
32		// Listening History
33		public const SCOPE_USER_TOP_READ = 'user-top-read';
34		public const SCOPE_USER_READ_RECENTLY_PLAYED = 'user-read-recently-played';
35
36		// Library
37		public const SCOPE_USER_LIBRARY_MODIFY = 'user-library-modify';
38		public const SCOPE_USER_LIBRARY_READ = 'user-library-read';
39
40		// Follow
41		public const SCOPE_USER_FOLLOW_MODIFY = 'user-follow-modify';
42		public const SCOPE_USER_FOLLOW_READ = 'user-follow-read';
43
44		// Playlist
45		public const SCOPE_PLAYLIST_READ_PRIVATE = 'playlist-read-private';
46		public const SCOPE_PLAYLIST_MODIFY_PUBLIC = 'playlist-modify-public';
47		public const SCOPE_PLAYLIST_MODIFY_PRIVATE = 'playlist-modify-private';
48		public const SCOPE_PLAYLIST_READ_COLLABORATIVE = 'playlist-read-collaborative';
49
50		// User
51		public const SCOPE_USER_READ_PRIVATE = 'user-read-private';
52		public const SCOPE_USER_READ_EMAIL = 'user-read-email';
53
54		// Playback
55		public const SCOPE_APP_REMOTE_CONTROL = 'app-remote-control';
56		public const SCOPE_STREAMING = 'streaming';
57
58		public function __construct(array $options = [], array $collaborators = [])
59		{
60		if (!isset($options['responseType']) \|\| $options['responseType'] !== self::RESPONSE_TYPE) {
61	8	$options['responseType'] = self::RESPONSE_TYPE;
62		}
63	8
64	1	parent::__construct($options, $collaborators);
65		}
66
67	8	/**
68	8	* Returns the base URL for authorizing a client.
69		*/
70		public function getBaseAuthorizationUrl(): string
71		{
72		return self::BASE_SPOTIFY_URL . 'authorize';
73	2	}
74
75	2	/**
76		* Returns the base URL for requesting an access token.
77		*/
78		public function getBaseAccessTokenUrl(array $params): string
79		{
80		return self::BASE_SPOTIFY_URL . 'api/token';
81	2	}
82
83	2	/**
84		* Returns the URL for requesting the resource owner's details.
85		*/
86		public function getResourceOwnerDetailsUrl(AccessToken $token): string
87		{
88		return 'https://api.spotify.com/v1/me';
89	1	}
90
91	1	/**
92		* Returns the default scopes used by this provider.
93		*
94		* This should only be the scopes that are required to request the details
95		* of the resource owner, rather than all the available scopes.
96		*/
97		protected function getDefaultScopes(): array
98		{
99		return [];
100	2	}
101
102	2	/**
103		* Checks a provider response for errors.
104		*
105		* @param array\|string $data Parsed response data
106		*
107		* @throws IdentityProviderException
108		*/
109		protected function checkResponse(ResponseInterface $response, $data): void
110		{
111		if ($response->getStatusCode() >= 400) {
112	3	$error = $data['error_description'] ?? $data['error'] ?? $response->getReasonPhrase();
113		$statusCode = $response->getStatusCode();
114	3
115	2	if (\is_array($data['error'])) {
116	2	$error = $data['error']['message'];
117		$statusCode = $data['error']['status'];
118	2	}
119	1
120	1	throw new SpotifyIdentityProviderException($error, $statusCode, $response);
		0 ignored issues – show Documentation introduced 2020-03-03 09:16 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...
121		}
122		}
123	2
124		/**
125	1	* Generates a resource owner object from a successful resource owner
126		* details request.
127		*/
128		protected function createResourceOwner(array $response, AccessToken $token): ResourceOwnerInterface
129		{
130		return new SpotifyResourceOwner($response);
131	1	}
132		}
133

ker0x / oauth2-spotify

Spotify::__construct() A last analyzed 2020-11-19 00:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Spotify::__construct() A
last analyzed 2020-11-19 00:23 UTC