pause 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f681f5880476f055a00a8131eb6977aad96a0ba5
-  data.tar.gz: 282371534a8dcdb32dac098f479ee5df62433e85
+  metadata.gz: bda062b9f3c87e7079efe48798f512afc22cfad8
+  data.tar.gz: afcdfb3a35303d0a6dede0964e1d30c275553e50
 SHA512:
-  metadata.gz: f9eb4591aa2533a7ea2759e7cb9c929de36ff32b75160701edc436d7ca12ca05dd91f6c72e9b09a4d5b9dfb3a3fcc234a9edd00860b6a6f2d3f60ff1c321ff0c
-  data.tar.gz: 397807c6f15cd909985b943f3b4b616484c9934025ed27124bed1f76728e0a7ab7e6721dd226135c56352b6b640786be6130210a0f34592d521c5bdf14a33023
+  metadata.gz: 8d195486f30a502ef7fee7c77bbd0471f3eeea1622d207d81d4719126e94d4c5d3c8016176c9ff2a40f51f8ba947fda712b629eba702cce8b5819bec6430364f
+  data.tar.gz: c8af42cebe5703e60a2d484984f7ba1294d58ecdb9621911ebb02aca9ec66f2657cd0f3372f50c7d7cc8609e3ee92be91df778c2dcdde150760f80abec32833f

data/README.md

@@ -198,6 +198,30 @@ action.ok?
 # => true
 ```
 
+## Using Pause with Twemproxy
+
+Pause can be used with Twemproxy to shard its data among multiple redis instances. When doing so,
+the `hash_tag` configuration in Twemproxy should be set to `"||"`. In addition, the `sharded` Pause
+configuration option should be set to true.
+
+When sharding is used, the Redis adapter used by Pause ignores the `redis_db`, which is not supported.
+
+```ruby
+Pause.configure do |config|
+  config.redis_host = "127.0.0.1"
+  config.redis_port = 6379
+  config.resolution = 600     # aggregate all events into 10 minute blocks
+  config.history    = 86400   # discard all events older than 1 day
+  config.sharded    = true
+end
+```
+
+With this configuration, any Pause operation that we know is not supported by Twemproxy will raise
+`Pause::Redis::OperationNotSupported`. For instance, when sharding we are unable to get a list of all
+tracked identifiers.
+
+The action block list is implemented as a sorted set, so it should still be usable when sharding.
+
 ## Contributing
 
 Want to make it better? Cool. Here's how:

data/lib/pause/action.rb

@@ -14,7 +14,7 @@ module Pause
     #     end
     #
     def scope
-      raise "Should implement scope. (Ex: ipn:follow)"
+      raise 'Should implement scope. (Ex: ipn:follow)'
     end
 
     def self.scope(scope_identifier = nil)
@@ -57,6 +57,10 @@ module Pause
       @checks = period_checks
     end
 
+    def block_for(ttl)
+      adapter.rate_limit!(scope, identifier, ttl)
+    end
+
     def increment!(count = 1, timestamp = Time.now.to_i)
       adapter.increment(scope, identifier, timestamp, count)
     end

data/lib/pause/analyzer.rb

@@ -4,7 +4,14 @@ module Pause
   class Analyzer
     include Pause::Helper::Timing
 
+    # #check(action)
+    #
+    # @param action [Pause::Action]
+    # @return [nil]  everything is fine
+    # @return [false]  this action is already blocked
+    # @return [Pause::RateLimitedEvent]  the action was blocked as a result of this check
     def check(action)
+      return false if adapter.rate_limited?(action.scope, action.identifier)
       timestamp = period_marker(Pause.config.resolution, Time.now.to_i)
       set = adapter.key_history(action.scope, action.identifier)
       action.checks.each do |period_check|

data/lib/pause/configuration.rb

@@ -8,7 +8,7 @@ module Pause
     end
 
     def redis_host
-      @redis_host || "127.0.0.1"
+      @redis_host || '127.0.0.1'
     end
 
     def redis_port
@@ -28,7 +28,7 @@ module Pause
     end
 
     def sharded
-      @sharded || false
+      !!@sharded
     end
   end
 end

data/lib/pause/redis/adapter.rb

@@ -98,7 +98,7 @@ module Pause
       end
 
       def tracked_scope(scope)
-        ["i", scope].join(':')
+        ['i', scope].join(':')
       end
 
       def tracked_key(scope, identifier)

data/lib/pause/redis/sharded_adapter.rb

@@ -28,7 +28,7 @@ module Pause
       end
 
       def keys(_key_scope)
-        raise OperationNotSupported.new("Can not be executed when Pause is configured in sharded mode")
+        raise OperationNotSupported.new('Can not be executed when Pause is configured in sharded mode')
       end
     end
   end

data/lib/pause/version.rb

@@ -1,3 +1,3 @@
 module Pause
-  VERSION = "0.1.2"
+  VERSION = '0.2.0'
 end

data/spec/pause/action_spec.rb

@@ -5,7 +5,7 @@ describe Pause::Action do
   include Pause::Helper::Timing
 
   class MyNotification < Pause::Action
-    scope "ipn:follow"
+    scope 'ipn:follow'
     check period_seconds: 20, max_allowed: 5, block_ttl: 40
     check period_seconds: 40, max_allowed: 7, block_ttl: 40
   end
@@ -13,19 +13,20 @@ describe Pause::Action do
   let(:resolution) { 10 }
   let(:history) { 60 }
   let(:configuration) { Pause::Configuration.new }
+  let(:adapter) { Pause::Redis::Adapter.new(Pause.config) }
 
   before do
     allow(Pause).to receive(:config).and_return(configuration)
     allow(Pause.config).to receive(:resolution).and_return(resolution)
     allow(Pause.config).to receive(:history).and_return(history)
-    allow(Pause).to receive(:adapter).and_return(Pause::Redis::Adapter.new(Pause.config))
+    allow(Pause).to receive(:adapter).and_return(adapter)
   end
 
-  let(:action) { MyNotification.new("1237612") }
-  let(:other_action) { MyNotification.new("1237613") }
+  let(:action) { MyNotification.new('1237612') }
+  let(:other_action) { MyNotification.new('1237613') }
 
-  describe "#increment!" do
-    it "should increment" do
+  describe '#increment!' do
+    it 'should increment' do
       time = Time.now
       Timecop.freeze time do
         expect(Pause.adapter).to receive(:increment).with(action.scope, '1237612', time.to_i, 1)
@@ -34,8 +35,8 @@ describe Pause::Action do
     end
   end
 
-  describe "#ok?" do
-    it "should successfully return if the action is blocked or not" do
+  describe '#ok?' do
+    it 'should successfully return if the action is blocked or not' do
       time = Time.now
       Timecop.freeze time do
         4.times do
@@ -47,7 +48,7 @@ describe Pause::Action do
       end
     end
 
-    it "should successfully consider different period checks" do
+    it 'should successfully consider different period checks' do
       time = Time.parse('Sept 22, 11:34:00')
 
       Timecop.freeze time - 30 do
@@ -66,7 +67,7 @@ describe Pause::Action do
       end
     end
 
-    it "should return false and silently fail if redis is not available" do
+    it 'should return false and silently fail if redis is not available' do
       allow(Pause::Logger).to receive(:fatal)
       allow_any_instance_of(Redis).to receive(:zrange).and_raise Redis::CannotConnectError
       time = period_marker(resolution, Time.now.to_i)
@@ -77,15 +78,15 @@ describe Pause::Action do
     end
   end
 
-  describe "#analyze" do
-    context "action should not be rate limited" do
-      it "returns nil" do
+  describe '#analyze' do
+    context 'action should not be rate limited' do
+      it 'returns nil' do
         expect(action.analyze).to be nil
       end
     end
 
-    context "action should be rate limited" do
-      it "returns a RateLimitedEvent object" do
+    context 'action should be rate limited' do
+      it 'returns a RateLimitedEvent object' do
         time = Time.now
         rate_limit = nil
 
@@ -105,8 +106,8 @@ describe Pause::Action do
     end
   end
 
-  describe ".tracked_identifiers" do
-    it "should return all the identifiers tracked (but not blocked) so far" do
+  describe '.tracked_identifiers' do
+    it 'should return all the identifiers tracked (but not blocked) so far' do
       action.increment!
       other_action.increment!
 
@@ -118,8 +119,8 @@ describe Pause::Action do
     end
   end
 
-  describe ".rate_limited_identifiers" do
-    it "should return all the identifiers blocked" do
+  describe '.rate_limited_identifiers' do
+    it 'should return all the identifiers blocked' do
       action.increment!(100, Time.now.to_i)
       other_action.increment!(100, Time.now.to_i)
 
@@ -131,8 +132,8 @@ describe Pause::Action do
     end
   end
 
-  describe ".unblock_all" do
-    it "should unblock all the identifiers for a scope" do
+  describe '.unblock_all' do
+    it 'should unblock all the identifiers for a scope' do
       10.times { action.increment! }
       other_action.increment!
 
@@ -149,7 +150,7 @@ describe Pause::Action do
     end
   end
 
-  describe "#unblock" do
+  describe '#unblock' do
     it 'unblocks the specified id' do
       10.times { action.increment! }
 
@@ -160,9 +161,17 @@ describe Pause::Action do
       expect(action.ok?).to be true
     end
   end
+
+  describe '#block_for' do
+    it 'blocks the IP for N seconds' do
+      expect(adapter).to receive(:rate_limit!).with(action.scope, action.identifier, 10).and_call_original
+      action.block_for(10)
+      expect(action.ok?).to be false
+    end
+  end
 end
 
-describe Pause::Action, ".check" do
+describe Pause::Action, '.check' do
   class ActionWithCheck < Pause::Action
     check 100, 150, 200
   end
@@ -177,50 +186,50 @@ describe Pause::Action, ".check" do
     check period_seconds: 50, block_ttl: 60, max_allowed: 100
   end
 
-  it "should define a period check on new instances" do
-    expect(ActionWithCheck.new("id").checks).to eq([
+  it 'should define a period check on new instances' do
+    expect(ActionWithCheck.new('id').checks).to eq([
           Pause::PeriodCheck.new(100, 150, 200)
         ])
   end
 
-  it "should define a period check on new instances" do
-    expect(ActionWithMultipleChecks.new("id").checks).to eq([
+  it 'should define a period check on new instances' do
+    expect(ActionWithMultipleChecks.new('id').checks).to eq([
           Pause::PeriodCheck.new(100, 150, 200),
           Pause::PeriodCheck.new(200, 150, 200),
           Pause::PeriodCheck.new(300, 150, 200)
         ])
   end
 
-  it "should accept hash arguments" do
-    expect(ActionWithHashChecks.new("id").checks).to eq([
+  it 'should accept hash arguments' do
+    expect(ActionWithHashChecks.new('id').checks).to eq([
           Pause::PeriodCheck.new(50, 100, 60)
         ])
   end
 
 end
 
-describe Pause::Action, ".scope" do
+describe Pause::Action, '.scope' do
   class UndefinedScopeAction < Pause::Action
   end
 
-  it "should raise if scope is not defined" do
+  it 'should raise if scope is not defined' do
     expect {
-      UndefinedScopeAction.new("1.2.3.4").scope
-    }.to raise_error("Should implement scope. (Ex: ipn:follow)")
+      UndefinedScopeAction.new('1.2.3.4').scope
+    }.to raise_error('Should implement scope. (Ex: ipn:follow)')
   end
 
   class DefinedScopeAction < Pause::Action
-    scope "my:scope"
+    scope 'my:scope'
   end
 
-  it "should set scope on class" do
-    expect(DefinedScopeAction.new("1.2.3.4").scope).to eq("my:scope")
+  it 'should set scope on class' do
+    expect(DefinedScopeAction.new('1.2.3.4').scope).to eq('my:scope')
   end
 end
 
-describe Pause::Action, "enabled/disabled states" do
+describe Pause::Action, 'enabled/disabled states' do
   class BlockedAction < Pause::Action
-    scope "blocked"
+    scope 'blocked'
     check 10, 0, 10
   end
 
@@ -233,27 +242,27 @@ describe Pause::Action, "enabled/disabled states" do
 
   let(:action) { BlockedAction }
 
-  describe "#disable" do
+  describe '#disable' do
     before do
       expect(action).to be_enabled
       expect(action).to_not be_disabled
       action.disable
     end
 
-    it "disables the action" do
+    it 'disables the action' do
       expect(action).to be_disabled
       expect(action).to_not be_enabled
     end
   end
 
-  describe "#enable" do
+  describe '#enable' do
     before do
       action.disable
       expect(action).to_not be_enabled
       action.enable
     end
 
-    it "enables the action" do
+    it 'enables the action' do
       expect(action).to be_enabled
       expect(action).to_not be_disabled
     end

data/spec/pause/analyzer_spec.rb

@@ -5,7 +5,7 @@ describe Pause::Analyzer do
   include Pause::Helper::Timing
 
   class FollowPushNotification < Pause::Action
-    scope "ipn:follow"
+    scope 'ipn:follow'
     check 20, 5, 12
     check 40, 7, 12
   end
@@ -13,19 +13,20 @@ describe Pause::Analyzer do
   let(:resolution) { 10 }
   let(:history) { 60 }
   let(:configuration) { Pause::Configuration.new }
+  let(:adapter) { Pause::Redis::Adapter.new(configuration) }
 
   before do
     allow(Pause).to receive(:config).and_return(configuration)
     allow(Pause.config).to receive(:resolution).and_return(resolution)
     allow(Pause.config).to receive(:history).and_return(history)
+    allow(Pause).to receive(:adapter).and_return(adapter)
   end
 
   let(:analyzer) { Pause.analyzer }
-  let(:adapter) { Pause.adapter }
-  let(:action) { FollowPushNotification.new("1243123") }
+  let(:action) { FollowPushNotification.new('1243123') }
 
-  describe "#analyze" do
-    it "checks and blocks if max_allowed is reached" do
+  describe '#analyze' do
+    it 'checks and blocks if max_allowed is reached' do
       time = Time.now
       expect(adapter).to receive(:rate_limit!).once.with(action.scope, '1243123', 12)
       Timecop.freeze time do
@@ -37,12 +38,12 @@ describe Pause::Analyzer do
     end
   end
 
-  describe "#check" do
-    it "should return nil if action is NOT blocked" do
+  describe '#check' do
+    it 'should return nil if action is NOT blocked' do
       expect(analyzer.check(action)).to be nil
     end
 
-    it "should return blocked action if action is blocked" do
+    it 'should return blocked action if action is blocked' do
       Timecop.freeze Time.now do
         5.times do
           action.increment!

data/spec/pause/configuration_spec.rb

@@ -1,36 +1,39 @@
 require 'spec_helper'
 
-describe Pause::Configuration, "#configure" do
+describe Pause::Configuration, '#configure' do
 
   subject { Pause::Configuration.new }
 
-  it "should allow configuration via block" do
+  it 'should allow configuration via block' do
     subject.configure do |c|
-      c.redis_host = "128.23.12.8"
-      c.redis_port = "2134"
-      c.redis_db = "13"
+      c.redis_host = '128.23.12.8'
+      c.redis_port = '2134'
+      c.redis_db = '13'
 
       c.resolution = 5000
       c.history = 6000
+      c.sharded = true
     end
 
-    expect(subject.redis_host).to eq("128.23.12.8")
+    expect(subject.redis_host).to eq('128.23.12.8')
     expect(subject.redis_port).to eq(2134)
-    expect(subject.redis_db).to eq("13")
+    expect(subject.redis_db).to eq('13')
 
     expect(subject.resolution).to eq(5000)
     expect(subject.history).to eq(6000)
+    expect(subject.sharded).to be true
   end
 
-  it "should provide redis defaults" do
+  it 'should provide redis defaults' do
     subject.configure do |config|
       # do nothing
     end
 
-    expect(subject.redis_host).to eq("127.0.0.1")
+    expect(subject.redis_host).to eq('127.0.0.1')
     expect(subject.redis_port).to eq(6379)
-    expect(subject.redis_db).to eq("1")
+    expect(subject.redis_db).to eq('1')
     expect(subject.resolution).to eq(600) # 10 minutes
     expect(subject.history).to eq(86400) # one day
+    expect(subject.sharded).to be false
   end
 end

data/spec/pause/redis/adapter_spec.rb

@@ -19,11 +19,11 @@ describe Pause::Redis::Adapter do
   let(:redis_conn) { adapter.send(:redis) }
 
   describe '#increment' do
-    let(:scope) { "blah" }
-    let(:identifier) { "213213" }
-    let(:tracked_key) { "i:blah:|213213|"}
+    let(:scope) { 'blah' }
+    let(:identifier) { '213213' }
+    let(:tracked_key) { 'i:blah:|213213|' }
 
-    it "should add key to a redis set" do
+    it 'should add key to a redis set' do
       adapter.increment(scope, identifier, Time.now.to_i)
       set = redis_conn.zrange(tracked_key, 0, -1, :with_scores => true)
       expect(set).to_not be_empty
@@ -31,7 +31,7 @@ describe Pause::Redis::Adapter do
       expect(set[0].size).to eql(2)
     end
 
-    it "should remove old key from a redis set" do
+    it 'should remove old key from a redis set' do
       time = Time.now
       expect(redis_conn).to receive(:zrem).with(tracked_key, [adapter.period_marker(resolution, time)])
 
@@ -44,7 +44,7 @@ describe Pause::Redis::Adapter do
       end
     end
 
-    it "sets expiry on key" do
+    it 'sets expiry on key' do
       expect(redis_conn).to receive(:expire).with(tracked_key, history)
       adapter.increment(scope, identifier, Time.now.to_i)
     end
@@ -73,41 +73,41 @@ describe Pause::Redis::Adapter do
     end
   end
 
-  describe "#rate_limit!" do
+  describe '#rate_limit!' do
   end
 
-  describe "#rate_limited?" do
+  describe '#rate_limited?' do
     let(:scope) { 'ipn:follow' }
     let(:identifier) { '123461234' }
     let(:blocked_key) { "b:#{key}" }
     let(:ttl) { 110000 }
 
-    it "should return true if blocked" do
+    it 'should return true if blocked' do
       adapter.rate_limit!(scope, identifier, ttl)
       expect(adapter.rate_limited?(scope, identifier)).to be true
     end
   end
 
-  describe "#tracked_key" do
-    it "prefixes key" do
-      expect(adapter.send(:tracked_key, "abc", "12345")).to eq("i:abc:|12345|")
+  describe '#tracked_key' do
+    it 'prefixes key' do
+      expect(adapter.send(:tracked_key, 'abc', '12345')).to eq('i:abc:|12345|')
     end
   end
 
   describe '#enable' do
     it 'deletes the disabled flag in redis' do
-      adapter.disable("boom")
-      expect(adapter.disabled?("boom")).to be true
-      adapter.enable("boom")
-      expect(adapter.disabled?("boom")).to be false
+      adapter.disable('boom')
+      expect(adapter.disabled?('boom')).to be true
+      adapter.enable('boom')
+      expect(adapter.disabled?('boom')).to be false
     end
   end
 
   describe '#disable' do
     it 'sets the disabled flag in redis' do
-      expect(adapter.enabled?("boom")).to be true
-      adapter.disable("boom")
-      expect(adapter.enabled?("boom")).to be false
+      expect(adapter.enabled?('boom')).to be true
+      adapter.disable('boom')
+      expect(adapter.enabled?('boom')).to be false
     end
   end
 
@@ -124,7 +124,7 @@ describe Pause::Redis::Adapter do
       let(:blocked_key) { "b:|#{scope}|" }
       let(:ttl) { 110000 }
 
-      it "saves ip to redis with expiration" do
+      it 'saves ip to redis with expiration' do
         time = Time.now
         Timecop.freeze time do
           adapter.rate_limit!(scope, identifier, ttl)

data/spec/spec_helper.rb

@@ -21,8 +21,4 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
-
-  config.before :each do
-    Redis.new.flushall
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pause
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Atasay Gokkaya
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: RReal time rate limiting for multi-process ruby environments based on Redis