ruby-recaptcha

The basics

The ReCaptcha::Client abstracts the ReCaptcha API for use in Rails Applications

Installing

1	gem install ruby-recaptcha

with Rails

In recent versions of Rails, you can specify the gem in environment.rb:

1	config.gem 'ruby-recaptcha'

Demonstration of usage

reCAPTCHA

First, create an account at ReCaptcha.net

Get your keys, and make them available as constants in your application. You can do this however you want, but RCC_PUB, RCC_PRIV (for regular reCaptcha) and MH_PUB, MH_PRIV (for MailHide) must be set to their respective values (the keys you receive from reCaptcha).

It doesn't matter how you set these constants. You can create them however you like:

1
2
3

RCC_PUB='foo' #normal constant decl
RCC_PUB=ENV['i_keep_it_here'] #from an environment variable
RCC_PUB, RCC_PRIV = (*File.open('/etc/keys', 'r').read_lines).map(&:reverse) #stored backwards, in a file.  muaahah!

The ReCaptcha::Client constructor can also take an options hash containing keys thusly:

1	Recaptcha::Client.new(:rcc_pub=>'some public key', :rcc_priv=>'some private key')

After your keys are configured, and the gem is loaded, include the ReCaptcha::AppHelper module in your ApplicationController:

1 2	class ApplicationController < ActionController::Base include ReCaptcha::AppHelper

This will mix-in validate_recap method.

Then, in the controller where you want to do the validation, chain validate_recap() into your regular validation:

def create
      @user = User.new(params[:user])
      if validate_recap(params, @user.errors) && @user.save
          #   ...do stuff...

Require and include the view helper in your application_helper:

1	include ReCaptcha::ViewHelper

This will mix get_captcha() into your view helper.

Now you can just call get_captcha() in your view to insert the requisite widget from ReCaptcha.

To customize theme and tabindex of the widget, you can include an options hash:

1	get_captcha(:options => {:theme => 'white', :tabindex => 10})

See the ReCaptcha API Documentation under "Look and Feel Customization" for more information.

Proxy support

If your rails application requires the use of a proxy, set proxy_host into your environment:

1	ENV['proxy_host']='foo.example.com:8080'

Mail Hide

When you mix in ViewHelper as above, you also get mail_hide(address, contents), which you can call in your view thusly:

1	<%= mail_hide(user.email) %>

Contents defaults to the first few characters of the email address.

Testing

If you want to run automated integration testing and get past your calls to validate_recap, you can redefine it in config/environments/test.rb, like so:

config.after_initialize do 
  module ReCaptcha::AppHelper
    def validate_recap( p, errors, options = {})
      return true
    end
  end
end

Now you can get past user/create in your cucumber stories!

Bugs

Issue Tracker

Code

Mercurial Repository

Note the wiki & forum & such there...

License

This code is free to use under the terms of the MIT License.

Contact

Comments are welcome. Send an email to [[mailto:mlooney@gmail.com.without.spam the author]]

Contributors:

Victor Cosby (test cleanup, additional code to style widget)
Ronald Schroeter (proxy support suggestion & proto-patch)
Peter Vandenberk (multi-key support, ssl support, various unit tests, test refactoring)
Kim Griggs (found long address-newline bug)

This revision is from 2009-03-15 03:32

mml / ruby-recaptcha (http://loonsoft.com/recaptcha/)