ReCAPTCHA Mailhide implementation for Ruby
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.document
.gitignore
.rspec
CHANGELOG.rdoc
Gemfile
LICENSE.txt Initial commit to recaptcha-mailhide. Apr 17, 2012
README.rdoc
Rakefile
recaptcha-mailhide.gemspec

README.rdoc

ReCAPTCHA Mailhide

This gem provides Ruby (and Rails) support for ReCAPTCHA's Mailhide API.

Installation

Add this to your Gemfile:

gem 'recaptcha-mailhide'

Configuration

Add this somewhere (if you're using Rails put it in config/initializers/recaptcha_mailhide.rb):

RecaptchaMailhide.configure do |c|
  c.private_key = '...'
  c.public_key  = '...'
end

If you need a set of public/private keys get them from www.google.com/recaptcha/mailhide/apikey

Usage

In Rails views

recaptcha_mailhide('foo@example.com')

You can also provide content as a method argument or a block (just like with link_to):

# Content in argument
recaptcha_mailhide('Click to view email', 'foo@example.com')

recaptcha_mailhide('foo@example.com') do
  # Content here
end

You can also provide options (they get forwarded to link_to):

recaptcha_mailhide('foo@example.com', class: 'hidden-email', target: '_blank')

In addition it accepts a :popup option that will make the link open in a popup window (requires JavaScript):

recaptcha_mailhide('foo@example.com', popup: true)

# Configuring popup window size
recaptcha_mailhide('foo@example.com', popup: { width: 600, height: 600 })

Pure Ruby

Use the following to get just the ReCAPTCHA Mailhide URL (without a link tag):

RecaptchaMailhide.url_for(email)

TODO

  • Tests for Rails helpers

  • Basic helpers (non-dependent on Rails)

  • Rails generator for initializer with auto-fetching of private/public keys

Copyright

This gem is Copyright © 2012 Pedro Fayolle. See LICENSE.txt for further details.

ReCAPTCHA Mailhide is Copyright © Google, Inc. This is gem is NOT affiliated with Google, Inc.