invisible_captcha 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57c21321c483942e15254c832843c09cbbba7830
-  data.tar.gz: 6c18c874fdd903093e1695a362064fd2d2b274cc
+  metadata.gz: 03aab9758bfbaf12adb3913f5b37c8423d269c2e
+  data.tar.gz: 18e136fc292c192126f7c08d5d60286a4c86ba6b
 SHA512:
-  metadata.gz: ed8400648117aac3086d26176f2f9d67eb615f737f4078ed5c817bb3604ac8d85b295266c92bcca9ceeba25953ee68601a69a79044b804b3287bfd8c28b1eaf0
-  data.tar.gz: be584800363bf741d078f3a09f931e98544da1af91ce7757b78b2d5e4e8f896ab93583f974a7a471f8da20ba37c0fdb85f48e52b1be163cdeba3716b6acc0ca1
+  metadata.gz: c60cc1997f5748fef444f1eea60aa3a47b42ee6de60dffa8f320e346608e224594f4252efbe19d7df80edaf8c137729df4357162cb27f2e8b6c7fa1327aed94f
+  data.tar.gz: b5b62112cf6ea24aab60e66f589a0756d06e7337c7564e43cdea6a838023334c43e22cba5e486c3c8b1278fe1ef4829a5c925fea3e4917ba919677bd10710049

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012-2014 Marc Anguera Insa
+Copyright 2012-2015 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

@@ -109,26 +109,16 @@ end
 
 ## Options and customization
 
-This section contains the option list of `invisible_captcha` method (controllers side) and the plugin setup options (initializer).
-
-### Controller method options:
-
-The `invisible_captcha` method accepts some options:
-
-* `only`: apply to given controller actions.
-* `except`: exclude to given controller actions.
-* `honeypot`: name of honeypot.
-* `scope`: name of scope, ie: 'topic[subtitle]' -> 'topic' is the scope.
-* `on_spam`: custom callback to be called on spam detection.
+This section contains a description of all plugin options and customizations.
 
 ### Plugin options:
 
-You also can customize some plugin options:
+You can customize:
 
 * `sentence_for_humans`: text for real users if input field was visible.
 * `error_message`: error message thrown by model validation (only model implementation).
 * `honeypots`: collection of default honeypots, used by the view helper, called with no args, to generate the honeypot field name
-* `visual_honeypots`: make honeypots visible, useful to test/debug your implementation.
+* `visual_honeypots`: make honeypots visible, also useful to test/debug your implementation.
 
 To change these defaults, add the following to an initializer (recommended `config/initializers/invisible_captcha.rb`):
 
@@ -141,6 +131,28 @@ InvisibleCaptcha.setup do |config|
 end
 ```
 
+### Controller method options:
+
+The `invisible_captcha` method accepts some options:
+
+* `only`: apply to given controller actions.
+* `except`: exclude to given controller actions.
+* `honeypot`: name of honeypot.
+* `scope`: name of scope, ie: 'topic[subtitle]' -> 'topic' is the scope.
+* `on_spam`: custom callback to be called on spam detection.
+
+### View helpers options:
+
+Using the view/form helper you can override some defaults for the given instance. Actually, it allows to change: `sentence_for_humans` and `visual_honeypots`.
+
+```erb
+<%= form_for(@topic) do |f| %>
+  <%= f.invisible_captcha :subtitle, visual_honeypots: true, sentence_for_humans: "Ei, don't fill on this input!" %>
+  <!-- or -->
+  <%= invisible_captcha visual_honeypots: true, sentence_for_humans: "Ei, don't fill on this input!" %>
+<% end %>
+```
+
 ## Contribute
 
 Any kind of idea, feedback or bug report are welcome! Open an [issue](https://github.com/markets/invisible_captcha/issues) or send a [pull request](https://github.com/markets/invisible_captcha/pulls).
@@ -163,4 +175,4 @@ $ rake web # PORT=4000 (default: 3000)
 
 ## License
 
-Copyright (c) 2012-2014 Marc Anguera. Invisible Captcha is released under the [MIT](LICENSE) License.
+Copyright (c) 2012-2015 Marc Anguera. Invisible Captcha is released under the [MIT](LICENSE) License.

data/lib/invisible_captcha/form_helpers.rb

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

data/lib/invisible_captcha/railtie.rb

@@ -1,9 +1,17 @@
 module InvisibleCaptcha
   class Railtie < Rails::Railtie
-    ActionController::Base.send :include, InvisibleCaptcha::ControllerExt
-    ActionController::Base.send :extend, InvisibleCaptcha::ControllerExt::ClassMethods
-    ActionView::Base.send :include, InvisibleCaptcha::ViewHelpers
-    ActionView::Helpers::FormBuilder.send :include, InvisibleCaptcha::FormHelpers
-    ActiveModel::Validations::InvisibleCaptchaValidator = InvisibleCaptcha::InvisibleCaptchaValidator
+    initializer 'invisible_captcha.rails_integration' do
+      ActiveSupport.on_load(:action_controller) do
+        include InvisibleCaptcha::ControllerExt
+        extend InvisibleCaptcha::ControllerExt::ClassMethods
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include InvisibleCaptcha::ViewHelpers
+        ActionView::Helpers::FormBuilder.send :include, InvisibleCaptcha::FormHelpers
+      end
+
+      ActiveModel::Validations::InvisibleCaptchaValidator = InvisibleCaptcha::InvisibleCaptchaValidator
+    end
   end
 end

data/lib/invisible_captcha/validator.rb

@@ -1,10 +1,7 @@
-require 'active_model/validator'
-
 module InvisibleCaptcha
   class InvisibleCaptchaValidator < ActiveModel::EachValidator
     def validate_each(record, attribute, value)
       if invisible_captcha?(record, attribute)
-        record.errors.clear
         record.errors[:base] = InvisibleCaptcha.error_message
       end
     end

data/lib/invisible_captcha/version.rb

@@ -1,3 +1,3 @@
 module InvisibleCaptcha
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/invisible_captcha/view_helpers.rb

@@ -5,31 +5,42 @@ module InvisibleCaptcha
     # @param honeypot [Symbol] name of honeypot, ie: subtitle => input name: subtitle
     # @param scope [Symbol] name of honeypot scope, ie: topic => input name: topic[subtitle]
     # @return [String] the generated html
-    def invisible_captcha(honeypot = nil, scope = nil)
-      build_invisible_captcha(honeypot, scope)
+    def invisible_captcha(honeypot = nil, scope = nil, options = {})
+      build_invisible_captcha(honeypot, scope, options)
     end
 
     private
 
-    def build_invisible_captcha(honeypot = nil, scope = nil)
+    def build_invisible_captcha(honeypot = nil, scope = nil, options = {})
+      if honeypot.is_a?(Hash)
+        options = honeypot
+        honeypot = nil
+      end
+
       honeypot = honeypot ? honeypot.to_s : InvisibleCaptcha.get_honeypot
-      label    = InvisibleCaptcha.sentence_for_humans
+      label    = options[:sentence_for_humans] || InvisibleCaptcha.sentence_for_humans
       html_id  = generate_html_id(honeypot, scope)
 
       content_tag(:div, :id => html_id) do
-        insert_inline_css(html_id) +
-        label_tag(build_label_name(honeypot, scope), label) +
-        text_field_tag(build_text_field_name(honeypot, scope))
-      end.html_safe
+        concat visibility_css(html_id, options)
+        concat label_tag(build_label_name(honeypot, scope), label)
+        concat text_field_tag(build_text_field_name(honeypot, scope))
+      end
     end
 
     def generate_html_id(honeypot, scope = nil)
       "#{scope || honeypot}_#{Time.now.to_i}"
     end
 
-    def insert_inline_css(container_id)
+    def visibility_css(container_id, options)
+      visibility = if options.key?(:visual_honeypots)
+        options[:visual_honeypots]
+      else
+        InvisibleCaptcha.visual_honeypots
+      end
+
       content_tag(:style, :type => 'text/css', :media => 'screen', :scoped => 'scoped') do
-       "##{container_id} { display:none; }" unless InvisibleCaptcha.visual_honeypots
+        "##{container_id} { display:none; }" unless visibility
       end
     end
 

data/spec/dummy/app/controllers/topics_controller.rb

@@ -10,7 +10,7 @@ class TopicsController < ApplicationController
     @topic = Topic.new(params[:topic])
 
     if @topic.valid?
-      redirect_to new_topic_path
+      redirect_to new_topic_path(context: params[:context]), notice: 'Topic valid!'
     else
       render action: 'new'
     end

data/spec/dummy/app/models/topic.rb

@@ -4,6 +4,7 @@ class Topic
 
   attr_accessor :title, :body, :subtitle
 
+  validates :title, presence: true
   validates :subtitle, invisible_captcha: true
 
   def initialize(attributes = {})

data/spec/dummy/app/views/layouts/application.html.erb

@@ -8,6 +8,17 @@
 </head>
 <body>
 
+<%= link_to "Default", new_topic_path %> |
+<%= link_to "With visual honeypots", new_topic_path(context: "visual_honeypots") %>
+
+<% flash.each do |key, value| %>
+  <ul>
+    <li>
+      <%= "[#{key.upcase}] #{value}" %>
+    </li>
+  </ul>
+<% end %>
+
 <%= yield %>
 
 </body>

data/spec/dummy/app/views/topics/new.html.erb

@@ -1,16 +1,35 @@
 <h1>New topic</h1>
 
+<% if @topic.errors.any? %>
+  <div>
+    <h2><%= pluralize(@topic.errors.count, "error") %> prohibited this record from being saved:</h2>
+    <ul>
+      <% @topic.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>
+
 <%= form_for(@topic) do |f| %>
-  <%= f.invisible_captcha :subtitle %>
+  <%= hidden_field_tag :context, params[:context] %>
+
+  <% if params[:context].blank? || params[:context] == 'default' %>
+    <%= f.invisible_captcha :subtitle %>
+  <% else %>
+    <%= f.invisible_captcha :subtitle, visual_honeypots: true %>
+  <% end %>
 
   <div class="field">
     <%= f.label :title %><br />
     <%= f.text_field :title %>
   </div>
+
   <div class="field">
     <%= f.label :body %><br />
     <%= f.text_area :body %>
   </div>
+
   <div class="actions">
     <%= f.submit %>
   </div>

data/spec/validator_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe InvisibleCaptcha::InvisibleCaptchaValidator do
   it 'do not pass validations if honeypot is presented' do
-    topic = Topic.new
+    topic = Topic.new(title: 'foo')
     expect(topic.valid?).to be true
 
     topic.subtitle = 'foo'

data/spec/view_helpers_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe InvisibleCaptcha::ViewHelpers, type: :helper do
+  def helper_output(honeypot = nil, scope = nil, options = {})
+    honeypot ||= InvisibleCaptcha.get_honeypot
+    input_id   = build_label_name(honeypot, scope)
+    input_name = build_text_field_name(honeypot, scope)
+    html_id    = generate_html_id(honeypot, scope)
+    visibilty  = if options.key?(:visual_honeypots)
+      options[:visual_honeypots]
+    else
+      InvisibleCaptcha.visual_honeypots
+    end
+
+    %{
+      <div id="#{html_id}">
+        <style type="text/css" media="screen" scoped="scoped">#{visibilty ? '' : "##{html_id} { display:none; }"}</style>
+        <label for="#{input_id}">#{InvisibleCaptcha.sentence_for_humans}</label>
+        <input type="text" name="#{input_name}" id="#{input_id}" />
+      </div>
+    }.gsub(/\s+/, ' ').strip.gsub('> <', '><')
+  end
+
+  before do
+    allow(Time).to receive(:now).and_return(Time.parse('Feb 19 1986'))
+    InvisibleCaptcha.visual_honeypots = false
+  end
+
+  it 'with no arguments' do
+    InvisibleCaptcha.honeypots = [:foo_id]
+    expect(invisible_captcha).to eq(helper_output)
+  end
+
+  it 'with specific honeypot' do
+    expect(invisible_captcha(:subtitle)).to eq(helper_output(:subtitle))
+  end
+
+  it 'with specific honeypot and scope' do
+    expect(invisible_captcha(:subtitle, :topic)).to eq(helper_output(:subtitle, :topic))
+  end
+
+  context "honeypot visibilty" do
+    it 'visible from defaults' do
+      InvisibleCaptcha.honeypots = [:foo_id]
+      InvisibleCaptcha.visual_honeypots = true
+
+      expect(invisible_captcha).to eq(helper_output)
+    end
+
+    it 'visible from given instance (default override)' do
+      InvisibleCaptcha.honeypots = [:foo_id]
+
+      expect(invisible_captcha(visual_honeypots: true)).to eq(helper_output(nil, nil, visual_honeypots: true))
+    end
+
+    it 'invisible from given instance (default override)' do
+      InvisibleCaptcha.honeypots = [:foo_id]
+      InvisibleCaptcha.visual_honeypots = true
+
+      expect(invisible_captcha(visual_honeypots: false)).to eq(helper_output(nil, nil, visual_honeypots: false))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invisible_captcha
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Marc Anguera Insa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2015-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -96,10 +96,10 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
-- spec/helpers_spec.rb
 - spec/invisible_captcha_spec.rb
 - spec/spec_helper.rb
 - spec/validator_spec.rb
+- spec/view_helpers_spec.rb
 homepage: https://github.com/markets/invisible_captcha
 licenses:
 - MIT
@@ -161,7 +161,7 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
-- spec/helpers_spec.rb
 - spec/invisible_captcha_spec.rb
 - spec/spec_helper.rb
 - spec/validator_spec.rb
+- spec/view_helpers_spec.rb

data/spec/helpers_spec.rb

@@ -1,43 +0,0 @@
-require 'spec_helper'
-
-describe InvisibleCaptcha::ViewHelpers, type: :helper do
-  def helper_output(honeypot = nil, scope = nil)
-    honeypot ||= InvisibleCaptcha.get_honeypot
-    input_id   = build_label_name(honeypot, scope)
-    input_name = build_text_field_name(honeypot, scope)
-    html_id    = generate_html_id(honeypot, scope)
-
-    %{
-      <div id="#{html_id}">
-        <style media="screen" scoped="scoped" type="text/css">#{InvisibleCaptcha.visual_honeypots ? '' : "##{html_id} { display:none; }"}</style>
-        <label for="#{input_id}">#{InvisibleCaptcha.sentence_for_humans}</label>
-        <input id="#{input_id}" name="#{input_name}" type="text" />
-      </div>
-    }.gsub(/\s+/, ' ').strip.gsub('> <', '><')
-  end
-
-  before do
-    allow(Time).to receive(:now).and_return(Time.parse('Feb 19 1986'))
-    InvisibleCaptcha.visual_honeypots = false
-  end
-
-  it 'view helper with no arguments' do
-    InvisibleCaptcha.honeypots = [:foo_id]
-    expect(invisible_captcha).to eq(helper_output)
-  end
-
-  it 'view helper with specific honeypot' do
-    expect(invisible_captcha(:subtitle)).to eq(helper_output(:subtitle))
-  end
-
-  it 'view helper with specific honeypot and scope' do
-    expect(invisible_captcha(:subtitle, :topic)).to eq(helper_output(:subtitle, :topic))
-  end
-
-  it 'view helper with visual honeypots enabled' do
-    InvisibleCaptcha.honeypots = [:foo_id]
-    InvisibleCaptcha.visual_honeypots = true
-
-    expect(invisible_captcha).to eq(helper_output)
-  end
-end