rack-recaptcha 0.1.1 → 0.2.0

data/README.md

@@ -19,27 +19,28 @@ You have to require 'rack-recaptcha' in your gemfile.
 
     * :public_key -- your ReCaptcha API public key *(required)*
     * :private_key -- your ReCaptcha API private key *(required)*
-    * :login_path -- where user goes to login or access the recaptcha   
+    * :paths -- where user goes to login or access the recaptcha (array of paths or single path)
 
 
 Now configure your app to use the middleware. This might be different across each web framework.
 
 #### Sinatra
-
-    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :login_path => 'PATH'
+   ## app.rb
+    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :paths => 'PATH'
     helpers Rack::Recaptcha::Helpers
 
 #### Padrino
 
     ## app/app.rb
-    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :login_path => 'PATH'
+    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :paths => 'PATH'
     helpers Rack::Recaptcha::Helpers
 
 
 #### Rails
 
     ## environment.rb:
-    config.middleware.use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :login_path => 'PATH'
+    config.gem 'rack-recaptcha', :lib => 'rack/recaptcha'
+    config.middleware.use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :paths => 'PATH'
 
     ## application_controller.rb
     include Rack::Recaptcha::Helpers
@@ -57,7 +58,7 @@ The `Rack::Recaptcha::Helpers` module (for Sinatra, Rails, Padrino) adds these m
   - you can also pass in :public\_key manually as well.
     - recaptcha\_tag(:challenge,:public\_key => 'PUBLIC')
 
-* `verified?` -- returns whether or not the verification passed.
+* `recaptcha_valid?` -- returns whether or not the verification passed.
 
 #### Example
 
@@ -72,7 +73,7 @@ In Padrino, here's how you would use the helpers.
       
     ## sessions.rb
     post :create, :map => '/login' do
-      if verified?
+      if recaptcha_valid?
         "passed!"
         else
         "failed!"
@@ -80,7 +81,13 @@ In Padrino, here's how you would use the helpers.
     end
 
 
-== Note on Patches/Pull Requests
+#### Contributors
+
+- Daniel Mendler(minad) - support for multiple paths and helpers clean up
+
+
+
+#### Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -90,6 +97,6 @@ In Padrino, here's how you would use the helpers.
   (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
 
 Copyright (c) 2010 Arthur Chiu. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/rack/recaptcha.rb

@@ -1,43 +1,45 @@
 require 'json'
-
-RECAPTCHA_API_URL        = 'http://api.recaptcha.net'
-RECAPTCHA_API_SECURE_URL = 'https://api-secure.recaptcha.net'
-RECAPTCHA_VERIFY_URL     = 'http://api-verify.recaptcha.net/verify'
-
-require File.expand_path(File.join(File.dirname(__FILE__),'recaptcha','helpers'))
+require 'rack/recaptcha/helpers'
 
 module Rack
   class Recaptcha
-    attr_reader :options
+    API_URL         = 'http://api.recaptcha.net'
+    API_SECURE_URL  = 'https://api-secure.recaptcha.net'
+    VERIFY_URL      = 'http://api-verify.recaptcha.net/verify'
+    CHALLENGE_FIELD = 'recaptcha_challenge_field'
+    RESPONSE_FIELD  = 'recaptcha_response_field'
+
     class << self
       attr_accessor :private_key, :public_key
     end
 
     def initialize(app,options = {})
-      @app, @options = 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]
     end
 
     def call(env)
       request = Request.new(env)
-      if request.post? and request.path == @options[:login_path]
+      if request.params[CHALLENGE_FIELD] and
+        request.params[RESPONSE_FIELD] and (not @paths or @paths.include?(request.path))
         value, msg = verify(request)
-        env.merge!('recaptcha.value' => value, 'recaptcha.msg' => msg)
+        env.merge!('recaptcha.valid' => value == 'true', 'recaptcha.msg' => msg)
       end
       @app.call(env)
     end
 
     def verify(request)
       params = {
-        :privatekey => Rack::Recaptcha.private_key,
-        :remoteip => request.ip,
-        :challenge => request.params['recaptcha_challenge_field'],
-        :response =>  request.params['recaptcha_response_field']
+        'privatekey' => Rack::Recaptcha.private_key,
+        'remoteip' => request.ip,
+        'challenge' => request.params[CHALLENGE_FIELD],
+        'response' =>  request.params[RESPONSE_FIELD]
       }
-      response = Net::HTTP.post_form URI.parse(RECAPTCHA_VERIFY_URL), params
+      response = Net::HTTP.post_form URI.parse(VERIFY_URL), params
       response.body.split("\n")
     end
 
   end
-end
+end

data/lib/rack/recaptcha/helpers.rb

@@ -9,49 +9,40 @@ module Rack
         :cols => 5
       }
 
-
       def recaptcha_tag(type= :noscript, options={})
         options = DEFAULT.merge(options)
         options[:public_key] ||= Rack::Recaptcha.public_key
-        path = options[:ssl] ? RECAPTCHA_API_SECURE_URL : RECAPTCHA_API_URL
+        path = options[:ssl] ? Rack::Recaptcha::API_SECURE_URL : Rack::Recaptcha::API_URL
         html = case type.to_sym
         when :challenge
-          (<<-CHALLENGE).gsub(/^ #{10}/,'')
-          <script type="text/javascript" src="#{path}/challenge?k=#{options[:public_key]}">
-          </script>
-          CHALLENGE
+          %{<script type="text/javascript" src="#{path}/challenge?k=#{options[:public_key]}">
+            </script>}.gsub(/^ +/, '')
         when :noscript
-          (<<-NOSCRIPT).gsub(/^ #{10}/,'')
-          <noscript>
-          <iframe src="#{path}/noscript?k=#{options[:public_key]}" height="#{options[:height]}" width="#{options[:width]}" frameborder="0"></iframe><br>
-          <textarea name="recaptcha_challenge_field" rows="#{options[:row]}" cols="#{options[:cols]}"></textarea>
-          <input type="hidden" name="recaptcha_response_field" value="manual_challenge">
-          </noscript>
-          NOSCRIPT
+          %{<noscript>
+            <iframe src="#{path}/noscript?k=#{options[:public_key]}" height="#{options[:height]}" width="#{options[:width]}" frameborder="0"></iframe><br>
+            <textarea name="recaptcha_challenge_field" rows="#{options[:row]}" cols="#{options[:cols]}"></textarea>
+            <input type="hidden" name="recaptcha_response_field" value="manual_challenge">
+            </noscript>}.gsub(/^ +/, '')
         when :ajax
-          (<<-AJAX).gsub(/^ #{10}/,'')
-          <div id="ajax_recaptcha"></div>
-          <script type="text/javascript" src="#{path}/js/recaptcha_ajax.js"></script>
-          <script type="text/javascript">
-          Recaptcha.create('#{options[:public_key]}', document.getElementById('ajax_recaptcha')#{options[:display] ? ',RecaptchaOptions' : ''});
-          </script>
-          AJAX
+          %{<div id="ajax_recaptcha"></div>
+            <script type="text/javascript" src="#{path}/js/recaptcha_ajax.js"></script>
+            <script type="text/javascript">
+            Recaptcha.create('#{options[:public_key]}', document.getElementById('ajax_recaptcha')#{options[:display] ? ',RecaptchaOptions' : ''});
+            </script>}.gsub(/^ +/, '')
         else
-          ""
+          ''
         end
         if options[:display]
-          (<<-DISPLAY).gsub(/^ #{10}/,'')
-          <script type="text/javascript">
-          var RecaptchaOptions = #{options[:display].to_json};
-          </script>
-          DISPLAY
+          %{<script type="text/javascript">
+            var RecaptchaOptions = #{options[:display].to_json};
+            </script>}.gsub(/^ +/, '')
         else
-          ""
+          ''
         end + html
       end
 
-      def verified?
-        env['recaptcha.value'] == 'true'
+      def recaptcha_valid?
+        env['recaptcha.valid']
       end
 
     end

data/rack-recaptcha.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-recaptcha}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Arthur Chiu"]
-  s.date = %q{2010-04-22}
+  s.date = %q{2010-05-19}
   s.description = %q{Rack middleware Captcha verification using Recaptcha API.}
   s.email = %q{mr.arthur.chiu@gmail.com}
   s.extra_rdoc_files = [
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   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.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Rack middleware for Recaptcha}
   s.test_files = [
     "test/helpers_test.rb",
@@ -46,7 +46,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<riot>, [">= 0"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])

data/test/helpers_test.rb

@@ -2,7 +2,7 @@ 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'
 
-class Helper
+class HelperTest
   attr_accessor :env
   include Rack::Recaptcha::Helpers
 end
@@ -10,7 +10,7 @@ end
 context "Rack::Recaptcha::Helpers" do
   setup do
     Rack::Recaptcha.public_key = '0'*40
-    @helper = Helper.new
+    @helper = HelperTest.new
   end
 
 
@@ -57,20 +57,20 @@ context "Rack::Recaptcha::Helpers" do
 
   end
 
-  context "verified?" do
+  context "recaptcha_valid?" do
     
     context "passing" do
       setup do
-        mock(@helper.env).[]('recaptcha.value').returns('true')
-        @helper.verified?
+        mock(@helper.env).[]('recaptcha.valid').returns(true)
+        @helper.recaptcha_valid?
       end
       asserts_topic
     end
 
     context "failing" do
       setup do
-        mock(@helper.env).[]('recaptcha.value').returns('false')
-        @helper.verified?
+        mock(@helper.env).[]('recaptcha.valid').returns(false)
+        @helper.recaptcha_valid?
       end
       asserts_topic.not!
     end

data/test/recaptcha_test.rb

@@ -25,16 +25,16 @@ context "Rack::Recaptcha" do
 
     context "post pass" do
       setup do
-        FakeWeb.register_uri(:post, RECAPTCHA_VERIFY_URL, :body => "true\nsuccess")
-        post("/login")
+        FakeWeb.register_uri(:post, Rack::Recaptcha::VERIFY_URL, :body => "true\nsuccess")
+        post("/login", 'recaptcha_challenge_field' => 'challenge', 'recaptcha_response_field' => 'response')
       end
       asserts("post login") { last_response.body }.equals 'post login'
     end
 
     context "post fail" do
       setup do
-        FakeWeb.register_uri(:post, RECAPTCHA_VERIFY_URL, :body => "false\nfailed")
-        post("/login")
+        FakeWeb.register_uri(:post, Rack::Recaptcha::VERIFY_URL, :body => "false\nfailed")
+        post("/login", 'recaptcha_challenge_field' => 'challenge', 'recaptcha_response_field' => 'response')
       end
       asserts("post fail") { last_response.body }.equals 'post fail'
     end

data/test/teststrap.rb

@@ -23,18 +23,18 @@ class Riot::Situation
       when '/' then [200,'Hello world']
       when '/login'
         if request.post?
-          env['recaptcha.value'] == 'true' ? [200, 'post login'] : [200, 'post fail']
+          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]
+      [return_code,{'Content-type' => 'text/plain'}, [body_text]]
     }
 
     builder = Rack::Builder.new
-    builder.use Rack::Recaptcha, :private_key => PRIVATE_KEY, :public_key => PUBLIC_KEY, :login_path => '/login'
+    builder.use Rack::Recaptcha, :private_key => PRIVATE_KEY, :public_key => PUBLIC_KEY, :paths => '/login'
     builder.run main_app
     builder.to_app
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-recaptcha
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Arthur Chiu
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-22 00:00:00 -07:00
+date: 2010-05-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: riot
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: rack-test
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -57,9 +64,11 @@ dependencies:
   name: rr
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -98,23 +107,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rack middleware for Recaptcha