OAuth2Framework\Component\AuthorizationCodeGrant\AuthorizationCode

Complexity

Total Complexity

30

Size/Duplication

Total Lines	326
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	createEmpty()	0	4	1
A	getSchema()	0	4	1
A	create()	0	20	1
A	getTokenId()	0	8	2
A	getAuthorizationCodeId()	0	9	2
A	getQueryParameters()	0	4	1
A	isUsed()	0	4	1
A	markAsUsed()	0	12	2
A	markAsRevoked()	0	9	1
A	getQueryParams()	0	4	1
A	getQueryParam()	0	8	2
A	getRedirectUri()	0	8	2
A	toArray()	0	6	1
B	createFromJson()	0	32	2
A	jsonSerialize()	0	11	1
A	apply()	0	13	4
A	getEventMap()	0	8	1
A	applyAuthorizationCodeCreatedEvent()	0	16	1
A	applyAuthorizationCodeMarkedAsUsedEvent()	0	7	1
A	applyAuthorizationCodeRevokedEvent()	0	7	1
A	hasQueryParam()	0	4	1

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace OAuth2Framework\Component\AuthorizationCodeGrant;

use OAuth2Framework\Component\AuthorizationCodeGrant\Event as AuthorizationCodeEvent;
use OAuth2Framework\Component\Core\Client\ClientId;
use OAuth2Framework\Component\Core\DataBag\DataBag;
use OAuth2Framework\Component\Core\Domain\DomainObject;
use OAuth2Framework\Component\Core\Event\Event;
use OAuth2Framework\Component\Core\ResourceServer\ResourceServerId;
use OAuth2Framework\Component\Core\Token\Token;
use OAuth2Framework\Component\Core\Token\TokenId;
use OAuth2Framework\Component\Core\UserAccount\UserAccountId;

class AuthorizationCode extends Token
{
    /**
     * @var AuthorizationCodeId
     */
    private $authorizationCodeId = null;

    /**
     * @var array
     */
    private $queryParameters = [];

    /**
     * @var string
     */
    private $redirectUri = null;

    /**
     * @var bool
     */
    private $used = false;

    /**
     * @return AuthorizationCode
     */
    public static function createEmpty(): self
    {
        return new self();
    }

    /**
     * {@inheritdoc}
     */
    public static function getSchema(): string
    {
        return 'https://oauth2-framework.spomky-labs.com/schemas/model/authorization-code/1.0/schema';
    }

    /**
     * @param AuthorizationCodeId $authorizationCodeId
     * @param ClientId            $clientId
     * @param UserAccountId       $userAccountId
     * @param array               $queryParameters
     * @param string              $redirectUri
     * @param \DateTimeImmutable  $expiresAt
     * @param DataBag             $parameters
     * @param DataBag             $metadatas
     * @param ResourceServerId    $resourceServerId
     *
     * @return AuthorizationCode
     */
    public function create(AuthorizationCodeId $authorizationCodeId, ClientId $clientId, UserAccountId $userAccountId, array $queryParameters, string $redirectUri, \DateTimeImmutable $expiresAt, DataBag $parameters, DataBag $metadatas, ? ResourceServerId $resourceServerId)
    {
        $clone = clone $this;
        $clone->authorizationCodeId = $authorizationCodeId;
        $clone->clientId = $clientId;
        $clone->resourceOwnerId = $userAccountId;
        $clone->queryParameters = $queryParameters;
        $clone->redirectUri = $redirectUri;
        $clone->authorizationCodeId = $authorizationCodeId;
        $clone->expiresAt = $expiresAt;
        $clone->parameters = $parameters;
        $clone->metadatas = $metadatas;
        $clone->expiresAt = $expiresAt;
        $clone->resourceServerId = $resourceServerId;

        $event = AuthorizationCodeEvent\AuthorizationCodeCreatedEvent::create($authorizationCodeId, $clientId, $userAccountId, $queryParameters, $redirectUri, $expiresAt, $parameters, $metadatas, $resourceServerId);
        $clone->record($event);

        return $clone;
    }

    /**
     * {@inheritdoc}
     */
    public function getTokenId(): TokenId
    {
        if (null === $this->authorizationCodeId) {
            throw new \RuntimeException('Authorization code not initialized.');
        }

        return $this->authorizationCodeId;
    }

    /**
     * @return AuthorizationCodeId
     */
    public function getAuthorizationCodeId(): AuthorizationCodeId
    {
        $id = $this->getTokenId();
        if (!$id instanceof AuthorizationCodeId) {
            throw new \RuntimeException('Authorization code not initialized.');
        }

        return $this->authorizationCodeId;
    }

    /**
     * @return array
     */
    public function getQueryParameters(): array
    {
        return $this->queryParameters;
    }

    /**
     * @return bool
     */
    public function isUsed(): bool
    {
        return $this->used;
    }

    /**
     * @return AuthorizationCode
     */
    public function markAsUsed(): self
    {
        if (true === $this->used) {
            return $this;
        }
        $clone = clone $this;
        $clone->used = true;
        $event = AuthorizationCodeEvent\AuthorizationCodeMarkedAsUsedEvent::create($clone->getTokenId());
        $clone->record($event);

        return $clone;
    }

    /**
     * @return AuthorizationCode
     */
    public function markAsRevoked(): self
    {
        $clone = clone $this;
        $clone->revoked = true;
        $event = AuthorizationCodeEvent\AuthorizationCodeRevokedEvent::create($clone->getTokenId());
        $clone->record($event);

        return $clone;
    }

    /**
     * @return array
     */
    public function getQueryParams(): array
    {
        return $this->queryParameters;
    }

    /**
     * @param string $key
     *
     * @return mixed
     */
    public function getQueryParam(string $key)
    {
        if ($this->hasQueryParam($key)) {
            throw new \RuntimeException(sprintf('Query parameter with key "%s" does not exist.', $key));
        }

        return $this->queryParameters[$key];
    }

    /**
     * @param string $key
     *
     * @return bool
     */
    public function hasQueryParam(string $key): bool
    {
        return array_key_exists($key, $this->getQueryParams());
    }

    /**
     * @return string
     */
    public function getRedirectUri(): string
    {
        if (null === $this->authorizationCodeId) {
            throw new \RuntimeException('Authorization code not initialized.');
        }

        return $this->redirectUri;
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        return [
            'code' => $this->getTokenId()->getValue(),
        ];
    }

    /**
     * {@inheritdoc}
     */
    public static function createFromJson(\stdClass $json): DomainObject
    {
        $authorizationCodeId = AuthorizationCodeId::create($json->auth_code_id);
        $queryParameters = (array) $json->query_parameters;
        $redirectUri = $json->redirect_uri;
        $resourceServerId = null !== $json->resource_server_id ? ResourceServerId::create($json->resource_server_id) : null;
        $used = $json->is_used;

        $expiresAt = \DateTimeImmutable::createFromFormat('U', (string) $json->expires_at);
        $clientId = ClientId::create($json->client_id);
        $parameters = DataBag::create((array) $json->parameters);
        $metadatas = DataBag::create((array) $json->metadatas);
        $revoked = $json->is_revoked;
        $resourceOwnerClass = $json->resource_owner_class;
        $resourceOwnerId = $resourceOwnerClass::create($json->resource_owner_id);

        $authorizationCode = new self();
        $authorizationCode->authorizationCodeId = $authorizationCodeId;
        $authorizationCode->queryParameters = $queryParameters;
        $authorizationCode->redirectUri = $redirectUri;
        $authorizationCode->used = $used;
        $authorizationCode->resourceServerId = $resourceServerId;

        $authorizationCode->expiresAt = $expiresAt;
        $authorizationCode->clientId = $clientId;
        $authorizationCode->parameters = $parameters;
        $authorizationCode->metadatas = $metadatas;
        $authorizationCode->revoked = $revoked;
        $authorizationCode->resourceOwnerId = $resourceOwnerId;

        return $authorizationCode;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        $data = parent::jsonSerialize() + [
                'auth_code_id' => $this->getTokenId()->getValue(),
                'query_parameters' => (object) $this->getQueryParameters(),
                'redirect_uri' => $this->getRedirectUri(),
                'is_used' => $this->isUsed(),
            ];

        return $data;
    }

    /**
     * @param Event $event
     *
     * @return AuthorizationCode
     */
    public function apply(Event $event): self
    {
        $map = $this->getEventMap();
        if (!array_key_exists($event->getType(), $map)) {
            throw new \RuntimeException('Unsupported event.');
        }
        if (null !== $this->authorizationCodeId && $this->authorizationCodeId->getValue() !== $event->getDomainId()->getValue()) {
            throw new \RuntimeException('Event not applicable for this authorization code.');
        }
        $method = $map[$event->getType()];

        return $this->$method($event);
    }

    /**
     * @return array
     */
    private function getEventMap(): array
    {
        return [
            AuthorizationCodeEvent\AuthorizationCodeCreatedEvent::class => 'applyAuthorizationCodeCreatedEvent',
            AuthorizationCodeEvent\AuthorizationCodeMarkedAsUsedEvent::class => 'applyAuthorizationCodeMarkedAsUsedEvent',
            AuthorizationCodeEvent\AuthorizationCodeRevokedEvent::class => 'applyAuthorizationCodeRevokedEvent',
        ];
    }

    /**
     * @param AuthorizationCodeEvent\AuthorizationCodeCreatedEvent $event
     *
     * @return AuthorizationCode
     */
    protected function applyAuthorizationCodeCreatedEvent(AuthorizationCodeEvent\AuthorizationCodeCreatedEvent $event): self
    {
        $clone = clone $this;
        $clone->authorizationCodeId = $event->getAuthorizationCodeId();
        $clone->clientId = $event->getClientId();
        $clone->resourceOwnerId = $event->getUserAccountId();
        $clone->queryParameters = $event->getQueryParameters();
        $clone->redirectUri = $event->getRedirectUri();
        $clone->expiresAt = $event->getExpiresAt();
        $clone->parameters = $event->getParameters();
        $clone->metadatas = $event->getMetadatas();
        $clone->expiresAt = $event->getExpiresAt();
        $clone->resourceServerId = $event->getResourceServerId();

        return $clone;
    }

    /**
     * @param AuthorizationCodeEvent\AuthorizationCodeMarkedAsUsedEvent $event
     *
     * @return AuthorizationCode
     */
    protected function applyAuthorizationCodeMarkedAsUsedEvent(AuthorizationCodeEvent\AuthorizationCodeMarkedAsUsedEvent $event): self
    {
        $clone = clone $this;
        $clone->used = true;

        return $clone;
    }

    /**
     * @param AuthorizationCodeEvent\AuthorizationCodeRevokedEvent $event
     *
     * @return AuthorizationCode
     */
    protected function applyAuthorizationCodeRevokedEvent(AuthorizationCodeEvent\AuthorizationCodeRevokedEvent $event): self
    {
        $clone = clone $this;
        $clone->revoked = true;

        return $clone;
    }
}