nice_text_captcha 0.1.1 → 0.1.2

data/README.markdown

@@ -0,0 +1,100 @@
+Nice Text Captcha
+=================
+
+by Neil Smith
+
+About
+-----
+
+This generates text-based CATPCHAs that are "nice", by my own personal
+subjective definition!
+
+Questions are purposely simple, and examples would include:
+
+* How many letters are there in the word 'White'?
+* In the word "tiger", what is the letter in the 5th position?
+* How many animals are in the words: "cat", 'Orange', and "dolphin"?
+* What is 'four' + "nine"?
+
+Why Another CAPTCHA Solution?
+-----------------------------
+
+There are plenty of choices out there, but none quite met my personal needs (or
+some client's needs) for one reason or another:
+
+* I wanted a self-contained solution that wasn't reliant on a 3rd party service
+* Relatedly, I didn't want to have to muck around with API keys to get it working
+* I wanted a few different question types, not just simple maths-based ones
+* I didn't want long/odd words and case that make the question difficult to
+  understand at first glance (so no "What's the first adverb in the list
+	discombobulation, deFeNEStraTE, DiscOncErTinGly, DiSiNTEGRATing. Enter the
+	name of a good Jack Black film if you don't think there are any adverbs. Enter
+	a surprising fact about cheese if you don't think Jack Black has done any
+	good films.")
+
+Implementation
+--------------
+
+You call a method in your view which both generates a random question, and places
+the possible answers into a flash[] object, stored in a SHA2 hash.
+
+(It's stored in a flash, as Rails handles ageing the data after a request - if we
+used the session, it would hang around for the duration of the session.)
+
+Then, in your controller action, you call a method which extracts the answers from
+the flash, and injects them into your model.
+
+A validation method on the model finally checks the answer against the hashed
+possible answers, and pushes an error onto the base of your model if the answer
+doesn't match.
+
+For numerical answers ("What is 'two' plus 'three'?"), both numbers ("3") and
+words ("three") are accepted.
+
+Requirements
+------------
+
+* Tested against Rails 2.3 - currently untested against Rails 3.
+* 'linguistics' gem for turning numbers into words and ordinals (gem install linguistics)
+* 'Digest/SHA2' for hashing the possible answers.
+
+Installation
+------------
+
+Simply add:
+
+    config.gem 'nice_text_captcha'
+
+to your environment.rb file, and install the gem via your preferred method.
+
+Usage Instructions
+------------------
+
+In your model, you need to add some validation:
+
+    class Thing < ActiveRecord::Base
+      validate :check_nice_text_captcha
+    end
+
+In your controller, you need to add a call to populate the answers from the
+data in the session:
+
+    class ThingsController < ActiveRecord::Base
+      def create
+        @thing = Thing.new(params[:thing]) # as normal
+        validate_nice_text_captcha_for(@thing)
+      end
+    end
+
+Finally, in your view, you need to render the question by calling nice_text_captcha,
+and give the user a text box for their answer:
+
+    <% form_for(@thing) do |f| %>
+      <!-- normal form elements here -->
+      
+      <%= f.nice_text_captcha %> <!-- this will generate a label with the catcha text inside -->
+      <%= f.text_field :nice_text_captcha %>
+      
+      <!-- probably a submit button here -->
+      
+    <% end %>

data/lib/nice_text_captcha.rb

@@ -1,4 +1,3 @@
-#config.gem "linguistics"
 require 'linguistics'
 Linguistics::use(:en)
 
@@ -9,13 +8,17 @@ require 'nice_text_captcha/action_controller_extensions'
 require 'nice_text_captcha/form_builder_extensions'
 
 require 'nice_text_captcha/types/default_question'
+require 'nice_text_captcha/types/fixed_question'
 require 'nice_text_captcha/types/letter_position_question'
 require 'nice_text_captcha/types/maths_question'
 require 'nice_text_captcha/types/word_length_question'
 require 'nice_text_captcha/types/words_in_list_question'
 
+# Mix in form builder helper
 ActionView::Helpers::FormBuilder.send :include, NiceTextCaptcha::FormBuilderExtensions
 
+# Mix in validation
 ActiveRecord::Base.send :include, NiceTextCaptcha::ActiveRecordExtensions
 
+# Mix in controller-controlled validation
 ActionController::Base.send :include, NiceTextCaptcha::ActionControllerExtensions

data/lib/nice_text_captcha/captcha.rb

@@ -5,13 +5,16 @@ module NiceTextCaptcha
     attr_reader :question
     attr_reader :answers
    
+    NICE_TEXT_CAPTCHA_TYPE_DEFAULTS = [
+      Types::FixedQuestion,
+      Types::MathsQuestion,
+      Types::LetterPositionQuestion,
+      Types::WordsInListQuestion,
+      Types::WordLengthQuestion,
+    ]
+   
     def initialize
-      captcha = [
-        Types::MathsQuestion,
-        Types::LetterPositionQuestion,
-        Types::WordsInListQuestion,
-        Types::WordLengthQuestion,
-      ].rand.new
+      captcha = (NICE_TEXT_CAPTCHA_TYPES rescue NICE_TEXT_CAPTCHA_TYPE_DEFAULTS).rand.new
       @question = captcha.question
       @answers = captcha.answers
     end

data/lib/nice_text_captcha/types/fixed_question.rb

@@ -0,0 +1,25 @@
+class NiceTextCaptcha::Types::FixedQuestion < NiceTextCaptcha::Types::DefaultQuestion
+  
+  def initialize
+    question = random_question
+    @question = question.first
+    @answers = question.last
+  end
+
+private
+  
+  def random_question
+    [
+      ["Is water wet or dry?", ["wet"]],
+      ["Is snow hot or cold?", ["cold"]],
+      ["Do dogs have tails?", ["yes", "y"]],
+      ["How many noses have you got?", ["1", "one"]],
+      ["Are elephants big or small?", ["big"]],
+      ["How many legs has a cat got?", ["4", "four"]],
+      ["Do shoes go on your hands or your feet?", ["feet", "your feet"]],
+    ].rand
+  end
+    
+end
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nice_text_captcha
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Neil Smith
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 +01:00
+date: 2010-10-12 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -26,27 +26,28 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.markdown
 files: 
-- README
+- README.markdown
 - lib/nice_text_captcha/action_controller_extensions.rb
 - lib/nice_text_captcha/active_record_extensions.rb
 - lib/nice_text_captcha/captcha.rb
 - lib/nice_text_captcha/form_builder_extensions.rb
 - lib/nice_text_captcha/types/default_question.rb
+- lib/nice_text_captcha/types/fixed_question.rb
 - lib/nice_text_captcha/types/letter_position_question.rb
 - lib/nice_text_captcha/types/maths_question.rb
 - lib/nice_text_captcha/types/word_length_question.rb
 - lib/nice_text_captcha/types/words_in_list_question.rb
 - lib/nice_text_captcha.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/smugx/nice_text_captcha
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- README
+- README.markdown
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README

@@ -1,73 +0,0 @@
-Nice Text Captcha
-by Neil Smith
-
-About
------
-
-This generates text-based CATPCHAs that are "nice", by my own personal
-subjective definition!
-
-Questions are purposely simple, and examples would include:
-
-* How many letters are there in the word 'White'?
-* In the word "tiger", what is the letter in the 5th position?
-* How many animals are in the words: "cat", "orange", and "dolphin"?
-* What is 'four' + "nine"?
-
-Implementation
---------------
-
-You call a method in your view which both generates a random question, and places
-the possible answers into a flash[] object, stored in a SHA2 hash.
-
-(It's stored in a flash, as Rails handles ageing the data after a request - if we
-used the session, it would hang around for the duration of the session.)
-
-Then, in your controller action, you call a method which extracts the answers from
-the flash, and injects them into your model.
-
-A validation method on the model finally checks the answer against the hashed
-possible answers, and pushes an error onto the base of your model if the answer
-doesn't match.
-
-For numerical answers ("What is 'two' plus 'three'?"), both numbers ("3") and
-words ("three") are accepted.
-
-Requirements
-------------
-
-Tested against Rails 2.3 - currently untested against Rails 3.
-'linguistics' gem for turning numbers into words and ordinals.
-'Digest/SHA2' for hashing the possible answers.
-
-Instructions
-------------
-
-In your model, you need to add some validation:
-
-class Thing < ActiveRecord::Base
-  validate :check_nice_text_captcha
-end
-
-In your controller, you need to add a call to populate the answers from the
-data in the session:
-
-class ThingsController < ActiveRecord::Base
-  def create
-		@thing = Thing.new(params[:thing]) # as normal
-		validate_nice_text_captcha_for(@thing)
-	end
-end
-
-Finally, in your view, you need to render the question by calling nice_text_captcha,
-and give the user a text box for their answer:
-
-<% form_for(@thing) do |f| %>
-  <!-- normal form elements here -->
-
-	<%= f.nice_text_captcha %><br />
-	<%= f.text_field :nice_text_captcha %><br />
-	
-	<!-- probably a submit button here -->
-
-<% end %>