redis-throttler 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3648bd744161a9c30693fd53fb7bfb490ab54f3
-  data.tar.gz: 1b7c3424b04912da66ed591db45e14a36e518e5d
+  metadata.gz: aee41934ea93c01a4563339083e4c04267b0cd89
+  data.tar.gz: 134b60d1f35fdb047bf7cd195eb0ca7153d26ec9
 SHA512:
-  metadata.gz: 7bff0a3c2299681c052da3d0333f6c7858ae5b689a2c434ead0e18de1bcfa83dbc94b9f241afb4509fe05c5eef3c2d5b9c5cd18cc0faf6b2aae0b20abd8f0bfa
-  data.tar.gz: bf0eac98c7f1cff826f20c79330f135b4252d58d8b47b77ce45000e20521d0df3dffebd52450efd4abb1d330e0217c2c289d15600d426a8f27610cf3af6ee1cd
+  metadata.gz: 486543f3afa4f34f92263547babf2a20245e285e88bc8c013827c660ae43d2ab9be645c6342767b66e86d5d1dc4ef7cf12cd0cf795ce71dd18c422aed4eb2b4c
+  data.tar.gz: 14db1b9b171195d51bf0fc5af2954adee390a8f7dcb5eb7115c49802353cc072e8b3a19181b22f9823c39d8018918f62b75059da91479df0d4750a6fc02f9fd1

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.1.6 / 2016-08-01:
+
+* Add test specs
+
+### 0.1.5 / 2016-07-31
+
+* Initial upload of lib:
+
 ### 0.1.0 / 2016-07-31
 
 * Initial release:

data/gemspec.yml

@@ -14,4 +14,5 @@ development_dependencies:
   rake: ~> 10.0
   rspec: ~> 3.0
   rubygems-tasks: ~> 0.2
+  timecop: ~> 0.8
   yard: ~> 0.8

data/lib/redis-throttler/base.rb

@@ -114,7 +114,7 @@ module RedisThrottler
     end
 
     def redis
-      @redis ||= Redis.new(host: '192.168.99.100', port: 32771)
+      @redis ||= Redis.new(host: '192.168.99.100', port: 32768)
     end
   end
 end

data/lib/redis-throttler/model.rb

@@ -18,29 +18,31 @@ module RedisThrottler
         threshold = opts[:for] || 900
         interval = opts[:interval] || 5
 
-        limiter = RedisThrottler::Base.new("#{klass}:#{key}", bucket_interval: interval, bucket_span: threshold)
+        bucket_span = [interval, 600].max
+
+        throttler = RedisThrottler::Base.new("#{klass}:#{key}", bucket_interval: interval, bucket_span: bucket_span)
         @limits[key] = "#{subject.to_s} limit #{limit} per #{threshold} sec"
 
         # includes('?') will return true
-        method = "#{key}_limiter"
+        method = "#{key}_throttler"
 
         %w(limits limits?).each do |string|
           define_singleton_method(string) { string.include?('?') || @limits }
-          define_method(string) { string.include?('?') || @limits }
+          define_method(string) { string.include?('?') || self.class.instance_variable_get('@limits')}
         end
 
         # i used Procs because they don't complain about arity
         # these Procs will return a string to be evaluated in context
 
         methods = {
-            :exceeded? => proc { |to_call| "#{method}.exceeded? \"#{to_call}\", threshold: #{limit}, interval: #{threshold}" },
+            :exceeded? => proc { |to_call, within| "#{method}.exceeded? \"#{to_call}\", threshold: #{limit}, interval: #{within}" },
             :increment => proc { |to_call| "#{method}.add(\"#{to_call}\")" },
             :count => proc { |to_call, within| "#{method}.count(\"#{to_call}\", #{within})" }
         }
 
         # define the class & instance methods
         # pass the id to access counters
-        define_singleton_method(method) { limiter }
+        define_singleton_method(method) { throttler }
         define_method(method) { self.class.send method }
 
         methods.each do |magic, meth|

data/lib/redis-throttler/version.rb

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

data/spec/model_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe TestClass do
+
+  it 'should be able to define throttle' do
+    expect(TestClass).to respond_to :throttle
+  end
+
+  it 'should have a throttler for defined throttle' do
+    expect(TestClass.logins_throttler.class).to eq(RedisThrottler::Base)
+  end
+
+  it 'should display limits as hash' do
+    expect(TestClass.limits).to be_a(Hash)
+  end
+
+  it 'should respond to limits? correctly' do
+    expect(TestClass.limits?).to eq(true)
+  end
+
+  it 'should be able to increment throttler by subject' 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
+    TestClass.logins_throttler.add('testid', 10)
+    expect(TestClass.logins_exceeded?('testid')).to eq(true)
+
+    TestClass.logins_throttler.add('testid2', 9)
+    expect(TestClass.logins_exceeded?('testid2')).to eq(false)
+  end
+
+  it 'should not be rate-limited after interval' do
+    expect(TestClass.logins_exceeded?('test3')).to eq(false)
+    10.times { TestClass.logins_increment('test3') }
+    expect(TestClass.logins_exceeded?('test3')).to eq(true)
+    Timecop.travel(60) 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

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Instace of TestClass' do
+  before do
+    @test = TestClass.new
+  end
+
+  it 'should have a throttler for defined throttle' do
+    expect(@test.logins_throttler.class).to eq(RedisThrottler::Base)
+  end
+
+  it 'should display limits as hash' do
+    expect(@test.limits).to be_a(Hash)
+  end
+
+  it 'should respond to limits? correctly' do
+    expect(@test.limits?).to eq(true)
+  end
+
+  it 'should be able to increment throttler by subject' 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
+      @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
+      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))
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,17 @@
 require 'rspec'
 require 'redis-throttler'
 require 'redis-throttler/base'
+require 'timecop'
 
+class TestClass
+  include RedisThrottler
+  throttle :logins, limit: 10, for: 60
+
+  def initialize
+    @id = 1234
+  end
+
+  def id
+    @id
+  end
+end

data/spec/throttler_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe RedisThrottler do
+describe RedisThrottler::Base do
 
   before do
     @rl = RedisThrottler::Base.new('test')
@@ -24,18 +24,18 @@ describe RedisThrottler do
   end
 
   it 'should be able to add to the count for a given subject' do
-    @rl.add("value1")
-    @rl.add("value1")
+    @rl.add('value1')
+    @rl.add('value1')
     expect(@rl.count('value1', 1)).to eq(2)
-    expect(@rl.count("value2", 1)).to eq(0)
-    # Timecop.travel(600) do
-    #   expect(@rl.count("value1", 1)).to eq(0)
-    # end
+    expect(@rl.count('value2', 1)).to eq(0)
+    Timecop.travel(60) do
+      expect(@rl.count('value1', 1)).to eq(0)
+    end
   end
 
   it 'should be able to add to the count by more than 1' do
-    @rl.add("value1", 3)
-    expect(@rl.count("value1", 1)).to eq(3)
+    @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
@@ -43,9 +43,9 @@ describe RedisThrottler do
     @rl.add(123)
     expect(@rl.count(123, 1)).to eq(2)
     expect(@rl.count(124, 1)).to eq(0)
-    # Timecop.travel(10) do
-    #   expect(@rl.count(123, 1)).to eq(0)
-    # end
+    Timecop.travel(10) do
+      expect(@rl.count(123, 1)).to eq(0)
+    end
   end
 
   it 'should return counter value' do
@@ -69,29 +69,29 @@ describe RedisThrottler 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
-  #   expect(@rl.count("key", 30)).to eq(0)
-  #   31.times do
-  #     @rl.add("key")
-  #   end
-  #   expect(@rl.count("key", 30)).to eq(31)
-  #
-  #   @value = nil
-  #   expect do
-  #     timeout(1) do
-  #       @rl.exec_within_threshold("key", {:threshold => 30, :interval => 30}) do
-  #         @value = 2
-  #       end
-  #     end
-  #   end.to raise_error(Timeout::Error)
-  #   expect(@value).to be nil
-  #   # Timecop.travel(40) do
-  #   #   @rl.exec_within_threshold("key", {:threshold => 30, :interval => 30}) do
-  #   #     @value = 1
-  #   #   end
-  #   # end
-  #   # expect(@value).to be 1
-  # end
+  it "accept 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")
+    end
+    expect(@rl.count("key", 30)).to eq(31)
+
+    @value = nil
+    expect do
+      Timeout.timeout(1) do
+        @rl.exec_within_threshold("key", {:threshold => 30, :interval => 30}) do
+          @value = 2
+        end
+      end
+    end.to raise_error(Timeout::Error)
+    expect(@value).to be nil
+    Timecop.travel(40) do
+      @rl.exec_within_threshold("key", {:threshold => 30, :interval => 30}) do
+        @value = 1
+      end
+    end
+    expect(@value).to be 1
+  end
 
   it 'counts correclty if bucket_span equals count-interval  ' do
     @rl = RedisThrottler::Base.new('key', {:bucket_span => 10, bucket_interval: 1})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-throttler
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Evan Surdam
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,8 @@ files:
 - lib/redis-throttler/model.rb
 - lib/redis-throttler/version.rb
 - redis-throttler.gemspec
+- spec/model_spec.rb
+- spec/object_spec.rb
 - spec/spec_helper.rb
 - spec/throttler_spec.rb
 homepage: https://github.com/esurdam/redis-throttler#readme