pause 0.4.0 → 0.5.0

data/lib/pause/action.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Pause
   class Action
     attr_accessor :identifier
 
-    def initialize(identifier)
-      @identifier       = identifier
+    def initialize(identifier, &block)
+      @identifier = identifier
       self.class.checks ||= []
+      instance_exec(&block) if block
     end
 
     def scope
@@ -22,9 +25,8 @@ module Pause
           #       scope "my:scope"
           #     end
           #
-          @scope = klass.name.downcase.gsub(/::/, '.')
+          @scope = klass.name.downcase.gsub('::', '.')
           class << self
-
             # @param [String] args
             def scope(*args)
               @scope = args.first if args && args.size == 1
@@ -156,6 +158,5 @@ module Pause
     def adapter
       self.class.adapter
     end
-
   end
 end

data/lib/pause/analyzer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pause/helper/timing'
 
 module Pause
@@ -12,12 +14,14 @@ module Pause
     # @return [Pause::RateLimitedEvent]  the action was blocked as a result of this check
     def check(action, recalculate: false)
       return false if adapter.rate_limited?(action.scope, action.identifier) && !recalculate
+
       timestamp = period_marker(Pause.config.resolution, Time.now.to_i)
       set       = adapter.key_history(action.scope, action.identifier)
       action.checks.each do |period_check|
         start_time = timestamp - period_check.period_seconds
         set.reverse.inject(0) do |sum, element|
           break if element.ts < start_time
+
           sum += element.count
           if sum >= period_check.max_allowed
             adapter.rate_limit!(action.scope, action.identifier, period_check.block_ttl)

data/lib/pause/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pause
   class Configuration
     attr_writer :redis_host, :redis_port, :redis_db, :resolution, :history, :sharded
@@ -24,7 +26,7 @@ module Pause
     end
 
     def history
-      (@history || 86400).to_i
+      (@history || 86_400).to_i
     end
 
     def sharded

data/lib/pause/helper/timing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pause
   module Helper
     module Timing

data/lib/pause/logger.rb

@@ -1,11 +1,18 @@
+# frozen_string_literal: true
+
 module Pause
+  # @description Logger class for Pause
   class Logger
-    def self.puts message
-      STDOUT.puts message
-    end
+    class << self
+      def puts(message)
+        $stdout.puts message
+      end
 
-    def self.fatal message
-      STDERR.puts message
+      def fatal(message)
+        # rubocop: disable Style/StderrPuts
+        $stderr.puts message.red
+        # rubocop: enable Style/StderrPuts
+      end
     end
   end
 end

data/lib/pause/rate_limited_event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pause
   class RateLimitedEvent
     attr_accessor :action, :identifier, :period_check, :sum, :timestamp
@@ -9,6 +11,5 @@ module Pause
       @sum = sum
       @timestamp = timestamp
     end
-
   end
 end

data/lib/pause/redis/adapter.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 require 'pause/helper/timing'
 
 module Pause
   module Redis
-
     # This class encapsulates Redis operations used by Pause
     class Adapter
       class << self
         def redis
-          @redis_conn ||= ::Redis.new(redis_connection_opts)
+          @redis ||= ::Redis.new(redis_connection_opts)
         end
 
         def redis_connection_opts
           { host: Pause.config.redis_host,
             port: Pause.config.redis_port,
-            db:   Pause.config.redis_db }
+            db: Pause.config.redis_db }
         end
       end
 
@@ -72,6 +73,7 @@ module Pause
       # @return count [Integer] the number of items deleted
       def delete_rate_limited_keys(scope)
         return 0 unless rate_limited_keys(scope).any?
+
         delete_tracking_keys(scope, rate_limited_keys(scope))
         redis.zremrangebyscore(rate_limited_list(scope), '-inf', '+inf').tap do |_count|
           redis.del rate_limited_list(scope)
@@ -84,7 +86,7 @@ module Pause
       end
 
       def disable(scope)
-        redis.set("internal:|#{scope}|:disabled", "1")
+        redis.set("internal:|#{scope}|:disabled", '1')
       end
 
       def enable(scope)
@@ -110,11 +112,11 @@ module Pause
       end
 
       def truncate_set_for(k)
-        if redis.zcard(k) > time_blocks_to_keep
-          list      = extract_set_elements(k)
-          to_remove = list.slice(0, (list.size - time_blocks_to_keep)).map(&:ts)
-          redis.zrem(k, to_remove) if k && to_remove && to_remove.size > 0
-        end
+        return unless redis.zcard(k) > time_blocks_to_keep
+
+        list      = extract_set_elements(k)
+        to_remove = list.slice(0, (list.size - time_blocks_to_keep)).map(&:ts)
+        redis.zrem(k, to_remove) if k && to_remove&.size&.positive?
       end
 
       def delete_tracking_keys(scope, ids)
@@ -137,7 +139,7 @@ module Pause
 
       def keys(key_scope)
         redis.keys("#{key_scope}:*").map do |key|
-          key.gsub(/^#{key_scope}:/, "").tr('|', '')
+          key.gsub(/^#{key_scope}:/, '').tr('|', '')
         end
       end
 

data/lib/pause/redis/sharded_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pause
   module Redis
     class OperationNotSupported < StandardError
@@ -7,7 +9,6 @@ module Pause
     # Operations that are not possible when data is sharded
     # raise an error.
     class ShardedAdapter < Adapter
-
       # Overrides real multi which is not possible when sharded.
       def with_multi
         yield(redis) if block_given?
@@ -23,7 +24,7 @@ module Pause
       private
 
       def keys(_key_scope)
-        raise OperationNotSupported.new('Can not be executed when Pause is configured in sharded mode')
+        raise OperationNotSupported, 'Can not be executed when Pause is configured in sharded mode'
       end
     end
   end

data/lib/pause/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pause
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/pause.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'redis'
+require 'colored2'
 require 'pause/version'
 require 'pause/configuration'
 require 'pause/action'
@@ -9,15 +12,15 @@ require 'pause/redis/sharded_adapter'
 require 'pause/rate_limited_event'
 
 module Pause
-  class PeriodCheck < Struct.new(:period_seconds, :max_allowed, :block_ttl)
+  PeriodCheck = Struct.new(:period_seconds, :max_allowed, :block_ttl) do
     def <=>(other)
-      self.period_seconds <=> other.period_seconds
+      period_seconds <=> other.period_seconds
     end
   end
 
-  class SetElement < Struct.new(:ts, :count)
+  SetElement = Struct.new(:ts, :count) do
     def <=>(other)
-      self.ts <=> other.ts
+      ts <=> other.ts
     end
   end
 
@@ -27,17 +30,17 @@ module Pause
     end
 
     def adapter
-      @adapter ||= config.sharded ?
-        Pause::Redis::ShardedAdapter.new(config) :
-        Pause::Redis::Adapter.new(config)
+      @adapter ||= if config.sharded
+                     Pause::Redis::ShardedAdapter.new(config)
+                   else
+                     Pause::Redis::Adapter.new(config)
+                   end
     end
 
-    def adapter=(adapter)
-      @adapter = adapter
-    end
+    attr_writer :adapter
 
     def configure(&block)
-      @configuration ||= Pause::Configuration.new.configure(&block)
+      @configure ||= Pause::Configuration.new.configure(&block)
     end
 
     def config(&block)

data/pause.gemspec

@@ -1,30 +1,27 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pause/version'
 
 Gem::Specification.new do |gem|
   gem.name          = 'pause'
   gem.version       = Pause::VERSION
-  gem.authors       = ['Atasay Gokkaya', 'Paul Henry', 'Eric Saxby', 'Konstantin Gredeskoul']
-  gem.email         = %w(atasay@wanelo.com paul@wanelo.com sax@ericsaxby.com kigster@gmail.com)
-  gem.summary       = %q(Fast, scalable, and flexible real time rate limiting library for distributed Ruby environments backed by Redis.)
-  gem.description   = %q(This gem provides highly flexible and easy to use interface to define rate limit checks, register events as they come, and verify if the rate limit is reached. Multiple checks for the same metric are easily supported. This gem is used at very high scale on several popular web sites.)
+  gem.authors       = ['Konstantin Gredeskoul', 'Atasay Gokkaya', 'Paul Henry', 'Eric Saxby']
+  gem.email         = %w[kigster@gmail.com atasay@wanelo.com paul@wanelo.com sax@ericsaxby.com]
+  gem.summary       = 'Fast, scalable, and flexible real time rate limiting library for distributed Ruby environments backed by Redis.'
+  gem.description   = 'This gem provides highly flexible and easy to use interface to define rate limit checks, register events as they come, and verify if the rate limit is reached. Multiple checks for the same metric are easily supported. This gem is used at very high scale on several popular web sites.'
   gem.homepage      = 'https://github.com/kigster/pause'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ['lib']
 
+  gem.add_dependency 'colored2'
   gem.add_dependency 'redis'
-  gem.add_dependency 'hiredis'
 
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'fakeredis'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'timecop'
-  gem.add_development_dependency 'rake'
+  # optional
+  # gem.add_dependency 'hiredis'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/pause/action_spec.rb

@@ -11,6 +11,10 @@ describe Pause::Action do
   end
 
   let(:resolution) { 10 }
+  let(:identifier) { '11112222' }
+  let(:action) { MyNotification.new(identifier) }
+  let(:other_identifier) { '8798734' }
+  let(:other_action) { MyNotification.new(other_identifier) }
   let(:history) { 60 }
   let(:configuration) { Pause::Configuration.new }
   let(:adapter) { Pause::Redis::Adapter.new(Pause.config) }
@@ -22,15 +26,9 @@ describe Pause::Action do
     allow(Pause).to receive(:adapter).and_return(adapter)
   end
 
-  let(:identifier) { '11112222' }
-  let(:action) { MyNotification.new(identifier) }
-
-  let(:other_identifier) { '8798734' }
-  let(:other_action) { MyNotification.new(other_identifier) }
-
   RSpec.shared_examples 'an action' do
     describe '#increment!' do
-      it 'should increment' do
+      it 'increments' do
         time = Time.now
         Timecop.freeze time do
           expect(Pause.adapter).to receive(:increment).with(action.scope, identifier, time.to_i, 1)
@@ -40,7 +38,7 @@ describe Pause::Action do
     end
 
     describe '#ok?' do
-      it 'should successfully return if the action is blocked or not' do
+      it 'successfullies return if the action is blocked or not' do
         time = Time.now
         Timecop.freeze time do
           4.times do
@@ -52,7 +50,7 @@ describe Pause::Action do
         end
       end
 
-      it 'should successfully consider different period checks' do
+      it 'successfullies consider different period checks' do
         time = Time.parse('Sept 22, 11:34:00')
 
         Timecop.freeze time - 30 do
@@ -71,7 +69,7 @@ describe Pause::Action do
         end
       end
 
-      it 'should return false and silently fail if redis is not available' do
+      it 'returns 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)
@@ -86,7 +84,7 @@ describe Pause::Action do
       context 'action should not be rate limited' do
         it 'returns nil' do
           expect(adapter.rate_limited?(action.scope, action.identifier)).to be false
-          expect(action.analyze).to be nil
+          expect(action.analyze).to be_nil
         end
       end
 
@@ -130,7 +128,7 @@ describe Pause::Action do
   end
 
   context 'actions under test' do
-    ['123456', 'hello', 0, 999999].each do |id|
+    ['123456', 'hello', 0, 999_999].each do |id|
       let(:identifier) { id }
       let(:action) { MyNotification.new(identifier) }
       describe "action with identifier #{id}" do
@@ -151,38 +149,47 @@ describe Pause::Action do
     let(:bogus) { Struct.new(:name, :event).new }
 
     describe '#unless_rate_limited' do
-      before do
-        expect(bogus).to receive(:name).exactly(2).times
+      before { expect(bogus).to receive(:name).twice }
+
+      describe '#initialize' do
+        before { expect(bogus).to receive(:event).once }
+
+        it 'is able to use methods inside the #new block' do
+          b = bogus
+          CowRateLimited.new(identifier) do
+            unless_rate_limited { b.name } # this executes
+            unless_rate_limited { b.name } # this also executes
+            unless_rate_limited { b.name } # and this will be rate limited
+            if_rate_limited { b.event }
+          end
+        end
       end
-      it 'should call through the block' do
+
+      it 'calls through the block' do
         action.unless_rate_limited { bogus.name }
         action.unless_rate_limited { bogus.name }
         result = action.unless_rate_limited { bogus.name }
-        expect(result).to be_a_kind_of(::Pause::RateLimitedEvent)
+        expect(result).to be_a(Pause::RateLimitedEvent)
       end
-    end
-
-    describe '#unless_rate_limited' do
-      before { expect(bogus).to receive(:name).exactly(2).times }
 
-      it 'should call through the block' do
+      it 'calls through the block' do
         3.times { action.unless_rate_limited { bogus.name } }
       end
 
       describe '#if_rate_limited' do
         before { 2.times { action.unless_rate_limited { bogus.name } } }
 
-        it 'it should not analyze during method call' do
+        it 'does not analyze during method call' do
           bogus.event = 1
           action.if_rate_limited { |event| bogus.event = event }
-          expect(bogus.event).to be_a_kind_of(::Pause::RateLimitedEvent)
+          expect(bogus.event).to be_a(Pause::RateLimitedEvent)
           expect(bogus.event.identifier).to eq(identifier)
         end
 
-        it 'should analyze if requested' do
+        it 'analyzes if requested' do
           action.unless_rate_limited { bogus.name }
           result = action.if_rate_limited { |event| bogus.event = event }
-          expect(bogus.event).to be_a_kind_of(::Pause::RateLimitedEvent)
+          expect(bogus.event).to be_a(Pause::RateLimitedEvent)
           expect(result).to eq(bogus.event)
         end
       end
@@ -190,7 +197,7 @@ describe Pause::Action do
   end
 
   describe '.tracked_identifiers' do
-    it 'should return all the identifiers tracked (but not blocked) so far' do
+    it 'returns all the identifiers tracked (but not blocked) so far' do
       action.increment!
       other_action.increment!
 
@@ -203,7 +210,7 @@ describe Pause::Action do
   end
 
   describe '.rate_limited_identifiers' do
-    it 'should return all the identifiers blocked' do
+    it 'returns all the identifiers blocked' do
       action.increment!(100, Time.now.to_i)
       other_action.increment!(100, Time.now.to_i)
 
@@ -216,7 +223,7 @@ describe Pause::Action do
   end
 
   describe '.unblock_all' do
-    it 'should unblock all the identifiers for a scope' do
+    it 'unblocks all the identifiers for a scope' do
       10.times { action.increment! }
       other_action.increment!
 
@@ -232,7 +239,6 @@ describe Pause::Action do
       expect(MyNotification.tracked_identifiers).to eq([other_action.identifier])
     end
   end
-
 end
 
 describe Pause::Action, '.check' do
@@ -250,22 +256,22 @@ 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
+  it 'defines 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
+  it 'defines 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)
-                                                                  ])
+           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
+  it 'accepts hash arguments' do
     expect(ActionWithHashChecks.new('id').checks).to eq([
                                                           Pause::PeriodCheck.new(50, 100, 60)
                                                         ])
@@ -278,7 +284,7 @@ describe Pause::Action, '.scope' do
     end
   end
 
-  it 'should raise if scope is not defined' do
+  it 'raises if scope is not defined' do
     expect(MyApp::NoScope.new('1.2.3.4').scope).to eq 'myapp.noscope'
   end
 
@@ -286,7 +292,7 @@ describe Pause::Action, '.scope' do
     scope 'my:scope'
   end
 
-  it 'should set scope on class' do
+  it 'sets scope on class' do
     expect(DefinedScopeAction.new('1.2.3.4').scope).to eq('my:scope')
   end
 end
@@ -309,26 +315,26 @@ describe Pause::Action, 'enabled/disabled states' do
   describe '#disable' do
     before do
       expect(action).to be_enabled
-      expect(action).to_not be_disabled
+      expect(action).not_to be_disabled
       action.disable
     end
 
     it 'disables the action' do
       expect(action).to be_disabled
-      expect(action).to_not be_enabled
+      expect(action).not_to be_enabled
     end
   end
 
   describe '#enable' do
     before do
       action.disable
-      expect(action).to_not be_enabled
+      expect(action).not_to be_enabled
       action.enable
     end
 
     it 'enables the action' do
       expect(action).to be_enabled
-      expect(action).to_not be_disabled
+      expect(action).not_to be_disabled
     end
   end
 end

data/spec/pause/analyzer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'timecop'
 
@@ -11,20 +13,17 @@ describe Pause::Analyzer do
   end
 
   let(:resolution) { 10 }
+  let(:analyzer) { Pause.analyzer }
+  let(:action) { FollowPushNotification.new('1243123') }
   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)
+    allow(Pause.config).to receive_messages(resolution: resolution, history: history)
+    allow(Pause).to receive_messages(config: configuration, adapter: adapter)
   end
 
-  let(:analyzer) { Pause.analyzer }
-  let(:action) { FollowPushNotification.new('1243123') }
-
   describe '#analyze' do
     it 'checks and blocks if max_allowed is reached' do
       time = Time.now
@@ -39,11 +38,11 @@ describe Pause::Analyzer do
   end
 
   describe '#check' do
-    it 'should return nil if action is NOT blocked' do
-      expect(analyzer.check(action)).to be nil
+    it 'returns 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 'returns blocked action if action is blocked' do
       Timecop.freeze Time.now do
         5.times do
           action.increment!

data/spec/pause/configuration_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Pause::Configuration, '#configure' do
+  subject { described_class.new }
 
-  subject { Pause::Configuration.new }
-
-  it 'should allow configuration via block' do
+  it 'allows configuration via block' do
     subject.configure do |c|
       c.redis_host = '128.23.12.8'
       c.redis_port = '2134'
@@ -24,7 +25,7 @@ describe Pause::Configuration, '#configure' do
     expect(subject.sharded).to be true
   end
 
-  it 'should provide redis defaults' do
+  it 'provides redis defaults' do
     subject.configure do |config|
       # do nothing
     end
@@ -33,7 +34,7 @@ describe Pause::Configuration, '#configure' do
     expect(subject.redis_port).to eq(6379)
     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.history).to eq(86_400) # one day
     expect(subject.sharded).to be false
   end
 end

data/spec/pause/logger_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Pause::Logger do
+  describe 'when accessed #puts' do
+    before do
+      expect($stdout).to receive(:puts).with('hello')
+    end
+
+    it 'calls through to puts without color' do
+      described_class.puts('hello')
+    end
+  end
+
+  describe 'when accessed via #fatal' do
+    before do
+      expect($stderr).to receive(:puts).with("\e[31mwhoops\e[0m")
+    end
+
+    it 'calls through to puts with color' do
+      described_class.fatal('whoops')
+    end
+  end
+end