ratelimit 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9759fc3e7da10acf75e0b15ba6f90a901257543
-  data.tar.gz: b3bcdc0daa3076dfe081942e90a922125a772019
+  metadata.gz: 3ca5c11e810378b9f764fc4df1a9eb95c5be682f
+  data.tar.gz: 29be916842600285b975409daa377a6ef0a47d7b
 SHA512:
-  metadata.gz: e4a346d5455ff73cd2218f312ac08f098f2acc80041995a1b9e00ad93dfa37ba27d27be293c2a741f15e2963416083008e7aecdac3f7f96498f32eef37d39a8b
-  data.tar.gz: 7af9dcaddc5bf2f17cb8d335384c3f87eda9336fd0303f3ad8b7ec1c99bdd9c81bcec37cc7e491d77548c974a19b7abcebfc475d694f51398cb941d346fc1334
+  metadata.gz: a8bf4fdb9ccb0e298870c1cb6e19d44e90d9fb92d5f5f311dd7d68eff139150c38b1a7bfcd3175c0cff317b3d96fbe02c72f20a4acdf26243cd3c28f4a74d0b3
+  data.tar.gz: fa1910970d4f93ec8e5c947012344a002bb0e8f7ed56b130fb8b454ae9ff373a140dd2e9e4865bd13772e51ba5485ca2448f0c2165f92d7549c41756d8935bbf

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/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.rb

@@ -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,7 +41,7 @@ class Ratelimit
   def add(subject, count = 1)
     bucket = get_bucket
     subject = "#{@key}:#{subject}"
-    redis.pipelined do
+    redis.multi do
       redis.hincrby(subject, bucket, count)
       redis.hdel(subject, (bucket + 1) % @bucket_count)
       redis.hdel(subject, (bucket + 2) % @bucket_count)
@@ -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/lib/ratelimit/version.rb

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

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.3
 platform: ruby
 authors:
 - E.J. Finneran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -201,4 +201,3 @@ summary: Rate limiting backed by redis
 test_files:
 - spec/ratelimit_spec.rb
 - spec/spec_helper.rb
-has_rdoc: