redis_token_bucket 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1991459cf61f197e4b366ade53dd41ecbaf26bd
-  data.tar.gz: 4931d16f9aa7fb622bf167fdbc74d4781bbdc548
+  metadata.gz: b5f3614cd42c5a2d7918d03e4e36c5d0bc6feb5f
+  data.tar.gz: 02d7546e49f27969c21f18986db43a6af57d6362
 SHA512:
-  metadata.gz: 3aa2fdf2aca0e7c374cd6845dece306ef0de74651f50b17328269d0abb5a38f9d742ae32ed9fb25119bd5922e166d00aceb42ce2574dae1da02df712d31e581a
-  data.tar.gz: 7f99aef70badd3708e784d240a81c1fa0f1c25a543f6d7fb66d40f7c5e7eb3d6cb4c7e64d2985aeb90aab834ea652ed8f940109fd4f39214e303d33e01de7ccc
+  metadata.gz: 15a6040f4b8b733ab9272b7d0232375a2dff33555a4f14e5c14339b056e76c6d8fc582ee0de141356259ac59e06f65b93dd5d38302a74a61524d3ff0f0c4a677
+  data.tar.gz: bab9137d9a5ab47c79eff97a3f560c0938c0a1e00117e3deb72a81b7447062e01edec45abaaf4f37b7166abb1465c605f22240ef87e2772ab555a8ec9027ebf5

data/README.md

@@ -9,11 +9,12 @@ Features:
   * Buckets are automatically removed when no longer used
 * Fast and concurrency safe
   * Each operation uses just a single network roundtrip to Redis
-  * Charging tokens is done with all-or-nothing semantics
+  * Charging tokens can be done with all-or-nothing semantics
 * Computed continuously
   * Token values (rate, size, current level, cost) use floating point numbers
   * Bucket level is computed with microsecond precision
 * Powerful and flexible
+  * Ability to use take-what-is-there semantics (instead of all-or-nothing)
   * Ability to charge multiple buckets with arbitrary token amounts at once
   * Ability to "reserve" tokens and to create "token debt"
 
@@ -113,6 +114,19 @@ puts "The current level of tokens in bucket short: #{levels[short_bucket[:key]]}
 puts "The current level of tokens in bucket long: #{levels[long_bucket[:key]]}"
 ```
 
+Charging with "take-what-is-there" semantics:
+
+```ruby
+
+call_my_business_logic
+
+success, levels = limiter.batch_charge(
+  [bucket, 1, {allow_charge_adjustment: true}]
+)
+```
+
+If you use the `allow_charge_adjustment` option, the charge will succeed, even if the bucket has insufficient tokens. In that case, as much as possible will be charged from the bucket. This may be useful, if your application wants to charge "after the fact", e.g. after your business logic has already run.
+
 Advanced: Bucket with Reserved Tokens
 
 ```ruby

data/lib/redis_token_bucket/limiter.lua

@@ -11,7 +11,7 @@ local timeouts = {}
 local exceeded = false
 
 for key_index, key in ipairs(KEYS) do
-  local arg_index = key_index * 4 - 2
+  local arg_index = key_index * 5 - 3
   local rate = tonumber(ARGV[arg_index])
   local size = tonumber(ARGV[arg_index + 1])
   local amount = tonumber(ARGV[arg_index + 2])
@@ -31,14 +31,20 @@ for key_index, key in ipairs(KEYS) do
     local limit = tonumber(ARGV[arg_index + 3]) or 0
 
     local new_level = current_level - amount
-    new_bucket_levels[key_index] = new_level
 
     local seconds_to_full = (size - new_level) / rate
     timeouts[key_index] = seconds_to_full
 
     if new_level < limit then
-      exceeded = true
+      local allow_charge_adjustment = tonumber(ARGV[arg_index + 4]) or 0
+
+      if allow_charge_adjustment > 0 then
+        new_level = limit
+      else
+        exceeded = true
+      end
     end
+    new_bucket_levels[key_index] = new_level
   end
 end
 

data/lib/redis_token_bucket/limiter.rb

@@ -75,7 +75,13 @@ class Limiter
   def props_for_charge(charge)
     bucket, amount, options = charge
 
-    [bucket[:rate], bucket[:size], amount, options ? options[:limit] : nil]
+    [
+      bucket[:rate],
+      bucket[:size],
+      amount,
+      options ? options[:limit] : nil,
+      options && options[:allow_charge_adjustment] ? 1 : 0,
+    ]
   end
 
   def eval_script(options)

data/lib/redis_token_bucket/version.rb

@@ -1,3 +1,3 @@
 module RedisTokenBucket
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_token_bucket
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kristian Hanekamp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Token Bucket Rate Limiting using Redis