Pelmered\LaravelHttpOAuthHelper\Options

Complexity

Total Complexity

6

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Test Coverage

Coverage

94.87%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	3	1
A	__construct()	0	11	1
A	getScopes()	0	3	1
A	make()	0	6	1
A	getDefaults()	0	9	1
A	validateOptions()	0	23	1

<?php

namespace Pelmered\LaravelHttpOAuthHelper;

use Closure;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

class Options
{
    /**
     * @param  array<string>  $scopes
     */
    final public function __construct(
        public array $scopes = [],
        public string $authType = Credentials::AUTH_TYPE_BASIC, //TODO: Which auth type should be default?
        public string $grantType = Credentials::GRANT_TYPE_CLIENT_CREDENTIALS,
        public string $tokenType = AccessToken::TYPE_BEARER,
        public string $tokenName = 'token',
        public int|string|Closure $expires = 3600,
        public string|Closure $accessToken = 'access_token',
        public ?Closure $tokenTypeCustomCallback = null,
    ) {
        $this->validateOptions();
    }

    /*
    public function __get($name)
    {
        return $this->$name;
    }
    */

    /**
     * @return array<string, string>
     */
    public function toArray(): array
    {
        return get_object_vars($this);
    }

    protected function validateOptions(): void
    {
        // Note: closures can't be checked at this point since we don't have access to the response objects
        Validator::make((array) $this, [
            'scopes.*' => 'string',
            'authType' => Rule::in([
                Credentials::AUTH_TYPE_BEARER,
                Credentials::AUTH_TYPE_BODY,
                Credentials::AUTH_TYPE_QUERY,
                Credentials::AUTH_TYPE_BASIC,
                Credentials::AUTH_TYPE_CUSTOM,
            ]),
            'grantType' => Rule::in([
                Credentials::GRANT_TYPE_CLIENT_CREDENTIALS,
                Credentials::GRANT_TYPE_PASSWORD_CREDENTIALS,
            ]),
            'tokenType' => Rule::in([
                AccessToken::TYPE_BEARER,
                AccessToken::TYPE_QUERY,
                AccessToken::TYPE_CUSTOM,
            ]),
            'tokenName' => 'string',
        ])->validate();
    }

    public function getScopes(): string
    {
        return implode(' ', $this->scopes);
    }

    /**
     * @param  array<string, mixed>  ...$parameters
     */
    public static function make(...$parameters): static
    {
        $defaults = static::getDefaults();
        $options  = array_merge($defaults, ...$parameters);

        return new static(...$options);

$options is expanded, but the parameter $scopes of Pelmered\LaravelHttpOAuthHelper\Options::__construct() does not expect variable arguments.

    }

    /**
     * @return array<string, mixed>
     */
    protected static function getDefaults(): array
    {
        return [
            'scopes'      => [],
            'grantType'   => Credentials::GRANT_TYPE_CLIENT_CREDENTIALS,
            'tokenType'   => AccessToken::TYPE_BEARER,
            'authType'    => Credentials::AUTH_TYPE_BASIC,
            'expires'     => 3600,
            'accessToken' => 'access_token',
        ];
    }
}