request_meter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1b3dd163f8c18bf998e16c82da60cab3a6d945aded55fff5d5e8f64d2dd0b76
+  data.tar.gz: 034aa52d3fa74680282e82a925d9e1eac6c03d5c33b16b0de855fe61b8359c9f
+SHA512:
+  metadata.gz: fbc6956b570a7dc13fff0880e517862083aa0adff8f6f3fc32ee5efccfa8c6ac55b1d35796354e28fc1b72bc77d07bb73a92191628ec2670a211632ad68c90b7
+  data.tar.gz: 4d774eb9652b7b8bbb69dd1102c6b9505673c899a8ecb32c8d5b7482c084b39636c8c3716b8265ea64ced32edd4568f8cae6f79015a8fc30ad105cefbd11b221

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/BlockLength:
+  Enabled: false
+
+Style/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-08
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 mihai9909
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# RequestMeter
+
+
+RequestMeter is a Rack middleware gem for Rails applications that limits API requests per API key within a specified timeframe.
+
+It is ideal for Rails APIs wanting built-in request limits.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add request_meter
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install request_meter
+```
+
+## Setup
+
+Add this line to `config/application.rb`
+
+<pre lang="ruby">
+Rails.application.config.middleware.use RequestMeter::Middleware
+</pre>
+
+Example `RequestMeter` configuration in `config/initializers/request_meter.rb`:
+
+
+<pre lang="ruby">
+RequestMeter.configure do |config|
+  config.api_key_header = "X-API-Key"
+  config.cache_client = Rails.application.config.redis
+  config.quota_limit = -> (api_key) {
+    user = User.find_by(api_key: api_key)
+    user&.quota_limit
+  }
+  config.quota_period_seconds = -> (api_key) {
+    user = User.find_by(api_key: api_key)
+    user&.quota_period_seconds
+  }
+end
+</pre>
+
+
+- `api_key_header` used to get the API key from the request headers
+    - default: `X-API-Key`
+
+- `quota_limit` maximum number of requests that can be performed in the timeframe `quota_period_seconds` by an API key.
+    - default: `1000`
+    - type: `Proc` or `Integer`
+
+- `quota_period_seconds` number of seconds in a timeframe
+    - default: `3600`
+    - type: `Proc` or `Integer`
+
+- `cache_client` Client used to track request counts. **Note: Only has support for Redis**
+
+The default configuration defines a global limit of `1000 requests per hour`
+
+For custom behavior (e.g., per-user limits), use a `Proc` to dynamically determine values.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports, pull requests and ideas for improvement are welcome on GitHub at https://github.com/mihai9909/request_meter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/request_meter/configuration.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RequestMeter
+  # Configuration class holds settings for the RequestMeter middleware.
+  #
+  # It manages API request quota limits, time windows, header keys, and the cache client.
+  #
+  # @example Default configuration
+  #   config = RequestMeter::Configuration.new
+  #   config.quota_limit           #=> 1000
+  #   config.quota_period_seconds  #=> 3600
+  #   config.api_key_header        #=> "X-API-Key"
+  #
+  # @api public
+  class Configuration
+    # @return [Integer, Proc] maximum allowed requests per quota period or a Proc returning limit by api_key
+    attr_accessor :quota_limit
+    # @return [Integer, Proc] quota window length in seconds or a Proc returning period by api_key
+    attr_accessor :quota_period_seconds
+    # @return [String] HTTP header name that holds the API key
+    attr_accessor :api_key_header
+    # @return [Object, nil] Cache client (e.g. Redis) used for tracking requests
+    attr_accessor :cache_client
+
+    # Initializes a new Configuration with default values.
+    #
+    # Defaults:
+    # - quota_limit: 1000
+    # - quota_period_seconds: 3600 (1 hour)
+    # - api_key_header: "X-API-Key"
+    # - cache_client: nil
+    #
+    # @return [void]
+    def initialize
+      @quota_limit = 1000
+      @quota_period_seconds = 3600
+      @api_key_header = "X-API-Key"
+      @cache_client = nil
+    end
+
+    # Returns the quota limit for a given API key.
+    #
+    # If quota_limit is a Proc, it is called with the api_key, otherwise returns the fixed limit.
+    #
+    # @param api_key [String] the API key to check
+    # @return [Integer] the quota limit for that API key
+    def get_quota_limit(api_key)
+      if @quota_limit.is_a?(Proc)
+        @quota_limit.call(api_key)
+      else
+        @quota_limit
+      end
+    end
+
+    # Returns the quota period (in seconds) for a given API key.
+    #
+    # If quota_period_seconds is a Proc, it is called with the api_key, otherwise returns the fixed period.
+    #
+    # @param api_key [String] the API key to check
+    # @return [Integer] the quota period in seconds for that API key
+    def get_quota_period_seconds(api_key)
+      if @quota_period_seconds.is_a?(Proc)
+        @quota_period_seconds.call(api_key)
+      else
+        @quota_period_seconds
+      end
+    end
+  end
+end

data/lib/request_meter/middleware.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "rack/request"
+
+# RequestMeter::Middleware is a Rack middleware for API rate limiting.
+#
+# It checks for a configured API key header and limits requests per key using Redis.
+#
+# @example Basic usage
+#   use RequestMeter::Middleware
+#
+# @api public
+
+module RequestMeter
+  class Middleware
+    # @param app [#call] the next middleware or Rack app
+    def initialize(app)
+      @app = app
+      @cache_client = RequestMeter.configuration.cache_client
+
+      return unless @cache_client.nil?
+
+      raise MissingCacheClientError, "Cache client is required"
+    end
+
+    # Processes an incoming request, enforces quota limits, and forwards it
+    #
+    # @param env [Hash] Rack environment
+    # @return [Array] Rack response triplet
+    def call(env)
+      req = Rack::Request.new(env)
+      api_key = req.get_header("HTTP_#{RequestMeter.configuration.api_key_header.upcase.gsub("-", "_")}")
+
+      if api_key.nil? || api_key.empty?
+        return [400, { "Content-Type" => "application/json" }, [{ error: "API key is required" }.to_json]]
+      end
+
+      quota_limit = RequestMeter.configuration.get_quota_limit(api_key)
+      quota_period = RequestMeter.configuration.get_quota_period_seconds(api_key)
+
+      if quota_limit.nil? || quota_period.nil?
+        return [400, { "Content-Type" => "application/json" },
+                [{ error: "Limits are not configured for the provided token" }.to_json]]
+      end
+
+      cache_key = "request_meter:#{api_key}"
+
+      current_count = @cache_client.incr(cache_key)
+
+      @cache_client.expire(cache_key, quota_period) if current_count == 1
+
+      if current_count > quota_limit
+        reset_in = @cache_client.ttl(cache_key)
+        headers = { "Retry-After" => reset_in.to_s }
+        return [429, headers, ["Quota exceeded. Try again in #{reset_in} seconds."]]
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/request_meter/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RequestMeter
+  # Current version of the RequestMeter gem.
+  #
+  # @return [String] the gem version
+  VERSION = "0.1.0"
+end

data/lib/request_meter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "request_meter/version"
+require "request_meter/middleware"
+require "request_meter/configuration"
+
+module RequestMeter
+  class MissingCacheClientError < StandardError; end
+
+  class << self
+    # @return [RequestMeter::Configuration] current configuration instance
+    attr_accessor :configuration
+  end
+
+  # Configure the RequestMeter settings.
+  #
+  # Yields the configuration object to the given block.
+  #
+  # @yieldparam config [RequestMeter::Configuration] the configuration object
+  # @return [void]
+  #
+  # @example
+  #   RequestMeter.configure do |config|
+  #     config.api_key_header = "X-API-Key"
+  #     config.quota_limit = 1000
+  #   end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/sig/request_meter.rbs

@@ -0,0 +1,4 @@
+module RequestMeter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: request_meter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mihai9909
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: "RequestMeter is a Rack middleware gem for Rails applications that tracks
+  and limits\nAPI requests per API key within a specified time window. \n\nIt is ideal
+  for Rails APIs wanting built-in request quota enforcement.\n"
+email:
+- neagoimihai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/request_meter.rb
+- lib/request_meter/configuration.rb
+- lib/request_meter/middleware.rb
+- lib/request_meter/version.rb
+- sig/request_meter.rbs
+homepage: https://github.com/mihai9909/request_meter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mihai9909/request_meter
+  source_code_uri: https://github.com/mihai9909/request_meter
+  changelog_uri: https://github.com/mihai9909/request_meter/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Middleware to limit per API key requests.
+test_files: []