better_rate_limit 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698bf0e0ba70aab7b648cb4e491697a629c7317f56177c2b62577300dfd226f3
-  data.tar.gz: 49765bc3916fb28fcd06ff924f892d3d90d04156f244b60850bcd1b4539b7110
+  metadata.gz: fd081be677a01d7f69d7e6e6ada8a3172d84d6ee74fbf7ccab5d5fbecb89ee58
+  data.tar.gz: 2817642bfee1165564273b8b36ae434e02e7135c6e63a887a4c178c4558d3752
 SHA512:
-  metadata.gz: cd2d27993d49945a2585b939759f9ac3196562f548f39fa812d12b51405e41e024e6c27eb769930592b570285576655275afb3ab9561685e8ff79cbc67405052
-  data.tar.gz: 3736574686273346443af48fdbe72af7f2a98bb164e45bc7734683a8b6cdd3d1d2889f1415874a35f5dfbafb1061b6af416ed957de08eda1fc66bd56d6208b9f
+  metadata.gz: bdd3fda987a39c8027d47ddec7b6112e089a609aaabd3a924e71a76417619b69284416183d68744ea05fa55b47e1cead0d04cb99ddb33937e6db97f578d784db
+  data.tar.gz: 7b03b579af9be74f8669af5531d254580b0f384232dc5cb295f6d4cbcea7ca3525d42ee41105f0c08dd121c6a68d91544e06dd38a7044bd0b4062cc6007077c5

data/README.md

@@ -41,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/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/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
 

data/lib/better_rate_limit/version.rb

@@ -1,3 +1,3 @@
 module BetterRateLimit
-  VERSION = "0.1.5"
+  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.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Pablo Fonseca
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -58,6 +58,7 @@ 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
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Rate limit requests