pause 0.4.0 → 0.5.0

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,59 +1,82 @@
+# 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
+
+    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.increment(scope, identifier, Time.now.to_i)
+      end
+
+      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
 
     context 'removing two elements' do
       let(:to_delete) { 2 }
-      let(:time) { Time.now }
+      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
-        adapter
-        to_delete.times do |t|
-          expect(redis_conn).to receive(:zrem).with(tracked_key, [adapter.period_marker(resolution, time + t)]).once
-        end
+        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 'should remove old elements' do
-        adapter.increment(scope, identifier, time.to_i)
+
+      it 'removes old elements' do
+        adapter.increment(scope, identifier, now.to_i)
         to_delete.times do |t|
-          next_time = time + (adapter.resolution + t + 1)
+          next_time = now + (adapter.resolution + t + 1)
           adapter.increment(scope, identifier, next_time.to_i)
         end
       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)
-    end
   end
 
   describe '#expire_block_list' do
@@ -74,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
@@ -128,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,21 +1,20 @@
+# 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)
@@ -24,15 +23,16 @@ describe Pause::Redis::ShardedAdapter do
 
   describe '#with_multi' do
     let(:redis) { adapter.send(:redis) }
-    it 'should not call redis.multi' do
-      expect(redis).to_not receive(:multi)
-      expect { adapter.increment(:scope, 123, Time.now) }.to_not raise_error
+
+    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 'should not use redis db when connecting' do
-      expect(adapter.send(:redis_connection_opts)).to_not include(:db)
+    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,28 +7,30 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-require 'pause'
 require 'fileutils'
 
+require 'simplecov'
+SimpleCov.start
+
+require 'pause'
+
 if ENV['PAUSE_REAL_REDIS']
   require 'pause/redis/adapter'
-  puts ; puts "NOTE: Using real Redis-server at #{Pause::Redis::Adapter.redis.inspect}\n\n"
+  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'.freeze
+  rspec_dir = './.spec'
   FileUtils.mkdir_p(rspec_dir)
   config.example_status_persistence_file_path = "#{rspec_dir}/results.txt"
 
   config.order = 'random'
 
   if ENV['PAUSE_REAL_REDIS']
-    config.before(:example) do
+    config.before do
       Pause::Redis::Adapter.redis.flushdb
     end
   end

metadata

@@ -1,20 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: pause
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
+- Konstantin Gredeskoul
 - Atasay Gokkaya
 - Paul Henry
 - Eric Saxby
-- Konstantin Gredeskoul
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2025-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: colored2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -28,7 +27,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hiredis
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -41,126 +40,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: fakeredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 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@ericsaxby.com
-- kigster@gmail.com
-executables: []
+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
@@ -175,14 +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
 homepage: https://github.com/kigster/pause
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -197,17 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Fast, scalable, and flexible real time rate limiting library for distributed
   Ruby environments backed by 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
+test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.3
-  - 2.4.3
-  - 2.5.0
-script: "bundle exec rake || ( sleep 1; bundle exec rspec --only-failures ) "
-services:
-  - redis-server
-notifications:
-  email:
-    recipients:
-      - kigster@gmail.com
-    on_success: never
-    on_failure: always