invisible_captcha 0.5.0 → 0.6.0

data/README.md

@@ -1,5 +1,5 @@
 # Invisible Captcha
-Simple spam protection for Rails applications using honeypot strategy. Support for ActiveModel (and ActiveRecord) forms and for non-RESTful resources.
+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.
 
 ## Installation
 Add this line to you Gemfile:
@@ -16,8 +16,8 @@ gem install invisible_captcha
 
 ## Usage
 
-### RESTful style
-In your form:
+### Model style
+View code:
 
 ```erb
 <%= form_for(@topic) do |f| %>
@@ -31,14 +31,14 @@ In your form:
 <% end %>
 ```
 
-In your model:
+Model code:
 
 ```ruby
 validates :subtitle, :invisible_captcha => true
 ```
 
-### Non-RESTful style
-In your form:
+### Controller style
+View code:
 
 ```erb
 <%= form_tag(search_path) do %>
@@ -48,10 +48,41 @@ In your form:
 <% end %>
 ```
 
-In your controller:
+Controller code:
 
 ```ruby
-before_filter :check_invisible_captcha
+before_filter :check_invisible_captcha, :only => [:create, :update]
+```
+
+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:
+
+```ruby
+if invisible_captcha?
+  # invalid
+else
+  # valid
+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:
+
+```ruby
+if invisible_captcha?(:topic, :subtitle)
+  # invalid
+else
+  # valid
+end
+```
+
+### Setup
+If you want to customize some defaults, add the following to an initializer (config/initializers/invisible_captcha.rb):
+
+```
+InvisibleCaptcha.setup do |ic|
+  ic.sentence_for_humans = 'Another sentence'
+  ic.error_message = 'Another error message'
+  ic.fake_fields << 'fake_field'
+end
 ```
 
 ## License

data/Rakefile

@@ -17,7 +17,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/markets/invisible_captcha"
   gem.license = "MIT"
   gem.summary = %Q{Simple honeypot protection for RoR apps}
-  gem.description = %Q{Simple spam protection for Rails applications using honeypot strategy.}
+  gem.description = %Q{Simple spam protection for Rails applications using honeypot strategy for better user experience.}
   gem.email = "srmarc.ai@gmail.com"
   gem.authors = ["Marc Anguera Insa"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/invisible_captcha.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "invisible_captcha"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marc Anguera Insa"]
-  s.date = "2013-09-02"
-  s.description = "Simple spam protection for Rails applications using honeypot strategy."
+  s.date = "2013-09-03"
+  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 = [
     "README.md"

data/lib/invisible_captcha.rb

@@ -5,17 +5,28 @@ require "#{GEM_PATH}/form_helpers.rb"
 require "#{GEM_PATH}/validator.rb"
 
 module InvisibleCaptcha
-
   # Default sentence for humans if text field is visible
   mattr_accessor :sentence_for_humans
   self.sentence_for_humans = 'If you are a human, ignore this field'
 
   # Default error message for validator
   mattr_accessor :error_message
-  self.error_message = 'YOU ARE A ROBOT!'
+  self.error_message = 'You are a robot!'
+
+  # Default fake fields for controller based workflow
+  mattr_accessor :fake_fields
+  self.fake_fields = ['foo_id', 'bar_id', 'baz_id']
 
-  # Default fake field name for text_field_tag
-  mattr_accessor :fake_field
-  self.fake_field = :query
+  # InvisibleCaptcha.setup do |ic|
+  #   ic.sentence_for_humans = 'Another sentence'
+  #   ic.error_message = 'Another error message'
+  #   ic.fake_fields << 'fake_field'
+  # end
+  def self.setup
+    yield(self)
+  end
 
+  def self.fake_field
+    self.fake_fields.sample
+  end
 end

data/lib/invisible_captcha/controller_helpers.rb

@@ -2,9 +2,19 @@ module InvisibleCaptcha
   module ControllerHelpers
 
     def check_invisible_captcha
-      head 200 if params[InvisibleCaptcha.fake_field].present?
+      head 200 if invisible_captcha?
     end
 
+    def invisible_captcha?(fake_resource = nil, fake_field = nil)
+      if fake_resource && fake_field
+        return true if params[fake_resource][fake_field].present?
+      else
+        InvisibleCaptcha.fake_fields.each do |field|
+          return true if params[field].present?
+        end
+      end
+      false
+    end
   end
 end
 

data/lib/invisible_captcha/validator.rb

@@ -4,7 +4,7 @@ module InvisibleCaptcha
   class InvisibleCaptchaValidator < ActiveModel::EachValidator
 
     def validate_each(record, attribute, value)
-      if robot_presence?(record, attribute)
+      if invisible_captcha?(record, attribute)
         record.errors.clear
         record.errors[:base] = InvisibleCaptcha.error_message
       end
@@ -12,7 +12,7 @@ module InvisibleCaptcha
 
     private
 
-    def robot_presence?(object, attribute)
+    def invisible_captcha?(object, attribute)
       object.send(attribute).present?
     end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: invisible_captcha
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -75,7 +75,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple spam protection for Rails applications using honeypot strategy.
+description: Simple spam protection for Rails applications using honeypot strategy
+  for better user experience.
 email: srmarc.ai@gmail.com
 executables: []
 extensions: []
@@ -107,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -400465203
+      hash: 260613869
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: