PassportSettings::getTokenCustomPropertiesProvider() - Code Metrics - Inspection of "Add ordering for scopes and clients URIs to MySql..." - limoncello-php-dist/passport - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 739d01...5ed129 )

by Neomerx

created 2017-10-29 22:36 UTC

kenCustomPropertiesProvider() A

↳ Parent: PassportSettings::get()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php namespace Limoncello\Passport\Package;

/**
 * Copyright 2015-2017 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Contracts\Settings\SettingsInterface;
use Limoncello\Core\Reflection\CheckCallableTrait;
use Limoncello\Passport\Contracts\Entities\TokenInterface;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface;
use ReflectionParameter;

/**
 * @package Limoncello\Passport
 */
class PassportSettings implements SettingsInterface
{
    use CheckCallableTrait;

    /** Config key */
    const KEY_IS_LOG_ENABLED = 0;

    /** Config key */
    const KEY_APPROVAL_URI_STRING = self::KEY_IS_LOG_ENABLED + 1;

    /** Config key */
    const KEY_ERROR_URI_STRING = self::KEY_APPROVAL_URI_STRING + 1;

    /** Config key */
    const KEY_DEFAULT_CLIENT_ID = self::KEY_ERROR_URI_STRING + 1;

    /** Config key */
    const KEY_CODE_EXPIRATION_TIME_IN_SECONDS = self::KEY_DEFAULT_CLIENT_ID + 1;

    /** Config key */
    const KEY_TOKEN_EXPIRATION_TIME_IN_SECONDS = self::KEY_CODE_EXPIRATION_TIME_IN_SECONDS + 1;

    /** Config key */
    const KEY_RENEW_REFRESH_VALUE_ON_TOKEN_REFRESH = self::KEY_TOKEN_EXPIRATION_TIME_IN_SECONDS + 1;

    /** Config key */
    const KEY_USER_TABLE_NAME = self::KEY_RENEW_REFRESH_VALUE_ON_TOKEN_REFRESH + 1;

    /** Config key */
    const KEY_USER_PRIMARY_KEY_NAME = self::KEY_USER_TABLE_NAME + 1;

    /**
     * Config key
     *
     * Value should be a static callable for user credentials validator (login and password).
     *
     * Examples ['SomeNamespace\ClassName', 'staticMethodName'] or 'SomeNamespace\ClassName::staticMethodName'
     *
     * Method signature
     *
     * public static function validateUser(ContainerInterface $container, string $userName, string $password)
     *
     * which returns either user ID (int|string) or null if user not found/invalid credentials.
     */
    const KEY_USER_CREDENTIALS_VALIDATOR = self::KEY_USER_PRIMARY_KEY_NAME + 1;

    /** Config key */
    const KEY_FAILED_CUSTOM_UNAUTHENTICATED_FACTORY = self::KEY_USER_CREDENTIALS_VALIDATOR + 1;

    /**
     * Config key
     *
     * Value should be a static callable for user scope validator (allowed scope identities).
     *
     * Examples ['SomeNamespace\ClassName', 'staticMethodName'] or 'SomeNamespace\ClassName::staticMethodName'
     *
     * Method signature
     *
     * public static function validateScope(ContainerInterface $container, int $userId, array $scopeIds = null): ?array
     *
     * which returns either changed allowed scope IDs or null if scope was not changed or throws auth exception.
     */
    const KEY_USER_SCOPE_VALIDATOR = self::KEY_FAILED_CUSTOM_UNAUTHENTICATED_FACTORY + 1;

    /**
     * Config key
     *
     * A custom properties provider for auth token. All the values returned from the provider
     * will be added to the token.
     *
     * Value should be a static callable.
     *
     * Examples ['SomeNamespace\ClassName', 'staticMethodName'] or 'SomeNamespace\ClassName::staticMethodName'
     *
     * Method signature
     *
     * public static function getExtraProps(ContainerInterface $container, TokenInterface $token): array
     */
    const KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER = self::KEY_USER_SCOPE_VALIDATOR + 1;

    /** Config key */
    const KEY_LAST = self::KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER;

    /**
     * @inheritdoc
     */
    final public function get(): array
    {
        $defaults = $this->getSettings();

        $credentialsValidator = $defaults[static::KEY_USER_CREDENTIALS_VALIDATOR];
        assert(
            $this->checkPublicStaticCallable(
                $credentialsValidator,
                [ContainerInterface::class, 'string', 'string']
            ),
            "Invalid credentials validator."
        );

        $scopeValidator = $defaults[static::KEY_USER_SCOPE_VALIDATOR] ?? null;
        assert(
            $this->checkPublicStaticCallable(
                $scopeValidator,
                [
                    ContainerInterface::class,
                    'int',
                    function (ReflectionParameter $parameter) {
                        return $parameter->allowsNull() === true && $parameter->isArray() === true;
                    },
                ]
            ),
            "Invalid scope validator."
        );

        $customPropsProvider = $defaults[static::KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER] ?? null;
        assert(
            $customPropsProvider === null ||
            $this->checkPublicStaticCallable(
                $customPropsProvider,
                [ContainerInterface::class, TokenInterface::class],
                'array'
            ),
            "Invalid token custom properties provider."
        );

        $customUnAuthFactory = $defaults[static::KEY_FAILED_CUSTOM_UNAUTHENTICATED_FACTORY] ?? null;
        assert(
            $customUnAuthFactory === null ||
            $this->checkPublicStaticCallable(
                $customUnAuthFactory,
                [],
                ResponseInterface::class
            ),
            "Invalid custom factory."
        );

        $approvalUri = $defaults[static::KEY_APPROVAL_URI_STRING];
        assert(empty($approvalUri) === false, "Invalid Approval URI `$approvalUri`.");

        $errorUri = $defaults[static::KEY_ERROR_URI_STRING];
        assert(empty($errorUri) === false, "Invalid Error URI `$errorUri`.");

        $defaultClientId = $defaults[static::KEY_DEFAULT_CLIENT_ID];
        assert(empty($defaultClientId) === false, "Invalid Default Client ID `$defaultClientId`.");

        $userTable = $defaults[static::KEY_USER_TABLE_NAME];
        assert(empty($userTable) === false, "Invalid User Table Name `$userTable`.");

        $userPk = $defaults[static::KEY_USER_TABLE_NAME];
        assert(empty($userPk) === false, "Invalid User Primary Key Name `$userPk`.");

        return $defaults + [
                static::KEY_APPROVAL_URI_STRING              => $approvalUri,
                static::KEY_ERROR_URI_STRING                 => $errorUri,
                static::KEY_DEFAULT_CLIENT_ID                => $defaultClientId,
                static::KEY_USER_TABLE_NAME                  => $userTable,
                static::KEY_USER_PRIMARY_KEY_NAME            => $userPk,
                static::KEY_USER_CREDENTIALS_VALIDATOR       => $credentialsValidator,
                static::KEY_USER_SCOPE_VALIDATOR             => $scopeValidator,
                static::KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER => $customPropsProvider,
            ];
    }

    /**
     * @return array
     */
    protected function getSettings(): array
    {
        return [
            static::KEY_IS_LOG_ENABLED                       => false,
            static::KEY_CODE_EXPIRATION_TIME_IN_SECONDS      => 10 * 60,
            static::KEY_TOKEN_EXPIRATION_TIME_IN_SECONDS     => 60 * 60,
            static::KEY_RENEW_REFRESH_VALUE_ON_TOKEN_REFRESH => true,
        ];
    }
}


1		<?php namespace Limoncello\Passport\Package;
2
3		/**
4		* Copyright 2015-2017 [email protected]
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		use Limoncello\Contracts\Settings\SettingsInterface;
20		use Limoncello\Core\Reflection\CheckCallableTrait;
21		use Limoncello\Passport\Contracts\Entities\TokenInterface;
22		use Psr\Container\ContainerInterface;
23		use Psr\Http\Message\ResponseInterface;
24		use ReflectionParameter;
25
26		/**
27		* @package Limoncello\Passport
28		*/
29		class PassportSettings implements SettingsInterface
30		{
31		use CheckCallableTrait;
32
33		/** Config key */
34		const KEY_IS_LOG_ENABLED = 0;
35
36		/** Config key */
37		const KEY_APPROVAL_URI_STRING = self::KEY_IS_LOG_ENABLED + 1;
38
39		/** Config key */
40		const KEY_ERROR_URI_STRING = self::KEY_APPROVAL_URI_STRING + 1;
41
42		/** Config key */
43		const KEY_DEFAULT_CLIENT_ID = self::KEY_ERROR_URI_STRING + 1;
44
45		/** Config key */
46		const KEY_CODE_EXPIRATION_TIME_IN_SECONDS = self::KEY_DEFAULT_CLIENT_ID + 1;
47
48		/** Config key */
49		const KEY_TOKEN_EXPIRATION_TIME_IN_SECONDS = self::KEY_CODE_EXPIRATION_TIME_IN_SECONDS + 1;
50
51		/** Config key */
52		const KEY_RENEW_REFRESH_VALUE_ON_TOKEN_REFRESH = self::KEY_TOKEN_EXPIRATION_TIME_IN_SECONDS + 1;
53
54		/** Config key */
55		const KEY_USER_TABLE_NAME = self::KEY_RENEW_REFRESH_VALUE_ON_TOKEN_REFRESH + 1;
56
57		/** Config key */
58		const KEY_USER_PRIMARY_KEY_NAME = self::KEY_USER_TABLE_NAME + 1;
59
60		/**
61		* Config key
62		*
63		* Value should be a static callable for user credentials validator (login and password).
64		*
65		* Examples ['SomeNamespace\ClassName', 'staticMethodName'] or 'SomeNamespace\ClassName::staticMethodName'
66		*
67		* Method signature
68		*
69		* public static function validateUser(ContainerInterface $container, string $userName, string $password)
70		*
71		* which returns either user ID (int\|string) or null if user not found/invalid credentials.
72		*/
73		const KEY_USER_CREDENTIALS_VALIDATOR = self::KEY_USER_PRIMARY_KEY_NAME + 1;
74
75		/** Config key */
76		const KEY_FAILED_CUSTOM_UNAUTHENTICATED_FACTORY = self::KEY_USER_CREDENTIALS_VALIDATOR + 1;
77
78		/**
79		* Config key
80		*
81		* Value should be a static callable for user scope validator (allowed scope identities).
82		*
83		* Examples ['SomeNamespace\ClassName', 'staticMethodName'] or 'SomeNamespace\ClassName::staticMethodName'
84		*
85		* Method signature
86		*
87		* public static function validateScope(ContainerInterface $container, int $userId, array $scopeIds = null): ?array
88		*
89		* which returns either changed allowed scope IDs or null if scope was not changed or throws auth exception.
90		*/
91		const KEY_USER_SCOPE_VALIDATOR = self::KEY_FAILED_CUSTOM_UNAUTHENTICATED_FACTORY + 1;
92
93		/**
94		* Config key
95		*
96		* A custom properties provider for auth token. All the values returned from the provider
97		* will be added to the token.
98		*
99		* Value should be a static callable.
100		*
101		* Examples ['SomeNamespace\ClassName', 'staticMethodName'] or 'SomeNamespace\ClassName::staticMethodName'
102		*
103		* Method signature
104		*
105		* public static function getExtraProps(ContainerInterface $container, TokenInterface $token): array
106		*/
107		const KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER = self::KEY_USER_SCOPE_VALIDATOR + 1;
108
109		/** Config key */
110		const KEY_LAST = self::KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER;
111
112		/**
113		* @inheritdoc
114		*/
115	1	final public function get(): array
116		{
117	1	$defaults = $this->getSettings();
118
119	1	$credentialsValidator = $defaults[static::KEY_USER_CREDENTIALS_VALIDATOR];
120	1	assert(
121	1	$this->checkPublicStaticCallable(
122	1	$credentialsValidator,
123	1	[ContainerInterface::class, 'string', 'string']
124		),
125	1	"Invalid credentials validator."
126		);
127
128	1	$scopeValidator = $defaults[static::KEY_USER_SCOPE_VALIDATOR] ?? null;
129	1	assert(
130	1	$this->checkPublicStaticCallable(
131	1	$scopeValidator,
132		[
133	1	ContainerInterface::class,
134	1	'int',
135	1	function (ReflectionParameter $parameter) {
136	1	return $parameter->allowsNull() === true && $parameter->isArray() === true;
137	1	},
138		]
139		),
140	1	"Invalid scope validator."
141		);
142
143	1	$customPropsProvider = $defaults[static::KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER] ?? null;
144	1	assert(
145	1	$customPropsProvider === null \|\|
146	1	$this->checkPublicStaticCallable(
147	1	$customPropsProvider,
148	1	[ContainerInterface::class, TokenInterface::class],
149	1	'array'
150		),
151	1	"Invalid token custom properties provider."
152		);
153
154	1	$customUnAuthFactory = $defaults[static::KEY_FAILED_CUSTOM_UNAUTHENTICATED_FACTORY] ?? null;
155	1	assert(
156	1	$customUnAuthFactory === null \|\|
157	1	$this->checkPublicStaticCallable(
158	1	$customUnAuthFactory,
159	1	[],
160	1	ResponseInterface::class
161		),
162	1	"Invalid custom factory."
163		);
164
165	1	$approvalUri = $defaults[static::KEY_APPROVAL_URI_STRING];
166	1	assert(empty($approvalUri) === false, "Invalid Approval URI `$approvalUri`.");
167
168	1	$errorUri = $defaults[static::KEY_ERROR_URI_STRING];
169	1	assert(empty($errorUri) === false, "Invalid Error URI `$errorUri`.");
170
171	1	$defaultClientId = $defaults[static::KEY_DEFAULT_CLIENT_ID];
172	1	assert(empty($defaultClientId) === false, "Invalid Default Client ID `$defaultClientId`.");
173
174	1	$userTable = $defaults[static::KEY_USER_TABLE_NAME];
175	1	assert(empty($userTable) === false, "Invalid User Table Name `$userTable`.");
176
177	1	$userPk = $defaults[static::KEY_USER_TABLE_NAME];
178	1	assert(empty($userPk) === false, "Invalid User Primary Key Name `$userPk`.");
179
180		return $defaults + [
181	1	static::KEY_APPROVAL_URI_STRING => $approvalUri,
182	1	static::KEY_ERROR_URI_STRING => $errorUri,
183	1	static::KEY_DEFAULT_CLIENT_ID => $defaultClientId,
184	1	static::KEY_USER_TABLE_NAME => $userTable,
185	1	static::KEY_USER_PRIMARY_KEY_NAME => $userPk,
186	1	static::KEY_USER_CREDENTIALS_VALIDATOR => $credentialsValidator,
187	1	static::KEY_USER_SCOPE_VALIDATOR => $scopeValidator,
188	1	static::KEY_TOKEN_CUSTOM_PROPERTIES_PROVIDER => $customPropsProvider,
189		];
190		}
191
192		/**
193		* @return array
194		*/
195	1	protected function getSettings(): array
196		{
197		return [
198	1	static::KEY_IS_LOG_ENABLED => false,
199	1	static::KEY_CODE_EXPIRATION_TIME_IN_SECONDS => 10 * 60,
200	1	static::KEY_TOKEN_EXPIRATION_TIME_IN_SECONDS => 60 * 60,
201	1	static::KEY_RENEW_REFRESH_VALUE_ON_TOKEN_REFRESH => true,
202		];
203		}
204		}
205

limoncello-php-dist / passport

Push — master ( 739d01...5ed129 )

kenCustomPropertiesProvider() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like