ambethia-recaptcha 0.2.2

data/CHANGELOG

@@ -0,0 +1,23 @@
+== 0.2.2 / 2009-09-14
+
+* Add a timeout to the validator
+* Give the documentation some love
+
+== 0.2.1 / 2009-09-14
+
+* Removed Ambethia namespace, and restructured classes a bit
+* Added an example rails app in the example-rails branch
+
+== 0.2.0 / 2009-09-12
+
+* RecaptchaOptions AJAX API Fix
+* Added 'cucumber' as a test environment to skip
+* Ruby 1.9 compat fixes
+* Added option :message => 'Custom error message' to verify_recaptcha
+* Removed dependency on ActiveRecord constant
+* Add I18n
+
+== 0.1.0 / 2008-2-8
+
+* 1 major enhancement
+	* Initial Gem Release

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Jason L Perry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,92 @@
+= reCAPTCHA
+
+Author::    Jason L Perry (http://ambethia.com)
+Copyright:: Copyright (c) 2007 Jason L Perry
+License::   {MIT}[http://creativecommons.org/licenses/MIT/]
+Info::      http://ambethia.com/recaptcha
+Git::       http://github.com/ambethia/recaptcha/tree/master
+Bugs::      http://github.com/ambethia/recaptcha/issues
+
+This plugin adds helpers for the {reCAPTCHA API}[http://recaptcha.net]. In your views you can use
+the +recaptcha_tags+ method to embed the needed javascript, and you can validate in your controllers
+with +verify_recaptcha+.
+
+You'll want to add your public and private API keys in the environment variables +RECAPTCHA_PUBLIC_KEY+
+and +RECAPTCHA_PRIVATE_KEY+, respectively. You could also specify them in <tt>config/environment.rb</tt> if you
+are so inclined (see below). Exceptions will be raised if you call these methods and the keys can't be found.
+
+== Rails Installation
+
+reCAPTCHA for Rails can be installed as a gem:
+
+  config.gem "ambethia-recaptcha", :lib => "recaptcha/rails", :source => "http://gems.github.com"
+
+Or, as a standard rails plugin:
+
+  script/plugin install git://github.com/ambethia/recaptcha.git
+
+== Setting up your API Keys
+
+There are two ways to setup your reCAPTCHA API keys once you {obtain}[http://recaptcha.net/whyrecaptcha.html]
+a pair. You can pass in your keys as options at runtime, for example:
+
+  recaptcha_tags :public_key => '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
+
+and later,
+
+  verify_recaptcha :private_key => '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
+
+
+Or, preferably, you can keep your keys out of your code base by exporting the environment variables
+mentioned earlier. You might do this in the .profile/rc, or equivalent for the user running your
+application:
+
+  export RECAPTCHA_PUBLIC_KEY  = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
+  export RECAPTCHA_PRIVATE_KEY = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
+
+If that's not your thing, and dropping things into <tt>config/environment.rb</tt> is, you can just do:
+
+  ENV['RECAPTCHA_PUBLIC_KEY']  = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
+  ENV['RECAPTCHA_PRIVATE_KEY'] = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
+
+== +recaptcha_tags+
+
+Some of the options available:
+
+<tt>:ssl</tt>::         Uses secure http for captcha widget (default +false+)
+<tt>:noscript</tt>::    Include <noscript> content (default +true+)
+<tt>:display</tt>::     Takes a hash containing the +theme+ and +tabindex+ options per the API. (default +nil+)
+<tt>:ajax</tt>::        Render the dynamic AJAX captcha per the API. (default +false+)
+<tt>:public_key</tt>::  Your public API key, takes precedence over the ENV variable (default +nil+)
+<tt>:error</tt>::       Override the error code returned from the reCAPTCHA API (default +nil+)
+
+You can also override the html attributes for the sizes of the generated +textarea+ and +iframe+
+elements, if CSS isn't your thing. Inspect the source of +recaptcha_tags+ to see these options.
+
+== +verify_recaptcha+
+
+This method returns +true+ or +false+ after processing the parameters from the reCAPTCHA widget. Why
+isn't this a model validation? Because that violates MVC. Use can use it like this, or how ever you
+like. Passing in the ActiveRecord object is optional, if you do--and the captcha fails to verify--an
+error will be added to the object for you to use.
+
+Some of the options available:
+
+<tt>:model</tt>::       Model to set errors
+<tt>:message</tt>::     Custom error message
+<tt>:private_key</tt>:: Your private API key, takes precedence over the ENV variable (default +nil+).
+<tt>:timeout</tt>::     The number of seconds to wait for reCAPTCHA servers before give up. (default +3+)
+
+  respond_to do |format|
+    if verify_recaptcha(:model => @post, :message => 'Oh! It's error with reCAPTCHA!') && @post.save
+      # ...
+    else
+      # ...
+    end
+  end
+
+== TODO
+* Remove Rails/ActionController dependencies
+* Framework agnostic
+* Add some helpers to use in before_filter and what not
+* Better documentation

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name           = "recaptcha"
+    gem.description    = "This plugin adds helpers for the reCAPTCHA API "
+    gem.summary        = "Helpers for the reCAPTCHA API"
+    gem.homepage       = "http://github.com/ambethia/recaptcha"
+    gem.authors        = ["Jason L. Perry"]
+    gem.email          = "jasper@ambethia.com"
+    gem.files.reject! { |fn| fn.include? ".gitignore" }
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rd|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include "README.rdoc", "LICENSE", "lib/**/*.rb"
+  rd.rdoc_dir = 'rdoc'
+  rd.options << '-N' # line numbers
+  rd.options << '-S' # inline source
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  # test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/init.rb

@@ -0,0 +1,4 @@
+# Rails plugin initialization.
+# You can also install it as a gem:
+#   config.gem "ambethia-recaptcha", :lib => "recaptcha/rails", :source => "http://gems.github.com"
+require 'recaptcha/rails'

data/lib/recaptcha.rb

@@ -0,0 +1,22 @@
+require 'recaptcha/client_helper'
+require 'recaptcha/verify'
+
+module Recaptcha
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+
+  
+  RECAPTCHA_API_SERVER        = 'http://api.recaptcha.net';
+  RECAPTCHA_API_SECURE_SERVER = 'https://api-secure.recaptcha.net';
+  RECAPTCHA_VERIFY_SERVER     = 'api-verify.recaptcha.net';
+
+  SKIP_VERIFY_ENV = ['test', 'cucumber']
+
+  class RecaptchaError < StandardError
+  end
+end

data/lib/recaptcha/client_helper.rb

@@ -0,0 +1,42 @@
+module Recaptcha
+  module ClientHelper
+    # Your public API can be specified in the +options+ hash or preferably
+    # the environment variable +RECAPTCHA_PUBLIC_KEY+.
+    def recaptcha_tags(options = {})
+      # Default options
+      key   = options[:public_key] ||= ENV['RECAPTCHA_PUBLIC_KEY']
+      error = options[:error] ||= session[:recaptcha_error]
+      uri   = options[:ssl] ? RECAPTCHA_API_SECURE_SERVER : RECAPTCHA_API_SERVER
+      html  = ""
+      if options[:display]
+        html << %{<script type="text/javascript">\n}
+        html << %{  var RecaptchaOptions = #{options[:display].to_json};\n}
+        html << %{</script>\n}
+      end
+      if options[:ajax]
+        html << %{<div id="dynamic_recaptcha"></div>}
+        html << %{<script type="text/javascript" src="#{uri}/js/recaptcha_ajax.js"></script>\n}
+        html << %{<script type="text/javascript">\n}
+        html << %{  Recaptcha.create('#{key}', document.getElementById('dynamic_recaptcha')#{options[:display] ? '' : ',RecaptchaOptions'});}
+        html << %{</script>\n}
+      else
+        html << %{<script type="text/javascript" src="#{uri}/challenge?k=#{key}}
+        html << %{#{error ? "&error=#{CGI::escape(error)}" : ""}"></script>\n}
+        unless options[:noscript] == false
+          html << %{<noscript>\n  }
+          html << %{<iframe src="#{uri}/noscript?k=#{key}" }
+          html << %{height="#{options[:iframe_height] ||= 300}" }
+          html << %{width="#{options[:iframe_width]   ||= 500}" }
+          html << %{frameborder="0"></iframe><br/>\n  }
+          html << %{<textarea name="recaptcha_challenge_field" }
+          html << %{rows="#{options[:textarea_rows] ||= 3}" }
+          html << %{cols="#{options[:textarea_cols] ||= 40}"></textarea>\n  }
+          html << %{<input type="hidden" name="recaptcha_response_field" value="manual_challenge">}
+          html << %{</noscript>\n}
+        end
+      end
+      raise RecaptchaError, "No public key specified." unless key
+      return html
+    end # recaptcha_tags
+  end # ClientHelper
+end # Recaptcha

data/lib/recaptcha/rails.rb

@@ -0,0 +1,4 @@
+require 'recaptcha'
+
+ActionView::Base.send(:include, Recaptcha::ClientHelper)
+ActionController::Base.send(:include, Recaptcha::Verify)

data/lib/recaptcha/verify.rb

@@ -0,0 +1,45 @@
+module Recaptcha
+  module Verify
+    # Your private API can be specified in the +options+ hash or preferably
+    # the environment variable +RECAPTCHA_PUBLIC_KEY+.
+    def verify_recaptcha(options = {})
+      return true if SKIP_VERIFY_ENV.include? ENV['RAILS_ENV']
+      model = options.is_a?(Hash)? options[:model] : options
+      private_key = options[:private_key] if options.is_a?(Hash)
+      private_key ||= ENV['RECAPTCHA_PRIVATE_KEY']
+      raise RecaptchaError, "No private key specified." unless private_key
+      begin
+        recaptcha = nil
+        Timeout::timeout(options[:timeout] || 3) do
+          recaptcha = Net::HTTP.post_form URI.parse("http://#{RECAPTCHA_VERIFY_SERVER}/verify"), {
+            "privatekey" => private_key,
+            "remoteip"   => request.remote_ip,
+            "challenge"  => params[:recaptcha_challenge_field],
+            "response"   => params[:recaptcha_response_field]
+          }
+        end
+        answer, error = recaptcha.body.split.map { |s| s.chomp }
+        unless answer == 'true'
+          session[:recaptcha_error] = error
+          if model
+            model.valid?
+            model.errors.add :base, options[:message] || "Captcha response is incorrect, please try again."
+          end
+          return false
+        else
+          session[:recaptcha_error] = nil
+          return true
+        end
+      rescue Timeout::Error 
+        session[:recaptcha_error] = "recaptcha-not-reachable"
+        if model
+          model.valid?
+          model.errors.add :base, options[:message] || "Oops, we failed to validate your Captcha. Please try again."
+        end
+        return false
+      rescue Exception => e
+        raise RecaptchaError, e.message, e.backtrace
+      end
+    end # verify_recaptcha
+  end # Verify
+end # Recaptcha

data/recaptcha.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{recaptcha}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason L. Perry"]
+  s.date = %q{2009-09-14}
+  s.description = %q{This plugin adds helpers for the reCAPTCHA API }
+  s.email = %q{jasper@ambethia.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/recaptcha.rb",
+     "lib/recaptcha/client_helper.rb",
+     "lib/recaptcha/rails.rb",
+     "lib/recaptcha/verify.rb",
+     "recaptcha.gemspec",
+     "tasks/recaptcha_tasks.rake",
+     "test/recaptcha_test.rb",
+     "test/verify_recaptcha_test.rb"
+  ]
+  s.homepage = %q{http://github.com/ambethia/recaptcha}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Helpers for the reCAPTCHA API}
+  s.test_files = [
+    "test/recaptcha_test.rb",
+     "test/verify_recaptcha_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/tasks/recaptcha_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :recaptcha do
+#   # Task goes here
+# end

data/test/recaptcha_test.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'cgi'
+require File.dirname(__FILE__) + '/../lib/recaptcha'
+
+class RecaptchaClientHelperTest < Test::Unit::TestCase
+  include Recaptcha
+  include Recaptcha::ClientHelper
+  include Recaptcha::Verify
+
+  attr_accessor :session
+
+  def setup
+    @session = {}
+    ENV['RECAPTCHA_PUBLIC_KEY']  = '0000000000000000000000000000000000000000'
+    ENV['RECAPTCHA_PRIVATE_KEY'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+  end
+    
+  def test_recaptcha_tags
+    # Might as well match something...
+    assert_match /http:\/\/api.recaptcha.net/, recaptcha_tags 
+  end
+  
+  def test_recaptcha_tags_with_ssl
+    assert_match /https:\/\/api-secure.recaptcha.net/, recaptcha_tags(:ssl => true)
+  end
+
+  def test_recaptcha_tags_without_noscript
+    assert_no_match /noscript/, recaptcha_tags(:noscript => false)
+  end
+  
+  def test_should_raise_exception_without_public_key
+    assert_raise RecaptchaError do
+      ENV['RECAPTCHA_PUBLIC_KEY'] = nil
+      recaptcha_tags
+    end
+  end
+end

data/test/verify_recaptcha_test.rb

@@ -0,0 +1,96 @@
+require 'test/unit'
+require 'rails/version' # For getting the rails version constants
+require 'active_support/vendor' # For loading I18n
+require 'mocha'
+require 'net/http'
+require File.dirname(__FILE__) + '/../lib/recaptcha'
+
+class RecaptchaVerifyTest < Test::Unit::TestCase
+  def setup
+
+    ENV['RECAPTCHA_PRIVATE_KEY'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+    @controller = TestController.new
+    @controller.request = stub(:remote_ip => "1.1.1.1")
+    @controller.params = {:recaptcha_challenge_field => "challenge", :recaptcha_response_field => "response"}
+
+    @expected_post_data = {}
+    @expected_post_data["privatekey"] = ENV['RECAPTCHA_PRIVATE_KEY']
+    @expected_post_data["remoteip"]   = @controller.request.remote_ip
+    @expected_post_data["challenge"]  = "challenge"
+    @expected_post_data["response"]   = "response"
+    
+    @expected_uri = URI.parse("http://#{Recaptcha::RECAPTCHA_VERIFY_SERVER}/verify")
+  end
+
+  def test_should_raise_exception_without_private_key
+    assert_raise Recaptcha::RecaptchaError do
+      ENV['RECAPTCHA_PRIVATE_KEY'] = nil
+      @controller.verify_recaptcha
+    end
+  end
+
+  def test_should_return_false_when_key_is_invalid
+    expect_http_post(response_with_body("false\ninvalid-site-private-key"))
+
+    assert !@controller.verify_recaptcha    
+    assert_equal "invalid-site-private-key", @controller.session[:recaptcha_error]
+  end
+  
+  def test_returns_true_on_success
+    @controller.session[:recaptcha_error] = "previous error that should be cleared"    
+    expect_http_post(response_with_body("true\n"))
+
+    assert @controller.verify_recaptcha
+    assert_nil @controller.session[:recaptcha_error]
+  end
+  
+  def test_errors_should_be_added_to_model
+    expect_http_post(response_with_body("false\nbad-news"))
+    
+    errors = mock
+    errors.expects(:add).with(:base, "Captcha response is incorrect, please try again.")
+    model = mock(:valid? => false, :errors => errors)
+
+    assert !@controller.verify_recaptcha(:model => model)
+    assert_equal "bad-news", @controller.session[:recaptcha_error]
+  end
+
+  def test_returns_true_on_success_with_optional_key
+    @controller.session[:recaptcha_error] = "previous error that should be cleared"
+    # reset private key
+    @expected_post_data["privatekey"] =  'ADIFFERENTPRIVATEKEYXXXXXXXXXXXXXX'
+    expect_http_post(response_with_body("true\n"))
+
+    assert @controller.verify_recaptcha(:private_key => 'ADIFFERENTPRIVATEKEYXXXXXXXXXXXXXX')
+    assert_nil @controller.session[:recaptcha_error]
+  end
+
+  def test_timeout
+    expect_http_post(Timeout::Error, :exception => true)
+    assert !@controller.verify_recaptcha()
+    assert_equal "recaptcha-not-reachable", @controller.session[:recaptcha_error]
+  end
+
+  private
+
+  class TestController
+    include Recaptcha::Verify
+    attr_accessor :request, :params, :session
+    
+    def initialize
+      @session = {}
+    end
+  end
+  
+  def expect_http_post(response, options = {})
+    unless options[:exception]
+      Net::HTTP.expects(:post_form).with(@expected_uri, @expected_post_data).returns(response)
+    else
+      Net::HTTP.expects(:post_form).raises response
+    end
+  end
+  
+  def response_with_body(body)
+    stub(:body => body)
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: ambethia-recaptcha
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Jason L. Perry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This plugin adds helpers for the reCAPTCHA API
+email: jasper@ambethia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/recaptcha.rb
+- lib/recaptcha/client_helper.rb
+- lib/recaptcha/rails.rb
+- lib/recaptcha/verify.rb
+- recaptcha.gemspec
+- tasks/recaptcha_tasks.rake
+- test/recaptcha_test.rb
+- test/verify_recaptcha_test.rb
+has_rdoc: false
+homepage: http://github.com/ambethia/recaptcha
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Helpers for the reCAPTCHA API
+test_files: 
+- test/recaptcha_test.rb
+- test/verify_recaptcha_test.rb