ruby-recaptcha 1.0.0

data/History.txt

@@ -0,0 +1,117 @@
+changeset:   49:201f032ce586
+user:        m@loonsoft.com
+date:        Tue Sep 02 10:59:53 2008 -0500
+summary:     removed test code which seems to cause trouble with the masses
+
+changeset:   48:297ed7ad0790
+user:        m@loonsoft.com
+date:        Fri May 30 09:04:24 2008 -0500
+summary:     fix for loopback addr requests
+
+changeset:   47:143671e3abb0
+user:        m@loonsoft.com
+date:        Mon Apr 07 23:24:24 2008 -0500
+summary:     fix for kim griggs
+
+changeset:   46:52e0ff173f56
+user:        m@loonsoft.com
+date:        Wed Mar 05 20:27:58 2008 -0600
+summary:     fixed bug when nil challenge string
+
+changeset:   45:f63d820d97f9
+user:        m@loonsoft.com
+date:        Sat Mar 01 08:40:33 2008 -0600
+summary:     integrated more patches from pv
+
+changeset:   44:4964962ea7be
+user:        m@loonsoft.com
+date:        Sun Feb 24 13:59:27 2008 -0600
+summary:     reapplied missing patch
+
+changeset:   43:299402495d48
+user:        m@loonsoft.com
+date:        Sun Feb 24 08:25:04 2008 -0600
+summary:     patch from peter vandenberk
+
+changeset:   40:e55d02f563e4
+user:        m@loonsoft.com
+date:        Sat Jan 12 11:33:35 2008 -0600
+summary:     proxy support
+
+changeset:   34:24e4ed5017bc
+user:        m@loonsoft.com
+date:        Thu Aug 23 15:01:14 2007 -0500
+summary:     fix from joey geiger
+
+changeset:   33:310e75fbd650
+user:        m@loonsoft.com
+date:        Sat Jun 09 08:10:38 2007 -0500
+summary:     error parameter no longer included when the error is blank or nil
+
+changeset:   31:ed21f08b6331
+parent:      27:5a6746ce03f7
+user:        m@loonsoft.com
+date:        Wed Jun 06 22:36:58 2007 -0500
+summary:     Backed out changeset 5a6746ce03f73d0dd02db155816500870088bf6e
+
+changeset:   27:5a6746ce03f7
+parent:      25:d614a6a28630
+user:        m@loonsoft.com
+date:        Wed Jun 06 22:02:37 2007 -0500
+summary:     Backed out changeset d614a6a28630eb4dba913739518dbdc6d3aaa410
+
+changeset:   25:d614a6a28630
+user:        m@loonsoft.com
+date:        Wed May 30 14:28:25 2007 -0500
+summary:     patch from victor cosby
+
+changeset:   24:d1dc394b249b
+user:        m@loonsoft.com
+date:        Tue May 29 09:57:04 2007 -0500
+summary:     Backed out changeset 1086e6e6217f85433cc539e6d687880adc421c2f
+
+changeset:   23:1086e6e6217f
+user:        m@loonsoft.com
+date:        Tue May 29 09:47:38 2007 -0500
+summary:     reworked error handling
+
+changeset:   22:5497521e6a01
+user:        m@loonsoft.com
+date:        Sun May 27 17:21:16 2007 -0500
+summary:     removed bogon method stub
+
+changeset:   19:943383442ab0
+user:        m@loonsoft.com
+date:        Sun May 27 15:21:27 2007 -0500
+summary:     mailhide supported
+
+changeset:   16:a9f834ef0ffb
+user:        m@loonsoft.com
+date:        Fri May 25 19:22:49 2007 -0500
+summary:     added cgi module, some tests
+
+changeset:   11:d7dcf24bb808
+user:        m@loonsoft.com
+date:        Fri May 25 11:58:27 2007 -0500
+summary:     changed license
+
+changeset:   9:8047f6e7eceb
+user:        m@loonsoft.com
+date:        Fri May 25 11:46:12 2007 -0500
+summary:     turned off ssl
+
+changeset:   4:d28f38ac7cde
+user:        m@loonsoft.com
+date:        Fri May 25 11:18:07 2007 -0500
+summary:     updated
+
+changeset:   1:146d97cc2e51
+user:        m@loonsoft.com
+date:        Fri May 25 10:41:52 2007 -0500
+summary:     fixed license
+
+changeset:   0:1f1ba6ed3ef1
+user:        m@loonsoft.com
+date:        Fri May 25 10:41:35 2007 -0500
+summary:     initial
+

data/README.txt

@@ -0,0 +1,113 @@
+= ruby-recaptcha
+
+h2. What
+
+h2. Installing
+
+<pre>
+  gem install recaptcha
+</pre>
+
+h2. The basics
+
+The ReCaptchaClient abstracts the ReCaptcha API for use in Rails Applications
+
+
+h2. Demonstration of usage
+
+h3. reCAPTCHA
+
+First, create an account at "ReCaptcha.net":http://www.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).
+
+The two common methods of doing this (for Rails applications) are to set these variables in your environment.rb file, or via an environment variable, or in Rails 2.2+, in an initializer.
+
+The ReCaptcha::Client constructor can also take an options hash containing keys thusly:
+<pre>
+  Recaptcha::Client.new(:rcc_pub=>'some key', :rcc_priv=>'some other key')
+</pre>
+In recent versions of Rails, you can specify the gem in environment.rb:
+
+<pre>
+  config.gem 'ruby-recaptcha'
+</pre>
+
+After your keys are configured, and the gem is loaded, include the ReCaptcha::AppHelper module in your ApplicationController: 
+<pre>
+class ApplicationController < ActionController::Base
+  include ReCaptcha::AppHelper
+</pre>
+ 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:
+<pre>
+  def create
+      @user = User.new(params[:user])
+      if validate_recap(params, @user.errors) && @user.save
+             ...do stuff...
+</pre>
+
+Require and include the view helper in your application_helper: NOTE: require is used here, not gem, not sure why.
+<pre>
+  include ReCaptcha::ViewHelper
+</pre> 
+
+This will mix get_captcha() into your view helper.
+
+Now you can just call <pre>get_captcha()</pre> in your view to insert the requisite widget from ReCaptcha.
+
+To customize theme and tabindex of the widget, you can include an options hash:
+
+<pre>get_captcha(:options => {:theme => 'white', :tabindex => 10})</pre>
+
+See the "reCAPTCHA API Documentation":http://recaptcha.net/apidocs/captcha/ under "Look and Feel Customization" for more information.
+
+h3. Proxy support
+
+If your rails application requires the use of a proxy, set proxy_host into your environment:
+<pre>
+  ENV['proxy_host']='foo.example.com:8080'
+</pre>
+
+h3. Mail Hide
+
+When you mix in ViewHelper as above, you also get <pre> mail_hide(address, contents)</pre>, which you can call in your view thusly:
+
+<pre>
+  ...
+  <%= mail_hide(user.email) %>
+</pre>
+
+Contents defaults to the first few characters of the email address.
+
+h2. Bugs
+
+http://www.bitbucket.org/mml/ruby-recaptcha/issues
+
+h2. Code
+
+Get it "here":http://www.bitbucket.org/mml/ruby-recaptcha
+
+Note the wiki & forum & such there...
+
+
+
+h2. License
+
+This code is free to use under the terms of the MIT License.
+
+h2. Contact
+
+Comments are welcome. Send an email to "McClain Looney":mailto:mlooney@gmail.com.
+
+h2. Contributors:
+
+Victor Cosby (test cleanup, additional code to style widget)
+<br>
+Ronald Schroeter (proxy support suggestion & proto-patch)
+<br>
+Peter Vandenberk (multi-key support, ssl support, various unit tests, test refactoring)
+<br>
+Kim Griggs (found long address-newline bug)  

data/lib/recaptcha.rb

@@ -0,0 +1,143 @@
+#Copyright (c) 2007, 2008, 2009 McClain Looney
+#
+#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.
+require 'openssl'
+require 'base64'
+require 'cgi'
+require 'net/http'
+require 'net/https'
+module ReCaptcha
+  module ViewHelper
+    def get_captcha(options={})
+      k = ReCaptcha::Client.new(options[:rcc_pub] || RCC_PUB, options[:rcc_priv] || RCC_PRIV, options[:ssl] || false)
+      r = k.get_challenge(session[:rcc_err] || '', options)
+      session[:rcc_err]=''
+      r
+    end
+    def mail_hide(address, contents=nil)
+      contents = truncate(address,10) if contents.nil?
+      k = ReCaptcha::MHClient.new(MH_PUB, MH_PRIV)
+      enciphered = k.encrypt(address)
+      uri = "http://mailhide.recaptcha.net/d?k=#{MH_PUB}&c=#{enciphered}"
+      t =<<-EOF
+      <a href="#{uri}"
+      onclick="window.open('#{uri}', '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return false;" title="Reveal this e-mail address">#{contents}</a>
+    EOF
+    end
+
+  end
+  module  AppHelper
+    private
+    def validate_recap(p, errors, options = {})
+      rcc=ReCaptcha::Client.new(options[:rcc_pub] || RCC_PUB, options[:rcc_priv] || RCC_PRIV)
+      res = rcc.validate(request.remote_ip, p[:recaptcha_challenge_field], p[:recaptcha_response_field], errors)
+      session[:rcc_err]=rcc.last_error
+
+      res
+    end
+  end
+  class MHClient
+    def initialize(pubkey, privkey)
+      @pubkey=pubkey
+      @privkey=privkey
+      @host='mailhide.recaptcha.net'
+    end
+    def encrypt(string)
+      padded = pad(string)
+      iv="\00\00\00\00\00\00\00\00\00\00\00\00\00\00\00\00"
+      cipher=OpenSSL::Cipher::Cipher.new("AES-128-CBC")
+      binkey = @privkey.unpack('a2'*16).map{|x| x.hex}.pack('c'*16)
+      cipher.encrypt
+      cipher.key=binkey
+      cipher.iv=iv
+      ciphertext = []
+      cipher.padding=0
+      ciphertext = cipher.update(padded)
+      ciphertext << cipher.final() rescue nil 
+      Base64.encode64(ciphertext).strip.gsub(/\+/, '-').gsub(/\//, '_').gsub(/\n/,'')
+    end
+    def pad(str)
+      l= 16-(str.length%16)
+      l.times do
+        str<< l
+      end
+      str
+    end
+  end
+  class Client
+
+    def initialize(pubkey, privkey, ssl=false)
+      @pubkey = pubkey
+      @privkey=privkey
+      @host = ssl ? 'api-secure.recaptcha.net':'api.recaptcha.net'
+      @vhost = 'api-verify.recaptcha.net'
+      @proto = ssl ? 'https' : 'http'
+      @ssl = ssl
+      @last_error=nil
+    end
+
+    def get_challenge(error='', options={})
+      s=''
+      if options[:options]
+        s << "<script type=\"text/javascript\">\nvar RecaptchaOptions = { "
+        options[:options].each do |k,v|
+          val = (v.class == Fixnum) ? "#{v}" : "\"#{v}\""
+          s << "#{k} : #{val}, "
+        end
+        s.sub!(/, $/, '};')
+        s << "\n</script>\n"
+      end
+      errslug = (error.empty?||error==nil||error=="success") ? '' :  "&error=#{CGI.escape(error)}"
+      s <<<<-EOF
+      <script type="text/javascript" src="#{@proto}://#{@host}/challenge?k=#{CGI.escape(@pubkey)}#{errslug}"> </script>
+      <noscript>
+      <iframe src="#{@proto}://#{@host}/noscript?k=#{CGI.escape(@pubkey)}#{errslug}"
+      height="300" width="500" frameborder="0"></iframe><br>
+      <textarea name="recaptcha_challenge_field" rows="3" cols="40">
+      </textarea>
+      <input type="hidden" name="recaptcha_response_field" 
+      value="manual_challenge">
+      </noscript>
+      EOF
+    end
+
+    def last_error
+      @last_error
+    end
+    def validate(remoteip, challenge, response, errors)
+      msg = "Captcha failed."
+      unless response and challenge
+        errors.add_to_base(msg)
+        return false
+      end
+      proxy_host, proxy_port = nil, nil
+      proxy_host, proxy_port = ENV['proxy_host'].split(':')  if ENV.has_key?('proxy_host')
+      http = Net::HTTP::Proxy(proxy_host, proxy_port).start(@vhost)
+      path='/verify'
+      data = "privatekey=#{CGI.escape(@privkey)}&remoteip=#{CGI.escape(remoteip)}&challenge=#{CGI.escape(challenge)}&response=#{CGI.escape(response)}"
+      resp, data = http.post(path, data, {'Content-Type'=>'application/x-www-form-urlencoded'})
+      response = data.split
+      result = response[0].chomp
+      @last_error=response[1].chomp
+      errors.add_to_base(msg) if  result != 'true'
+      result == 'true' 
+    end
+  end
+
+end

data/lib/ruby-recaptcha.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'recaptcha'
+module RubyRecaptcha
+  VERSION = '1.0.0'
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/ruby-recaptcha'

data/test/test_recaptcha.rb

@@ -0,0 +1,336 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'rubygems'
+gem 'mocha'
+require 'mocha'
+gem 'rails'
+
+module ReCaptcha
+  module ViewHelper
+    def self.define_public_key
+      class_eval "RCC_PUB = 'foo'"
+    end
+    def self.define_private_key
+      class_eval "RCC_PRIV = 'bar'"
+    end
+    def self.undefine_public_key
+      remove_const :RCC_PUB
+    end
+    def self.undefine_private_key
+      remove_const :RCC_PRIV
+    end
+  end
+  module AppHelper
+    def self.define_public_key
+      class_eval "RCC_PUB = 'foo'"
+    end
+    def self.define_private_key
+      class_eval "RCC_PRIV = 'bar'"
+    end
+    def self.undefine_public_key
+      remove_const :RCC_PUB
+    end
+    def self.undefine_private_key
+      remove_const :RCC_PRIV
+    end
+    public :validate_recap
+  end
+end
+
+class TestRecaptcha < Test::Unit::TestCase
+  class ViewFixture
+    PRIVKEY='6LdnAQAAAAAAAPYLVPwVvR7Cy9YLhRQcM3NWsK_C'
+    PUBKEY='6LdnAQAAAAAAAKEk59yjuP3csGEeDmdj__7cyMtY'
+    include ReCaptcha::ViewHelper
+    # views in Rails "inherit" the controller's session...
+    def session
+      @session ||= {}
+    end
+  end
+  class ControllerFixture
+    include ReCaptcha::AppHelper
+    attr_reader :request
+    # all Rails controllers have a session...
+    def session
+      @session ||= {}
+    end
+    def initialize()
+      @request = mock()
+      @request.stubs(:remote_ip).returns('0.0.0.0') # this will skip the actual captcha validation...
+      @request
+    end
+    include Mocha::Standalone
+  end
+
+  def setup
+    @vf = ViewFixture.new
+    @cf = ControllerFixture.new
+  end
+
+  def test_encrypt
+    mhc = ReCaptcha::MHClient.new('01S1TOX9aibKxfC9oJlp8IeA==', 'deadbeefdeadbeefdeadbeefdeadbeef')
+    z =mhc.encrypt('x@example.com')
+    assert_equal 'wBG7nOgntKqWeDpF9ucVNQ==', z
+    z =mhc.encrypt('johndoe@example.com')
+    assert_equal 'whWIqk0r4urZ-3S7y7uSceC9_ECd3hpAGy71E2o0HpI=', z
+  end
+  def test_encrypt_long
+    mhc = ReCaptcha::MHClient.new('01S1TOX9aibKxfC9oJlp8IeA==', 'deadbeefdeadbeefdeadbeefdeadbeef')
+    z =mhc.encrypt('averylongemailaddressofmorethan32cdharactersx@example.com')
+    assert_equal "q-0LLVT2bIxWbFpfLfpNhJAGadkfWXVk4hAxSlVaLrdnXrsB1NKNubavS5N-7PBued3K531vifN6NB3iz3W7qQ==",z
+    z =mhc.encrypt('johndoe@example.com')
+    assert_equal 'whWIqk0r4urZ-3S7y7uSceC9_ECd3hpAGy71E2o0HpI=', z
+  end
+
+  def test_nil_challenge
+    client = new_client
+    estub = stub_everything('errors')
+    client.validate('abc', nil, 'foo', estub)
+
+  end
+
+  def test_constructor
+    client = new_client('abc', 'def', true)
+    expected= <<-EOF
+    <script type=\"text/javascript\" src=\"https://api-secure.recaptcha.net/challenge?k=abc\"> </script>\n      <noscript>\n      <iframe src=\"https://api-secure.recaptcha.net/noscript?k=abc\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    assert_equal expected.strip, client.get_challenge.strip
+    client = new_client
+    expected= <<-EOF
+    <script type=\"text/javascript\" src=\"http://api.recaptcha.net/challenge?k=abc\"> </script>\n      <noscript>\n      <iframe src=\"http://api.recaptcha.net/noscript?k=abc\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    assert_equal expected.strip, client.get_challenge.strip
+    client = new_client
+    expected= <<-EOF
+    <script type=\"text/javascript\" src=\"http://api.recaptcha.net/challenge?k=abc\"> </script>\n      <noscript>\n      <iframe src=\"http://api.recaptcha.net/noscript?k=abc\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    assert_equal expected.strip, client.get_challenge.strip
+  end
+
+  def test_constructor_with_recaptcha_options
+    # "Look and Feel Customization" per http://recaptcha.net/apidocs/captcha/
+    client = new_client
+    expected= <<-EOF
+    <script type=\"text/javascript\">\nvar RecaptchaOptions = { theme : \"white\", tabindex : 10};\n</script>\n      <script type=\"text/javascript\" src=\"http://api.recaptcha.net/challenge?k=abc&error=somerror\"> </script>\n      <noscript>\n      <iframe src=\"http://api.recaptcha.net/noscript?k=abc&error=somerror\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    assert_equal expected.strip, client.get_challenge('somerror', :options => {:theme => 'white', :tabindex => 10}).strip
+  end
+
+  def test_validate_fails
+    badwords_resp="false\r\n360 incorrect-captcha-sol"
+    err_stub=mock()
+    err_stub.expects(:add_to_base).with("Captcha failed.")
+    stub_proxy=mock('proxy')
+    stub_http = mock('http mock')
+    stub_proxy.expects(:start).with('api-verify.recaptcha.net').returns(stub_http)
+    stub_http.expects(:post).with('/verify', 'privatekey=def&remoteip=localhost&challenge=abc&response=def', {'Content-Type' => 'application/x-www-form-urlencoded'}).returns(['foo', badwords_resp])
+    Net::HTTP.expects(:Proxy).returns(stub_proxy)
+    client = new_client
+    assert !client.validate('localhost', 'abc', 'def', err_stub)
+  end
+  def test_validate_good
+    goodwords_resp="true\r\nsuccess"
+    err_stub=mock()
+    stub_proxy=mock('proxy')
+    stub_http = mock('http mock')
+    stub_proxy.expects(:start).with('api-verify.recaptcha.net').returns(stub_http)
+    stub_http.expects(:post).with('/verify', 'privatekey=def&remoteip=localhost&challenge=abc&response=def', {'Content-Type' => 'application/x-www-form-urlencoded'}).returns(['foo', goodwords_resp])
+    Net::HTTP.expects(:Proxy).with(nil, nil).returns(stub_proxy)
+    client = new_client
+    assert client.validate('localhost', 'abc', 'def', err_stub)
+  end
+  def test_validate_good_proxy
+    ENV['proxy_host']='fubar:8080'
+    goodwords_resp="true\r\nsuccess"
+    err_stub=mock()
+    stub_proxy=mock('proxy')
+    stub_http = mock('http mock')
+    stub_proxy.expects(:start).with('api-verify.recaptcha.net').returns(stub_http)
+    stub_http.expects(:post).with('/verify', 'privatekey=def&remoteip=localhost&challenge=abc&response=def', {'Content-Type' => 'application/x-www-form-urlencoded'}).returns(['foo', goodwords_resp])
+    Net::HTTP.expects(:Proxy).with('fubar', '8080').returns(stub_proxy)
+    client = new_client
+    assert client.validate('localhost', 'abc', 'def', err_stub)
+    ENV['proxy_host']='fubar'
+    err_stub=mock()
+    stub_proxy=mock('proxy')
+    stub_http = mock('http mock')
+    stub_proxy.expects(:start).with('api-verify.recaptcha.net').returns(stub_http)
+    stub_http.expects(:post).with('/verify', 'privatekey=def&remoteip=localhost&challenge=abc&response=def', {'Content-Type' => 'application/x-www-form-urlencoded'}).returns(['foo', goodwords_resp])
+    Net::HTTP.expects(:Proxy).with('fubar', nil).returns(stub_proxy)
+    client = new_client
+    assert client.validate('localhost', 'abc', 'def', err_stub)
+  end
+
+  #
+  # unit tests for the get_captcha() ViewHelper method
+  #
+
+  def test_get_captcha_fails_without_key_constants
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PRIV)
+    assert_raise NameError do
+      @vf.get_captcha
+    end
+  end
+  def test_get_captcha_fails_without_public_key_constant
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PRIV)
+    ReCaptcha::ViewHelper.define_private_key
+    assert ReCaptcha::ViewHelper.const_defined?(:RCC_PRIV)
+    assert_raise NameError do
+      @vf.get_captcha
+    end
+    ReCaptcha::ViewHelper.undefine_private_key
+  end
+  def test_get_captcha_fails_without_private_key_constant
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PRIV)
+    ReCaptcha::ViewHelper.define_public_key
+    assert ReCaptcha::ViewHelper.const_defined?(:RCC_PUB)
+    assert_raise NameError do
+      @vf.get_captcha
+    end
+    ReCaptcha::ViewHelper.undefine_public_key
+  end
+  def test_get_captcha_succeeds_with_key_constants
+    mock_client = mock('client')
+    ReCaptcha::Client.expects(:new).returns(mock_client)
+    mock_client.expects(:get_challenge).with('', {})
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PRIV)
+    ReCaptcha::ViewHelper.define_public_key
+    ReCaptcha::ViewHelper.define_private_key
+    assert ReCaptcha::ViewHelper.const_defined?(:RCC_PUB)
+    assert ReCaptcha::ViewHelper.const_defined?(:RCC_PRIV)
+    assert_nothing_raised do
+      @vf.get_captcha
+    end
+    ReCaptcha::ViewHelper.undefine_public_key
+    ReCaptcha::ViewHelper.undefine_private_key
+  end
+  def test_get_captcha_succeeds_without_key_constants_but_with_options
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::ViewHelper.const_defined?(:RCC_PRIV)
+    assert_nothing_raised do
+      @vf.get_captcha(:rcc_pub => 'foo', :rcc_priv => 'bar')
+    end
+  end
+  def test_get_captcha_is_correct_with_constants_and_with_options
+    expected= <<-EOF
+    <script type=\"text/javascript\" src=\"http://api.recaptcha.net/challenge?k=%s\"> </script>\n      <noscript>\n      <iframe src=\"http://api.recaptcha.net/noscript?k=%s\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    # first, with constants
+    ReCaptcha::ViewHelper.define_public_key  # 'foo'
+    ReCaptcha::ViewHelper.define_private_key # 'bar'
+    actual = @vf.get_captcha
+    assert_equal(((expected % ['foo', 'foo']).strip), actual.strip)
+    ReCaptcha::ViewHelper.undefine_public_key
+    ReCaptcha::ViewHelper.undefine_private_key
+    # next, with options
+    actual = @vf.get_captcha(:rcc_pub => 'foobar', :rcc_priv => 'blegga')
+    assert_equal(((expected % ['foobar', 'foobar']).strip), actual.strip)
+  end
+
+  #
+  # unit tests for the validate_recap() AppHelper method
+  #
+
+  def test_validate_recap_fails_without_key_constants
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PRIV)
+    assert_raise NameError do
+      @cf.validate_recap({}, {})
+    end
+  end
+  def test_validate_recap_fails_without_public_key_constant
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PRIV)
+    ReCaptcha::AppHelper.define_private_key
+    assert ReCaptcha::AppHelper.const_defined?(:RCC_PRIV)
+    assert_raise NameError do
+      @cf.validate_recap({}, {})
+    end
+    ReCaptcha::AppHelper.undefine_private_key
+  end
+  def test_validate_recap_fails_without_private_key_constant
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PRIV)
+    ReCaptcha::AppHelper.define_public_key
+    assert ReCaptcha::AppHelper.const_defined?(:RCC_PUB)
+    assert_raise NameError do
+      @cf.validate_recap({}, {})
+    end
+    ReCaptcha::AppHelper.undefine_public_key
+  end
+  def test_validate_recap_succeeds_with_key_constants
+    e = mock('errors')
+    e.expects(:add_to_base).with('Captcha failed.')
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PRIV)
+    ReCaptcha::AppHelper.define_public_key
+    ReCaptcha::AppHelper.define_private_key
+    assert ReCaptcha::AppHelper.const_defined?(:RCC_PUB)
+    assert ReCaptcha::AppHelper.const_defined?(:RCC_PRIV)
+    assert_nothing_raised do
+      @cf.validate_recap({}, e)
+    end
+    ReCaptcha::AppHelper.undefine_public_key
+    ReCaptcha::AppHelper.undefine_private_key
+  end
+  def test_validate_recap_succeeds_without_key_constants_but_with_options
+    mock = mock('client')
+    ReCaptcha::Client.expects(:new).returns(mock)
+    mock.expects(:validate).with('0.0.0.0', nil, nil, {}).returns(true)
+    mock.expects(:last_error)
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PUB)
+    assert !ReCaptcha::AppHelper.const_defined?(:RCC_PRIV)
+    @cf.validate_recap({}, {}, :rcc_pub => 'foo', :rcc_priv => 'bar')
+  end
+  def test_validate_recap_is_correct_with_constants_and_with_options
+    # first, with constants
+    e = mock('errors')
+    mock = mock('client')
+    ReCaptcha::Client.expects(:new).returns(mock).times(2)
+    mock.expects(:validate).with('0.0.0.0', nil,  nil, {}).returns(true)
+    mock.expects(:last_error).times(2)
+    ReCaptcha::AppHelper.define_public_key  # 'foo'
+    ReCaptcha::AppHelper.define_private_key # 'bar'
+    assert @cf.validate_recap({}, {})
+    ReCaptcha::AppHelper.undefine_public_key
+    ReCaptcha::AppHelper.undefine_private_key
+    # next, with options
+    mock.expects(:validate).with('0.0.0.0', nil,  nil, e).returns(true)
+    assert @cf.validate_recap({}, e, {:rcc_pub => 'foobar', :rcc_priv => 'blegga'})
+  end
+
+  #
+  # unit tests for HTTP/HTTPS-variants of get_captcha() method
+  #
+
+  def test_get_captcha_uses_http_without_options
+    expected= <<-EOF
+    <script type=\"text/javascript\" src=\"http://api.recaptcha.net/challenge?k=%s\"> </script>\n      <noscript>\n      <iframe src=\"http://api.recaptcha.net/noscript?k=%s\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    actual = @vf.get_captcha(:rcc_pub => 'foobar', :rcc_priv => 'blegga')
+    assert_equal(((expected % ['foobar', 'foobar']).strip), actual.strip)
+  end
+  def test_get_captcha_uses_https_with_options_true
+    expected= <<-EOF
+    <script type=\"text/javascript\" src=\"https://api-secure.recaptcha.net/challenge?k=%s\"> </script>\n      <noscript>\n      <iframe src=\"https://api-secure.recaptcha.net/noscript?k=%s\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    actual = @vf.get_captcha(:rcc_pub => 'foobar', :rcc_priv => 'blegga', :ssl => true)
+    assert_equal(((expected % ['foobar', 'foobar']).strip), actual.strip)
+  end
+  def test_get_captcha_uses_http_with_options_false
+    expected= <<-EOF
+    <script type=\"text/javascript\" src=\"http://api.recaptcha.net/challenge?k=%s\"> </script>\n      <noscript>\n      <iframe src=\"http://api.recaptcha.net/noscript?k=%s\"\n      height=\"300\" width=\"500\" frameborder=\"0\"></iframe><br>\n      <textarea name=\"recaptcha_challenge_field\" rows=\"3\" cols=\"40\">\n      </textarea>\n      <input type=\"hidden\" name=\"recaptcha_response_field\" \n      value=\"manual_challenge\">\n      </noscript>
+    EOF
+    actual = @vf.get_captcha(:rcc_pub => 'foobar', :rcc_priv => 'blegga', :ssl => false)
+    assert_equal(((expected % ['foobar', 'foobar']).strip), actual.strip)
+  end
+
+  private
+
+  def new_client(pubkey='abc', privkey='def', ssl=false)
+    ReCaptcha::Client.new(pubkey, privkey, ssl)
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-recaptcha
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- McClain Looney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ""
+email: 
+- m@loonsoft.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+files: 
+- History.txt
+- README.txt
+- lib/recaptcha.rb
+- lib/ruby-recaptcha.rb
+has_rdoc: true
+homepage: h2. What
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: ruby-recaptcha
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: 
+- test/test_helper.rb
+- test/test_recaptcha.rb