rails_rate_limit 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf52b273c158732c58a654255744cbc096ddab47348f16684211435074dfd9b9
-  data.tar.gz: 239cf6c9e06d1300d057c28a2bdcd065de265799d58c369e061e9787e504879b
+  metadata.gz: f84a9dd27c84c9d0519657dcdc6a03da54339a00951fba0e4dfe847e210bc416
+  data.tar.gz: 68ed631f37784ac86f12e261cd28e99caf879f4b604604f5c0717b9e9a071062
 SHA512:
-  metadata.gz: 17198b2b17fe32b8dea0d56d99a02157cc4e0f50e103006b6faea197d38b2206c9810243cdf06a1c0e3c95807bd63d00feea07a426f358f026d60c7c57a5e37b
-  data.tar.gz: b1b66ee43016fd1db38083833228c779507dd586573cd9d47a3d69bd0a5cac45e6c478308a9e399d370fe5618b9182c657c55e8b09ff0e4ca465a6dbe25a2e6e
+  metadata.gz: 0d5822c1423345099c7d42a21ca11951720de2f9be00e7858fdf9ffee69b3e970454ed878e57e36c75ee74e49c213a0de1a079f2a476c52c95cdaabefdc34138
+  data.tar.gz: 736ce16dddb1b5e238e88570cd67cbce3895f2bb51a61a10a5d635112d4fe3d3489a33bf01735ddc67ebf350a669f668c3ce1952324a8ba5145649c0806cc379

data/README.md

@@ -1,4 +1,4 @@
-# Rails Rate Limit
+# **Rails Rate Limit**
 
 [![Gem Version](https://badge.fury.io/rb/rails_rate_limit.svg)](https://badge.fury.io/rb/rails_rate_limit)
 [![Build Status](https://github.com/kasvit/rails_rate_limit/workflows/Ruby/badge.svg)](https://github.com/kasvit/rails_rate_limit/actions)
@@ -99,23 +99,33 @@ end
 
 ### Rate Limiting Methods
 
-You can limit any instance method in your classes (class methods are not supported yet):
+You can limit both instance and class methods in your classes:
 
 ```ruby
 class ApiClient
-  include RailsRateLimit::Klass # include this module
+  include RailsRateLimit::Klass
 
+  # Instance method
   def make_request
     # Your API call logic here
   end
 
-  # IMPORTANT: set_rate_limit must be called AFTER method definition
-  # Basic usage
+  # Class method
+  def self.bulk_request
+    # Your API call logic here
+  end
+
+  # Rate limit for instance method
   set_rate_limit :make_request,
                 limit: 100,
                 period: 1.minute
 
-  # Advanced usage with all options
+  # Rate limit for class method
+  set_rate_limit :bulk_request,
+                limit: 10,
+                period: 1.hour
+
+  # Advanced usage with all options (instance method)
   set_rate_limit :another_method,
                 limit: 10,                       # Maximum calls allowed
                 period: 1.hour,                  # Time window for the limit
@@ -128,21 +138,26 @@ class ApiClient
                   nil # Method will return nil
                 }
 
-  # Example with default handler that raises error
-  set_rate_limit :risky_method,
-                limit: 5,
-                period: 1.minute
-                # Without on_exceeded option it will use default handler
-                # that raises RailsRateLimit::RateLimitExceeded
-
-  # Example with custom error handling
-  def safe_request
-    risky_method
-  rescue RailsRateLimit::RateLimitExceeded => e
-    # Handle the error
-    Rails.logger.warn("Rate limit exceeded: #{e.message}")
-    nil # or any other fallback value
-  end
+  # Advanced usage with all options (class method)
+  set_rate_limit :another_class_method,
+                limit: 5,                        # Maximum calls allowed
+                period: 1.day,                   # Time window for the limit
+                by: -> { "global:#{name}" },     # Method call identifier
+                store: :redis,                   # Override default store
+                on_exceeded: -> {                # Custom error handler
+                  log_exceeded_event
+                  "Rate limit exceeded"          # Return custom message
+                }
+
+  # Direct rate limit setting
+  # You can also set rate limits directly if you have both instance and class methods with the same name
+  set_instance_rate_limit :process,             # For instance method
+                         limit: 10,
+                         period: 1.hour
+
+  set_class_rate_limit :process,                # For class method
+                      limit: 5,
+                      period: 1.hour
 end
 ```
 
@@ -153,7 +168,8 @@ For both controllers and methods:
 - `period`: (Required) Time period for the limit (in seconds or ActiveSupport::Duration)
 - `by`: (Optional) Lambda/Proc to generate unique identifier
   - Default for controllers: `"#{controller.class.name}:#{controller.request.remote_ip}"`
-  - Default for methods: `"#{self.class.name}##{method_name}:#{respond_to?(:id) ? 'id='+id.to_s : 'object_id='+object_id.to_s}"`
+  - Default for instance methods: `"#{self.class.name}##{method_name}:#{respond_to?(:id) ? 'id='+id.to_s : 'object_id='+object_id.to_s}"`
+  - Default for class methods: `"#{class.name}.#{method_name}"`
 - `store`: (Optional) Override default storage backend (`:redis`, `:memcached`, `:memory`)
 - `on_exceeded`: (Optional) Custom handler for rate limit exceeded
 

data/lib/rails_rate_limit/klass.rb

@@ -8,6 +8,18 @@ module RailsRateLimit
       def set_rate_limit(method_name, limit:, period:, by: nil, store: nil, on_exceeded: nil)
         Validations.validate_options!(limit: limit, period: period, by: by, store: store)
 
+        if method_defined?(method_name) || private_method_defined?(method_name)
+          set_instance_rate_limit(method_name, limit: limit, period: period, by: by, store: store,
+                                               on_exceeded: on_exceeded)
+        elsif singleton_class.method_defined?(method_name) || singleton_class.private_method_defined?(method_name)
+          set_class_rate_limit(method_name, limit: limit, period: period, by: by, store: store,
+                                            on_exceeded: on_exceeded)
+        else
+          raise ArgumentError, "Method #{method_name} is not defined"
+        end
+      end
+
+      def set_instance_rate_limit(method_name, limit:, period:, by:, store:, on_exceeded:)
         original_method = instance_method(method_name)
 
         define_method(method_name) do |*args, &block|
@@ -30,6 +42,30 @@ module RailsRateLimit
           end
         end
       end
+
+      def set_class_rate_limit(method_name, limit:, period:, by:, store:, on_exceeded:)
+        original_method = singleton_class.instance_method(method_name)
+
+        singleton_class.define_method(method_name) do |*args, &block|
+          limiter = RateLimiter.new(
+            context: self,
+            by: by || lambda {
+              "#{name}.#{method_name}"
+            },
+            limit: limit,
+            period: period.to_i,
+            store: store
+          )
+
+          begin
+            limiter.perform!
+            original_method.bind(self).call(*args, &block)
+          rescue RailsRateLimit::RateLimitExceeded
+            handler = on_exceeded.nil? ? RailsRateLimit.configuration.handle_klass_exceeded : on_exceeded
+            instance_exec(&handler)
+          end
+        end
+      end
     end
   end
 end

data/lib/rails_rate_limit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsRateLimit
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_rate_limit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kasvit