rack-recaptcha 0.5.0 → 0.6.0

data/README.md

@@ -11,10 +11,12 @@ First, install the library with:
 
 You have to require 'rack-recaptcha' in your gemfile.
 
-    ## Gemfile
-    gem 'rack-recaptcha', :require => 'rack/recaptcha'
-    
-    
+````ruby
+## Gemfile
+gem 'rack-recaptcha', :require => 'rack/recaptcha'
+````
+
+
     Available options for `Rack::Recaptcha` middleware are:
 
     * :public_key -- your ReCaptcha API public key *(required)*
@@ -23,35 +25,42 @@ You have to require 'rack-recaptcha' in your gemfile.
 Now configure your app to use the middleware. This might be different across each web framework.
 
 #### Sinatra
-    ## app.rb
-    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
-    helpers Rack::Recaptcha::Helpers
+
+````ruby
+## app.rb
+use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
+helpers Rack::Recaptcha::Helpers
+````
 
 #### Padrino
 
-    ## app/app.rb
-    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
-    helpers Rack::Recaptcha::Helpers
+````ruby
+## app/app.rb
+use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
+helpers Rack::Recaptcha::Helpers
+````
 
 
 #### Rails
 
-    ## application.rb:
-    class Application < Rails::Application
-    # ...
-      config.gem 'rack-recaptcha', :lib => 'rack/recaptcha'
-      config.middleware.use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
-    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.
-    module ApplicationController
-      include Rack::Recaptcha::Helpers
-    end
+````ruby
+## application.rb:
+class Application < Rails::Application
+# ...
+  config.gem 'rack-recaptcha', :lib => 'rack/recaptcha'
+  config.middleware.use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
+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.
+module ApplicationController
+  include Rack::Recaptcha::Helpers
+end
+````
 
 ### Helpers
 
@@ -83,33 +92,46 @@ to have the helper always return false.
 
 In Padrino, here's how you would use the helpers.
 
-    ## 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
+````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:
 
-    ## new.html.haml
-    - form_tag '/login' do
-      = raw recaptcha_tag(:challenge)
-      = submit_tag "Submit"
+````haml
+## new.html.haml
+- form_tag '/login' do
+  = raw recaptcha_tag(:challenge)
+  = submit_tag "Submit"
+````
 
 ### Contributors
 
-- Daniel Mendler(minad) - support for multiple paths and helpers clean up
-- Eric Anderson(eric1234) - Make verify independently usable.
+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
 
 
 #### Note on Patches/Pull Requests

data/lib/rack/recaptcha/helpers.rb

@@ -33,13 +33,16 @@ module Rack
         options = DEFAULT.merge(options)
         options[:public_key] ||= Rack::Recaptcha.public_key
         path = options[:ssl] ? Rack::Recaptcha::API_SECURE_URL : Rack::Recaptcha::API_URL
+        params = "k=#{options[:public_key]}"
+        error_message = request.env['recaptcha.msg']
+        params += "&error=" + URI.encode(error_message) unless error_message.nil?
         html = case type.to_sym
         when :challenge
-          %{<script type="text/javascript" src="#{path}/challenge?k=#{options[:public_key]}">
+          %{<script type="text/javascript" src="#{path}/challenge?#{params}">
             </script>}.gsub(/^ +/, '')
         when :noscript
           %{<noscript>
-            <iframe src="#{path}/noscript?k=#{options[:public_key]}" height="#{options[:height]}" width="#{options[:width]}" frameborder="0"></iframe><br>
+            <iframe src="#{path}/noscript?#{params}" 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(/^ +/, '')

data/rack-recaptcha.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{rack-recaptcha}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
   s.required_rubygems_version = ">=1.3.6"
   s.authors = ["Arthur Chiu"]
   s.date = %q{2010-07-18}

data/test/helpers_test.rb

@@ -14,16 +14,18 @@ class HelperTest
 end
 
 context "Rack::Recaptcha::Helpers" do
-  setup { Rack::Recaptcha.public_key = '0'*40 }
-
   helper(:helper_test) { HelperTest.new }
 
+  setup { Rack::Recaptcha.public_key = '0'*40 }
 
   context "recaptcha_tag" do
 
     context "ajax" do
       context "with display" do
-        setup { helper_test.recaptcha_tag(:ajax,:display => {:theme => 'red'}) }
+        setup do
+          mock(helper_test.request.env).[]('recaptcha.msg').returns(nil)
+          helper_test.recaptcha_tag(:ajax,:display => {:theme => 'red'})
+        end
 
         asserts_topic('has js').matches %r{recaptcha_ajax.js}
         asserts_topic('has div').matches %r{<div id="ajax_recaptcha"></div>}
@@ -31,7 +33,10 @@ context "Rack::Recaptcha::Helpers" do
         asserts_topic('has theme').matches %r{"theme":"red"}
       end
       context "without display" do
-        setup { helper_test.recaptcha_tag(:ajax) }
+        setup do
+          mock(helper_test.request.env).[]('recaptcha.msg').returns(nil)
+          helper_test.recaptcha_tag(:ajax)
+        end
 
         asserts_topic('has js').matches %r{recaptcha_ajax.js}
         asserts_topic('has div').matches %r{<div id="ajax_recaptcha"></div>}
@@ -41,7 +46,10 @@ context "Rack::Recaptcha::Helpers" do
     end
 
     context "noscript" do
-      setup { helper_test.recaptcha_tag :noscript, :public_key => "hello_world_world" }
+      setup do
+        mock(helper_test.request.env).[]('recaptcha.msg').returns(nil)
+        helper_test.recaptcha_tag :noscript, :public_key => "hello_world_world"
+      end
 
       asserts_topic("iframe").matches %r{iframe}
       asserts_topic("no script tag").matches %r{<noscript>}
@@ -50,7 +58,10 @@ context "Rack::Recaptcha::Helpers" do
     end
 
     context "challenge" do
-      setup { helper_test.recaptcha_tag(:challenge) }
+      setup do
+        mock(helper_test.request.env).[]('recaptcha.msg').returns(nil)
+        helper_test.recaptcha_tag(:challenge)
+      end
 
       asserts_topic("has script tag").matches %r{script}
       asserts_topic("has challenge js").matches %r{challenge}
@@ -62,16 +73,47 @@ context "Rack::Recaptcha::Helpers" do
     context "server" do
 
       asserts("using ssl url") do
+        mock(helper_test.request.env).[]('recaptcha.msg').returns(nil)
         helper_test.recaptcha_tag(:challenge, :ssl => true)
       end.matches %r{#{Rack::Recaptcha::API_SECURE_URL}}
 
       asserts("using non ssl url") do
+        mock(helper_test.request.env).[]('recaptcha.msg').returns(nil)
         helper_test.recaptcha_tag(:ajax)
       end.matches %r{#{Rack::Recaptcha::API_URL}}
     end
 
   end
 
+  context "recaptcha_tag_errors" do
+    context "challenge with error" do
+      setup do
+        mock(helper_test.request.env).[]('recaptcha.msg').returns("Sample Error")
+        helper_test.recaptcha_tag(:challenge)
+      end
+
+      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}}
+      asserts_topic("has previous error").matches %r{Sample%20Error}
+    end
+
+    context "noscript with error" do
+      setup do
+        mock(helper_test.request.env).[]('recaptcha.msg').returns("Sample Error")
+        helper_test.recaptcha_tag :noscript, :public_key => "hello_world_world"
+      end
+
+      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}
+      asserts_topic("has previous error").matches %r{Sample%20Error}
+    end
+  end
+
   context "recaptcha_valid?" do
 
     asserts "that it passes when recaptcha.valid is true" do

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rack-recaptcha
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 0
-  version: 0.5.0
+  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors: 
 - Arthur Chiu
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-18 00:00:00 -07:00
-default_executable: 
+date: 2010-07-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -25,8 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -38,10 +31,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 12
-        - 3
         version: 0.12.3
   type: :development
   version_requirements: *id002
@@ -53,10 +42,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 7
         version: 0.5.7
   type: :development
   version_requirements: *id003
@@ -68,10 +53,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
         version: 1.3.0
   type: :development
   version_requirements: *id004
@@ -83,10 +64,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 2
         version: 1.0.2
   type: :development
   version_requirements: *id005
@@ -111,7 +88,6 @@ files:
 - test/helpers_test.rb
 - test/recaptcha_test.rb
 - test/teststrap.rb
-has_rdoc: true
 homepage: http://github.com/achiu/rack-recaptcha
 licenses: []
 
@@ -125,23 +101,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.4
 signing_key: 
 specification_version: 3
 summary: Rack middleware for Recaptcha