prorate 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2c78403fd3d37fd073ccf736618673e532c6fc53efd7e1c342c7edebc4037f
-  data.tar.gz: 497b74b1d07d1590e44f338f7150b6b75fe5ed154af82d052381915a2b174c69
+  metadata.gz: 7e00071a8bb75be7ca3c74ecaf662e049f5c55cae7cb867c9851062efd5b8073
+  data.tar.gz: 277671f9b2dcce7d032e9f9f38b294ced2ca953cd0f85b940d488f3ff306ee38
 SHA512:
-  metadata.gz: d2a262971d745073dfd385088d92bf40667fa8108e6c3b71982b17fad41d6ee94472e40f8189badfa6131ac853a0dfe381e9bfbef93a0b7bbd24c3f39339251f
-  data.tar.gz: 33f4f60558e7cee9fd671ebe48f4e35fc67e58c2ea5ad5cde5e40368b8b486e941eabb71ddf3dfaa87a9380689d31c059d56ea81cfa8860a955409d075840824
+  metadata.gz: 40e22d2cdb70cb407b7cc2135624a373e95e83514cfa8bb2f42a6106b40640b458a017212967fb533ba080e3e4707199a1fb1e2414b68f1289e1d24b15b05fbc
+  data.tar.gz: 269d8ef7d384c08c928d3bed3412b2e7ae470e696ff03042744c79bd696962a9a7a82d099de8a153aef344029f40e8640d4e772bee90054b64b4f0183c96d2c9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.7.1
+
+* Fix use of a ConnectionPool as `redis:` argument which was broken in 0.7.0
+* Use the Lua KEYS argument in `rate_limit.lua` for future-proof clustering support
+  instead of computing the touched keys inside the Lua script.
+
 # 0.7.0
 
 * Add a naked `LeakyBucket` object which allows one to build sophisticated rate limiting relying

data/Rakefile

@@ -9,6 +9,10 @@ YARD::Rake::YardocTask.new(:doc) do |t|
   t.files = ['lib/**/*.rb', '-', 'LICENSE.txt', 'CHANGELOG.md']
 end
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["-c", "--order=rand"]
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
 RuboCop::RakeTask.new(:rubocop)
 task default: [:spec, :rubocop]

data/lib/prorate/leaky_bucket.rb

@@ -60,7 +60,7 @@ module Prorate
     #   If your bucket is specific to a user, a browser or an IP address you need to mix in
     #   those values into the key prefix as appropriate.
     # @param leak_rate[Float] the leak rate of the bucket, in tokens per second
-    # @param redis[Redis,#with] a Redis connection or a ConnectonPool instance
+    # @param redis[Redis,#with] a Redis connection or a ConnectionPool instance
     #   if you are using the connection_pool gem. With a connection pool Prorate will
     #   checkout a connection using `#with` and check it in when it's done.
     # @param bucket_capacity[Numeric] how many tokens is the bucket capped at.
@@ -70,7 +70,7 @@ module Prorate
     #   of 12, and will then immediately start leaking again.
     def initialize(redis_key_prefix:, leak_rate:, redis:, bucket_capacity:)
       @redis_key_prefix = redis_key_prefix
-      @redis = NullPool.new(redis) unless redis.respond_to?(:with)
+      @redis = redis.respond_to?(:with) ? redis : NullPool.new(redis)
       @leak_rate = leak_rate.to_f
       @capacity = bucket_capacity.to_f
     end

data/lib/prorate/rate_limit.lua

@@ -8,13 +8,21 @@
 redis.replicate_commands()
 -- make some nicer looking variable names:
 local retval = nil
-local bucket_level_key = ARGV[1] .. ".bucket_level"
-local last_updated_key = ARGV[1] .. ".last_updated"
-local block_key = ARGV[1] .. ".block"
-local max_bucket_capacity = tonumber(ARGV[2])
-local leak_rate = tonumber(ARGV[3])
-local block_duration = tonumber(ARGV[4])
-local n_tokens = tonumber(ARGV[5]) -- How many tokens this call adds to the bucket. Defaults to 1
+
+-- Redis documentation recommends passing the keys separately so that Redis
+-- can - in the future - verify that they live on the same shard of a cluster, and
+-- raise an error if they are not. As far as can be understood this functionality is not
+-- yet present, but if we can make a little effort to make ourselves more future proof
+-- we should.
+local bucket_level_key = KEYS[1]
+local last_updated_key = KEYS[2]
+local block_key = KEYS[3]
+
+-- and the config variables
+local max_bucket_capacity = tonumber(ARGV[1])
+local leak_rate = tonumber(ARGV[2])
+local block_duration = tonumber(ARGV[3])
+local n_tokens = tonumber(ARGV[4]) -- How many tokens this call adds to the bucket. Defaults to 1
 
 -- Take the Redis timestamp
 local redis_time = redis.call("TIME") -- Array of [seconds, microseconds]

data/lib/prorate/throttle.rb

@@ -13,7 +13,7 @@ module Prorate
     def initialize(name:, limit:, period:, block_for:, redis:, logger: Prorate::NullLogger)
       @name = name.to_s
       @discriminators = [name.to_s]
-      @redis = NullPool.new(redis) unless redis.respond_to?(:with)
+      @redis = redis.respond_to?(:with) ? redis : NullPool.new(redis)
       @logger = logger
       @block_for = block_for
 
@@ -135,9 +135,15 @@ module Prorate
     end
 
     def run_lua_throttler(identifier:, bucket_capacity:, leak_rate:, block_for:, n_tokens:)
+      # Computing the identifier is somewhat involved so we should avoid doing it too often
+      id = identifier
+      bucket_level_key = "#{id}.bucket_level"
+      last_updated_key = "#{id}.last_updated"
+      block_key = "#{id}.block"
+
       @redis.with do |redis|
         begin
-          redis.evalsha(LUA_SCRIPT_HASH, [], [identifier, bucket_capacity, leak_rate, block_for, n_tokens])
+          redis.evalsha(LUA_SCRIPT_HASH, keys: [bucket_level_key, last_updated_key, block_key], argv: [bucket_capacity, leak_rate, block_for, n_tokens])
         rescue Redis::CommandError => e
           if e.message.include? "NOSCRIPT"
             # The Redis server has never seen this script before. Needs to run only once in the entire lifetime

data/lib/prorate/version.rb

@@ -1,3 +1,3 @@
 module Prorate
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prorate
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Time-restricted rate limiter using Redis