co-limit 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72909f9bdd98c89548d9513f2431095a7edf110f0b2b62a3f928cb5f2f65ddba
-  data.tar.gz: a9be065e44bedb462c7595cf35bbb2a7f1feb9097f97581e210130891089d21e
+  metadata.gz: 5f54e6c9ae0b841090b1fe2eae972242c4a416eb504de4940cc807a500f7d27a
+  data.tar.gz: ebc7e45c7c29b425a4391230173f8db3a44c288482a917f2ef8e57be75552a31
 SHA512:
-  metadata.gz: 20aee9b9a5a274424f880119f9dd7c59eb82624ceef1d3194e0c527b1a029370628563bb22885d5b688210504a02b244a744f60d2565825f7ad1970ac5e1f8ee
-  data.tar.gz: 3992bd40ac746931e6a797e0838cc36318029ca394cb425d84598636597761a461964857ce6ad35dc21ae79be8e434522758a7f2eb7ec1974a17c74447f51b1e
+  metadata.gz: 8535547535b239b227de6f78dfa0c37380e33c77f74db7c85ad91792068847b44f9074b02b3e034f9d94c8c89d517ac884ab18f111aaaca8bdeee02fc774b2ba
+  data.tar.gz: b37ee6f384eed0728a8b4a29b3271475bbe42607c0d879471081947ec4d2c34ef7d14be28f95b305094cf2cb8c548c6aa3a5a1b77fdc5fbf0eac52711fe0ac53

data/README.md

@@ -3,7 +3,7 @@
 
 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.
+You can define rate-limiting rules dynamically using a lambda, 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.
 
@@ -12,13 +12,13 @@ This gem is ideal for APIs, background jobs, or any system that needs simple, ef
 To install the gem and add it to your application's Gemfile, execute:
 
 ```bash
-$ bundle add limit
+$ bundle add co-limit
 ```
 
 If you are not using Bundler, you can install the gem directly by running:
 
 ```bash
-$ gem install limit
+$ gem install co-limit
 ```
 
 ## Usage
@@ -85,7 +85,7 @@ You can configure the Redis connection either by passing the connection details
 ### 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`.
+- **limit_calculator**: A `Lambda` that takes a key (e.g., `"user_id:site_name"`) and returns a hash with `max_requests` and `window_seconds`.
 
 ### Supported Rate Limiters:
 

data/lib/limit/version.rb

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

data/lib/limit.rb

@@ -43,14 +43,14 @@ module Limit
 
     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}
+      # @param identifier_prefix: [String] A namespace prefix for redis keys for this limiter instance
+      # @param limit_calculator: [Lambda] 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)
+      raise ArgumentError, 'limit_calculator must be a Lambda' unless limit_calculator.lambda?
 
       # Will be using the same connection across all instance unless wanted to connect to diff instance of redis
 
@@ -78,7 +78,7 @@ module Limit
       raise NotImplementedError "#{self.class.name} must implement the allowed? method"
     end
 
-    def get_key(prefix)
+    def get_key(key)
       raise NotImplementedError "#{self.class.name} must implement the get_key() method"
     end
 
@@ -136,9 +136,9 @@ module Limit
       results[0] <= max_requests
     end
 
-    def get_key(prefix, window_seconds)
+    def get_key(key, window_seconds)
       time_window = (Time.now.to_i / window_seconds) * window_seconds
-      "#{@identifier_prefix}:#{prefix}:#{time_window.to_s}"
+      "#{@identifier_prefix}:#{key}:#{time_window.to_s}"
     end
   end
 
@@ -167,8 +167,8 @@ module Limit
       results[2] <= max_requests
     end
 
-    def get_key(prefix)
-      "#{@identifier_prefix}:#{prefix}"
+    def get_key(key)
+      "#{@identifier_prefix}:#{key}"
     end
   end
 

data/sig/limit/limit.rbs

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: co-limit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - CosmicOppai
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-29 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis