pause 0.2.1 → 0.5.0

data/README.md

@@ -1,17 +1,125 @@
-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)
+[![RSpec](https://github.com/kigster/pause/actions/workflows/rspec.yml/badge.svg?style=for-the-badge)](https://github.com/kigster/pause/actions/workflows/rspec.yml)
+[![Rubocop](https://github.com/kigster/pause/actions/workflows/rubocop.yml/badge.svg?style=for-the-badge)](https://github.com/kigster/pause/actions/workflows/rubocop.yml)
 
-Pause is a flexible Redis-backed rate-limiting client. Use it to track events, with
+[![Gem Version](https://badge.fury.io/rb/pause@2x.png?icon=si%3Arubygems)](https://badge.fury.io/rb/pause)
+
+[![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
+
+## In a Nutshell
+
+**Pause** is a fast and very flexible Redis-backed rate-limiter. You can use it to track events, with
 rules around how often they are allowed to occur within configured time checks.
 
-Because Pause is Redis-based, multiple ruby processes (even distributed across multiple servers) can track and report
-events together, and then query whether a particular identifier should be rate limited or not.
+Sample applications include:
+ 
+ * throttling notifications sent to a user as to not overwhelm them with too much frequency,
+ * IP-based blocking based on HTTP request volume (see the related gem [spanx](https://github.com/wanelo/spanx)) that uses Pause,
+ * ensuring you do not exceed API rate limits when calling external web APIs.
+ * etc.
+ 
+Pause currently does not offer a CLI client, and can only be used from within a Ruby application.
+
+Additionally:
+
+ * Pause is pure-ruby gem and does not depend on Rails or Rack
+ * Pause can be used across multiple ruby processes, since it uses a distributed Redis backend
+ * Pause is currently in use by a web application receiving 6K-10K web requests per second
+ * Pause will work with a horizontally sharded multi-Redis-backend by using Twitter's [Twemproxy](https://github.com/twitter/twemproxy). This way, millions of concurrent users can be handled with ease.
+
+### Quick Start
+
+This section is meant to give you a rapid introduction, so that you can start using Pause immediately.
+
+Our use case: we want to rate limit notifications sent to users, identified by their `user_id`, to:
+
+ * no more than 1 in any 2-hour period
+ * no more than 3 per day
+ * no more than 7 per week
+
+Here is how we could set this up using Pause:
+
+#### Configuration
+
+We need to setup Pause with a Redis instance. Here is how we do it:
+
+```ruby
+require 'pause'
+
+# First, lets point Pause to a Redis instance
+Pause.configure do |config|
+  # Redis connection parameters
+  config.redis_host = '127.0.0.1'
+  config.redis_port = 6379
+  config.redis_db   = 1
+  config.resolution = 600     
+  config.history    = 7 * 86400  # discard events older than 7 days   
+end
+```
+
+> NOTE: **resolution** is an setting that's key to understanding how Pause works. It represents the length of time during which similar events are aggregated into a Hash-like object, where the key is the identifier, and the value is the count within that period.
+> 
+> Because of this,
+>  
+>   * _Larger resolution requires less RAM and CPU and are faster to compute_
+>   * _Smaller resolution is more computationally expensive, but provides higher granularity_.
+>
+> The resolution setting must set to the smallest rate-limit period across all of your checks. Below it is set to 10 minutes, meaning that you can use Pause to **rate limit any event to no more than N times within a period of 10 minutes or more.**
+
+
+#### Define Rate Limited "Action"
+
+Next we must define the rate limited action based on the specification above. This is how easy it is:
+
+```ruby
+module MyApp
+  class UserNotificationLimiter < ::Pause::Action
+    # this is a redis key namespace added to all data in this action
+    scope 'un'  
+    
+    check period_seconds: 120, 
+          max_allowed: 1, 
+          block_ttl: 240
+          
+    check period_seconds: 86400, 
+          max_allowed: 3
+          
+    check period_seconds: 7 * 86400, 
+          max_allowed: 7
+  end
+end
+```
+
+> NOTE: for each check, `block_ttl` defaults to `period_seconds`, and represents the duration of time the action will consider itself as "rate limited" after a particular check reaches the limit.  Note, that all actions will automatically leave the "rate limited" state after `block_ttl` seconds have passed.
+
+#### Perform operation, but only if the user is not rate-limited
+
+Now we simply instantiate this limiter by passing user ID (any unique identifier works). We can then ask the limiter, `ok?` or `rate_limited?`, or we can use two convenient methods that only execute enclosed block if the described condition is satisfied:
+
+```ruby
+class NotificationsWorker
+  def perform(user_id)
+    MyApp::UserNotificationLimiter.new(user_id) do 
+      unless_rate_limited do
+        # this block ONLY runs if rate limit is not reached
+        user = User.find(user_id) 
+        PushNotifications.new(user).send_push_notification!
+      end
+      
+      if_rate_limited do |rate_limit_event|
+        # this block ONLY runs if the action has reached it's rate limit.
+        Rails.logger.info("user #{user.id} has exceeded rate limit: #{rate_limit_event}") 
+      end
+    end   
+  end
+end
+```
+
+That's it! Using these two methods you can pretty much ensure that your rate limits are always in check. 
 
-Sample applications include IP-based blocking based on HTTP request volume (see related gem "spanx"),
-throttling push notifications as to not overwhelm the user with too much frequency, etc.
 
 ## Installation
 
@@ -86,47 +194,44 @@ In other words, if your shortest check is 1 minute, you could set resolution to
 require 'pause'
 
 class FollowAction < Pause::Action
-  scope "f"
+  scope 'fa' # keep those short
   check period_seconds:   60, max_allowed:  100, block_ttl: 3600
   check period_seconds: 1800, max_allowed: 2000, block_ttl: 3600
 end
 ```
 
-When an event occurs, you increment an instance of your action, optionally with a timestamp and count. This saves
-data into a redis store, so it can be checked later by other processes. Timestamps should be in unix epoch format.
+When an event occurs, you increment an instance of your action, optionally with a timestamp and count. This saves data into a redis store, so it can be checked later by other processes. Timestamps should be in unix epoch format.
+
+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
 class FollowsController < ApplicationController
   def create
     action = FollowAction.new(user.id)
     if action.ok?
-      # do stuff!
-      # and track it...
+      user.follow! 
+      # and don't forget to track the "success"
       action.increment!
-    else
-      # action is rate limited, either skip
-      # or show error, depending on the context.
     end
   end
 end
 
 class OtherController < ApplicationController
   def index
-    action = OtherAction.new(params[:thing])
+    action = OtherAction.new(params[:thing])d
     unless action.rate_limited?
       # perform business logic
-      ....
-      # track it
+      # but in this
       action.increment!(params[:count].to_i, Time.now.to_i)
     end
   end
 end
 ```
 
-If more data is needed about why the action is blocked, the `analyze` can be called
+If more data is needed about why the action is blocked, the `analyze` can be called:
 
 ```ruby
-action = NotifyViaEmailAction.new("thing")
+action = NotifyViaEmailAction.new(:thing)
 
 while true
   action.increment!
@@ -216,12 +321,30 @@ Pause.configure do |config|
 end
 ```
 
-With this configuration, any Pause operation that we know is not supported by Twemproxy will raise
-`Pause::Redis::OperationNotSupported`. For instance, when sharding we are unable to get a list of all
-tracked identifiers.
+With this configuration, any Pause operation that we know is not supported by Twemproxy will raise `Pause::Redis::OperationNotSupported`. For instance, when sharding we are unable to get a list of all tracked identifiers.
 
 The action block list is implemented as a sorted set, so it should still be usable when sharding.
 
+## 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`.
+
+Please note that Travis suite, as well as the default rake task, run both.
+
+### Unit Testing with Fakeredis
+
+Fakeredis is the default, and is also run whenever `bundle exec rspec` is executed, or `rake spec` task invoked.
+
+```bash
+bundle exec rake spec:unit
+```
+
+### Integration Testing with Redis
+
+```bash
+bundle exec rake spec:integration
+```
+
 ## Contributing
 
 Want to make it better? Cool. Here's how:
@@ -234,8 +357,10 @@ 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.
+ * This gem was written by Eric Saxby, Atasay Gokkaya and Konstantin Gredeskoul at Wanelo, Inc.
+ * It's been updated and refreshed by Konstantin Gredeskoul.
+
 
-Please see the LICENSE.txt file for further details.
+Please see the [LICENSE.txt](LICENSE.txt) file for further details.
 
 

data/Rakefile

@@ -1,6 +1,48 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: %w[spec:unit spec:integration]
+
+namespace :spec do
+  desc 'Run specs using fakeredis'
+  task :unit do
+    ENV['PAUSE_REAL_REDIS'] = nil
+    Rake::Task['spec'].execute
+  end
+  desc 'Run specs against a local Redis server'
+  task :integration do
+    ENV['PAUSE_REAL_REDIS'] = 'true'
+    Rake::Task['spec'].execute
+  end
+end
+
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :clean do
+  shell('rm -rf pkg/ tmp/ coverage/ doc/ ')
+end
+
+task gem: [:build] do
+  shell('gem install pkg/*')
+end
+
+task permissions: [:clean] do
+  shell('chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*')
+  shell('find . -type d -exec chmod o+x,g+x {} \\;')
+end
+
+task build: :permissions
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = %w[lib/**/*.rb exe/*.rb - README.md LICENSE.txt]
+  t.options.unshift('--title', '"Pause - Redis-backed Rate Limiter"')
+  t.after = -> { exec('open doc/index.html') }
+end

data/bin/spec

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+retry-errors() {
+  sleep 1
+  bundle exec rspec --only-failures
+}
+
+specs() {
+  bundle exec rspec && \
+    PAUSE_REAL_REDIS=true bundle exec rspec
+}
+
+specs || retry-errors
+

data/lib/pause/action.rb

@@ -1,62 +1,131 @@
+# frozen_string_literal: true
+
 module Pause
   class Action
     attr_accessor :identifier
 
-    def initialize(identifier)
+    def initialize(identifier, &block)
       @identifier = identifier
-      self.class.checks = [] unless self.class.instance_variable_get(:@checks)
+      self.class.checks ||= []
+      instance_exec(&block) if block
     end
 
-    # Action subclasses should define their scope as follows
-    #
-    #     class MyAction < Pause::Action
-    #       scope "my:scope"
-    #     end
-    #
     def scope
-      raise 'Should implement scope. (Ex: ipn:follow)'
-    end
-
-    def self.scope(scope_identifier = nil)
-      class_variable_set(:@@class_scope, scope_identifier)
-      define_method(:scope) { scope_identifier }
-    end
-
-    # Action subclasses should define their checks as follows
-    #
-    #  period_seconds - compare all activity by an identifier within the time period
-    #  max_allowed    - if the number of actions by an identifier exceeds max_allowed for the time period marked
-    #                   by period_seconds, it is no longer ok.
-    #  block_ttl      - time to mark identifier as not ok
-    #
-    #     class MyAction < Pause::Action
-    #       check period_seconds: 60,   max_allowed: 100,  block_ttl: 3600
-    #       check period_seconds: 1800, max_allowed: 2000, block_ttl: 3600
-    #     end
-    #
-    def self.check(*args)
-      @checks ||= []
-      period_seconds, max_allowed, block_ttl =
-        if args.first.is_a?(Hash)
-          [args.first[:period_seconds], args.first[:max_allowed], args.first[:block_ttl]]
-        else
-          args
+      self.class.scope
+    end
+
+    class << self
+      attr_accessor :checks
+
+      def inherited(klass)
+        klass.instance_eval do
+          # Action subclasses should define their scope as follows
+          #
+          #     class MyAction < Pause::Action
+          #       scope "my:scope"
+          #     end
+          #
+          @scope = klass.name.downcase.gsub('::', '.')
+          class << self
+            # @param [String] args
+            def scope(*args)
+              @scope = args.first if args && args.size == 1
+              @scope
+            end
+          end
         end
-      @checks << Pause::PeriodCheck.new(period_seconds, max_allowed, block_ttl)
-    end
-
-    def self.checks
-      @checks
+      end
+
+      # Actions can be globally disabled or re-enabled in a persistent
+      # way.
+      #
+      #   MyAction.disable
+      #   MyAction.enabled? => false
+      #   MyAction.disabled? => true
+      #
+      #   MyAction.enable
+      #   MyAction.enabled? => true
+      #   MyAction.disabled? => false
+      #
+      def enable
+        adapter.enable(scope)
+      end
+
+      def disable
+        adapter.disable(scope)
+      end
+
+      def enabled?
+        adapter.enabled?(scope)
+      end
+
+      def disabled?
+        !enabled?
+      end
+
+      # Action subclasses should define their checks as follows
+      #
+      #  period_seconds - compare all activity by an identifier within the time period
+      #  max_allowed    - if the number of actions by an identifier exceeds max_allowed for the time period marked
+      #                   by period_seconds, it is no longer ok.
+      #  block_ttl      - time to mark identifier as not ok
+      #
+      #     class MyAction < Pause::Action
+      #       check period_seconds: 60,   max_allowed: 100,  block_ttl: 3600
+      #       check period_seconds: 1800, max_allowed: 2000, block_ttl: 3600
+      #     end
+      #
+      def check(*args, **opts)
+        self.checks ||= []
+
+        params =
+          if args.empty?
+            # if block_ttl is not provided, just default to the period
+            opts[:block_ttl] ||= opts[:period_seconds]
+            [opts[:period_seconds], opts[:max_allowed], opts[:block_ttl]]
+          else
+            args
+          end
+
+        self.checks << Pause::PeriodCheck.new(*params)
+      end
+
+      def tracked_identifiers
+        adapter.all_keys(scope)
+      end
+
+      def rate_limited_identifiers
+        adapter.rate_limited_keys(scope)
+      end
+
+      def unblock_all
+        adapter.delete_rate_limited_keys(scope)
+      end
+
+      def adapter
+        Pause.adapter
+      end
+    end
+
+    def unless_rate_limited(count: 1, timestamp: Time.now.to_i, &_block)
+      check_result = analyze
+      if check_result.nil?
+        yield
+        increment!(count, timestamp)
+      else
+        check_result
+      end
+    end
+
+    def if_rate_limited(&_block)
+      check_result = analyze(recalculate: true)
+      yield(check_result) unless check_result.nil?
     end
 
     def checks
       self.class.checks
     end
 
-    def self.checks=(period_checks)
-      @checks = period_checks
-    end
-
     def block_for(ttl)
       adapter.rate_limit!(scope, identifier, ttl)
     end
@@ -66,7 +135,7 @@ module Pause
     end
 
     def rate_limited?
-      ! ok?
+      !ok?
     end
 
     def ok?
@@ -76,65 +145,18 @@ module Pause
       false
     end
 
-    def analyze
-      Pause.analyzer.check(self)
-    end
-
-    def self.tracked_identifiers
-      adapter.all_keys(self.class_scope)
-    end
-
-    def self.rate_limited_identifiers
-      adapter.rate_limited_keys(self.class_scope)
-    end
-
-    def self.unblock_all
-      adapter.delete_rate_limited_keys(self.class_scope)
+    def analyze(recalculate: false)
+      Pause.analyzer.check(self, recalculate: recalculate)
     end
 
     def unblock
       adapter.delete_rate_limited_key(scope, identifier)
     end
 
-    # Actions can be globally disabled or re-enabled in a persistent
-    # way.
-    #
-    #   MyAction.disable
-    #   MyAction.enabled? => false
-    #   MyAction.disabled? => true
-    #
-    #   MyAction.enable
-    #   MyAction.enabled? => true
-    #   MyAction.disabled? => false
-    #
-    def self.enable
-      adapter.enable(class_scope)
-    end
-
-    def self.disable
-      adapter.disable(class_scope)
-    end
-
-    def self.enabled?
-      adapter.enabled?(class_scope)
-    end
-
-    def self.disabled?
-      ! enabled?
-    end
-
     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
   end
 end

data/lib/pause/analyzer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pause/helper/timing'
 
 module Pause
@@ -10,14 +12,16 @@ module Pause
     # @return [nil]  everything is fine
     # @return [false]  this action is already blocked
     # @return [Pause::RateLimitedEvent]  the action was blocked as a result of this check
-    def check(action)
-      return false if adapter.rate_limited?(action.scope, action.identifier)
+    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)
+      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,9 +1,11 @@
+# frozen_string_literal: true
+
 module Pause
   class Configuration
     attr_writer :redis_host, :redis_port, :redis_db, :resolution, :history, :sharded
 
     def configure
-      yield self
+      yield self if block_given?
       self
     end
 
@@ -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