pause 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cebe59883ec6e4803896b89e61d88c53f43902cc
+  data.tar.gz: 86067516015b359cbe2becb8d2e5b71748484f70
+SHA512:
+  metadata.gz: 3538a2c610971934961be482f4531e43a1b614c4d48786484592f4e9c170ef5e4694055d1e8efb80839c62d636c93f997907fd5c9ed1df181adcf8bb6711d361
+  data.tar.gz: bb3921bf9935e98176a073ac2dabcf43c1786c75ce5e532b04497dba4a8dff039d28ed9a1f88b12fd9a5da6052259e762e1cba1a66bd87bf7288f7d771021e42

data/README.md

@@ -1,6 +1,7 @@
 Pause
 ======
 
+[![Gem Version](https://badge.fury.io/rb/pause.png)](http://badge.fury.io/rb/pause)
 [![Build status](https://secure.travis-ci.org/wanelo/pause.png)](http://travis-ci.org/wanelo/pause)
 
 Pause is a flexible Redis-backed rate-limiting client. Use it to track events, with
@@ -173,6 +174,29 @@ while true
 end
 ```
 
+## Unblocking
+
+Actions can be unblocked manually after they have been blocked.
+
+To unblock all blocked identifiers for a single action:
+
+```ruby
+MyAction.unblock_all
+```
+
+To unblock a single identifier for an action:
+
+```ruby
+action = MyAction.new('hello')
+
+action.ok?
+# => false
+
+action.unblock
+
+action.ok?
+# => true
+```
 
 ## Contributing
 

data/lib/pause.rb

@@ -24,6 +24,10 @@ module Pause
       @analyzer ||= Pause::Analyzer.new
     end
 
+    def adapter
+      @adapter ||= Pause::Redis::Adapter.new(config)
+    end
+
     def configure(&block)
       @configuration = Pause::Configuration.new.configure(&block)
     end

data/lib/pause/action.rb

@@ -50,7 +50,7 @@ module Pause
     end
 
     def checks
-      self.class.instance_variable_get(:@checks)
+      self.class.checks
     end
 
     def self.checks=(period_checks)
@@ -58,7 +58,7 @@ module Pause
     end
 
     def increment!(count = 1, timestamp = Time.now.to_i)
-      Pause.analyzer.increment(self, timestamp, count)
+      adapter.increment(key, timestamp, count)
     end
 
     def rate_limited?
@@ -77,19 +77,23 @@ module Pause
     end
 
     def self.tracked_identifiers
-      Pause.analyzer.tracked_identifiers(self.class_scope)
+      adapter.all_keys(self.class_scope)
     end
 
     def self.rate_limited_identifiers
-      Pause.analyzer.rate_limited_identifiers(self.class_scope)
+      adapter.rate_limited_keys(self.class_scope)
     end
 
     def self.unblock_all
-      Pause.analyzer.adapter.delete_rate_limited_keys(self.class_scope)
+      adapter.delete_rate_limited_keys(self.class_scope)
+    end
+
+    def unblock
+      adapter.delete_rate_limited_key(scope, identifier)
     end
 
     def key
-      "#{self.scope}:#{@identifier}"
+      "#{self.scope}:#{identifier}"
     end
 
     # Actions can be globally disabled or re-enabled in a persistent
@@ -104,15 +108,15 @@ module Pause
     #   MyAction.disabled? => false
     #
     def self.enable
-      Pause.analyzer.adapter.enable(class_scope)
+      adapter.enable(class_scope)
     end
 
     def self.disable
-      Pause.analyzer.adapter.disable(class_scope)
+      adapter.disable(class_scope)
     end
 
     def self.enabled?
-      Pause.analyzer.adapter.enabled?(class_scope)
+      adapter.enabled?(class_scope)
     end
 
     def self.disabled?
@@ -121,6 +125,14 @@ module Pause
 
     private
 
+    def self.adapter
+      Pause.adapter
+    end
+
+    def adapter
+      self.class.adapter
+    end
+
     def self.class_scope
       class_variable_get:@@class_scope if class_variable_defined?(:@@class_scope)
     end

data/lib/pause/analyzer.rb

@@ -4,31 +4,7 @@ module Pause
   class Analyzer
     include Pause::Helper::Timing
 
-    attr_accessor :adapter
-
-    def initialize
-      @adapter ||= Pause::Redis::Adapter.new(Pause.config)
-    end
-
-    def increment(action, timestamp = Time.now.to_i, count = 1)
-      adapter.increment(action.key, timestamp, count)
-    end
-
     def check(action)
-      analyze(action)
-    end
-
-    def tracked_identifiers(scope)
-      adapter.all_keys(scope)
-    end
-
-    def rate_limited_identifiers(scope)
-      adapter.rate_limited_keys(scope)
-    end
-
-    private
-
-    def analyze(action)
       timestamp = period_marker(Pause.config.resolution, Time.now.to_i)
       set = adapter.key_history(action.key)
       action.checks.each do |period_check|
@@ -48,5 +24,10 @@ module Pause
       nil
     end
 
+    private
+
+    def adapter
+      Pause.adapter
+    end
   end
 end

data/lib/pause/redis/adapter.rb

@@ -50,10 +50,11 @@ module Pause
       end
 
       def delete_rate_limited_keys(scope)
-        ids = rate_limited_keys(scope)
-        increment_keys = ids.map{ |key| white_key(scope, key) }
-        rate_limited_keys = ids.map{ |key| rate_limited_key(scope, key) }
-        redis.del (increment_keys + rate_limited_keys)
+        delete_rate_limited_ids scope, rate_limited_keys(scope)
+      end
+
+      def delete_rate_limited_key(scope, id)
+        delete_rate_limited_ids scope, [id]
       end
 
       def disable(scope)
@@ -74,6 +75,12 @@ module Pause
 
       private
 
+      def delete_rate_limited_ids(scope, ids)
+        increment_keys = ids.map{ |key| white_key(scope, key) }
+        rate_limited_keys = ids.map{ |key| rate_limited_key(scope, key) }
+        redis.del(increment_keys + rate_limited_keys)
+      end
+
       def redis
         @redis_conn ||= ::Redis.new(host: Pause.config.redis_host,
                                     port: Pause.config.redis_port,

data/lib/pause/version.rb

@@ -1,3 +1,3 @@
 module Pause
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/pause/action_spec.rb

@@ -27,7 +27,7 @@ describe Pause::Action do
     it "should increment" do
       time = Time.now
       Timecop.freeze time do
-        Pause.analyzer.should_receive(:increment).with(action, time.to_i, 1)
+        Pause.adapter.should_receive(:increment).with(action.key, time.to_i, 1)
         action.increment!
       end
     end
@@ -58,7 +58,6 @@ describe Pause::Action do
       action.increment! 1, time
 
       action.ok?.should be_false
-
     end
 
     it "should return false and silently fail if redis is not available" do
@@ -99,7 +98,7 @@ describe Pause::Action do
     end
   end
 
-  describe "#tracked_identifiers" do
+  describe ".tracked_identifiers" do
     it "should return all the identifiers tracked (but not blocked) so far" do
       action.increment!
       other_action.increment!
@@ -112,7 +111,7 @@ describe Pause::Action do
     end
   end
 
-  describe "#rate_limited_identifiers" 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)
@@ -125,7 +124,7 @@ describe Pause::Action do
     end
   end
 
-  describe "#unblock_all" do
+  describe ".unblock_all" do
     it "should unblock all the identifiers for a scope" do
       10.times { action.increment! }
       other_action.increment!
@@ -142,6 +141,18 @@ describe Pause::Action do
       MyNotification.tracked_identifiers.should == [other_action.identifier]
     end
   end
+
+  describe "#unblock" do
+    it 'unblocks the specified id' do
+      10.times { action.increment! }
+
+      expect(action.ok?).to be_false
+
+      action.unblock
+
+      expect(action.ok?).to be_true
+    end
+  end
 end
 
 describe Pause::Action, ".check" do

data/spec/pause/analyzer_spec.rb

@@ -21,26 +21,16 @@ describe Pause::Analyzer do
   end
 
   let(:analyzer) { Pause.analyzer }
-  let(:adapter) { Pause.analyzer.adapter }
+  let(:adapter) { Pause.adapter }
   let(:action) { FollowPushNotification.new("1243123") }
 
-  describe "#increment" do
-    it "should increment an action" do
-      time = Time.now
-      adapter.should_receive(:increment).with(action.key, time.to_i, 1)
-      Timecop.freeze time do
-        analyzer.increment(action)
-      end
-    end
-  end
-
   describe "#analyze" do
     it "checks and blocks if max_allowed is reached" do
       time = Time.now
       adapter.should_receive(:rate_limit!).once.with(action.key, 12)
       Timecop.freeze time do
         5.times do
-          analyzer.increment(action)
+          action.increment!
           analyzer.check(action)
         end
       end
@@ -55,7 +45,7 @@ describe Pause::Analyzer do
     it "should return blocked action if action is blocked" do
       Timecop.freeze Time.now do
         5.times do
-          analyzer.increment(action)
+          action.increment!
         end
         analyzer.check(action).should be_a(Pause::RateLimitedEvent)
       end

data/spec/pause/redis/adapter_spec.rb

@@ -12,6 +12,7 @@ describe Pause::Redis::Adapter do
     Pause.stub(:config).and_return(configuration)
     Pause.config.stub(:resolution).and_return(resolution)
     Pause.config.stub(:history).and_return(history)
+    redis_conn.flushall
   end
 
   let(:adapter) { Pause::Redis::Adapter.new(Pause.config) }
@@ -75,4 +76,59 @@ describe Pause::Redis::Adapter do
       adapter.send(:white_key, "abc").should == "i:abc"
     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
+    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
+    end
+  end
+
+  describe '#rate_limit!' do
+    it 'rate limits a key for a specific ttl' do
+      expect(adapter.rate_limited?('1')).to be_false
+      adapter.rate_limit!('1', 10)
+      expect(adapter.rate_limited?('1')).to be_true
+    end
+  end
+
+  describe '#delete_rate_limited_keys' do
+    it 'calls redis del with all keys' do
+      adapter.rate_limit!('boom:1', 10)
+      adapter.rate_limit!('boom:2', 10)
+
+      expect(adapter.rate_limited?('boom:1')).to be_true
+      expect(adapter.rate_limited?('boom:2')).to be_true
+
+      adapter.delete_rate_limited_keys('boom')
+
+      expect(adapter.rate_limited?('boom:1')).to be_false
+      expect(adapter.rate_limited?('boom:2')).to be_false
+    end
+  end
+
+  describe '#delete_rate_limit_key' do
+    it 'calls redis del with all keys' do
+      adapter.rate_limit!('boom:1', 10)
+      adapter.rate_limit!('boom:2', 10)
+
+      expect(adapter.rate_limited?('boom:1')).to be_true
+      expect(adapter.rate_limited?('boom:2')).to be_true
+
+      adapter.delete_rate_limited_key('boom', '1')
+
+      expect(adapter.rate_limited?('boom:1')).to be_false
+      expect(adapter.rate_limited?('boom:2')).to be_true
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -21,4 +21,8 @@ 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,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pause
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Atasay Gokkaya
@@ -12,102 +11,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Real time rate limiting for multi-process ruby environments based on
@@ -121,11 +108,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .pairs
-- .rspec
-- .rvmrc
-- .travis.yml
+- ".gitignore"
+- ".pairs"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -148,27 +135,26 @@ files:
 - spec/support/fakeredis.rb
 homepage: https://github.com/wanelo/pause
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RReal time rate limiting for multi-process ruby environments based on Redis
 test_files:
 - spec/pause/action_spec.rb
@@ -177,3 +163,4 @@ test_files:
 - spec/pause/redis/adapter_spec.rb
 - spec/spec_helper.rb
 - spec/support/fakeredis.rb
+has_rdoc: