Module: QuickCaptcha::ViewHelpers

Includes:
CaptchaUtils
Defined in:
lib/quick_captcha/view_helpers.rb

Overview

:nodoc

Instance Method Summary collapse

Methods included from CaptchaUtils

#generate_simple_captcha_key, #simple_captcha_key, simple_captcha_matches?, #simple_captcha_matches?, simple_captcha_passed!, #simple_captcha_passed!, #simple_captcha_value, simple_captcha_value

Instance Method Details

#show_quick_captcha(options = {}) ⇒ Object

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

Label:

default label is “type the text from the image”, it can be modified by passing :label as

<%= show_simple_captcha(:label => “new captcha label”) %>.

Image Style:

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 EXPRESSICA.com

All Feedbacks/Comments/Issues/Queries are welcome.



71
72
73
 
# File 'lib/quick_captcha/view_helpers.rb', line 71

def show_quick_captcha(options = {})
  show_simple_captcha(options)
end

#show_simple_captcha(options = {}) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/quick_captcha/view_helpers.rb', line 75

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