QueryParam::authenticate() - Code Metrics - Inspection of "Refactoring and cleanup" - yiisoft/auth - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#18)

by Alexander

created 2020-08-24 20:09 UTC

QueryParam::authenticate() A

↳ Parent: QueryParam

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Auth\Method;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Yiisoft\Auth\AuthenticationMethodInterface;
use Yiisoft\Auth\IdentityInterface;
use Yiisoft\Auth\IdentityRepositoryInterface;

/**
 * QueryParam supports the authentication based on the access token passed through a query parameter.
 */
final class QueryParam implements AuthenticationMethodInterface
{
    private const TOKEN_PARAMETER_NAME = 'access-token';
    /**
     * @var string the parameter name for passing the access token
     */
    private string $tokenParameterName = self::TOKEN_PARAMETER_NAME;

    private IdentityRepositoryInterface $identityRepository;

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

    public function authenticate(ServerRequestInterface $request): ?IdentityInterface
    {
        $accessToken = $request->getQueryParams()[$this->tokenParameterName] ?? null;
        if (is_string($accessToken)) {
            return $this->identityRepository->findIdentityByToken($accessToken, get_class($this));
        }

        return null;
    }

    public function challenge(ResponseInterface $response): ResponseInterface
    {
        return $response;
    }

    public function withTokenParameterName(string $name): self
    {
        $new = clone $this;
        $new->tokenParameterName = $name;
        return $new;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Auth\Method;
6
7		use Psr\Http\Message\ResponseInterface;
8		use Psr\Http\Message\ServerRequestInterface;
9		use Yiisoft\Auth\AuthenticationMethodInterface;
10		use Yiisoft\Auth\IdentityInterface;
11		use Yiisoft\Auth\IdentityRepositoryInterface;
12
13		/**
14		* QueryParam supports the authentication based on the access token passed through a query parameter.
15		*/
16		final class QueryParam implements AuthenticationMethodInterface
17		{
18		private const TOKEN_PARAMETER_NAME = 'access-token';
19		/**
20		* @var string the parameter name for passing the access token
21		*/
22		private string $tokenParameterName = self::TOKEN_PARAMETER_NAME;
23
24		private IdentityRepositoryInterface $identityRepository;
25
26	8	public function __construct(IdentityRepositoryInterface $identityRepository)
27		{
28	8	$this->identityRepository = $identityRepository;
29	8	}
30
31	6	public function authenticate(ServerRequestInterface $request): ?IdentityInterface
32		{
33	6	$accessToken = $request->getQueryParams()[$this->tokenParameterName] ?? null;
34	6	if (is_string($accessToken)) {
35	5	return $this->identityRepository->findIdentityByToken($accessToken, get_class($this));
36		}
37
38	3	return null;
39		}
40
41	2	public function challenge(ResponseInterface $response): ResponseInterface
42		{
43	2	return $response;
44		}
45
46	1	public function withTokenParameterName(string $name): self
47		{
48	1	$new = clone $this;
49	1	$new->tokenParameterName = $name;
50	1	return $new;
51		}
52		}
53

yiisoft / auth

Pull Request — master (#18)

QueryParam::authenticate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like