rate_limiter_engine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25680fbf29d02bc0d1657d03a82074f66608db7115efa20387bb3d613a382d79
+  data.tar.gz: 39d2fe46ef92d55517bf070286157152888a2f3b654215f89a9d57fe0320b047
+SHA512:
+  metadata.gz: 0ecd532d39f1d09de8db9f500a6b3e5ee03edfd7b801392cb996dce0f13e20085cfd9354b28f1454715ef5cf9563f66e27f2beffb3ddddc82e13e0d8a65c8bcd
+  data.tar.gz: 701c10ba0dee7ac5a9bdafaa7d79c2f013d59eab9035fadb92a73a9481c9d33394c45438e9b6bb0212d4e3685da94b22ca13cf8b2ae43e0cee3e2a42f203d2cd

data/lib/rate_limiter.rb

@@ -0,0 +1,6 @@
+require 'rate_limiter/configuration'
+require 'rate_limiter/rate_limiter'
+require 'rate_limiter/rate_limit'
+require 'rate_limiter/engine'
+
+module RateLimiter; end

data/lib/rate_limiter/configuration.rb

@@ -0,0 +1,20 @@
+module RateLimiter
+  class Configuration
+    attr_accessor :rate_default,
+                  :period_default,
+                  :force_rate_limit,
+                  :force_period
+  end
+
+  class << self
+    def configure
+      yield(configuration)
+
+      configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/rate_limiter/engine.rb

@@ -0,0 +1,5 @@
+module RateLimiter
+  class Engine < ::Rails::Engine
+    isolate_namespace RateLimiter
+  end
+end

data/lib/rate_limiter/rate_limit.rb

@@ -0,0 +1,45 @@
+module RateLimiter
+  module RateLimit
+    extend ActiveSupport::Concern
+
+    @@rate = {}
+    @@rate_default = ::RateLimiter.configuration.rate_default || 100
+    @@period = {}
+    @@period_default = ::RateLimiter.configuration.period_default || 100
+
+    included do
+      before_action :rate_limiter
+
+      def self.rate(rate)
+        @@rate[controller_name] = rate
+      end
+
+      def self.period(period)
+        @@period[controller_name] = period
+      end
+    end
+
+    protected
+
+    def rate_limiter
+      rate_limiter_object.count
+      rate_limiter_object.increment
+
+      render_limit_exceeded if rate_limiter_object.blocked?
+    end
+
+    def render_limit_exceeded
+      render json: {
+        message: "Rate limit exceeded. Try again in #{rate_limiter_object.cooldown_period} seconds"
+      }, status: :too_many_requests
+    end
+
+    def client_key
+      "#{request.env['REMOTE_IP']}_counter"
+    end
+
+    def rate_limiter_object
+      RateLimiter.new(client_key)
+    end
+  end
+end

data/lib/rate_limiter/rate_limiter.rb

@@ -0,0 +1,70 @@
+module RateLimiter
+  class RateLimiter
+    def initialize(client_key)
+      @client_key = client_key
+    end
+
+    attr_reader :client_key
+
+    def blocked?
+      counter.present? && limit_exceeded
+    end
+
+    def count
+      return if counter
+
+      set_client_key
+      set_expire
+    end
+
+    def increment
+      $redis.incr(client_key)
+    end
+
+    def cooldown_period
+      $redis.ttl(client_key)
+    end
+
+    private
+
+    def counter
+      $redis.get(client_key)
+    end
+
+    def limit_exceeded
+      counter.to_i > rate_limit.to_i
+    end
+
+    def set_client_key
+      $redis.set(client_key, 0)
+    end
+
+    def set_expire
+      $redis.expire(client_key, period)
+    end
+
+    def rate_limit
+      force_rate_limit || rate_default
+    end
+
+    def period
+      force_period || period_default
+    end
+
+    def force_rate_limit
+      ::RateLimiter.configuration.force_rate_limit
+    end
+
+    def rate_default
+      ::RateLimiter.configuration.rate_default
+    end
+
+    def force_period
+      ::RateLimiter.configuration.force_period
+    end
+
+    def period_default
+      ::RateLimiter.configuration.period_default
+    end
+  end
+end

data/lib/rate_limiter/version.rb

@@ -0,0 +1,3 @@
+module RateLimiter
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rate_limiter_engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vitor Oliveira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Rate Limiter for Rails APIs
+email:
+- vbrazo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rate_limiter.rb
+- lib/rate_limiter/configuration.rb
+- lib/rate_limiter/engine.rb
+- lib/rate_limiter/rate_limit.rb
+- lib/rate_limiter/rate_limiter.rb
+- lib/rate_limiter/version.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Rate Limiter for Rails APIs
+test_files: []