nice_text_captcha 0.1.0

data/README

@@ -0,0 +1,73 @@
+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 %>

data/lib/nice_text_captcha.rb

@@ -0,0 +1,21 @@
+#config.gem "linguistics"
+require 'linguistics'
+Linguistics::use(:en)
+
+require 'nice_text_captcha/captcha'
+
+require 'nice_text_captcha/active_record_extensions'
+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/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'
+
+ActionView::Helpers::FormBuilder.send :include, NiceTextCaptcha::FormBuilderExtensions
+
+ActiveRecord::Base.send :include, NiceTextCaptcha::ActiveRecordExtensions
+
+ActionController::Base.send :include, NiceTextCaptcha::ActionControllerExtensions

data/lib/nice_text_captcha/action_controller_extensions.rb

@@ -0,0 +1,11 @@
+module NiceTextCaptcha
+  
+  module ActionControllerExtensions
+    
+    def validate_nice_text_captcha_for(obj)
+      obj.nice_text_captcha_responses = flash[:nice_text_captcha_responses] || ["no_answers_in_session"]
+    end
+    
+  end
+  
+end

data/lib/nice_text_captcha/active_record_extensions.rb

@@ -0,0 +1,31 @@
+module NiceTextCaptcha
+  
+  module ActiveRecordExtensions
+    
+    attr_accessor :nice_text_captcha
+    attr_accessor :nice_text_captcha_responses
+    
+    def check_nice_text_captcha
+      
+      captcha_successful = @nice_text_captcha_responses.nil?
+      @nice_text_captcha_responses.each do |response|
+        captcha_successful = true if Captcha.hash(self.class.to_s.underscore, @nice_text_captcha.strip.downcase) == response
+      end if @nice_text_captcha_responses
+      
+      if !captcha_successful
+        errors.add_to_base(nice_text_captcha_failure_message)
+      end
+
+      @nice_text_captcha = nil
+        
+    end
+    
+protected
+
+    def nice_text_captcha_failure_message
+      "Please ensure you answer the security question (CAPTCHA) correctly"
+    end
+    
+  end
+  
+end

data/lib/nice_text_captcha/captcha.rb

@@ -0,0 +1,30 @@
+module NiceTextCaptcha
+  
+  class Captcha
+   
+    attr_reader :question
+    attr_reader :answers
+   
+    def initialize
+      captcha = [
+        Types::MathsQuestion,
+        Types::LetterPositionQuestion,
+        Types::WordsInListQuestion,
+        Types::WordLengthQuestion,
+      ].rand.new
+      @question = captcha.question
+      @answers = captcha.answers
+    end
+    
+    def encrypted_answers_for(object_name)
+      answers.collect { |answer| Captcha.hash(object_name, answer) }
+    end
+
+    def self.hash(obj, answer)
+      str = obj.to_s + answer.to_s + ActionController::Base.session_options[:secret].to_s
+      Digest::SHA2.hexdigest(str)
+    end
+    
+  end
+  
+end

data/lib/nice_text_captcha/form_builder_extensions.rb

@@ -0,0 +1,13 @@
+module NiceTextCaptcha
+  
+  module FormBuilderExtensions
+    
+    def nice_text_captcha
+      captcha = NiceTextCaptcha::Captcha.new
+      @template.flash[:nice_text_captcha_responses] = captcha.encrypted_answers_for(@object_name)
+      captcha.question
+    end
+    
+  end
+  
+end

data/lib/nice_text_captcha/types/default_question.rb

@@ -0,0 +1,42 @@
+module NiceTextCaptcha::Types
+  class DefaultQuestion
+
+    ANIMALS = ["dog", "cat", "dolphin", "mouse", "horse", "penguin", "panda", "tiger", "lion", "zebra"]
+    COLOURS = ["black", "white", "red", "green", "blue", "pink", "purple", "orange", "yellow", "brown"]
+
+    attr_reader :question
+    attr_reader :answers
+
+  private
+
+    def fifty_fifty?
+      rand(2) == 0
+    end
+
+    def number_to_word(number)
+      number.to_i.en.numwords
+    end
+
+    def number_to_ordinal(number)
+      number.to_i.en.ordinal
+    end
+  
+    def randomly_quote(word)
+      q = ["'", "\""].rand
+      q + word + q
+    end
+  
+    def randomly_capitalise(word)
+      fifty_fifty? ? word : word.capitalize
+    end
+  
+    def randomly_quote_and_capitalise(word)
+      randomly_quote(randomly_capitalise(word))
+    end
+  
+    def randomly_sort(list)
+      list.sort { |x,y| rand(100) <=> rand(100) }
+    end  
+
+  end
+end

data/lib/nice_text_captcha/types/letter_position_question.rb

@@ -0,0 +1,32 @@
+class NiceTextCaptcha::Types::LetterPositionQuestion < NiceTextCaptcha::Types::DefaultQuestion
+  
+  def initialize
+    word = [ANIMALS + COLOURS].flatten.rand
+    position = rand(word.length) + 1
+    answer = word[position - 1, 1]
+    
+    position_string = number_to_ordinal(position)
+    
+    position_string = "first" if position == 1 and fifty_fifty?
+    position_string = "second" if position == 2 and fifty_fifty?
+    position_string = (fifty_fifty? ? "final" : "last") if position == word.length and fifty_fifty?
+    position_string = "second to last" if position == word.length - 1 and fifty_fifty?
+    
+    @question = format_question(randomly_quote_and_capitalise(word), position_string)
+    @answers = [answer]
+  end
+  
+  def format_question(word, position)
+    [
+      "What is the %s letter in the word %s?" % [position, word],
+      "What's the %s letter in the word %s?" % [position, word],
+      "The %s letter in %s is what?" % [position, word],
+      "The %s letter in the word %s is?" % [position, word],
+      "In the word %s, what is the %s letter?" % [word, position],
+      "In the word %s, what is the letter in the %s position?" % [word, position],
+    ].rand
+  end
+  
+private
+  
+end

data/lib/nice_text_captcha/types/maths_question.rb

@@ -0,0 +1,36 @@
+class NiceTextCaptcha::Types::MathsQuestion < NiceTextCaptcha::Types::DefaultQuestion
+  
+  def initialize
+    number_1 = one_to_nine
+    number_2 = one_to_nine
+    answer = number_1 + number_2
+    
+    @question = format_question(number_or_word(number_1), number_or_word(number_2))
+    @answers = [answer, number_to_word(answer)]
+  end
+  
+  def format_question(one, two)
+    [
+      "What is %s plus %s?" % [one, two],
+      "What is %s + %s?" % [one, two],
+      "What is %s added to %s?" % [one, two],
+      "What do you get if you add the numbers %s and %s?" % [one, two],
+      "What is the result of adding %s and %s?" % [one, two],
+    ].rand
+  end
+  
+private
+
+  def one_to_nine
+    rand(9) + 1
+  end
+  
+  def number_or_word(number)
+    if fifty_fifty?
+      number
+    else
+      randomly_quote_and_capitalise(number_to_word(number))
+    end
+  end
+    
+end

data/lib/nice_text_captcha/types/word_length_question.rb

@@ -0,0 +1,20 @@
+class NiceTextCaptcha::Types::WordLengthQuestion < NiceTextCaptcha::Types::DefaultQuestion
+  
+  def initialize
+    word = [ANIMALS + COLOURS].flatten.rand
+    answer = word.length
+    
+    @question = format_question(randomly_quote_and_capitalise(word))
+    @answers = [answer, number_to_word(answer)]
+  end
+  
+  def format_question(word)
+    [
+      "How many letters are in the word %s?" % word,
+      "How many letters are there in the word %s?" % word,
+      "How many letters are there in %s?" % word,
+      "In the word %s, how many letters are there?" % word,
+    ].rand
+  end
+    
+end

data/lib/nice_text_captcha/types/words_in_list_question.rb

@@ -0,0 +1,38 @@
+class NiceTextCaptcha::Types::WordsInListQuestion < NiceTextCaptcha::Types::DefaultQuestion
+  
+  def initialize
+    animals = randomly_sort(ANIMALS)
+    colours = randomly_sort(COLOURS)
+    
+    answer = rand(3) + 1
+    
+    if fifty_fifty?
+      words = animals[0 .. answer-1]
+      words << colours[0 .. rand(3)]
+      noun = "animals"
+    else
+      words = colours[0 .. answer-1]
+      words << animals[0 .. rand(3)]
+      noun = "colours"
+    end
+
+    words.flatten!
+    words.collect! { |w| randomly_quote_and_capitalise(w) }
+    
+    @question = format_question(noun, randomly_sort(words))
+    
+    @answers = [answer, number_to_word(answer)]
+  end
+  
+  def format_question(noun, word_list)
+    collective_noun = ["list", "words", "list of words", "word list"].rand
+    collective_noun = "following " + collective_noun if fifty_fifty?
+
+    [
+      "How many %s are in the %s: %s?" % [noun, collective_noun, word_list.to_sentence],
+      "How many %s are there in the %s: %s?" % [noun, collective_noun, word_list.to_sentence],
+      "In the %s: %s - how many %s are there?" % [collective_noun, word_list.to_sentence, noun],
+    ].rand
+  end
+      
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: nice_text_captcha
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Neil Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-06 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: neil.jx.smith@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- 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/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: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generates Text Catpchas, that are 'nice' by my own personal definition!
+test_files: []
+