mwhuss-recaptcha 0.1.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+== 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/Manifest

@@ -0,0 +1,12 @@
+CHANGELOG
+init.rb
+lib/recaptcha/recaptcha.rb
+lib/recaptcha.rb
+LICENSE
+Manifest
+Rakefile
+README.rdoc
+recaptcha.gemspec
+tasks/recaptcha_tasks.rake
+test/recaptcha_test.rb
+test/verify_recaptcha_test.rb

data/README.rdoc

@@ -0,0 +1,53 @@
+= ReCAPTCHA
+
+Author::    Jason L Perry (http://ambethia.com)
+
+Copyright:: Copyright (c) 2007 Jason L Perry
+
+License::   MIT
+
+RDOC::      http://ambethia.com/recaptcha/
+
+Git::       http://github.com/ambethia/recaptcha/tree/master
+
+Bugs::      http://ambethia.lighthouseapp.com/projects/11072-recaptcha/overview
+
+
+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 config/environment.rb if you
+are so inclined. Exceptions will be raised if you call these methods and the keys can't be found.
+
+== +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>:public_key</tt>::  Your public API key, takes precedence over the ENV variable (default +nil+).
+<tt>:error</tt>::       Override the error in +session[:recaptcha_error]+ (default +nil+).
+
+== +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.
+
+  respond_to do |format|
+    if verify_recaptcha(@post) && @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,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'echoe'
+
+Echoe.new('recaptcha', '0.1.0') do |p|
+  p.description    = "This plugin adds helpers for the ReCAPTCHA API "
+  p.url            = "http://github.com/ambethia/recaptcha/tree/master"
+  p.author         = "Jason L. Perry"
+  p.email          = "jasper@ambethia.com"
+  p.ignore_pattern = ["pkg/**/*"]
+  p.development_dependencies = []
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the recaptcha plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+ALLISON = "/Library/Ruby/Gems/1.8/gems/allison-2.0.3/lib/allison.rb"  
+  
+Rake::RDocTask.new do |rd|  
+  rd.main = "README.rdoc"  
+  rd.rdoc_files.include "README.rdoc", "LICENSE", "lib/**/*.rb"
+  rd.title = "ReCAPTCHA"  
+  rd.options << '-N' # line numbers  
+  rd.options << '-S' # inline source  
+  rd.template = ALLISON if File.exist?(ALLISON)  
+end
+
+desc "Upload the rdoc to ambethia.com"
+task "publish" do
+  sh "scp -r html/* ambethia.com:~/www/ambethia.com/recaptcha"
+end

data/init.rb

@@ -0,0 +1,3 @@
+require 'recaptcha.rb'
+ActionView::Base.send :include, Ambethia::ReCaptcha::Helper
+ActionController::Base.send :include, Ambethia::ReCaptcha::Controller

data/lib/recaptcha.rb

@@ -0,0 +1,3 @@
+require 'recaptcha/recaptcha'
+ActionView::Base.send :include, Ambethia::ReCaptcha::Helper
+ActionController::Base.send :include, Ambethia::ReCaptcha::Controller

data/lib/recaptcha/recaptcha.rb

@@ -0,0 +1,84 @@
+# ReCAPTCHA
+module Ambethia
+  module ReCaptcha
+    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']
+
+    module Helper
+      # 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
+        xhtml = Builder::XmlMarkup.new :target => out=(''), :indent => 2 # Because I can.
+        if options[:display]
+          xhtml.script(:type => "text/javascript"){ |x| x << "var RecaptchaOptions = #{options[:display].to_json};\n"}
+        end
+        if options[:ajax]
+         xhtml.div(:id => 'dynamic_recaptcha') {}
+         xhtml.script(:type => "text/javascript", :src => "#{uri}/js/recaptcha_ajax.js") {}
+         xhtml.script(:type => "text/javascript") do |x|
+           x << "Recaptcha.create('#{key}', document.getElementById('dynamic_recaptcha') );"
+         end
+        else
+          xhtml.script(:type => "text/javascript", :src => :"#{uri}/challenge?k=#{key}&error=#{error}") {}
+          unless options[:noscript] == false
+            xhtml.noscript do
+              xhtml.iframe(:src    => "#{uri}/noscript?k=#{key}",
+                           :height => options[:iframe_height] ||= 300,
+                           :width  => options[:iframe_width]  ||= 500,
+                           :frameborder => 0) {}; xhtml.br
+              xhtml.textarea nil, :name => "recaptcha_challenge_field",
+                                  :rows => options[:textarea_rows] ||= 3,
+                                  :cols => options[:textarea_cols] ||= 40
+              xhtml.input :name => "recaptcha_response_field",
+                          :type => "hidden", :value => "manual_challenge"
+            end
+          end
+        end
+        raise ReCaptchaError, "No public key specified." unless key
+        return out
+      end # recaptcha_tags
+    end # Helpers
+
+    module Controller
+      # 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']
+        private_key = options[:private_key] ||= ENV['RECAPTCHA_PRIVATE_KEY']
+        raise ReCaptchaError, "No private key specified." unless private_key
+        begin
+          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]
+          }
+          answer, error = recaptcha.body.split.map { |s| s.chomp }
+          unless answer == 'true'
+            session[:recaptcha_error] = error
+            if model = options[:model]
+              model.valid?
+              model.errors.add_to_base "Captcha response is incorrect, please try again."
+            end
+            return false
+          else
+            session[:recaptcha_error] = nil
+            return true
+          end
+        rescue Exception => e
+          raise ReCaptchaError, e
+        end
+      end # verify_recaptcha
+    end # ControllerHelpers
+
+    class ReCaptchaError < StandardError; end
+
+  end # ReCaptcha
+end # Ambethia

data/recaptcha.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{recaptcha}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason L. Perry"]
+  s.date = %q{2009-02-08}
+  s.description = %q{This plugin adds helpers for the ReCAPTCHA API}
+  s.email = %q{jasper@ambethia.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/recaptcha/recaptcha.rb", "lib/recaptcha.rb", "LICENSE", "README.rdoc", "tasks/recaptcha_tasks.rake"]
+  s.files = ["CHANGELOG", "init.rb", "lib/recaptcha/recaptcha.rb", "lib/recaptcha.rb", "LICENSE", "Manifest", "Rakefile", "README.rdoc", "tasks/recaptcha_tasks.rake", "test/recaptcha_test.rb", "test/verify_recaptcha_test.rb", "recaptcha.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ambethia/recaptcha/tree/master}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Recaptcha", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{recaptcha}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{This plugin adds 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 = 2
+
+    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,38 @@
+require 'test/unit'
+require 'rubygems'
+require 'builder'
+require File.dirname(__FILE__) + '/../lib/recaptcha'
+
+class ReCaptchaTest < Test::Unit::TestCase
+  include Ambethia::ReCaptcha
+  include Ambethia::ReCaptcha::Helper
+  include Ambethia::ReCaptcha::Controller
+
+  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,88 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'net/http'
+require File.dirname(__FILE__) + '/../lib/recaptcha'
+
+class VerifyReCaptchaTest < 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://#{Ambethia::ReCaptcha::RECAPTCHA_VERIFY_SERVER}/verify")
+  end
+  
+  def test_should_raise_exception_without_private_key
+    assert_raise Ambethia::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_to_base).with("Captcha response is incorrect, please try again.")
+    
+    model = mock
+    model.expects(:valid?)
+    model.expects(:errors).returns(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
+  
+  private
+  
+  class TestController
+    include Ambethia::ReCaptcha::Controller    
+    attr_accessor :request, :params, :session
+    
+    def initialize
+      @session = {}
+    end
+  end
+  
+  def expect_http_post(response)
+    Net::HTTP.expects(:post_form).with(@expected_uri, @expected_post_data).returns(response)
+  end
+  
+  def response_with_body(body)
+    stub(:body => body)
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: mwhuss-recaptcha
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason L. Perry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-08 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: This plugin adds helpers for the ReCAPTCHA API
+email: jasper@ambethia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/recaptcha/recaptcha.rb
+- lib/recaptcha.rb
+- LICENSE
+- README.rdoc
+- tasks/recaptcha_tasks.rake
+files: 
+- CHANGELOG
+- init.rb
+- lib/recaptcha/recaptcha.rb
+- lib/recaptcha.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README.rdoc
+- tasks/recaptcha_tasks.rake
+- test/recaptcha_test.rb
+- test/verify_recaptcha_test.rb
+- recaptcha.gemspec
+has_rdoc: true
+homepage: http://github.com/ambethia/recaptcha/tree/master
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Recaptcha
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: recaptcha
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This plugin adds helpers for the ReCAPTCHA API
+test_files: 
+- test/recaptcha_test.rb
+- test/verify_recaptcha_test.rb