co-limit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72909f9bdd98c89548d9513f2431095a7edf110f0b2b62a3f928cb5f2f65ddba
+  data.tar.gz: a9be065e44bedb462c7595cf35bbb2a7f1feb9097f97581e210130891089d21e
+SHA512:
+  metadata.gz: 20aee9b9a5a274424f880119f9dd7c59eb82624ceef1d3194e0c527b1a029370628563bb22885d5b688210504a02b244a744f60d2565825f7ad1970ac5e1f8ee
+  data.tar.gz: 3992bd40ac746931e6a797e0838cc36318029ca394cb425d84598636597761a461964857ce6ad35dc21ae79be8e434522758a7f2eb7ec1974a17c74447f51b1e

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 cosmicoppai@protonmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 CosmicOppai
+
+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,142 @@
+
+# Limit Gem
+
+Gem that provides flexible, Redis-backed rate limiting utilities. It supports both Fixed Window and Rolling Window (Sliding Log) strategies, to easily control the number of allowed requests for a given identifier within a time window.
+
+You can define rate-limiting rules dynamically using a Proc, and configure Redis via environment variables (REDIS_HOST, REDIS_PORT, REDIS_PASSWORD) or by passing connection details directly.
+
+This gem is ideal for APIs, background jobs, or any system that needs simple, efficient throttling logic.
+
+## Installation
+
+To install the gem and add it to your application's Gemfile, execute:
+
+```bash
+$ bundle add limit
+```
+
+If you are not using Bundler, you can install the gem directly by running:
+
+```bash
+$ gem install limit
+```
+
+## Usage
+
+### Example Usage
+
+Here's an example of how to use the rate limiter in your application:
+
+```ruby
+sync_limit_calculator = lambda do |key| 
+  pms_name = key.split(':').last.to_sym
+  SITE_LIMITS.fetch(pms_name, :default)
+end
+
+rate_limiter = Limit::RollingWindowRateLimiter.new(
+  identifier_prefix: 'access', 
+  limit_calculator: sync_limit_calculator,
+  host: '127.0.0.1', 
+  port: 6379, 
+  password: 'abcd1234'
+)
+
+key = '007:x'
+success_count = 0
+a = Time.now
+11.times do
+  allowed = rate_limiter.allowed?(key)
+  success_count += 1 if allowed
+end
+
+sleep 5 - (Time.now - a) + 0.5  # wait until the next window
+allowed = rate_limiter.allowed?(key)  # request will be allowed
+success_count += 1 if allowed
+
+puts "Success count: #{success_count}"  # Expected to be 11
+```
+
+### Redis Configuration
+
+You can configure the Redis connection either by passing the connection details as arguments or by setting environment variables.
+
+- **Option 1**: Pass the connection details directly when initializing the limiter:
+
+  ```ruby
+  rate_limiter = Limit::RollingWindowRateLimiter.new(
+    identifier_prefix: 'access', 
+    limit_calculator: sync_limit_calculator,
+    host: '127.0.0.1', 
+    port: 6379, 
+    password: 'abcd1234'
+  )
+  ```
+
+- **Option 2**: Set the connection details as environment variables (`REDIS_HOST`, `REDIS_PORT`, and `REDIS_PASSWORD`), and the gem will automatically use them:
+
+  ```bash
+  export REDIS_HOST='127.0.0.1'
+  export REDIS_PORT='6379'
+  export REDIS_PASSWORD='abcd1234'
+  ```
+
+  In this case, the gem will use these environment variables to establish the Redis connection.
+
+### Key Points:
+
+- **identifier_prefix**: A namespace prefix for Redis keys (e.g., `"access"`).
+- **limit_calculator**: A `Proc` that takes a key (e.g., `"user_id:site_name"`) and returns a hash with `max_requests` and `window_seconds`.
+
+### Supported Rate Limiters:
+
+- **Fixed Window Rate Limiter**:
+  Allows a specified number of requests within a fixed time window. This method can cause burst traffic as it doesn't account for requests made outside of the window until it resets.
+
+- **Rolling Window Rate Limiter**:
+  Uses a sliding window mechanism, where only requests made within the last `n` seconds are counted. It provides more consistent traffic flow but can be more resource-intensive.
+
+## Development
+
+After checking out the repo, install the dependencies by running:
+
+```bash
+$ bin/setup
+```
+
+To run tests, execute:
+
+```bash
+$ rake test
+```
+
+For an interactive prompt, run:
+
+```bash
+$ bin/console
+```
+
+To install the gem locally:
+
+```bash
+$ bundle exec rake install
+```
+
+To release a new version, update the version number in `version.rb`, and run:
+
+```bash
+$ bundle exec rake release
+```
+
+This will create a git tag for the new version, push the tag, and push the gem to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cosmicoppai/limit. This project aims to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [code of conduct](https://github.com/cosmicoppai/limit/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 Limit project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/cosmicoppai/limit/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/Steepfile

@@ -0,0 +1,6 @@
+target :lib do
+  signature "sig"
+  check "lib"
+
+  library 'redis'
+end

data/lib/limit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Limit
+  VERSION = '0.1.0'
+end

data/lib/limit.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'logger'
+
+
+module Limit
+
+  # Base Class, implementing:
+  # - Method to connect with redis
+  # - Signature for limit_calculator
+  class BaseLimiter
+    attr_reader :limit_calculator, :identifier_prefix
+
+    @redis = nil
+    @logger = Logger.new($stdout)
+
+    class << self
+
+      def connection
+        host = ENV['REDIS_HOST']
+        port = ENV['REDIS_PORT']
+        password = ENV['REDIS_PASSWORD']
+        @redis ||= create_connection(host: host, port: port, password: password)
+      end
+
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+
+      private
+
+      def create_connection(host:, port:, password:)
+        if password && !password.empty?
+          Redis.new(host: host, port: port, password: password)
+        else
+          logger.warn('Connecting without password')
+          Redis.new(host: host, port: port)
+        end
+      end
+
+    end
+
+    def initialize(identifier_prefix:, limit_calculator:, host: nil, port: nil, password: nil)
+
+    # @param identifier_prefix: [String] A namespace prefix for redis keys for this limiter instance
+    # @param limit_calculator: [Proc] A method that takes a key(String) and returns hash: {max_requests: Integer, window_seconds: Integer}
+
+      unless identifier_prefix.is_a?(String) && !identifier_prefix.empty?
+        raise ArgumentError, 'identifier_prefix must be a non-empty String'
+      end
+
+      raise ArgumentError, 'limit_calculator must be a Proc' unless limit_calculator.is_a?(Proc)
+
+      # Will be using the same connection across all instance unless wanted to connect to diff instance of redis
+
+      @redis = if host && port && password
+                 self.class.send(:create_connection, host: host, port: port, password: password)
+               else
+                 self.class.connection
+               end
+
+      @identifier_prefix = identifier_prefix
+      @limit_calculator = limit_calculator
+      @logger = self.class.logger
+
+      begin
+        @redis.ping
+        @logger.info("Successfully connected to Redis @ #{@redis.connection[:host]}:#{@redis.connection[:port]}")
+      rescue Redis::BaseError => e
+        @logger.error("Error connecting to Redis: #{e.message}")
+        raise e
+      end
+
+    end
+
+    def allowed?(key)
+      raise NotImplementedError "#{self.class.name} must implement the allowed? method"
+    end
+
+    def get_key(prefix)
+      raise NotImplementedError "#{self.class.name} must implement the get_key() method"
+    end
+
+
+    protected
+
+    def get_current_limit(key)
+      limit_data = @limit_calculator.call(key)
+
+      unless limit_data.is_a?(Hash) && limit_data[:max_requests].is_a?(Integer) && limit_data[:max_requests].positive? &&
+             limit_data[:window_seconds].is_a?(Integer) && limit_data[:window_seconds].positive?
+
+        raise ArgumentError, "Limit calculator for key '#{key}' returned invalid data: #{limit_data.inspect}. Expected { max_requests: Integer > 0, window_seconds: Integer > 0 }"
+      end
+
+      limit_data
+    end
+
+    def redis_pipeline(&block)
+      begin
+        @redis.pipelined { |pipe| block.call(pipe) }
+      rescue Redis::CommandError => e
+        @logger.error(e.message)
+      end
+    end
+
+    def current_micros
+      (Time.now.to_f * 1_000_000).to_i
+    end
+
+
+  end
+
+
+  # ====================================================================================================================
+
+  # Fixed Window Rate Limiter, allows n of request in a fixed window
+  # ALERT: There is a chance of bursts/spike in this method, so use it with caution
+  class FixedWindowRateLimiter < BaseLimiter
+    def allowed?(key)
+      limit_data = get_current_limit(key)
+      max_requests = limit_data[:max_requests]
+      window_seconds = limit_data[:window_seconds]
+
+      window_key = get_key(key, window_seconds)
+
+      results = redis_pipeline do |pipe|
+        # This is for simplicity as incr handles both creation and incrementing, rather than waiting on some read
+        # using the pipeline, the whole operation would also be atomic, as redis is single threaded and both queries are send in one trip
+        # https://redis.io/docs/latest/develop/use/pipelining/
+        pipe.incr(window_key)
+        pipe.expire(window_key, window_seconds)
+      end
+
+      results[0] <= max_requests
+    end
+
+    def get_key(prefix, window_seconds)
+      time_window = (Time.now.to_i / window_seconds) * window_seconds
+      "#{@identifier_prefix}:#{prefix}:#{time_window.to_s}"
+    end
+  end
+
+  # RollingWindow Rate limiter implemented using Sliding Log, allows n no of requests in rolling window
+  class RollingWindowRateLimiter < BaseLimiter
+    def allowed?(key)
+      limit_data = get_current_limit(key)
+      max_requests = limit_data[:max_requests]
+      window_seconds = limit_data[:window_seconds]
+
+      set_key = get_key(key)
+
+      curr_micros = current_micros
+
+      window_start_micros = curr_micros - (window_seconds*1_000_000)
+
+      results = redis_pipeline do |pipe|
+        # uses sorted set
+        # https://redis.io/glossary/redis-sorted-sets/
+        pipe.zremrangebyscore(set_key, 0, window_start_micros)
+        pipe.zadd(set_key, curr_micros, curr_micros.to_s)
+        pipe.zcard(set_key)
+        pipe.expire(set_key, window_seconds)
+      end
+
+      results[2] <= max_requests
+    end
+
+    def get_key(prefix)
+      "#{@identifier_prefix}:#{prefix}"
+    end
+  end
+
+
+end

data/sig/limit/limit.rbs

@@ -0,0 +1,37 @@
+type redis = untyped
+
+module Limit
+VERSION: String
+
+class BaseLimiter
+self.@redis: redis
+@logger: Logger
+
+@redis: redis | nil
+
+def self.connection: -> nil
+
+def self.create_connection: (String, Integer, String) -> redis
+
+def self.log: (String, String) -> nil
+
+def self.logger: -> Logger
+
+attr_reader identifier_prefix: String
+attr_reader limit_calculator: Proc
+
+def initialize: -> untyped
+
+def allowed?: (String) -> bool
+
+def get_current_limit: (String) -> Hash[String, Integer]
+
+def get_key: (String) -> String
+
+def current_micros: (nil) -> Integer
+
+def log: (String, String) -> nil
+
+def redis_pipeline: () { (redis) -> untyped } -> untyped
+end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: co-limit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CosmicOppai
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+description:
+email:
+- cosmicoppai@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/limit.rb
+- lib/limit/version.rb
+- sig/limit/limit.rbs
+homepage: https://github.com/cosmicoppai/limit
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/cosmicoppai/limit
+  changelog_uri: https://github.com/Cosmicoppai/limit/blob/main/CHANGELOG.md
+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.4.19
+signing_key:
+specification_version: 4
+summary: Minimal Rate-Limiter
+test_files: []