traffic_jam 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc24485cfcc470e68b80dbb53f6b135ab9879bf0
-  data.tar.gz: ab8ea5c0a5e1075af9606fae0e4a0cc9bb1fc071
+  metadata.gz: 805e6a84771b1d0933268ad372a33224ac7f5d26
+  data.tar.gz: 978bfe19a6637a37efa7b501c53a919104165d18
 SHA512:
-  metadata.gz: f428099b9b945e9196a4e54146a79af29d8e8e8c430320f1e9237be2e96df3b9f39e29cad2b78c53694f9c76e85ee698f38af91b23ab715339ab9f578eaa4434
-  data.tar.gz: 7c9afc9302a854fa68c042c9329e73a6224858bec71e25fb0ff5ac2a72fdcd6ab7f5aeedba4af936242a20e5fb96bc4fc87dcacdf9a77b3291f582adb5ddd540
+  metadata.gz: eb81caf639081a1313d893e2c3cc61e8c4d097061e4a6abbb3fbfcd03936dc4709f7fb745d9e206252265e61f3ed41d4351752657fd47d2990b70f2db8ac9a5f
+  data.tar.gz: abd29587f6e1bbda2f5a3abba3bf470429846d0c928bf9d2d40797b17b4c66881395846f199305a874bf6dad778bb4edac39dbb0627b7eb0f7bf69caeec88014

data/lib/traffic_jam.rb

@@ -1,12 +1,12 @@
 require 'ostruct'
 require 'digest/md5'
-require_relative 'traffic_jam/errors'
 require_relative 'traffic_jam/configuration'
+require_relative 'traffic_jam/errors'
+require_relative 'traffic_jam/gcra_limit'
+require_relative 'traffic_jam/lifetime_limit'
 require_relative 'traffic_jam/limit'
 require_relative 'traffic_jam/limit_group'
-require_relative 'traffic_jam/simple_limit'
 require_relative 'traffic_jam/rolling_limit'
-require_relative 'traffic_jam/lifetime_limit'
 
 module TrafficJam
   include Errors

data/lib/traffic_jam/{simple_limit.rb → gcra_limit.rb}

@@ -2,21 +2,28 @@ require_relative 'limit'
 require_relative 'scripts'
 
 module TrafficJam
-  # A SimpleLimit is a limit type that is more efficient for increments but does
-  # not support decrements or changing the max value without a complete reset.
-  # This means that if the period or max value for an action, value key changes,
-  # the used and remaining values cannot be preserved.
-  #
-  # This works by storing a key in Redis with a millisecond-precision expiry
+  # GCRA (Generic Cell Rate Algorithm) is a leaky bucket type rate limiting
+  # algorithm. GCRA works by storing a key in Redis with a ms-precision expiry
   # representing the time that the limit will be completely reset. Each
   # increment operation converts the increment amount into the number of
   # milliseconds to be added to the expiry.
   #
+  # When a request comes in, we take the existing expiry value, subtract a fixed
+  # amount representing the limit’s total burst capacity from it, and compare
+  # the result to the current time. This result represents the next time to
+  # allow a request. If it’s in the past, we allow the incoming request, and if
+  # it’s in the future, we don’t. After a successful request, a new expiry is
+  # calculated. (see https://brandur.org/rate-limiting)
+  #
+  # This limit type does not support decrements or changing the max value without
+  # a complete reset. This means that if the period or max value for an
+  # action/value key changes, the used and remaining values cannot be preserved.
+  #
   # Example: Limit is 5 per 10 seconds.
   #     An increment by 1 first sets the key to expire in 2s.
   #     Another immediate increment by 4 sets the expiry to 10s.
   #     Subsequent increments fail until clock time catches up to expiry
-  class SimpleLimit < Limit
+  class GCRALimit < Limit
     # Increment the amount used by the given number. Does not perform increment
     # if the operation would exceed the limit. Returns whether the operation was
     # successful.
@@ -42,9 +49,9 @@ module TrafficJam
       result =
         begin
           redis.evalsha(
-            Scripts::INCREMENT_SIMPLE_HASH, keys: [key], argv: argv)
+            Scripts::INCREMENT_GCRA_HASH, keys: [key], argv: argv)
         rescue Redis::CommandError
-          redis.eval(Scripts::INCREMENT_SIMPLE, keys: [key], argv: argv)
+          redis.eval(Scripts::INCREMENT_GCRA, keys: [key], argv: argv)
         end
 
       case result
@@ -57,7 +64,7 @@ module TrafficJam
       else
         raise Errors::UnknownReturnValue,
               "Received unexpected return value #{result} from " \
-              "increment_simple eval"
+              "increment_gcra eval"
       end
     end
 
@@ -91,4 +98,7 @@ module TrafficJam
       "#{config.key_prefix}:s"
     end
   end
+
+  # alias for backward compatibility
+  SimpleLimit = GCRALimit
 end

data/lib/traffic_jam/scripts.rb

@@ -10,8 +10,8 @@ module TrafficJam
 
     INCREMENT_SCRIPT = load('increment')
     INCREMENT_SCRIPT_HASH = Digest::SHA1.hexdigest(INCREMENT_SCRIPT)
-    INCREMENT_SIMPLE = load('increment_simple')
-    INCREMENT_SIMPLE_HASH = Digest::SHA1.hexdigest(INCREMENT_SIMPLE)
+    INCREMENT_GCRA = load('increment_gcra')
+    INCREMENT_GCRA_HASH = Digest::SHA1.hexdigest(INCREMENT_GCRA)
     INCREMENT_ROLLING = load('increment_rolling')
     INCREMENT_ROLLING_HASH = Digest::SHA1.hexdigest(INCREMENT_ROLLING)
     INCRBY = load('incrby')

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: traffic_jam
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jim Posen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2018-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -47,16 +53,16 @@ files:
 - lib/traffic_jam.rb
 - lib/traffic_jam/configuration.rb
 - lib/traffic_jam/errors.rb
+- lib/traffic_jam/gcra_limit.rb
 - lib/traffic_jam/lifetime_limit.rb
 - lib/traffic_jam/limit.rb
 - lib/traffic_jam/limit_group.rb
 - lib/traffic_jam/rolling_limit.rb
 - lib/traffic_jam/scripts.rb
-- lib/traffic_jam/simple_limit.rb
 - scripts/incrby.lua
 - scripts/increment.lua
+- scripts/increment_gcra.lua
 - scripts/increment_rolling.lua
-- scripts/increment_simple.lua
 - scripts/sum_rolling.lua
 homepage: https://github.com/coinbase/traffic_jam
 licenses:
@@ -78,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Library for time-based rate limiting