invisible_captcha 0.6.2 → 0.6.4

data/README.md

@@ -1,5 +1,6 @@
 # Invisible Captcha
-Simple spam protection for Rails applications using honeypot strategy and for better user experience. Support for ActiveRecord (and ActiveModel) forms and for non-RESTful resources.
+Simple and flexible spam protection solution for Rails applications using honeypot strategy and for better user experience.
+Support for ActiveRecord (and ActiveModel) forms and for non-RESTful resources.
 
 ## Installation
 Add this line to you Gemfile:
@@ -8,69 +9,85 @@ Add this line to you Gemfile:
 gem 'invisible_captcha'
 ```
 
-Or install gem:
+Or install gem manually:
 
 ```
 gem install invisible_captcha
 ```
 
 ## Usage
+There are different ways to implement:
 
 ### Model style
 View code:
 
 ```erb
 <%= form_for(@topic) do |f| %>
-
-  <!-- You can use form helper -->
   <%= f.invisible_captcha :subtitle %>
-
-  <!-- or view helper -->
-  <%= invisible_captcha :topic, :subtitle %>
-
 <% end %>
 ```
 
 Model code:
 
 ```ruby
-validates :subtitle, :invisible_captcha => true
+class Topic < ActiveRecord::Base
+  attr_accessor :subtitle # virtual attribute, the honeypot
+  validates :subtitle, :invisible_captcha => true
+end
+```
+
+If you are using [strong_parameters](https://github.com/rails/strong_parameters), don't forget to keep the honeypot attribute into the params hash:
+```ruby
+def topic_params
+  params.require(:topic).permit(:subtitle)
+end
 ```
 
 ### Controller style
 View code:
 
 ```erb
-<%= form_tag(search_path) do %>
-
+<%= form_for(@topic) do |f| %>
   <%= invisible_captcha %>
-
 <% end %>
 ```
 
 Controller code:
 
 ```ruby
-before_filter :check_invisible_captcha, :only => [:create, :update]
+class TopicsController < ApplicationController
+  before_filter :check_invisible_captcha # :only => [:create, :update]
+  # your controller code
+end
 ```
 
-This filter returns a response that has no content (only headers). If you desire a different behaviour, this lib provides a method to check manualy if invisible captcha (fake field) is present:
+This filter triggers when the spam is the in params and responds without content (only headers). If you desire a different behaviour, you can use a provided method to check manualy if invisible captcha (fake field) is present:
 
 ```ruby
 if invisible_captcha?
-  # invalid
+  # spam present
 else
-  # valid
+  # no spam
 end
 ```
 
-If you want to use it in this way but using RESTful forms with `form_for`, you can call this method with the fake field as a parameters:
+### Controller style (resource oriented):
 
-```ruby
-if invisible_captcha?(:topic, :subtitle)
-  # invalid
-else
-  # valid
+In your form:
+```
+<%= form_for(@topic) do |f| %>
+  <%= f.invisible_captcha :subtitle %>
+<% end %>
+```
+
+In your controller:
+```
+def create
+  if invisible_captcha?(:topic, :subtitle)
+    head 200 # or redirect_to new_topic_path
+  else
+    # regular workflow
+  end
 end
 ```
 
@@ -79,9 +96,9 @@ If you want to customize some defaults, add the following to an initializer (con
 
 ```
 InvisibleCaptcha.setup do |ic|
-  ic.sentence_for_humans = 'Another sentence'
-  ic.error_message = 'Another error message'
-  ic.fake_fields << 'fake_field'
+  ic.sentence_for_humans = 'If you are a human, ignore this field'
+  ic.error_message = 'You are a robot!'
+  ic.fake_fields << 'another_fake_field'
 end
 ```
 

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.4

data/invisible_captcha.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "invisible_captcha"
-  s.version = "0.6.2"
+  s.version = "0.6.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marc Anguera Insa"]
-  s.date = "2013-10-02"
+  s.date = "2013-11-21"
   s.description = "Simple spam protection for Rails applications using honeypot strategy for better user experience."
   s.email = "srmarc.ai@gmail.com"
   s.extra_rdoc_files = [
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "invisible_captcha.gemspec",
     "lib/invisible_captcha.rb",
-    "lib/invisible_captcha/controller_helpers.rb",
+    "lib/invisible_captcha/controller_methods.rb",
     "lib/invisible_captcha/form_helpers.rb",
     "lib/invisible_captcha/validator.rb",
     "lib/invisible_captcha/view_helpers.rb"

data/lib/invisible_captcha.rb

@@ -1,4 +1,4 @@
-require 'invisible_captcha/controller_helpers.rb'
+require 'invisible_captcha/controller_methods.rb'
 require 'invisible_captcha/view_helpers.rb'
 require 'invisible_captcha/form_helpers.rb'
 require 'invisible_captcha/validator.rb'
@@ -19,7 +19,7 @@ module InvisibleCaptcha
   # InvisibleCaptcha.setup do |ic|
   #   ic.sentence_for_humans = 'Another sentence'
   #   ic.error_message = 'Another error message'
-  #   ic.fake_fields << 'fake_field'
+  #   ic.fake_fields << 'another_fake_field'
   # end
   def self.setup
     yield(self)

data/lib/invisible_captcha/{controller_helpers.rb → controller_methods.rb}

@@ -1,5 +1,5 @@
 module InvisibleCaptcha
-  module ControllerHelpers
+  module ControllerMethods
 
     def check_invisible_captcha
       head 200 if invisible_captcha?
@@ -18,4 +18,4 @@ module InvisibleCaptcha
   end
 end
 
-ActionController::Base.send :include, InvisibleCaptcha::ControllerHelpers
+ActionController::Base.send :include, InvisibleCaptcha::ControllerMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: invisible_captcha
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -89,7 +89,7 @@ files:
 - VERSION
 - invisible_captcha.gemspec
 - lib/invisible_captcha.rb
-- lib/invisible_captcha/controller_helpers.rb
+- lib/invisible_captcha/controller_methods.rb
 - lib/invisible_captcha/form_helpers.rb
 - lib/invisible_captcha/validator.rb
 - lib/invisible_captcha/view_helpers.rb
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1304051618189671970
+      hash: -428601357
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: