invisible_captcha 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5011fee9db065c86faf1507c11e0d3000ad61e19d05e7102e8bcf3750abcd52f
-  data.tar.gz: bd104ffe4aeb3436c1d365a293c66f80d9d2e42c543b009ea596ac83d9a84db2
+  metadata.gz: 22b983b8b83c0fb6eee4d4a97e3680c2c8e44c305c9181aee11e57f995f545e4
+  data.tar.gz: 97a7ec072f6158d49c0f65f73d3d8c6ee90725306ff0de87af5dd21ce1fc5184
 SHA512:
-  metadata.gz: e1c5608b8671bfef9edfec01531f575fe3a83c12a00dd72090a772686f2fef56ab6436e323dc7ca7daa1b82d30764ca03a2f89d6727145f593d377d1c057fe51
-  data.tar.gz: 811827be3f2a2bd4a18a1004377605c8db09c1279658371d2191e27226afd6557235c8747a5c39ec82a65bc443bb4590dcced9fff96d8be4fba946d21a07a50d
+  metadata.gz: 1d77948f8fe547ccf52da9d92389f170ce43bdaab80cdcf246f80fde50db6773134c305e7edc0a162036f4c6d5a98f75342679dc7915c44ba37c727168d35f3f
+  data.tar.gz: 687063c83c44dbae9a65ba75664c8240e7915464738aea41b38bf4e089aab7945fc2b22dda64814bdab85b7ae241439d7dd8dfccfe56a3f16b26b6b9ee145ecf

data/.travis.yml

@@ -3,9 +3,9 @@ cache: bundler
 sudo: false
 rvm:
   - ruby-head
-  - 2.6.2
-  - 2.5.5
-  - 2.4.5
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
   - 2.3.8
   - 2.2.10
 gemfile:
@@ -22,7 +22,7 @@ before_install:
   - rvm @global do yes | gem install bundler -v '< 2'
 matrix:
   exclude:
-    - rvm: 2.4.5
+    - rvm: 2.4.9
       gemfile: gemfiles/rails_6.0.gemfile
     - rvm: 2.3.8
       gemfile: gemfiles/rails_6.0.gemfile
@@ -30,11 +30,11 @@ matrix:
       gemfile: gemfiles/rails_6.0.gemfile
     - rvm: ruby-head
       gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.6.2
+    - rvm: 2.6.5
       gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.5.5
+    - rvm: 2.5.7
       gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.4.5
+    - rvm: 2.4.9
       gemfile: gemfiles/rails_3.2.gemfile
   allow_failures:
-    - rvm: ruby-head
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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 +106,7 @@ All notable changes to this project will be documented in this file.
 
 - First version of controller filters
 
+[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/README.md

@@ -7,13 +7,13 @@
 
 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.
 
@@ -47,7 +47,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
@@ -55,13 +55,13 @@ class TopicsController < ApplicationController
 
   private
 
-  def your_spam_callback_method
-    redirect_to root_path
-  end
+    def your_spam_callback_method
+      redirect_to root_path
+    end
 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 +69,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.
@@ -145,6 +165,38 @@ You can also pass html options to the input:
 <%= invisible_captcha :subtitle, :topic, id: "your_id", class: "your_class" %>
 ```
 
+### 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
+
+Note that Content Security Policy only works on Rails 5.2 and up.
+
 ### I18n
 
 `invisible_captcha` tries to use I18n when it's available by default. The keys it looks for are the following:
@@ -156,17 +208,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:

data/Rakefile

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

data/invisible_captcha.gemspec

@@ -22,4 +22,3 @@ Gem::Specification.new do |spec|
   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'

data/lib/invisible_captcha/controller_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InvisibleCaptcha
   module ControllerExt
     module ClassMethods

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 = "0.13.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
@@ -54,7 +56,13 @@ module InvisibleCaptcha
 
       return if visible
 
-      content_tag(:style, media: 'screen') do
+      nonce = if Rails.version >= '5.2'
+                content_security_policy_nonce if options[:nonce]
+              else
+                nil
+              end
+
+      content_tag(:style, media: 'screen', nonce: nonce) do
         ".#{css_class} {#{InvisibleCaptcha.css_strategy}}"
       end
     end

data/spec/controllers_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
   render_views
 
   def switchable_post(action, params = {})
-    if ::Rails::VERSION::STRING > '5'
+    if Rails.version > '5'
       post action, params: params
     else
       post action, params
@@ -10,7 +12,7 @@ RSpec.describe InvisibleCaptcha::ControllerExt, type: :controller do
   end
 
   def switchable_put(action, params = {})
-    if ::Rails::VERSION::STRING > '5'
+    if Rails.version > '5'
       put action, params: params
     else
       put action, params

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

@@ -39,4 +39,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,9 @@ require 'rspec/rails'
 require 'invisible_captcha'
 
 RSpec.configure do |config|
+  if Rails.version >= '5.2'
+    config.include ActionDispatch::ContentSecurityPolicy::Request, type: :helper
+  end
   config.disable_monkey_patching!
   config.order = :random
   config.expect_with :rspec

data/spec/view_helpers_spec.rb

@@ -1,8 +1,14 @@
+# 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;")
 
+    if Rails.version >= '5.2'
+      allow_any_instance_of(ActionDispatch::ContentSecurityPolicy::Request).to receive(:content_security_policy_nonce).and_return('123')
+    end
+
     # to test content_for and provide
     @view_flow = ActionView::OutputFlow.new
 
@@ -26,6 +32,12 @@ RSpec.describe InvisibleCaptcha::ViewHelpers, type: :helper do
     expect(invisible_captcha(:subtitle, :topic, { class: 'foo_class' })).to match(/class="foo_class"/)
   end
 
+  if Rails.version >= '5.2'
+    it 'with CSP nonce' do
+      expect(invisible_captcha(:subtitle, :topic, { nonce: true })).to match(/nonce="123"/)
+    end
+  end
+
   it 'generated html + styles' do
     InvisibleCaptcha.honeypots = [:foo_id]
     output = invisible_captcha.gsub("\"", "'")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invisible_captcha
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Marc Anguera Insa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -113,6 +113,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
@@ -180,6 +181,7 @@ 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