rack-recaptcha2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe4b7b672ad738889bca4ded27940d615d43631d
+  data.tar.gz: 9ec20d4976ccc435823dfc803c7543e808a49a96
+SHA512:
+  metadata.gz: debec378c1bdbb90e1ca672611b8bd1edcf75a4132376d40d08c04a3df6a957eaafb09914e3b90dcc413452ae0e0492f13ff6854289f2d932eb66244479f1d21
+  data.tar.gz: c1eeee981b98b8953fe907acc66c45273dd6a1901b640d728b8919029ab528e3b634b6aa6f01866c22bcd33a979ec84b2d54bacb714abda46d9d545dd7ea52e0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.rvmrc
+.rbx/
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Arthur Chiu
+
+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.md

@@ -0,0 +1,211 @@
+# rack-recaptcha [![](http://stillmaintained.com/achiu/rack-recaptcha.png)](http://stillmaintained.com/achiu/rack-recaptcha)
+
+[![Build Status](https://secure.travis-ci.org/achiu/rack-recaptcha.png)](http://travis-ci.org/achiu/rack-recaptcha)
+
+Drop this Rack middleware in your web application to enable CAPTCHA verification via Recaptcha API.
+
+## How to Use
+
+### Configuration
+
+First, install the library with:
+    [sudo] gem install rack-recaptcha
+
+You have to require 'rack-recaptcha' in your gemfile.
+
+````ruby
+## Gemfile
+gem 'rack-recaptcha', :require => 'rack/recaptcha'
+````
+
+
+    Available options for `Rack::Recaptcha` middleware are:
+
+    * :public_key -- your ReCaptcha API public key *(required)*
+    * :private_key -- your ReCaptcha API private key *(required)*
+    * :proxy_host -- the HTTP Proxy hostname *(optional)*
+    * :proxy_port -- the HTTP Proxy port *(optional)*
+    * :proxy_user -- the HTTP Proxy user *(optional, omit unless the proxy requires it)*
+    * :proxy_password -- the HTTP Proxy password *(optional, omit unless the proxy requires it)*
+
+Now configure your app to use the middleware. This might be different across each web framework.
+
+#### Sinatra
+
+````ruby
+## app.rb
+use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
+helpers Rack::Recaptcha::Helpers
+````
+
+#### Padrino
+
+````ruby
+## app/app.rb
+use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
+helpers Rack::Recaptcha::Helpers
+````
+
+
+#### Rails
+
+````ruby
+## application.rb:
+module YourRailsAppName
+  class Application < Rails::Application
+    ...
+    config.gem 'rack-recaptcha', :lib => 'rack/recaptcha'
+    config.middleware.use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
+  end
+end
+
+## application_helper.rb or whatever helper you want it in.
+module ApplicationHelper
+  include Rack::Recaptcha::Helpers
+end
+
+## application_controller.rb or whatever controller you want it in.
+class ApplicationController < ActionController::Base
+  ...
+  include Rack::Recaptcha::Helpers
+  ...
+end
+````
+
+### Helpers
+
+The `Rack::Recaptcha::Helpers` module (for Sinatra, Rails, Padrino) adds these methods to your app:
+
+Return a javascript recaptcha form
+```ruby
+  recaptcha_tag :challenge
+```
+
+Return a non-javascript recaptcha form
+```ruby
+  recaptcha_tag :noscript
+```
+
+Return a ajax recaptcha form
+```ruby
+  recaptcha_tag :ajax
+```
+
+For ajax recaptcha's, you can pass additional options like:
+```ruby
+  recaptcha_tag :ajax, :display => { :theme => 'red'}
+```
+
+For non-ajax recaptcha's, you can pass additional options like:
+```ruby
+  # Overrides the key set in Middleware
+  recaptcha_tag :challenge, :public_key => KEY
+
+  # Adjust Height and/or Width
+  recaptcha_tag :noscript, :height => 300, :width => 500
+
+  # Adjust the rows and/or columns
+  recaptcha_tag :challenge, :row => 3, :cols => 5
+
+  # Set the language
+  recaptcha_tag :noscript, :language => :en
+```
+
+To test whether or not the verification passed, you can use:
+
+```ruby
+  recaptcha_valid?
+```
+
+The `recaptcha_valid?` helper can also be overloaded during tests. You
+can set its response to either true or false by doing the following:
+
+```ruby
+ # Have recaptcha_valid? return true
+ Rack::Recaptcha.test_mode!
+
+ # Or have it return false
+ Rack::Recaptcha.test_mode! :return => false
+```
+
+
+For additional options and resources checkout the [customization page](https://developers.google.com/recaptcha/docs/customization)
+
+#### Example
+
+In Padrino, here's how you would use the helpers.
+
+````haml
+## new.haml
+- form_tag '/login', :class => 'some_form', :method => 'post' do
+  = text_field_tag :email
+  = password_field_tag :password
+  = recaptcha_tag(:challenge)
+  = submit_tag "Submit"
+
+## sessions.rb
+post :create, :map => '/login' do
+  if recaptcha_valid?
+    "passed!"
+    else
+    "failed!"
+  end
+end
+````
+
+In rails, you'll need to use also use the raw method:
+
+````haml
+## new.html.haml
+- form_tag '/login' do
+  = raw recaptcha_tag(:challenge)
+  = submit_tag "Submit"
+````
+
+### Contributors
+
+Daniel Mendler - [minad](https://github.com/minad)
+
+  * support for multiple paths and helpers clean up
+
+Eric Anderson - [eric1234](https://github.com/eric1234)
+
+  * Make verify independently usable.
+
+Chad Johnston - [iamthechad](https://github.com/iamthechad)
+
+  * Adding Error Message handling in recaptcha widget
+
+Eric Hu - [eric-hu](https://github.com/eric-hu)
+
+  * Patching error message issue when no `request` is present
+
+Tobias Begalke - [elcamino](https://github.com/elcamino)
+
+  * Added HTTP Proxy support
+
+Julik Tarkhanov - [julik](https://github.com/julik)
+
+  * Adding rack-recaptcha to travis-ci
+
+Rob Worley - [robworley](https://github.com/robworley)
+  
+  * Adding language setting for recaptcha form
+
+sam71 - [sam71](https://github.com/sam71)
+
+  * Fix recaptcha hanging when used in proxy environment.
+
+#### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+#### Copyright
+
+Copyright (c) 2010, 2011, 2012 Arthur Chiu. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.warning = true
+  test.verbose = true
+end
+
+task :default => [:test]

data/lib/rack/recaptcha.rb

@@ -0,0 +1,82 @@
+require  File.expand_path '../recaptcha/helpers', __FILE__
+require 'net/http'
+require 'json'
+
+module Rack
+  class Recaptcha
+    API_URL         = 'http://www.google.com/recaptcha/api.js'
+    API_SECURE_URL  = 'https://www.google.com/recaptcha/api.js'
+    VERIFY_URL      = 'https://www.google.com/recaptcha/api/siteverify'
+    RESPONSE_FIELD  = 'g-recaptcha-response'
+
+    class << self
+      attr_accessor :private_key, :public_key, :test_mode, :proxy_host, :proxy_port, :proxy_user, :proxy_password
+
+      def test_mode!(options = {})
+        value = options[:return]
+        self.test_mode = value.nil? ? true : options[:return]
+      end
+    end
+
+    # Initialize the Rack Middleware. Some of the available options are:
+    #   :public_key  -- your ReCaptcha API public key *(required)*
+    #   :private_key -- your ReCaptcha API private key *(required)*
+    #
+    def initialize(app,options = {})
+      @app = app
+      @paths = options[:paths] && [options[:paths]].flatten.compact
+      self.class.private_key = options[:private_key]
+      self.class.public_key = options[:public_key]
+      self.class.proxy_host = options[:proxy_host]
+      self.class.proxy_port = options[:proxy_port]
+      self.class.proxy_user = options[:proxy_user]
+      self.class.proxy_password = options[:proxy_password]
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      request = Request.new(env)
+      if request.params[RESPONSE_FIELD]
+        value, msg = verify(
+          request.ip,
+          request.params[RESPONSE_FIELD]
+        )
+        env.merge!('recaptcha.valid' => value, 'recaptcha.msg' => msg)
+      end
+      @app.call(env)
+    end
+
+    def verify(ip, response)
+      params = {
+        'secret' => Rack::Recaptcha.private_key,
+        'remoteip'   => ip,
+        'response'   => response
+      }
+
+      uri  = URI.parse(VERIFY_URL)
+
+
+      if self.class.proxy_host && self.class.proxy_port
+        http = Net::HTTP.Proxy(self.class.proxy_host,
+                               self.class.proxy_port,
+                               self.class.proxy_user,
+                               self.class.proxy_password).start(uri.host, uri.port, :use_ssl => true)
+      else
+        http = Net::HTTP.start(uri.host, uri.port, :use_ssl => true)
+      end
+
+      request           = Net::HTTP::Post.new(uri.path)
+      request.form_data = params
+      response          = http.request(request)
+
+      parsed_response = JSON.parse(response.body)
+      success = parsed_response['success']
+      error_messages = parsed_response['error-codes'] || []
+      return [success, error_messages.join(',')]
+    end
+
+  end
+end

data/lib/rack/recaptcha/helpers.rb

@@ -0,0 +1,48 @@
+require 'json'
+
+module Rack
+  class Recaptcha
+    module Helpers
+
+      DEFAULT= {
+        :ssl => true
+      }
+
+      # Helper method to output a recaptcha widget.
+      # Available options:
+      #
+      #  :public_key - Set the public key. Overrides the key set in Middleware option
+      def recaptcha_widget(options={})
+        options = DEFAULT.merge(options)
+        options[:public_key] ||= Rack::Recaptcha.public_key
+
+        %{<div class="g-recaptcha" data-sitekey="#{options[:public_key]}"></div>}.gsub(/^ +/, '')
+      end
+
+      # Helper method to output the recaptcha javascript.
+      # Available options:
+      #
+      #  :language   - Set the language
+      def recaptcha_javascript(options={})
+        options = DEFAULT.merge(options)
+        path = options[:ssl] ? Rack::Recaptcha::API_SECURE_URL : Rack::Recaptcha::API_URL
+        params = ''
+        params += "?hl=" + uri_parser.escape(options[:language].to_s) if options[:language]
+        %{<script src='#{path + params}'></script>}
+      end
+
+      # Helper to return whether the recaptcha was accepted.
+      def recaptcha_valid?
+        test = Rack::Recaptcha.test_mode
+        test.nil? ? request.env['recaptcha.valid'] : test
+      end
+
+      private
+
+      def uri_parser
+        @uri_parser ||= URI.const_defined?(:Parser) ? URI::Parser.new : URI
+      end
+
+    end
+  end
+end

data/rack-recaptcha.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = %q{rack-recaptcha2}
+  s.version = "1.0.0"
+  s.required_rubygems_version = ">=1.3.6"
+  s.authors = ["Arthur Chiu"]
+  s.date = %q{2010-07-18}
+  s.description = %q{Rack middleware Captcha verification using Recaptcha API.}
+  s.email = %q{mr.arthur.chiu@gmail.com}
+  s.extra_rdoc_files = ["LICENSE", "README.md"]
+  s.files = %w{.document .gitignore LICENSE README.md Rakefile rack-recaptcha.gemspec} + Dir.glob("{lib,test}/**/*")
+  s.homepage = %q{http://github.com/achiu/rack-recaptcha}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rack middleware for Recaptcha}
+  s.test_files = Dir.glob("test/**/*")
+  s.add_runtime_dependency "json", ">= 0"
+  s.add_development_dependency "rake",      "~> 0.9.2"
+  s.add_development_dependency "minitest",  "~> 4.6"
+  s.add_development_dependency "rack-test", "~> 0.5.7"
+  s.add_development_dependency "fakeweb",   "~> 1.3.0"
+  s.add_development_dependency "rr",        "~> 1.0.2"
+end

data/test/helpers_test.rb

@@ -0,0 +1,92 @@
+require File.expand_path '../test_helper', __FILE__
+
+class HelperTest
+  attr_accessor :request
+  include Rack::Recaptcha::Helpers
+
+  def initialize
+    @request = HelperTest::Request.new
+  end
+
+  class Request
+    attr_accessor :env
+  end
+end
+
+# With "attr_accessor :request" HelperTest has "request" defined as a method
+# even when @request is set to nil
+#
+# defined?(request)
+# => method
+# request
+# => nil
+# self
+# => #<HelperTest:0x00000002125000 @request=nil>
+class HelperTestWithoutRequest
+  include Rack::Recaptcha::Helpers
+end
+
+describe Rack::Recaptcha::Helpers do
+
+  def helper_test
+    HelperTest.new
+  end
+
+  def helper_test_without_request
+    HelperTestWithoutRequest.new
+  end
+
+  before do
+    Rack::Recaptcha.public_key = ::PUBLIC_KEY
+  end
+
+  describe ".recaptcha_widget" do
+
+    it "should render recaptcha div" do
+      topic = helper_test.recaptcha_widget()
+
+      assert_match %r{<div class="g-recaptcha" data-sitekey=".*"></div>}, topic
+    end
+
+    it "should use given public key" do
+      topic = helper_test.recaptcha_widget(:public_key => 'test')
+
+      assert_match %r{<div class="g-recaptcha" data-sitekey="test"></div>}, topic
+    end
+  end
+
+  describe ".recaptcha_valid?" do
+    it "should assert that it passes when recaptcha.valid is true" do
+      Rack::Recaptcha.test_mode = nil
+      mock(helper_test.request.env).[]('recaptcha.valid').returns(true)
+      assert helper_test.recaptcha_valid?
+    end
+
+    it "should refute that it passes when recaptcha.valid is false" do
+      Rack::Recaptcha.test_mode = nil
+      mock(helper_test.request.env).[]('recaptcha.valid').returns(false)
+      refute helper_test.recaptcha_valid?
+    end
+
+    it "should assert that it passes when test mode set to pass" do
+      Rack::Recaptcha.test_mode!
+      assert helper_test.recaptcha_valid?
+    end
+
+    it "should assert that it passes when test mode set to fail" do
+      Rack::Recaptcha.test_mode! :return => false
+      refute helper_test.recaptcha_valid?
+    end
+  end
+
+  describe ".recaptcha_widget without request object" do
+
+    it "should work without request object" do
+      topic = helper_test_without_request.recaptcha_widget()
+
+      assert_match %r{<div class="g-recaptcha" data-sitekey=".*"></div>},            topic
+    end
+
+  end
+
+end

data/test/recaptcha_test.rb

@@ -0,0 +1,31 @@
+require File.expand_path '../test_helper', __FILE__
+
+describe Rack::Recaptcha do
+  before do
+    FakeWeb.allow_net_connect = false
+  end
+
+  describe "#test_mode!" do
+    it "should set test_mode to true" do
+      Rack::Recaptcha.test_mode!
+      assert Rack::Recaptcha.test_mode
+    end
+
+    it "should set test_mode to true" do
+      Rack::Recaptcha.test_mode! :return => false
+      refute Rack::Recaptcha.test_mode
+    end
+  end
+
+  it "should hit the login and pass" do
+    FakeWeb.register_uri(:post, Rack::Recaptcha::VERIFY_URL, :body => '{"success":true}')
+    post("/login", 'g-recaptcha-response' => 'response')
+    assert_equal 'post login', last_response.body
+  end
+
+  it "should hit the login and fail" do
+    FakeWeb.register_uri(:post, Rack::Recaptcha::VERIFY_URL, :body => '{"success":false,"error-codes":["invalid-input-response"]}')
+    post("/login", 'g-recaptcha-response' => 'response')
+    assert_equal 'post fail', last_response.body
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+gem 'minitest'
+require 'minitest/autorun'
+require 'rack/test'
+require 'rack/mock'
+require 'rack/utils'
+require 'rack/session/cookie'
+require 'rack/builder'
+require 'fakeweb'
+require 'rr'
+require File.expand_path '../../lib/rack/recaptcha', __FILE__
+
+PUBLIC_KEY  = '0'*40
+PRIVATE_KEY = 'X'*40
+
+class MiniTest::Spec
+  include Rack::Test::Methods
+  include RR::Adapters::MiniTest
+
+  def app
+    main_app = lambda { |env|
+      request = Rack::Request.new(env)
+      return_code, body_text =
+      case request.path
+      when '/' then [200,'Hello world']
+      when '/login'
+        if request.post?
+          env['recaptcha.valid'] ? [200, 'post login'] : [200, 'post fail']
+        else
+          [200,'login']
+        end
+      else
+        [404,'Nothing here']
+      end
+      [return_code,{'Content-type' => 'text/plain'}, [body_text]]
+    }
+
+    builder = Rack::Builder.new
+    builder.use Rack::Recaptcha, :private_key => PRIVATE_KEY, :public_key => PUBLIC_KEY
+    builder.run main_app
+    builder.to_app
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rack-recaptcha2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: Rack middleware Captcha verification using Recaptcha API.
+email: mr.arthur.chiu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- rack-recaptcha.gemspec
+- lib/rack/recaptcha.rb
+- lib/rack/recaptcha/helpers.rb
+- test/helpers_test.rb
+- test/test_helper.rb
+- test/recaptcha_test.rb
+homepage: http://github.com/achiu/rack-recaptcha
+licenses: []
+metadata: {}
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rack middleware for Recaptcha
+test_files:
+- test/helpers_test.rb
+- test/test_helper.rb
+- test/recaptcha_test.rb