redis-gcra 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '085c8c8eb0a8f54f613cec4551f777bf0ad3e49d'
-  data.tar.gz: fad812c225a86dd55234fd51e68911f6099f3c79
+  metadata.gz: d4ce10313659f0a4e111a77b037e45afff5e44f9
+  data.tar.gz: 791b63e5937c82a7e0757064edb45016bb90e3df
 SHA512:
-  metadata.gz: 8458a2915d214ea6f8c9daa247aa92ed25e46e61a42c4d274969970efd1fda3b7fa109f86afb4fcbe2c4bde1d6f6f1839ef0568324a1a56ca76010badcd79fb9
-  data.tar.gz: 75058e691d72f31eb6a147e157b112fd4968dff4d9897fae3a5a8bda6655c5adf44f51bfebedc5456e6fe8f6327ac8925f2a07fe6012eef623c5c8d120c13a41
+  metadata.gz: 4dd33796a611fe9c0d57eae0ba2ff2d7b95a38c8f3da96e98b42f9a9c57a923b53d412c103d43319e2a20c019692be07a8ad9f81366d1ba1e7a85b1fdafe9120
+  data.tar.gz: 581125696884139ac3b83972aac95c859a9ee4c163e64b1b02a24e2b52705374dae48e5f76b08da84d240bf935fa60123147391ed3b048ca8d9ebd53e38970da

data/README.md

@@ -1,10 +1,11 @@
 # RedisGCRA
 [![Build Status](https://travis-ci.org/rwz/redis-gcra.svg?branch=master)](https://travis-ci.org/rwz/redis-gcra)
 
-This gem is an implementation of GCRA for rate limiting based on Redis. The
-code requires Redis version 3.2 or newer since it relies on
+This gem is an implementation of [GCRA][gcra] for rate limiting based on Redis.
+The code requires Redis version 3.2 or newer since it relies on
 [`replicate_commands`][redis-replicate-commands] feature.
 
+[gcra]: https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm
 [redis-replicate-commands]: https://redis.io/commands/eval#replicating-commands-instead-of-scripts
 
 ## Installation
@@ -41,16 +42,16 @@ result = RedisGCRA.limit(
 )
 
 result.limited?    # => false - request should not be limited
-result.remaning    # => 998   - remaining number of requests until limited
+result.remaining   # => 998   - remaining number of requests until limited
 result.retry_after # => nil   - can retry without delay
 result.reset_after # => ~0.6  - in 0.6 seconds rate limiter will completely reset
 
 # call limit 499 more times in rapid succession and you get:
 
-result.limited?    # => true - request should be limited
-result.remaining   # => 0    - no requests can be made at this point
-result.retry_after # => ~1.1 - can retry in 1.1 seconds
-result.reset_after # => ~600 - in 600 seconds rate limiter will completely reset
+result.limited?    # => true  - request should be limited
+result.remaining   # => 0     - no requests can be made at this point
+result.retry_after # => ~1.2  - can retry in 1.2 seconds
+result.reset_after # => ~600  - in 600 seconds rate limiter will completely reset
 ```
 
 The implementation utilizes single key in Redis that matches the key you pass
@@ -64,7 +65,7 @@ redis.del "overall-account/bob@example.com"
 ```
 
 You call also retrieve the current state of rate limiter for particular key
-without actually modifying the state. Of order to do that, use the `peek`
+without actually modifying the state. In order to do that, use the `peek`
 method:
 
 ```ruby
@@ -76,14 +77,23 @@ RedisGCRA.peek(
   period: 60 # seconds
 )
 
-result.limited?    # => true - current state is limited
-result.remaining   # => 0    - no requests can be made
-result.retry_after # => nil  - peek always return nil here
-result.reset_after # => ~600 - in 600 seconds rate limiter will completely reset
+result.limited?    # => true  - current state is limited
+result.remaining   # => 0     - no requests can be made
+result.retry_after # => ~0.6  - in 0.6 seconds remaining will become 1
+result.reset_after # => ~600  - in 600 seconds rate limiter will completely reset
 ```
 
+## Inspiration
+
+This code was inspired by this great [blog post][blog-post] by [Brandur
+Leach][brandur] and his amazing work on [throttled Go package][throttled].
+
+[blog-post]: https://brandur.org/rate-limiting
+[brandur]: https://github.com/brandur
+[throttled]: https://github.com/throttled/throttled
+
 ## License
 
-The gem is available as open source under the terms of the [MIT
-License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License][mit].
 
+[mit]: http://opensource.org/licenses/MIT

data/lib/redis-gcra/version.rb

@@ -1,3 +1,3 @@
 module RedisGCRA
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/vendor/inspect_gcra_ratelimit.lua

@@ -31,15 +31,14 @@ if reset_after == 0 then
 end
 
 local limited
+local retry_after
 
 if remaining == 0 then
   limited = 1
+  retry_after = emission_interval - diff
 else
   limited = 0
+  retry_after = -1
 end
 
--- retry_after is always nil because it doesn't make much sense in inspect
--- context
-local retry_after = -1
-
 return {limited, remaining, tostring(retry_after), tostring(reset_after)}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-gcra
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pavel Pravosud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis