spamtrap 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 619741f1ea048808a9235e1bc02a814c2d6606aed599e188c3ea99d464e2fc85
-  data.tar.gz: e309645da54a5ac5c898b83f8e90b5132361001724469ceabe18bf7f3195fbac
+  metadata.gz: f0cec3797da20a8ab16dd95113f15c271acb6764478291372e14fc8d3556e0a3
+  data.tar.gz: 960f481d33667095c861f91665786ab6e5a60c5a162e9f90fea709b99821b91e
 SHA512:
-  metadata.gz: 9e8328c22c89ee565ef34c2cff0e2ecad4aae2b9e71a9627bb6162e57e1013577fa53f65a56a217928e8d0503017b4c2508cec435ecf0c911eb257da53087f59
-  data.tar.gz: 49fa2e0f20b2489eb082c9bd4cd3fe1a09f4d4ddd03022676e12a91fc7779a0bab36e1a628205a0a1f29904da8292a984ef11a317bda486eed0c74f1a5d42909
+  metadata.gz: 846a83081e7139d5c6ba56674d3f5506abebc583c9f2fc62501fa8dc30d230f391f3a61a63a8a231456368a09c8ba20635d8af1176356d7574c97d1c4c0a9f9c
+  data.tar.gz: fab5e0b02f702ee3f71bb2914d766a6a3ba1fedc90232189844497e5c818927b7cd31ff17eeb0fbf3583494b4e3e54c14e00511055df6a604608a5d850e3c0ad

data/lib/spamtrap/controller.rb

@@ -9,9 +9,10 @@ module Spamtrap::Controller
     def spamtrap(honeypot = 'spamtrap', options = {}, &block)
       # Capture explicit per-call values; use sentinel so globals are read
       # at request time rather than at class definition time.
-      nonce_opt   = options.key?(:nonce)         ? options.delete(:nonce)         : :global
-      timeout_opt = options.key?(:nonce_timeout) ? options.delete(:nonce_timeout) : :global
-      mutate_opt  = options.key?(:mutate)        ? options.delete(:mutate)        : :global
+      nonce_opt    = options.key?(:nonce)         ? options.delete(:nonce)         : :global
+      timeout_opt  = options.key?(:nonce_timeout) ? options.delete(:nonce_timeout) : :global
+      mutate_opt   = options.key?(:mutate)        ? options.delete(:mutate)        : :global
+      on_trap_opt  = options.key?(:on_trap)       ? options.delete(:on_trap)       : :global
 
       before_action(options) do |controller|
         controller.instance_eval(&block) if block_given?
@@ -24,9 +25,11 @@ module Spamtrap::Controller
 
           if params[honeypot].present?
             Rails.logger.warn "Spamtrap triggered by #{request.remote_ip}."
+            spamtrap_invoke_on_trap(:honeypot, on_trap_opt)
             head 200
           elsif nonce_enabled && !spamtrap_valid_nonce?(nonce_timeout)
             Rails.logger.warn "Spamtrap nonce invalid from #{request.remote_ip}."
+            spamtrap_invoke_on_trap(:nonce, on_trap_opt)
             head 200
           end
         end
@@ -69,7 +72,15 @@ module Spamtrap::Controller
     end
   end
 
-  private :spamtrap_valid_nonce?, :spamtrap_remap_params, :spamtrap_remap_hash
+  def spamtrap_invoke_on_trap(reason, on_trap_opt)
+    callback = on_trap_opt == :global ? Spamtrap.on_trap : on_trap_opt
+    return unless callback.respond_to?(:call)
+    callback.call(reason: reason, request: request)
+  rescue StandardError => e
+    Rails.logger.error "Spamtrap on_trap callback raised: #{e.class}: #{e.message}"
+  end
+
+  private :spamtrap_valid_nonce?, :spamtrap_remap_params, :spamtrap_remap_hash, :spamtrap_invoke_on_trap
 
 end
 

data/lib/spamtrap/version.rb

@@ -1,5 +1,5 @@
 module Spamtrap
 
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 
 end

data/lib/spamtrap.rb

@@ -2,7 +2,8 @@ require 'openssl'
 
 module Spamtrap
   class << self
-    attr_writer :nonce, :nonce_timeout, :mutate
+    attr_accessor :on_trap
+    attr_writer   :nonce, :nonce_timeout, :mutate
 
     def nonce
       @nonce || false

data/test/controller_test.rb

@@ -345,3 +345,129 @@ class GlobalOverrideControllerTest < ActionController::TestCase
     assert_equal 'body', response.body
   end
 end
+
+# Controllers for on_trap callback tests.
+class OnTrapGlobalCallbackController < ActionController::Base
+  spamtrap :trap_field, only: :create
+
+  def create
+    render plain: 'success'
+  end
+end
+
+class OnTrapGlobalNonceCallbackController < ActionController::Base
+  spamtrap :trap_field, nonce: true, only: :create
+
+  def create
+    render plain: 'success'
+  end
+end
+
+class OnTrapPerDeclarationController < ActionController::Base
+  spamtrap :trap_field, only: :create,
+    on_trap: ->(reason:, request:) { Thread.current[:per_decl_calls] << { reason: reason, ip: request.remote_ip } }
+
+  def create
+    render plain: 'success'
+  end
+end
+
+class OnTrapCallbackTest < ActionController::TestCase
+  tests OnTrapGlobalCallbackController
+
+  setup do
+    @calls = []
+    Spamtrap.on_trap = ->(reason:, request:) { @calls << { reason: reason, ip: request.remote_ip } }
+  end
+
+  teardown do
+    Spamtrap.on_trap = nil
+  end
+
+  def test_global_callback_invoked_on_honeypot_trap
+    post :create, params: { trap_field: 'spam' }
+    assert_response :ok
+    assert_empty response.body
+    assert_equal 1, @calls.size
+    assert_equal :honeypot, @calls.first[:reason]
+  end
+
+  def test_global_callback_not_invoked_on_legitimate_request
+    post :create, params: { trap_field: '' }
+    assert_response :ok
+    assert_equal 'success', response.body
+    assert_empty @calls
+  end
+
+  def test_no_callback_when_on_trap_is_nil
+    Spamtrap.on_trap = nil
+    post :create, params: { trap_field: 'spam' }
+    assert_response :ok
+    assert_empty response.body
+    # no error raised — test simply passes
+  end
+end
+
+class OnTrapNonceCallbackTest < ActionController::TestCase
+  include NonceTestHelper
+  tests OnTrapGlobalNonceCallbackController
+
+  setup do
+    @calls = []
+    Spamtrap.on_trap = ->(reason:, request:) { @calls << { reason: reason, ip: request.remote_ip } }
+  end
+
+  teardown do
+    Spamtrap.on_trap = nil
+  end
+
+  def test_global_callback_invoked_on_nonce_trap
+    post :create, params: { trap_field: '' }
+    assert_response :ok
+    assert_empty response.body
+    assert_equal 1, @calls.size
+    assert_equal :nonce, @calls.first[:reason]
+  end
+end
+
+class OnTrapPerDeclarationCallbackTest < ActionController::TestCase
+  tests OnTrapPerDeclarationController
+
+  setup do
+    Thread.current[:per_decl_calls] = []
+    @global_calls = []
+    Spamtrap.on_trap = ->(reason:, request:) { @global_calls << reason }
+  end
+
+  teardown do
+    Spamtrap.on_trap = nil
+    Thread.current[:per_decl_calls] = nil
+  end
+
+  def test_per_declaration_callback_takes_precedence_over_global
+    post :create, params: { trap_field: 'spam' }
+    assert_response :ok
+    assert_empty response.body
+    assert_equal 1, Thread.current[:per_decl_calls].size
+    assert_equal :honeypot, Thread.current[:per_decl_calls].first[:reason]
+    assert_empty @global_calls
+  end
+end
+
+class OnTrapCallbackErrorResilienceTest < ActionController::TestCase
+  tests OnTrapGlobalCallbackController
+
+  setup do
+    Spamtrap.on_trap = ->(**) { raise 'callback exploded' }
+  end
+
+  teardown do
+    Spamtrap.on_trap = nil
+  end
+
+  def test_broken_callback_does_not_prevent_head_200
+    post :create, params: { trap_field: 'spam' }
+    assert_response :ok
+    assert_empty response.body
+  end
+end

data/test/test_helper.rb

@@ -21,6 +21,9 @@ Rails.application.routes.draw do
   post 'nested_mutation/create',  to: 'nested_mutation#create'
   post 'global_defaults/create',  to: 'global_defaults#create'
   post 'global_override/create',  to: 'global_override#create'
+  post 'on_trap_global_callback/create',       to: 'on_trap_global_callback#create'
+  post 'on_trap_global_nonce_callback/create', to: 'on_trap_global_nonce_callback#create'
+  post 'on_trap_per_declaration/create',       to: 'on_trap_per_declaration#create'
 end
 
 class ActionController::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spamtrap
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Cedric Howe