better_rate_limit 0.1.5 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698bf0e0ba70aab7b648cb4e491697a629c7317f56177c2b62577300dfd226f3
-  data.tar.gz: 49765bc3916fb28fcd06ff924f892d3d90d04156f244b60850bcd1b4539b7110
+  metadata.gz: 9eedeebfe87d1f95a4541b994bcabec39ac02250827174c12da04b612209e4f6
+  data.tar.gz: 0aee3a1cf32a3e59c8b1307dd6364f6610272366267d4c59644741df3d9006b6
 SHA512:
-  metadata.gz: cd2d27993d49945a2585b939759f9ac3196562f548f39fa812d12b51405e41e024e6c27eb769930592b570285576655275afb3ab9561685e8ff79cbc67405052
-  data.tar.gz: 3736574686273346443af48fdbe72af7f2a98bb164e45bc7734683a8b6cdd3d1d2889f1415874a35f5dfbafb1061b6af416ed957de08eda1fc66bd56d6208b9f
+  metadata.gz: 162d31096ed6a08dc8ca38b18becb34512f25abd99297bd9b03ac7dd0208499dea1fd8ba2871584a9929ba45555734e8a8611c2b3d64df663b3a60128f007ae3
+  data.tar.gz: b28194386480e1ec62fca06ea62ba8de6ec41eedae07d97710e9afb1bf5af09923fe5f1465a93f3cd85c167f5c18300f74b8242e35eeffed95af66a165ec7c8a

data/Gemfile.lock

@@ -1,44 +1,44 @@
 PATH
   remote: .
   specs:
-    better_rate_limit (0.1.5)
+    better_rate_limit (0.1.6)
       actionpack (>= 5.0)
       redis (>= 3.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.4.3)
-      actionview (= 5.2.4.3)
-      activesupport (= 5.2.4.3)
+    actionpack (5.2.6.2)
+      actionview (= 5.2.6.2)
+      activesupport (= 5.2.6.2)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.4.3)
-      activesupport (= 5.2.4.3)
+    actionview (5.2.6.2)
+      activesupport (= 5.2.6.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.4.3)
+    activesupport (5.2.6.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    erubi (1.9.0)
-    i18n (1.8.5)
+    erubi (1.10.0)
+    i18n (1.9.1)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.14.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    minitest (5.15.0)
     mocha (1.11.2)
     mock_redis (0.25.0)
     nokogiri (1.10.10)
@@ -47,8 +47,8 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rack (2.2.3)
-    rack-test (0.6.3)
-      rack (>= 1.0)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
     rails-controller-testing (1.0.5)
       actionpack (>= 5.0.1.rc1)
       actionview (>= 5.0.1.rc1)
@@ -56,13 +56,13 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
     rake (12.3.3)
-    redis (4.2.5)
+    redis (4.3.1)
     thread_safe (0.3.6)
     timecop (0.9.1)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
 
 PLATFORMS

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/configuration.rb

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

data/lib/better_rate_limit/redis_connection.rb

@@ -2,6 +2,12 @@
 
 require 'redis'
 
+class MissingRedisConfigError < StandardError
+  def initialize
+    super 'Redis client not set'
+  end
+end
+
 module BetterRateLimit
   module RedisConnection
     def self.included(host)
@@ -10,7 +16,7 @@ module BetterRateLimit
 
     module ClassMethods
       def redis_client
-        @redis_client ||= Redis.new(url: ENV.fetch('REDIS_URL', 'redis://localhost:6379'))
+        @redis_client ||= BetterRateLimit.configuration.redis_client
       end
     end
   end

data/lib/better_rate_limit/throttle.rb

@@ -10,21 +10,24 @@ module BetterRateLimit
 
     class << self
       def throttle(key, limit:, time_window:)
+        return true if BetterRateLimit.configuration.ignore
+        raise MissingRedisConfigError unless redis_client
+
         now = Time.now.utc
         timestamps_count = redis_client.llen key
 
         if timestamps_count < limit
-          redis_client.multi do
-            redis_client.rpush key, now
-            redis_client.expire key, time_window.to_i
+          redis_client.multi do |pipeline|
+            pipeline.rpush key, now
+            pipeline.expire key, time_window.to_i
           end
           true
         else
           first = redis_client.lpop(key)
 
-          redis_client.multi do
-            redis_client.rpush key, now
-            redis_client.expire key, time_window.to_i
+          redis_client.multi do |pipeline|
+            pipeline.rpush key, now
+            pipeline.expire key, time_window.to_i
           end
 
           return false unless first

data/lib/better_rate_limit/version.rb

@@ -1,3 +1,3 @@
 module BetterRateLimit
-  VERSION = "0.1.5"
+  VERSION = '0.1.8'
 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'

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.8
 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: 2022-07-15 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.2.22
 signing_key:
 specification_version: 4
 summary: Rate limit requests