ethercreative/yii2-ip-ratelimiter

Allow guest clients to be rate limited, using their IP as the identifier

yii2-ip-ratelimiter

Allow guest clients to be rate limited, using their IP as the identifier.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require ethercreative/yii2-ip-ratelimiter "1.*"

or add

"ethercreative/yii2-ip-ratelimiter": "1.*"

to the require section of your composer.json file.

Usage

Modify the bahavior method of the controller you want to rate limit

public function behaviors()
{
	$behaviors = parent::behaviors();
	$behaviors['rateLimiter'] = [
		// Use class
		'class' => \ethercreative\ratelimiter\RateLimiter::className(),

		// The maximum number of allowed requests
		'rateLimit' => 100,

		// The time period for the rates to apply to
		'timePeriod' => 600,

		// Separate rate limiting for guests and authenticated users
		// Defaults to true
		// - false: use one set of rates, whether you are authenticated or not
		// - true: use separate ratesfor guests and authenticated users
		'separateRates' => false,

		// Whether to return HTTP headers containing the current rate limiting information
		'enableRateLimitHeaders' => false,
	];
	return $behaviors;
}

yii2-ip-ratelimiter's Issues

User trait instead class

Hello, thanks for package.

What about idea, when logic of RateLimitInterface will be implemented in trait instead class.

I think it will be more flexible.

Installation via Composer issue

I have attempted to add this extension to my project but I am getting a composer error.

    - The requested package ethercreative/yii2-ip-ratelimiter ~2.0.0 exists as ethercreative/yii2-ip-ratelimiter[1.0, dev-master] but these are rejected by your constraint.

I have attempted to add this plugin via both ways
php composer.phar require ethercreative/yii2-ip-ratelimiter "~2.0.0"
Adding "ethercreative/yii2-ip-ratelimiter": "~2.0.0" to my composer.json

yii site design

Hi there,

I see nice artwork on repo homepage seems like you know bit about design as well, I was wondering would you be able to give us a hand with yii2 home design.

here is what we have currently.

https://github.com/yiisoft-contrib/yiiframework.com

regards
Alrazi

README.MD contains errors

php composer.phar require ethercreative/yii2-api-ratelimiter "~2.0.0"

should be:

php composer.phar require ethercreative/yii2-ip-ratelimiter "~1.0"

The package cannot be installed like this.

Question about timePeriod

Can you please describe what is the timePeriod (unit) property? Seconds or what?

I mean 1 min * X seconds?

Typo in README.md caused me problems installing

Under section Installation there is a typo in the suggested composer command...

php composer.phar require ethercretaive/yii2-ip-ratelimiter "~1.0.0"

vs

php composer.phar require ethercreative/yii2-ip-ratelimiter "~1.0.0"

Caused me a few minutes of confusion!