actionlimiter 0.2.0 → 1.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f5bc1107b2d90f94cb1805894dc9047764da8c0cfe298836a63ab01f4ad38b
-  data.tar.gz: f6eca9a81f6492e8f6a9c3b2231a5f85b0d5417773e57e4495b8976652b8564f
+  metadata.gz: 596e0724078e69a1a1a9fa6c220cfc338f71effe4ddd5e5b6e97bd3d5238d3ef
+  data.tar.gz: db1489d41e0fc62ecb8a41ab310bbeae3541d30934d3575db25d0adf24ea7c10
 SHA512:
-  metadata.gz: 40a691dd3379ac0c52dd09ba9c3a159953be02457a76984fe6a2d3d36339a4fd0bf2710030d5c8428e020d12053104c192d09807ad47ed57c3266650a914472c
-  data.tar.gz: d2bcd2fff1eb33902cbd3993675232224dacfd0d07e9abb49a2adc940c381b84fdcc2f02a0cd6c079675c338c3eac6e0f1313d4c25a018ef8a9454a7640d8f83
+  metadata.gz: 18d46303d422c38445b7f100f9125c86028649e6971fbbf1035652345675ad4f3c448934871fd275de27582e9cc649be8cd432106fd2c8c183b46fc999d81708
+  data.tar.gz: e0ab0fd97db9ac5c75780fe228efb51b5b7c3a70ea87f790601b5d4954325c9edf7700539c87b2516f37cdcdfc7cdd96bb095cab378f75c59e0168df61a264aa

data/README.md

@@ -1,6 +1,6 @@
 # ActionLimiter
 
-[![Unit Test](https://github.com/angryboat/actionlimiter/actions/workflows/testing.yml/badge.svg)](https://github.com/angryboat/actionlimiter/actions/workflows/testing.yml) [![Linters](https://github.com/angryboat/actionlimiter/actions/workflows/linting.yml/badge.svg)](https://github.com/angryboat/actionlimiter/actions/workflows/linting.yml)
+[![Ruby Gem](https://github.com/angryboat/actionlimiter/actions/workflows/ruby-gem.yml/badge.svg?event=push)](https://github.com/angryboat/actionlimiter/actions/workflows/ruby-gem.yml)
 
 Provides Redis backed rate limiting for Rails applications.
 

data/lib/action_limiter/config.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'connection_pool'
+require 'redis'
+require 'singleton'
+
+module ActionLimiter # rubocop:disable Style/Documentation
+  ##
+  # Provides configuration for the Gem
+  #
+  # @author Maddie Schipper
+  # @since 1.0.0
+  class Config
+    include Singleton
+
+    ##
+    # The shared Redis connection pool
+    attr_accessor :redis
+
+    ##
+    # The URL used for new Redis connections in the default pool
+    attr_accessor :redis_url
+
+    ##
+    # @private
+    def initialize
+      pool_size = ENV.fetch('RAILS_MAX_THREADS', 1).to_i
+
+      self.redis_url = 'redis://localhost:6379/0'
+      self.redis = ConnectionPool.new(size: pool_size) do
+        Redis.new(url: redis_url)
+      end
+    end
+  end
+
+  ##
+  # @private
+  def self.with_redis_connection(...)
+    Config.instance.redis.with(...)
+  end
+end

data/lib/action_limiter/middleware/ip.rb

@@ -63,7 +63,7 @@ module ActionLimiter
       def _call(env)
         remote_ip = env.fetch('action_dispatch.remote_ip')
         bucket_key = Digest::MD5.hexdigest(remote_ip.to_s)
-        bucket = @token_bucket.increment(bucket_key, Time.now)
+        bucket = @token_bucket.increment_and_return_bucket(bucket_key, Time.now)
 
         env['action_limiter.ip_bucket'] = bucket
 

data/lib/action_limiter/scripts/token_bucket.lua

@@ -13,6 +13,6 @@ local bucket_name = KEYS[1]
 
 redis.call('ZREMRANGEBYSCORE', bucket_name, '-inf', min)
 redis.call('ZADD', bucket_name, ts, ts)
-redis.call('EXPIRE', bucket_name, period * 5)
+redis.call('EXPIRE', bucket_name, period + 2)
 
 return redis.call('ZCARD', bucket_name)

data/lib/action_limiter/token_bucket.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
+require 'action_limiter/config'
 require 'action_limiter/instrumentation'
-require 'action_limiter/redis_provider'
 require 'action_limiter/scripts'
 
 module ActionLimiter
@@ -11,7 +11,9 @@ module ActionLimiter
   # @author Maddie Schipper
   # @since 0.1.0
   class TokenBucket
-    Bucket = Struct.new(:name, :value)
+    ##
+    # @private
+    Bucket = Struct.new(:name, :value, :max_size, :period, keyword_init: true)
 
     ##
     # The period length for the bucket in seconds
@@ -41,9 +43,6 @@ module ActionLimiter
       @period = period.to_i
       @size = size.to_i
       @namespace = namespace&.to_s || 'action_limiter/token_bucket'
-      @script_hash = ActionLimiter::RedisProvider.connection_pool.with do |connection|
-        connection.script(:load, ActionLimiter::SCRIPTS.fetch(:token_bucket))
-      end
     end
 
     ##
@@ -54,20 +53,44 @@ module ActionLimiter
     #
     # @return [true, false] The limiting status of the bucket
     def limited?(bucket, time: Time.now)
-      increment(bucket, time).value > size
+      increment_and_return_bucket(bucket, time).value > size
+    end
+
+    ##
+    # Delete a bucket's current value
+    #
+    # @param bucket [String] The name of the bucket to delete
+    #
+    # @return [void]
+    def delete(bucket)
+      ActionLimiter.instrument('action_limiter.token_bucket.reset') do
+        ActionLimiter.with_redis_connection do |connection|
+          connection.del(bucket_key(bucket))
+        end
+      end
     end
 
     ##
     # @private
-    def increment(bucket, time)
+    def increment_and_return_bucket(bucket, time)
       ActionLimiter.instrument('action_limiter.token_bucket.increment') do
-        ActionLimiter::RedisProvider.connection_pool.with do |connection|
-          time_stamp = time.to_f
-          bucket_key = "#{namespace}/#{bucket}"
-          value = connection.evalsha(@script_hash, [bucket_key], [period.to_s, time_stamp.to_s])
-          Bucket.new(bucket, value)
+        ActionLimiter.with_redis_connection do |connection|
+          value = connection.evalsha(script_hash, [bucket_key(bucket)], [period.to_s, time.to_f.to_s])
+          Bucket.new(name: bucket, value: value, max_size: size, period: period)
         end
       end
     end
+
+    private
+
+    def script_hash
+      @script_hash ||= ActionLimiter.with_redis_connection do |connection|
+        connection.script(:load, ActionLimiter::SCRIPTS.fetch(:token_bucket))
+      end
+    end
+
+    def bucket_key(bucket)
+      "#{namespace}/#{bucket}"
+    end
   end
 end

data/lib/action_limiter/version.rb

@@ -3,5 +3,5 @@
 module ActionLimiter
   ##
   # The current version number
-  VERSION = '0.2.0'
+  VERSION = '1.0.0.beta4'
 end

data/lib/action_limiter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'action_limiter/config'
 require 'action_limiter/middleware'
 require 'action_limiter/rails'
 require 'action_limiter/token_bucket'
@@ -11,4 +12,12 @@ require 'action_limiter/version'
 # @author Maddie Schipper
 # @since 0.1.0
 module ActionLimiter
+  ##
+  # Perform configuration
+  #
+  # @author Maddie Schipper
+  # @since 1.0.0
+  def self.configure
+    yield(Config.instance) if block_given?
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionlimiter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0.beta4
 platform: ruby
 authors:
 - Maddie Schipper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -50,7 +50,23 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Redis backed request rate limiter
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Redis backed token bucket rate limting implementation.
+
+  '
 email:
 - maddie@angryboat.com
 executables: []
@@ -60,12 +76,12 @@ files:
 - LICENSE
 - README.md
 - lib/action_limiter.rb
+- lib/action_limiter/config.rb
 - lib/action_limiter/instrumentation.rb
 - lib/action_limiter/middleware.rb
 - lib/action_limiter/middleware/ip.rb
 - lib/action_limiter/rails.rb
 - lib/action_limiter/rails/engine.rb
-- lib/action_limiter/redis_provider.rb
 - lib/action_limiter/scripts.rb
 - lib/action_limiter/scripts/token_bucket.lua
 - lib/action_limiter/token_bucket.rb
@@ -76,6 +92,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/angryboat/actionlimiter
   source_code_uri: https://github.com/angryboat/actionlimiter
   changelog_uri: https://github.com/angryboat/actionlimiter
@@ -87,15 +104,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Redis backed request rate limiter
+summary: Rate Limiting
 test_files: []

data/lib/action_limiter/redis_provider.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require 'connection_pool'
-require 'redis'
-
-##
-# @private
-module ActionLimiter
-  ##
-  # Private
-  class RedisProvider
-    MUTEX = Mutex.new
-
-    class << self
-      def pool_size
-        ENV.fetch('ACTION_LIMITER_POOL_SIZE', 5).to_i
-      end
-
-      def pool_connection_timeout
-        ENV.fetch('ACTION_LIMITER_TIMEOUT', 30).to_i
-      end
-
-      def redis_connection_host
-        ENV.fetch('ACTION_LIMITER_REDIS_HOST', '127.0.0.1')
-      end
-
-      def redis_connection_port
-        ENV.fetch('ACTION_LIMITER_REDIS_PORT', 6379).to_i
-      end
-
-      def redis_connection_database
-        ENV.fetch('ACTION_LIMITER_REDIS_DB', 0).to_i
-      end
-
-      def connection_pool
-        MUTEX.synchronize do
-          @connection_pool ||= unsafe_create_connection_pool
-        end
-      end
-
-      def unsafe_create_connection_pool
-        ConnectionPool.new(size: pool_size, timeout: pool_connection_timeout) do
-          RedisProvider.unsafe_create_redis_connection
-        end
-      end
-
-      def unsafe_create_redis_connection
-        Redis.new(
-          host: redis_connection_host,
-          port: redis_connection_port,
-          db: redis_connection_database
-        )
-      end
-    end
-  end
-end