RateLimit\AbstractRateLimiter

Complexity

Total Complexity

9

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getLimit()	0	4	1
A	getWindow()	0	4	1
A	hit()	0	15	3
A	getRemainingAttempts()	0	4	1
A	getResetAt()	0	4	1
A	getCurrent()	0	4	1
	get()	0	1	?
	init()	0	1	?
	increment()	0	1	?
	ttl()	0	1	?

<?php
/**
 * This file is part of the Rate Limit package.
 *
 * Copyright (c) Nikola Posa
 *
 * For full copyright and license information, please refer to the LICENSE file,
 * located at the package root folder.
 */

declare(strict_types=1);

namespace RateLimit;

use RateLimit\Exception\RateLimitExceededException;

/**
 * @author Nikola Posa <posa.nikola@gmail.com>
 */
abstract class AbstractRateLimiter implements RateLimiterInterface
{
    /**
     * @var int
     */
    protected $limit;

    /**
     * @var int
     */
    protected $window;

    /**
     * @var string
     */
    protected $key;

    public function __construct(int $limit, int $window)
    {
        $this->limit = $limit;
        $this->window = $window;
    }

    /**
     * {@inheritdoc}
     */
    public function getLimit() : int
    {
        return $this->limit;
    }

    /**
     * {@inheritdoc}
     */
    public function getWindow() : int
    {
        return $this->window;
    }

    /**
     * {@inheritdoc}
     */
    public function hit(string $key)
    {
        $current = $this->getCurrent($key);

        if ($current >= $this->limit) {
            throw RateLimitExceededException::forKey($key);
        }

        if (0 === $current) {
            $this->init($key);
            return;
        }

        $this->increment($key);
    }

    /**
     * {@inheritdoc}
     */
    public function getRemainingAttempts(string $key) : int
    {
        return max(0, $this->limit - $this->getCurrent($key));
    }

    /**
     * {@inheritdoc}
     */
    public function getResetAt(string $key) : int
    {
        return time() + $this->ttl($key);
    }

    protected function getCurrent(string $key) : int
    {
        return $this->get($key, 0);
    }

    abstract protected function get(string $key, int $default) : int;

    abstract protected function init(string $key);

    abstract protected function increment(string $key);

    abstract protected function ttl(string $key) : int;
}