quick_captcha 3.2.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 [Sur http://expressica.com]
+Copyright (c) 2010 [kares <http://log.kares.org>]
+
+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/README.md

@@ -0,0 +1,280 @@
+
+This code is a fork <http://github.com/kares/simple_captcha>
+
+Main Updates
+------------
+
+ - Renamed (mostly) to QuickMagick
+ - Upgraded to engine running under Rails 3.2
+ - Removed support for RMagick
+ - Removed support for Rails 2
+ - Attempted to maintain backwards compatibility
+
+
+Other Updates
+-------------
+
+The original version does all kinds of method aliasing and requires you
+to write code specifically for handling the captcha validation. This version
+accepts the usual :if, :unless and :on options.
+
+This version does not bypass the validation if in test mode. It behaves the
+same in all environments, allowing you to actually test it.
+
+To disable the validations in test mode, You should now state it explicitly:
+
+    class User < ActiveRecord::Base
+      validates_captcha :unless => lambda { Rails.env.test? }
+    end
+
+NOTE: This will validate captcha every-time You do a `user.save` !
+
+There's an API that allows You to (temporary) disable captcha validation for
+classes, individual instances or even blocks :
+
+    User.captcha_validation = false # disables validation globally
+    user = User.new
+    ...
+    # force captcha validation for the given instance and block
+    user.captcha_validation(true) do
+      user.save!
+    end
+    ...
+    # enable captcha validation for the given instance
+    user.captcha_validation(true)
+    user.save
+    ...
+    # reset captcha validation - fallback to the class setting
+    user.captcha_validation(nil)
+    user.save # validates captcha if User.captcha_validation?
+
+
+Old Validation
+--------------
+
+A backward compatible validation for Your model classes is as well available.
+The original captcha validation code was different from standard validation in
+a way that it did not validate the captcha on "regular" `save` calls, one has
+to explicitly state captcha validation is desired by calling `save_with_captcha`.
+
+    class User < ActiveRecord::Base
+      apply_simple_captcha :message => 'WTF?!'
+    end
+
+NOTE: The "old" behavior is emulated using the captcha_validation flags.
+
+QuickCaptcha
+=============
+  
+QuickCaptcha is the simplest and a robust captcha plugin. Its implementation
+requires adding up a single line in views and in controllers/models.
+  
+### Features
+  
+ - Zero FileSystem usage(secret code moved to db-store and image storage removed).
+ - Provides various image styles.
+ - Provides three level of complexity of images.
+ - Works absolutely fine in distributed environment(session and db based implementation
+   works fine in distributed environment).
+ - Implementation is as easy as just writing a single line in your view.
+   `<%= show_quick_captcha %>` within the 'form' tags.
+ - Flexible DOM and CSS handling(There is a separate view partial for rendering 
+   QuickCaptcha DOM elements).
+ - Automated removal of 1 hour old unmatched simple_captcha data.
+
+### Pre-Requisite
+
+  [quick_magick](https://rubyforge.org/projects/quickmagick) should be installed on your machine to use this plugin.
+
+
+### Installation
+  
+  gem install quick_captcha
+  add gem 'quick_captcha' to Gemfile
+
+### Setup
+
+After installation, follow these simple steps to setup the plugin. 
+The setup will depend on the version of rails your application is using.
+
+#### STEP 1
+
+ for Rails 3.x :
+
+    rails generate quick_captcha
+
+#### STEP 2
+
+    rake db:migrate
+
+#### STEP 4 (Optional)
+
+  configure quick_captcha e.g. in `app/config/initializers/quick_captcha.rb`
+
+    QuickCaptcha.backend = :quick_magick 
+
+    QuickCaptcha.image_options = {
+        :image_color => 'white',
+        :image_size => '110x30',
+        :text_color => 'black',
+        :text_font => 'arial',
+        :text_size => 22
+    } # these are the defaults
+
+  Please note that some image options such as color might change when using
+  some of the pre-built captcha image styles available.
+
+
+### Usage
+
+#### Controller Based
+
+  Include `QuickCaptcha::ControllerValidation` into Your captcha validating
+  controller or put the include into `app/controllers/application.rb`
+
+    ApplicationController < ActionController::Base
+      include QuickCaptcha::ControllerValidation
+    end
+
+  in the view file within the form tags add this code
+    
+    <%= show_quick_captcha %> or <%= show_simple_captcha %>
+    
+  and in the controller's action authenticate it as 
+    
+    if quick_captcha_valid?
+      do this
+    else
+      do that
+    end
+
+
+#### Model Based
+  
+  In the view file within the form tags write this code
+
+    <%= show_quick_captcha(:object=>"user") %>
+
+  and in the model class include `QuickCaptcha::ModelValidation` and setup
+  the validation
+
+    class User < ActiveRecord::Base
+      include QuickCaptcha::ModelValidation
+
+      validates_captcha :on => :create, :message => 'invalid captcha'
+    end
+
+  or if You prefer the old version which doesn't trigger the captcha
+  validation on `save` (one have to call `save_with_captcha`)
+
+    class User < ActiveRecord::Base
+      include QuickCaptcha::ModelValidation
+      
+      apply_quick_captcha :message => :'invalid_captcha'
+    end
+
+
+Options & Examples
+------------------
+
+    View Options
+    ==========================================================================
+
+    :label
+    --------------------------------------------------------------------------
+      provides the custom text b/w the image and the text field,
+      the default is "type the code from the image"
+
+    :image_style
+    --------------------------------------------------------------------------
+      Provides the specific image style for the captcha image.
+      There are eight different styles available with the plugin as...
+      1) simply_blue
+      2) simply_red
+      3) simply_green
+      4) charcoal_grey
+      5) embosed_silver
+      6) all_black
+      7) distorted_black
+      8) almost_invisible
+
+      See the included samples <http://github.com/kares/simple_captcha/samples>.
+      You can also specify 'random' to select the random image style.
+
+
+    :distortion
+    --------------------------------------------------------------------------
+      Handles the complexity of the image. The :distortion can be set to 'low',
+      'medium' or 'high'. Default is 'low'.
+
+    :object
+    --------------------------------------------------------------------------
+      the name of the object of the model class, to implement the model based
+      captcha.
+
+
+    How to change the CSS for QuickCaptcha DOM elements ?
+    -----------------------------------------------------
+    You can change the CSS of the QuickCaptcha DOM elements as per your need
+    in this file.
+    "/app/views/quick_captcha/_quick_captcha.erb"
+    
+
+    View's Examples
+    ==========================================================================
+
+    Controller Based Example
+    --------------------------------------------------------------------------
+      example
+      -------
+      <%= show_quick_captcha(:label => "human authentication") %>
+
+      example
+      -------
+      <%= show_quick_captcha(:label       => "human authentication",
+                              :image_style => 'embosed_silver') %>
+
+      example
+      -------
+      <%= show_quick_captcha(:label       => "human authentication",
+                              :image_style => 'simply_red',
+                              :distortion  => 'medium') %>
+
+    Model Based Example
+    --------------------------------------------------------------------------
+
+      example
+      -------
+      <%= show_quick_captcha(:object => 'user',
+                              :label  => "human authentication") %>
+
+
+
+    Model Options
+    ==========================================================================
+
+    :message
+    --------------------------------------------------------------------------
+      provides the custom message on failure of captcha authentication
+      the default is "Secret Code did not match with the Image"
+
+    :add_to_base
+    --------------------------------------------------------------------------
+      if set to true, appends the error message to the base.
+
+    Model's Example
+    ==========================================================================
+
+      example
+      -------
+      class User < ActiveRecord::Base
+        apply_quick_captcha # the "old" way using save_with_captcha
+      end
+
+      example
+      -------
+      class User < ActiveRecord::Base
+        validates_captcha :message => "Are you a bot?", :add_to_base => true
+      end
+
+    ==========================================================================

data/Rakefile

@@ -0,0 +1,59 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the quick_captcha plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the quick_captcha plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QuickCaptcha'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Generate captcha image samples.'
+task :generate_samples do
+  
+  $:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+  require 'action_view'
+  require 'active_record'
+  require 'quick_captcha'
+  # prefer quick_magick (works with JRuby) :
+  begin
+    require 'quick_magick'
+    require 'quick_captcha/quick_magick_backend'
+    QuickCaptcha.backend = :quick_magick
+  rescue
+    raise "could not find quick_magick"
+  end
+
+  include QuickCaptcha::ViewHelpers
+  include QuickCaptcha::ImageHelpers
+
+  def self.simple_captcha_value(key) # stub
+    generate_simple_captcha_data
+  end
+
+  samples_dir = File.join(File.dirname(__FILE__), 'samples')
+  image_styles = QuickCaptcha::ImageHelpers::IMAGE_STYLES
+
+  (image_styles + [ nil ]).each do |image_style|
+    simple_captcha_img = generate_simple_captcha_image(:image_style => image_style)
+    filename = File.join(samples_dir, (image_style || 'default') + '.jpg')
+    File.open(filename, "wb") { |file| file << simple_captcha_img }
+  end
+
+end

data/app/controllers/quick_captcha_controller.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+class QuickCaptchaController < ActionController::Base
+  include QuickCaptcha::ImageHelpers
+
+  def show  #:nodoc
+    simple_captcha_key = params[:simple_captcha_key] || params[:captcha_key]
+    raise ":simple_captcha_key parameter missing" unless simple_captcha_key
+    send_data(
+      generate_simple_captcha_image(
+        :image_style => params[:image_style],
+        :distortion => params[:distortion], 
+        :simple_captcha_key => simple_captcha_key),
+      :type => 'image/jpeg',
+      :disposition => 'inline',
+      :filename => 'simple_captcha.jpg')
+  end
+  alias_method :simple_captcha, :show # backward compatibility
+  
+end

data/app/models/simple_captcha_data.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+class SimpleCaptchaData < ActiveRecord::Base
+  self.table_name = "simple_captcha_data"
+  
+  class << self
+    def get_data(key)
+      find_by_key(key) || new(:key => key)
+    end
+    
+    def remove_data(key)
+      clear_old_data
+      data = find_by_key(key)
+      data.destroy if data
+    end
+    
+    def clear_old_data(time = 1.hour.ago)
+      return unless Time === time
+      destroy_all("updated_at < '#{time.to_s(:db)}'")
+    end
+  end
+  
+end

data/app/views/quick_captcha/_quick_captcha.erb

@@ -0,0 +1,39 @@
+<!-- Copyright (c) 2007 [Sur http://expressica.com] -->
+
+<style type="text/CSS">
+  #simple_captcha { border: 1px solid #ccc; padding: 5px !important; }
+  #simple_captcha,
+  #simple_captcha div { display: table; }
+  #simple_captcha .simple_captcha_field,
+  #simple_captcha .simple_captcha_image {
+    border: 1px solid #ccc;
+    margin: 0px 0px 2px 0px !important;
+    padding: 0px !important;
+  }
+  #simple_captcha .simple_captcha_image img {
+    margin: 0px !important;
+    padding: 0px !important;
+    width: 110px !important;
+  }
+  #simple_captcha .simple_captcha_label { font-size: 12px; }
+  #simple_captcha .simple_captcha_field input {
+    width: 150px !important;
+    font-size: 16px;
+    border: none;
+    background-color: #efefef;
+  }
+</style>
+
+<div id='simple_captcha'>
+  <div class='simple_captcha_image'>
+    <%= @simple_captcha_options[:image] %>
+  </div>
+  
+  <div class='simple_captcha_field'>
+    <%= @simple_captcha_options[:field] %>
+  </div>
+  
+  <div class='simple_captcha_label'>
+    <%= @simple_captcha_options[:label] %>
+  </div>
+</div>

data/config/initializers/quick_captcha.rb

@@ -0,0 +1,7 @@
+# QuickCaptcha Configuration
+#
+# put this in an initializer: config/initializers/quick_captcha.rb
+#
+# more info at http://github.com/portablemind/quick_captcha
+#
+QuickCaptcha.backend = :quick_magick 

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  match '/simple_captcha/:action', :to => 'quick_captcha', :as => :simple_captcha
+  match '/quick_captcha/:action', :to => 'quick_captcha', :as => :quick_captcha
+end

data/lib/generators/quick_captcha_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+class QuickCaptchaGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+  end
+
+  def self.next_migration_number(dirname)
+    Time.now.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_migration
+    migration_template "migration.rb", File.join('db/migrate', "create_simple_captcha_data.rb")
+  end
+  
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,14 @@
+class CreateSimpleCaptchaData < ActiveRecord::Migration
+  def self.up
+    create_table :simple_captcha_data do |t|
+      t.string :key, :limit => 40
+      t.string :value, :limit => 20
+      t.timestamps
+    end
+    add_index :simple_captcha_data, :key
+  end
+
+  def self.down
+    drop_table :simple_captcha_data
+  end
+end

data/lib/quick_captcha.rb

@@ -0,0 +1,69 @@
+require "quick_captcha/version"
+require "quick_captcha/engine"
+
+require 'quick_captcha/captcha_utils'
+require 'quick_captcha/image_helpers'
+require 'quick_captcha/view_helpers'
+require 'quick_captcha/quick_magick_backend'
+require 'quick_captcha/controller_validation'
+require 'quick_captcha/model_validation'
+
+
+#ActiveRecord::Base.extend QuickCaptcha::ModelHelpers::ClassMethods
+ActionView::Base.send :include, QuickCaptcha::ViewHelpers
+
+module QuickCaptcha
+
+  @@image_options = {
+      :image_color => 'white',
+      :image_size => '110x30',
+      :text_color => 'black',
+      :text_font => 'arial',
+      :text_size => 22
+  }
+  def self.image_options
+    @@image_options
+  end
+
+  def self.image_options=(options)
+    @@image_options.merge! options
+  end
+
+  @@captcha_length = nil
+  def self.captcha_length
+    @@captcha_length ||= 6
+  end
+
+  def self.captcha_length=(length)
+    if length
+      raise "invalid captcha length < 0 : #{length}" if length <= 0
+      raise "invalid captcha length > 20 : #{length}" if length > 20
+    end
+    @@captcha_length = length
+  end
+
+  @@backend = nil
+  def self.backend
+    self.backend = :quick_magick unless @@backend
+    @@backend
+  end
+
+  def self.backend=(backend)
+    if backend.nil?
+      return @@backend = nil
+    end
+    if backend.is_a?(Symbol) || backend.is_a?(String)
+      backend = backend.to_s.camelize
+      backend_const = const_get(backend + 'Backend') rescue nil
+      backend_const = const_get(backend) rescue nil unless backend_const
+      raise "unsupported backend: #{backend}" unless backend_const
+    else
+      backend_const = backend
+    end
+    unless backend_const.respond_to?(:generate_simple_captcha_image)
+      raise "invalid backend: #{backend_const} - does not respond to :generate_simple_captcha_image"
+    end
+    @@backend = backend_const
+  end
+
+end

data/lib/quick_captcha/captcha_utils.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+require 'digest/sha1'
+
+module QuickCaptcha #:nodoc
+  module CaptchaUtils
+
+    def self.simple_captcha_value(key)
+      SimpleCaptchaData.get_data(key).value rescue nil
+    end
+
+    def self.simple_captcha_matches?(captcha, key)
+      captcha && captcha.delete(" ").upcase == simple_captcha_value(key)
+    end
+
+    def self.simple_captcha_passed!(key)
+      SimpleCaptchaData.remove_data(key)
+    end
+
+    def simple_captcha_value
+      QuickCaptcha::CaptchaUtils.simple_captcha_value(simple_captcha_key)
+    end
+
+    def simple_captcha_matches?(captcha)
+      QuickCaptcha::CaptchaUtils.simple_captcha_matches?(captcha, simple_captcha_key)
+    end
+
+    def simple_captcha_passed!
+      QuickCaptcha::CaptchaUtils.simple_captcha_passed!(simple_captcha_key).tap do
+        session[:simple_captcha] = nil
+      end
+    end
+
+    def simple_captcha_key
+      session[:simple_captcha] ||= generate_simple_captcha_key
+    end
+
+    def generate_simple_captcha_key
+      session_id = session[:id] || 
+        request.respond_to?(:session_options) ?
+          request.session_options[:id] : session.session_id
+      Digest::SHA1.hexdigest(Time.now.to_s + session_id.to_s)
+    end
+
+  end
+end

data/lib/quick_captcha/controller_validation.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+module QuickCaptcha #:nodoc
+  module ControllerValidation #:nodoc
+
+    include QuickCaptcha::CaptchaUtils
+
+    # This method is to validate the simple captcha in controller.
+    # It means when the captcha is controller based i.e. :object has not been passed to the method show_simple_captcha.
+    #
+    # *Example*
+    #
+    # If you want to save an object say @user only if the captcha is validated then do like this in action...
+    #
+    #  if simple_captcha_valid?
+    #   @user.save
+    #  else
+    #   flash[:notice] = "captcha did not match"
+    #   redirect_to :action => "myaction"
+    #  end
+    def quick_captcha_valid?
+      simple_captcha_valid?
+    end
+
+    def simple_captcha_valid?
+      if captcha = params[:captcha]
+        result = simple_captcha_matches?(captcha)
+        simple_captcha_passed! if result
+        result
+      else
+        false
+      end
+    end
+
+  end
+end

data/lib/quick_captcha/engine.rb

@@ -0,0 +1,6 @@
+module QuickCaptcha
+  class Engine < Rails::Engine
+    isolate_namespace QuickCaptcha
+
+  end
+end

data/lib/quick_captcha/image_helpers.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+module QuickCaptcha #:nodoc
+  module ImageHelpers #:nodoc
+
+    def generate_simple_captcha_image(options = {})
+      options = QuickCaptcha.image_options.merge(options)
+      key = options.delete(:simple_captcha_key)
+      captcha_text = QuickCaptcha::CaptchaUtils.simple_captcha_value(key)
+      options[:captcha_text] = captcha_text
+      options[:distortion] = distortion(options[:distortion])
+      options[:image_style] = image_style(options[:image_style])
+      QuickCaptcha.backend.generate_simple_captcha_image(options)
+    end
+
+    IMAGE_STYLES = [
+      'embosed_silver',
+      'simply_red',
+      'simply_green',
+      'simply_blue',
+      'distorted_black',
+      'all_black',
+      'charcoal_grey',
+      'almost_invisible'
+    ]
+
+    private
+
+      def image_style(key)
+        return IMAGE_STYLES[rand(IMAGE_STYLES.length)] if key == 'random'
+        IMAGE_STYLES.include?(key) ? key : nil # 'simply_blue'
+      end
+
+      DISTORTIONS = ['low', 'medium', 'high']
+
+      def distortion(key)
+        key = key == 'random' ?
+          DISTORTIONS[rand(DISTORTIONS.length)] :
+          DISTORTIONS.include?(key) ? key : 'low'
+        case key
+          when 'low' then return [0 + rand(2), 80 + rand(20)]
+          when 'medium' then return [2 + rand(2), 50 + rand(20)]
+          when 'high' then return [4 + rand(2), 30 + rand(20)]
+        end
+      end
+
+  end
+
+end

data/lib/quick_captcha/model_validation.rb

@@ -0,0 +1,124 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+module QuickCaptcha #:nodoc
+  module ModelValidation #:nodoc
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # To implement model based simple captcha use this method in the model as...
+    #
+    #  class User < ActiveRecord::Base
+    #    validates_captcha :message => "Are you a bot?"
+    #  end
+    # 
+    # Configuration options:
+    #
+    #   * :add_to_base - Specifies if error should be added to base or captcha field. defaults to false.
+    #   * :message - A custom error message (default is: "Secret Code did not match with the Image")
+    #   * :on - Specifies when this validation is active (default is :save, other options :create, :update)
+    #   * :if - Specifies a method, proc or string to call to determine if the validation should occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The method, proc or string should return or evaluate to a true or false value.
+    #   * :unless - Specifies a method, proc or string to call to determine if the validation should not occur (e.g. :unless => :skip_validation, or :unless => Proc.new { |user| user.signup_step <= 2 }). The method, proc or string should return or evaluate to a true or false value.
+    #
+    module ClassMethods
+      
+      def validates_captcha(options = {})
+        orig_options = options
+        # AR by default looks into the following i18n scope :
+        # :'activerecord.errors.messages.record_invalid'
+        options = { :message => :captcha }
+        options.update(orig_options)
+
+        attr_accessor :captcha, :captcha_key 
+        include QuickCaptcha::ModelValidation::InstanceMethods
+
+        validate =
+          case (options[:on] || :save)
+            when :save   then :validate
+            when :create then :validate_on_create
+            when :update then :validate_on_update
+          end
+        send(validate, options) do |record|
+          if !record.captcha_validation?
+            true
+          elsif record.captcha_is_valid?
+            true
+          elsif options[:add_to_base]
+            record.errors.add_to_base(options[:message])
+            false
+          else
+            record.errors.add(:captcha, options[:message])
+            false
+          end
+        end
+      end
+
+      def apply_quick_captcha(options = {})
+        apply_simple_captcha(options)
+      end
+
+      def apply_simple_captcha(options = {}) # 4 backward compatibility
+        outcome = validates_captcha(options)
+        self.captcha_validation = false
+        include QuickCaptcha::ModelValidation::SaveWithCaptcha
+        outcome
+      end
+
+      def captcha_validation?
+        defined?(@_captcha_validation) ? @_captcha_validation : true
+      end
+
+      def captcha_validation=(flag)
+        @_captcha_validation = flag
+      end
+
+    end
+
+    module InstanceMethods
+
+      def captcha_is_valid?
+        QuickCaptcha::CaptchaUtils.simple_captcha_matches?(captcha, captcha_key)
+      end
+
+      def captcha_validation?
+        if defined?(@_captcha_validation) && ! @_captcha_validation.nil?
+          @_captcha_validation
+        else
+          self.class.captcha_validation?
+        end
+      end
+
+      def captcha_validation(flag = true)
+        prev = @_captcha_validation
+        @_captcha_validation = flag
+        if block_given?
+          outcome = yield
+          @_captcha_validation = prev
+        end
+        outcome
+      end
+
+    end
+
+    module SaveWithCaptcha
+
+      if defined?(ActiveModel) && ActiveModel::VERSION::MAJOR >= 3
+
+        def save_with_captcha(options = {})
+          options[:validate] = true unless options.has_key?(:validate)
+          captcha_validation(true) { save(options) }
+        end
+
+      else
+
+        def save_with_captcha
+          captcha_validation(true) { save }
+        end
+
+      end
+    end
+
+
+  end
+end

data/lib/quick_captcha/quick_magick_backend.rb

@@ -0,0 +1,68 @@
+
+require 'quick_magick'
+
+module QuickCaptcha
+
+  module QuickMagickBackend
+
+    def self.generate_simple_captcha_image(options)
+      width, height = options[:image_size].split('x')
+      
+      image = QuickMagick::Image::solid(width, height, options[:image_color])
+      image.format = 'JPG'
+
+      image = set_simple_captcha_image_style(image, options)
+      image.implode(0.2).to_blob
+    end
+
+    private
+
+    def self.set_simple_captcha_image_style(image, options)
+      amplitude, frequency = options[:distortion]
+      case options[:image_style]
+      when 'embosed_silver'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency).shade('20x60')
+      when 'simply_red'
+        options[:text_color] = 'darkred'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency)
+      when 'simply_green'
+        options[:text_color] = 'darkgreen'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency)
+      when 'simply_blue'
+        options[:text_color] = 'darkblue'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency)
+      when 'distorted_black'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency).edge(10)
+      when 'all_black'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency).edge(2)
+      when 'charcoal_grey'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency).charcoal(0)
+      when 'almost_invisible'
+        options[:text_color] = 'red'
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency).solarize(50)
+      else
+        append_simple_captcha_code(image, options)
+        image = image.wave(amplitude, frequency)
+      end
+      return image
+    end
+
+    def self.append_simple_captcha_code(image, options)
+      image.family = options[:text_font]
+      image.pointsize = options[:text_size]
+      image.fill = options[:text_color]
+      image.gravity = 'center'
+      image.draw_text 0, 5, options[:captcha_text]
+    end
+
+  end
+
+end

data/lib/quick_captcha/version.rb

@@ -0,0 +1,10 @@
+module QuickCaptcha
+  module VERSION #:nodoc:
+    MAJOR = 3
+    MINOR = 2
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end
+

data/lib/quick_captcha/view_helpers.rb

@@ -0,0 +1,132 @@
+# Copyright (c) 2008 [Sur http://expressica.com]
+
+module QuickCaptcha #:nodoc
+  module ViewHelpers #:nodoc
+
+    include QuickCaptcha::CaptchaUtils
+
+    # Simple Captcha is a very simplified captcha.
+    #
+    # It can be used as a *Model* or a *Controller* based Captcha depending on what options
+    # we are passing to the method show_simple_captcha.
+    #
+    # *show_simple_captcha* method will return the image, the label and the text box.
+    # This method should be called from the view within your form as...
+    #
+    # <%= show_simple_captcha %>
+    #
+    # The available options to pass to this method are
+    # * label
+    # * image_syle
+    # * object
+    # * distortion
+    #
+    # <b>Label:</b>
+    #
+    # default label is "type the text from the image", it can be modified by passing :label as
+    #
+    # <%= show_simple_captcha(:label => "new captcha label") %>.
+    #
+    # <b>Image Style:</b>
+    #
+    # There are eight different styles of images available as...
+    # * embosed_silver
+    # * simply_red
+    # * simply_green
+    # * simply_blue
+    # * distorted_black
+    # * all_black
+    # * charcoal_grey
+    # * almost_invisible
+    #
+    # The default image is simply_blue and can be modified by passing any of the above style as...
+    #
+    # <%= show_simple_captcha(:image_style => "simply_red") %>
+    #
+    # The images can also be selected randomly by using *random* in the image_style as
+    # 
+    # <%= show_simple_captcha(:image_style => "random") %>
+    #
+    # *Object*
+    #
+    # This option is needed to create a model based captcha.
+    # If this option is not provided, the captcha will be controller based and
+    # should be checked in controller's action just by calling the method simple_captcha_valid?
+    #
+    # To make a model based captcha give this option as...
+    #
+    # <%= show_simple_captcha(:object => "user") %>
+    # and also call the method apply_simple_captcha in the model
+    # this will consider "user" as the object of the model class.
+    #
+    # *Examples*
+    # * controller based
+    # <%= show_simple_captcha(:image_style => "embosed_silver", :label => "Human Authentication: type the text from image above") %>
+    # * model based
+    # <%= show_simple_captcha(:object => "person", :image_style => "simply_blue", :label => "Human Authentication: type the text from image above") %>
+    #
+    # Find more detailed examples with sample images here on my blog http://EXPRESSICA.com
+    #
+    # All Feedbacks/Comments/Issues/Queries are welcome.
+    def show_quick_captcha(options = {})
+      show_simple_captcha(options)
+    end
+
+    def show_simple_captcha(options = {})
+      simple_captcha_key = self.simple_captcha_key
+      options[:field_value] = set_simple_captcha_data(simple_captcha_key, options[:code_type])
+      @simple_captcha_options = {
+         :image => simple_captcha_image(simple_captcha_key, options),
+         :label => options[:label] || "(type the code from the image)", # TODO label
+         :field => simple_captcha_field(options)
+      }
+      render :partial => 'quick_captcha/quick_captcha', 
+             :locals => { :simple_captcha_options => @simple_captcha_options }
+    end
+
+    private
+
+      def simple_captcha_image(simple_captcha_key, options = {})
+        url = main_app.quick_captcha_url(
+            :action => 'show',
+            :simple_captcha_key => simple_captcha_key,
+            :image_style => options[:image_style],
+            :distortion => options[:distortion],
+            :time => Time.now.to_i
+        )
+
+        img = "<img src='#{url}' alt='captcha' />"
+        img = img.html_safe if img.respond_to? :html_safe
+        img
+      end
+
+      def simple_captcha_field(options = {})
+        if object = options[:object]
+          text_field(object, :captcha, :value => '', :autocomplete => 'off') +
+          hidden_field(object, :captcha_key, {:value => options[:field_value]})
+        else
+          text_field_tag(:captcha, nil, :autocomplete => 'off')
+        end
+      end
+
+      def set_simple_captcha_data(simple_captcha_key, code_type = nil)
+        key, value = simple_captcha_key, generate_simple_captcha_data(code_type)
+        data = SimpleCaptchaData.get_data(key)
+        data.value = value
+        data.save!
+        key
+      end
+
+      def generate_simple_captcha_data(code_type = nil)
+        value = ''
+        case code_type
+        when 'numeric'
+          QuickCaptcha.captcha_length.times{ value << (48 + rand(10)).chr }
+        else
+          QuickCaptcha.captcha_length.times{ value << (65 + rand(26)).chr }
+        end
+        value
+      end
+
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: quick_captcha
+version: !ruby/object:Gem::Version
+  version: 3.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam H
+- Marek de Heus
+- Karol Bucek
+- Kei Kusakari
+- nap
+- Sur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: quick_magick
+  requirement: &70332610336100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70332610336100
+description: Forked from https://github.com/kares/simple_captcha
+email:
+- ahull@tnsolutionsinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/quick_captcha_controller.rb
+- app/models/simple_captcha_data.rb
+- app/views/quick_captcha/_quick_captcha.erb
+- config/initializers/quick_captcha.rb
+- config/routes.rb
+- lib/generators/quick_captcha_generator.rb
+- lib/generators/templates/migration.rb
+- lib/quick_captcha/captcha_utils.rb
+- lib/quick_captcha/controller_validation.rb
+- lib/quick_captcha/engine.rb
+- lib/quick_captcha/image_helpers.rb
+- lib/quick_captcha/model_validation.rb
+- lib/quick_captcha/quick_magick_backend.rb
+- lib/quick_captcha/version.rb
+- lib/quick_captcha/view_helpers.rb
+- lib/quick_captcha.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://tnsolutionsinc.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple Captcha solution using lightweight QuickMagick backend implemented
+  as Rails 3.2 engine
+test_files: []