rack_rate_limiting 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7aff6cea5f0811eaed535e5d463cfba9be66584d86abb89555393c68afee4b54
+  data.tar.gz: b34e11788a9fe866193c6f2bd422eb53f6addf0929b3439aee5fbdd990318fa0
+SHA512:
+  metadata.gz: '059c1fefec0fa03c1acd2ba3be564c9d6857e6f4869bc16c5ae7266cbdb9d93aa0e1ee01ccdd16a3f74ab2217037e675c81ccf713902ad14ac9e51d2ecee4075'
+  data.tar.gz: f0d660e49304bf57a702624c57f89569636131ae6e1db17861229470e014f4cb4ecb3a310522d1fc9c06825fc8fb8826d31ec3c9df2c9c17018125dd62913d06

data/.byebug_history

@@ -0,0 +1,5 @@
+c
+middleware.storage
+middleware.instance_variable
+middleware.storage
+middleware

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Abdul Rahman Khan
+
+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,140 @@
+# RateLimiter
+
+A flexible rate limiting gem for Rack-based Ruby applications. Provides multiple storage options and easy configuration for API rate limiting.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+Alternatively, add this line to your application's Gemfile:
+
+```ruby
+gem 'UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+### Basic Setup
+
+Add the middleware to your application:
+
+#### For Rails Applications
+
+```ruby
+# config/application.rb
+module YourApp
+  class Application < Rails::Application
+    config.middleware.use RateLimiter::Middleware
+  end
+end
+```
+
+#### For Rack Applications
+
+```ruby
+# config.ru
+require 'rate_limiter'
+
+RateLimiter.configure do |config|
+  config.requests_per_minute = 100
+end
+
+use RateLimiter::Middleware
+run YourApp
+```
+
+### Configuration
+
+Configure the rate limiter with your desired settings:
+
+```ruby
+# config/initializers/rate_limiter.rb (for Rails)
+RateLimiter.configure do |config|
+  config.requests_per_minute = 100  # Number of requests allowed per minute
+  config.storage_type = :memory     # Choose storage type (:memory, :redis, :memcache)
+
+  # Redis configuration (if using Redis storage)
+  config.redis_options = {
+    host: 'localhost',
+    port: 6379
+  }
+end
+```
+
+### Storage Options
+
+The gem supports multiple storage backends:
+
+#### Memory Storage (Default)
+```ruby
+RateLimiter.configure do |config|
+  config.storage_type = :memory
+end
+```
+
+#### Memcache Storage
+```ruby
+RateLimiter.configure do |config|
+  config.storage_type = :memcache
+end
+```
+
+#### Redis Storage
+```ruby
+RateLimiter.configure do |config|
+  config.storage_type = :redis
+  config.redis_options = {
+    host: 'localhost',
+    port: 6379
+  }
+end
+```
+
+### Rate Limit Exceeded Response
+
+When the rate limit is exceeded, the middleware returns:
+
+- Status: `429 Too Many Requests`
+- Body: "Rate limit exceeded. Try again later."
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+TODO: Update the github url below
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rate_limiter.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RateLimiter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rate_limiter/configuration.rb

@@ -0,0 +1,15 @@
+module RateLimiter
+  class Configuration
+    attr_accessor :requests_per_minute, :storage_type, :redis_options
+
+    def initialize
+      @requests_per_minute = 60
+      @storage_type = :memory
+      @redis_options = { host: 'localhost', port: 6379 }
+    end
+
+    def storage_type=(type)
+      @storage_type = type.to_sym
+    end
+  end
+end

data/lib/rate_limiter/middleware.rb

@@ -0,0 +1,25 @@
+# lib/rate_limiter/middleware.rb
+module RateLimiter
+  class Middleware
+    def initialize(app)
+      @app = app
+      @config = RateLimiter.config
+      @storage = RateLimiter.storage
+    end
+
+    def call(request)
+      client_id = request['REMOTE_ADDR']
+      @storage.add_request(client_id)
+
+      puts "********************************************************"
+      puts "Requests in last minute: #{@storage.requests_in_last_minute(client_id).size}"
+      puts "********************************************************"
+
+      if @storage.requests_in_last_minute(client_id).size > @config.requests_per_minute
+        [429, { 'Content-Type' => 'text/plain' }, ['Rate limit exceeded. Try again later.']]
+      else
+        @app.call(request)
+      end
+    end
+  end
+end

data/lib/rate_limiter/storage/base.rb

@@ -0,0 +1,13 @@
+module RateLimiter
+  module Storage
+    class Base
+      def add_request(client_id)
+        raise NotImplementedError, "Subclasses must implement this method"
+      end
+
+      def requests_in_last_minute(client_id)
+        raise NotImplementedError, "Subclasses must implement this method"
+      end
+    end
+  end
+end

data/lib/rate_limiter/storage/factory.rb

@@ -0,0 +1,18 @@
+module RateLimiter
+  module Storage
+    class Factory
+      def self.create(config)
+        case config.storage_type
+        when :memory
+          Memory.new
+        when :memcache
+          Memcache.new
+        when :redis
+          Redis.new(config.redis_options)
+        else
+          raise ArgumentError, "Unknown storage type: #{config.storage_type}"
+        end
+      end
+    end
+  end
+end

data/lib/rate_limiter/storage/memcache.rb

@@ -0,0 +1,25 @@
+module RateLimiter
+  module Storage
+    class Memcache < Base
+      # Compare Memcache with the rack-attack gem code
+      # https://github.com/kickstarter/rack-attack/blob/master/lib/rack/attack/storage/memcache.rb
+      def initialize
+        @cache = Dalli::Client.new
+      end
+
+      def add_request(client_id)
+        key = "rate_limit:#{client_id}"
+        timestamps = @cache.get(key) || []
+        timestamps << Time.now.to_i
+        @cache.set(key, timestamps, 60) # Set to expire as defined in the configuration
+      end
+
+      def requests_in_last_minute(client_id)
+        key = "rate_limit:#{client_id}"
+        timestamps = @cache.get(key) || []
+        one_minute_ago = Time.now.to_i - 60
+        timestamps.select { |timestamp| timestamp > one_minute_ago }
+      end
+    end
+  end
+end

data/lib/rate_limiter/storage/memory.rb

@@ -0,0 +1,23 @@
+module RateLimiter
+  module Storage
+    class Memory < Base
+      def initialize
+        @store = Hash.new { |hash, key| hash[key] = [] }
+        @mutex = Mutex.new
+      end
+
+      def add_request(client_id)
+        @mutex.synchronize do
+          @store[client_id] << Time.now
+        end
+      end
+
+      def requests_in_last_minute(client_id)
+        @mutex.synchronize do
+          one_minute_ago = Time.now - 60
+          @store[client_id].select { |timestamp| timestamp > one_minute_ago }
+        end
+      end
+    end
+  end
+end

data/lib/rate_limiter/storage/redis.rb

@@ -0,0 +1,43 @@
+# lib/rate_limiter/storage/redis.rb
+module RateLimiter
+  module Storage
+    class Redis < Base
+      EXPIRATION_TIME = 60  # 60 seconds = 1 minute
+
+      def initialize(options = {})
+        default_options = {
+          host: 'localhost',
+          port: 6379
+        }
+
+        default_options[:namespace] = 'rate_limiter'
+
+        @options = default_options.merge(options)
+        @redis = ::Redis.new(@options)
+      end
+
+      def add_request(client_id)
+        key = cache_key(client_id)
+        @redis.multi do |redis|
+          redis.lpush(key, Time.now.to_i)
+          redis.expire(key, EXPIRATION_TIME)
+        end
+      end
+
+      def requests_in_last_minute(client_id)
+        key = cache_key(client_id)
+        one_minute_ago = Time.now.to_i - EXPIRATION_TIME
+        
+        @redis.lrange(key, 0, -1).map(&:to_i).select do |timestamp|
+          timestamp > one_minute_ago
+        end
+      end
+
+      private
+
+      def cache_key(client_id)
+        [@options[:namespace], 'rate_limit', client_id].compact.join(':')
+      end
+    end
+  end
+end

data/lib/rate_limiter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RateLimiter
+  VERSION = "0.1.3"
+end

data/lib/rate_limiter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'thread'
+require 'dalli'
+require_relative 'rate_limiter/version'
+require_relative 'rate_limiter/configuration'
+require_relative 'rate_limiter/storage/base'
+require_relative 'rate_limiter/storage/memory'
+require_relative 'rate_limiter/storage/memcache'
+require_relative 'rate_limiter/storage/redis'
+require_relative 'rate_limiter/storage/factory'
+require_relative 'rate_limiter/middleware'
+
+module RateLimiter
+  class Error < StandardError; end
+
+  def self.configure
+    @config ||= Configuration.new
+    yield(@config) if block_given?
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.storage
+    @storage ||= Storage::Factory.create(config)
+  end
+end

data/lib/tasks/test_middleware.rb

@@ -0,0 +1,14 @@
+# test_middleware.rb
+require 'byebug'
+require_relative 'lib/rate_limiter'
+
+RateLimiter.configure do |config|
+  config.requests_per_minute = 100
+end
+
+app = ->(env) { [200, { 'Content-Type' => 'text/plain' }, ['Hello, World!']] }
+middleware = RateLimiter::Middleware.new(app, RateLimiter.config, RateLimiter.storage)
+
+# Simulate a request
+env = { 'REMOTE_ADDR' => '127.0.0.1' }
+middleware.call(env)

data/sig/rate_limiter.rbs

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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: rack_rate_limiting
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Hassan Tahir
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 
+email:
+- hassantahirjaura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rate_limiter.rb
+- lib/rate_limiter/configuration.rb
+- lib/rate_limiter/middleware.rb
+- lib/rate_limiter/storage/base.rb
+- lib/rate_limiter/storage/factory.rb
+- lib/rate_limiter/storage/memcache.rb
+- lib/rate_limiter/storage/memory.rb
+- lib/rate_limiter/storage/redis.rb
+- lib/rate_limiter/version.rb
+- lib/tasks/test_middleware.rb
+- sig/rate_limiter.rbs
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key: 
+specification_version: 4
+summary: Use this gem to rate limit your API requests.
+test_files: []