redis-throttler 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee41934ea93c01a4563339083e4c04267b0cd89
-  data.tar.gz: 134b60d1f35fdb047bf7cd195eb0ca7153d26ec9
+  metadata.gz: d495303bb5a7733b5fd5feb751563a505d700db5
+  data.tar.gz: 5c8defae79ace760ed398e9d8565ce642dfbe11c
 SHA512:
-  metadata.gz: 486543f3afa4f34f92263547babf2a20245e285e88bc8c013827c660ae43d2ab9be645c6342767b66e86d5d1dc4ef7cf12cd0cf795ce71dd18c422aed4eb2b4c
-  data.tar.gz: 14db1b9b171195d51bf0fc5af2954adee390a8f7dcb5eb7115c49802353cc072e8b3a19181b22f9823c39d8018918f62b75059da91479df0d4750a6fc02f9fd1
+  metadata.gz: 8fc82355c9e9a62a1f06501be6eedc76231d7a0c9b90f5f3fe21730cd32cfbd476c4e6520901b69a11a5ebca9fb173d158baacf786d0f9455b8b2183e6d188c0
+  data.tar.gz: 9909db6de4dd0a69f075eb5ca6e91c345b4d7e5d6f35bdc2fc36d5e0efaa912a3f7aa42b145143c82cd13bb07ffcaf2407923ad13f13c812463c42ad34f7ac24

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.1.7 / 2016-08-01:
+
+* Fix test specs
+* Fix miscount when interval too high
+* Expand model and object tests
+
 ### 0.1.6 / 2016-08-01:
 
 * Add test specs

data/lib/redis-throttler/model.rb

@@ -16,19 +16,17 @@ module RedisThrottler
         subject = opts[:by] || :id
         limit = opts[:limit] || 5
         threshold = opts[:for] || 900
-        interval = opts[:interval] || 5
-
-        bucket_span = [interval, 600].max
+        interval = opts[:interval] || ([threshold,120].max)/120
+        bucket_span = threshold * 2
 
         throttler = RedisThrottler::Base.new("#{klass}:#{key}", bucket_interval: interval, bucket_span: bucket_span)
-        @limits[key] = "#{subject.to_s} limit #{limit} per #{threshold} sec"
+        @limits[key] = { :limit => limit, :threshold => threshold }
 
-        # includes('?') will return true
         method = "#{key}_throttler"
 
         %w(limits limits?).each do |string|
           define_singleton_method(string) { string.include?('?') || @limits }
-          define_method(string) { string.include?('?') || self.class.instance_variable_get('@limits')}
+          define_method(string) { string.include?('?') || self.class.instance_variable_get(:@limits)}
         end
 
         # i used Procs because they don't complain about arity
@@ -49,7 +47,6 @@ module RedisThrottler
           define_singleton_method("#{key}_#{magic.to_s}") { |id, within = threshold| eval meth.call(id, within) }
           define_method("#{key}_#{magic.to_s}") { |within = threshold| eval meth.call("#{self.send subject}", within) }
         end
-
       end
     end
   end

data/lib/redis-throttler/version.rb

@@ -1,3 +1,3 @@
 module RedisThrottler
-   VERSION = '0.1.6'
+   VERSION = '0.1.7'
 end

data/spec/model_spec.rb

@@ -2,29 +2,37 @@ require 'spec_helper'
 
 describe TestClass do
 
-  it 'should be able to define throttle' do
-    expect(TestClass).to respond_to :throttle
+  # we will test the firstly defined throttle
+  before do
+    throttle = TestClass.instance_variable_get(:@limits)
+    key = throttle.keys[0]
+    @count_to_fail = throttle[key][:limit]
+    @time_til_okay = throttle[key][:threshold]
   end
 
-  it 'should have a throttler for defined throttle' do
-    expect(TestClass.logins_throttler.class).to eq(RedisThrottler::Base)
+  it 'Klass.throttle' do
+    expect(TestClass).to respond_to :throttle
   end
 
-  it 'should display limits as hash' do
+  it '.limits' do
     expect(TestClass.limits).to be_a(Hash)
   end
 
-  it 'should respond to limits? correctly' do
+  it '.limits?' do
     expect(TestClass.limits?).to eq(true)
   end
 
-  it 'should be able to increment throttler by subject' do
+  it '.#{key}_throttler' do
+    expect(TestClass.logins_throttler.class).to eq(RedisThrottler::Base)
+  end
+
+  it '.#{key}_increments(id)' do
     TestClass.logins_increment('testid')
     TestClass.logins_increment('testid')
     expect(TestClass.logins_count('testid')).to eq(2)
   end
 
-  it 'should responsd to exceeded? correctly' do
+  it '.#{key}_exceeded?(id)' do
     TestClass.logins_throttler.add('testid', 10)
     expect(TestClass.logins_exceeded?('testid')).to eq(true)
 
@@ -32,17 +40,18 @@ describe TestClass do
     expect(TestClass.logins_exceeded?('testid2')).to eq(false)
   end
 
-  it 'should not be rate-limited after interval' do
+  it 'counts right' do
+    @count_to_fail.times { TestClass.logins_increment('test4') }
+    expect(TestClass.logins_count('test4')).to eq(TestClass.logins_throttler.count('test4', 60))
+  end
+
+  it 'recovers after limit passed' do
     expect(TestClass.logins_exceeded?('test3')).to eq(false)
-    10.times { TestClass.logins_increment('test3') }
+    @count_to_fail.times { TestClass.logins_increment('test3') }
+
     expect(TestClass.logins_exceeded?('test3')).to eq(true)
-    Timecop.travel(60) do
+    Timecop.travel(@time_til_okay) do
       expect(TestClass.logins_exceeded?('test3')).to eq(false)
     end
   end
-
-  it 'should return counter value for subject within defined limits' do
-    10.times { TestClass.logins_increment('test4') }
-    expect(TestClass.logins_count('test4')).to eq(TestClass.logins_throttler.count('test4', 60))
-  end
 end

data/spec/object_spec.rb

@@ -3,40 +3,64 @@ require 'spec_helper'
 describe 'Instace of TestClass' do
   before do
     @test = TestClass.new
+    throttle = TestClass.instance_variable_get(:@limits)
+    key = throttle.keys[0]
+    @count_to_fail = throttle[key][:limit]
+    @time_til_okay = throttle[key][:threshold]
   end
 
-  it 'should have a throttler for defined throttle' do
-    expect(@test.logins_throttler.class).to eq(RedisThrottler::Base)
+  it 'includes RedisThrottler' do
+    expect(@test).to be_a_kind_of(RedisThrottler)
   end
 
-  it 'should display limits as hash' do
+  it '.limits' do
     expect(@test.limits).to be_a(Hash)
   end
 
-  it 'should respond to limits? correctly' do
+  it '.limits?' do
     expect(@test.limits?).to eq(true)
   end
 
-  it 'should be able to increment throttler by subject' do
+  it '.#{key}_throttler' do
+    expect(@test.logins_throttler.class).to eq(RedisThrottler::Base)
+  end
+
+  it '.#{key}_increment' do
     @test.logins_increment
     @test.logins_increment
     expect(@test.logins_count).to eq(2)
   end
 
-  it 'should responsd to exceeded? correctly' do
-    10.times do
+  it '.#{key}_exceeded?' do
+    @count_to_fail.times do
       @test.logins_increment
     end
     expect(@test.logins_exceeded?).to eq(true)
   end
 
-  it 'should not be rate-limited after interval' do
-    Timecop.travel(60) do
+  it 'counts right' do
+    expect(@test.logins_count).to eq(TestClass.logins_count(@test.id))
+
+    4.times { @test.logins_increment }
+
+    Timecop.travel(@time_til_okay) do
+      (@count_to_fail - 1).times do
+        @test.logins_increment
+      end
+
+      expect(@test.logins_count(1)).to eq(@count_to_fail - 1)
       expect(@test.logins_exceeded?).to eq(false)
     end
   end
 
-  it 'should return counter value for subject within defined limits' do
-    expect(@test.logins_count).to eq(TestClass.logins_count(@test.id))
+
+  it 'recovers after limit passed' do
+    @count_to_fail.times do
+      @test.logins_increment
+    end
+    expect(@test.logins_exceeded?).to eq(true)
+    Timecop.travel(@time_til_okay) do
+      expect(@test.logins_exceeded?).to eq(false)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ require 'timecop'
 
 class TestClass
   include RedisThrottler
-  throttle :logins, limit: 10, for: 60
+  throttle :logins, limit: 10, for: 5000
 
   def initialize
     @id = 1234
@@ -15,3 +15,5 @@ class TestClass
     @id
   end
 end
+
+@test = TestClass.new

data/spec/throttler_spec.rb

@@ -7,23 +7,23 @@ describe RedisThrottler::Base do
     @rl.send(:redis).flushdb
   end
 
-  it 'should set_bucket_expiry to the bucket_span if not defined' do
+  it 'sets set_bucket_expiry to the bucket_span if not defined' do
     expect(@rl.instance_variable_get(:@bucket_span)).to eq(@rl.instance_variable_get(:@bucket_expiry))
   end
 
-  it 'should not allow bucket count less than 3' do
+  it 'does not allow bucket count less than 3' do
     expect do
       RedisThrottler::Base.new('test', {:bucket_span => 1, :bucket_interval => 1})
     end.to raise_error(ArgumentError)
   end
 
-  it 'should not allow bucket expiry to be larger than the bucket span' do
+  it 'does not allow bucket_expiry > bucket_span' do
     expect do
       RedisThrottler::Base.new("key", {:bucket_expiry => 1200})
     end.to raise_error(ArgumentError)
   end
 
-  it 'should be able to add to the count for a given subject' do
+  it '.add(\'string\', 1)' do
     @rl.add('value1')
     @rl.add('value1')
     expect(@rl.count('value1', 1)).to eq(2)
@@ -33,12 +33,12 @@ describe RedisThrottler::Base do
     end
   end
 
-  it 'should be able to add to the count by more than 1' do
+  it '.add(\'string\', 3)' do
     @rl.add('value1', 3)
     expect(@rl.count('value1', 1)).to eq(3)
   end
 
-  it 'should be able to add to the count for a non-string subject' do
+  it '.add(123, 1)' do
     @rl.add(123)
     @rl.add(123)
     expect(@rl.count(123, 1)).to eq(2)
@@ -48,12 +48,12 @@ describe RedisThrottler::Base do
     end
   end
 
-  it 'should return counter value' do
+  it '.count' do
     counter_value = @rl.add("value1")
     expect(@rl.count("value1", 1)).to eq(counter_value)
   end
 
-  it 'respond to exceeded? method correctly' do
+  it '.exceeded?' do
     5.times do
       @rl.add("value1")
     end
@@ -69,7 +69,7 @@ describe RedisThrottler::Base do
     expect(@rl.within_bounds?("value1", {:threshold => 10, :interval => 30})).to be false
   end
 
-  it "accept a threshold and a block that gets executed once it's below the threshold" do
+  it 'accepts a threshold and a block that gets executed once it\'s below the threshold' do
     expect(@rl.count("key", 30)).to eq(0)
     31.times do
       @rl.add("key")
@@ -93,7 +93,7 @@ describe RedisThrottler::Base do
     expect(@value).to be 1
   end
 
-  it 'counts correclty if bucket_span equals count-interval  ' do
+  it 'counts correctly when bucket_span equals count-interval ' do
     @rl = RedisThrottler::Base.new('key', {:bucket_span => 10, bucket_interval: 1})
     @rl.add('value1')
     expect(@rl.count('value1', 10)).to eql(1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-throttler
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Evan Surdam