ApiClients\Client\Travis\ApiSettings

Complexity

Total Complexity

2

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getOptions()	0	24	2

<?php declare(strict_types=1);

namespace ApiClients\Client\Travis;

use ApiClients\Foundation\Hydrator\Options as HydratorOptions;
use ApiClients\Foundation\Options as FoundationOptions;
use ApiClients\Foundation\Transport\Options as TransportOptions;
use ApiClients\Middleware\Json\JsonDecodeMiddleware;
use ApiClients\Middleware\Json\JsonEncodeMiddleware;
use ApiClients\Middleware\TokenAuthorization\Options as TokenAuthorizationHeaderMiddlewareOptions;
use ApiClients\Middleware\TokenAuthorization\TokenAuthorizationHeaderMiddleware;
use ApiClients\Middleware\UserAgent\Options as UserAgentMiddlewareOptions;
use ApiClients\Middleware\UserAgent\UserAgentMiddleware;
use ApiClients\Middleware\UserAgent\UserAgentStrategies;
use function ApiClients\Foundation\options_merge;

final class ApiSettings
{
    /**
     * Travis' Pusher App ID as found on: https://docs.travis-ci.com/api?http#external-apis
     * Will automate the retrieval of that key later in the PR.
     */
    const PUSHER_KEY = '5df8ac576dcccf4fd076';

    const NAMESPACE = 'ApiClients\\Client\\Travis\\Resource';

    const DEFAULT_TRANSPORT_OPTIONS = [
        FoundationOptions::HYDRATOR_OPTIONS => [
            HydratorOptions::NAMESPACE => self::NAMESPACE,
            HydratorOptions::NAMESPACE_DIR => __DIR__ . DIRECTORY_SEPARATOR . 'Resource' . DIRECTORY_SEPARATOR,
        ],
        FoundationOptions::TRANSPORT_OPTIONS => [
            TransportOptions::HOST => 'api.travis-ci.org',
            TransportOptions::HEADERS => [
                'Accept' => 'application/vnd.travis-ci.2+json',
            ],
            TransportOptions::MIDDLEWARE => [
                JsonDecodeMiddleware::class,
                JsonEncodeMiddleware::class,
                UserAgentMiddleware::class,
            ],
            TransportOptions::DEFAULT_REQUEST_OPTIONS => [
                UserAgentMiddleware::class => [
                    UserAgentMiddlewareOptions::STRATEGY => UserAgentStrategies::PACKAGE_VERSION,
                    UserAgentMiddlewareOptions::PACKAGE => 'api-clients/travis',
                ],
            ],
        ],
    ];

    /**
     * Get client options based on $token, $suffix, and $suppliedOptions.
     * Will add auth middleware when $token isn't empty.
     *
     * @param  string $token
     * @param  string $suffix
     * @param  array  $suppliedOptions
     * @return array
     */
    public static function getOptions(
        string $token,
        string $suffix,
        array $suppliedOptions = []
    ): array {
        $options = options_merge(self::DEFAULT_TRANSPORT_OPTIONS, $suppliedOptions);
        $options[FoundationOptions::HYDRATOR_OPTIONS][HydratorOptions::NAMESPACE_SUFFIX] = $suffix;

        if ($token !== '') {
            $transportOptions = $options[FoundationOptions::TRANSPORT_OPTIONS];
            $transportOptions[TransportOptions::MIDDLEWARE][] = TokenAuthorizationHeaderMiddleware::class;
            $transportOptions[TransportOptions::DEFAULT_REQUEST_OPTIONS] = array_merge_recursive(
                $transportOptions[TransportOptions::DEFAULT_REQUEST_OPTIONS] ?? [],
                [
                    TokenAuthorizationHeaderMiddleware::class => [
                        TokenAuthorizationHeaderMiddlewareOptions::TOKEN => $token,
                    ],
                ]
            );
            $options[FoundationOptions::TRANSPORT_OPTIONS] = $transportOptions;
        }

        return $options;
    }
}