Class: ValidatesCaptcha::Provider::Question

Inherits:
Object
  • Object
show all
Includes:
ActionView::Helpers
Defined in:
lib/validates_captcha/provider/question.rb

Overview

A question/answer captcha provider.

Constant Summary collapse

DEFAULT_QUESTIONS_AND_ANSWERS = 
{
"What's the capital of France?" => "Paris",
"What's the capital of Germany?" => "Berlin",
"What's the opposite of good?" => ["bad", "evil"],
"What's the opposite of love?" => "hate",
"What's the sum of 2 and 3?" => ["5", "five"],
"What's the product of 3 and 4?" => ["12", "twelve"],
"Thumb, tooth or hand: which is part of the head?" => "tooth",
"Bread, ham or milk: which is something to drink?" => "milk",
"What day is today, if yesterday was Friday?" => "Saturday",
"What day is today, if tomorrow is Tuesday?" => "Monday",
"What is the 2nd letter of the third word in this question?" => "h",
"What color is the sky on a sunny day?" => "blue" }.freeze
@@questions_and_answers = 
DEFAULT_QUESTIONS_AND_ANSWERS

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.questions_and_answers ⇒ Object

Returns the current captcha questions/answers hash. Defaults to DEFAULT_QUESTIONS_AND_ANSWERS.



28
29
30
 
# File 'lib/validates_captcha/provider/question.rb', line 28

def questions_and_answers
  @@questions_and_answers
end

.questions_and_answers=(qna) ⇒ Object

Sets the current captcha questions/answers hash. Used to set a custom questions/answers hash.



34
35
36
 
# File 'lib/validates_captcha/provider/question.rb', line 34

def questions_and_answers=(qna)
  @@questions_and_answers = qna
end

Instance Method Details

#call(env) ⇒ Object

This method is the one called by Rack.

It returns HTTP status 404 if the path is not recognized. If the path is recognized, it returns HTTP status 200 and delivers a new challenge in JSON format.

Please take a look at the source code if you want to learn more.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/validates_captcha/provider/question.rb', line 46

def call(env)
  if env['PATH_INFO'] == regenerate_path
    captcha_challenge = generate_challenge
    json = { :captcha_challenge => captcha_challenge }.to_json

    [200, { 'Content-Type' => 'application/json' }, [json]]
  else
    [404, { 'Content-Type' => 'text/html' }, ['Not Found']]
  end
end

#generate_challenge ⇒ Object

Returns a captcha question.



58
59
60
 
# File 'lib/validates_captcha/provider/question.rb', line 58

def generate_challenge
  self.class.questions_and_answers.keys[rand(self.class.questions_and_answers.keys.size)]
end

#render_challenge(sanitized_object_name, object, options = {}) ⇒ Object

Returns a span tag with the inner HTML set to the captcha question.

Internally calls Rails’ content_tag helper method, passing the options argument.



73
74
75
76
77
 
# File 'lib/validates_captcha/provider/question.rb', line 73

def render_challenge(sanitized_object_name, object, options = {})
  options[:id] = "#{sanitized_object_name}_captcha_question"

  content_tag :span, object.captcha_challenge, options
end

#render_regenerate_challenge_link(sanitized_object_name, object, options = {}, html_options = {}) ⇒ Object

Returns an anchor tag that makes an AJAX request to fetch a new question and updates the captcha challenge after the request is complete.

Internally calls Rails’ link_to_remote helper method, passing the options and html_options arguments. So it relies on the Prototype javascript framework to be available on the web page. As of version 0.9.8 you can pass :jquery => true as an option to render Javascript that’s based on jQuery.

The anchor text defaults to ‘New question’. You can set this to a custom value providing a :text key in the options hash.



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/validates_captcha/provider/question.rb', line 89

def render_regenerate_challenge_link(sanitized_object_name, object, options = {}, html_options = {})
  text = options.delete(:text) || 'New question'
  if options.delete(:jquery)
    onclick = "jQuery.getJSON('#{regenerate_path}', function(result){jQuery('##{sanitized_object_name}_captcha_question').text(result.captcha_challenge); jQuery('##{sanitized_object_name}_captcha_challenge').val(result.captcha_challenge); jQuery('##{sanitized_object_name}_captcha_solution').val('');});return false;"
    link_to text, "#", options.reverse_merge(:onclick => onclick), html_options
  else
    success = "var result = request.responseJSON; $('#{sanitized_object_name}_captcha_question').update = result.captcha_challenge; $('#{sanitized_object_name}_captcha_challenge').value = result.captcha_challenge; $('#{sanitized_object_name}_captcha_solution').value = '';"
    link_to_remote text, options.reverse_merge(:url => regenerate_path, :method => :get, :success => success), html_options
  end
end

#solved?(question, answer) ⇒ Boolean

Returns true if the captcha was solved using the given question and answer, otherwise false.

Returns:

  • (Boolean) 


64
65
66
67
68
 
# File 'lib/validates_captcha/provider/question.rb', line 64

def solved?(question, answer)
  return false unless self.class.questions_and_answers.key?(question)
  answers = Array.wrap(self.class.questions_and_answers[question]).map(&:downcase)
  answers.include?(answer.downcase)
end