acts_as_textcaptcha 3.0.0 → 3.0.1

data/README.rdoc

@@ -81,6 +81,15 @@ Finally, in your form view add the spam question and answer fields using the tex
 
 *NOTE:* If you'd rather NOT use this helper and prefer to write all your own view code, see the html produced from the textcaptcha_fields method in the gem source code.
 
+=== Toggling Textcaptcha
+
+You can toggle textcaptcha on/off for your models by overriding the `perform_textcaptcha?` method. If you overridde it to return false, no questions will be fetched from
+the web service and textcaptcha validation is not performed. Additionally the `textcaptcha_fields` form helper will render nothing.  This is useful for writing your own
+logic to disable spam protection for logged in users etc.
+
+For flexibility you can also use a `skip_textcaptcha` attribute (protected from mass-assignment) to skip the textcaptcha validation step only. This is helpful when you
+need to bypass spam protection after a question has been generated and `perform_textcaptcha?` is true.
+
 == More Configurations
 
 The gem can be configured for models individually (as shown above) or with a config/textcaptcha.yml file for the whole app.  A config must have a valid bcrypt_salt, and an api_key and/or an array of questions defined.
@@ -104,14 +113,14 @@ The gem can be configured for models individually (as shown above) or with a con
 
 The gem comes with a handy rake task to copy over a {textcaptcha.yml}[http://github.com/matthutchinson/acts_as_textcaptcha/raw/master/config/textcaptcha.yml] template to your Rails config directory.  It will also generate a random BCrypt Salt when you first run it.
 
-rake textcaptcha:config
+  rake textcaptcha:config
 
 *NOTE:* If you are on Rails 2.3.*, you'll have to add the following to your Rakefile to make this task available;
 
-`# load textcaptcha rake tasks
-Dir["#{Gem.searcher.find('acts_as_textcaptcha').full_gem_path}/lib/tasks/**/*.rake"].each { |ext| load ext } if Gem.searcher.find('acts_as_textcaptcha')`
+  # load textcaptcha rake tasks
+  Dir["#{Gem.searcher.find('acts_as_textcaptcha').full_gem_path}/lib/tasks/**/*.rake"].each { |ext| load ext } if Gem.searcher.find('acts_as_textcaptcha')
 
-=== Using _without_ the Text CAPTCHA web service
+=== Confguring _without_ the Text CAPTCHA web service
 
 To use only your own logic questions simply ommit the api_key from your config and define at least 1 logic question/answer.
 
@@ -150,8 +159,6 @@ A call to @model.textcaptcha in your controller will query the Text CAPTCHA web
 
 validate_textcaptcha is called on @model.validate and checks that the @model.spam_answer matches one of the possible answers (decrypted).  This validation is _only_ carried out on new records, i.e. never on edit, only on create.  All attempted spam answers are case-insensitive and have trailing/leading white-space removed.
 
-perform_textcaptcha? is a simple utility method (that can be overridden in your model)  It allows you to define whether the spam check should be carried out at all.  For example, to turn off spam checking for logged in users.
-
 If an error or timeout occurs in loading or parsing the API, ActsAsTextcaptcha will fall back to choose a random logic question defined in your options.  If the web service fails or no API key is specified AND no alternate questions are configured, the @model will not require spam checking and will pass as valid.
 
 For more details on the code please check the {documentation}[http://rdoc.info/projects/matthutchinson/acts_as_textcaptcha].  Tests are written with  {MiniTest}[https://rubygems.org/gems/minitest] and code coverage is provided by {SimpleCov}[https://github.com/colszowka/simplecov]

data/lib/acts_as_textcaptcha/textcaptcha.rb

@@ -31,8 +31,16 @@ module ActsAsTextcaptcha
 
     def acts_as_textcaptcha(options = nil)
       cattr_accessor :textcaptcha_config
-      attr_accessor  :spam_question, :spam_answers, :spam_answer
-      attr_protected :spam_question if respond_to?(:accessible_attributes) && accessible_attributes.nil?
+      attr_accessor  :spam_question, :spam_answers, :spam_answer, :skip_textcaptcha
+
+      if respond_to?(:accessible_attributes)
+        if accessible_attributes.nil?
+          attr_protected :spam_question
+          attr_protected :skip_textcaptcha
+        else
+          attr_accessible :spam_answer, :spam_answers
+        end
+      end
 
       validate :validate_textcaptcha
 
@@ -52,7 +60,7 @@ module ActsAsTextcaptcha
 
     module InstanceMethods
 
-      # override this method to toggle textcaptcha spam checking, default is on (true)
+      # override this method to toggle textcaptcha spam checking altogether, default is on (true)
       def perform_textcaptcha?
         true
       end
@@ -121,7 +129,7 @@ module ActsAsTextcaptcha
       def validate_textcaptcha
         # only spam check on new/unsaved records (ie. no spam check on updates/edits)
         if !respond_to?('new_record?') || new_record?
-          if perform_textcaptcha? && !validate_spam_answer
+          if !skip_textcaptcha && perform_textcaptcha? && !validate_spam_answer
             errors.add(:spam_answer, :incorrect_answer, :message => "is incorrect, try another question instead")
             # regenerate question
             textcaptcha

data/lib/acts_as_textcaptcha/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTextcaptcha
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/test/textcaptcha_test.rb

@@ -60,6 +60,17 @@ describe 'Textcaptcha' do
       @contact.valid?.must_equal true
       @contact.errors[:spam_answer].must_be_empty
     end
+
+    it 'should allow validation to be skipped' do
+      @note.valid?.must_equal false
+      @note.skip_textcaptcha = true
+      @note.valid?.must_equal true
+    end
+
+    it 'should protect skip_textcaptcha attribute from mass assignment' do
+      @contact = Contact.new(:skip_textcaptcha => true)
+      @contact.skip_textcaptcha.must_equal nil
+    end
   end
 
   describe 'encryption' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_textcaptcha
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-06 00:00:00.000000000 +01:00
+date: 2011-08-07 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
-  requirement: &2156333440 !ruby/object:Gem::Requirement
+  requirement: &2164674040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *2156333440
+  version_requirements: *2164674040
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2156333020 !ruby/object:Gem::Requirement
+  requirement: &2164673620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156333020
+  version_requirements: *2164673620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156332560 !ruby/object:Gem::Requirement
+  requirement: &2164673160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156332560
+  version_requirements: *2164673160
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2156332140 !ruby/object:Gem::Requirement
+  requirement: &2164672740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156332140
+  version_requirements: *2164672740
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2156331720 !ruby/object:Gem::Requirement
+  requirement: &2164672320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156331720
+  version_requirements: *2164672320
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2156331300 !ruby/object:Gem::Requirement
+  requirement: &2164671900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156331300
+  version_requirements: *2164671900
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2156330880 !ruby/object:Gem::Requirement
+  requirement: &2164671480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156330880
+  version_requirements: *2164671480
 description: ! "Simple question/answer based spam protection for your Rails models.\n
   \ You can define your own logic questions and/or fetch questions from the textcaptcha.com
   API.\n  The questions involve human logic and are tough for spam bots to crack.\n