validates_captcha 0.9.3 → 0.9.4

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.9.4 (October 7, 2009)
+
+* Include new StaticImage provider
+
+
 == 0.9.3 (September 29, 2009)
 
 * Change API, include new Question provider, make it the default one

data/README.rdoc

@@ -5,10 +5,12 @@ ActiveRecord's validation mechanism and providing helpers for ActionController
 and ActionView.
 
 RDoc documentation (including this README as start page) can be found at 
-http://m4n.github.com/validates_captcha
+http://m4n.github.com/validates_captcha. Validates Captcha was first 
+announced {here}[http://m4n.github.com/2009/09/28/introducing-validates-captcha.html].
 
-Validates Captcha uses question/answer captchas by default. But you can 
-also use the built-in image captcha provider -- or implement your own.
+By default, question/answer captcha challenges are used, but you can also switch 
+to the built-in image captcha providers. If you stick to ValidatesCaptcha’s API, 
+you can even implement your own captcha challenge provider.
 
 
 
@@ -18,8 +20,8 @@ Validates Captcha extends ActiveRecord, ActionController and ActionView with
 helper methods that make it a snap to integrate captcha verification in your 
 Rails application.
 
-<b>Step #1:</b> Extend the form of your view with the necessary captcha display 
-and input logic.
+<b>Step #1:</b> Extend your view’s form with the necessary captcha display and 
+input logic.
 
   # app/views/comments/new.html.erb
   <% form_for @comment do |f| %>
@@ -152,7 +154,7 @@ Outside +with_captcha_validation+, no captcha validation is performed.
 
 
 
-== Question/answer challange captchas (default provider)
+== Question/answer challenge captchas (default provider)
 
 You can set the captcha provider to use question/answer challenges with 
 the code below. It is best to put this in a Rails initializer.
@@ -170,10 +172,11 @@ to do it.
 
 
 
-== Image challenge captchas
+== Dynamic image challenge captchas
 
-You can set the captcha provider to use image challenges with 
-the code below. It is best to put this in a Rails initializer.
+You can set the captcha provider to use dynamically created image challenges 
+with the code below.  Dynamic means that the captcha image is created on invocation.  
+If you want to utilize this provider, it is best to put this in a Rails initializer.
 
   ValidatesCaptcha.provider = ValidatesCaptcha::Provider::Image.new
 
@@ -190,6 +193,29 @@ values to your needs.
 
 
 
+== Static image challenge captchas
+
+You can set the captcha provider to use static image challenges with 
+the code below.  Static means that there exist some pre-created images 
+in a folder accessible by the web application.  If you want to utilize 
+this provider, it is best to put this in a Rails initializer.
+
+  ValidatesCaptcha.provider = ValidatesCaptcha::Provider::StaticImage.new
+
+There is a Rake tast for creating the static captcha images:
+
+  rake validates_captcha:create_static_images
+
+This will create 3 images for you. To create a different number of images, 
+provide a COUNT argument:
+
+  rake validates_captcha:create_static_images COUNT=50
+
+If you want to customize the path the images get saved to (or other stuff), 
+please see the documentation for ValidatesCaptcha::Provider::StaticImage.
+
+
+
 == Extensibility
 
 Don't like the built-in challenges? It's easy to extend them or to implement 

data/lib/validates_captcha/provider/image.rb

@@ -1,5 +1,3 @@
-require 'openssl'
-require 'active_support/secure_random'
 require 'action_view/helpers'
 
 module ValidatesCaptcha
@@ -80,8 +78,6 @@ module ValidatesCaptcha
     class Image
       include ActionView::Helpers
       
-      KEY = ::ActiveSupport::SecureRandom.hex(32).freeze
-      
       @@string_generator = nil
       @@reversible_encrypter = nil
       @@image_generator = nil

data/lib/validates_captcha/provider/static_image.rb

@@ -0,0 +1,224 @@
+require 'digest/sha1'
+require 'action_view/helpers'
+
+module ValidatesCaptcha
+  module Provider
+    # An image captcha provider that relies on pre-created captcha images.
+    #
+    # There is a Rake tast for creating the captcha images:
+    #
+    #  rake validates_captcha:create_static_images
+    #
+    # This will create 3 images in #filesystem_dir. To create a 
+    # different number of images, provide a COUNT argument:
+    #
+    #  rake validates_captcha:create_static_images COUNT=50 
+    #
+    # This class contains the getters and setters for the backend classes:
+    # image generator and string generator.  This allows you to replace them 
+    # with your custom implementations.  For more information on how to bring 
+    # the image provider to use your own implementation instead of the default 
+    # one, consult the documentation for the specific default class.
+    #
+    # The default captcha image generator uses ImageMagick's +convert+ command to 
+    # create the captcha.  So a recent and properly configured version of ImageMagick 
+    # must be installed on the system.  The version used while developing was 6.4.5.  
+    # But you are not bound to ImageMagick.  If you want to provide a custom image 
+    # generator, take a look at the documentation for 
+    # ValidatesCaptcha::ImageGenerator::Simple on how to create your own.
+    class StaticImage
+      include ActionView::Helpers
+      
+      SALT = "3f(61&831_fa0712d4a?b58-eb4b8$a2%.36378f".freeze
+      
+      @@string_generator = nil
+      @@image_generator = nil
+      @@filesystem_dir = nil
+      @@web_dir = nil
+      @@salt = nil
+      
+      class << self
+        # Returns the current captcha string generator. Defaults to an
+        # instance of the ValidatesCaptcha::StringGenerator::Simple class.
+        def string_generator
+          @@string_generator ||= ValidatesCaptcha::StringGenerator::Simple.new
+        end
+        
+        # Sets the current captcha string generator. Used to set a
+        # custom string generator.
+        def string_generator=(generator)
+          @@string_generator = generator
+        end
+        
+        # Returns the current captcha image generator. Defaults to an
+        # instance of the ValidatesCaptcha::ImageGenerator::Simple class.
+        def image_generator
+          @@image_generator ||= ValidatesCaptcha::ImageGenerator::Simple.new
+        end
+        
+        # Sets the current captcha image generator. Used to set a custom
+        # image generator.
+        def image_generator=(generator)
+          @@image_generator = generator
+        end
+        
+        # Returns the current captcha image file system directory. Defaults to 
+        # +RAILS_ROOT/public/images/captchas+.
+        def filesystem_dir
+          @@filesystem_dir ||= ::File.join(::Rails.public_path, 'images', 'captchas')
+        end
+        
+        # Sets the current captcha image file system directory. Used to set a custom
+        # image directory.
+        def filesystem_dir=(dir)
+          @@filesystem_dir = dir
+        end
+        
+        # Returns the current captcha image web directory. Defaults to 
+        # +/images/captchas+.
+        def web_dir
+          @@web_dir ||= '/images/captchas'
+        end
+        
+        # Sets the current captcha image web directory. Used to set a custom
+        # image directory.
+        def web_dir=(dir)
+          @@web_dir = dir
+        end
+        
+        # Returns the current salt used for encryption.
+        def salt
+          @@salt ||= SALT
+        end
+        
+        # Sets the current salt used for encryption. Used to set a custom
+        # salt.
+        def salt=(salt)
+          @@salt = salt
+        end
+        
+        # Return the encryption of the +code+ using #salt.
+        def encrypt(code)
+          ::Digest::SHA1.hexdigest "#{salt}--#{code}"
+        end        
+        
+        # Creates a captcha image in the #filesystem_dir and returns 
+        # the path to it and the code displayed on the image.
+        def create_image
+          code = string_generator.generate
+          encrypted_code = encrypt(code)
+          
+          image_filename = "#{encrypted_code}#{image_generator.file_extension}"
+          image_path = File.join(filesystem_dir, image_filename)
+          image_bytes = image_generator.generate(code)
+          
+          File.open image_path, 'w' do |os|
+            os.write image_bytes
+          end
+          
+          return image_path, code
+        end
+      end
+      
+      # This method is the one called by Rack.
+      # 
+      # It returns HTTP status 404 if the path is not recognized. If the path is 
+      # recognized, it returns HTTP status 200 and delivers a new challenge in 
+      # JSON format.
+      #
+      # Please take a look at the source code if you want to learn more.
+      def call(env)
+        if env['PATH_INFO'] == regenerate_path
+          captcha_challenge = generate_challenge
+          json = { :captcha_challenge => captcha_challenge, :captcha_image_path => image_path(captcha_challenge) }.to_json
+          
+          [200, { 'Content-Type' => 'application/json' }, [json]]
+        else
+          [404, { 'Content-Type' => 'text/html' }, ['Not Found']]
+        end
+      end
+      
+      # Returns an array containing the paths to the available captcha images.
+      def images
+        @images ||= Dir[File.join(filesystem_dir, "*#{image_file_extension}")]
+      end
+      
+      # Returns an array containing the available challenges (encrypted captcha codes).
+      def challenges
+        @challenges ||= images.map { |path| File.basename(path, image_file_extension) }
+      end
+      
+      # Returns a captcha challenge.
+      def generate_challenge
+        raise("no captcha images found in #{filesystem_dir}") if challenges.empty?
+        
+        challenges[rand(challenges.size)]
+      end
+        
+      # Returns true if the captcha was solved using the given +challenge+ and +solution+, 
+      # otherwise false.
+      def solved?(challenge, solution)
+        challenge == encrypt(solution)
+      end
+      
+      # Returns an image tag with the source set to the url of the captcha image.
+      # 
+      # Internally calls Rails' +image_tag+ helper method, passing the +options+ argument.
+      def render_challenge(sanitized_object_name, object, options = {})
+        src = image_path(object.captcha_challenge)
+        
+        options[:alt] ||= 'CAPTCHA'
+        options[:id] = "#{sanitized_object_name}_captcha_image"
+        
+        image_tag src, options
+      end
+      
+      # Returns an anchor tag that makes an AJAX request to fetch a new captcha code and updates 
+      # the captcha image after the request is complete.
+      # 
+      # Internally calls Rails' +link_to_remote+ helper method, passing the +options+ and 
+      # +html_options+ arguments. So it relies on the Prototype javascript framework 
+      # to be available on the web page.
+      #
+      # The anchor text defaults to 'Regenerate Captcha'. You can set this to a custom value 
+      # providing a +:text+ key in the +options+ hash.
+      def render_regenerate_challenge_link(sanitized_object_name, object, options = {}, html_options = {})
+        text = options.delete(:text) || 'Regenerate Captcha'
+        success = "var result = request.responseJSON; $('#{sanitized_object_name}_captcha_image').src = result.captcha_image_path; $('#{sanitized_object_name}_captcha_challenge').value = result.captcha_challenge; $('#{sanitized_object_name}_captcha_solution').value = '';"
+        
+        link_to_remote text, options.reverse_merge(:url => regenerate_path, :method => :get, :success => success), html_options
+      end
+      
+      private        
+        def regenerate_path #:nodoc:
+          '/captchas/regenerate'
+        end
+        
+        def image_file_extension #:nodoc:
+          self.class.image_generator.file_extension
+        end
+      
+        def image_path(encrypted_code) #:nodoc:
+          File.join(web_dir, "#{encrypted_code}#{image_file_extension}")
+        end
+      
+        def encrypt(code) #:nodoc:
+          self.class.encrypt code
+        end
+        
+        def filesystem_dir #:nodoc:
+          self.class.filesystem_dir
+        end
+        
+        def web_dir #:nodoc:
+          self.class.web_dir
+        end
+      
+        # This is needed by +link_to_remote+ called in +render_regenerate_link+.
+        def protect_against_forgery? #:nodoc:
+          false
+        end
+    end
+  end
+end
+      

data/lib/validates_captcha/version.rb

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

data/lib/validates_captcha.rb

@@ -38,6 +38,7 @@ module ValidatesCaptcha
   module Provider
     autoload :Question, 'validates_captcha/provider/question'
     autoload :Image, 'validates_captcha/provider/image'
+    autoload :StaticImage, 'validates_captcha/provider/static_image'
   end
   
   module StringGenerator

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

@@ -76,13 +76,21 @@ end
 class ControllerValidationTest < ActionController::TestCase
   tests WidgetsController
   
-  def with_image_provider(&block)
+  def with_dynamic_image_provider(&block)
     old_provider = ValidatesCaptcha.provider
     provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::Image.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
@@ -109,7 +117,7 @@ class ControllerValidationTest < ActionController::TestCase
   end
   
   test "calling #save method of controller should not assign @invalid" do
-    with_image_provider do |provider|
+    with_dynamic_image_provider do |provider|
       challenge = provider.generate_challenge
       solution = provider.send(:decrypt, challenge)
       
@@ -117,6 +125,14 @@ class ControllerValidationTest < ActionController::TestCase
       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)
@@ -127,7 +143,7 @@ class ControllerValidationTest < ActionController::TestCase
   end
   
   test "calling #store method of controller should assign @invalid" do
-    with_image_provider do |provider|
+    with_dynamic_image_provider do |provider|
       challenge = provider.generate_challenge
       solution = provider.send(:decrypt, challenge).reverse
       
@@ -135,6 +151,14 @@ class ControllerValidationTest < ActionController::TestCase
       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 = '---'
@@ -145,7 +169,7 @@ class ControllerValidationTest < ActionController::TestCase
   end
   
   test "calling #persist method of controller should assign @invalid" do
-    with_image_provider do |provider|
+    with_dynamic_image_provider do |provider|
       challenge = provider.generate_challenge
       solution = provider.send(:decrypt, challenge).reverse
       
@@ -153,6 +177,14 @@ class ControllerValidationTest < ActionController::TestCase
       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 = '---'
@@ -163,7 +195,7 @@ class ControllerValidationTest < ActionController::TestCase
   end
   
   test "calling #bingo method of controller should not assign @invalid" do
-    with_image_provider do |provider|
+    with_dynamic_image_provider do |provider|
       challenge = provider.generate_challenge
       solution = provider.send(:decrypt, challenge).reverse
       
@@ -171,6 +203,14 @@ class ControllerValidationTest < ActionController::TestCase
       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 = '---'

data/test/cases/model_validation_test.rb

@@ -1,13 +1,21 @@
 require 'test_helper'
 
 class ModelValidationTest < ValidatesCaptcha::TestCase
-  def with_image_provider(&block)
+  def with_dynamic_image_provider(&block)
     old_provider = ValidatesCaptcha.provider
     provider = ValidatesCaptcha.provider = ValidatesCaptcha::Provider::Image.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
@@ -76,13 +84,20 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
   end
   
   test "not within a #with_captcha_validation block, calling valid? should return true if an invalid captcha_solution is set" do
-    with_image_provider do |provider|
+    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 = '---'
@@ -92,13 +107,20 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
   end
   
   test "not within a #with_captcha_validation block, calling valid? should return true if a valid captcha_solution is set" do
-    with_image_provider do |provider|
+    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)
@@ -130,7 +152,7 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
   end
   
   test "within a #with_captcha_validation block, calling valid? should return false if an invalid captcha_solution is set" do
-    with_image_provider do |provider|
+    with_dynamic_image_provider do |provider|
       Widget.with_captcha_validation do
         widget = Widget.new
         widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge).reverse
@@ -141,6 +163,17 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
       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
@@ -154,7 +187,7 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
   end
   
   test "within a #with_captcha_validation block, calling valid? should return true if a valid captcha_solution is set" do
-    with_image_provider do |provider|
+    with_dynamic_image_provider do |provider|
       Widget.with_captcha_validation do
         widget = Widget.new
         widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge)
@@ -163,6 +196,15 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
       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
@@ -174,7 +216,7 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
   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_image_provider do |provider|
+    with_dynamic_image_provider do |provider|
       widget = Widget.new
       widget.captcha_solution = provider.send(:decrypt, widget.captcha_challenge).reverse
       
@@ -187,6 +229,19 @@ class ModelValidationTest < ValidatesCaptcha::TestCase
       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 = '---'

data/test/cases/provider/static_image_test.rb

@@ -0,0 +1,148 @@
+require 'test_helper'
+
+STATIC_IMAGE = ValidatesCaptcha::Provider::StaticImage
+
+unless defined?(::Rails)
+  module Rails
+    def self.public_path
+      'public'
+    end
+  end
+end
+
+class StaticImageTest < ValidatesCaptcha::TestCase
+  test "defines a class level #string_generator method" do
+    assert_respond_to STATIC_IMAGE, :string_generator
+  end
+  
+  test "defines a class level #string_generator= method" do
+    assert_respond_to STATIC_IMAGE, :string_generator=
+  end
+  
+  test "#string_generator method's return value should equal the value set using the #string_generator= method" do
+    old_string_generator = STATIC_IMAGE.string_generator
+    
+    STATIC_IMAGE.string_generator = 'abc'
+    assert_equal 'abc', STATIC_IMAGE.string_generator
+    
+    STATIC_IMAGE.string_generator = old_string_generator
+  end
+  
+  test "defines a class level #image_generator method" do
+    assert_respond_to STATIC_IMAGE, :image_generator
+  end
+  
+  test "defines a class level #image_generator= method" do
+    assert_respond_to STATIC_IMAGE, :image_generator=
+  end
+  
+  test "#image_generator method's return value should equal the value set using the #image_generator= method" do
+    old_image_generator = STATIC_IMAGE.image_generator
+    
+    STATIC_IMAGE.image_generator = 'abc'
+    assert_equal 'abc', STATIC_IMAGE.image_generator
+    
+    STATIC_IMAGE.image_generator = old_image_generator
+  end
+  
+  test "defines a class level #salt method" do
+    assert_respond_to STATIC_IMAGE, :salt
+  end
+  
+  test "defines a class level #salt= method" do
+    assert_respond_to STATIC_IMAGE, :salt=
+  end
+  
+  test "#salt method's return value should equal the value set using the #salt= method" do
+    old_salt = STATIC_IMAGE.salt
+    
+    STATIC_IMAGE.salt = 'abc'
+    assert_equal 'abc', STATIC_IMAGE.salt
+    
+    STATIC_IMAGE.salt = old_salt
+  end
+  
+  test "defines a class level #filesystem_dir method" do
+    assert_respond_to STATIC_IMAGE, :filesystem_dir
+  end
+  
+  test "defines a class level #filesystem_dir= method" do
+    assert_respond_to STATIC_IMAGE, :filesystem_dir=
+  end
+  
+  test "#filesystem_dir method's return value should equal the value set using the #filesystem_dir= method" do
+    old_filesystem_dir = STATIC_IMAGE.filesystem_dir
+    
+    STATIC_IMAGE.filesystem_dir = 'abc'
+    assert_equal 'abc', STATIC_IMAGE.filesystem_dir
+    
+    STATIC_IMAGE.filesystem_dir = old_filesystem_dir
+  end
+  
+  test "defines a class level #web_dir method" do
+    assert_respond_to STATIC_IMAGE, :web_dir
+  end
+  
+  test "defines a class level #web_dir= method" do
+    assert_respond_to STATIC_IMAGE, :web_dir=
+  end
+  
+  test "#web_dir method's return value should equal the value set using the #web_dir= method" do
+    old_web_dir = STATIC_IMAGE.web_dir
+    
+    STATIC_IMAGE.web_dir = 'abc'
+    assert_equal 'abc', STATIC_IMAGE.web_dir
+    
+    STATIC_IMAGE.web_dir = old_web_dir
+  end
+  
+  test "calling #call with unrecognized path should have response status 404" do
+    result = STATIC_IMAGE.new.call 'PATH_INFO' => '/unrecognized'
+    
+    assert_equal 404, result.first
+  end
+  
+  test "calling #call with regenerate path should have response status 200" do
+    si = STATIC_IMAGE.new
+    si.instance_variable_set "@challenges", ['abc']
+    
+    result = si.call 'PATH_INFO' => si.send(:regenerate_path)
+    
+    assert_equal 200, result.first
+  end
+  
+  test "calling #call with regenerate path should have content type response header set to application/json" do
+    si = STATIC_IMAGE.new
+    si.instance_variable_set "@challenges", ['abc']
+    
+    result = si.call 'PATH_INFO' => si.send(:regenerate_path)
+    
+    assert result.second.key?('Content-Type')
+    assert_equal 'application/json', result.second['Content-Type']
+  end
+  
+  test "calling #generate_challenge should raise runtime error if no images are available" do
+    si = STATIC_IMAGE.new
+    si.instance_variable_set "@images", []
+    
+    assert_raises RuntimeError do
+      si.generate_challenge
+    end
+  end
+    
+  test "calling #generate_challenge should not raise runtime error if an images is available" do
+    si = STATIC_IMAGE.new
+    si.instance_variable_set "@images", ['/path/to/an/image.gif']
+    
+    assert_nothing_raised do
+      si.generate_challenge
+    end
+  end  
+  
+  test "calling #generate_challenge should return the image file basename without extension" do
+    si = STATIC_IMAGE.new
+    si.instance_variable_set "@images", ["/path/to/an/captcha-image#{si.send(:image_file_extension)}"]
+    
+    assert_equal 'captcha-image', si.generate_challenge
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: validates_captcha
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Martin Andert
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-29 00:00:00 +02:00
+date: 2009-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,16 +55,19 @@ files:
 - lib/validates_captcha/model_validation.rb
 - lib/validates_captcha/provider/image.rb
 - lib/validates_captcha/provider/question.rb
+- lib/validates_captcha/provider/static_image.rb
 - lib/validates_captcha/reversible_encrypter/simple.rb
 - lib/validates_captcha/string_generator/simple.rb
 - lib/validates_captcha/test_case.rb
 - lib/validates_captcha/version.rb
 - rails/init.rb
+- tasks/static_image_tasks.rake
 - test/cases/controller_validation_test.rb
 - test/cases/image_generator/simple_test.rb
 - test/cases/model_validation_test.rb
 - test/cases/provider/image_test.rb
 - test/cases/provider/question_test.rb
+- test/cases/provider/static_image_test.rb
 - test/cases/reversible_encrypter/simple_test.rb
 - test/cases/string_generator/simple_test.rb
 - test/cases/validates_captcha_test.rb
@@ -76,7 +79,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Validates Captcha 0.9.3
+- Validates Captcha 0.9.4
 - --main
 - README.rdoc
 - --line-numbers
@@ -110,6 +113,7 @@ test_files:
 - test/cases/model_validation_test.rb
 - test/cases/provider/image_test.rb
 - test/cases/provider/question_test.rb
+- test/cases/provider/static_image_test.rb
 - test/cases/reversible_encrypter/simple_test.rb
 - test/cases/string_generator/simple_test.rb
 - test/cases/validates_captcha_test.rb