Fix ip header

.gitignore

@@ -1,6 +1,3 @@
-composer.phar
 /vendor/
-
-# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+/.idea/
+/composer.lock

README.md

@@ -10,13 +10,13 @@ The preferred way to install this extension is through [composer](http://getcomp
 Either run
 
 ```
-php composer.phar require ethercreative/yii2-ip-ratelimiter "1.*"
+php composer.phar require andreyv/yii2-ip-ratelimiter "2.*"
 ```
 
 or add
 
 ```
-"ethercreative/yii2-ip-ratelimiter": "1.*"
+"andreyv/yii2-ip-ratelimiter": "2.*"
 ```
 
 to the require section of your `composer.json` file.
@@ -28,26 +28,36 @@ 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;
+    $behaviors = parent::behaviors();
+    $behaviors['rateLimiter'] = [
+        // Use class
+        'class' => \andreyv\ratelimiter\IpRateLimiter::class,
+
+        // 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 false
+        // - false: use one set of rates, whether you are authenticated or not
+        // - true: use separate ratesfor guests and authenticated users
+        'separateRates' => true,
+
+        // Whether to return HTTP headers containing the current rate limiting information
+        'enableRateLimitHeaders' => false,
+
+        // Array of actions on which to apply ratelimiter, if empty - applies to all actions
+        'actions' => ['index'],
+
+        // Allows to skip rate limiting for test environment
+        'testMode' => true,
+        // Defines whether proxy enabled, list of headers getting from request ipHeaders. By default ['X-Forwarded-For']
+        'proxyEnabled' => false
+    ];
+    return $behaviors;
 }
 ```
+
+Forked from ethercreative/yii2-ip-ratelimiter.

composer.json

@@ -1,23 +1,29 @@
 {
-	"name": "ethercreative/yii2-ip-ratelimiter",
-	"description": "Allow guest clients to be rate limited, using their IP as the identifier.",
-	"type": "yii2-module",
-	"keywords": ["yii2", "ratelimiter"],
-	"license": "MIT",
-	"authors": [
-		{
-			"name": "Matt Edmonston",
-			"email": "[email protected]"
-		},
+    "name": "andreyv/yii2-ip-ratelimiter",
+    "description": "Allow guest clients to be rate limited, using their IP as the identifier.",
+    "type": "yii2-module",
+    "keywords": ["yii2", "ratelimiter"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Matt Edmonston",
+            "email": "[email protected]"
+        },
         {
           "name": "Yaroslav Lukyanov",
           "email": "[email protected]"
+        },
+        {
+          "name": "Andreyv V",
+          "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "yiisoft/yii2": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "andreyv\\ratelimiter\\": "src"
         }
-	],
-	"require": {},
-	"autoload": {
-		"psr-4": {
-			"ethercreative\\ratelimiter\\": ""
-		}
-	}
+    }
 }

IpRateLimitInterface.php → src/IpRateLimitInterface.php

@@ -1,14 +1,9 @@
 <?php
 
-namespace ethercreative\ratelimiter;
+namespace andreyv\ratelimiter;
 
 use yii\filters\RateLimitInterface;
 
-/**
- * Interface IpRateLimitInterface
- *
- * @package ethercreative\ratelimiter
- */
 interface IpRateLimitInterface extends RateLimitInterface
 {
     /**
@@ -20,5 +15,5 @@ interface IpRateLimitInterface extends RateLimitInterface
      *
      * @return static
      */
-    public static function findByIp($ip, $rateLimit, $timePeriod);
+    public static function create($ip, $rateLimit, $timePeriod);
 }

src/IpRateLimiter.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace andreyv\ratelimiter;
+
+use Yii;
+use yii\filters\RateLimiter;
+
+class IpRateLimiter extends RateLimiter
+{
+    /**
+     * @var boolean whether to separate rate limiting between non and authenticated users
+     */
+    public $separateRates = false;
+
+    /**
+     * @var integer the maximum number of allowed requests
+     */
+    public $rateLimit = 5;
+
+    /**
+     * @var integer the time period for the rates to apply to
+     */
+    public $timePeriod = 1;
+
+    /**
+     * @var array list of actions on which to apply ratelimiter, if empty - applies to all actions
+     */
+    public $actions = [];
+
+    /**
+     * @var bool allows to skip rate limiting for test environment
+     */
+    public $testMode = false;
+
+    /**
+     * @var bool defines whether proxy enabled
+     */
+    public $proxyEnabled = false;
+
+    /**
+     * @inheritdoc
+     */
+    public function beforeAction($action)
+    {
+        if ($this->testMode) {
+            return true;
+        }
+
+        if (is_array($this->actions) && (empty($this->actions) || in_array($action->id, $this->actions))) {
+            if ($this->separateRates && !$this->user) {
+                $this->user = Yii::$app->getUser() ? Yii::$app->getUser()->getIdentity(false) : null;
+            }
+
+            if (!$this->user) {
+                /** @var IpRateLimitInterface $identityClass */
+                $identityClass = Yii::$app->getUser()->identityClass;
+                if (!in_array(UserIdentity::class, class_implements($identityClass))) {
+                    $identityClass = UserIdentity::class;
+                }
+
+                $this->user = $identityClass::create(
+                    $this->request->getUserIP(),
+                    $this->rateLimit,
+                    $this->timePeriod
+                );
+            }
+
+            return parent::beforeAction($action);
+        }
+        return true;
+    }
+}

UserExample.php → src/UserIdentity.php

@@ -1,15 +1,10 @@
 <?php
 
-namespace ethercreative\ratelimiter;
+namespace andreyv\ratelimiter;
 
 use Yii;
 
-/**
- * Class UserExample
- *
- * @package ethercreative\ratelimiter
- */
-class UserExample extends \yii\base\Model implements IpRateLimitInterface
+class UserIdentity implements IpRateLimitInterface
 {
     /**
      * @var string IP of the user
@@ -29,7 +24,7 @@ class UserExample extends \yii\base\Model implements IpRateLimitInterface
     /**
      * @inheritdoc
      */
-    public static function findByIp($ip, $rateLimit, $timePeriod)
+    public static function create($ip, $rateLimit, $timePeriod)
     {
         $user = new static();