better_rate_limit 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8202a0675862d02c311bc2c05f294d5adf1a1add2e5cf65aa401edcb0c159d5
-  data.tar.gz: b94eb54339bdd7347dbc83f4ac95f87f413671227c89e072bbc0d56bc5a5fb65
+  metadata.gz: fd081be677a01d7f69d7e6e6ada8a3172d84d6ee74fbf7ccab5d5fbecb89ee58
+  data.tar.gz: 2817642bfee1165564273b8b36ae434e02e7135c6e63a887a4c178c4558d3752
 SHA512:
-  metadata.gz: '07802df810af301f0d5d1fd8f1bd4f924b535e1dddc98575faa20ec20093d88777f27dc9f99cd6d17d7dd9163ea5760300af5b266ae5a5e120cb03c31c0ee2ea'
-  data.tar.gz: 2659222d45eb6a1d2a6559ef78c8a64fefd7e0c66a06d38b96810782063059037d6f8da8a6453b55aa8adc9c7d6e70b7c98797405c9b4258b908ed339c788d89
+  metadata.gz: bdd3fda987a39c8027d47ddec7b6112e089a609aaabd3a924e71a76417619b69284416183d68744ea05fa55b47e1cead0d04cb99ddb33937e6db97f578d784db
+  data.tar.gz: 7b03b579af9be74f8669af5531d254580b0f384232dc5cb295f6d4cbcea7ca3525d42ee41105f0c08dd121c6a68d91544e06dd38a7044bd0b4062cc6007077c5

data/.gitignore

@@ -1,61 +1,3 @@
-<<<<<<< HEAD
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
-=======
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -64,7 +6,5 @@ build-iPhoneSimulator/
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
->>>>>>> init gem
+*.gem
+.byebug_history

data/.travis.yml

@@ -2,5 +2,5 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.5
+  - 2.6.6
 before_install: gem install bundler -v 2.1.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    better_rate_limit (0.1.2)
+    better_rate_limit (0.1.5)
       actionpack (>= 5.0)
       redis (>= 3.3)
 
@@ -59,7 +59,7 @@ GEM
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
     rake (12.3.3)
-    redis (4.2.1)
+    redis (4.2.5)
     thread_safe (0.3.6)
     timecop (0.9.1)
     tzinfo (1.2.7)

data/README.md

@@ -1,4 +1,6 @@
 # BetterRateLimit
+[![Build Status](https://travis-ci.org/upscopeio/better_rate_limit.svg?branch=master)](https://travis-ci.org/upscopeio/better_rate_limit)
+[![Gem Version](https://badge.fury.io/rb/better_rate_limit.svg)](https://badge.fury.io/rb/better_rate_limit)
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/better_rate_limit`. To experiment with that code, run `bin/console` for an interactive prompt.
 
@@ -7,7 +9,7 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'better_rate_limit', git: 'https://github.com/upscopeio/better_rate_limit'
+gem 'better_rate_limit'
 ```
 
 And then execute:
@@ -39,6 +41,15 @@ ActiveSupport::Notifications.subscribe /rate_limit/ do |_name, _start, _finish,
 end
 ```
 
+### Configuration
+You can ignore the throttle by using the following configuration
+```ruby
+BetterRateLimit.configure do |config|
+  config.ignore = true
+end
+```
+Useful to ignore the throttle on tests.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/action_controller/better_rate_limit.rb

@@ -1,23 +1,26 @@
 require 'ostruct'
 require 'better_rate_limit/throttle'
+require 'better_rate_limit/limit'
 
 module ActionController
   module BetterRateLimit
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def rate_limit(max, every:, name: nil, scope: -> { real_ip }, only: [], except: [])
-        rate_limits << OpenStruct.new({
-                                        max: max,
-                                        every: every,
-                                        name: name || controller_path,
-                                        scope: scope,
-                                        only: only,
-                                        except: except,
-                                        controller_path: controller_path
+      def rate_limit(max, options)
+        rate_limits << Limit.build(max, controller_path, {
+                                        if: options[:if],
+                                        unless: options[:unless],
+                                        every: options[:every],
+                                        name: options[:name] || controller_path,
+                                        scope: options[:scope] || -> { real_ip },
+                                        only: options[:only] || [],
+                                        except: options[:except] || [],
+                                        clear_if: options[:clear_if]
                                       })
 
         before_action :perform_rate_limiting
+        after_action :clear_keys
       end
 
       def rate_limits
@@ -41,6 +44,20 @@ module ActionController
       render file: 'public/429.html', status: :too_many_requests, layout: false
     end
 
+    def clear_keys
+      rate_limits = self.class.all_rate_limits.filter(&:clear_if_present?)
+      return if rate_limits.empty?
+
+      rate_limits.each do |rate_limit|
+        should_clear = rate_limit.clear_if.is_a?(Proc) ? instance_exec(&rate_limit.clear_if) : send(rate_limit.clear_if)
+        next unless should_clear
+
+        scope = rate_limit.scope.is_a?(Proc) ? instance_exec(&rate_limit.scope) : send(rate_limit.scope)
+        scope = scope.to_param if scope.respond_to?(:to_param)
+        ::BetterRateLimit::Throttle.clear(rate_limit.key(scope))
+      end
+    end
+
     private
 
     def json?
@@ -52,7 +69,17 @@ module ActionController
     end
 
     def under_rate_limit?(limit)
-      if limit.controller_path == controller_path
+      if limit.has_if_condition?
+        if_condition = limit._if.is_a?(Proc) ? instance_exec(&limit._if) : send(limit._if)
+        return true unless if_condition
+      end
+
+      if limit.has_unless_condition?
+        unless_condition = limit._unless.is_a?(Proc) ? instance_exec(&limit._unless) : send(limit._unless)
+        return true if unless_condition
+      end
+
+      if limit.controller_path_is?(controller_path)
         return true if action_name.to_sym.in?([limit.except].flatten)
         return true if !limit.only.empty? && !action_name.to_sym.in?([limit.only].flatten)
       end
@@ -60,9 +87,7 @@ module ActionController
       scope = limit.scope.is_a?(Proc) ? instance_exec(&limit.scope) : send(limit.scope)
       scope = scope.to_param if scope.respond_to?(:to_param)
 
-      key = ['controller_throttle', limit.name, limit.max, limit.every, scope].join(':')
-
-      ::BetterRateLimit::Throttle.allow? key, limit: limit.max, time_window: limit.every
+      ::BetterRateLimit::Throttle.allow? limit.key(scope), limit: limit.max, time_window: limit.every
     end
   end
 end

data/lib/better_rate_limit.rb

@@ -1,4 +1,21 @@
 require 'action_controller'
+require 'better_rate_limit/configuration'
+
+module BetterRateLimit
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+  end
+end
 
 module ActionController
   autoload :BetterRateLimit, 'action_controller/better_rate_limit'

data/lib/better_rate_limit/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BetterRateLimit
+  class Configuration
+    attr_accessor :ignore
+
+    def initialize
+      @ignore = false
+    end
+  end
+end

data/lib/better_rate_limit/limit.rb

@@ -0,0 +1,75 @@
+class Limit
+  def self.build(max, controller_path, options)
+    options.assert_valid_keys(:if, :unless, :every, :name, :scope, :only, :except, :clear_if)
+    new(max, controller_path, {
+      if: options[:if],
+      unless: options[:unless],
+      every: options[:every],
+      name: options[:name],
+      scope: options[:scope],
+      only: options[:only],
+      except: options[:except],
+      clear_if: options[:clear_if]
+    })
+  end
+
+  attr_reader :max, :controller_path
+
+  def initialize(max, controller_path, options)
+    @max = max
+    @controller_path = controller_path
+    @options = options
+  end
+
+  def _if
+    @options[:if]
+  end
+
+  def name
+    @options[:name]
+  end
+
+  def every
+    @options[:every]
+  end
+
+  def _unless
+    @options[:unless]
+  end
+
+  def except
+    @options[:except]
+  end
+
+  def only
+    @options[:only]
+  end
+
+  def scope
+    @options[:scope]
+  end
+
+  def clear_if
+    @options[:clear_if]
+  end
+
+  def clear_if_present?
+    @options[:clear_if].present?
+  end
+
+  def has_if_condition?
+    _if.present?
+  end
+
+  def has_unless_condition?
+    _unless.present?
+  end
+
+  def controller_path_is?(controller_path)
+    self.controller_path == controller_path
+  end
+
+  def key(key_scope)
+    ['controller_throttle', name, max, every, key_scope].join(':')
+  end
+end

data/lib/better_rate_limit/throttle.rb

@@ -10,6 +10,8 @@ module BetterRateLimit
 
     class << self
       def throttle(key, limit:, time_window:)
+        return true if BetterRateLimit.configuration.ignore
+
         now = Time.now.utc
         timestamps_count = redis_client.llen key
 
@@ -21,11 +23,14 @@ module BetterRateLimit
           true
         else
           first = redis_client.lpop(key)
+
           redis_client.multi do
             redis_client.rpush key, now
             redis_client.expire key, time_window.to_i
           end
 
+          return false unless first
+
           passing = first.to_time(:utc) < time_window.ago
 
           unless passing
@@ -37,6 +42,11 @@ module BetterRateLimit
         end
       end
 
+      def clear(key)
+        redis_client.del(key)
+        redis_client.del("failing-rate-limits:#{key}")
+      end
+
       alias allow? throttle
 
       def notify(key)

data/lib/better_rate_limit/version.rb

@@ -1,3 +1,3 @@
 module BetterRateLimit
-  VERSION = "0.1.2"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_rate_limit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Pablo Fonseca
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -58,6 +58,8 @@ files:
 - bin/setup
 - lib/action_controller/better_rate_limit.rb
 - lib/better_rate_limit.rb
+- lib/better_rate_limit/configuration.rb
+- lib/better_rate_limit/limit.rb
 - lib/better_rate_limit/redis_connection.rb
 - lib/better_rate_limit/throttle.rb
 - lib/better_rate_limit/version.rb