pause 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24edf9a7ae6f6e5556c6dea257d89e8bfa5dd1a4b7115436162758bf259ca36d
-  data.tar.gz: 0f90ae2d8f9dd8678e3e1e8e9dbdbbfd0cbcde8cbf28cf35780924dc3e654b71
+  metadata.gz: 5e50b977e8a0291be3ffa4c7c3cd29e7e7dd4d35d7eaabf7135a50e285ba4e6e
+  data.tar.gz: 29090acb4bd36888191ecb05e5f233a87cf3d2f44e1c83ef5929406dee6b7568
 SHA512:
-  metadata.gz: 2b2a54352c815d7c884a64b9953b0ea053b267903d667cceb0503e82756e4459ba766789e1fb85a5f6f079c7d9095aa720f35b464b051da7bc3818058073d91e
-  data.tar.gz: 2a9a41a61e6402516d0f243189af152d170decd6f5e5c5831b2b5d5758d243fe02ab4840e25237b18a557be081819264ed84e70ba1ffa7e524f49a36bd7bae3a
+  metadata.gz: '09db81cdc48b8bc669a1a138cc00f1a2c7d230eee954551e15c09261d1caf7f2a0f465d4559e1cf0337dc5257c50585e85839365e59da35173737eed537625c5'
+  data.tar.gz: ade37423f09768bf16fc55c80d0252f412808b86457b4fc792efc1d86b499fcc9e346d5547f43d2a058d3f916075cf00b5e8d3fc4ad33c0232521e985ae3bc94

data/.rubocop.yml

@@ -17,6 +17,7 @@ inherit_from: .rubocop_todo.yml
 #
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 3.2
 
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
@@ -26,3 +27,9 @@ RSpec/ExampleLength:
 
 RSpec/MultipleExpectations:
   Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## [Unreleased](https://github.com/kigster/pause/tree/HEAD)
+
+[Full Changelog](https://github.com/kigster/pause/compare/v0.5.0...HEAD)
+
+**Merged pull requests:**
+
+- Improving test coverage by adding missing tests [\#3](https://github.com/kigster/pause/pull/3) ([kigster](https://github.com/kigster))
+
+## [v0.5.0](https://github.com/kigster/pause/tree/v0.5.0) (2025-02-07)
+
+[Full Changelog](https://github.com/kigster/pause/compare/2bad44d9026e4bd24c35384d28f5945187a061f5...v0.5.0)
+
+**Merged pull requests:**
+
+- Adding Guthub Actions and removing Travis [\#2](https://github.com/kigster/pause/pull/2) ([kigster](https://github.com/kigster))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -7,7 +7,6 @@ source 'https://rubygems.org'
 
 group :development, :test do
   gem 'fakeredis'
-  gem 'guard-rspec'
   gem 'rake'
   gem 'rspec'
   gem 'rubocop'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pause (0.5.0)
+    pause (0.5.1)
       colored2
       redis
 
@@ -9,66 +9,20 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    coderay (1.1.3)
     colored2 (4.0.3)
     diff-lcs (1.5.1)
     docile (1.4.1)
     fakeredis (0.9.2)
       redis (~> 4.8)
-    ffi (1.17.1)
-    ffi (1.17.1-aarch64-linux-gnu)
-    ffi (1.17.1-aarch64-linux-musl)
-    ffi (1.17.1-arm-linux-gnu)
-    ffi (1.17.1-arm-linux-musl)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x86-linux-gnu)
-    ffi (1.17.1-x86-linux-musl)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
-    ffi (1.17.1-x86_64-linux-musl)
-    formatador (1.1.0)
-    guard (2.19.1)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      logger (~> 1.6)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      ostruct (~> 0.6)
-      pry (>= 0.13.0)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
     json (2.9.1)
     language_server-protocol (3.17.0.4)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.5)
-    lumberjack (1.2.10)
-    method_source (1.1.0)
-    nenv (0.3.0)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    ostruct (0.6.1)
     parallel (1.26.3)
     parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    pry (0.15.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.11.1)
-      ffi (~> 1.0)
     redis (4.8.1)
     regexp_parser (2.10.0)
     rspec (3.13.0)
@@ -101,14 +55,12 @@ GEM
     rubocop-rspec (3.4.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    shellany (0.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    thor (1.3.2)
     timecop (0.9.10)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
@@ -130,7 +82,6 @@ PLATFORMS
 
 DEPENDENCIES
   fakeredis
-  guard-rspec
   pause!
   rake
   rspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright © 2018 Konstantin Gredeskoul, Atasay Gokkaya, Eric Saxby, Paul Henry
+Copyright © 2013-2025 Konstantin Gredeskoul, Atasay Gokkaya, Eric Saxby, Paul Henry
 
 MIT License
 

data/README.md

@@ -7,11 +7,11 @@
 [![Downloads](https://img.shields.io/gem/dt/pause.svg?style=for-the-badge&color=0AF)](https://rubygems.org/gems/pause)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge&color=0AF)](https://opensource.org/licenses/MIT)
 
-# Pause
+# Pause — A Redis-backed Rate Limiter
 
-## In a Nutshell
+## Overview
 
-**Pause** is a fast and very flexible Redis-backed rate-limiter. You can use it to track events, with
+**Pause** is a fast and very flexible Redis-backed rate-limiter, written originally at [Wanelo.com](https://www.crunchbase.com/organization/wanelo). You can use it to track events, with
 rules around how often they are allowed to occur within configured time checks.
 
 Sample applications include:
@@ -139,12 +139,17 @@ Or install it yourself as:
 
 ### Configuration
 
-Configure Pause. This could be in a Rails initializer.
+Configure Pause. This could be in a Rails initializer. At the moment, pause can only be used as a singleton, i.e. you can not use `pause` with multiple configurations, or multiple redis backends. This is something that can be rather easily fixed, if necessary.
 
-  * resolution - The time resolution (in seconds) defining the minimum period into which action counts are
+Therefore, you configure the Pause singleton with the following options: 
+ 
+  * **redis connection parameters** - The host, port and db of the Redis instance to use.
+
+  * **resolution** - the length of time (in seconds) defining the minimum period into which action counts are
                  aggregated. This defines the size of the persistent store. The higher the number, the less data needs
                  to be persisted in Redis.
-  * history - The maximum amount of time (in seconds) that data is persisted
+
+  * **history** - The maximum amount of time (in seconds) that data is persisted.
 
 ```ruby
 Pause.configure do |config|
@@ -156,12 +161,10 @@ Pause.configure do |config|
 end
 ```
 
+
 ### Actions
 
-Define local actions for your application. Actions define a scope by
-which they are identified in the persistent store (aka "namespace"), and a set of checks.  Checks define various
-thresholds (`max_allowed`) against periods of time (`period_seconds`). When a threshold it triggered,
-the action is rate limited, and stays rate limited for the duration of `block_ttl` seconds.
+Define local actions for your application. Actions define a scope by which they are identified in the persistent store (aka "namespace"), and a set of checks.  Checks define various thresholds (`max_allowed`) against periods of time (`period_seconds`). When a threshold it triggered, the action is rate limited, and stays rate limited for the duration of `block_ttl` seconds.
 
 #### Checks
 
@@ -205,6 +208,7 @@ When an event occurs, you increment an instance of your action, optionally with
 In the example at the top of the README you saw how we used `#unless_rate_limited` and `#if_rate_limited` methods. These are the recommended API methods, but if you must get a finer-grained control over the actions, you can also use methods such as `#ok?`, `#rate_limited?`, `#increment!` to do manually what the block methods do already. Below is an example of this "manual" implementation:
 
 ```ruby
+# app/controllers/follows_controller.rb
 class FollowsController < ApplicationController
   def create
     action = FollowAction.new(user.id)
@@ -216,6 +220,7 @@ class FollowsController < ApplicationController
   end
 end
 
+# app/controlers/other_controller.rb
 class OtherController < ApplicationController
   def index
     action = OtherAction.new(params[:thing])d
@@ -237,11 +242,16 @@ while true
   action.increment!
 
   rate_limit_event = action.analyze
-  if rate_limit_event
-    puts rate_limit_event.identifier               # which key got rate limited ("thing")
-    puts rate_limit_event.sum                      # total count that triggered a rate limit
-    puts rate_limit_event.timestamp                # timestamp when rate limiting occurred
-    puts rate_limit_event.period_check             # period check object, that triggered this rate limiting event
+  
+  if rate_limit_event    # or action.ok?
+    # which key got rate limited ("thing")
+    rate_limit_event.identifier
+    # total count that triggered a rate limit
+    rate_limit_event.sum
+    # timestamp when rate limiting occurred
+    rate_limit_event.timestamp
+    # period check object, that triggered this rate limiting event
+    rate_limit_event.period_check
   else
     # not rate-limited, same as action.ok?
   end
@@ -327,13 +337,13 @@ The action block list is implemented as a sorted set, so it should still be usab
 
 ## Testing
 
-By default, `fakeredis` gem is used to emulate Redis in development. However, the same test-suite should be able to run against a real redis — however, be aware that it will flush the current db during spec run. In order to run specs against real redis, make sure you have Redis running locally on the default port, and that you are able to connect to it using `redis-cli`.
+By default, `fakeredis` gem is used to emulate Redis in development. 
 
-Please note that Travis suite, as well as the default rake task, run both.
+However, the same test-suite runs against a real redis, just be aware that using real redis server running locally on 127.0.0.1 will result in a `flush` operation on the current redis db during the spec run. In order to run specs against real redis, please make sure you have Redis running locally on the default port (6379), and that you are able to connect to it using `redis-cli -p 6379 -h 127.0.0.1`.
 
-### Unit Testing with Fakeredis
+### Unit Testing with FakeRedis
 
-Fakeredis is the default, and is also run whenever `bundle exec rspec` is executed, or `rake spec` task invoked.
+The gem `fakeredis` is the default for testing, and is also run whenever `bundle exec rspec` is executed, or `rake spec` task invoked.
 
 ```bash
 bundle exec rake spec:unit
@@ -345,6 +355,16 @@ bundle exec rake spec:unit
 bundle exec rake spec:integration
 ```
 
+OR
+
+```bash
+PAUSE_REAL_REDIS=1 bundle exec rspec
+```
+
+### Test Coverage
+
+At the time of this writing the gem has 100% test coverage. Please keep it that way ;)
+
 ## Contributing
 
 Want to make it better? Cool. Here's how:
@@ -357,9 +377,15 @@ Want to make it better? Cool. Here's how:
 
 ## Authors
 
- * This gem was written by Eric Saxby, Atasay Gokkaya and Konstantin Gredeskoul at Wanelo, Inc.
- * It's been updated and refreshed by Konstantin Gredeskoul.
+ * This gem was donated to Open Source by [Wanelo, Inc](https://www.crunchbase.com/organization/wanelo)
 
+ * The original authors are:
+   * [Atasay Gökkaya](https://github.com/atasay)
+   * [Konstantin Gredeskoul](https://github.com/kigster)
+   * [Eric Saxby](https://github.com/sax)
+   * Paul Henry
+ 
+ * The gem is currently maintained and kept up to date by [Konstantin Gredeskoul](https://kig.re/)
 
 Please see the [LICENSE.txt](LICENSE.txt) file for further details.
 

data/lib/pause/action.rb

@@ -117,7 +117,7 @@ module Pause
       end
     end
 
-    def if_rate_limited(&_block)
+    def if_rate_limited(&)
       check_result = analyze(recalculate: true)
       yield(check_result) unless check_result.nil?
     end

data/lib/pause/version.rb

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

data/lib/pause.rb

@@ -13,6 +13,14 @@ require 'pause/rate_limited_event'
 
 module Pause
   PeriodCheck = Struct.new(:period_seconds, :max_allowed, :block_ttl) do
+    def initialize(*args, period_seconds: nil, max_allowed: nil, block_ttl: nil)
+      if args.any?
+        super(*args)
+      else
+        super(period_seconds, max_allowed, block_ttl)
+      end
+    end
+
     def <=>(other)
       period_seconds <=> other.period_seconds
     end
@@ -39,12 +47,12 @@ module Pause
 
     attr_writer :adapter
 
-    def configure(&block)
-      @configure ||= Pause::Configuration.new.configure(&block)
+    def configure(&)
+      @configure ||= Pause::Configuration.new.configure(&)
     end
 
-    def config(&block)
-      configure(&block)
+    def config(&)
+      configure(&)
     end
   end
 end

data/spec/pause/analyzer_spec.rb

@@ -42,6 +42,10 @@ describe Pause::Analyzer do
       expect(analyzer.check(action)).to be_nil
     end
 
+    it 'returns nil if action is NOT rate limited' do
+      expect(action).not_to be_rate_limited
+    end
+
     it 'returns blocked action if action is blocked' do
       Timecop.freeze Time.now do
         5.times do

data/spec/pause/period_check_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Pause
+  RSpec.describe PeriodCheck do
+    let(:period_seconds) { 10 }
+    let(:max_allowed) { 2 }
+    let(:block_ttl) { 10 }
+
+    let(:period_check_1) do
+      described_class.new(
+        period_seconds: period_seconds,
+        max_allowed: max_allowed,
+        block_ttl: block_ttl
+      )
+    end
+
+    let(:period_check_2) do
+      described_class.new(
+        period_seconds: 2 * period_seconds,
+        max_allowed: 1.5 * max_allowed,
+        block_ttl:
+      )
+    end
+
+    describe '#==' do
+      let(:period_check_3) do
+        described_class.new(
+          period_seconds: 2 * period_seconds,
+          max_allowed: 1.5 * max_allowed,
+          block_ttl:
+        )
+      end
+
+      it 'is equal' do
+        expect(period_check_3).to eq(period_check_2)
+      end
+
+      it 'is not equal' do
+        expect(period_check_3).not_to eq(period_check_1)
+      end
+
+      describe '#sort' do
+        let(:list) { [period_check_2, period_check_1] }
+
+        it 'sorts' do
+          expect(list.sort).to eq([period_check_1, period_check_2])
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pause
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -10,7 +10,7 @@ authors:
 - Eric Saxby
 bindir: bin
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -61,9 +61,9 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".rvmrc"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -84,6 +84,7 @@ files:
 - spec/pause/configuration_spec.rb
 - spec/pause/logger_spec.rb
 - spec/pause/pause_spec.rb
+- spec/pause/period_check_spec.rb
 - spec/pause/redis/adapter_spec.rb
 - spec/pause/redis/sharded_adapter_spec.rb
 - spec/spec_helper.rb

data/Guardfile

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# ^syntax detection
-
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec' do
-  watch(/^spanx\.gemspec/) { 'spec' }
-  watch(%r{^lib/(.+)\.rb$}) { 'spec' }
-
-  watch(%r{^spec/.+_spec\.rb$})
-  watch('spec/spec_helper.rb') { 'spec' }
-  watch(%r{spec/support/.*}) { 'spec' }
-end