acts_as_textcaptcha 1.1.2 → 1.2.0

data/README.rdoc

@@ -1,14 +1,16 @@
 = ActAsTextcaptcha   
 
-Spam protection for your ActiveRecord models using logic questions and the excellent {Text CAPTCHA}[http://textcaptcha.com] service.  
+ActsAsTextcaptcha provides spam protection for your Rails models using logic questions from the excellent {Text CAPTCHA}[http://textcaptcha.com/] web service (by {Rob Tuley}[http://openknot.com/me/] of {Openknot}[http://openknot.com/]).  
 
-ActAsTextcaptcha can *also* be configured with your very own logic questions (to fall back on if the textcaptcha service is down) or as a replacement for the service.  The plugin can also make use of *bcrypt* *encryption*, to store the possible answers in your session (recommended if you are using the default Rails {CookieStore}[http://apidock.com/rails/CGI/Session/CookieStore])
+To get started, {grab an API key for your website}[http://textcaptcha.com/api] and follow along with the instructions below.
+
+The gem can be configured with your very own logic questions (to fall back on if the textcaptcha service is down) or as a replacement for the service.  It also makes use of {bcrypt}[http://bcrypt-ruby.rubyforge.org/] encryption when storing the answers in your session (recommended if you're using the default Rails CookieStore)                   
 
 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].
   
 == Demo
 
-A {fully working demo on heroku}[http://textcaptcha.heroku.com] will be available soon.
+Here's a {fully working demo on heroku}[http://textcaptcha.heroku.com]!
 
 == Requirements
 
@@ -26,23 +28,23 @@ Install the gems
 
   sudo gem install acts_as_textcaptcha bcrypt-ruby
   
-Or you can install it as a Rails plugin 
+Or you can install acts_as_textcaptcha as a Rails plugin 
 
   script/plugin install git://github.com/hiddenloop/acts_as_textcaptcha    
   
 == Using             
            
-First, in your environment.rb file, add the gem to your config like so;
+First, add the gem in your environment.rb file;
 
   config.gem 'acts_as_textcaptcha'
                                                        
-Next configure your models to be spam protected like so; (this is the most basic way to configure the gem, with an api key only)
+Next configure your models 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 the answers. Like so;
+Next in your controller *new* and *create* actions you'll want to _spamify_ your model and merge in the answers. Like so;
 
   def new
     @comment = Comment.new
@@ -67,16 +69,12 @@ Finally, in your form/view erb do something like the following;
     <%= f.label :spam_answer, @comment.spam_question %>
     <%= f.text_field :spam_answer, :value => '' %>
   <%- end -%>
-
-More configurations are available and will be explained here shortly.  If your'e interested now, jump into the code.
     
 == More Configurations    
 
-You can also configure ActAsTextcaptcha in the following ways.
-
-=== Options hash
+You can also configure spam protection in the following ways.
 
-You can configure your models with the following options.
+=== Hash
 
   class Comment < ActiveRecord::Base
     acts_as_textcaptcha({'api_key'     => 'your_textcaptcha_api_key',
@@ -86,45 +84,65 @@ You can configure your models with the following options.
                                            {'question' => 'The green hat is what color?', 'answers' => 'green'}]})
   end 
   
-* *api_key* (from textcaptcha)
+* *api_key* (from Text CAPTCHA)
 * *bcrypt_salt* - used to encrypt valid possible answers in your session (recommended if you are using cookie session storage)  NOTE: this  must be a valid bcrypt salt; for security PLEASE CHANGE THIS, open irb and enter; require 'bcrypt'; BCrypt::Engine.generate_salt
 * *bcrypt_cost* - an optional logarithmic var which determines how computational expensive the bcrypt hash is to calculate (a cost of 4 is twice as much work as a cost of 3 - default is 10)
 * *questions* - an array of question and answer hashes (see above)  A random question from this array will be asked if the textcaptcha web service fails
 
-=== config/textcaptcha.yml
+=== YAML config
 
-The above options can also be expressed in {textcaptcha.yml}[http://github.com/hiddenloop/acts_as_textcaptcha/raw/master/config/textcaptcha.yml] drop this into your Rails config folder.      
+All the above options can be expressed in a {textcaptcha.yml}[http://github.com/hiddenloop/acts_as_textcaptcha/raw/master/config/textcaptcha.yml] file. Drop this into your RAILS_ROOT/config folder.  
 
-It *also* is possible to configure without an api_key, and provide your own logic questions only.
+=== _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?  
                             
-* spam answers are not case-sensitive and left/right white space is trimmed
-* if the textcaptcha service is down, the gem will look for user defined questions defined in the options
-* if no questions are found, AND the service is down no spam protection will take place and the model will be valid
+The gem contains two parts, a module for your ActiveRecord models, and a tiny helper method (spamify).
+
+A call to spamify(@model) in your controller will query the Text CAPTCHA web service.  A restful GET request is made with Net::HTTP and parsed using the standard XML::Parser.  A spam_question is assigned to the model, and an array of possible answers are encrypted in the session.
+
+validate_spam_answer() is called on @model.validate() and checks that the @model.spam_answer matches one of those possible answers in the session.  This validation is _only_ carried out on new records, i.e. never on edit, only on create.  User's attempted spam answers are not case-sensitive and have trailing/leading white-space removed.
+
+{BCrypt}[http://bcrypt-ruby.rubyforge.org] encryption is used to securely store the possible answers in your session.  You must specify a valid bcrypt-salt and (computational) cost in your options.  Without these options possible answers will be MD5-hashed only.
+
+allowed?() and perform_spam_check?() are utility methods (that can be overridden in your model)  They basically act as flags allowing you to control creation of new records, or whether the spam check should be carried out at all.
+
+If an error occurs in loading or parsing the web service XML, ActsAsTextcaptcha will fall back to choose a random logic question defined in your options.  Additionally, if you'd prefer _not_ to use the service at all, you can omit the api_key from your options entirely.  
+
+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.
 
-Will explain more soon, until then examine the code on github or browse the rdocs.
+For more details on the code please check the {documentation}[http://rdoc.info/projects/hiddenloop/acts_as_textcaptcha].
 
-== Rake
+== Rake Tasks
 
 * rake spec (run the tests)
 * rake rcov (run tests showing coverage)
 * rake rdoc (generate docs)
 
-== Credits
+== Links
+                                                          
+* {Documentation}[http://rdoc.info/projects/hiddenloop/acts_as_textcaptcha]
+* {Demo}[http://textcaptcha.heroku.com]
+* {Code}[http://github.com/hiddenloop/acts_as_textcaptcha]
+* {Wiki}[http://wiki.github.com/hiddenloop/acts_as_textcaptcha/]
+* {Bug Tracker}[http://github.com/hiddenloop/acts_as_textcaptcha/issues]
+* {Gem}[http://rubygems.org/gems/acts_as_textcaptcha]   
+* {Code Metrics}[http://getcaliper.com/caliper/project?repo=http%3A%2F%2Frubygems.org%2Fgems%2Facts_as_textcaptcha] (flay, reek, churn etc.)
 
-Who's who?
+== Who's who?
 
-* {ActsAsTextcaptcha}[http://github.com/hiddenloop/acts_as_textcaptcha] authored by {Matthew Hutchinson}[http://matthewhutchinson.net]
+* {ActsAsTextcaptcha}[http://github.com/hiddenloop/acts_as_textcaptcha] and {little robot drawing}[http://www.flickr.com/photos/hiddenloop/4541195635/] by {Matthew Hutchinson}[http://matthewhutchinson.net]
 * {Text CAPTCHA}[http://textcaptcha.com] api and service by {Rob Tuley}[http://openknot.com/me/] at {Openknot}[http://openknot.com]
-* Gem and code kindly hosted at {rubygems.org}[http://rubygems.org/gems/acts_as_textcaptcha] and {github.com}[http://github.com/hiddenloop/acts_as_textcaptcha]
+* {bcrypt-ruby}[http://bcrypt-ruby.rubyforge.org/] Gem by {Coda Hale}[http://codahale.com]
 
 == Usage
 
-This code is currently used in a number of production websites and applications. It was originally extracted from code developed for  {Bugle}[http://bugleblogs.com]
+This code is currently used in a number of production websites and apps. It was originally extracted from code developed for {Bugle}[http://bugleblogs.com]
 
 * {matthewhutchinson.net}[http://matthewhutchinson.net]
 * {pmFAQtory.com}[http://pmfaqtory.com]
 * {The FAQtory}[http://faqtory.heroku.com]
 
-(if you're happily using acts_as_textcaptcha in production, let me know and I'll add your site/app to the list)
+(if you're happily using acts_as_textcaptcha in production, let me know and I'll add you to this list)

data/Rakefile

@@ -9,13 +9,13 @@ task :test    => :spec
 
 desc "Run all specs"
 Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_files = FileList['spec/*_spec.rb']
   t.spec_opts = ['--options', 'spec/spec.opts']
-end 
+end
 
 desc "Run all specs with RCov"
 Spec::Rake::SpecTask.new(:rcov) do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_files = FileList['spec/*_spec.rb']
   t.rcov = true
   t.rcov_opts = ['--exclude', 'spec']
 end
@@ -27,8 +27,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README.rdoc', 'LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end   
-
+end
 
 begin
   require 'jeweler'
@@ -41,8 +40,42 @@ begin
     gemspec.email = "matt@hiddenloop.com"
     gemspec.homepage = "http://github.com/hiddenloop/acts_as_textcaptcha"
     gemspec.authors = ["Matthew Hutchinson"]
-  end           
+    
+    gemspec.add_dependency('bcrypt-ruby', '>= 2.1.2')
+  end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+begin
+  require 'metric_fu'
+  MetricFu::Configuration.run do |config|
+    config.metrics  = [ :churn, :saikuro, :flog, :flay, :reek, :roodi, :rcov ]
+    config.graphs   = [ :flog, :flay, :reek, :roodi, :rcov ]
+    config.flay     = { :dirs_to_flay => ['lib'],
+                        :minimum_score => 75  }
+    config.flog     = { :dirs_to_flog => ['lib']  }
+    config.reek     = { :dirs_to_reek => ['lib']  }
+    config.roodi    = { :dirs_to_roodi => ['lib'] }
+    config.saikuro  = { :output_directory => 'tmp/metric_fu/scratch/saikuro',
+                        :input_directory => ['lib'],
+                        :cyclo => "",
+                        :filter_cyclo => "0",
+                        :warn_cyclo => "5",
+                        :error_cyclo => "7",
+                        :formater => "text" }
+    config.churn    = { :start_date => "1 year ago", :minimum_churn_count => 10 }
+    config.rcov     = { :environment => 'test',
+                        :test_files => ['spec/*_spec.rb'],
+                        :rcov_opts => ["--sort coverage",
+                                       "--no-html",
+                                       "--text-coverage",
+                                       "--no-color",
+                                       "--profile",
+                                       "--rails",
+                                       "--exclude spec"]}
+    config.graph_engine = :bluff
+  end
+rescue LoadError
+  puts "Metric Fu not available. Install it with: sudo gem install metric_fu reek roodi flay googlecharts"
 end

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/acts_as_textcaptcha.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_textcaptcha}
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Hutchinson"]
-  s.date = %q{2010-04-20}
+  s.date = %q{2010-05-05}
   s.description = %q{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}
@@ -52,9 +52,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bcrypt-ruby>, [">= 2.1.2"])
     else
+      s.add_dependency(%q<bcrypt-ruby>, [">= 2.1.2"])
     end
   else
+    s.add_dependency(%q<bcrypt-ruby>, [">= 2.1.2"])
   end
 end
 

data/spec/spec_helper.rb

@@ -1,8 +1,19 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
 require 'rubygems'
 require 'spec'
 require 'active_record'
+require 'spec/autorun'
 
-require 'lib/acts_as_textcaptcha'
+# Uncomment the next line to use webrat's matchers
+#require 'webrat/integrations/rspec-rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+require File.dirname(__FILE__) + '/../lib/acts_as_textcaptcha'
 require File.dirname(__FILE__) + '/../init.rb'
 
 config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Matthew Hutchinson
@@ -14,10 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 +01:00
+date: 2010-05-05 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bcrypt-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id001
 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.