custom_captcha 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/CHANGELOG

@@ -0,0 +1,4 @@
+== 0.1.0
+
+* First release
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+

data/Guardfile

@@ -0,0 +1,22 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/README.markdown

@@ -0,0 +1,107 @@
+== CustomCaptcha
+
+CustomCaptcha is a simple and custom captcha plugin for Rails3.
+
+
+== Supported versions
+
+* Ruby 1.8.7, 1.9.2, 1.9.3
+
+* Rails 3.0.x, 3.1
+
+* ImageMagick should be installed on your machine to use this plugin.
+
+
+== Installation
+
+In your app's `Gemfile`, add:
+
+    gem "custom_captcha", :git => "git://github.com/vkill/custom_captcha.git"
+
+Then run:
+
+    bundle
+    rails generate custom_captcha:install
+
+If you want to modify default captcha images storage location, edit your `config/initializers/custom_captcha.rb`
+
+Then run:
+
+    bundle exec rake custom_captcha:generate_images[100]
+
+
+== Base Usage
+
+=== View helper
+
+In the view file within the form tags add this code
+
+  <%= display_custom_captcha %>
+
+and in the controller's action authenticate it as
+
+  if custom_captcha_valid?(params[:custom_captcha])
+    flash[:notice] = "captcha did match."
+  else
+    flash[:notice] = "captcha did not match."
+  end
+
+=== FormBuilder helper
+
+In the model class add this code
+
+  class User < ActiveRecord::Basse
+    apply_custom_captcha
+  end
+
+and in the view file within the form tags write this code
+
+  <%= form_for @user do |form| -%>
+    ...
+    <%= form.custom_captcha %>
+    ...
+  <% end -%>
+
+
+== Usage your custom captcha area template
+
+first, copy and modify your custom captcha area template
+
+    cd app/views/custom_captcha/captcha_styles/
+    cp _default.html.erb _mycaptcha.html.erb
+
+and then in the view file your the use of
+
+  <%= display_custom_captcha(:template => :mycaptcha) %>
+
+
+== Options & Examples
+
+=== Helper Options, View helper and FormBuilder helper
+
+* *template* - use your custom template
+
+* *label_text* - custom label text
+
+* *key_id* - custom captcha hidden input key id
+
+* *key_name* - custom captcha hidden input key name
+
+* *field_name* - custom captcha input field name
+
+* *img_id* - custom captcha img id
+
+* *change_text* - custom change text
+
+=== Examples
+
+  <%= display_custom_captcha(:img_id => :captcha, :label_text => "captcha", :field_name => :captcha %>
+
+
+== I18n supported
+
+
+== Copyright
+
+Copyright (c) 2011 vkill.net .
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/custom_captcha/captcha_images_controller.rb

@@ -0,0 +1,28 @@
+class CustomCaptcha::CaptchaImagesController < ApplicationController
+
+  respond_to :html, :js, :json
+
+  def show
+    @image_file_path = read_image_file_path(params[:key])
+    respond_to do |format|
+      format.html {
+        send_file(@image_file_path, :type => 'image/jpeg', :disposition => 'inline', :filename => 'custom_captcha.jpg')
+      }
+      format.json { render :json => {:image_file_path => @image_file_path} }
+    end
+  end
+
+  def change
+    @img_id = params[:img_id] || CustomCaptcha::DEFAULTVALUE[:img_id]
+    @key_id = params[:key_id] || CustomCaptcha::DEFAULTVALUE[:key_id]
+    @key = choice_image_file_path_and_write_session_cache()
+    @img_src = show_captcha_image_path(@key)
+
+    respond_to do |format|
+      format.js
+      format.json { render :json => {@img_id => @img_src, @key_id => @key} }
+    end
+  end
+
+end
+

data/app/views/custom_captcha/captcha_images/change.html.erb

@@ -0,0 +1,2 @@
+if you see this message, please mail to administrator!
+

data/app/views/custom_captcha/captcha_images/change.js.erb

@@ -0,0 +1,3 @@
+$("img#<%= @img_id %>").attr("src", "<%= @img_src %>")
+$("input#<%= @key_id %>").attr("value", "<%= @key %>")
+

data/app/views/custom_captcha/captcha_images/show.html.erb

@@ -0,0 +1,2 @@
+if you see this message, please mail to administrator!
+

data/app/views/custom_captcha/captcha_styles/_default.html.erb

@@ -0,0 +1,10 @@
+<br/>
+
+<%= label_tag captcha[:label_text] %>
+<%= text_field_tag captcha[:field_name] %>
+<%= hidden_field_tag captcha[:key_name], captcha[:key], :id => captcha[:key_id] %>
+<%= image_tag captcha[:img_src], :id => captcha[:img_id], :alt => captcha[:label_text] %>
+<%= link_to captcha[:change_text], captcha[:change_url], :remote => true %>
+
+<br/>
+

data/config/locales/custom_captcha.en.yml

@@ -0,0 +1,6 @@
+en:
+  custom_captcha:
+    label: "captcha"
+    change: "changing a picture"
+    message: "Secret Code did not match with the Image"
+

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+  match "captcha_images/change" => "custom_captcha/captcha_images#change",
+          :as => :change_captcha_images
+
+  match "captcha_images/:key" => "custom_captcha/captcha_images#show",
+          :as => :show_captcha_image,
+          :constraints => { :key => /[A-Za-z0-9]{32,40}/ }
+end
+

data/custom_captcha.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "custom_captcha/version"
+
+Gem::Specification.new do |s|
+  s.name        = "custom_captcha"
+  s.version     = CustomCaptcha::VERSION
+  s.date        = Date.today
+  s.authors     = ["vkill"]
+  s.email       = ["vkill.net@gmail.com"]
+  s.homepage    = "https://github.com/vkill/custom_captcha"
+  s.summary     = "A simple and custom captcha for Rails3."
+  s.description = "A simple and custom captcha for Rails3."
+
+  s.rubyforge_project = "custom_captcha"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard-rspec"
+  s.add_dependency "rails", "~> 3.0"
+  s.add_dependency "rmagick", "~> 2.13.1"
+  s.add_dependency 'jquery-rails', "~> 1.0.16"
+
+end
+

data/lib/custom_captcha.rb

@@ -0,0 +1,39 @@
+require "active_support/concern"
+require "active_support/core_ext/object"
+require "active_support/core_ext/class/attribute_accessors"
+require "active_support/core_ext/module/attribute_accessors"
+require "securerandom"
+require "RMagick"
+include Magick
+require "tmpdir"
+require "fileutils"
+require "digest/md5"
+require "find"
+
+require 'custom_captcha/errors'
+require 'custom_captcha/version'
+require 'custom_captcha/configuration'
+require 'custom_captcha/utils'
+require 'custom_captcha/image'
+
+require "rails"
+require "custom_captcha/engine"
+require "custom_captcha/railtie"
+
+module CustomCaptcha
+  DEFAULTVALUE = {
+    :field_name => :custom_captcha,
+    :key_name => :custom_captcha_key,
+    :key_id => :custom_captcha_key,
+    :img_id => :custom_captcha_img,
+    :template => 'default'
+  }
+  class << self
+    def configure(&block)
+      CustomCaptcha::Configuration.configure(&block)
+    end
+  end
+  # init configuration
+  CustomCaptcha::Configuration.init_config()
+end
+

data/lib/custom_captcha/action_controller_extension.rb

@@ -0,0 +1,42 @@
+module CustomCaptcha
+  module ActionControllerExtension
+    extend ActiveSupport::Concern
+    included do
+      include CustomCaptcha::CommonMethods
+      helper_method :choice_image_file_path_and_write_session_cache,
+                    :read_captcha_digested, :read_image_file_path
+    end
+    module ClassMethods
+    end
+    module InstanceMethods
+      def custom_captcha_valid?(captcha_value=nil)
+        if CustomCaptcha::Configuration.disable? or Rails.env.test?
+          return true
+        end
+        captcha_value ||= params[CustomCaptcha::DEFAULTVALUE[:field_name]]
+        if captcha_value
+          CustomCaptcha::Utils.captcha_value_valid?(captcha_value, read_captcha_digested())
+        else
+          return false
+        end
+      end
+
+      def choice_image_file_path_and_write_session_cache
+        image_file_path, captcha_digested, key =
+                  CustomCaptcha::Utils.choice_image_file_path_and_generate_captcha_digested_key
+        session[:captcha_digested] = captcha_digested
+        Rails.cache.write(key, [image_file_path, captcha_digested])
+        key
+      end
+
+      def read_captcha_digested
+        session[:captcha_digested]
+      end
+
+      def read_image_file_path(key)
+        Rails.cache.read(key)[0] rescue nil
+      end
+    end
+  end
+end
+

data/lib/custom_captcha/action_view_extension.rb

@@ -0,0 +1,56 @@
+module CustomCaptcha
+  module ActionViewExtension
+    module Base
+      extend ActiveSupport::Concern
+      included do
+        include CustomCaptcha::CommonMethods
+      end
+      module ClassMethods
+      end
+      module InstanceMethods
+        def display_custom_captcha(options={})
+          return "" if CustomCaptcha::Configuration.disable?
+          options[:key] = choice_image_file_path_and_write_session_cache
+
+          options[:field_name] ||= CustomCaptcha::DEFAULTVALUE[:field_name]
+          options[:key_name] ||= CustomCaptcha::DEFAULTVALUE[:key_name]
+          options[:key_id] ||= CustomCaptcha::DEFAULTVALUE[:key_id]
+          options[:img_id] ||= CustomCaptcha::DEFAULTVALUE[:img_id]
+
+          options[:img_src] = show_captcha_image_path(options[:key])
+          options[:template] ||= CustomCaptcha::DEFAULTVALUE[:template]
+          options[:label_text] ||= I18n.t('custom_captcha.label')
+          options[:change_text] ||= I18n.t('custom_captcha.change')
+          options[:change_url] = change_captcha_images_path(:img_id => options[:img_id], :key_id => options[:key_id])
+          render "custom_captcha/captcha_styles/#{options[:template].to_s}", :captcha => options
+        end
+      end
+    end
+
+    module Helpers
+      module FormBuilder
+        extend ActiveSupport::Concern
+        included do
+          include CustomCaptcha::CommonMethods
+        end
+        module ClassMethods
+        end
+        module InstanceMethods
+          def custom_captcha(options={})
+            return "" unless (@object.custom_captcha_key rescue nil)
+            options[:object_name] = @object_name.to_s
+            options[:key] = @object.custom_captcha_key
+
+            options[:field_name] = object_field_name options[:object_name], CustomCaptcha::DEFAULTVALUE[:field_name]
+            options[:key_name] = object_field_name options[:object_name], CustomCaptcha::DEFAULTVALUE[:key_name]
+            options[:key_id] = object_field_id options[:object_name], CustomCaptcha::DEFAULTVALUE[:key_id]
+            options[:img_id] = object_field_id options[:object_name], CustomCaptcha::DEFAULTVALUE[:img_id]
+
+            @template.display_custom_captcha(options)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/custom_captcha/active_record_extension.rb

@@ -0,0 +1,51 @@
+module CustomCaptcha
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+    included do
+      include CustomCaptcha::CommonMethods
+      extend ClassMethods
+    end
+    module ClassMethods
+      def apply_custom_captcha
+        attr_accessor :custom_captcha, :custom_captcha_key
+
+        after_initialize do
+          after_initialize if custom_captcha_need_valid?
+        end
+
+        validate :valid_custom_captcha, :if => :custom_captcha_need_valid?
+
+        include CustomCaptcha::ActiveRecordExtension::InstanceMethods
+      end
+    end
+    module InstanceMethods
+      def after_initialize
+        self.custom_captcha_key ||= choice_image_file_path_and_write_cache
+      end
+
+      def valid_custom_captcha
+        unless CustomCaptcha::Utils.captcha_value_valid?(custom_captcha, read_captcha_digested())
+          errors.add(:custom_captcha, I18n.t('custom_captcha.message'))
+        end
+      end
+
+      def custom_captcha_need_valid?
+        !CustomCaptcha::Configuration.disable? and !Rails.env.test?
+      end
+
+      private
+        def choice_image_file_path_and_write_cache
+          image_file_path, captcha_digested, key =
+                    CustomCaptcha::Utils.choice_image_file_path_and_generate_captcha_digested_key
+          Rails.cache.write(key, [image_file_path, captcha_digested])
+          key
+        end
+
+        def read_captcha_digested
+          Rails.cache.read(self.custom_captcha_key)[1] rescue ""
+        end
+
+    end
+  end
+end
+

data/lib/custom_captcha/common_methods.rb

@@ -0,0 +1,13 @@
+module CustomCaptcha
+  module CommonMethods
+    private
+      def object_field_name(object_name, field_name)
+        object_name.to_s + "[" + field_name.to_s + "]"
+      end
+
+      def object_field_id(object_name, field_name)
+        object_name.to_s + "_" + field_name.to_s
+      end
+  end
+end
+

data/lib/custom_captcha/configuration.rb

@@ -0,0 +1,107 @@
+module CustomCaptcha
+  module Configuration
+
+    mattr_accessor  :image_columns,
+                    :image_rows,
+                    :image_style,
+                    :text_range,
+                    :text_length,
+                    :images_path,
+                    :enable,
+                    :salt
+    mattr_reader    :images_path_definite
+
+    class << self
+
+      def configure
+        yield self
+        # make inage files path and defined @@images_path_definite
+        make_and_define_images_path()
+        # reload all image files key
+        CustomCaptcha::Utils.reload_image_files_paths()
+      end
+
+      def reset_config
+        configure do |config|
+          config.image_columns  = default_image_columns()
+          config.image_rows     = default_image_rows()
+          config.image_style    = CustomCaptcha::Image.image_style.keys.first
+          config.text_range     = default_text_range()
+          config.text_length    = default_text_length()
+          config.images_path    = default_images_path()
+          config.enable         = true
+          config.salt           = SecureRandom.hex(10)
+        end
+        make_and_define_images_path()
+      end
+      alias_method :init_config, :reset_config
+
+      def disable?
+        !@@enable
+      end
+
+      #image columns setting
+      def default_image_columns
+        120
+      end
+      def image_columns
+        image_columns = @@image_columns.to_i.blank? ? default_image_columns() : @@image_columns
+      end
+
+      #image rows setting
+      def default_image_rows
+        40
+      end
+      def image_rows
+        image_rows = @@image_rows.to_i.blank? ? default_image_rows() : @@image_rows
+      end
+
+      #image style setting
+      def default_image_style
+
+      end
+
+      #image text range setting
+      def default_text_range
+        ('a'..'z').to_a + (0..9).to_a
+      end
+      def text_range
+        text_range = @@text_range.to_a.blank? ? default_text_range() : @@text_range
+      end
+
+      #image text length setting
+      def default_text_length
+        5
+      end
+      def text_length
+        text_length = @@text_length.to_i.blank? ? default_text_length() : @@text_length
+        if 4 < text_length or text_length < 10
+          text_length
+        else
+          default_text_length()
+        end
+      end
+
+      #images path setting
+      def default_images_path
+        File.join(Dir::tmpdir, 'captcha_images')
+      end
+      def images_path
+        images_path = @@images_path.to_s.blank? ? default_images_path() : @@images_path
+      end
+
+      #images path make and define
+      def make_and_define_images_path
+        images_path = images_path()
+        begin
+          FileUtils.mkdir_p images_path
+        rescue
+          raise CustomCaptcha::MakeImagePathError
+        else
+          @@images_path_definite = images_path
+        end
+      end
+    end
+  end
+end
+

data/lib/custom_captcha/engine.rb

@@ -0,0 +1,5 @@
+module CustomCaptcha
+  class Engine < ::Rails::Engine
+  end
+end
+

data/lib/custom_captcha/errors.rb

@@ -0,0 +1,5 @@
+module CustomCaptcha
+  class MakeImagePathError < StandardError; end
+  class InitImageFilesKeyError < StandardError; end
+end
+

data/lib/custom_captcha/image.rb

@@ -0,0 +1,86 @@
+module CustomCaptcha
+  module Image
+    mattr_reader :image_style
+    @@image_style = {
+      :simply_blue => {:background_color => :white, :text_fill => :darkblue, :text_font_family => :helvetica}
+    }
+    #image text length and image text font_size proportion
+    @@font_size = {
+      4 => 46,
+      5 => 41,
+      6 => 36,
+      7 => 31,
+      8 => 26,
+      9 => 21,
+      10 => 16
+    }
+
+    class << self
+      def create(number=1, &block)
+        image_style_simply_blue = @@image_style[:simply_blue]
+        image_style = @@image_style[CustomCaptcha::Configuration.image_style] || image_style_simply_blue
+        options = {}
+        options[:background_color] = image_style[:background_color] || image_style_simply_blue[:background_color]
+        options[:text_fill] = image_style[:text_fill] || image_style_simply_blue[:text_fill]
+        options[:text_font_family] = image_style[:text_font_family] || image_style_simply_blue[:text_font_family]
+        image_files = create_image_files(number, options, &block)
+      end
+    end
+
+    private
+      class << self
+        def generate_image_text
+          text_range = CustomCaptcha::Configuration.text_range
+          text_length = CustomCaptcha::Configuration.text_length
+          text_range.to_a.sort_by!{rand()}.take(text_length).join()
+        end
+
+        def generate_image_file_path(text)
+          File.join(
+            CustomCaptcha::Utils.image_file_dirname(),
+            [
+              CustomCaptcha::Utils.image_file_basename(text),
+              CustomCaptcha::Utils.image_file_extname()
+            ].join()
+          )
+        end
+
+        def create_image_files(number, options={}, &block)
+          columns = CustomCaptcha::Configuration.image_columns
+          rows = CustomCaptcha::Configuration.image_rows
+
+          image_files = []
+          number.to_i.times do |n|
+            canvas = Magick::ImageList.new
+            canvas.new_image(columns, rows) {
+              self.background_color = options[:background_color].to_s
+            }
+            text = Magick::Draw.new
+            text.font_family = options[:text_font_family].to_s
+            text.fill = options[:text_fill].to_s
+            text.gravity = Magick::CenterGravity
+
+            image_text = generate_image_text()
+            text.annotate(canvas, 0,0,0,0, image_text) {
+              self.pointsize = @@font_size[image_text.length]
+            }
+            image_file = generate_image_file_path(image_text)
+            begin
+              canvas.write(image_file)
+            rescue
+              yield(number, n+1, "failed", image_file) if block
+              next
+            else
+              yield(number, n+1, "succeed", image_file) if block
+              image_files << image_file
+            ensure
+              canvas.clear
+            end
+          end
+          image_files
+        end
+
+      end
+  end
+end
+

data/lib/custom_captcha/railtie.rb

@@ -0,0 +1,25 @@
+require 'custom_captcha/common_methods'
+require 'custom_captcha/action_controller_extension'
+require 'custom_captcha/action_view_extension'
+require 'custom_captcha/active_record_extension'
+
+module CustomCaptcha
+  class Railtie < ::Rails::Railtie
+    initializer 'custom_captcha' do |app|
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send :include, CustomCaptcha::ActionControllerExtension
+      end
+
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, CustomCaptcha::ActionViewExtension::Base
+        ActionView::Helpers::FormBuilder.send :include,
+                                CustomCaptcha::ActionViewExtension::Helpers::FormBuilder
+      end
+
+      ActiveSupport.on_load :active_record do
+        include CustomCaptcha::ActiveRecordExtension
+      end
+    end
+  end
+end
+

data/lib/custom_captcha/utils.rb

@@ -0,0 +1,94 @@
+module CustomCaptcha
+  module Utils
+
+    mattr_reader :image_files_paths, :image_files_paths_choice_size
+    @@image_files_paths = []
+    @@image_files_paths_choice_size = @@image_files_paths.size
+
+    class << self
+
+      def generate_image_files(number=1, &block)
+        CustomCaptcha::Image.create(number, &block)
+      end
+
+      def clear_image_files
+        FileUtils.rm_r Dir[File.join(image_file_dirname(), "**", "*")]
+      end
+
+      def reload_image_files_paths
+        @@image_files_paths.clear
+        reset_image_files_paths()
+      end
+      alias_method :init_image_files_paths, :reload_image_files_paths
+
+
+      def choice_image_file_path_and_generate_captcha_digested_key
+        image_file_path = random_choice_image_file_path
+        captcha_digested = get_captcha_digested(image_file_path)
+        key = hexdigest_text([Time.now.to_i, SecureRandom.hex(10)].join())
+        [image_file_path, captcha_digested, key]
+      end
+
+      def captcha_value_valid?(captcha_value, captcha_digested)
+        image_file_basename_suffix(captcha_value) == captcha_digested
+      end
+
+    end
+
+    private
+      class << self
+        def hexdigest_text(text)
+          Digest::MD5.hexdigest([text.to_s.downcase, CustomCaptcha::Configuration.salt].join())
+        end
+
+        def image_file_dirname
+          CustomCaptcha::Configuration.images_path_definite
+        end
+
+        def image_file_basename_prefix
+#          ("a".."z").to_a.sort_by!{rand()}.take(8).join()
+          SecureRandom.hex(4)
+        end
+
+        def image_file_basename_suffix(text)
+          hexdigest_text(text)
+        end
+
+        def image_file_basename(text)
+          [image_file_basename_prefix, image_file_basename_suffix(text)].join()
+        end
+
+        def image_file_extname
+          ".gif"
+        end
+
+        # if image file path empty, then auto generating 3 image file.
+        def reset_image_files_paths
+          if @@image_files_paths.blank? or @@image_files_paths_choice_size == 0
+            n = 0
+            while true
+              @@image_files_paths = Dir[File.join(image_file_dirname(), ["[a-z0-9]*", image_file_extname()].join())]
+              break unless self.image_files_paths.blank?
+              generate_image_files(3)
+              raise InitImageFilesKeyError if n >= 3
+              n += 1
+            end
+            @@image_files_paths.sort_by!{rand()}
+            @@image_files_paths_choice_size = @@image_files_paths.size
+          end
+        end
+
+        def random_choice_image_file_path
+          reset_image_files_paths()
+          @@image_files_paths_choice_size -= 1
+          @@image_files_paths[@@image_files_paths_choice_size]
+        end
+
+        def get_captcha_digested(image_file_path)
+          image_file_basename = File.basename(image_file_path, image_file_extname())
+          image_file_basename[-32..-1]
+        end
+      end
+  end
+end
+

data/lib/custom_captcha/version.rb

@@ -0,0 +1,4 @@
+module CustomCaptcha
+  VERSION = "0.1.0"
+end
+

data/lib/generators/custom_captcha/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/custom_captcha/install/install_generator.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../utils', __FILE__)
+
+class CustomCaptcha::InstallGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  include CustomCaptcha::Generators::Utils::InstanceMethods
+
+  desc "Creates CustomCaptcha initializer and copy locale files to your application."
+
+  def create_initializer
+    data_custom_captcha_rb = %Q/
+CustomCaptcha.configure do |config|
+  config.image_columns  = 120
+  config.image_rows     = 40
+  config.image_style    = "simply_blue"
+  config.text_range     = ("a".."z").to_a
+  config.text_length    = 5
+  config.images_path    = Rails.root.join("public", "system", "captcha_images").to_s
+  config.enable         = true
+  config.salt           = "#{ SecureRandom.hex(20) }"
+end
+    /
+    initializer "custom_captcha.rb", data_custom_captcha_rb
+  end
+
+  def create_locale
+    copy_file "../../../../../config/locales/custom_captcha.en.yml", "config/locales/custom_captcha.en.yml"
+  end
+
+  def create_views
+    filename_pattern = File.expand_path("../../../../../app/views/custom_captcha/captcha_styles/*", __FILE__)
+    Dir[filename_pattern].each do |f|
+      copy_file f, "app/views/custom_captcha/captcha_styles/#{File.basename f}"
+    end
+  end
+
+  def test_rakes
+    display "test generate and clear images..."
+    rake("custom_captcha:generate_images[1]")
+    rake("custom_captcha:clear_images")
+  end
+
+  def show_readme
+    display "Succeed! custom_captcha has been installed."
+    readme("README")
+  end
+end
+

data/lib/generators/custom_captcha/install/templates/README

@@ -0,0 +1,18 @@
+===============================================================================
+
+Some setup you must do manually:
+
+  1. Modify captcha images directory in config/initializers/custom_captcha.rb.
+     For example:
+
+       config.images_path = Rails.root.join("public", "captcha_images").to_s
+
+  2. Generate captcha images.
+
+       # bundle exec rake custom_captcha:generate_images[100]
+
+
+Homepage: https://github.com/vkill/custom_captcha
+by: vkill
+===============================================================================
+

data/lib/generators/custom_captcha/uninstall/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate uninstall Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/custom_captcha/uninstall/templates/README

@@ -0,0 +1,2 @@
+Homepage: https://github.com/vkill/custom_captcha
+

data/lib/generators/custom_captcha/uninstall/uninstall_generator.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../../utils', __FILE__)
+
+class CustomCaptcha::UninstallGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  include CustomCaptcha::Generators::Utils::InstanceMethods
+
+  desc "Remove CustomCaptcha initializer and remove locale files from your application."
+
+  def clear_images
+    rake("custom_captcha:clear_images")
+  end
+
+  def destroy_initializer
+    remove_file "config/initializers/custom_captcha.rb"
+  end
+
+  def destroy_locale
+    remove_file "config/locales/custom_captcha.en.yml"
+  end
+
+  def destroy_views
+#    filename_pattern = File.expand_path("../../../../../app/views/custom_captcha/captcha_styles/*", __FILE__)
+#    Dir[filename_pattern].each do |f|
+#      copy_file f, "app/views/custom_captcha/captcha_styles/#{File.basename f}"
+#    end
+    Dir["app/views/custom_captcha/captcha_styles/*"].each do |f|
+      remove_file f
+    end
+  end
+
+  def show_readme
+    display "Done! custom_captcha has been uninstalled."
+    readme("README")
+  end
+end
+

data/lib/generators/custom_captcha/utils.rb

@@ -0,0 +1,12 @@
+module CustomCaptcha
+  module Generators
+    module Utils
+      module InstanceMethods
+        def display(output, color = :green)
+          say("           -  #{output}", color)
+        end
+      end
+    end
+  end
+end
+

data/lib/tasks/custom_captcha_utils.rake

@@ -0,0 +1,26 @@
+#encoding: utf-8
+
+require "rubygems"
+require "bundler/setup"
+
+require "custom_captcha"
+
+namespace :custom_captcha do
+  desc "Generate {count} captcha images."
+  task :generate_images, [:count] => :environment do |t, args|
+    args.with_defaults(:count => 3)
+    count = args[:count].to_i
+    CustomCaptcha::Utils.generate_image_files(count) do |number, n, state, image_file|
+      puts "           -  [%s/%s] %s Generating %s" % [ n, number, state.capitalize!, image_file ]
+    end
+  end
+
+  desc "Clear captcha images."
+  task :clear_images => :environment do |t|
+    print "\r           -  Clearing captcha images..."
+    CustomCaptcha::Utils.clear_image_files()
+    print "done\n"
+  end
+
+end
+

data/spec/configuration_spec.rb

@@ -0,0 +1,19 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe CustomCaptcha::Configuration do
+
+  it "should set a configuration" do
+    CustomCaptcha::Configuration.text_length.should == 5
+    CustomCaptcha.configure do |config|
+      config.text_length = 6
+    end
+    CustomCaptcha::Configuration.text_length.should == 6
+  end
+
+  it "should define images path and create images path" do
+    CustomCaptcha::Configuration.make_and_define_images_path()
+    File.exist?(CustomCaptcha::Configuration.images_path_definite).should be_true
+  end
+end
+

data/spec/image_spec.rb

@@ -0,0 +1,10 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe CustomCaptcha::Image do
+
+  it "should create a image" do
+    CustomCaptcha::Image.create().should be_true
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+#encoding: utf-8
+
+require "rubygems"
+require "bundler/setup"
+require "custom_captcha"
+

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: custom_captcha
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- vkill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70249600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70249600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70249330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70249330
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70249040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70249040
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70248730 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248730
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70248350 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70248350
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: &70248000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70248000
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: &70247670 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.16
+  type: :runtime
+  prerelease: false
+  version_requirements: *70247670
+description: A simple and custom captcha for Rails3.
+email:
+- vkill.net@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- Guardfile
+- README.markdown
+- Rakefile
+- app/controllers/custom_captcha/captcha_images_controller.rb
+- app/views/custom_captcha/captcha_images/change.html.erb
+- app/views/custom_captcha/captcha_images/change.js.erb
+- app/views/custom_captcha/captcha_images/show.html.erb
+- app/views/custom_captcha/captcha_styles/_default.html.erb
+- config/locales/custom_captcha.en.yml
+- config/routes.rb
+- custom_captcha.gemspec
+- lib/custom_captcha.rb
+- lib/custom_captcha/action_controller_extension.rb
+- lib/custom_captcha/action_view_extension.rb
+- lib/custom_captcha/active_record_extension.rb
+- lib/custom_captcha/common_methods.rb
+- lib/custom_captcha/configuration.rb
+- lib/custom_captcha/engine.rb
+- lib/custom_captcha/errors.rb
+- lib/custom_captcha/image.rb
+- lib/custom_captcha/railtie.rb
+- lib/custom_captcha/utils.rb
+- lib/custom_captcha/version.rb
+- lib/generators/custom_captcha/install/USAGE
+- lib/generators/custom_captcha/install/install_generator.rb
+- lib/generators/custom_captcha/install/templates/README
+- lib/generators/custom_captcha/uninstall/USAGE
+- lib/generators/custom_captcha/uninstall/templates/README
+- lib/generators/custom_captcha/uninstall/uninstall_generator.rb
+- lib/generators/custom_captcha/utils.rb
+- lib/tasks/.gitkeep
+- lib/tasks/custom_captcha_utils.rake
+- spec/configuration_spec.rb
+- spec/image_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vkill/custom_captcha
+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: custom_captcha
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple and custom captcha for Rails3.
+test_files:
+- spec/configuration_spec.rb
+- spec/image_spec.rb
+- spec/spec_helper.rb
+has_rdoc: