karsthammer-validates_captcha 0.9.5a

data/lib/validates_captcha/test_case.rb

@@ -0,0 +1,12 @@
+require 'active_support/test_case'
+
+module ValidatesCaptcha #:nodoc:
+  class TestCase < ActiveSupport::TestCase #:nodoc:
+    def assert_greater_than(expected, size, message = '')
+      _wrap_assertion do
+        full_message = build_message(message, "<?> expected to be greater than <?>.", size, expected)
+        assert_block(full_message) { size > expected }
+      end
+    end
+  end
+end

data/lib/validates_captcha/version.rb

@@ -0,0 +1,9 @@
+module ValidatesCaptcha #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 9
+    TINY = 5
+ 
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rails/init.rb

@@ -0,0 +1,29 @@
+require 'validates_captcha'
+
+config.after_initialize do
+  ::ActiveRecord::Base.send :include, ValidatesCaptcha::ModelValidation
+  ::ActionController::Base.send :include, ValidatesCaptcha::ControllerValidation
+  ::ActionView::Base.send :include, ValidatesCaptcha::FormHelper
+  ::ActionView::Helpers::FormBuilder.send :include, ValidatesCaptcha::FormBuilder
+end
+
+module ::ValidatesCaptcha
+  class MiddlewareWrapper
+    RECOGNIZED_RESPONSE_STATUS_CODES = [200, 422].freeze
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      result = ValidatesCaptcha.provider.call(env)
+      
+      return @app.call(env) unless RECOGNIZED_RESPONSE_STATUS_CODES.include?(result.first)
+      
+      result
+    end
+  end
+end
+
+config.middleware.use ::ValidatesCaptcha::MiddlewareWrapper
+

data/tasks/static_image_tasks.rake

@@ -0,0 +1,33 @@
+require 'validates_captcha'
+
+namespace :validates_captcha do
+  desc "Create 3 static captcha images in RAILS_ROOT/public/images/captchas/, specify a different number with COUNT=n"  
+  task :create_static_images => [:create_static_image_dir, :clear_static_image_dir] do  
+    count = ENV['COUNT'] ? ENV['COUNT'].to_i : 3
+    
+    count.times do
+      path, code = ValidatesCaptcha::Provider::StaticImage.create_image
+      puts "Created #{path} with code #{code}"
+    end
+  end
+  
+  task :create_static_image_dir => :environment do
+    image_dir = ValidatesCaptcha::Provider::StaticImage.filesystem_dir
+    
+    unless File.exist?(image_dir)
+      FileUtils.mkdir_p image_dir
+      puts "Created directory #{image_dir}"
+    end
+  end
+  
+  task :clear_static_image_dir => :environment do
+    image_dir = ValidatesCaptcha::Provider::StaticImage.filesystem_dir
+    image_files = Dir[File.join(image_dir, '*')]
+    
+    if image_files.any?
+      FileUtils.rm image_files
+      puts "Cleared directory #{image_dir}"
+    end
+  end
+end
+

data/test/cases/controller_validation_test.rb

@@ -0,0 +1,222 @@
+require 'test_helper'
+require 'action_controller'
+
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+end
+
+class WidgetsController < ActionController::Base
+  include ValidatesCaptcha::ControllerValidation
+  
+  validates_captcha :except => [:update, :save, :persist, :bingo]
+  validates_captcha_of :widgets, :only => :update
+  validates_captcha_of Widget, :only => [:save, :persist]
+  
+  def create
+    begin
+      Widget.new.save!
+    rescue ActiveRecord::RecordInvalid
+      @invalid = true
+    end
+    
+    render :nothing => true
+  end
+  
+  def update
+    begin
+      Widget.new.save!
+    rescue ActiveRecord::RecordInvalid
+      @invalid = true
+    end
+    
+    render :nothing => true
+  end
+  
+  def save
+    begin
+      Widget.create! params['widget']
+    rescue ActiveRecord::RecordInvalid
+      @invalid = true
+    end
+
+    render :nothing => true
+  end
+  
+  def store
+    begin
+      Widget.create! params['widget']
+    rescue ActiveRecord::RecordInvalid
+      @invalid = true
+    end
+
+    render :nothing => true
+  end
+  
+  def persist
+    begin
+      Widget.create! params['widget']
+    rescue ActiveRecord::RecordInvalid
+      @invalid = true
+    end
+
+    render :nothing => true
+  end
+  
+  def bingo
+    begin
+      Widget.new.save!
+    rescue ActiveRecord::RecordInvalid
+      @invalid = true
+    end
+    
+    render :nothing => true
+  end
+end
+
+class ControllerValidationTest < ActionController::TestCase
+  tests WidgetsController
+  
+  def with_dynamic_image_provider(&block)
+    old_provider = ValidatesCaptcha.provider
+    provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::DynamicImage.new
+    yield provider
+    ValidatesCaptcha.provider = old_provider
+  end
+  
+  def with_static_image_provider(&block)
+    old_provider = ValidatesCaptcha.provider
+    provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::StaticImage.new
+    provider.instance_variable_set "@images", ["/path/to/#{provider.send(:encrypt, 'hello')}#{provider.send(:image_file_extension)}"]
+    yield provider
+    ValidatesCaptcha.provider = old_provider
+  end
+  
+  def with_question_provider(&block)
+    old_provider = ValidatesCaptcha.provider
+    provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::Question.new
+    yield provider
+    ValidatesCaptcha.provider = old_provider
+  end
+  
+  test "defines a class level #validates_captcha method" do
+    assert_respond_to WidgetsController, :validates_captcha
+  end
+  
+  test "defines a class level #validates_captcha_of method" do
+    assert_respond_to WidgetsController, :validates_captcha_of
+  end
+  
+  test "calling #create method of controller should assign @invalid" do
+    post :create
+    assert_not_nil assigns(:invalid)
+  end
+  
+  test "calling #update method of controller should assign @invalid" do
+    post :update
+    assert_not_nil assigns(:invalid)
+  end
+  
+  test "calling #save method of controller should not assign @invalid" do
+    with_dynamic_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = provider.send(:decrypt, challenge)
+      
+      post :save, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_nil assigns(:invalid)
+    end
+    
+    with_static_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = 'hello'
+      
+      post :save, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_nil assigns(:invalid)
+    end
+    
+    with_question_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = provider.send(:solve, challenge)
+      
+      post :save, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_nil assigns(:invalid)
+    end
+  end
+  
+  test "calling #store method of controller should assign @invalid" do
+    with_dynamic_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = provider.send(:decrypt, challenge).reverse
+      
+      post :store, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_not_nil assigns(:invalid)
+    end
+    
+    with_static_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = '---'
+      
+      post :store, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_not_nil assigns(:invalid)
+    end
+    
+    with_question_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = '---'
+      
+      post :store, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_not_nil assigns(:invalid)
+    end
+  end
+  
+  test "calling #persist method of controller should assign @invalid" do
+    with_dynamic_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = provider.send(:decrypt, challenge).reverse
+      
+      post :persist, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_not_nil assigns(:invalid)
+    end
+    
+    with_static_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = '---'
+      
+      post :persist, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_not_nil assigns(:invalid)
+    end
+    
+    with_question_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = '---'
+      
+      post :persist, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_not_nil assigns(:invalid)
+    end
+  end
+  
+  test "calling #bingo method of controller should not assign @invalid" do
+    with_dynamic_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = provider.send(:decrypt, challenge).reverse
+      
+      post :bingo, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_nil assigns(:invalid)
+    end
+    
+    with_static_image_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = '---'
+      
+      post :bingo, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_nil assigns(:invalid)
+    end
+    
+    with_question_provider do |provider|
+      challenge = provider.generate_challenge
+      solution = '---'
+      
+      post :bingo, { 'widget' => { 'captcha_challenge' => challenge, 'captcha_solution' => solution } }
+      assert_nil assigns(:invalid)
+    end
+  end
+end

data/test/cases/image_generator/simple_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+ 
+IG = ValidatesCaptcha::ImageGenerator::Simple
+ 
+class ImageGeneratorTest < ValidatesCaptcha::TestCase
+  test "defines an instance level #generate method" do
+    assert_respond_to IG.new, :generate
+  end
+  
+  test "instance level #generate method accepts an argument" do
+    assert_nothing_raised { IG.new.generate('abc') }
+  end
+  
+  test "instance level #generate method returns a string" do
+    assert_kind_of String, IG.new.generate('abc')
+  end
+  
+  test "defines an instance level #file_extension method" do
+    assert_respond_to IG.new, :file_extension
+  end
+  
+  test "instance level #file_extension method returns a string" do
+    assert_kind_of String, IG.new.file_extension
+  end
+  
+  test "defines an instance level #mime_type method" do
+    assert_respond_to IG.new, :mime_type
+  end
+  
+  test "instance level #mime_type method returns a string" do
+    assert_kind_of String, IG.new.mime_type
+  end
+end
+

data/test/cases/model_validation_test.rb

@@ -0,0 +1,258 @@
+require 'test_helper'
+
+class ModelValidationTest < ValidatesCaptcha::TestCase
+  def with_dynamic_image_provider(&block)
+    old_provider = ValidatesCaptcha.provider
+    provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::DynamicImage.new
+    yield provider
+    ValidatesCaptcha.provider = old_provider
+  end
+  
+  def with_static_image_provider(&block)
+    old_provider = ValidatesCaptcha.provider
+    provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::StaticImage.new
+    provider.instance_variable_set "@images", ["/path/to/#{provider.send(:encrypt, 'hello')}#{provider.send(:image_file_extension)}"]
+    yield provider
+    ValidatesCaptcha.provider = old_provider
+  end
+  
+  def with_question_provider(&block)
+    old_provider = ValidatesCaptcha.provider
+    provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::Question.new
+    yield provider
+    ValidatesCaptcha.provider = old_provider
+  end
+  
+  test "defines an accessible attribute named +captcha_solution+" do
+    assert Widget.accessible_attributes.include?('captcha_solution')
+  end
+  
+  test "defines an instance level #captcha_solution method" do
+    assert_respond_to Widget.new, :captcha_solution
+  end
+  
+  test "defines a instance level #captcha_solution= method" do
+    assert_respond_to Widget.new, :captcha_solution=
+  end
+  
+  test "assigned value to #captcha_solution= should equal return value of #captcha_solution" do
+    widget = Widget.new
+    widget.captcha_solution = 'abc123'
+    
+    assert_equal 'abc123', widget.captcha_solution
+  end
+  
+  test "defines an accessible attribute named +captcha_challenge+" do
+    assert Widget.accessible_attributes.include?('captcha_challenge')
+  end
+  
+  test "defines an instance level #captcha_challenge method" do
+    assert_respond_to Widget.new, :captcha_challenge
+  end
+  
+  test "defines an instance level #captcha_challenge= method" do
+    assert_respond_to Widget.new, :captcha_challenge=
+  end
+  
+  test "value assigned to #captcha_challenge= should equal return value of #captcha_challenge" do
+    widget = Widget.new
+    widget.captcha_challenge = 'asdfghjk3456789'
+    
+    assert_equal 'asdfghjk3456789', widget.captcha_challenge
+  end
+  
+  test "defines #validate_captcha method callback of kind +validate+" do
+    assert Widget.validate_callback_chain.any? { |callback| callback.method == :validate_captcha && callback.kind == :validate }
+  end
+  
+  test "defines a class level with_captcha_validation method" do
+    assert_respond_to Widget, :with_captcha_validation
+  end
+  
+  test "not within a #with_captcha_validation block, calling valid? should return true if no captcha_solution is set" do
+    widget = Widget.new
+    widget.captcha_solution = nil
+    
+    assert widget.valid?
+  end
+  
+  test "not within a #with_captcha_validation block, calling valid? should return true if an empty captcha_solution is set" do
+    widget = Widget.new
+    widget.captcha_solution = '   '
+    
+    assert widget.valid?
+  end
+  
+  test "not within a #with_captcha_validation block, calling valid? should return true if an invalid captcha_solution is set" do
+    with_dynamic_image_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge).reverse
+      
+      assert widget.valid?
+    end
+    
+    with_static_image_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = '---'
+      
+      assert widget.valid?
+    end
+    
+    with_question_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = '---'
+      
+      assert widget.valid?
+    end
+  end
+  
+  test "not within a #with_captcha_validation block, calling valid? should return true if a valid captcha_solution is set" do
+    with_dynamic_image_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge)
+      
+      assert widget.valid?
+    end
+    
+    with_static_image_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = 'hello'
+      
+      assert widget.valid?
+    end
+    
+    with_question_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = provider.send(:solve, widget.captcha_challenge)
+      
+      assert widget.valid?
+    end
+  end
+  
+  test "within a #with_captcha_validation block, calling valid? should return false if no captcha_solution is set" do
+    Widget.with_captcha_validation do
+      widget = Widget.new
+      widget.captcha_solution = nil
+      
+      assert !widget.valid?
+      assert_equal 1, Array.wrap(widget.errors[:captcha_solution]).size
+      assert Array.wrap(widget.errors[:captcha_solution]).first.include?('blank')
+    end
+  end
+  
+  test "within a #with_captcha_validation block, calling valid? should return false if an empty captcha_solution is set" do
+    Widget.with_captcha_validation do
+      widget = Widget.new
+      widget.captcha_solution = '   '
+      
+      assert !widget.valid?
+      assert_equal 1, Array.wrap(widget.errors[:captcha_solution]).size
+      assert Array.wrap(widget.errors[:captcha_solution]).first.include?('blank')
+    end
+  end
+  
+  test "within a #with_captcha_validation block, calling valid? should return false if an invalid captcha_solution is set" do
+    with_dynamic_image_provider do |provider|
+      Widget.with_captcha_validation do
+        widget = Widget.new
+        widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge).reverse
+        
+        assert !widget.valid?
+        assert_equal 1, Array.wrap(widget.errors[:captcha_solution]).size
+        assert Array.wrap(widget.errors[:captcha_solution]).first.include?('invalid')
+      end
+    end
+    
+    with_static_image_provider do |provider|
+      Widget.with_captcha_validation do
+        widget = Widget.new
+        widget.captcha_solution = '---'
+        
+        assert !widget.valid?
+        assert_equal 1, Array.wrap(widget.errors[:captcha_solution]).size
+        assert Array.wrap(widget.errors[:captcha_solution]).first.include?('invalid')
+      end
+    end
+    
+    with_question_provider do |provider|
+      Widget.with_captcha_validation do
+        widget = Widget.new
+        widget.captcha_solution = '---'
+        
+        assert !widget.valid?
+        assert_equal 1, Array.wrap(widget.errors[:captcha_solution]).size
+        assert Array.wrap(widget.errors[:captcha_solution]).first.include?('invalid')
+      end
+    end
+  end
+  
+  test "within a #with_captcha_validation block, calling valid? should return true if a valid captcha_solution is set" do
+    with_dynamic_image_provider do |provider|
+      Widget.with_captcha_validation do
+        widget = Widget.new
+        widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge)
+        
+        assert widget.valid?
+      end
+    end
+    
+    with_static_image_provider do |provider|
+      Widget.with_captcha_validation do
+        widget = Widget.new
+        widget.captcha_solution = 'hello'
+        
+        assert widget.valid?
+      end
+    end
+    
+    with_question_provider do |provider|
+      Widget.with_captcha_validation do
+        widget = Widget.new
+        widget.captcha_solution = provider.send(:solve, widget.captcha_challenge)
+        
+        assert widget.valid?
+      end
+    end
+  end
+  
+  test "with #with_captcha_validation block, calling valid? before and after the block should return true if valid? returned false within block" do
+    with_dynamic_image_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge).reverse
+      
+      assert widget.valid?
+      
+      Widget.with_captcha_validation do
+        assert !widget.valid?
+      end
+      
+      assert widget.valid?
+    end
+    
+    with_static_image_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = '---'
+      
+      assert widget.valid?
+      
+      Widget.with_captcha_validation do
+        assert !widget.valid?
+      end
+      
+      assert widget.valid?
+    end
+    
+    with_question_provider do |provider|
+      widget = Widget.new
+      widget.captcha_solution = '---'
+      
+      assert widget.valid?
+      
+      Widget.with_captcha_validation do
+        assert !widget.valid?
+      end
+      
+      assert widget.valid?
+    end
+  end
+end