acts_as_textcaptcha 2.2.1 → 2.2.2

data/README.rdoc

@@ -8,59 +8,46 @@ The gem can be configured with your very own logic questions (to fall back on if
 
 Text CAPTCHA's logic questions are aimed at a child's age of 7, so can be solved easily by all but the most cognitively impaired users. As they involve human logic, such questions cannot be solved by a robot.  There are both advantages and disadvantages for using logic questions over image based captchas, {find out more at Text CAPTCHA}[http://textcaptcha.com/why].
   
-== Rails 3
-
-This gem is Rails 3 compatible.
-
 == Demo
 
 Here's a {fully working demo on heroku}[http://textcaptcha.heroku.com]!
 
-== Requirements
-
-What do you need?
+== Installing
 
-* {Rails}[http://github.com/rails/rails] >= 2.3.x  (including Rails 3)
-* {Ruby}[http://ruby-lang.org/] >= 1.8.7 (also tested with REE and Ruby 1.9.2)                                                                                                                      
-* {bcrypt-ruby}[http://bcrypt-ruby.rubyforge.org/] gem (to securely encrypt the spam answers in your session)
-* {Text CAPTCHA api key}[http://textcaptcha.com/register] (_optional_, since you can define your own logic questions, see below for details)             
-* {Rspec2}[http://rspec.info/] (_optional_ if you want to run the tests, requires >= rspec2)
- 
-== Installing            
+=== Rails 3
 
-Install the gem
+Just add the following to your Gemfile, then run `bundle install`;
 
-  gem install acts_as_textcaptcha
+  gem 'acts_as_textcaptcha'
   
+=== Rails 2.3.*
+
+Add the following to your environment.rb file, then install with `gem install acts_as_textcaptcha`;
+
+  config.gem 'acts_as_textcaptcha'
+
+=== As a plugin
+
 Or install as a plugin with
-  
+
   rails plugin install git@github.com:matthutchinson/acts_as_textcaptcha.git
   OR
   script/plugin install git@github.com:matthutchinson/acts_as_textcaptcha.git
-  
+
 If you do decide to install this as a Rails plugin, you'll have to manually include the bcrypt-ruby gem in your Gemfile or environment config. Like so;
-  
+
   gem 'bcrypt-ruby', :require => 'bcrypt'
   OR
   config.gem 'bcrypt-ruby', :lib => 'bcrypt'
-  
-== Using           
-  
-First add the gem to your Gemfile
 
-  gem "acts_as_textcaptcha"
-           
-OR add to your environment.rb config;
+== Setting up
 
-  config.gem 'acts_as_textcaptcha'
-  
-                                                       
-Next configure your models to be spam protected; (this is the most basic way to configure the gem, with an api key only)
+Configure which models are to be spam protected; (this is the most basic way to configure the gem, with an api key only)
 
   class Comment < ActiveRecord::Base
     acts_as_textcaptcha({'api_key' => 'your_textcaptcha_api_key'})
   end          
-               
+
 Next in your controller *new* and *create* actions you'll want to _spamify_ your model and merge in the answers. Like so;
 
   def new
@@ -77,7 +64,7 @@ Next in your controller *new* and *create* actions you'll want to _spamify_ your
       render :action => 'new'
     end
   end       
-      
+
 Finally, in your form/view erb do something like the following;
 
   <%- if @comment.new_record? -%>
@@ -88,10 +75,10 @@ Finally, in your form/view erb do something like the following;
       <%= f.text_field :spam_answer, :value => '' %>
     <%- end -%>
   <%- end -%>
-    
+
 == More Configurations    
 
-You can also configure spam protection in the following ways.
+You can also configure acts_as_textcaptcha in the following ways.
 
 === Hash
 
@@ -110,12 +97,21 @@ You can also configure spam protection in the following ways.
 
 === YAML config
 
-All the above options can be expressed in a {textcaptcha.yml}[http://github.com/matthutchinson/acts_as_textcaptcha/raw/master/config/textcaptcha.yml] file. Drop this into your RAILS_ROOT/config folder.  
+All the above options can be expressed in a {textcaptcha.yml}[http://github.com/matthutchinson/acts_as_textcaptcha/raw/master/config/textcaptcha.yml] file. Drop this into your RAILS_ROOT/config folder.  The gem comes with a handy rake task to copy over a textcaptcha.yml template to your Rails config directory.
+
+rake textcaptcha:generate_config
+
+*NOTE:* If you are on Rails 2.3.*, you'll have to add the following to your Rakefile to make this task available;
 
-=== _Without_ the Text CAPTCHA web service    
+`# 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    
 
 It *also* is possible to configure to use only your own user defined logic questions.  To do so, just ommit the api_key and set at least 1 logic question in your options.
 
+
 == What does the code do?  
                             
 The gem contains two parts, a module for your ActiveRecord models, and a tiny helper method (spamify).
@@ -134,11 +130,43 @@ If the web service fails or no-api key is specified AND no alternate questions a
 
 For more details on the code please check the {documentation}[http://rdoc.info/projects/matthutchinson/acts_as_textcaptcha].
 
-== Rake Tasks
+== Translations
+
+Recent versions of the gem use standard Rails, I18n translation for the 2 possible error messages generated by acts_as_textcaptcha, with a fall-back to a default English error message.  Unfortunately in some versions of Rails 2.3.* the translation fall-back fails.  For this case (and when translating) the translations should be provided in your locale file with the following hierarchy (assuming your model is Comment);
+
+  en:
+    activerecord:
+      errors:
+        models:
+          comment:
+            disabled: "Sorry, adding a %{model} is currently disabled"
+            attributes:
+              spam_answer:
+                incorrect_answer: "is incorrect, try another question instead"
+    activemodel:
+      attributes:
+        comment:
+          spam_answer: "Spam answer"
+
+It should be noted that currently the textcaptcha API service only offers logic questions in English.
+
+== Testing and docs
+
+In development you can run the specs and rdoc tasks like so;
 
 * rake spec (run the rspec2 tests)
 * rake rdoc (generate docs)
 
+== Requirements
+
+What do you need?
+
+* {Rails}[http://github.com/rails/rails] >= 2.3.2  (including Rails 3)
+* {Ruby}[http://ruby-lang.org/] >= 1.8.7 (also tested with REE and Ruby 1.9.2)                                                                                                                      
+* {bcrypt-ruby}[http://bcrypt-ruby.rubyforge.org/] gem (to securely encrypt the spam answers in your session)
+* {Text CAPTCHA api key}[http://textcaptcha.com/register] (_optional_, since you can define your own logic questions, see below for details)             
+* {Rspec2}[http://rspec.info/] (_optional_ if you want to run the tests, requires >= rspec2)
+
 == Links
                                                           
 * {Documentation}[http://rdoc.info/projects/matthutchinson/acts_as_textcaptcha]
@@ -157,7 +185,7 @@ For more details on the code please check the {documentation}[http://rdoc.info/p
 
 == Todo
 
-* Test in other Ruby versions
+* Fix issue with multiple forms open in the same session
 
 == Usage
 

data/Rakefile

@@ -20,4 +20,4 @@ RDoc::Task.new do |rd|
   rd.rdoc_dir = 'doc'
   rd.options  << "--all"
   rd.rdoc_files.include("README.rdoc", "LICENSE", "lib/**/*.rb")
-end
+end

data/acts_as_textcaptcha.gemspec

@@ -20,13 +20,14 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
-  s.add_dependency('rails')
-  s.add_dependency('activerecord')
+
   s.add_dependency('bcrypt-ruby', '~> 2.1.2')
-  
-  s.add_development_dependency('rspec', '~> 2.5.0')
-  s.add_development_dependency('rcov', '~> 0.9.9')
-  s.add_development_dependency('rdoc', '~> 3.5.3')
+
+  s.add_development_dependency('rails')
+  s.add_development_dependency('activerecord')
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rcov')
+  s.add_development_dependency('rdoc')
   s.add_development_dependency('sqlite3')
 end

data/lib/acts_as_textcaptcha/textcaptcha.rb

@@ -16,9 +16,11 @@ end
 
 module ActsAsTextcaptcha
 
-  class Railtie < ::Rails::Railtie
-    rake_tasks do
-      load "tasks/textcaptcha.rake"
+  if Rails.version =~ /^3\./
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load "tasks/textcaptcha.rake"
+      end
     end
   end
 

data/lib/acts_as_textcaptcha/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTextcaptcha
-  VERSION = "2.2.1"
+  VERSION = "2.2.2"
 end

metadata

@@ -1,108 +1,119 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: acts_as_textcaptcha
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.2.2
   prerelease: 
-  version: 2.2.1
 platform: ruby
-authors: 
+authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2011-07-26 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt-ruby
+  requirement: &2152243920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152243920
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2152243500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bcrypt-ruby
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152243500
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2152243040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.1.2
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152243040
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152242620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.5.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2152242620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152242200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.9.9
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2152242200
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2152241780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 3.5.3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2152241780
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2152241360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-description: |-
-  Spam protection for your ActiveRecord models using logic questions and the excellent textcaptcha api. See textcaptcha.com for more details and to get your api key.
-    The logic questions are aimed at a child's age of 7, so can be solved easily by all but the most cognitively impaired users. As they involve human logic, such questions cannot be solved by a robot.
-    For more reasons on why logic questions are useful, see here; http://textcaptcha.com/why
-email: 
+  prerelease: false
+  version_requirements: *2152241360
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2152240940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152240940
+description: ! "Spam protection for your ActiveRecord models using logic questions
+  and the excellent textcaptcha api. See textcaptcha.com for more details and to get
+  your api key.\n  The logic questions are aimed at a child's age of 7, so can be
+  solved easily by all but the most cognitively impaired users. As they involve human
+  logic, such questions cannot be solved by a robot.\n  For more reasons on why logic
+  questions are useful, see here; http://textcaptcha.com/why"
+email:
 - matt@hiddenloop.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - LICENSE
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -123,34 +134,33 @@ files:
 - spec/schema.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/matthutchinson/acts_as_textcaptcha
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Spam protection for your models via logic questions and the excellent textcaptcha.com api
-test_files: 
+summary: Spam protection for your models via logic questions and the excellent textcaptcha.com
+  api
+test_files:
 - spec/acts_as_textcaptcha_spec.rb
 - spec/database.yml
 - spec/schema.rb