LunixREST\Router\Router

Complexity

Total Complexity

12

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	route()	0	21	3
A	validateKey()	0	5	2
A	validateExtension()	0	6	3
A	throttle()	0	2	1
A	validateAccess()	0	2	1
A	executeEndpoint()	0	3	1

<?php
namespace LunixREST\Router;

use LunixREST\AccessControl\AccessControl;
use LunixREST\Endpoint\Endpoint;
use LunixREST\Endpoint\EndpointFactory;
use LunixREST\Endpoint\Exceptions\UnknownEndpointException;
use LunixREST\Exceptions\AccessDeniedException;
use LunixREST\Exceptions\InvalidAPIKeyException;
use LunixREST\Exceptions\ThrottleLimitExceededException;
use LunixREST\Request\Request;
use LunixREST\Response\Exceptions\UnknownResponseTypeException;
use LunixREST\Response\Response;
use LunixREST\Response\ResponseData;
use LunixREST\Response\ResponseFactory;
use LunixREST\Throttle\Throttle;

/**
 * Class Router
 * @package LunixREST\Router
 */
class Router {
    /**
     * @var AccessControl
     */
    protected $accessControl;
    /**
     * @var Throttle
     */
    protected $throttle;
    /**
     * @var ResponseFactory
     */
    protected $responseFactory;
    /**
     * @var EndpointFactory
     */
    private $endpointFactory;

    /**
     * @param AccessControl $accessControl
     * @param Throttle $throttle
     * @param ResponseFactory $responseFactory
     * @param EndpointFactory $endpointFactory
     */
    public function __construct(AccessControl $accessControl, Throttle $throttle, ResponseFactory $responseFactory, EndpointFactory $endpointFactory){
        $this->accessControl = $accessControl;
        $this->throttle = $throttle;
        $this->responseFactory = $responseFactory;
        $this->endpointFactory = $endpointFactory;
    }

    /**
     * @param Request $request
     * @return Response
     * @throws AccessDeniedException
     * @throws InvalidAPIKeyException
     * @throws ThrottleLimitExceededException
     * @throws UnknownEndpointException
     * @throws UnknownResponseTypeException
     */
    public function route(Request $request): Response{
        $this->validateKey($request);

        $this->validateExtension($request);

        $endpoint = $this->endpointFactory->getEndpoint($request->getEndpoint(), $request->getVersion());

        if($this->throttle->shouldThrottle($request)) {
            throw new ThrottleLimitExceededException('Request limit exceeded');
        }

        if(!$this->accessControl->validateAccess($request)) {
            throw new AccessDeniedException("API key does not have the required permissions to access requested resource");
        }

        $this->throttle->logRequest($request);

        $responseData = $this->executeEndpoint($endpoint, $request);

        return $this->responseFactory->getResponse($responseData, $request->getExtension());
    }

    /**
     * @param Request $request
     * @throws InvalidAPIKeyException
     */
    protected function validateKey(Request $request){
        if(!$this->accessControl->validateKey($request->getApiKey())){
            throw new InvalidAPIKeyException('Invalid API key');
        }
    }

    /**
     * @param Request $request
     * @throws UnknownResponseTypeException
     */
    protected function validateExtension(Request $request) {
        $formats = $this->responseFactory->getSupportedTypes();
        if(!$formats || !in_array($request->getExtension(), $formats)){

The expression $formats of type string[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            throw new UnknownResponseTypeException('Unknown response format: ' . $request->getExtension());
        }
    }

    /**
     * @param Request $request
     * @throws ThrottleLimitExceededException
     */
    protected function throttle(Request $request) {

The parameter $request is not used and could be removed.

    }

    /**
     * @param Request $request
     * @throws AccessDeniedException
     */
    protected function validateAccess(Request $request) {

The parameter $request is not used and could be removed.

    }

    protected function executeEndpoint(Endpoint $endpoint, Request $request): ResponseData {
        return call_user_func([$endpoint, $request->getMethod()], [$request]);
    }
}