rack-recaptcha 0.2.2 → 0.3.0

data/README.md

@@ -1,4 +1,4 @@
-# rack-recaptcha
+# rack-recaptcha [![](http://stillmaintained.com/achiu/rack-recaptcha.png)](http://stillmaintained.com/achiu/rack-recaptcha)
 
 Drop this Rack middleware in your web application to enable CAPTCHA verification via Recaptcha API.
 
@@ -84,7 +84,7 @@ In Padrino, here's how you would use the helpers.
 ### Contributors
 
 - Daniel Mendler(minad) - support for multiple paths and helpers clean up
-
+- Eric Anderson(eric1234) - Make verify independently usable.
 
 
 #### Note on Patches/Pull Requests
@@ -99,4 +99,4 @@ In Padrino, here's how you would use the helpers.
 
 #### Copyright
 
-Copyright (c) 2010 Arthur Chiu. See LICENSE for details.
+Copyright (c) 2011 Arthur Chiu. See LICENSE for details.

data/Rakefile

@@ -1,25 +1,5 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rack-recaptcha"
-    gem.summary = %Q{Rack middleware for Recaptcha}
-    gem.description = %Q{Rack middleware Captcha verification using Recaptcha API.}
-    gem.email = "mr.arthur.chiu@gmail.com"
-    gem.homepage = "http://github.com/achiu/rack-recaptcha"
-    gem.authors = ["Arthur Chiu"]
-    gem.add_runtime_dependency "json", ">=0"
-    gem.add_development_dependency "riot", ">= 0"
-    gem.add_development_dependency "rack-test", ">=0"
-    gem.add_development_dependency "rr", ">=0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -28,29 +8,4 @@ Rake::TestTask.new(:test) do |test|
   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 :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rack-recaptcha #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => [:test]

data/lib/rack/recaptcha.rb

@@ -1,11 +1,10 @@
-require 'json'
-require 'rack/recaptcha/helpers'
+require  File.expand_path '../recaptcha/helpers', __FILE__
 
 module Rack
   class Recaptcha
-    API_URL         = 'http://api.recaptcha.net'
-    API_SECURE_URL  = 'https://api-secure.recaptcha.net'
-    VERIFY_URL      = 'http://api-verify.recaptcha.net/verify'
+    API_URL         = 'http://www.google.com/recaptcha/api'
+    API_SECURE_URL  = 'https://www.google.com/recaptcha/api'
+    VERIFY_URL      = 'http://www.google.com/recaptcha/api/verify'
     CHALLENGE_FIELD = 'recaptcha_challenge_field'
     RESPONSE_FIELD  = 'recaptcha_response_field'
 
@@ -13,6 +12,10 @@ module Rack
       attr_accessor :private_key, :public_key
     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)*
+    #   :paths       -- where user goes to login or access the recaptcha (array of paths or single path)
     def initialize(app,options = {})
       @app = app
       @paths = options[:paths] && [options[:paths]].flatten.compact
@@ -28,18 +31,22 @@ module Rack
       request = Request.new(env)
       if request.params[CHALLENGE_FIELD] and
         request.params[RESPONSE_FIELD] and (not @paths or @paths.include?(request.path))
-        value, msg = verify(request)
+        value, msg = verify(
+          request.ip,
+          request.params[CHALLENGE_FIELD],
+          request.params[RESPONSE_FIELD]
+        )
         env.merge!('recaptcha.valid' => value == 'true', 'recaptcha.msg' => msg)
       end
       @app.call(env)
     end
 
-    def verify(request)
+    def verify(ip, challenge, response)
       params = {
         'privatekey' => Rack::Recaptcha.private_key,
-        'remoteip' => request.ip,
-        'challenge' => request.params[CHALLENGE_FIELD],
-        'response' =>  request.params[RESPONSE_FIELD]
+        'remoteip'   => ip,
+        'challenge'  => challenge,
+        'response'   => response
       }
       response = Net::HTTP.post_form URI.parse(VERIFY_URL), params
       response.body.split("\n")

data/lib/rack/recaptcha/helpers.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Rack
   class Recaptcha
     module Helpers
@@ -9,6 +11,24 @@ module Rack
         :cols => 5
       }
 
+      # Helper method to output a recaptcha form. Some of the available
+      # types you can have are:
+      #
+      # :challenge - Returns a javascript recaptcha form
+      # :noscript  - Return a non-javascript recaptcha form
+      # :ajax      - Return a ajax recaptcha form
+      #
+      # You also have a few available options:
+      #
+      # For :ajax:
+      #  :display    - You can adjust the display of the ajax form. An example:
+      #                recaptcha_tag :ajax, :display => {:theme => 'red'}.
+      # For :challenge and :noscript
+      #  :public_key - Set the public key. Overrides the key set in Middleware option
+      #  :height     - Adjust the height of the form
+      #  :width      - Adjust the width of the form
+      #  :row        - Adjust the rows for the challenge field
+      #  :cols       - Adjust the column for the challenge field
       def recaptcha_tag(type= :noscript, options={})
         options = DEFAULT.merge(options)
         options[:public_key] ||= Rack::Recaptcha.public_key
@@ -41,6 +61,7 @@ module Rack
         end + html
       end
 
+      # Helper to return whether the recaptcha was accepted.
       def recaptcha_valid?
         request.env['recaptcha.valid']
       end

data/rack-recaptcha.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{rack-recaptcha}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
   s.required_rubygems_version = ">=1.3.6"
   s.authors = ["Arthur Chiu"]
   s.date = %q{2010-07-18}
@@ -14,8 +14,9 @@ Gem::Specification.new do |s|
   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("riot", [">= 0"])
-  s.add_development_dependency("rack-test", [">= 0"])
-  s.add_development_dependency("rr", [">= 0"])
+  s.add_runtime_dependency "json", ">= 0"
+  s.add_development_dependency "riot",      "~> 0.12.1"
+  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

@@ -1,6 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__),'teststrap'))
-require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack','recaptcha','helpers'))
-require 'riot/rr'
+require File.expand_path '../teststrap', __FILE__
 
 class HelperTest
   attr_accessor :request
@@ -16,51 +14,60 @@ class HelperTest
 end
 
 context "Rack::Recaptcha::Helpers" do
-  setup do
-    Rack::Recaptcha.public_key = '0'*40
-    @helper = HelperTest.new
-  end
+  setup { Rack::Recaptcha.public_key = '0'*40 }
+
+  helper(:helper_test) { HelperTest.new }
 
 
   context "recaptcha_tag" do
 
     context "ajax" do
       context "with display" do
-        setup { @helper.recaptcha_tag(:ajax,:display => {:theme => 'red'}) }
-        asserts("has js") { topic }.matches %r{recaptcha_ajax.js}
-        asserts("has div") { topic }.matches %r{<div id="ajax_recaptcha"></div>}
-        asserts("has display") { topic }.matches %r{RecaptchaOptions}
-        asserts("has red theme") { topic }.matches %r{"theme":"red"}
+        setup { helper_test.recaptcha_tag(:ajax,:display => {:theme => 'red'}) }
+
+        asserts_topic('has js').matches %r{recaptcha_ajax.js}
+        asserts_topic('has div').matches %r{<div id="ajax_recaptcha"></div>}
+        asserts_topic('has display').matches %r{RecaptchaOptions}
+        asserts_topic('has theme').matches %r{"theme":"red"}
       end
       context "without display" do
-        setup { @helper.recaptcha_tag(:ajax) }
-        asserts("has js") { topic }.matches %r{recaptcha_ajax.js}
-        asserts("has div") { topic }.matches %r{<div id="ajax_recaptcha"></div>}
-        asserts("has display") { topic =~ %r{RecaptchaOptions} }.not!
-        asserts("has red theme") { topic =~ %r{"theme":"red"} }.not!
+        setup { helper_test.recaptcha_tag(:ajax) }
+
+        asserts_topic('has js').matches %r{recaptcha_ajax.js}
+        asserts_topic('has div').matches %r{<div id="ajax_recaptcha"></div>}
+        denies_topic('has display').matches %r{RecaptchaOptions}
+        denies_topic('has theme').matches %r{"theme":"red"}
       end
     end
 
     context "noscript" do
-      setup { @helper.recaptcha_tag :noscript, :public_key => "hello_world_world" }
-      asserts("iframe") { topic }.matches %r{iframe}
-      asserts("no script tag") { topic }.matches %r{<noscript>}
-      asserts("public key") { topic }.matches %r{hello_world_world}
-      asserts("has js") { topic =~ %r{recaptcha_ajax.js} }.not!
+      setup { helper_test.recaptcha_tag :noscript, :public_key => "hello_world_world" }
+
+      asserts_topic("iframe").matches %r{iframe}
+      asserts_topic("no script tag").matches %r{<noscript>}
+      asserts_topic("public key").matches %r{hello_world_world}
+      denies_topic("has js").matches %r{recaptcha_ajax.js}
     end
 
     context "challenge" do
-      setup { @helper.recaptcha_tag(:challenge) }
-      asserts("has script tag") { topic }.matches %r{script}
-      asserts("has challenge js") { topic }.matches %r{challenge}
-      asserts("has js") { topic =~ %r{recaptcha_ajax.js} }.not!
-      asserts("has display") { topic =~ %r{RecaptchaOptions} }.not!
-      asserts("has public_key") { topic }.matches %r{#{'0'*40}}
+      setup { helper_test.recaptcha_tag(:challenge) }
+
+      asserts_topic("has script tag").matches %r{script}
+      asserts_topic("has challenge js").matches %r{challenge}
+      denies_topic("has js").matches %r{recaptcha_ajax.js}
+      denies_topic("has display").matches %r{RecaptchaOptions}
+      asserts_topic("has public_key").matches %r{#{'0'*40}}
     end
 
     context "server" do
-      asserts("using ssl url") { @helper.recaptcha_tag(:challenge, :ssl => true) }.matches %r{https://api-secure.recaptcha.net}
-      asserts("using non ssl url") { @helper.recaptcha_tag(:ajax) }.matches %r{http://api.recaptcha.net}
+
+      asserts("using ssl url") do
+        helper_test.recaptcha_tag(:challenge, :ssl => true)
+      end.matches %r{#{Rack::Recaptcha::API_SECURE_URL}}
+
+      asserts("using non ssl url") do
+        helper_test.recaptcha_tag(:ajax)
+      end.matches %r{#{Rack::Recaptcha::API_URL}}
     end
 
   end
@@ -69,18 +76,18 @@ context "Rack::Recaptcha::Helpers" do
     
     context "passing" do
       setup do
-        mock(@helper.request.env).[]('recaptcha.valid').returns(true)
-        @helper.recaptcha_valid?
+        mock(helper_test.request.env).[]('recaptcha.valid').returns(true)
       end
-      asserts_topic
+
+      asserts("retrieves request") { helper_test.recaptcha_valid? }
     end
 
     context "failing" do
       setup do
-        mock(@helper.request.env).[]('recaptcha.valid').returns(false)
-        @helper.recaptcha_valid?
+        mock(helper_test.request.env).[]('recaptcha.valid').returns(false)
       end
-      asserts_topic.not!
+
+      denies("that it retrieves request") { helper_test.recaptcha_valid? }
     end
 
   end

data/test/recaptcha_test.rb

@@ -1,19 +1,20 @@
-require File.expand_path(File.join(File.dirname(__FILE__),'teststrap'))
-require 'fakeweb'
+require File.expand_path '../teststrap', __FILE__
 
 FakeWeb.allow_net_connect = false
 context "Rack::Recaptcha" do
 
   context "basic request" do
-    setup { get("/")}
-    asserts("status is 200") { last_response.status }.equals 200
-    asserts("body is hello world") { last_response.body }.equals 'Hello world'
+    setup { get("/") ; last_response }
+
+    asserts(:status).equals 200
+    asserts(:body).equals "Hello world"
   end
 
   context "exposes" do
     setup { Rack::Recaptcha }
-    asserts("private key") { topic.private_key }.equals PRIVATE_KEY
-    asserts("public key") { topic.public_key }.equals PUBLIC_KEY
+
+    asserts(:private_key).equals PRIVATE_KEY
+    asserts(:public_key).equals PUBLIC_KEY
   end
 
   context "login path" do

data/test/teststrap.rb

@@ -7,7 +7,8 @@ require 'rack/builder'
 require 'rr'
 require 'riot'
 require 'riot/rr'
-require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack','recaptcha'))
+require 'fakeweb'
+require File.expand_path '../../lib/rack/recaptcha', __FILE__
 
 PUBLIC_KEY = '0'*40
 PRIVATE_KEY = 'X'*40
@@ -38,5 +39,12 @@ class Riot::Situation
     builder.run main_app
     builder.to_app
   end
+end
+
+class Riot::Context
 
+  # denies_topic currently on edge. Will remove once its released
+  def denies_topic(what)
+    denies(what) { topic }
+  end
 end

metadata

@@ -2,12 +2,12 @@
 name: rack-recaptcha
 version: !ruby/object:Gem::Version 
   hash: 19
-  prerelease: false
+  prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Arthur Chiu
@@ -38,12 +38,14 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 45
         segments: 
         - 0
-        version: "0"
+        - 12
+        - 1
+        version: 0.12.1
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -52,28 +54,48 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
         - 0
-        version: "0"
+        - 5
+        - 7
+        version: 0.5.7
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rr
+  name: fakeweb
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
+        - 1
+        - 3
         - 0
-        version: "0"
+        version: 1.3.0
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :development
+  version_requirements: *id005
 description: Rack middleware Captcha verification using Recaptcha API.
 email: mr.arthur.chiu@gmail.com
 executables: []
@@ -127,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Rack middleware for Recaptcha