ratelimit 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b05cd16072c91b5a26037a5455e7ae1d5952eea22e0b17187a3e25be4623728
-  data.tar.gz: b57fdeba66adbe85f1303ff5c4bfedead5bc6ce5d7b1d4d3608da1ebc847bb5c
+  metadata.gz: cb39d9fac25f51e2a7a95957ce738e281898774a296974b05cfa57b0ea858462
+  data.tar.gz: 6c2026639b39ebfec84029f00a4a56a78299378a8fbece227806b80a96f5058e
 SHA512:
-  metadata.gz: ef451adc48b2e6248231e43a633544bcd823013059a0736d4fb284e1b4a3d8ab002cec7ebae9b9c26e1aad5ffa192a35c3f7a623b1fd438a20ed4526a8d0d989
-  data.tar.gz: bae41807e4b35c2050353d4bdebeb0ba35b0408464901682b86e6870f6c1744162773287fcca96fc35ca2b80daa0db8a844db9f4e7ee16b5cbe46d8eb28ee36f
+  metadata.gz: 542f0e876ea9f96646b7e2241988af030f1a8c54a02710559a31433bf8f8f3f99d8efd3e589cc35a5780f7ba4f426d5b6227c65b04ed5b5f48d6541e598deeec
+  data.tar.gz: 7718a195d5afdbdf94339ca65ff7341d992f2f7d56d55ed70c8b8b450509db85db029c14e7cadfd4a41e0bcf6adf835590f424fd79750f66e6d8ec18bf033d52

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - head
+          - '3.2'
+          - '3.1'
+          - '3.0'
+          - '2.7'
+          - '2.6'
+          - '2.5'
+          - '2.4'
+          - '2.3'
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0
+
+* #45 fix inaccurate rate limit count
+
 # 1.0.4 
 
 * #41 Remove redis deprecation warning

data/README.md

@@ -1,7 +1,6 @@
 # Ratelimit: Slow your roll
 
-[![Build Status](https://secure.travis-ci.org/ejfinneran/ratelimit.svg?branch=master)](http://travis-ci.org/ejfinneran/ratelimit)
-[![Code Climate](https://img.shields.io/codeclimate/github/ejfinneran/ratelimit.svg)](https://codeclimate.com/github/ejfinneran/ratelimit)
+[![Code Climate](https://codeclimate.com/github/ejfinneran/ratelimit.png)](https://codeclimate.com/github/ejfinneran/ratelimit)
 [![Coverage Status](https://img.shields.io/coveralls/ejfinneran/ratelimit.svg)](https://coveralls.io/r/ejfinneran/ratelimit)
 
 Ratelimit provides a way to rate limit actions across multiple servers using Redis.  This is a port of RateLimit.js found [here](https://github.com/chriso/redback/blob/master/lib/advanced_structures/RateLimit.js) and inspired by [this post](https://gist.github.com/chriso/54dd46b03155fcf555adccea822193da).

data/lib/ratelimit/version.rb

@@ -1,3 +1,3 @@
 class Ratelimit
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/lib/ratelimit.rb

@@ -2,6 +2,35 @@ require 'redis'
 require 'redis-namespace'
 
 class Ratelimit
+  COUNT_LUA_SCRIPT = <<-LUA.freeze
+    local subject = KEYS[1]
+    local oldest_bucket = tonumber(ARGV[1])
+    local current_bucket = tonumber(ARGV[2])
+    local count = 0
+
+    for bucket = oldest_bucket + 1, current_bucket do
+      local value = redis.call('HGET', subject, tostring(bucket))
+      if value then
+        count = count + tonumber(value)
+      end
+    end
+
+    return count
+  LUA
+
+  MAINTENANCE_LUA_SCRIPT = <<-LUA.freeze
+    local subject = KEYS[1]
+    local oldest_bucket = tonumber(ARGV[1])
+
+    -- Delete expired keys
+    local all_keys = redis.call('HKEYS', subject)
+    for _, key in ipairs(all_keys) do
+      local bucket_key = tonumber(key)
+      if bucket_key < oldest_bucket then
+        redis.call('HDEL', subject, tostring(bucket_key))
+      end
+    end
+  LUA
 
   # Create a Ratelimit object.
   #
@@ -30,6 +59,7 @@ class Ratelimit
       raise ArgumentError.new("Cannot have less than 3 buckets")
     end
     @raw_redis = options[:redis]
+    load_scripts
   end
 
   # Add to the counter for a given subject.
@@ -41,11 +71,13 @@ class Ratelimit
   def add(subject, count = 1)
     bucket = get_bucket
     subject = "#{@key}:#{subject}"
+
+    # Cleanup expired keys every 100th request
+    cleanup_expired_keys(subject) if rand < 0.01
+
     redis.multi do |transaction|
       transaction.hincrby(subject, bucket, count)
-      transaction.hdel(subject, (bucket + 1) % @bucket_count)
-      transaction.hdel(subject, (bucket + 2) % @bucket_count)
-      transaction.expire(subject, @bucket_expiry)
+      transaction.expire(subject, @bucket_expiry + @bucket_interval)
     end.first
   end
 
@@ -54,15 +86,12 @@ class Ratelimit
   # @param [String] subject Subject for the count
   # @param [Integer] interval How far back (in seconds) to retrieve activity.
   def count(subject, interval)
-    bucket = get_bucket
     interval = [[interval, @bucket_interval].max, @bucket_span].min
-    count = (interval / @bucket_interval).floor
+    oldest_bucket = get_bucket(Time.now.to_i - interval)
+    current_bucket = get_bucket
     subject = "#{@key}:#{subject}"
 
-    keys = (0..count - 1).map do |i|
-      (bucket - i) % @bucket_count
-    end
-    return redis.hmget(subject, *keys).inject(0) {|a, i| a + i.to_i}
+    execute_script(@count_script_sha, [subject], [oldest_bucket, current_bucket])
   end
 
   # Check if the rate limit has been exceeded.
@@ -111,7 +140,30 @@ class Ratelimit
   private
 
   def get_bucket(time = Time.now.to_i)
-    ((time % @bucket_span) / @bucket_interval).floor
+    (time / @bucket_interval).floor
+  end
+
+  # Cleanup expired keys for a given subject
+  def cleanup_expired_keys(subject)
+    oldest_bucket = get_bucket(Time.now.to_i - @bucket_expiry)
+    execute_script(@maintenance_script_sha, [subject], [oldest_bucket])
+  end
+
+  # Execute the script or reload the scripts on error
+  def execute_script(*args)
+    redis.evalsha(*args)
+  rescue Redis::CommandError => e
+    raise unless e.message =~ /NOSCRIPT/
+
+    load_scripts
+    retry
+  end
+
+  # Load the lua scripts into redis
+  # This must be on the redis.redis object, not the namespace
+  def load_scripts
+    @count_script_sha = redis.redis.script(:load, COUNT_LUA_SCRIPT)
+    @maintenance_script_sha = redis.redis.script(:load, MAINTENANCE_LUA_SCRIPT)
   end
 
   def redis

data/ratelimit.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency             "redis-namespace", ">= 1.0.0"
   spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "fakeredis"
   spec.add_development_dependency "timecop"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard"

data/spec/ratelimit_spec.rb

@@ -14,6 +14,7 @@ describe Ratelimit do
         let(:options) { super().merge(redis: redis) }
 
         it 'wraps redis in redis-namespace' do
+          expect(redis).to receive(:script).with(:load, anything).twice
           expect(subject.send(:redis)).to be_instance_of(Redis::Namespace)
         end
       end
@@ -117,7 +118,6 @@ describe Ratelimit do
     expect(@value).to be 1
   end
 
-
   it "counts correctly if bucket_span equals count-interval  " do
     @r = Ratelimit.new("key", {:bucket_span => 10, bucket_interval: 1})
     @r.add('value1')

data/spec/spec_helper.rb

@@ -16,7 +16,6 @@
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require 'coveralls'
 Coveralls.wear!
-require 'fakeredis'
 require 'timecop'
 require 'ratelimit'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ratelimit
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - E.J. Finneran
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: fakeredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -159,11 +145,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt

data/.travis.yml

@@ -1,7 +0,0 @@
-script: "bundle exec rspec"
-rvm:
-  - 2.1.10
-  - 2.2
-  - 2.3
-  - 2.4.0
-  - jruby-9.0.5.0