recaptcha 0.3.4 → 0.3.5

data/.gitignore

@@ -1,2 +1,3 @@
 rdoc
 pkg
+Gemfile.lock

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.3.5 / 2012-05-02
+
+* I18n for error messages
+* Rails: delete flash keys if unused
+
 == 0.3.4 / 2011-12-13
 
 * Rails 3
@@ -25,4 +30,4 @@
 == 0.1.0 / 2008-2-8
 
 * 1 major enhancement
-	* Initial Gem Release
+	* Initial Gem Release

data/README.rdoc

@@ -17,31 +17,18 @@ call these methods and the keys can't be found.
 
 == About this fork
 
-This fork tries to introduces a more convenient way to configure recaptcha's
+This fork tries to introduce a more convenient way to configure recaptcha's
 settings. The API will be inspired by {Thoughtbot's
 Hoptoad}[http://robots.thoughtbot.com/post/344833329/mygem-configure-block].
 
 == Rails Installation
 
-reCAPTCHA for Rails, add this to your Gemfile:
+reCAPTCHA for Rails > 3.0, add this to your Gemfile:
 
   gem "recaptcha", :require => "recaptcha/rails"
 
-Or, it can be installed as a gem:
-
-  config.gem "recaptcha", :lib => "recaptcha/rails"
-
-Or, as a standard rails plugin:
-
-  script/plugin install git://github.com/ambethia/recaptcha.git
-
-== Merb Installation
-
-reCAPTCHA can also be used in a Merb application when installed as a gem:
-
-  dependency "alm-recaptcha", ">=0.2.2.1", :require_as => "recaptcha/merb"
-
-Initial Merb compatability funded by ALM Labs.
+Rails apps below 3.0 are no longer supported, but you can install an older
+release and view it's README.
 
 == Setting up your API Keys
 
@@ -56,7 +43,7 @@ into a +config/initializers/recaptcha.rb+ when used in a Rails project.
   Recaptcha.configure do |config|
     config.public_key  = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
     config.private_key = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
-    config.proxy = 'http://myrpoxy.com.au:8080'
+    config.proxy = 'http://myproxy.com.au:8080'
   end
 
 This way, you may also set additional options to fit recaptcha into your
@@ -66,15 +53,16 @@ deployment environment.
 
 If you want to temporarily overwrite the configuration you set with `Recaptcha.configure` (when testing, for example), you can use a `Recaptcha#with_configuration` block:
 
-  Recaptcha.configure(:public_key => '12345') do
+  Recaptcha.with_configuration(:public_key => '12345') do
     # Do stuff with the overwritten public_key.
   end
 
-=== Shell environment
+=== Heroku & Shell environment
 
 Or, you can keep your keys out of your code base by exporting the following
 environment variables. You might do this in the .profile/rc, or equivalent for
-the user running your application:
+the user running your application. This would also be the preffered method
+in an Heroku deployment.
 
   export RECAPTCHA_PUBLIC_KEY  = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
   export RECAPTCHA_PRIVATE_KEY = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
@@ -102,9 +90,9 @@ And, add +verify_recaptcha+ logic to each form action that you've protected.
 
 Some of the options available:
 
-<tt>:ssl</tt>::         Uses secure http for captcha widget (default +false+)
+<tt>:ssl</tt>::         Uses secure http for captcha widget (default +false+, but can be changed by setting +config.use_ssl_by_default+)
 <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>:display</tt>::     Takes a hash containing the +theme+ and +tabindex+ options per the API. (default +nil+), options: 'red', 'white', 'blackglass', 'clean', 'custom'
 <tt>:ajax</tt>::        Render the dynamic AJAX captcha per the API. (default +false+)
 <tt>:public_key</tt>::  Your public API key, takes precedence over the ENV variable (default +nil+)
 <tt>:error</tt>::       Override the error code returned from the reCAPTCHA API (default +nil+)
@@ -136,13 +124,20 @@ Some of the options available:
   end
 
 == I18n support
-reCAPTCHA passes two types of error explanation to a linked model. It will use the I18n gem 
-to translate the default error message if I18n is available. To customize the messages to your locale, 
+reCAPTCHA passes two types of error explanation to a linked model. It will use the I18n gem
+to translate the default error message if I18n is available. To customize the messages to your locale,
 add these keys to your I18n backend:
 
 <tt>recaptcha.errors.verification_failed</tt>:: error message displayed if the captcha words didn't match
 <tt>recaptcha.errors.recaptcha_unavailable</tt>:: displayed if a timout error occured while attempting to verify the captcha
 
+Also you can translate API response errors to human friendly by adding translations to the locale (+config/locales/en.yml+):
+
+  en:
+    recaptcha:
+      errors:
+        incorrect-captcha-sol: 'Fail'
+
 == TODO
 * Remove Rails/ActionController dependencies
 * Framework agnostic

data/lib/recaptcha.rb

@@ -3,10 +3,12 @@ require 'recaptcha/client_helper'
 require 'recaptcha/verify'
 
 module Recaptcha
-  RECAPTCHA_API_SERVER_URL        = 'http://www.google.com/recaptcha/api'
+  RECAPTCHA_API_SERVER_URL        = '//www.google.com/recaptcha/api'
   RECAPTCHA_API_SECURE_SERVER_URL = 'https://www.google.com/recaptcha/api'
   RECAPTCHA_VERIFY_URL            = 'http://www.google.com/recaptcha/api/verify'
+  USE_SSL_BY_DEFAULT              = false
 
+  HANDLE_TIMEOUTS_GRACEFULLY      = true
   SKIP_VERIFY_ENV = ['test', 'cucumber']
 
   # Gives access to the current Configuration.

data/lib/recaptcha/client_helper.rb

@@ -6,12 +6,13 @@ module Recaptcha
       # Default options
       key   = options[:public_key] ||= Recaptcha.configuration.public_key
       raise RecaptchaError, "No public key specified." unless key
-      error = options[:error] ||= (defined? flash ? flash[:recaptcha_error] : "")
+      error = options[:error] ||= ((defined? flash) ? flash[:recaptcha_error] : "")
       uri   = Recaptcha.configuration.api_server_url(options[:ssl])
+      lang  = options[:display] && options[:display][:lang] ? options[:display][:lang].to_sym : ""
       html  = ""
       if options[:display]
         html << %{<script type="text/javascript">\n}
-        html << %{  var RecaptchaOptions = #{options[:display].to_json};\n}
+        html << %{  var RecaptchaOptions = #{hash_to_json(options[:display])};\n}
         html << %{</script>\n}
       end
       if options[:ajax]
@@ -31,7 +32,8 @@ module Recaptcha
         EOS
       else
         html << %{<script type="text/javascript" src="#{uri}/challenge?k=#{key}}
-        html << %{#{error ? "&amp;error=#{CGI::escape(error)}" : ""}"></script>\n}
+        html << %{#{error ? "&amp;error=#{CGI::escape(error)}" : ""}}
+        html << %{#{lang ? "&amp;lang=#{lang}" : ""}"></script>\n}
         unless options[:noscript] == false
           html << %{<noscript>\n  }
           html << %{<iframe src="#{uri}/noscript?k=#{key}" }
@@ -47,5 +49,19 @@ module Recaptcha
       end
       return (html.respond_to?(:html_safe) && html.html_safe) || html
     end # recaptcha_tags
+
+    private
+
+    def hash_to_json(hash)
+      result = "{"
+      result << hash.map do |k, v|
+        if ! v.is_a?(String) || k.to_s == "callback"
+          "\"#{k}\": #{v}"
+        else
+          "\"#{k}\": \"#{v}\""
+        end
+      end.join(", ")
+      result << "}"
+    end
   end # ClientHelper
 end # Recaptcha

data/lib/recaptcha/configuration.rb

@@ -1,6 +1,6 @@
 module Recaptcha
   # This class enables detailed configuration of the recaptcha services.
-  # 
+  #
   # By calling
   #
   #   Recaptcha.configuration # => instance of Recaptcha::Configuration
@@ -13,7 +13,7 @@ module Recaptcha
   # you are able to perform configuration updates.
   #
   # Your are able to customize all attributes listed below. All values have
-  # sensitive default and will very likely not need to be changed. 
+  # sensitive default and will very likely not need to be changed.
   #
   # Please note that the public and private key for the reCAPTCHA API Access
   # have no useful default value. The keys may be set via the Shell enviroment
@@ -34,19 +34,24 @@ module Recaptcha
                   :skip_verify_env,
                   :private_key,
                   :public_key,
-                  :proxy
+                  :proxy,
+                  :handle_timeouts_gracefully,
+                  :use_ssl_by_default
 
     def initialize #:nodoc:
-      @nonssl_api_server_url = RECAPTCHA_API_SERVER_URL
-      @ssl_api_server_url    = RECAPTCHA_API_SECURE_SERVER_URL
-      @verify_url            = RECAPTCHA_VERIFY_URL
-      @skip_verify_env       = SKIP_VERIFY_ENV
+      @nonssl_api_server_url      = RECAPTCHA_API_SERVER_URL
+      @ssl_api_server_url         = RECAPTCHA_API_SECURE_SERVER_URL
+      @verify_url                 = RECAPTCHA_VERIFY_URL
+      @skip_verify_env            = SKIP_VERIFY_ENV
+      @handle_timeouts_gracefully = HANDLE_TIMEOUTS_GRACEFULLY
+      @use_ssl_by_default         = USE_SSL_BY_DEFAULT
 
       @private_key           = ENV['RECAPTCHA_PRIVATE_KEY']
       @public_key            = ENV['RECAPTCHA_PUBLIC_KEY']
     end
 
-    def api_server_url(ssl = false) #:nodoc:
+    def api_server_url(ssl = nil) #:nodoc:
+      ssl = use_ssl_by_default if ssl.nil?
       ssl ? ssl_api_server_url : nonssl_api_server_url
     end
   end

data/lib/recaptcha/verify.rb

@@ -34,25 +34,39 @@ module Recaptcha
         end
         answer, error = recaptcha.body.split.map { |s| s.chomp }
         unless answer == 'true'
-          flash[:recaptcha_error] = error
+          flash[:recaptcha_error] = if defined?(I18n)
+            I18n.translate("recaptcha.errors.#{error}", {:default => error})
+          else
+            error
+          end
+
           if model
             message = "Word verification response is incorrect, please try again."
-            message = I18n.translate(:'recaptcha.errors.verification_failed', {:default => message}) if defined?(I18n)
+            message = I18n.translate('recaptcha.errors.verification_failed', {:default => message}) if defined?(I18n)
             model.errors.add attribute, options[:message] || message
           end
           return false
         else
-          flash[:recaptcha_error] = nil
+          flash.delete(:recaptcha_error)
           return true
         end
       rescue Timeout::Error
-        flash[:recaptcha_error] = "recaptcha-not-reachable"
-        if model
-          message = "Oops, we failed to validate your word verification response. Please try again."
-          message = I18n.translate(:'recaptcha.errors.recaptcha_unreachable', :default => message) if defined?(I18n)
-          model.errors.add attribute, options[:message] || message
+        if Recaptcha.configuration.handle_timeouts_gracefully
+          flash[:recaptcha_error] = if defined?(I18n)
+            I18n.translate('recaptcha.errors.recaptcha_unreachable', {:default => 'Recaptcha unreachable.'})
+          else
+            'Recaptcha unreachable.'
+          end
+
+          if model
+            message = "Oops, we failed to validate your word verification response. Please try again."
+            message = I18n.translate('recaptcha.errors.recaptcha_unreachable', :default => message) if defined?(I18n)
+            model.errors.add attribute, options[:message] || message
+          end
+          return false
+        else
+          raise RecaptchaError, "Recaptcha unreachable."
         end
-        return false
       rescue Exception => e
         raise RecaptchaError, e.message, e.backtrace
       end

data/lib/recaptcha/version.rb

@@ -1,3 +1,3 @@
 module Recaptcha
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/test/recaptcha_test.rb

@@ -19,7 +19,17 @@ class RecaptchaClientHelperTest < Test::Unit::TestCase
 
   def test_recaptcha_tags
     # Might as well match something...
-    assert_match /http:\/\/www.google.com\/recaptcha\/api\/challenge/, recaptcha_tags
+    assert_match /"\/\/www.google.com\/recaptcha\/api\/challenge/, recaptcha_tags
+  end
+
+  def test_ssl_by_default
+    Recaptcha.configuration.use_ssl_by_default = true
+    assert_match /https:\/\/www.google.com\/recaptcha\/api\/challenge/, recaptcha_tags
+  end
+
+  def test_relative_protocol_by_default_without_ssl
+    Recaptcha.configuration.use_ssl_by_default = false
+    assert_match /\/\/www.google.com\/recaptcha\/api\/challenge/, recaptcha_tags(:ssl => false)
   end
 
   def test_recaptcha_tags_with_ssl

data/test/verify_recaptcha_test.rb

@@ -2,6 +2,7 @@
 
 require 'test/unit'
 require 'rubygems'
+require 'active_support'
 require 'active_support/core_ext/string'
 require 'mocha'
 require 'i18n'
@@ -70,7 +71,17 @@ class RecaptchaVerifyTest < Test::Unit::TestCase
   def test_timeout
     expect_http_post(Timeout::Error, :exception => true)
     assert !@controller.verify_recaptcha()
-    assert_equal "recaptcha-not-reachable", @controller.flash[:recaptcha_error]
+    assert_equal "Recaptcha unreachable.", @controller.flash[:recaptcha_error]
+  end
+
+  def test_timeout_when_handle_timeouts_gracefully_disabled
+    Recaptcha.with_configuration(:handle_timeouts_gracefully => false) do
+      expect_http_post(Timeout::Error, :exception => true)
+      assert_raise Recaptcha::RecaptchaError, "Recaptcha unreachable." do
+        assert @controller.verify_recaptcha()
+      end
+      assert_nil @controller.flash[:recaptcha_error]
+    end
   end
 
   def test_message_should_use_i18n
@@ -79,8 +90,12 @@ class RecaptchaVerifyTest < Test::Unit::TestCase
     verification_failed_default      = "Word verification response is incorrect, please try again."
     recaptcha_unreachable_translated = "Netzwerkfehler, bitte versuchen Sie es später erneut."
     recaptcha_unreachable_default    = "Oops, we failed to validate your word verification response. Please try again."
-    I18n.expects(:translate).with(:'recaptcha.errors.verification_failed', :default => verification_failed_default).returns(verification_failed_translated)
-    I18n.expects(:translate).with(:'recaptcha.errors.recaptcha_unreachable', :default => recaptcha_unreachable_default).returns(recaptcha_unreachable_translated)
+
+    I18n.expects(:translate).with('recaptcha.errors.bad-news', {:default => 'bad-news'})
+    I18n.expects(:translate).with('recaptcha.errors.recaptcha_unreachable', {:default => 'Recaptcha unreachable.'})
+
+    I18n.expects(:translate).with('recaptcha.errors.verification_failed', :default => verification_failed_default).returns(verification_failed_translated)
+    I18n.expects(:translate).with('recaptcha.errors.recaptcha_unreachable', :default => recaptcha_unreachable_default).returns(recaptcha_unreachable_translated)
 
     errors = mock
     errors.expects(:add).with(:base, verification_failed_translated)
@@ -95,6 +110,22 @@ class RecaptchaVerifyTest < Test::Unit::TestCase
 
   end
 
+  def test_it_translates_api_response_with_i18n
+    api_error_translated = "Bad news, body :("
+    expect_http_post(response_with_body("false\nbad-news"))
+    I18n.expects(:translate).with('recaptcha.errors.bad-news', :default => 'bad-news').returns(api_error_translated)
+
+    assert !@controller.verify_recaptcha
+    assert_equal api_error_translated, @controller.flash[:recaptcha_error]
+  end
+
+  def test_it_fallback_to_api_response_if_i18n_translation_is_missing
+    expect_http_post(response_with_body("false\nbad-news"))
+
+    assert !@controller.verify_recaptcha
+    assert_equal 'bad-news', @controller.flash[:recaptcha_error]
+  end
+
   private
 
   class TestController

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recaptcha
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70162456439800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70162456439800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70162456438320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70162456438320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70162456437340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70162456437340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70162456435080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70162456435080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This plugin adds helpers for the reCAPTCHA API
 email:
 - jasper@ambethia.com
@@ -65,11 +85,9 @@ files:
 - .gitignore
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - init.rb
 - lib/recaptcha.rb
 - lib/recaptcha/client_helper.rb
@@ -94,21 +112,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -241857000290141400
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -241857000290141400
 requirements: []
 rubyforge_project: recaptcha
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Helpers for the reCAPTCHA API

data/Gemfile.lock

@@ -1,26 +0,0 @@
-PATH
-  remote: .
-  specs:
-    recaptcha (0.3.4)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.1.3)
-      multi_json (~> 1.0)
-    i18n (0.6.0)
-    metaclass (0.0.1)
-    mocha (0.10.0)
-      metaclass (~> 0.0.1)
-    multi_json (1.0.3)
-    rake (0.9.2.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport
-  i18n
-  mocha
-  rake
-  recaptcha!

data/VERSION

@@ -1 +0,0 @@
-0.3.2