Service::authenticate() - Code Metrics - php-opencloud/openstack - Measure and Improve Code Quality continuously with Scrutinizer

Service::authenticate() A
last analyzed 2017-12-19 03:52 UTC

↳ Parent: Service

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	17
ccs	8
cts	8
cp	1
rs	9.4285
cc	1
eloc	10
nc	1
nop	1
crap	1

<?php declare(strict_types=1);

namespace OpenStack\Identity\v2;

use GuzzleHttp\ClientInterface;
use OpenStack\Common\Auth\IdentityService;
use OpenStack\Common\Service\AbstractService;
use OpenStack\Identity\v2\Models\Catalog;
use OpenStack\Identity\v2\Models\Token;

/**
 * Represents the OpenStack Identity v2 service.
 *
 * @property \OpenStack\Identity\v2\Api $api
 */
class Service extends AbstractService implements IdentityService
{
    public static function factory(ClientInterface $client): self
    {
        return new static($client, new Api());
    }

    public function authenticate(array $options = []): array
    {
        $definition = $this->api->postToken();

        $response = $this->execute($definition, array_intersect_key($options, $definition['params']));

        $token = $this->model(Token::class, $response);

        $serviceUrl = $this->model(Catalog::class, $response)->getServiceUrl(
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $options['catalogName'],
            $options['catalogType'],
            $options['region'],
            $options['urlType']
        );

        return [$token, $serviceUrl];
    }

    /**
     * Generates a new authentication token
     *
     * @param array $options {@see \OpenStack\Identity\v2\Api::postToken}
     *
     * @return Models\Token
     */
    public function generateToken(array $options = []): Token
    {
        $response = $this->execute($this->api->postToken(), $options);
        return $this->model(Token::class, $response);
    }
}


GitHub Access Token became invalid

Service::authenticate() A
last analyzed 2017-12-19 03:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

1		<?php declare(strict_types=1);
2
3		namespace OpenStack\Identity\v2;
4
5		use GuzzleHttp\ClientInterface;
6		use OpenStack\Common\Auth\IdentityService;
7		use OpenStack\Common\Service\AbstractService;
8		use OpenStack\Identity\v2\Models\Catalog;
9		use OpenStack\Identity\v2\Models\Token;
10
11		/**
12		* Represents the OpenStack Identity v2 service.
13		*
14		* @property \OpenStack\Identity\v2\Api $api
15		*/
16		class Service extends AbstractService implements IdentityService
17	1	{
18		public static function factory(ClientInterface $client): self
19	1	{
20		return new static($client, new Api());
21	1	}
22
23	1	public function authenticate(array $options = []): array
24		{
25	1	$definition = $this->api->postToken();
26	1
27	1	$response = $this->execute($definition, array_intersect_key($options, $definition['params']));
28	1
29	1	$token = $this->model(Token::class, $response);
30	1
31		$serviceUrl = $this->model(Catalog::class, $response)->getServiceUrl(
		0 ignored issues – show Bug introduced 2015-11-23 10:33 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OpenStack\Common\Resource\ResourceInterface` as the method `getServiceUrl()` does only exist in the following implementations of said interface: `OpenStack\Identity\v2\Models\Catalog`, `OpenStack\Identity\v3\Models\Catalog`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
32	1	$options['catalogName'],
33		$options['catalogType'],
34		$options['region'],
35		$options['urlType']
36		);
37
38		return [$token, $serviceUrl];
39		}
40
41		/**
42	1	* Generates a new authentication token
43		*
44	1	* @param array $options {@see \OpenStack\Identity\v2\Api::postToken}
45	1	*
46		* @return Models\Token
47		*/
48		public function generateToken(array $options = []): Token
49		{
50		$response = $this->execute($this->api->postToken(), $options);
51		return $this->model(Token::class, $response);
52		}
53		}
54

php-opencloud / openstack

GitHub Access Token became invalid

Service::authenticate() A last analyzed 2017-12-19 03:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Service::authenticate() A
last analyzed 2017-12-19 03:52 UTC