tiny_captcha 0.0.1 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7470acbf45a2f9152ed8f19180067c67714090e
+  data.tar.gz: 6a9fb11adfc2d802b7a2579be6d279d48e83ec6b
+SHA512:
+  metadata.gz: e4590af09ba5857c23fe31f597afeef564b461f90dcacfd3f93fa24f62acbaf99f08f1a28878f7760f8eb60b55e15b903885dfd84cb08805f5ecac018c376a7e
+  data.tar.gz: e88bfba0336b263b24f8f3b041b258e16e11e2897cfd334a23bca7565f7bd9e144b86aa1542a7cf91f42e873e08f5fef3759be525f3cf0ae157239f185f8b466

data/app/controllers/tiny_captcha/application_controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module TinyCaptcha
   class ApplicationController < ActionController::Base
   end

data/app/controllers/tiny_captcha/images_controller.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha
+  class ImagesController < ::ActionController::Base
+    #
+    # params:
+    #  - object
+    #
+    def new
+      @tiny_captcha_options = generate_tiny_captcha_options(:object => params[:object])
+
+      respond_to do |format|
+        format.json {
+          render :json => {
+            :tiny_captcha_options => @tiny_captcha_options
+          }
+        }
+      end
+    end
+  end
+end
+

data/app/helpers/tiny_captcha/application_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module TinyCaptcha
   module ApplicationHelper
   end

data/config/locales/en/tiny_captcha.en.yml

@@ -0,0 +1,9 @@
+en:
+  tiny_captcha:
+    label: 'Please input captcha'
+    placeholder: 'Captcha'
+    retry: 'Change'
+    message:
+      default: "Secret Code did not match with the Image"
+      user: "The secret Image and code were different"
+

data/config/locales/zh-CN/tiny_captcha.zh-CN.yml

@@ -0,0 +1,8 @@
+zh-CN:
+  tiny_captcha:
+    label: '请输验证码'
+    placeholder: '请输验证码'
+    retry:   '看不清? 重新获取'
+    message:
+      default: "不正确"
+

data/config/routes.rb

@@ -1,2 +1,6 @@
+# -*- encoding : utf-8 -*-
 TinyCaptcha::Engine.routes.draw do
+  namespace :tiny_captcha do
+    resources :images, :only => [:new]
+  end
 end

data/lib/generators/USAGE

@@ -0,0 +1,4 @@
+TinyCaptcha
+=============
+# Generate migration and copy view partial
+  rails generate tiny_captcha

data/lib/generators/templates/migration.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+class CreateTinyCaptchaData < ActiveRecord::Migration
+  def self.up
+    create_table :tiny_captcha_data do |t|
+      t.string :key, :limit => 40
+      t.string :value, :limit => 6
+      t.timestamps
+    end
+    
+    add_index :tiny_captcha_data, :key
+  end
+
+  def self.down
+    drop_table :tiny_captcha_data
+  end
+end

data/lib/generators/templates/partial.erb

@@ -0,0 +1,37 @@
+<style type="text/CSS">
+  .tiny_captcha{border: 1px solid #ccc; padding: 5px !important;}
+  .tiny_captcha,
+  .tiny_captcha div{display: table;}
+  .tiny_captcha .tiny_captcha_field,
+  .tiny_captcha .tiny_captcha_image{
+    border: 1px solid #ccc;
+    margin: 0px 0px 2px 0px !important;
+    padding: 0px !important;
+  }
+  .tiny_captcha .tiny_captcha_image img{
+    margin: 0px !important;
+    padding: 0px !important;
+    width: 110px !important;
+  }
+  .tiny_captcha .tiny_captcha_label{font-size: 12px;}
+  .tiny_captcha .tiny_captcha_field input{
+    width: 150px !important;
+    font-size: 16px;
+    border: none;
+    background-color: #efefef;
+  }
+</style>
+
+<div class='tiny_captcha'>
+  <div class='tiny_captcha_image'>
+    <%%= tiny_captcha_options[:image] %>
+  </div>
+
+  <div class='tiny_captcha_field'>
+    <%%= tiny_captcha_options[:field] %>
+  </div>
+
+  <div class='tiny_captcha_label'>
+    <%%= tiny_captcha_options[:label] %>
+  </div>
+</div>

data/lib/generators/tiny_captcha_generator.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+
+class TinyCaptchaGenerator < 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_partial
+    template "partial.erb", File.join('app/views', 'tiny_captcha', "_tiny_captcha.erb")
+  end
+
+  def create_migration
+    migration_template "migration.rb", File.join('db/migrate', "create_tiny_captcha_data.rb")
+  end
+end

data/lib/tiny_captcha.rb

@@ -1,4 +1,67 @@
-require "tiny_captcha/engine"
+# -*- encoding : utf-8 -*-
 
 module TinyCaptcha
+  autoload :Utils,             'tiny_captcha/utils'
+
+  autoload :ImageHelpers,      'tiny_captcha/image'
+  autoload :ViewHelper,        'tiny_captcha/view'
+  autoload :ControllerHelpers, 'tiny_captcha/controller'
+
+  autoload :FormBuilder,       'tiny_captcha/form_builder'
+  autoload :CustomFormBuilder, 'tiny_captcha/formtastic'
+
+  if defined?(ActiveRecord)
+    autoload :ModelHelpers,      'tiny_captcha/active_record'
+    autoload :TinyCaptchaData,   'tiny_captcha/tiny_captcha_data'
+  else
+    autoload :TinyCaptchaData,  'tiny_captcha/tiny_captcha_data_mongoid.rb'
+  end
+
+
+  autoload :Middleware,         'tiny_captcha/middleware'
+
+  mattr_accessor :image_size
+  @@image_size = "100x28"
+
+  mattr_accessor :length
+  @@length = 6
+
+  # 'embosed_silver',
+  # 'simply_red',
+  # 'simply_green',
+  # 'simply_blue',
+  # 'distorted_black',
+  # 'all_black',
+  # 'charcoal_grey',
+  # 'almost_invisible'
+  # 'random'
+  mattr_accessor :image_style
+  @@image_style = 'simply_blue'
+
+  # 'low', 'medium', 'high', 'random'
+  mattr_accessor :distortion
+  @@distortion = 'low'
+
+  # command path
+  mattr_accessor :image_magick_path
+  @@image_magick_path = ''
+
+  # tmp directory
+  mattr_accessor :tmp_path
+  @@tmp_path = nil
+
+  mattr_accessor :image_show_path
+  @@image_show_path = '/tiny_captcha/images/show'
+
+  def self.add_image_style(name, params = [])
+    ::TinyCaptcha::ImageHelpers.image_styles.update(name.to_s => params)
+  end
+
+  def self.setup
+    yield self
+  end
 end
+
+I18n.load_path += Dir[Pathname.new(__FILE__).join('..', '..', 'config', 'locales', '**', '*.{rb,yml}').to_s]
+
+require 'tiny_captcha/engine' if defined?(Rails)

data/lib/tiny_captcha/active_record.rb

@@ -0,0 +1,93 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha #:nodoc
+  module ModelHelpers #:nodoc
+    def self.included(base)
+      base.extend(SingletonMethods)
+    end
+
+    # To implement model based simple captcha use this method in the model as...
+    #
+    #  class User < ActiveRecord::Base
+    #
+    #    apply_tiny_captcha :message => "my customized message"
+    #
+    #  end
+    #
+    # Customize the error message by using :message, the default message is "Captcha did not match". 
+    # As in the applications captcha is needed with a very few cases like signing up the new user, but
+    # not every time you need to authenticate the captcha with @user.save. So as to maintain simplicity
+    # here we have the explicit method to save the instace with captcha validation as...
+    #
+    # * to validate the instance
+    #  
+    #  @user.valid_with_captcha?  # whene captcha validation is required.
+    #
+    #  @user.valid?               # when captcha validation is not required.
+    #
+    # * to save the instance
+    #
+    #  @user.save_with_captcha   # whene captcha validation is required.
+    #
+    #  @user.save                # when captcha validation is not required.
+    module SingletonMethods
+      def apply_tiny_captcha(options = {})
+        options = { :add_to_base => false }.merge(options)
+
+        class_attribute :tiny_captcha_options
+        self.tiny_captcha_options = options
+
+        unless self.is_a?(ClassMethods)
+          include InstanceMethods
+          extend ClassMethods
+
+          attr_accessor :captcha, :captcha_key
+        end
+      end
+    end
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+
+      def valid_with_captcha?
+        [valid?, is_captcha_valid?].all?
+      end
+
+      def tiny_captcha_valid?
+        self.errors[:captcha].empty?
+      end
+
+      def is_captcha_valid?
+        return true if Rails.env.test?
+
+        if captcha && captcha.upcase.delete(" ") == ::TinyCaptcha::Utils::tiny_captcha_value(captcha_key)
+          ::TinyCaptcha::Utils::tiny_captcha_passed!(captcha_key)
+          return true
+        else
+          message = tiny_captcha_options[:message] || I18n.t(
+            self.class.model_name.to_s.downcase, :scope => [:tiny_captcha, :message], :default => :default
+          )
+
+          # tiny_captcha_options[:add_to_base] ? errors.add(:base, message) : errors.add(:captcha, message)
+          errors.add(:captcha, message)
+          return false
+        end
+      end
+
+      def update_attributes_with_captcha *args
+        valid_with_captcha? && update_attributes(*args)
+      end
+
+      def save_with_captcha
+        # valid_with_captcha? && save(:validate => false)
+        valid_with_captcha? && self.save
+      end
+
+      def save_with_captcha!
+        valid_with_captcha? && self.save!
+      end
+
+    end
+  end
+end

data/lib/tiny_captcha/controller.rb

@@ -0,0 +1,58 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha #:nodoc 
+  module ControllerHelpers #:nodoc
+    def self.included base
+      base.class_eval do
+        include InstanceMethods
+        helper_method :generate_tiny_captcha_options
+      end
+    end
+
+    module InstanceMethods
+      # 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_tiny_captcha.
+      #
+      # *Example*
+      #
+      # If you want to save an object say @user only if the captcha is validated then do like this in action...
+      #
+      #  if tiny_captcha_valid?
+      #   @user.save
+      #  else
+      #   flash[:notice] = "captcha did not match"
+      #   redirect_to :action => "myaction"
+      #  end
+      def tiny_captcha_valid?
+        return true if Rails.env.test?
+
+        if params[:captcha]
+          data = TinyCaptcha::Utils::tiny_captcha_value(params[:captcha_key] || session[:captcha])
+          result = data == params[:captcha].delete(" ").upcase
+          TinyCaptcha::Utils::tiny_captcha_passed!(session[:captcha]) if result
+          return result
+        else
+          return false
+        end
+      end
+
+      # 生成验证的信息
+      # options:
+      #   - object
+      def generate_tiny_captcha_options *args
+        options = args.extract_options!
+
+        key = TinyCaptcha::Utils.generate_key_use_session(
+          session, options[:object]
+        )
+
+        {
+          :image_url   => ::TinyCaptcha::Utils.generate_image_url(key, request.base_url, options),
+          :label       => options[:label] || I18n.t('tiny_captcha.label'),
+          :captcha_key => ::TinyCaptcha::Utils.set_tiny_captcha_data(key, options),
+          :object      => options[:object]
+        }
+
+      end
+    end
+  end
+end

data/lib/tiny_captcha/engine.rb

@@ -1,5 +1,32 @@
+# -*- encoding : utf-8 -*-
+require 'rails'
+require 'tiny_captcha'
+
 module TinyCaptcha
   class Engine < ::Rails::Engine
-    isolate_namespace TinyCaptcha
+    config.before_initialize do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:include, TinyCaptcha::ModelHelpers)
+      end
+    end
+
+    config.after_initialize do
+      ActionView::Base.send(:include, TinyCaptcha::ViewHelper)
+      ActionView::Helpers::FormBuilder.send(:include, TinyCaptcha::FormBuilder)
+
+      ActionController::Base.send :include, ::TinyCaptcha::ControllerHelpers
+
+      if Object.const_defined?("Formtastic")
+        if Formtastic.const_defined?("Helpers")
+          Formtastic::Helpers::FormHelper.builder = TinyCaptcha::CustomFormBuilder
+        else
+          Formtastic::SemanticFormHelper.builder = TinyCaptcha::CustomFormBuilder
+        end
+      end
+    end
+
+    config.app_middleware.use TinyCaptcha::Middleware
   end
 end
+
+

data/lib/tiny_captcha/form_builder.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha
+  module FormBuilder
+    def self.included(base)
+      base.send(:include, TinyCaptcha::ViewHelper)
+      base.send(:include, TinyCaptcha::FormBuilder::ClassMethods)
+      base.send(:include, ActionView::Helpers)
+      # base.send(:include, Sprockets::Helpers::RailsHelper)
+      # base.send(:include, Sprockets::Helpers::IsolatedHelper)
+      
+      base.delegate :render, :session, :to => :template
+    end
+    
+    module ClassMethods
+      # Example:
+		  # <% form_for :post, :url => posts_path do |form| %>
+		  #   ...
+		  #   <%= form.tiny_captcha :label => "Enter numbers.." %>
+		  # <% end %>
+		  #
+		  def tiny_captcha(options = {})
+      	options.update :object => @object_name
+      	show_tiny_captcha(objectify_options(options))
+      end
+
+      private
+
+        def template
+          @template
+        end
+
+        def tiny_captcha_field(options={})
+          html = {:autocomplete => 'off', :required => 'required', :value => ''}
+          html.merge!(options[:input_html] || {})
+          html[:placeholder] = options[:placeholder] || I18n.t('tiny_captcha.placeholder')
+
+          text_field(:captcha, html) + hidden_field(:captcha_key, {
+            :value => options[:captcha_key], :class => 'captcha-key'
+          })
+        end
+    end
+  end
+end

data/lib/tiny_captcha/formtastic.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha
+  class CustomFormBuilder < Formtastic::FormBuilder
+
+    private
+
+    def tiny_captcha_input(method, options)
+      options.update :object => sanitized_object_name
+      self.send(:show_tiny_captcha, options)
+    end
+  end
+end

data/lib/tiny_captcha/image.rb

@@ -0,0 +1,85 @@
+# -*- encoding : utf-8 -*-
+require 'tempfile'
+module TinyCaptcha #:nodoc
+  module ImageHelpers #:nodoc
+
+    mattr_accessor :image_styles
+    @@image_styles = {
+      'embosed_silver'  => ['-fill darkblue', '-shade 20x60', '-background white'],
+      'simply_red'      => ['-fill darkred', '-background white'],
+      'simply_green'    => ['-fill darkgreen', '-background white'],
+      'simply_blue'     => ['-fill darkblue', '-background white'],
+      'distorted_black' => ['-fill darkblue', '-edge 10', '-background white'],
+      'all_black'       => ['-fill darkblue', '-edge 2', '-background white'],
+      'charcoal_grey'   => ['-fill darkblue', '-charcoal 5', '-background white'],
+      'almost_invisible' => ['-fill red', '-solarize 50', '-background white']
+    }
+
+    DISTORTIONS = ['low', 'medium', 'high']
+
+    class << self
+
+      def image_params(key = 'simply_blue')
+        image_keys = @@image_styles.keys
+
+        style = begin
+          if key == 'random'
+            image_keys[rand(image_keys.length)]
+          else
+            image_keys.include?(key) ? key : 'simply_blue'
+          end
+        end
+
+        @@image_styles[style]
+      end
+
+      def distortion(key='low')
+        key =
+          key == 'random' ?
+          DISTORTIONS[rand(DISTORTIONS.length)] :
+          DISTORTIONS.include?(key) ? key : 'low'
+        case key.to_s
+          when 'low' then return [2 + rand(2), 80 + rand(20)]
+          when 'medium' then return [4 + rand(2), 50 + rand(20)]
+          when 'high' then return [6 + rand(2), 30 + rand(20)]
+        end
+      end
+    end
+
+    if RUBY_VERSION < '1.9'
+      class Tempfile < ::Tempfile
+        # Replaces Tempfile's +make_tmpname+ with one that honors file extensions.
+        def make_tmpname(basename, n = 0)
+          extension = File.extname(basename)
+          sprintf("%s,%d,%d%s", File.basename(basename, extension), $$, n, extension)
+        end
+      end
+    end
+
+    private
+
+      def generate_tiny_captcha_image(tiny_captcha_key) #:nodoc
+        amplitude, frequency = ImageHelpers.distortion(TinyCaptcha.distortion)
+        text = Utils::tiny_captcha_value(tiny_captcha_key)
+
+        params = ImageHelpers.image_params(TinyCaptcha.image_style).dup
+        params << "-size #{TinyCaptcha.image_size}"
+        params << "-wave #{amplitude}x#{frequency}"
+        params << "-gravity \"Center\""
+        params << "-pointsize 22"
+        params << "-implode 0.2"
+
+        dst = Tempfile.new(RUBY_VERSION < '1.9' ? 'tiny_captcha.jpg' : ['tiny_captcha', '.jpg'], TinyCaptcha.tmp_path)
+        dst.binmode
+
+        params << "label:#{text} \"#{File.expand_path(dst.path)}\""
+
+        TinyCaptcha::Utils::run("convert", params.join(' '))
+
+        dst.close
+
+        File.expand_path(dst.path)
+        #dst
+      end
+  end
+end

data/lib/tiny_captcha/middleware.rb

@@ -0,0 +1,70 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha
+  class Middleware
+    include TinyCaptcha::ImageHelpers
+
+    DEFAULT_SEND_FILE_OPTIONS = {
+      :type         => 'application/octet-stream'.freeze,
+      :disposition  => 'attachment'.freeze,
+    }.freeze
+
+    CODE_KEY = 'code'
+
+    def initialize(app, options={})
+      @app = app
+      self
+    end
+
+    def call(env) # :nodoc:
+      if env["REQUEST_METHOD"] == "GET" && env['PATH_INFO'].start_with?(::TinyCaptcha.image_show_path)
+        # /tiny_captcha/images/show?code=abcdefg
+        make_image(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    protected
+
+      def render_json(env, data={}, headers={}, status=404)
+        body = []
+        body << data.to_json
+        headers['Content-Type'] = 'application/json'
+        [status, headers, body]
+      end
+
+      def make_image(env, headers = {}, status = 404)
+        request = Rack::Request.new(env)
+        code = request.params[CODE_KEY]
+        body = []
+
+        if !code.blank? && ::TinyCaptcha::Utils::tiny_captcha_value(code)
+          #status, headers, body = @app.call(env)
+          #status = 200
+          #body = generate_tiny_captcha_image(code)
+          #headers['Content-Type'] = 'image/jpeg'
+
+          return send_file(
+            generate_tiny_captcha_image(code),
+            :type => 'image/jpeg',
+            :disposition => 'inline',
+            :filename =>  'tiny_captcha.jpg'
+          )
+        end
+
+        [status, headers, body]
+      end
+
+      def send_file(path, options = {})
+        raise MissingFile, "Cannot read file #{path}" unless File.file?(path) and File.readable?(path)
+
+        options[:filename] ||= File.basename(path) unless options[:url_based_filename]
+
+        status = options[:status] || 200
+        headers = {"Content-Disposition" => "#{options[:disposition]}; filename='#{options[:filename]}'", "Content-Type" => options[:type], 'Content-Transfer-Encoding' => 'binary', 'Cache-Control' => 'private'}
+        response_body = File.open(path, "rb")
+
+        [status, headers, response_body]
+      end
+  end
+end

data/lib/tiny_captcha/tiny_captcha_data.rb

@@ -0,0 +1,36 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha
+  class TinyCaptchaData < ::ActiveRecord::Base
+    def self.rails3?
+      ::ActiveRecord::VERSION::MAJOR == 3
+    end
+
+    def self.rails4?
+      ::ActiveRecord::VERSION::MAJOR == 4
+    end
+
+    if rails3? || rails4?
+      self.table_name = "tiny_captcha_data"
+    else
+      set_table_name "tiny_captcha_data"
+    end
+
+    attr_accessible :key, :value
+
+    class << self
+      def get_data(key)
+        data = find_by_key(key) || new(:key => key)
+      end
+
+      def remove_data(key)
+        delete_all(["#{connection.quote_column_name(:key)} = ?", key])
+        clear_old_data(1.hour.ago)
+      end
+      
+      def clear_old_data(time = 1.hour.ago)
+        return unless Time === time
+        delete_all(["#{connection.quote_column_name(:updated_at)} < ?", time])
+      end
+    end
+  end
+end

data/lib/tiny_captcha/tiny_captcha_data_mongoid.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha
+  class TinyCaptchaData
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :key, type: String
+    field :value, type: String
+
+    class << self
+      def get_data(key)
+        data = where(:key => key).first || new(:key => key)
+      end
+      
+      def remove_data(key)
+        where(:key => key).delete_all
+        clear_old_data(1.hour.ago)
+      end
+      
+      def clear_old_data(time = 1.hour.ago)
+        return unless Time === time
+        where(:updated_at.lte => time).delete_all
+      end
+    end
+  end
+end

data/lib/tiny_captcha/utils.rb

@@ -0,0 +1,80 @@
+# -*- encoding : utf-8 -*-
+require 'digest/sha1'
+
+module TinyCaptcha #:nodoc
+  module Utils #:nodoc
+    # Execute command with params and return output if exit status equal expected_outcodes
+    def self.run(cmd, params = "", expected_outcodes = 0)
+      command = %Q[#{cmd} #{params}].gsub(/\s+/, " ")
+      command = "#{command} 2>&1"
+
+      unless (image_magick_path = TinyCaptcha.image_magick_path).blank?
+        command = File.join(image_magick_path, command)
+      end
+
+      output = `#{command}`
+
+      unless [expected_outcodes].flatten.include?($?.exitstatus)
+        raise ::StandardError, "Error while running #{cmd}: #{output}"
+      end
+
+      output
+    end
+
+    def self.tiny_captcha_value(key) #:nodoc
+      TinyCaptchaData.get_data(key).value rescue nil
+    end
+
+    def self.tiny_captcha_passed!(key) #:nodoc
+      TinyCaptchaData.remove_data(key)
+    end
+
+    def self.generate_key(*args)
+      args << Time.now.to_s
+      Digest::SHA1.hexdigest(args.join)
+    end
+
+    def self.set_tiny_captcha_data(key, options={})
+      code_type = options[:code_type]
+
+      data = TinyCaptcha::TinyCaptchaData.get_data(key)
+      data.value = generate_tiny_captcha_data(code_type)
+      data.save
+      key
+    end
+
+    def self.generate_tiny_captcha_data(code)
+      value = ''
+
+      case code
+      when 'numeric' then
+        ::TinyCaptcha.length.times{value << (48 + rand(10)).chr}
+      else
+        ::TinyCaptcha.length.times{value << (65 + rand(26)).chr}
+      end
+
+      return value
+    end
+
+    def self.generate_image_url key, *args
+      options = args.extract_options!
+
+      defaults = {}
+      defaults[:time] = options[:time] || Time.now.to_i
+
+      base_url = args.first || ENV['RAILS_RELATIVE_URL_ROOT']
+
+      "#{base_url}#{::TinyCaptcha.image_show_path}?code=#{key}&#{defaults.to_query}"
+    end
+
+    def self.generate_key_use_session session, *args
+      key_name = args.first
+
+      if key_name.nil?
+        session[:captcha] ||= TinyCaptcha::Utils.generate_key(session[:id].to_s, 'captcha')
+      else
+        TinyCaptcha::Utils.generate_key(session[:id].to_s, key_name)
+      end
+    end
+  end
+end

data/lib/tiny_captcha/version.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module TinyCaptcha
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/tiny_captcha/view.rb

@@ -0,0 +1,99 @@
+# -*- encoding : utf-8 -*-
+module TinyCaptcha #:nodoc
+  module ViewHelper #:nodoc
+
+    # Tiny 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_tiny_captcha.
+    #
+    # *show_tiny_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_tiny_captcha %>
+    #
+    # The available options to pass to this method are
+    # * label
+    # * object
+    #
+    # <b>Label:</b>
+    #
+    # default label is "type the text from the image", it can be modified by passing :label as
+    #
+    # <%= show_tiny_captcha(:label => "new captcha label") %>.
+    #
+    # *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 tiny_captcha_valid?
+    #
+    # To make a model based captcha give this option as...
+    #
+    # <%= show_tiny_captcha(:object => "user") %>
+    # and also call the method apply_tiny_captcha in the model
+    # this will consider "user" as the object of the model class.
+    #
+    # *Examples*
+    # * controller based
+    # <%= show_tiny_captcha(:label => "Human Authentication: type the text from image above") %>
+    # * model based
+    # <%= show_tiny_captcha(:object => "person", :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.
+    #
+    #
+    # eg. show_tiny_captcha :label => '', :captcha_key => '', :image_url => ''
+    def show_tiny_captcha(*args)
+      options = args.extract_options!
+
+      options[:captcha_key] ||= set_tiny_captcha_data(
+        (
+          args.first || tiny_captcha_key(options[:object])
+        ),
+          options
+      )
+
+      key = options[:captcha_key]
+      
+      defaults = {
+        :image => tiny_captcha_image(key, options),
+        :label => options[:label] || I18n.t('tiny_captcha.label'),
+        :field => tiny_captcha_field(options)
+      }
+
+      render :partial => 'tiny_captcha/tiny_captcha', :locals => { :tiny_captcha_options => defaults }
+    end
+
+    private
+
+      def tiny_captcha_image(key, options = {})
+        url = options[:image_url] || ::TinyCaptcha::Utils.generate_image_url(key, options)
+        tag('img', :src => url, :alt => 'captcha', :class => 'captcha-image')
+      end
+      
+      def tiny_captcha_field(options={})
+        html = {:autocomplete => 'off', :required => 'required'}
+        html.merge!(options[:input_html] || {})
+        html[:placeholder] = options[:placeholder] || I18n.t('tiny_captcha.placeholder')
+          
+        if options[:object]
+          text_field(options[:object], :captcha, html.merge(:value => '')) +
+          hidden_field(options[:object], :captcha_key, {:value => options[:captcha_key], :class => 'captcha-key'})
+        else
+          text_field_tag(:captcha, nil, html) +
+          hidden_field_tag(:captcha_key, options[:captcha_key], :class => 'captcha-key')
+        end
+      end
+
+      def set_tiny_captcha_data(key, options={})
+        ::TinyCaptcha::Utils.set_tiny_captcha_data key, options
+      end
+  
+      def tiny_captcha_key(key_name = nil)
+        TinyCaptcha::Utils.generate_key_use_session session, key_name
+      end 
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,3 @@
+# -*- encoding : utf-8 -*-
 module ApplicationHelper
 end

data/test/dummy/config/application.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require File.expand_path('../boot', __FILE__)
 
 require 'rails/all'

data/test/dummy/config/boot.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 

data/test/dummy/config/environment.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Load the Rails application.
 require File.expand_path('../application', __FILE__)
 

data/test/dummy/config/environments/development.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/test/dummy/config/environments/production.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/test/dummy/config/environments/test.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Be sure to restart your server when you modify this file.
 
 # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Be sure to restart your server when you modify this file.
 
 # Configure sensitive parameters which will be filtered from the log file.

data/test/dummy/config/initializers/inflections.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Be sure to restart your server when you modify this file.
 
 # Add new inflection rules using the following format. Inflections

data/test/dummy/config/initializers/mime_types.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Be sure to restart your server when you modify this file.
 
 # Add new mime types for use in respond_to blocks:

data/test/dummy/config/initializers/secret_token.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Be sure to restart your server when you modify this file.
 
 # Your secret key is used for verifying the integrity of signed cookies.

data/test/dummy/config/initializers/session_store.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Be sure to restart your server when you modify this file.
 
 Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Be sure to restart your server when you modify this file.
 
 # This file contains settings for ActionController::ParamsWrapper which

data/test/dummy/config/routes.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 Rails.application.routes.draw do
 
   mount TinyCaptcha::Engine => "/tiny_captcha"

data/test/integration/navigation_test.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'test_helper'
 
 class NavigationTest < ActionDispatch::IntegrationTest

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 

data/test/tiny_captcha_test.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'test_helper'
 
 class TinyCaptchaTest < ActiveSupport::TestCase

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: tiny_captcha
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - happy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: tiny_util
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Description of TinyCaptcha.
@@ -66,115 +59,125 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/views/layouts/tiny_captcha/application.html.erb
-- app/controllers/tiny_captcha/application_controller.rb
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
 - app/assets/javascripts/tiny_captcha/application.js
 - app/assets/stylesheets/tiny_captcha/application.css
+- app/controllers/tiny_captcha/application_controller.rb
+- app/controllers/tiny_captcha/images_controller.rb
 - app/helpers/tiny_captcha/application_helper.rb
+- app/views/layouts/tiny_captcha/application.html.erb
+- config/locales/en/tiny_captcha.en.yml
+- config/locales/zh-CN/tiny_captcha.zh-CN.yml
 - config/routes.rb
-- lib/tiny_captcha/engine.rb
-- lib/tiny_captcha/version.rb
+- lib/generators/USAGE
+- lib/generators/templates/migration.rb
+- lib/generators/templates/partial.erb
+- lib/generators/tiny_captcha_generator.rb
 - lib/tasks/tiny_captcha_tasks.rake
 - lib/tiny_captcha.rb
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
-- test/tiny_captcha_test.rb
-- test/test_helper.rb
-- test/dummy/bin/bundle
-- test/dummy/bin/rake
-- test/dummy/bin/rails
+- lib/tiny_captcha/active_record.rb
+- lib/tiny_captcha/controller.rb
+- lib/tiny_captcha/engine.rb
+- lib/tiny_captcha/form_builder.rb
+- lib/tiny_captcha/formtastic.rb
+- lib/tiny_captcha/image.rb
+- lib/tiny_captcha/middleware.rb
+- lib/tiny_captcha/tiny_captcha_data.rb
+- lib/tiny_captcha/tiny_captcha_data_mongoid.rb
+- lib/tiny_captcha/utils.rb
+- lib/tiny_captcha/version.rb
+- lib/tiny_captcha/view.rb
 - test/dummy/README.rdoc
-- test/dummy/config.ru
 - test/dummy/Rakefile
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
-- test/dummy/public/favicon.ico
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
-- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/config/application.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/boot.rb
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
 - test/integration/navigation_test.rb
+- test/test_helper.rb
+- test/tiny_captcha_test.rb
 homepage: http://github.com/xiuxian123/tiny_passport
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 965235565
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 965235565
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Summary of TinyCaptcha.
 test_files:
-- test/tiny_captcha_test.rb
-- test/test_helper.rb
-- test/dummy/bin/bundle
-- test/dummy/bin/rake
-- test/dummy/bin/rails
-- test/dummy/README.rdoc
-- test/dummy/config.ru
-- test/dummy/Rakefile
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
-- test/dummy/public/favicon.ico
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
-- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/config/application.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/boot.rb
+- test/dummy/config.ru
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/dummy/Rakefile
+- test/dummy/README.rdoc
 - test/integration/navigation_test.rb
+- test/test_helper.rb
+- test/tiny_captcha_test.rb