text_captcha 0.1.1

data/README.rdoc

@@ -0,0 +1,89 @@
+= TextCaptcha
+
+A captcha verification for Rails apps, directly integrated into ActiveRecord.
+It uses questions & answers instead of those ugly images.
+
+== Installation
+
+Just run
+
+  gem install text_captcha
+
+== Usage
+
+Just add the validation to your model.
+
+  class Comment < ActiveRecord::Base
+    validates_captcha
+  end
+
+By default the <tt>{:on => :create}</tt> option will be used. You can provide
+any other option you want.
+
+  class Comment < ActiveRecord::Base
+    validates_captcha :if => :new_record?
+  end
+
+  @comment = Comment.new
+
+  @comment.challenge
+  #=> The colour of a red T-shirt is?
+
+  @comment.challenge_answer = "red"
+  @comment.valid?
+  #=> true
+
+Note that you can answer the question without worrying about uppercase/lowercase.
+All strings are normalized before the comparison. So "ReD", "RED" or "red" will
+pass the validation.
+
+You can use TextCaptcha with a non-ActiveRecord class. You just need to
+include the <tt>TextCaptcha::Validation</tt> module.
+
+  class Comment
+    include ActiveModel::Validations
+    include TextCaptcha::Validation
+
+    validates_captcha
+  end
+
+  @comment = Comment.new
+  @comment.valid?
+  #=> false
+
+  @comment.errors[:challenge_answer]
+  #=> ["You need to answer the anti-spam question."]
+
+You can disable TextCaptcha without having to remove all validations.
+This is specially good when running tests.
+
+  TextCaptcha.enabled = false
+
+  class Comment
+    include ActiveModel::Validations
+    include TextCaptcha::Validation
+
+    validates_captcha
+  end
+
+  @comment = Comment.new
+  @comment.valid?
+  #=> true
+
+== To-Do
+
+* Add more questions.
+
+== License
+
+(The MIT License)
+
+Copyright © 2010:
+
+* Nando Vieira - http://nandovieira.com.br
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,48 @@
+require "rcov/rcovtask"
+require "rake/testtask"
+require "rake/rdoctask"
+require "lib/text_captcha/version"
+
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.rcov_opts = ["--sort coverage", "--exclude .gem"]
+
+  t.output_dir = "coverage"
+  t.libs << "test"
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+  t.ruby_opts = %w[-rubygems]
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = "doc"
+  rdoc.title = "TextCaptcha API"
+  rdoc.options += %w[ --line-numbers --inline-source --charset utf-8 ]
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+begin
+  require "jeweler"
+
+  Jeweler::Tasks.new do |gem|
+    gem.name = "text_captcha"
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/text_captcha"
+    gem.authors = ["Nando Vieira"]
+    gem.version = TextCaptcha::Version::STRING
+    gem.summary = "Simple captcha based on plain text questions."
+    gem.files =  FileList["README.rdoc", "{lib,test,locales}/**/*", "Rakefile"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "You need to install jeweler to build this gem."
+end

data/lib/text_captcha.rb

@@ -0,0 +1,33 @@
+require "active_record"
+require "active_support/all"
+
+module TextCaptcha
+  autoload :Validation,  "text_captcha/validation"
+  autoload :Version,  "text_captcha/version"
+
+  class << self
+    # You can disable TextCaptcha without having to remove all validations.
+    # This is specially good when running tests.
+    #
+    #   TextCaptcha.enabled = false
+    #
+    #   class Comment
+    #     include ActiveModel::Validations
+    #     include TextCaptcha::Validation
+    #
+    #     validates_captcha
+    #   end
+    #
+    #   @comment = Comment.new
+    #   @comment.valid?
+    #   #=> true
+    #
+    attr_accessor :enabled
+  end
+
+  # TextCaptcha is enabled by default
+  self.enabled = true
+
+  I18n.load_path += Dir[File.dirname(__FILE__) + "/../locales/**/*.yml"]
+  ::ActiveRecord::Base.send :include, TextCaptcha::Validation
+end

data/lib/text_captcha/config.rb

@@ -0,0 +1,13 @@
+module TextCaptcha
+  def self.configure(&block)
+    yield TextCaptcha::Config
+  end
+
+  class Config
+    class << self
+      attr_accessor :enabled
+      attr_accessor :challenge_attr
+      attr_accessor :answer_attr
+    end
+  end
+end

data/lib/text_captcha/validation.rb

@@ -0,0 +1,124 @@
+module TextCaptcha
+  module Validation
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      # Validate if answer for a captcha question is correct.
+      # If there's no valid user, an error will be attached to
+      # <tt>:challenge_answer</tt> attribute.
+      #
+      #   class Comment < ActiveRecord::Base
+      #     validates_captcha
+      #   end
+      #
+      # By default the <tt>{:on => :create}</tt> options will be used. You can provide
+      # any other option you want.
+      #
+      #   class Comment < ActiveRecord::Base
+      #     validates_captcha :if => :new_record?
+      #   end
+      #
+      #   @comment = Comment.new
+      #
+      #   @comment.challenge
+      #   #=> The colour of a red T-shirt is?
+      #
+      #   @comment.challenge_answer = "red"
+      #   @comment.valid?
+      #   #=> true
+      #
+      # Note that you can answer the question without worrying about uppercase/lowercase.
+      # All strings are normalized before the comparison. So "ReD", "RED" or "red" will
+      # pass the validation.
+      #
+      # You can use TextCaptcha with a non-ActiveRecord class. You just need to
+      # include the <tt>TextCaptcha::Validation</tt> module.
+      #
+      #   class Comment
+      #     include ActiveModel::Validations
+      #     include TextCaptcha::Validation
+      #
+      #     validates_captcha
+      #   end
+      #
+      #   @comment = Comment.new
+      #   @comment.valid?
+      #   #=> false
+      #
+      #   @comment.errors[:challenge_answer]
+      #   #=> ["You need to answer the anti-spam question."]
+      #
+      #
+      def validates_captcha(options = {})
+        attr_accessor :challenge_answer
+        attr_writer :challenge_id
+
+        # Only add default options if class descends from ActiveRecord.
+        # Otherwise, validations won't run because regular classes don't
+        # have save new record status.
+        if self.ancestors.include?(::ActiveRecord::Base)
+          options.reverse_merge!(:on => :create)
+        end
+
+        validate :check_challenge_answer, options
+      end
+    end
+
+    module InstanceMethods
+      # Return an array with the current question and its answers.
+      def current_challenge
+        all_challenges[challenge_id.to_i]
+      end
+
+      # Return the question string.
+      def challenge
+        current_challenge.first
+      end
+
+      # Return all accepted answers.
+      def challenge_answers
+        current_challenge.last
+      end
+
+      # Return the question id. If none is assigned it chooses on
+      # randomly.
+      def challenge_id
+        @challenge_id ||= Kernel.rand(all_challenges.count)
+      end
+
+      # Return all questions.
+      def all_challenges
+        @all_challenges ||= I18n.t("text_captcha.challenges")
+      end
+
+      # Detect if the answer is correct. Will also return true if <tt>TextCaptcha.enabled</tt>
+      # is set to <tt>false</tt>.
+      def valid_challenge_answer?
+        return false unless current_challenge
+        return true unless TextCaptcha.enabled
+
+        answers = challenge_answers.collect {|a| to_captcha(a)}
+        !challenge_answer.blank? && answers.include?(to_captcha(challenge_answer))
+      end
+
+      private
+      # Check if the answer is correct. Add an error to
+      # <tt><:challenge_answer/tt> attribute otherwise.
+      def check_challenge_answer
+        unless valid_challenge_answer?
+          errors.add(:challenge_answer, I18n.t("text_captcha.error_message"))
+        end
+      end
+
+      # Normalize the strings for comparison.
+      def to_captcha(str)
+        str.to_s.squish.downcase
+      end
+    end
+  end
+end

data/lib/text_captcha/version.rb

@@ -0,0 +1,8 @@
+module TextCaptcha
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 1
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  text_captcha:
+    error_message: "You need to answer the anti-spam question."
+    challenges:
+      - - "The colour of a red T-shirt is?"
+        - ["red"]
+      - - "What is two plus two?"
+        - ["4", "four"]
+      - - "Green, tracksuit or elephant: the colour is?"
+        - ["green"]
+      - - "The colour of a blue shark is?"
+        - ["blue"]

data/locales/pt.yml

@@ -0,0 +1,13 @@
+pt: &PT
+  text_captcha:
+    error_message: "Você precisa responder a pergunta anti-spam corretamente."
+    challenges:
+      - - Quanto é 2 + 2?
+        - ["4", "quatro"]
+      - - Que dia vem depois de sábado?
+        - ["domingo"]
+      - - Quantas horas tem 1 dia?
+        - ["24"]
+
+pt-BR:
+  <<: *PT

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "rubygems"
+gem "test-unit"
+require "test/unit"
+require "mocha"
+
+require "text_captcha"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do
+  end
+
+  create_table :accounts do
+  end
+end

data/test/text_captcha_test.rb

@@ -0,0 +1,93 @@
+require "test_helper"
+
+class User < ActiveRecord::Base
+  validates_captcha
+end
+
+class Account < ActiveRecord::Base
+  validates_captcha :on => :save
+end
+
+class Comment
+  include ActiveModel::Validations
+  include TextCaptcha::Validation
+
+  validates_captcha
+end
+
+class TextCaptchaTest < Test::Unit::TestCase
+  def setup
+    I18n.locale = :en
+    TextCaptcha.enabled = true
+    @user = User.new
+    @account = Account.new
+  end
+
+  def test_enabled_option
+    assert_respond_to TextCaptcha, :enabled
+  end
+
+  def test_skip_captcha_validation_when_is_disabled
+    TextCaptcha.enabled = false
+    assert @user.valid?
+  end
+
+  def test_return_all_challenges
+    assert_equal I18n.t("text_captcha.challenges"), @user.all_challenges
+  end
+
+  def test_randomly_choose_challenge_id
+    assert_kind_of Numeric, @user.challenge_id
+  end
+
+  def test_keep_previously_selected_challenge
+    id = @user.challenge_id
+    assert_equal id, @user.challenge_id
+  end
+
+  def test_select_a_new_challenge
+    Kernel.expects(:rand).twice.with(@user.all_challenges.count).returns(100, 101)
+
+    assert_equal 100, @user.challenge_id
+    @user.challenge_id = nil
+    assert_equal 101, @user.challenge_id
+  end
+
+  def test_return_challenge
+    assert_not_nil @user.challenge
+  end
+
+  def test_require_captcha_answer
+    assert !@user.valid?
+    assert_equal I18n.t("text_captcha.error_message"), @user.errors[:challenge_answer].to_s
+  end
+
+  def test_accept_valid_answer
+    @user.challenge_answer = @user.challenge_answers.first
+    assert @user.valid?
+  end
+
+  def test_respect_on_create_option
+    @user.challenge_answer = @user.challenge_answers.first
+    assert @user.save
+    assert @user.valid?
+  end
+
+  def test_respect_on_save_option
+    @account.challenge_answer = @account.challenge_answers.first
+    assert @account.save
+
+    @account.challenge_answer = nil
+    @account.challenge_id = nil
+
+    assert !@account.valid?
+    assert_equal I18n.t("text_captcha.error_message"), @account.errors[:challenge_answer].to_s
+  end
+
+  def test_extend_any_object
+    @comment = Comment.new
+    assert_not_nil @comment.challenge
+    assert !@comment.valid?
+    assert_equal I18n.t("text_captcha.error_message"), @comment.errors[:challenge_answer].to_s
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: text_captcha
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-17 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/text_captcha.rb
+- lib/text_captcha/config.rb
+- lib/text_captcha/validation.rb
+- lib/text_captcha/version.rb
+- locales/en.yml
+- locales/pt.yml
+- test/config_test.rb
+- test/test_helper.rb
+- test/text_captcha_test.rb
+has_rdoc: true
+homepage: http://github.com/fnando/text_captcha
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Simple captcha based on plain text questions.
+test_files: 
+- test/config_test.rb
+- test/test_helper.rb
+- test/text_captcha_test.rb