pause 0.2.1 → 0.5.0

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

data/spec/pause/pause_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Pause do
@@ -5,8 +7,8 @@ RSpec.describe Pause do
     let(:configuration) { Pause::Configuration.new }
 
     before do
-      Pause.adapter = nil
-      allow(Pause).to receive(:config).and_return(configuration)
+      described_class.adapter = nil
+      allow(described_class).to receive(:config).and_return(configuration)
       configuration.configure { |c| c.sharded = sharded }
     end
 
@@ -14,7 +16,7 @@ RSpec.describe Pause do
       let(:sharded) { true }
 
       it 'is a ShardedAdapter' do
-        expect(Pause.adapter).to be_a(Pause::Redis::ShardedAdapter)
+        expect(described_class.adapter).to be_a(Pause::Redis::ShardedAdapter)
       end
     end
 
@@ -22,7 +24,7 @@ RSpec.describe Pause do
       let(:sharded) { false }
 
       it 'is an Adapter' do
-        expect(Pause.adapter).to be_a(Pause::Redis::Adapter)
+        expect(described_class.adapter).to be_a(Pause::Redis::Adapter)
       end
     end
   end

data/spec/pause/redis/adapter_spec.rb

@@ -1,52 +1,81 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'date'
 require 'timecop'
 
 describe Pause::Redis::Adapter do
-
   let(:resolution) { 10 }
+  let(:adapter) { described_class.new(Pause.config) }
+  let(:redis_conn) { adapter.send(:redis) }
   let(:history) { 60 }
   let(:configuration) { Pause::Configuration.new }
 
   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.config).to receive_messages(resolution: resolution, history: history)
     redis_conn.flushall
   end
 
-  let(:adapter) { Pause::Redis::Adapter.new(Pause.config) }
-  let(:redis_conn) { adapter.send(:redis) }
-
   describe '#increment' do
     let(:scope) { 'blah' }
     let(:identifier) { '213213' }
-    let(:tracked_key) { 'i:blah:|213213|' }
+    let(:tracked_key) { "i:#{scope}:|#{identifier}|" }
+    let(:now) { Time.now.to_i }
 
-    it 'should add key to a redis set' do
+    it 'adds 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
-      expect(set.size).to eql(1)
-      expect(set[0].size).to eql(2)
+      set = redis_conn.zrange(tracked_key, 0, -1, with_scores: true)
+      expect(set).not_to be_empty
+      expect(set.size).to be(1)
+      expect(set[0].size).to be(2)
     end
 
-    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)])
+    describe 'when increment is called' do
+      let(:redis_conn_double) { instance_double(Redis) }
+
+      before do
+        allow(adapter).to receive(:with_multi).and_yield(redis_conn_double)
+      end
+
+      it 'calls zincrby on the redis connection' do
+        allow(redis_conn_double).to receive(:expire)
+        expect(redis_conn_double).to receive(:zincrby)
 
-      adapter.time_blocks_to_keep = 1
-      Timecop.freeze time do
         adapter.increment(scope, identifier, Time.now.to_i)
       end
-      Timecop.freeze time + (adapter.resolution + 1) do
+
+      it 'calls expire on the redis key' do
+        expect(redis_conn_double).to receive(:expire).with(tracked_key, history)
+        allow(redis_conn_double).to receive(:zincrby)
+
         adapter.increment(scope, identifier, Time.now.to_i)
       end
     end
 
-    it 'sets expiry on key' do
-      expect(redis_conn).to receive(:expire).with(tracked_key, history)
-      adapter.increment(scope, identifier, Time.now.to_i)
+    context 'removing two elements' do
+      let(:to_delete) { 2 }
+      let(:period_start) { adapter.period_marker(resolution, now) }
+      let(:period_end) { adapter.period_marker(resolution, now + resolution) }
+
+      around do |example|
+        Timecop.freeze(now) { example.run }
+      end
+
+      before do
+        redis_conn.flushall
+        adapter.time_blocks_to_keep = 1
+        allow(redis_conn).to receive(:zrem).with(tracked_key, [period_start])
+        allow(redis_conn).to receive(:zrem).with(tracked_key, [period_start, period_end])
+      end
+
+      it 'removes old elements' do
+        adapter.increment(scope, identifier, now.to_i)
+        to_delete.times do |t|
+          next_time = now + (adapter.resolution + t + 1)
+          adapter.increment(scope, identifier, next_time.to_i)
+        end
+      end
     end
   end
 
@@ -68,21 +97,18 @@ describe Pause::Redis::Adapter do
 
       adapter.expire_block_list(scope)
 
-      expect(redis_conn.zscore('b:|a|', blocked_identifier)).not_to be nil
-      expect(redis_conn.zscore('b:|a|', expired_identifier)).to be nil
+      expect(redis_conn.zscore('b:|a|', blocked_identifier)).not_to be_nil
+      expect(redis_conn.zscore('b:|a|', expired_identifier)).to be_nil
     end
   end
 
-  describe '#rate_limit!' do
-  end
-
   describe '#rate_limited?' do
     let(:scope) { 'ipn:follow' }
     let(:identifier) { '123461234' }
     let(:blocked_key) { "b:#{key}" }
-    let(:ttl) { 110000 }
+    let(:ttl) { 110_000 }
 
-    it 'should return true if blocked' do
+    it 'returns true if blocked' do
       adapter.rate_limit!(scope, identifier, ttl)
       expect(adapter.rate_limited?(scope, identifier)).to be true
     end
@@ -122,17 +148,16 @@ describe Pause::Redis::Adapter do
       let(:scope) { 'ipn:follow' }
       let(:identifier) { '1234' }
       let(:blocked_key) { "b:|#{scope}|" }
-      let(:ttl) { 110000 }
+      let(:ttl) { 110_000 }
 
       it 'saves ip to redis with expiration' do
         time = Time.now
         Timecop.freeze time do
           adapter.rate_limit!(scope, identifier, ttl)
         end
-        expect(redis_conn.zscore(blocked_key, identifier)).to_not be nil
+        expect(redis_conn.zscore(blocked_key, identifier)).not_to be_nil
         expect(redis_conn.zscore(blocked_key, identifier)).to eq(time.to_i + ttl)
       end
-
     end
   end
 

data/spec/pause/redis/sharded_adapter_spec.rb

@@ -1,24 +1,38 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'date'
 require 'timecop'
 
 describe Pause::Redis::ShardedAdapter do
-
   let(:resolution) { 10 }
+  let(:adapter) { described_class.new(Pause.config) }
   let(:history) { 60 }
   let(:configuration) { Pause::Configuration.new }
 
   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.config).to receive_messages(resolution: resolution, history: history)
   end
 
-  let(:adapter) { Pause::Redis::ShardedAdapter.new(Pause.config) }
-
   describe '#all_keys' do
     it 'is not supported' do
       expect { adapter.all_keys('cake') }.to raise_error(Pause::Redis::OperationNotSupported)
     end
   end
+
+  describe '#with_multi' do
+    let(:redis) { adapter.send(:redis) }
+
+    it 'does not call redis.multi' do
+      expect(redis).not_to receive(:multi)
+      expect { adapter.increment(:scope, 123, Time.now) }.not_to raise_error
+    end
+  end
+
+  describe '#redis' do
+    it 'does not use redis db when connecting' do
+      expect(adapter.send(:redis_connection_opts)).not_to include(:db)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
@@ -5,20 +7,31 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-require 'rubygems'
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'fileutils'
+
+require 'simplecov'
+SimpleCov.start
+
 require 'pause'
-require 'pry'
-require 'support/fakeredis'
+
+if ENV['PAUSE_REAL_REDIS']
+  require 'pause/redis/adapter'
+  puts
+  puts "NOTE: Using real Redis-server at #{Pause::Redis::Adapter.redis.inspect}\n\n"
+else
+  require 'fakeredis/rspec'
+end
 
 RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+  rspec_dir = './.spec'
+  FileUtils.mkdir_p(rspec_dir)
+  config.example_status_persistence_file_path = "#{rspec_dir}/results.txt"
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
+
+  if ENV['PAUSE_REAL_REDIS']
+    config.before do
+      Pause::Redis::Adapter.redis.flushdb
+    end
+  end
 end

metadata

@@ -1,18 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: pause
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
+- Konstantin Gredeskoul
 - Atasay Gokkaya
 - Paul Henry
 - Eric Saxby
-- Konstantin Gredeskoul
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2025-02-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -27,26 +40,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Real time rate limiting for multi-process ruby environments based on
-  Redis
+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.
 email:
+- kigster@gmail.com
 - atasay@wanelo.com
 - paul@wanelo.com
-- sax@wanelo.com
-- kig@wanelo.com
-executables: []
+- sax@ericsaxby.com
+executables:
+- spec
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".rvmrc"
-- ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/spec
 - lib/pause.rb
 - lib/pause/action.rb
 - lib/pause/analyzer.rb
@@ -61,15 +82,15 @@ files:
 - spec/pause/action_spec.rb
 - spec/pause/analyzer_spec.rb
 - spec/pause/configuration_spec.rb
+- spec/pause/logger_spec.rb
 - spec/pause/pause_spec.rb
 - spec/pause/redis/adapter_spec.rb
 - spec/pause/redis/sharded_adapter_spec.rb
 - spec/spec_helper.rb
-- spec/support/fakeredis.rb
-homepage: https://github.com/wanelo/pause
+homepage: https://github.com/kigster/pause
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -84,17 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
-summary: RReal time rate limiting for multi-process ruby environments based on Redis
-test_files:
-- spec/pause/action_spec.rb
-- spec/pause/analyzer_spec.rb
-- spec/pause/configuration_spec.rb
-- spec/pause/pause_spec.rb
-- spec/pause/redis/adapter_spec.rb
-- spec/pause/redis/sharded_adapter_spec.rb
-- spec/spec_helper.rb
-- spec/support/fakeredis.rb
+summary: Fast, scalable, and flexible real time rate limiting library for distributed
+  Ruby environments backed by Redis.
+test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-script: "bundle exec rspec"
-notifications:
-  email:
-    recipients:
-      - dev-info@wanelo.com
-    on_success: never
-    on_failure: always

data/spec/support/fakeredis.rb

@@ -1,2 +0,0 @@
-require 'fakeredis/rspec'
-