invisible_captcha 0.12.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5011fee9db065c86faf1507c11e0d3000ad61e19d05e7102e8bcf3750abcd52f
-  data.tar.gz: bd104ffe4aeb3436c1d365a293c66f80d9d2e42c543b009ea596ac83d9a84db2
+  metadata.gz: 86acfe71e903568702c63c261bfd32a066dbc947d1c2fa2b4956178a7de591db
+  data.tar.gz: a9a8768c5bcfb9a7656e0638dde4bf40e169719385bf947dace7fa4d34f03656
 SHA512:
-  metadata.gz: e1c5608b8671bfef9edfec01531f575fe3a83c12a00dd72090a772686f2fef56ab6436e323dc7ca7daa1b82d30764ca03a2f89d6727145f593d377d1c057fe51
-  data.tar.gz: 811827be3f2a2bd4a18a1004377605c8db09c1279658371d2191e27226afd6557235c8747a5c39ec82a65bc443bb4590dcced9fff96d8be4fba946d21a07a50d
+  metadata.gz: ec1ed1b9f7bef2e753f7b736dbce8124b5cd4c699e4075cbd15fdade99e6f332025e3088f0754315b18f8bde48b7e883c3470f840a535a3631f2e5c659c415df
+  data.tar.gz: 3698ed54f31c8f87730dcd92e14c2076e10aaa98a14a765e7d3be8bfd0e259385572b5d3252b8328fb4a539634bb8e086270b2e7e34117ab76a15ab4f42c095b

data/.gitignore

@@ -8,3 +8,4 @@ Gemfile.lock
 spec/dummy/log/*.log
 spec/dummy/tmp/
 .byebug_history
+.DS_Store

data/.travis.yml

@@ -1,40 +1,18 @@
 language: ruby
 cache: bundler
-sudo: false
 rvm:
   - ruby-head
-  - 2.6.2
-  - 2.5.5
-  - 2.4.5
-  - 2.3.8
-  - 2.2.10
+  - 3.0.0
+  - 2.7.2
+  - 2.6.5
+  - 2.5.8
 gemfile:
+  - gemfiles/rails_6.1.gemfile
   - gemfiles/rails_6.0.gemfile
   - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_4.2.gemfile
-  - gemfiles/rails_3.2.gemfile
-before_install:
-  # Rails 4.x requires Bundler version < 2.0.
-  - "find /home/travis/.rvm/rubies -wholename '*default/bundler-*.gemspec' -delete"
-  - rvm @global do gem uninstall bundler -a -x
-  - rvm @global do yes | gem install bundler -v '< 2'
 matrix:
   exclude:
-    - rvm: 2.4.5
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: 2.3.8
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: 2.2.10
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: ruby-head
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.6.2
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.5.5
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.4.5
-      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 3.0.0
+      gemfile: gemfiles/rails_5.2.gemfile
   allow_failures:
-    - rvm: ruby-head
+    - rvm: ruby-head

data/Appraisals

@@ -1,3 +1,7 @@
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1.0"
+end
+
 appraise "rails-6.0" do
   gem "rails", "~> 6.0.0"
 end
@@ -5,19 +9,3 @@ end
 appraise "rails-5.2" do
   gem "rails", "~> 5.2.0"
 end
-
-appraise "rails-5.1" do
-  gem "rails", "~> 5.1.0"
-end
-
-appraise "rails-5.0" do
-  gem "rails", "~> 5.0.0"
-end
-
-appraise "rails-4.2" do
-  gem "rails", "~> 4.2.0"
-end
-
-appraise "rails-3.2" do
-  gem "rails", "~> 3.2.0"
-end

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.0]
+
+- New spinner, IP based, validation check (#89)
+- Drop official support for unmaintained Rails versions: 5.1, 5.0 and 4.2 (#86)
+- Drop official support for EOL Rubies: 2.4 and 2.3 (#86)
+
+## [1.1.0]
+
+- New option `prepend: true` for the controller macro (#77)
+
+## [1.0.1]
+
+- Fix naming issue with Ruby 2.7 (#65)
+
+## [1.0.0]
+
+- Remove Ruby 2.2 and Rails 3.2 support
+- Add Instrumentation event (#62)
+
+## [0.13.0]
+
+- Add support for the Content Security Policy nonce (#61)
+- Freeze all strings (#60)
+
 ## [0.12.2]
 
 - Allow new timestamp to be set during `on_timestamp_spam` callback (#53)
@@ -101,6 +125,11 @@ All notable changes to this project will be documented in this file.
 
 - First version of controller filters
 
+[2.0.0]: https://github.com/markets/invisible_captcha/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/markets/invisible_captcha/compare/v1.0.1...v1.1.0
+[1.0.1]: https://github.com/markets/invisible_captcha/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/markets/invisible_captcha/compare/v0.13.0...v1.0.0
+[0.13.0]: https://github.com/markets/invisible_captcha/compare/v0.12.2...v0.13.0
 [0.12.2]: https://github.com/markets/invisible_captcha/compare/v0.12.1...v0.12.2
 [0.12.1]: https://github.com/markets/invisible_captcha/compare/v0.12.0...v0.12.1
 [0.12.0]: https://github.com/markets/invisible_captcha/compare/v0.11.0...v0.12.0

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012-2017 Marc Anguera Insa
+Copyright 2012-2021 Marc Anguera Insa
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,25 +1,27 @@
 # Invisible Captcha
 
 [![Gem](https://img.shields.io/gem/v/invisible_captcha.svg?style=flat-square)](https://rubygems.org/gems/invisible_captcha)
-[![Build Status](https://travis-ci.org/markets/invisible_captcha.svg)](https://travis-ci.org/markets/invisible_captcha)
+[![Build Status](https://travis-ci.com/markets/invisible_captcha.svg?branch=master)](https://travis-ci.com/markets/invisible_captcha)
 
-> Simple and flexible spam protection solution for Rails applications.
+> Complete and flexible spam protection solution for Rails applications.
 
 Invisible Captcha provides different techniques to protect your application against spambots.
 
-The main protection is a solution based on the `honeypot` principle, which provides a better user experience, since there is no extra steps for real users, but for the bots.
+The main protection is a solution based on the `honeypot` principle, which provides a better user experience since there are no extra steps for real users, only for the bots.
 
 Essentially, the strategy consists on adding an input field :honey_pot: into the form that:
 
 - shouldn't be visible by the real users
 - should be left empty by the real users
-- will most be filled by spam bots
+- will most likely be filled by spam bots
 
-It also comes with a time-sensitive :hourglass: form submission.
+It also comes with:
+- a time-sensitive :hourglass: form submission
+- an IP based :mag: spinner validation
 
 ## Installation
 
-Invisible Captcha is tested against Rails `>= 3.2` and Ruby `>= 2.2`.
+Invisible Captcha is tested against Rails `>= 5.2` and Ruby `>= 2.5`.
 
 Add this line to your Gemfile and then execute `bundle install`:
 
@@ -47,7 +49,7 @@ class TopicsController < ApplicationController
 end
 ```
 
-This method will act as a `before_action` that triggers when spam is detected (honeypot field has some value). By default it responds with no content (only headers: `head(200)`). This is a good default, since the bot will surely read the response code and will think that it has achieved to submit the form properly. But, anyway, you are able to define your own callback by passing a method to the `on_spam` option:
+This method will act as a `before_action` that triggers when spam is detected (honeypot field has some value). By default, it responds with no content (only headers: `head(200)`). This is a good default, since the bot will surely read the response code and will think that it has achieved to submit the form properly. But, anyway, you can define your own callback by passing a method to the `on_spam` option:
 
 ```ruby
 class TopicsController < ApplicationController
@@ -61,7 +63,7 @@ class TopicsController < ApplicationController
 end
 ```
 
-Note that is not mandatory to specify a `honeypot` attribute (nor in the view, nor in the controller). In this case, the engine will take a random field from `InvisibleCaptcha.honeypots`. So, if you're integrating it following this path, in your form:
+Note that it is not mandatory to specify a `honeypot` attribute (neither in the view nor in the controller). In this case, the engine will take a random field from `InvisibleCaptcha.honeypots`. So, if you're integrating it following this path, in your form:
 
 ```erb
 <%= form_tag(new_contact_path) do |f| %>
@@ -69,12 +71,32 @@ Note that is not mandatory to specify a `honeypot` attribute (nor in the view, n
 <% end %>
 ```
 
-In you controller:
+In your controller:
 
 ```
 invisible_captcha only: [:new_contact]
 ```
 
+`invisible_captcha` sends all messages to `flash[:error]`. For messages to appear on your pages, add `<%= flash[:error] %>` to `app/views/layouts/application.html.erb` (somewhere near the top of your `<body>` element):
+
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Yet another Rails app</title>
+  <%= stylesheet_link_tag    "application", media: "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <%= flash[:error] %>
+  <%= yield %>
+</body>
+</html>
+```
+
+You can place `<%= flash[:error] %>` next to `:alert` and `:notice` message types, if you have them in your `app/views/layouts/application.html.erb`.
+
 ## Options and customization
 
 This section contains a description of all plugin options and customizations.
@@ -84,12 +106,14 @@ This section contains a description of all plugin options and customizations.
 You can customize:
 
 - `sentence_for_humans`: text for real users if input field was visible. By default, it uses I18n (see below).
-- `honeypots`: collection of default honeypots. Used by the view helper, called with no args, to generate a random honeypot field name. By default, a random collection is already generated.
+- `honeypots`: collection of default honeypots. Used by the view helper, called with no args, to generate a random honeypot field name. By default, a random collection is already generated. As the random collection is stored in memory, it will not work if you are running multiple Rails instances behind a load balancer. See [Multiple Rails instances](#multiple-rails-instances).
 - `visual_honeypots`: make honeypots visible, also useful to test/debug your implementation.
 - `timestamp_threshold`: fastest time (in seconds) to expect a human to submit the form (see [original article by Yoav Aner](https://blog.gingerlime.com/2012/simple-detection-of-comment-spam-in-rails/) outlining the idea). By default, 4 seconds. **NOTE:** It's recommended to deactivate the autocomplete feature to avoid false positives (`autocomplete="off"`).
 - `timestamp_enabled`: option to disable the time threshold check at application level. Could be useful, for example, on some testing scenarios. By default, true.
 - `timestamp_error_message`: flash error message thrown when form submitted quicker than the `timestamp_threshold` value. It uses I18n by default.
 - `injectable_styles`: if enabled, you should call anywhere in your layout the following helper `<%= invisible_captcha_styles %>`. This allows you to inject styles, for example, in `<head>`. False by default, styles are injected inline with the honeypot.
+- `spinner_enabled`: option to disable the IP spinner validation.
+- `secret`: customize the secret key to encode some internal values. By default, it reads the environment variable `ENV['INVISIBLE_CAPTCHA_SECRET']` and fallbacks to random value. Be careful, if you are running multiple Rails instances behind a load balancer, use always the same value via the environment variable.
 
 To change these defaults, add the following to an initializer (recommended `config/initializers/invisible_captcha.rb`):
 
@@ -97,9 +121,10 @@ To change these defaults, add the following to an initializer (recommended `conf
 InvisibleCaptcha.setup do |config|
   # config.honeypots           << ['more', 'fake', 'attribute', 'names']
   # config.visual_honeypots    = false
-  # config.timestamp_threshold = 4
+  # config.timestamp_threshold = 2
   # config.timestamp_enabled   = true
   # config.injectable_styles   = false
+  # config.spinner_enabled     = true
 
   # Leave these unset if you want to use I18n (see below)
   # config.sentence_for_humans     = 'If you are a human, ignore this field'
@@ -107,6 +132,22 @@ InvisibleCaptcha.setup do |config|
 end
 ```
 
+#### Multiple Rails instances
+
+If you have multiple Rails instances running behind a load balancer, you have to share the same honeypots collection between the instances.
+
+Either use a fixed collection or share them between the instances using `Rails.cache`:
+
+```ruby
+InvisibleCaptcha.setup do |config|
+  config.honeypots = Rails.cache.fetch('invisible_captcha_honeypots') do
+    (1..20).map { InvisibleCaptcha.generate_random_honeypot }
+  end
+end
+```
+
+Be careful also with the `secret` setting. Since it will be stored in-memory, if you are running this setup, the best idea is to provide the environment variable (`ENV['INVISIBLE_CAPTCHA_SECRET']`) from your infrastructure.
+
 ### Controller method options:
 
 The `invisible_captcha` method accepts some options:
@@ -114,11 +155,12 @@ The `invisible_captcha` method accepts some options:
 - `only`: apply to given controller actions.
 - `except`: exclude to given controller actions.
 - `honeypot`: name of custom honeypot.
-- `scope`: name of scope, ie: 'topic[subtitle]' -> 'topic' is the scope.
+- `scope`: name of scope, ie: 'topic[subtitle]' -> 'topic' is the scope. By default, it's inferred from the `controller_name`.
 - `on_spam`: custom callback to be called on spam detection.
 - `timestamp_enabled`: enable/disable this technique at action level.
 - `on_timestamp_spam`: custom callback to be called when form submitted too quickly. The default action redirects to `:back` printing a warning in `flash[:error]`.
 - `timestamp_threshold`: custom threshold per controller/action. Overrides the global value for `InvisibleCaptcha.timestamp_threshold`.
+- `prepend`: the spam detection will run in a `prepend_before_action` if `prepend: true`, otherwise will run in a `before_action`.
 
 ### View helpers options:
 
@@ -145,6 +187,71 @@ You can also pass html options to the input:
 <%= invisible_captcha :subtitle, :topic, id: "your_id", class: "your_class" %>
 ```
 
+### Spam detection notifications
+
+In addition to the `on_spam` controller callback, you can use the [Active Support Instrumentation API](https://guides.rubyonrails.org/active_support_instrumentation.html) to set up a global event handler that fires whenever spam is detected. This is useful for advanced logging, background processing, etc.
+
+To set up a global event handler, [subscribe](https://guides.rubyonrails.org/active_support_instrumentation.html#subscribing-to-an-event) to the `invisible_captcha.spam_detected` event in an initializer:
+
+```ruby
+# config/initializers/invisible_captcha.rb
+
+ActiveSupport::Notifications.subscribe('invisible_captcha.spam_detected') do |*args, data|
+  AwesomeLogger.warn(data[:message], data) # Log to an external logging service.
+  SpamRequest.create(data)                 # Record the blocked request in your database.
+end
+```
+
+The `data` passed to the subscriber is hash containing information about the request that was detected as spam. For example:
+
+```ruby
+{
+  message: "Invisible Captcha honeypot param 'subtitle' was present.",
+  remote_ip: '127.0.0.1',
+  user_agent: 'Chrome 77',
+  controller: 'users',
+  action: 'create',
+  url: 'http://example.com/users',
+  params: {
+    topic: { subtitle: 'foo' },
+    controller: 'users',
+    action: 'create'
+  }
+}
+```
+
+_**Note:** `params` will be filtered according to your `Rails.application.config.filter_parameters` configuration, making them (probably) safe for logging. But always double-check that you're not inadvertently logging sensitive form data, like passwords and credit cards._
+
+### Content Security Policy
+
+If you're using a Content Security Policy (CSP) in your Rails app, you will need to generate a nonce on the server, and pass `nonce: true` attribute to the view helper. Uncomment the following lines in your `config/initializers/content_security_policy.rb` file:
+
+```ruby
+# Be sure to restart your server when you modify this file.
+
+# If you are using UJS then enable automatic nonce generation
+Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
+
+# Set the nonce only to specific directives
+Rails.application.config.content_security_policy_nonce_directives = %w(style-src)
+```
+Note that if you are already generating nonce for scripts, you'd have to include `script-src` to `content_security_policy_nonce_directives` as well:
+
+```ruby
+Rails.application.config.content_security_policy_nonce_directives = %w(script-src style-src)
+```
+
+And in your view helper, you need to pass `nonce: true` to the `invisible_captcha` helper:
+
+```erb
+<%= invisible_captcha nonce: true %>
+```
+
+**WARNING:** Content Security Policy can break your site! If you already run a website with third-party scripts, styles, images, and fonts, it is highly recommended to enable CSP in report-only mode and observe warnings as they appear. Learn more at MDN:
+
+* https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
+* https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
 ### I18n
 
 `invisible_captcha` tries to use I18n when it's available by default. The keys it looks for are the following:
@@ -156,17 +263,20 @@ en:
     timestamp_error_message: "Sorry, that was too quick! Please resubmit."
 ```
 
-You can override the english ones in your own i18n config files as well as add new ones for other locales.
+You can override the English ones in your i18n config files as well as add new ones for other locales.
 
 If you intend to use I18n with `invisible_captcha`, you _must not_ set `sentence_for_humans` or `timestamp_error_message` to strings in the setup phase.
 
 ## Testing your controllers
 
-If you're encountering unexpected behaviour while testing controllers that use the `invisible_captcha` action filter, you may want to disable timestamp check for the test environment:
+If you're encountering unexpected behaviour while testing controllers that use the `invisible_captcha` action filter, you may want to disable timestamp check for the test environment. Add the following snippet to the `config/initializers/invisible_captcha.rb` file:
 
 ```ruby
-# test/test_helper.rb, spec/rails_helper.rb, ...
-InvisibleCaptcha.timestamp_enabled = false
+# Be sure to restart your server when you modify this file.
+
+InvisibleCaptcha.setup do |config|
+  config.timestamp_enabled = !Rails.env.test?
+end
 ```
 
 Another option is to wait for the timestamp check to be valid:
@@ -204,7 +314,7 @@ $ bundle exec appraisal rspec
 Run specs against specific version:
 
 ```
-$ bundle exec appraisal rails-5.2 rspec
+$ bundle exec appraisal rails-6.0 rspec
 ```
 
 ### Demo

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 

data/gemfiles/{rails_3.2.gemfile → rails_6.1.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 3.2.0"
+gem "rails", "~> 6.1.0"
 
 gemspec path: "../"

data/invisible_captcha.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |spec|
   spec.version       = InvisibleCaptcha::VERSION
   spec.authors       = ["Marc Anguera Insa"]
   spec.email         = ["srmarc.ai@gmail.com"]
-  spec.description   = "Unobtrusive, flexible and simple spam protection for Rails applications using honeypot strategy for better user experience."
-  spec.summary       = "Simple honeypot protection for RoR apps"
+  spec.description   = "Unobtrusive, flexible and complete spam protection for Rails applications using honeypot strategy for better user experience."
+  spec.summary       = "Honeypot spam protection for Rails"
   spec.homepage      = "https://github.com/markets/invisible_captcha"
   spec.license       = "MIT"
 
@@ -15,11 +15,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails', '>= 3.2.0'
+  spec.add_dependency 'rails', '>= 5.0'
 
-  spec.add_development_dependency 'rspec-rails', '~> 3.1'
+  spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'test-unit', '~> 3.0'
-  spec.add_development_dependency 'byebug'
 end
-

data/lib/invisible_captcha.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'invisible_captcha/version'
 require 'invisible_captcha/controller_ext'
 require 'invisible_captcha/view_helpers'
@@ -13,7 +15,9 @@ module InvisibleCaptcha
                   :timestamp_threshold,
                   :timestamp_enabled,
                   :visual_honeypots,
-                  :injectable_styles
+                  :injectable_styles,
+                  :spinner_enabled,
+                  :secret
 
     def init!
       # Default sentence for real users if text field was visible
@@ -31,9 +35,15 @@ module InvisibleCaptcha
       # Make honeypots visibles
       self.visual_honeypots = false
 
-      # If enabled, you should call anywhere in of your layout the following helper, to inject the honeypot styles:
-      #  <%= invisible_captcha_styles %>
+      # If enabled, you should call anywhere in your layout the following helper, to inject the honeypot styles:
+      # <%= invisible_captcha_styles %>
       self.injectable_styles = false
+
+      # Spinner check enabled by default
+      self.spinner_enabled = true
+
+      # A secret key to encode some internal values
+      self.secret = ENV['INVISIBLE_CAPTCHA_SECRET'] || SecureRandom.hex(64)
     end
 
     def sentence_for_humans
@@ -68,6 +78,10 @@ module InvisibleCaptcha
       ].sample
     end
 
+    def encode(value)
+      Digest::MD5.hexdigest("#{self.secret}-#{value}")
+    end
+
     private
 
     def call_lambda_or_return(obj)

data/lib/invisible_captcha/controller_ext.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module InvisibleCaptcha
   module ControllerExt
     module ClassMethods
       def invisible_captcha(options = {})
-        if respond_to?(:before_action)
-          before_action(options) do
+        if options.key?(:prepend)
+          prepend_before_action(options) do
             detect_spam(options)
           end
         else
-          before_filter(options) do
+          before_action(options) do
             detect_spam(options)
           end
         end
@@ -19,7 +21,7 @@ module InvisibleCaptcha
     def detect_spam(options = {})
       if timestamp_spam?(options)
         on_timestamp_spam(options)
-      elsif honeypot_spam?(options)
+      elsif honeypot_spam?(options) || spinner_spam?
         on_spam(options)
       end
     end
@@ -28,11 +30,7 @@ module InvisibleCaptcha
       if action = options[:on_timestamp_spam]
         send(action)
       else
-        if respond_to?(:redirect_back)
-          redirect_back(fallback_location: root_path, flash: { error: InvisibleCaptcha.timestamp_error_message })
-        else
-          redirect_to :back, flash: { error: InvisibleCaptcha.timestamp_error_message }
-        end
+        redirect_back(fallback_location: root_path, flash: { error: InvisibleCaptcha.timestamp_error_message })
       end
     end
 
@@ -53,24 +51,33 @@ module InvisibleCaptcha
 
       return false unless enabled
 
-      @invisible_captcha_timestamp ||= session.delete(:invisible_captcha_timestamp)
+      timestamp = session.delete(:invisible_captcha_timestamp)
 
       # Consider as spam if timestamp not in session, cause that means the form was not fetched at all
-      unless @invisible_captcha_timestamp
-        warn("Invisible Captcha timestamp not found in session.")
+      unless timestamp
+        warn_spam("Invisible Captcha timestamp not found in session.")
         return true
       end
 
-      time_to_submit = Time.zone.now - DateTime.iso8601(@invisible_captcha_timestamp)
+      time_to_submit = Time.zone.now - DateTime.iso8601(timestamp)
       threshold = options[:timestamp_threshold] || InvisibleCaptcha.timestamp_threshold
 
       # Consider as spam if form submitted too quickly
       if time_to_submit < threshold
-        warn("Invisible Captcha timestamp threshold not reached (took #{time_to_submit.to_i}s).")
+        warn_spam("Invisible Captcha timestamp threshold not reached (took #{time_to_submit.to_i}s).")
         return true
       end
 
-      return false
+      false
+    end
+
+    def spinner_spam?
+      if InvisibleCaptcha.spinner_enabled && params[:spinner] != session[:invisible_captcha_spinner]
+        warn_spam("Invisible Captcha spinner value mismatch")
+        return true
+      end
+
+      false
     end
 
     def honeypot_spam?(options = {})
@@ -81,8 +88,8 @@ module InvisibleCaptcha
         # If honeypot is defined for this controller-action, search for:
         # - honeypot: params[:subtitle]
         # - honeypot with scope: params[:topic][:subtitle]
-        if params[honeypot].present? || (params[scope] && params[scope][honeypot].present?)
-          warn("Invisible Captcha honeypot param '#{honeypot}' was present.")
+        if params[honeypot].present? || params.dig(scope, honeypot).present?
+          warn_spam("Invisible Captcha honeypot param '#{honeypot}' was present.")
           return true
         else
           # No honeypot spam detected, remove honeypot from params to avoid UnpermittedParameters exceptions
@@ -92,7 +99,7 @@ module InvisibleCaptcha
       else
         InvisibleCaptcha.honeypots.each do |default_honeypot|
           if params[default_honeypot].present?
-            warn("Invisible Captcha honeypot param '#{default_honeypot}' was present.")
+            warn_spam("Invisible Captcha honeypot param '#{default_honeypot}' was present.")
             return true
           end
         end
@@ -101,8 +108,19 @@ module InvisibleCaptcha
       false
     end
 
-    def warn(message)
+    def warn_spam(message)
       logger.warn("Potential spam detected for IP #{request.remote_ip}. #{message}")
+
+      ActiveSupport::Notifications.instrument(
+        'invisible_captcha.spam_detected',
+        message: message,
+        remote_ip: request.remote_ip,
+        user_agent: request.user_agent,
+        controller: params[:controller],
+        action: params[:action],
+        url: request.url,
+        params: request.filtered_parameters
+      )
     end
   end
 end

data/lib/invisible_captcha/form_helpers.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module InvisibleCaptcha
   module FormHelpers
     def invisible_captcha(honeypot, options = {})
       @template.invisible_captcha(honeypot, self.object_name, options)
     end
   end
-end
+end

data/lib/invisible_captcha/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InvisibleCaptcha
   class Railtie < Rails::Railtie
     initializer 'invisible_captcha.rails_integration' do

data/lib/invisible_captcha/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InvisibleCaptcha
-  VERSION = "0.12.2"
+  VERSION = "2.0.0"
 end

data/lib/invisible_captcha/view_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InvisibleCaptcha
   module ViewHelpers
     # Builds the honeypot html
@@ -8,9 +10,17 @@ module InvisibleCaptcha
     #
     # @return [String] the generated html
     def invisible_captcha(honeypot = nil, scope = nil, options = {})
-      if InvisibleCaptcha.timestamp_enabled
+      @captcha_ocurrences = 0 unless defined?(@captcha_ocurrences)
+      @captcha_ocurrences += 1
+
+      if InvisibleCaptcha.timestamp_enabled || InvisibleCaptcha.spinner_enabled
         session[:invisible_captcha_timestamp] = Time.zone.now.iso8601
       end
+
+      if InvisibleCaptcha.spinner_enabled && @captcha_ocurrences == 1
+        session[:invisible_captcha_spinner] = InvisibleCaptcha.encode("#{session[:invisible_captcha_timestamp]}-#{current_request.remote_ip}")
+      end
+
       build_invisible_captcha(honeypot, scope, options)
     end
 
@@ -22,6 +32,10 @@ module InvisibleCaptcha
 
     private
 
+    def current_request
+      @request ||= request
+    end
+
     def build_invisible_captcha(honeypot = nil, scope = nil, options = {})
       if honeypot.is_a?(Hash)
         options = honeypot
@@ -42,6 +56,9 @@ module InvisibleCaptcha
         concat styles unless InvisibleCaptcha.injectable_styles
         concat label_tag(build_label_name(honeypot, scope), label)
         concat text_field_tag(build_input_name(honeypot, scope), nil, default_honeypot_options.merge(options))
+        if InvisibleCaptcha.spinner_enabled
+          concat hidden_field_tag("spinner", session[:invisible_captcha_spinner])
+        end
       end
     end
 
@@ -54,7 +71,9 @@ module InvisibleCaptcha
 
       return if visible
 
-      content_tag(:style, media: 'screen') do
+      nonce = content_security_policy_nonce if options[:nonce]
+
+      content_tag(:style, media: 'screen', nonce: nonce) do
         ".#{css_class} {#{InvisibleCaptcha.css_strategy}}"
       end
     end

data/spec/controllers_spec.rb

@@ -1,39 +1,27 @@
+# frozen_string_literal: true
+
 RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
   render_views
 
-  def switchable_post(action, params = {})
-    if ::Rails::VERSION::STRING > '5'
-      post action, params: params
-    else
-      post action, params
-    end
-  end
-
-  def switchable_put(action, params = {})
-    if ::Rails::VERSION::STRING > '5'
-      put action, params: params
-    else
-      put action, params
-    end
-  end
-
   before(:each) do
     @controller = TopicsController.new
     request.env['HTTP_REFERER'] = 'http://test.host/topics'
+
     InvisibleCaptcha.init!
     InvisibleCaptcha.timestamp_threshold = 1
+    InvisibleCaptcha.spinner_enabled = false
   end
 
   context 'without invisible_captcha_timestamp in session' do
     it 'fails like if it was submitted too fast' do
-      switchable_post :create, topic: { title: 'foo' }
+      post :create, params: { topic: { title: 'foo' } }
 
       expect(response).to redirect_to 'http://test.host/topics'
       expect(flash[:error]).to eq(InvisibleCaptcha.timestamp_error_message)
     end
 
     it 'passes if disabled at action level' do
-      switchable_post :copy, topic: { title: 'foo' }
+      post :copy, params: { topic: { title: 'foo' } }
 
       expect(flash[:error]).not_to be_present
       expect(response.body).to be_present
@@ -41,7 +29,8 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
 
     it 'passes if disabled at app level' do
       InvisibleCaptcha.timestamp_enabled = false
-      switchable_post :create, topic: { title: 'foo' }
+
+      post :create, params: { topic: { title: 'foo' } }
 
       expect(flash[:error]).not_to be_present
       expect(response.body).to be_present
@@ -54,7 +43,7 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
     end
 
     it 'fails if submission before timestamp_threshold' do
-      switchable_post :create, topic: { title: 'foo' }
+      post :create, params: { topic: { title: 'foo' } }
 
       expect(response).to redirect_to 'http://test.host/topics'
       expect(flash[:error]).to eq(InvisibleCaptcha.timestamp_error_message)
@@ -64,7 +53,7 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
     end
 
     it 'allows a custom on_timestamp_spam callback' do
-      switchable_put :update, id: 1, topic: { title: 'bar' }
+      put :update, params: { id: 1, topic: { title: 'bar' } }
 
       expect(response.status).to eq(204)
     end
@@ -77,7 +66,7 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
         end
       end
 
-      expect { switchable_put :update, id: 1, topic: { title: 'bar' } }
+      expect { put :update, params: { id: 1, topic: { title: 'bar' } } }
         .to change { session[:invisible_captcha_timestamp] }
         .to be_present
     end
@@ -86,10 +75,12 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
       it 'passes if submission on or after timestamp_threshold' do
         sleep InvisibleCaptcha.timestamp_threshold
 
-        switchable_post :create, topic: {
-          title: 'foobar',
-          author: 'author',
-          body: 'body that passes validation'
+        post :create, params: {
+          topic: {
+            title: 'foobar',
+            author: 'author',
+            body: 'body that passes validation'
+          }
         }
 
         expect(flash[:error]).not_to be_present
@@ -102,7 +93,7 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
       it 'allow to set a custom timestamp_threshold per action' do
         sleep 2 # custom threshold
 
-        switchable_post :publish, id: 1
+        post :publish, params: { id: 1 }
 
         expect(flash[:error]).not_to be_present
         expect(response.body).to be_present
@@ -113,33 +104,90 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
   context 'honeypot attribute' do
     before(:each) do
       session[:invisible_captcha_timestamp] = Time.zone.now.iso8601
+
       # Wait for valid submission
       sleep InvisibleCaptcha.timestamp_threshold
     end
 
     it 'fails with spam' do
-      switchable_post :create, topic: { subtitle: 'foo' }
+      post :create,  params: { topic: { subtitle: 'foo' } }
 
       expect(response.body).to be_blank
     end
 
     it 'passes with no spam' do
-      switchable_post :create, topic: { title: 'foo' }
+      post :create,  params: { topic: { title: 'foo' } }
 
       expect(response.body).to be_present
     end
 
     it 'allow a custom on_spam callback' do
-      switchable_put :update, id: 1, topic: { subtitle: 'foo' }
+      put :update,  params: { id: 1, topic: { subtitle: 'foo' } }
 
       expect(response.body).to redirect_to(new_topic_path)
     end
 
     it 'honeypot is removed from params if you use a custom honeypot' do
-      switchable_post :create, topic: { title: 'foo', subtitle: '' }
+      post :create,  params: { topic: { title: 'foo', subtitle: '' } }
 
       expect(flash[:error]).not_to be_present
       expect(@controller.params[:topic].key?(:subtitle)).to eq(false)
     end
+
+    describe 'ActiveSupport::Notifications' do
+      let(:dummy_handler) { double(handle_event: nil) }
+
+      let!(:subscriber) do
+        subscriber = ActiveSupport::Notifications.subscribe('invisible_captcha.spam_detected') do |*args, data|
+          dummy_handler.handle_event(data)
+        end
+
+        subscriber
+      end
+
+      after { ActiveSupport::Notifications.unsubscribe(subscriber) }
+
+      it 'dispatches an `invisible_captcha.spam_detected` event' do
+        expect(dummy_handler).to receive(:handle_event).once.with(
+          message: "Invisible Captcha honeypot param 'subtitle' was present.",
+          remote_ip: '0.0.0.0',
+          user_agent: 'Rails Testing',
+          controller: 'topics',
+          action: 'create',
+          url: 'http://test.host/topics',
+          params: {
+            topic: { subtitle: "foo"},
+            controller: 'topics',
+            action: 'create'
+          }
+        )
+
+        post :create, params: { topic: { subtitle: 'foo' } }
+      end
+    end
+  end
+
+  context 'spinner attribute' do
+    before(:each) do
+      InvisibleCaptcha.spinner_enabled = true
+      InvisibleCaptcha.secret = 'secret'
+      session[:invisible_captcha_timestamp] = Time.zone.now.iso8601
+      session[:invisible_captcha_spinner] = '32ab649161f9f6faeeb323746de1a25d'
+
+      # Wait for valid submission
+      sleep InvisibleCaptcha.timestamp_threshold
+    end
+
+    it 'fails with no spam, but mismatch of spinner' do
+      post :create,  params: { topic: { title: 'foo' }, spinner: 'mismatch' }
+
+      expect(response.body).to be_blank
+    end
+
+    it 'passes with no spam and spinner match' do
+      post :create,  params: { topic: { title: 'foo' }, spinner: '32ab649161f9f6faeeb323746de1a25d' }
+
+      expect(response.body).to be_present
+    end
   end
 end

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/config/environments/test.rb

@@ -14,13 +14,8 @@ Dummy::Application.configure do
 
   # Disable serving static files from the `/public` folder by default since
   # Apache or NGINX already handles this.
-  if Rails.version >= "5.0.0"
-    config.public_file_server.enabled = true
-    config.public_file_server.headers = {'Cache-Control' => 'public, max-age=3600'}
-  else
-    config.serve_static_files = true
-    config.static_cache_control = "public, max-age=3600"
-  end
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {'Cache-Control' => 'public, max-age=3600'}
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
@@ -39,4 +34,4 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
-end
+end

data/spec/invisible_captcha_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe InvisibleCaptcha do
   it 'initialize with defaults' do
     InvisibleCaptcha.init!

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ENV['RAILS_ENV'] = 'test'
 
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
@@ -5,6 +7,7 @@ require 'rspec/rails'
 require 'invisible_captcha'
 
 RSpec.configure do |config|
+  config.include ActionDispatch::ContentSecurityPolicy::Request, type: :helper
   config.disable_monkey_patching!
   config.order = :random
   config.expect_with :rspec
@@ -12,17 +15,3 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 end
-
-# Rails 4.2 call `initialize` inside `recycle!`. However Ruby 2.6 doesn't allow calling `initialize` twice.
-# More info: https://github.com/rails/rails/issues/34790
-if RUBY_VERSION >= "2.6.0" && Rails.version < "5"
-  module ActionController
-    class TestResponse < ActionDispatch::TestResponse
-      def recycle!
-        @mon_mutex_owner_object_id = nil
-        @mon_mutex = nil
-        initialize
-      end
-    end
-  end
-end

data/spec/view_helpers_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 RSpec.describe InvisibleCaptcha::ViewHelpers, type: :helper do
   before(:each) do
-    allow(Time.zone).to receive(:now).and_return(Time.zone.parse('Feb 19 1986'))
     allow(InvisibleCaptcha).to receive(:css_strategy).and_return("display:none;")
+    allow_any_instance_of(ActionDispatch::ContentSecurityPolicy::Request).to receive(:content_security_policy_nonce).and_return('123')
 
     # to test content_for and provide
     @view_flow = ActionView::OutputFlow.new
@@ -26,6 +28,10 @@ RSpec.describe InvisibleCaptcha::ViewHelpers, type: :helper do
     expect(invisible_captcha(:subtitle, :topic, { class: 'foo_class' })).to match(/class="foo_class"/)
   end
 
+  it 'with CSP nonce' do
+    expect(invisible_captcha(:subtitle, :topic, { nonce: true })).to match(/nonce="123"/)
+  end
+
   it 'generated html + styles' do
     InvisibleCaptcha.honeypots = [:foo_id]
     output = invisible_captcha.gsub("\"", "'")
@@ -52,6 +58,18 @@ RSpec.describe InvisibleCaptcha::ViewHelpers, type: :helper do
     end
   end
 
+  context "should have spinner field" do
+    it 'that exists by default, spinner_enabled is true' do
+      InvisibleCaptcha.spinner_enabled = true
+      expect(invisible_captcha).to match(/spinner/)
+    end
+
+    it 'that does not exist if spinner_enabled is false' do
+      InvisibleCaptcha.spinner_enabled = false
+      expect(invisible_captcha).not_to match(/spinner/)
+    end
+  end
+
   it 'should set spam timestamp' do
     invisible_captcha
     expect(session[:invisible_captcha_timestamp]).to eq(Time.zone.now.iso8601)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invisible_captcha
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Marc Anguera Insa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2021-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,30 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,21 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Unobtrusive, flexible and simple spam protection for Rails applications
+description: Unobtrusive, flexible and complete spam protection for Rails applications
   using honeypot strategy for better user experience.
 email:
 - srmarc.ai@gmail.com
@@ -97,12 +69,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails_3.2.gemfile
-- gemfiles/rails_4.2.gemfile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
 - invisible_captcha.gemspec
 - lib/invisible_captcha.rb
 - lib/invisible_captcha/controller_ext.rb
@@ -113,6 +82,7 @@ files:
 - spec/controllers_spec.rb
 - spec/dummy/README.md
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
@@ -175,11 +145,12 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Simple honeypot protection for RoR apps
+summary: Honeypot spam protection for Rails
 test_files:
 - spec/controllers_spec.rb
 - spec/dummy/README.md
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb

data/gemfiles/rails_4.2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 4.2.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.1.0"
-
-gemspec path: "../"