init

Author: jiaxincui

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/.idea

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 [jiaxincui](https://github.com/jiaxincui) <jenkincei@hotmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "jiaxincui/laravel-throttler",
+    "version": "0.3.0",
+    "description": "Multiple policy rate limit for laravel",
+    "keywords": ["laravel", "throttler", "rate limit"],
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "jiaxincui",
+            "email": "jenkincei@hotmail.com",
+            "role": "Developer"
+        }
+    ],
+    "support": {
+        "email": "jenkincei@hotmail.com",
+        "source":"https://github.com/jiaxincui/laravel-throttler"
+    },
+    "minimum-stability": "stable",
+    "require": {
+        "illuminate/cache": "~5.0|~6.0|~7.0",
+        "illuminate/container": "~5.0|~6.0|~7.0",
+        "illuminate/support": "~5.0|~6.0|~7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Jiaxincui\\Throttler\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Jiaxincui\\Throttler\\ThrottlerServiceProvider"
+            ]
+        }
+    }
+}

config/throttler.php

@@ -0,0 +1,58 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | 限速器 key 前缀
+    |--------------------------------------------------------------------------
+    |
+    | 如果有多个应用存在 key 重复的可能你可以设置一个适当的前缀，如果你确定没有重复的可能可忽略。
+    |
+    */
+
+    'prefix' => '',
+
+    /*
+    |--------------------------------------------------------------------------
+    | 限速器
+    |--------------------------------------------------------------------------
+    |
+    | 如果为空，默认使用 Illuminate\Cache\RateLimiter
+    | 如果要自定义限速器实现，要确保其实现 Jiaxincui\Throttler\Contracts\Limiter 接口
+    |
+    */
+
+    'limiter' => '',
+
+    /*
+    |--------------------------------------------------------------------------
+    | 限速方案
+    |--------------------------------------------------------------------------
+    |
+    | 在使用中没有明确指定 guard 将使用 default 作为限速方案。
+    | 每个方案可以设置多条策略，如 default 方案限制每秒钟5次，并且每分钟10次，每小时50次，每24小时100次，可以像下面这样设置:
+    | 'default' => [
+    |   [5, 1],
+    |   [10, 60],
+    |   [50, 60*60],
+    |   [100, 60*60*24]
+    |  ]
+    |
+    | 也可以设置多条方案，如下将设置一个 custom 的方案:
+    |  'custom' => [
+    |    [5, 1],
+    |    [10, 60]
+    |   ]
+    |
+    */
+
+    'guards' => [
+        'default' => [
+            [5, 1]
+        ],
+
+        'custom' => [
+        ]
+    ]
+];

readme.md

@@ -0,0 +1,167 @@
+## About
+
+Multiple policy rate limit for laravel
+
+适用于 Laravel 的多策略速率限制包
+
+## 应用场景
+
++ 多策略的Api请求速率控制
+
++ 多策略的队列速率控制
+
+## 安装
+
+```terminal
+composer require jiaxincui/laravel-throttler
+```
+
+## 配置文件
+
+此命令将配置文件copy至`config/throttler.php`
+
+```terminal
+php artisan vendor:publish --provider="Jiaxincui\Throttler\ThrottlerServiceProvider"
+```
+
++ `prefix` 限速器 key 前缀，如果有多个应用存在 key 重复的可能你可以设置一个适当的前缀，如果你确定没有重复的可能可忽略。
+
++ `limiter` 使用的限速器，如果为空，默认使用`Iluminate\Cache\RateLimiter`， 如果要自定义限速器实现，要确保其实现 `Jiaxincui\Throttler\Contracts\Limiter` 接口
+
++ `guard` 限速方案，在使用中没有明确指定 `guard` 将使用 `default` 作为限速方案。
+
+每个方案可以设置多条策略，如 default 方案限制每秒钟5次，并且每分钟10次，每小时50次，每24小时100次，可以像下面这样设置:
+
+```php
+[
+  'guards' => [
+    'default' => [
+      [5, 1],
+      [10, 60],
+      [50, 60*60],
+      [100, 60*60*24]
+    ],
+
+ //   'custom' => [
+ //     [5, 1],
+ //     [10, 60]
+ //   ]
+  ]
+];
+
+```
+
+
+### 使用
+
++ 一般情况下你只需要在配置文件设置策略即可。
+
+
+```php
+use Jiaxincui\Throttler\Facades\Throttler;
+
+Throttler::for($request->ip)
+    ->then(function() {
+        // 通过
+        var_dump('Hello world!');
+    }, function($availableIn) {
+        // 未通过
+        var_dump($availableIn);
+    });
+
+// 使用其他限速方案
+Throttler::guard('custom')
+    ->for($request->ip)
+    ->then(function() {
+        // 通过
+        var_dump('Hello world!');
+    }, function($availableIn) {
+        // 未通过
+        var_dump($availableIn);
+    });
+```
+
++ 如果你要在运行时设置限制策略，可以像下面这样做：
+
+```php
+use Jiaxincui\Throttler\Facades\Throttler;
+
+Throttler::for($user->id)
+    ->tap([5, 1])
+    ->tap([10, 60])
+    ->tap([50, 60*60])
+    ->then(function() {
+        // 通过
+        var_dump('Hello world!');
+    }, function($availableIn) {
+        // 未通过
+        var_dump($availableIn);
+    });
+
+// 或者
+$taps = [
+    [5, 1],
+    [10, 60],
+    [50, 60 * 60]
+];
+
+Throttler::throttle($user->id)
+    ->tap($taps)
+    ->then(function() {
+        // 通过
+        var_dump('Hello world!');
+    }, function($availableIn) {
+        // 未通过
+        var_dump($availableIn);
+    });
+```
+
++ 你也可以在控制器的构造方法里通过依赖注入使用它
+
+```php
+<?php
+
+namespace App\Http\Controllers;
+
+use Jiaxincui\Throttler\Throttler;
+
+class UserController extends Controller
+{
+    protected $throttler;
+
+    /**
+     * Create a new controller instance.
+     *
+     * @param Throttler $throttler
+     */
+    public function __construct(Throttler $throttler)
+    {
+        $this->throttler = $throttler;
+    }
+    public function index(Request $request)
+    {
+        $this->throttler->for($request->ip)
+            ->then(function () {
+              // 通过
+            }, function ($availableIn) {
+              // 未通过
+}           );
+    }
+
+}
+```
+
+## Api
+
+| 方法 | 返回 | 说明 |
+| :-- | :-- | :-- |
+| `for(string $key)` | `$this` | 传入`$key`创建一个限速器 |
+| `guard(string $guradName)` | `$this` | 应用一个限速方案 |
+| `tap(array $tapAndTaps)` | `$this` | 添加一个或多个限速策略 |
+| `then(callable $callback, callable $failure)`| `null` | `$callback` 成功通过的回调, `$failure`未通过回调，参数`$availableIn`为距离下次可通过的秒数 |
+
+
+## License
+
+[MIT](https://github.com/jiaxincui/laravel-throttler/blob/master/LICENSE.md) © [JiaxinCui](https://github.com/jiaxincui)
+

src/Contracts/RateLimiter.php

@@ -0,0 +1,35 @@
+<?php
+
+
+namespace Jiaxincui\Throttler\Contracts;
+
+
+interface RateLimiter
+{
+
+    /**
+     * Determine if the given key has been "accessed" too many times.
+     *
+     * @param  string  $key
+     * @param  int  $maxAttempts
+     * @return bool
+     */
+    public function tooManyAttempts($key, $maxAttempts);
+
+    /**
+     * Increment the counter for a given key for a given decay time.
+     *
+     * @param  string  $key
+     * @param  int  $decaySeconds
+     * @return int
+     */
+    public function hit($key, $decaySeconds);
+
+    /**
+     * Get the number of seconds until the "key" is accessible again.
+     *
+     * @param  string  $key
+     * @return int
+     */
+    public function availableIn($key);
+}

src/Exceptions/ThrottlerException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Jiaxincui\Throttler\Exceptions;
+
+use Exception;
+
+class ThrottlerException extends Exception
+{
+    //
+}

src/Facades/Throttler.php

@@ -0,0 +1,14 @@
+<?php
+
+
+namespace Jiaxincui\Throttler\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class Throttler extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return \Jiaxincui\Throttler\Throttler::class;
+    }
+}