action_ip_filter 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd87d049abbc429bef20f3c4d684efd1f94a97cf9758603e6a404ecc97c487c0
-  data.tar.gz: 1460f97edeb6ddd39c71190ec07d866c3bc473818ab2ae852624a034027b1d7d
+  metadata.gz: ca72b3ded0f28fecbd905a3d92b1314627bd03347b04a8a5e6e51b37f7bfe74e
+  data.tar.gz: a6fbe7fb5cf0007863049a618a6ac0668ff302a577ed3a4932ea2ef313200c54
 SHA512:
-  metadata.gz: 7e279fadffc67defc41e2447f985780fc0332022a1bce62de27b065f9e715bbf18d173f8c87aa72780d2b8b91b743d45130608235f0b6d7c42cdfa24b699518e
-  data.tar.gz: e2918f5170516b232838a516e0ddf7c80f81cd5ef7c9359a1c07820e9ec96d1a8d91f9579824df7b535b24064596cd0da2e1d046db63146a4d3c524eeea9c0cb
+  metadata.gz: dd7422ec80a6fe13148db4daf70a16657416d6c4b1f13b4699851c8996d42434d60d15c7ba341b4f652ff0775d546c3deb3918b2f8c2ea8b61b97a2040486009
+  data.tar.gz: 0773de5c419cdde2693ca64575347df64b4b79647fa34d52d5293c90f0e285f8adc544e20e998d8227356f62c6da68e5a2e1e1a8859485ee5d2af19d5745ee9e

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-12-02
+
+### New Features
+
+- Make `log_denial_message` configurable [#9](https://github.com/smartbank-inc/action_ip_filter/pull/9)
+
+## [0.4.1] - 2025-12-01
+
+### Bug Fix
+
+- Fix to allow an `Array[String]` to be used as the list of allowed IP addresses [#7](https://github.com/smartbank-inc/action_ip_filter/pull/7)
+
 ## [0.4.0] - 2025-12-01
 
 ### Breaking Changes

data/README.md

@@ -6,12 +6,12 @@ A lightweight gem that provides IP address restrictions for Rails controllers at
 
 Unlike Rack middleware solutions (e.g., `rack-attack`), action_ip_filter operates at the controller level:
 
-| Feature | rack-attack | action_ip_filter |
-|---------|-------------|----------------|
-| Layer | Rack middleware (all requests) | Controller before_action |
-| Granularity | Path/IP based | Controller/Action based |
-| Overhead | Every request evaluated | Only specified actions |
-| Use case | DDoS protection, rate limiting | Admin panels, webhooks |
+| Feature     | rack-attack                    | action_ip_filter         |
+|-------------|--------------------------------|--------------------------|
+| Layer       | Rack middleware (all requests) | Controller before_action |
+| Granularity | Path/IP based                  | Controller/Action based  |
+| Overhead    | Every request evaluated        | Only specified actions   |
+| Use case    | DDoS protection, rate limiting | Admin panels, webhooks   |
 
 **Use this gem when you need:**
 - IP restrictions on specific controller actions only
@@ -177,17 +177,36 @@ ActionIpFilter.configure do |config|
 
   # Enable/disable denial logging (default: true)
   config.log_denials = true
+
+  # Logging on denied
+  # It passes `config.logger` as the first argument (logger) and the actual client IP address as the second argument (client_ip).
+  config.log_denial_message = ->(logger, client_ip) {
+    logger.error("Blocked IP: #{client_ip}")
+  }
 end
 ```
 
 ### Default Values
 
-| Option | Default                             | Description                                        |
-|--------|-------------------------------------|----------------------------------------------------|
-| `ip_resolver` | `-> { request.remote_ip }` | Proc that extracts client IP from request |
-| `on_denied` | `-> { head :forbidden }`            | Handler called when access is denied (returns 403) |
-| `logger` | `Rails.logger`                      | Logger instance for denied request logging |
-| `log_denials` | `true`                              | Whether to log denied requests as warn level |
+| Option               | Default                    | Description                                        |
+|----------------------|----------------------------|----------------------------------------------------|
+| `ip_resolver`        | `-> { request.remote_ip }` | Proc that extracts client IP from request          |
+| `on_denied`          | `-> { head :forbidden }`   | Handler called when access is denied (returns 403) |
+| `logger`             | `Rails.logger`             | Logger instance for denied request logging         |
+| `log_denials`        | `true`                     | Whether to log denied requests as warn level       |
+| `log_denial_message` | See below                  | Proc that formats the denial log message           |
+
+The default `log_denial_message` is:
+
+```ruby
+->(logger, client_ip) {
+  logger.warn("[ActionIpFilter] Access denied for IP: #{client_ip} on #{self.class.name}##{action_name}")
+}
+```
+
+### Note on the configurable Proc block
+
+The block is executed via `instance_exec` in the controller context, so you may call controller methods such as `request`, `head`, `render`, and others.
 
 ## Testing
 

data/lib/action_ip_filter/configuration.rb

@@ -6,18 +6,33 @@ module ActionIpFilter
     # @rbs @on_denied: ^() -> void
     # @rbs @logger: Logger?
     # @rbs @log_denials: bool
+    # @rbs @log_denial_message: ^(Logger, String?) -> void
+
+    # @rbs!
+    #   interface _Request
+    #     def remote_ip: () -> String
+    #   end
+    #
+    #   def action_name: () -> String
+    #   def controller_name: () -> String
+    #   def head: (Symbol) -> void
+    #   def request: () -> _Request
 
     attr_accessor :ip_resolver #: ^() -> String?
     attr_accessor :on_denied #: ^() -> void
     attr_accessor :logger #: Logger?
     attr_accessor :log_denials #: bool
+    attr_accessor :log_denial_message #: ^(Logger, String?) -> void
 
     # @rbs return: void
     def initialize
-      @ip_resolver = -> { request.remote_ip } # steep:ignore NoMethod
-      @on_denied = -> { head :forbidden } # steep:ignore NoMethod
+      @ip_resolver = -> { request.remote_ip }
+      @on_denied = -> { head :forbidden }
       @logger = nil
       @log_denials = true
+      @log_denial_message = ->(logger, client_ip) {
+        logger.warn("[ActionIpFilter] Access denied for IP: #{client_ip} on #{self.class.name}##{action_name}")
+      }
     end
   end
 

data/lib/action_ip_filter/ip_filterable.rb

@@ -7,12 +7,12 @@ module ActionIpFilter
     extend ActiveSupport::Concern
 
     # @rbs!
-    #   def action_name: () -> String
-    #   def instance_exec: [T] (*untyped) { () -> T } -> T
+    #   def instance_exec: [T] () { () -> T } -> T
+    #                    | (Logger, String?) { (Logger, String?) -> void } -> void
     #   def before_action: (*untyped, **untyped) -> void
 
     class_methods do
-      # @rbs allowed_ips: String | ^() -> Array[String]
+      # @rbs allowed_ips: String | Array[String] | ^() -> Array[String]
       # @rbs on_denied: (^() -> void)?
       # @rbs only: Array[Symbol]?
       # @rbs except: Array[Symbol]?
@@ -24,7 +24,7 @@ module ActionIpFilter
 
     private
 
-    # @rbs allowed_ips: Array[String | ^() -> Array[String]]
+    # @rbs allowed_ips: Array[String | Array[String] | ^() -> Array[String]]
     # @rbs on_denied: (^() -> void)?
     # @rbs return: void
     def verify_ip_access(allowed_ips:, on_denied:)
@@ -38,7 +38,7 @@ module ActionIpFilter
           instance_exec(&allowed_ip)
         else
           [allowed_ip]
-        end
+        end.flatten
 
         IpMatcher.allowed?(client_ip, ips)
       end
@@ -57,9 +57,10 @@ module ActionIpFilter
       logger = ActionIpFilter.configuration.logger
       return if logger.nil?
 
-      logger.warn do
-        "[ActionIpFilter] Access denied for IP: #{client_ip} on #{self.class.name}##{action_name}"
-      end
+      log_denial_message = ActionIpFilter.configuration.log_denial_message
+      return if log_denial_message.nil?
+
+      instance_exec(logger, client_ip, &log_denial_message)
     end
   end
 end

data/lib/action_ip_filter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionIpFilter
-  VERSION = "0.4.0" #: String
+  VERSION = "0.5.0" #: String
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_ip_filter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - SmartBank, Inc.