LunixREST\Server\Throttle\CachePoolThrottle

Complexity

Total Complexity

5

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	shouldThrottle()	0	6	1
A	logRequest()	0	12	2
	deriveCacheKey()	0	1	?
A	getCacheItemPool()	0	4	1

<?php
namespace LunixREST\Server\Throttle;

use LunixREST\Server\APIRequest\APIRequest;
use Psr\Cache\CacheItemPoolInterface;

/**
 * A Throttle implementation that relies on an underlying CacheItemPool, and allows a certain number requests in a certain number of seconds.
 * Class CachePoolThrottle
 * @package LunixREST\Server\Throttle
 */
abstract class CachePoolThrottle implements Throttle
{
    /**
     * @var CacheItemPoolInterface
     */
    private $cacheItemPool;
    /**
     * @var int
     */
    private $limit;
    /**
     * @var int
     */
    private $perXSeconds;

    /**
     * CachePoolThrottle constructor.
     * @param CacheItemPoolInterface $cacheItemPool
     * @param int $limit
     * @param int $perXSeconds
     */
    public function __construct(CacheItemPoolInterface $cacheItemPool, int $limit = 60, int $perXSeconds = 60)
    {
        $this->cacheItemPool = $cacheItemPool;
        $this->limit = $limit;
        $this->perXSeconds = $perXSeconds;
    }

    /**
     * Returns true if the given request should be throttled in our implementation
     * @param \LunixREST\Server\APIRequest\APIRequest $request
     * @return bool
     */
    public function shouldThrottle(APIRequest $request): bool
    {
        $item = $this->cacheItemPool->getItem($this->deriveCacheKey($request));

        return $item->get() >= $this->limit;
    }

    /**
     * Log that a request took place
     * @param \LunixREST\Server\APIRequest\APIRequest $request
     */
    public function logRequest(APIRequest $request): void
    {
        $item = $this->cacheItemPool->getItem($this->deriveCacheKey($request));

        if($requestCount = $item->get()) {
            $item->set($requestCount + 1);
        } else {
            $item->set(1)->expiresAfter($this->perXSeconds);
        }

        $this->cacheItemPool->save($item);
    }

    /**
     * @param APIRequest $request
     * @return string
     */
    protected abstract function deriveCacheKey(APIRequest $request): string;

The abstract declaration must precede the visibility declaration

    /**
     * @return CacheItemPoolInterface
     */
    public function getCacheItemPool(): CacheItemPoolInterface
    {
        return $this->cacheItemPool;
    }
}