Facile\OpenIDClient\Exception\OAuth2Exception

Complexity

Total Complexity

13

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	fromResponse()	0	10	3
A	jsonSerialize()	0	17	3
A	getErrorUri()	0	3	1
A	__construct()	0	16	2
A	fromParameters()	0	12	2
A	getError()	0	3	1
A	getDescription()	0	3	1

<?php

declare(strict_types=1);

namespace Facile\OpenIDClient\Exception;

use function array_key_exists;
use function is_array;
use function json_decode;
use JsonSerializable;
use Psr\Http\Message\ResponseInterface;
use function sprintf;
use Throwable;

class OAuth2Exception extends RuntimeException implements JsonSerializable
{
    /** @var string */
    private $error;

    /** @var null|string */
    private $description;

    /** @var null|string */
    private $errorUri;

    /**
     * @param ResponseInterface $response
     * @param Throwable|null $previous
     *
     * @throws RemoteException
     *
     * @return self
     */
    public static function fromResponse(ResponseInterface $response, Throwable $previous = null): self
    {
        /** @psalm-var false|array{error: string, error_description?: string, error_uri?: string}  $data */
        $data = json_decode((string) $response->getBody(), true);

        if (! is_array($data) || ! isset($data['error'])) {
            throw new RemoteException($response, $response->getReasonPhrase(), $previous);
        }

        return self::fromParameters($data);
    }

    /**
     * @param array<string, mixed> $params
     * @param Throwable|null $previous
     *
     * @return self
     *
     * @psalm-param array{error?: string, error_description?: string, error_uri?: string} $params
     */
    public static function fromParameters(array $params, Throwable $previous = null): self
    {
        if (! array_key_exists('error', $params)) {
            throw new InvalidArgumentException('Invalid OAuth2 exception', 0, $previous);
        }

        return new self(
            $params['error'],
            $params['error_description'] ?? null,
            $params['error_uri'] ?? null,
            0,
            $previous
        );
    }

    public function __construct(
        string $error,
        ?string $description = null,
        ?string $errorUri = null,
        int $code = 0,
        Throwable $previous = null
    ) {
        $message = $error;
        if (null !== $description) {
            $message = sprintf('%s (%s)', $description, $error);
        }

        parent::__construct($message, $code, $previous);
        $this->error = $error;
        $this->description = $description;
        $this->errorUri = $errorUri;
    }

    /**
     * @return string
     */
    public function getError(): string
    {
        return $this->error;
    }

    /**
     * @return string|null
     */
    public function getDescription(): ?string
    {
        return $this->description;
    }

    /**
     * @return string|null
     */
    public function getErrorUri(): ?string
    {
        return $this->errorUri;
    }

    /**
     * @return array<string, mixed>
     * @psalm-return array{error: string, error_description?: string, error_uri?: string}
     */
    public function jsonSerialize(): array
    {
        $data = [
            'error' => $this->getError(),
        ];

        $description = $this->getDescription();
        if (null !== $description) {
            $data['error_description'] = $description;
        }

        $errorUri = $this->getErrorUri();
        if (null !== $errorUri) {
            $data['error_uri'] = $errorUri;
        }

        return $data;
    }
}