ratelimit 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9759fc3e7da10acf75e0b15ba6f90a901257543
-  data.tar.gz: b3bcdc0daa3076dfe081942e90a922125a772019
+SHA256:
+  metadata.gz: 0b05cd16072c91b5a26037a5455e7ae1d5952eea22e0b17187a3e25be4623728
+  data.tar.gz: b57fdeba66adbe85f1303ff5c4bfedead5bc6ce5d7b1d4d3608da1ebc847bb5c
 SHA512:
-  metadata.gz: e4a346d5455ff73cd2218f312ac08f098f2acc80041995a1b9e00ad93dfa37ba27d27be293c2a741f15e2963416083008e7aecdac3f7f96498f32eef37d39a8b
-  data.tar.gz: 7af9dcaddc5bf2f17cb8d335384c3f87eda9336fd0303f3ad8b7ec1c99bdd9c81bcec37cc7e491d77548c974a19b7abcebfc475d694f51398cb941d346fc1334
+  metadata.gz: ef451adc48b2e6248231e43a633544bcd823013059a0736d4fb284e1b4a3d8ab002cec7ebae9b9c26e1aad5ffa192a35c3f7a623b1fd438a20ed4526a8d0d989
+  data.tar.gz: bae41807e4b35c2050353d4bdebeb0ba35b0408464901682b86e6870f6c1744162773287fcca96fc35ca2b80daa0db8a844db9f4e7ee16b5cbe46d8eb28ee36f

data/.travis.yml

@@ -1,9 +1,7 @@
 script: "bundle exec rspec"
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - 2.1.2
-  - rbx-2
-  - jruby-19mode
+  - 2.1.10
+  - 2.2
+  - 2.3
+  - 2.4.0
+  - jruby-9.0.5.0

data/CHANGELOG.md

@@ -1,9 +1,21 @@
+# 1.0.4 
+
+* #41 Remove redis deprecation warning
+
+# 1.0.3
+
+* #28 Fix counting the same buckets multiple times when the interval > bucket_span
+
+# 1.0.2 09/09/2014
+
+* #15 Raise error if bucket_count too small
+
 # 1.0.1 08/05/2014
+
 * #14 fix issue with wrong count on bucket_span == count(..interval) - @olgen
 
 # 1.0.0 06/15/2014
 
-
 * #7 Allow adding more than one to a counter - @Nielsomat
 * #8 Add Ruby 2 support and remove Ruby 1.8 support
 * #6 Clean up initialization method
@@ -16,7 +28,6 @@
 * Allow non-string subject and key -- Thanks Alexey Noskov
 Fix for bucket_expiry allowed to be larger than bucket_span and causing bad results -- Thanks Alexey Noskov
 
-
 # 0.0.2 10/29/2011
 
 Initial Relase

data/README.md

@@ -4,7 +4,7 @@
 [![Code Climate](https://img.shields.io/codeclimate/github/ejfinneran/ratelimit.svg)](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](http://chris6f.com/rate-limiting-with-redis).
+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).
 
 
 ## Installation
@@ -58,6 +58,7 @@ You can also pass a block that will only get executed if the given threshold is
 ``` rb
 ratelimit.exec_within_threshold phone_number, threshold: 10, interval: 30 do
   some_rate_limited_code
+  ratelimit.add(phone_number)
 end
 ```
 

data/lib/ratelimit/version.rb

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

data/lib/ratelimit.rb

@@ -3,7 +3,7 @@ require 'redis-namespace'
 
 class Ratelimit
 
-  # Create a RateLimit object.
+  # Create a Ratelimit object.
   #
   # @param [String] key A name to uniquely identify this rate limit. For example, 'emails'
   # @param [Hash] options Options hash
@@ -12,7 +12,7 @@ class Ratelimit
   # @option options [Integer] :bucket_expiry (@bucket_span) How long we keep data in each bucket before it is auto expired. Cannot be larger than the bucket_span.
   # @option options [Redis]   :redis (nil) Redis client if you need to customize connection options
   #
-  # @return [RateLimit] RateLimit instance
+  # @return [Ratelimit] Ratelimit instance
   #
   def initialize(key, options = {})
     @key = key
@@ -29,7 +29,7 @@ class Ratelimit
     if @bucket_count < 3
       raise ArgumentError.new("Cannot have less than 3 buckets")
     end
-    @redis = options[:redis]
+    @raw_redis = options[:redis]
   end
 
   # Add to the counter for a given subject.
@@ -41,11 +41,11 @@ class Ratelimit
   def add(subject, count = 1)
     bucket = get_bucket
     subject = "#{@key}:#{subject}"
-    redis.pipelined do
-      redis.hincrby(subject, bucket, count)
-      redis.hdel(subject, (bucket + 1) % @bucket_count)
-      redis.hdel(subject, (bucket + 2) % @bucket_count)
-      redis.expire(subject, @bucket_expiry)
+    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)
     end.first
   end
 
@@ -55,7 +55,7 @@ class Ratelimit
   # @param [Integer] interval How far back (in seconds) to retrieve activity.
   def count(subject, interval)
     bucket = get_bucket
-    interval = [interval, @bucket_interval].max
+    interval = [[interval, @bucket_interval].max, @bucket_span].min
     count = (interval / @bucket_interval).floor
     subject = "#{@key}:#{subject}"
 
@@ -97,6 +97,7 @@ class Ratelimit
   # @example Send an email as long as we haven't send 5 in the last 10 minutes
   #   ratelimit.exec_with_threshold(email, [:threshold => 5, :interval => 600]) do
   #     send_another_email
+  #     ratelimit.add(email)
   #   end
   def exec_within_threshold(subject, options = {}, &block)
     options[:threshold] ||= 30
@@ -114,6 +115,6 @@ class Ratelimit
   end
 
   def redis
-    @redis ||= Redis::Namespace.new(:ratelimit, :redis => @redis || Redis.new)
+    @redis ||= Redis::Namespace.new(:ratelimit, redis: @raw_redis || Redis.new)
   end
 end

data/ratelimit.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency             "redis", ">= 2.0.0"
+  spec.add_dependency             "redis", ">= 3.0.0"
   spec.add_dependency             "redis-namespace", ">= 1.0.0"
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "fakeredis"
   spec.add_development_dependency "timecop"

data/spec/ratelimit_spec.rb

@@ -1,6 +1,24 @@
 require 'spec_helper'
 
 describe Ratelimit do
+  describe '.initialize' do
+    subject { described_class.new(key, options) }
+
+    let(:options) { Hash.new }
+
+    context 'with key' do
+      let(:key) { 'key' }
+
+      context 'with redis option' do
+        let(:redis) { double('redis') }
+        let(:options) { super().merge(redis: redis) }
+
+        it 'wraps redis in redis-namespace' do
+          expect(subject.send(:redis)).to be_instance_of(Redis::Namespace)
+        end
+      end
+    end
+  end
 
   before do
     @r = Ratelimit.new("key")
@@ -75,7 +93,7 @@ describe Ratelimit do
     expect(@r.within_bounds?("value1", {:threshold => 10, :interval => 30})).to be false
   end
 
-  it "accept a threshhold and a block that gets executed once it's below the threshold" do
+  it "accept a threshold and a block that gets executed once it's below the threshold" do
     expect(@r.count("key", 30)).to eq(0)
     31.times do
       @r.add("key")
@@ -100,10 +118,15 @@ describe Ratelimit do
   end
 
 
-  it "counts correclty if bucket_span equals count-interval  " do
+  it "counts correctly if bucket_span equals count-interval  " do
     @r = Ratelimit.new("key", {:bucket_span => 10, bucket_interval: 1})
     @r.add('value1')
     expect(@r.count('value1', 10)).to eql(1)
   end
 
+  it "counts correctly if interval is greater than bucket_span" do
+    @r = Ratelimit.new("key", { bucket_span: 10, bucket_interval: 1})
+    @r.add('value1')
+    expect(@r.count('value1', 40)).to eql(1)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ratelimit
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - E.J. Finneran
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
@@ -42,14 +42,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -178,7 +178,7 @@ homepage: https://github.com/ejfinneran/ratelimit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,12 +193,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Rate limiting backed by redis
 test_files:
 - spec/ratelimit_spec.rb
 - spec/spec_helper.rb
-has_rdoc: