lastobelus-merb-recaptcha 1.0.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Anton Ageev
+
+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.rdoc

@@ -0,0 +1,45 @@
+= merb-recaptcha
+
+== About
+
+Merb-recaptcha is plugin for Merb web-framework. It provides view and controller helpers for Recaptcha service.
+
+== Installation
+
+Install gem from github.com:
+    gem install antage-merb-recaptcha --source=http://gems.github.com
+
+Add following line in <tt>config/dependencies.rb</tt> of your web application:
+    dependency "antage-merb-recaptcha", "~> 1.0.0", :require_as => "merb-recaptcha"
+
+Sign up at Recaptcha and get public and private keys. Add keys in <tt>config/init.rb</tt>:
+    Merb::BootLoader.after_app_loads do
+      Merb::Plugins.config[:merb_recaptcha][:public_key] = "... here your public key ..."
+      Merb::Plugins.config[:merb_recaptcha][:private_key] = "... here your private key ..."
+    end
+
+== Usage
+
+Just add helper in your form:
+    <%= form_for @users, :action => resource(:users), :method => :post do %>
+      .....
+      <%= recaptcha_tags %>
+      <%= submit "Send" %>
+    <% end %>
+
+And then check captcha in controller:
+    class Users < Application
+      ......
+      def create(user)
+        @user = User.new(user)
+        if (captcha_correct = recaptcha_valid?) && @user.save
+          redirect resource(@user)
+        else
+          unless captcha_correct
+            @user.valid?
+            @user.errors.add(:general, "Captcha code is incorrect")
+        end
+        render :new
+      end
+      ......
+    end

data/Rakefile

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/clean'
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+require 'spec/rake/spectask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb-recaptcha"
+GEM_VERSION = "1.0.2"
+AUTHOR = "Anton Ageev"
+EMAIL = "antage@gmail.com"
+HOMEPAGE = "http://github.com/antage/merb-recaptcha/"
+SUMMARY = "Merb plugin that provides helpers for recaptcha.net service"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb-recaptcha'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ "README.rdoc", "LICENSE" ]
+  s.rdoc_options << "--main" << "README.rdoc"
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.rdoc Rakefile TODO merb-recaptcha.gemspec) + Dir["lib/**/*"].select { |f| File.file?(f) }
+  s.test_files = %w(spec/spec_helper.rb) + Dir["spec/*_spec.rb"] + Dir["spec/fixture/app/**/*"].select { |f| File.file?(f) }
+
+  s.add_runtime_dependency "merb-core", ">= 1.0.0"
+  s.add_runtime_dependency "builder", "~> 2.0"
+  s.add_development_dependency "rspec", ">= 1.1.0"
+  s.add_development_dependency "mocha", ">= 0.9.3"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+Rake::RDocTask.new do |rdoc|
+  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc"
+  rdoc.title = "merb-recaptcha docs"
+  rdoc.rdoc_dir = "doc"
+  rdoc.options << "--line-numbers" << "--inline-source"
+end
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--format' << 'specdoc' << '--colour'
+  t.spec_opts << '--loadby' << 'random'
+  t.spec_files = Pathname.glob(ENV['FILES'] || 'spec/**/*_spec.rb')
+  t.rcov = false
+end
+
+task :default => :spec

data/TODO

@@ -0,0 +1 @@
+TODO:

data/lib/merb-recaptcha.rb

@@ -0,0 +1,30 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_recaptcha] = {
+    :public_key => "",
+    :private_key => "",
+    :allow_disable_by_cookie => false
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    # require code that must be loaded before the application
+    require 'merb-recaptcha/constants.rb'
+    require 'merb-recaptcha/view_helpers.rb'
+    require 'merb-recaptcha/exceptions.rb'
+    require 'merb-recaptcha/controller_mixin.rb'
+    module Merb::GlobalHelpers # :nodoc:
+      include Merb::Helpers::Recaptcha
+    end
+    class Merb::Controller # :nodoc:
+      include Merb::RecaptchaMixin
+    end
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    # code that can be required after the application loads
+  end
+  
+  Merb::Plugins.add_rakefiles "merb-recaptcha/merbtasks"
+end

data/lib/merb-recaptcha/constants.rb

@@ -0,0 +1,7 @@
+module Merb
+  module Recaptcha
+    API_SERVER = "http://api.recaptcha.net"
+    API_SECURE_SERVER = "https://api-secure.recaptcha.net"
+    API_VERIFY_SERVER = "http://api-verify.recaptcha.net"
+  end
+end

data/lib/merb-recaptcha/controller_mixin.rb

@@ -0,0 +1,47 @@
+require 'net/http'
+
+module Merb # :nodoc:
+  module RecaptchaMixin
+
+    # This method checks challenge and response data via Recaptcha API server.
+    # * It will return true, if filled captcha response is correct.
+    # * It will return false, if captcha is incorrect.
+    # * It will raise exception, if Recaptcha API server returns error.
+    #
+    def recaptcha_valid?
+      return true if (Merb.testing? && !Merb::RecaptchaMixin.const_defined?(:DO_NOT_IGNORE_RECAPTCHA_IN_TESTING_ENV))
+      return true if Merb::Plugins.config[:merb_recaptcha][:allow_disable_by_cookie] && cookies[:recaptcha_disabled]=="true"
+      begin
+        response = Net::HTTP.post_form(URI.parse("#{Merb::Recaptcha::API_VERIFY_SERVER}/verify"), {
+          :privatekey => Merb::Plugins.config[:merb_recaptcha][:private_key],
+          :remoteip => request.remote_ip,
+          :challenge => params[:recaptcha_challenge_field],
+          :response => params[:recaptcha_response_field]
+        })
+      rescue Exception => e
+        if Merb.env?(:production) || ENV['OFFLINE']
+          Merb.logger.error("when trying to connect to recaptcha, got #{e.message}")
+          return true;
+        else
+          raise
+        end
+      end
+      answer, error = response.body.split.map { |s| s.chomp }
+      if answer == "true"
+        true
+      else
+        Merb.logger.fatal("recaptcha error: #{error} for #{request.remote_ip}")
+        case error
+        when "incorrect-captcha-sol" then false
+        when "invalid-site-public-key" then raise Merb::Recaptcha::InvalidSitePublicKey
+        when "invalid-site-private-key" then raise Merb::Recaptcha::InvalidSitePrivateKey
+        when "invalid-request-cookie" then raise Merb::Recaptcha::InvalidRequestCookie
+        when "verify-params-incorrect" then raise Merb::Recaptcha::VerifyParamsIncorrect
+        when "invalid-referrer" then raise Merb::Recaptcha::InvalidReferrer
+        else
+          raise Merb::Recaptcha::GenericError
+        end
+      end
+    end
+  end
+end

data/lib/merb-recaptcha/exceptions.rb

@@ -0,0 +1,30 @@
+module Merb # :nodoc:
+  module Recaptcha
+    class GenericError < RuntimeError; end
+
+    # We weren't able to verify the public key.
+    # Possible solutions:
+    #
+    # * Did you swap the public and private key? It is important to use the correct one
+    # * Did you make sure to copy the entire key, with all hyphens and underscores, but without any spaces? The key should be exactly 40 letters long.
+    #
+    class InvalidSitePublicKey < GenericError; end
+
+    # We weren't able to verify the private key.
+    # Possible solutions:
+    #
+    # * Did you swap the public and private key? It is important to use the correct one
+    # * Did you make sure to copy the entire key, with all hyphens and underscores, but without any spaces? The key should be exactly 40 letters long.
+    #         
+    class InvalidSitePrivateKey < GenericError; end
+
+    # The challenge parameter of the verify script was incorrect.
+    class InvalidRequestCookie < GenericError; end
+
+    # The parameters to /verify were incorrect, make sure you are passing all the required parameters.
+    class VerifyParamsIncorrect < GenericError; end
+
+    # reCAPTCHA API keys are tied to a specific domain name for security reasons.
+    class InvalidReferrer < GenericError; end
+  end
+end

data/lib/merb-recaptcha/view_helpers.rb

@@ -0,0 +1,117 @@
+require 'builder'
+
+module Merb # :nodoc:
+  module Helpers # :nodoc:
+    module Recaptcha
+
+      # Display recaptcha widget in various ways.
+      # 
+      # * Display in-place:
+      #     <%= recaptcha_tags :ajax => false, :noscript => false %>
+      #
+      # * Display in-place with <noscript></noscript> block:
+      #     <%= recaptcha_tags :ajax => false, :noscript => true, :iframe_height => 100, :iframe_width => 100 %>
+      #
+      # * Dynamically create Recaptcha widget:
+      #     <%= recaptcha_tags :ajax => true, :element_id => "recaptcha_place" %>
+      #     <div id="recaptcha_place"></div>
+      #   The above code bind javascript code on onload event:
+      #     <script type="text/javascript">
+      #     ....
+      #     window.onload = function() { Recaptcha.create(....); }
+      #     ....
+      #     </script>
+      #   If you use jQuery, you could use special value for :ajax parameter:
+      #     <%= recaptcha_tags :ajax => :jquery %>
+      #     <div id="recpatcha"></div>
+      #   This code generates following:
+      #     <script type="text/javascript">
+      #     ....
+      #     $(document).ready(function() { Recaptcha.create(....); });
+      #     ....
+      #     </script>
+      #   You can specified callback function that will be invoked after widget has been created:
+      #     <%= recaptcha_tags :ajax => true, :callback => "Recaptcha.focus_response_field" %>
+      #     <div id="recaptcha"></div>
+      #   This code will set focus on response field of created widget.
+      #
+      # For both displaying ways, you can customize widget:
+      #   <%= recaptcha_tags :theme => "clean", :tabindex => 2 %>
+      # More detailed description of customizing options is at http://recaptcha.net/apidocs/captcha/client.html
+      #
+      # Default values of options:
+      # * :ajax => false
+      # * :element_id => "recaptcha"
+      # * :callback => nil
+      # * :noscript => false
+      # * :iframe_height => 300
+      # * :iframe_width => 500
+      #
+      def recaptcha_tags(options = {})
+        public_key = Merb::Plugins.config[:merb_recaptcha][:public_key] 
+
+        ajax = options.delete(:ajax) || false # boolean or :jquery
+        element_id = options.delete(:element_id) || "recaptcha" # string, html element id, only if ajax == true
+        callback = options.delete(:callback) # string, javascript function name, only if ajax == true
+        noscript = options.delete(:noscript) || false # boolean
+        iframe_height = options.delete(:iframe_height) || 300 # integer, only if noscript == true
+        iframe_width = options.delete(:iframe_width) || 500 # integer, only if noscript == true
+
+        api_url = if request.ssl?
+          Merb::Recaptcha::API_SECURE_SERVER
+        else
+          Merb::Recaptcha::API_SERVER
+        end
+
+        result = ""
+        xhtml = Builder::XmlMarkup.new(:target => result, :indent => 2) 
+        if ajax
+          xhtml.script(:type => "text/javascript", :src => "#{api_url}/js/recaptcha_ajax.js") {}
+          xhtml.script(:type => "text/javascript") do |js|
+            options_and_callback = callback.nil? ? options : options.merge(:callback => callback)
+            js << "//<![CDATA[\n"
+            js << "var options = #{hash_to_json(options_and_callback)};\n"
+            if ajax == :jquery
+              js << "$(document).ready(function() { Recaptcha.create('#{public_key}', document.getElementById('#{element_id}'), options); });\n"
+            else
+              js << "window.onload = function() { Recaptcha.create('#{public_key}', document.getElementById('#{element_id}'), options); };\n"
+            end
+            js << "//]]>\n"
+          end
+        else
+          unless options.empty?
+            xhtml.script(:type => "text/javascript") do |js|
+              js << "//<![CDATA[\n"
+              js << "var RecaptchaOptions = #{hash_to_json(options)};\n"
+              js << "//]]>\n"
+            end
+          end
+          xhtml.script(:type => "text/javascript", :src => "#{api_url}/challenge?k=#{public_key}") {}
+          if noscript
+            xhtml.noscript do
+              xhtml.iframe(:src => "#{api_url}/noscript?k=#{public_key}", :height => iframe_height, :width => iframe_width, :frameborder => 0) {}
+              xhtml.br
+              xhtml.textarea(:name => "recaptcha_challenge_field", :rows => 3, :cols => 40) {}
+              xhtml.input :name => "recaptcha_response_field", :type => "hidden", :value => "manual_challenge"
+            end
+          end
+        end
+        result
+      end
+
+      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
+  end
+end

data/merb-recaptcha.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{merb-recaptcha}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anton Ageev", "Michael Johnston"]
+  s.date = %q{2008-12-19}
+  s.description = %q{Merb plugin that provides helpers for recaptcha.net service}
+  s.email = %q{antage@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+  s.files = ["LICENSE", "README.rdoc", "Rakefile", "TODO", "merb-recaptcha.gemspec", "lib/merb-recaptcha/constants.rb", "lib/merb-recaptcha/merbtasks.rb", "lib/merb-recaptcha/controller_mixin.rb", "lib/merb-recaptcha/view_helpers.rb", "lib/merb-recaptcha/exceptions.rb", "lib/merb-recaptcha.rb", "spec/spec_helper.rb", "spec/recaptcha_ajax_with_options_spec.rb", "spec/recaptcha_noajax_without_noscript_spec.rb", "spec/recaptcha_noajax_with_noscript_spec.rb", "spec/recaptcha_valid_spec.rb", "spec/recaptcha_ajax_spec.rb", "spec/recaptcha_ajax_with_callback_spec.rb", "spec/recaptcha_noajax_with_options_spec.rb", "spec/recaptcha_ajax_with_jquery_spec.rb", "spec/fixture/app/controllers/application.rb", "spec/fixture/app/controllers/exceptions.rb", "spec/fixture/app/controllers/recaptcha.rb", "spec/fixture/app/views/exceptions/not_acceptable.html.erb", "spec/fixture/app/views/exceptions/not_found.html.erb", "spec/fixture/app/views/layout/application.html.erb", "spec/fixture/app/views/recaptcha/ajax.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_callback.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_options.html.erb", "spec/fixture/app/views/recaptcha/noajax_without_noscript.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_options.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_noscript.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_jquery.html.erb", "spec/fixture/app/helpers/global_helpers.rb", "spec/fixture/app/helpers/recaptcha_helpers.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/antage/merb-recaptcha/}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{merb-recaptcha}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Merb plugin that provides helpers for recaptcha.net service}
+  s.test_files = ["spec/spec_helper.rb", "spec/recaptcha_ajax_with_options_spec.rb", "spec/recaptcha_noajax_without_noscript_spec.rb", "spec/recaptcha_noajax_with_noscript_spec.rb", "spec/recaptcha_valid_spec.rb", "spec/recaptcha_ajax_spec.rb", "spec/recaptcha_ajax_with_callback_spec.rb", "spec/recaptcha_noajax_with_options_spec.rb", "spec/recaptcha_ajax_with_jquery_spec.rb", "spec/fixture/app/controllers/application.rb", "spec/fixture/app/controllers/exceptions.rb", "spec/fixture/app/controllers/recaptcha.rb", "spec/fixture/app/views/exceptions/not_acceptable.html.erb", "spec/fixture/app/views/exceptions/not_found.html.erb", "spec/fixture/app/views/layout/application.html.erb", "spec/fixture/app/views/recaptcha/ajax.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_callback.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_options.html.erb", "spec/fixture/app/views/recaptcha/noajax_without_noscript.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_options.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_noscript.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_jquery.html.erb", "spec/fixture/app/helpers/global_helpers.rb", "spec/fixture/app/helpers/recaptcha_helpers.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<merb-core>, [">= 1.0.0"])
+      s.add_runtime_dependency(%q<builder>, ["~> 2.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.1.0"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.3"])
+    else
+      s.add_dependency(%q<merb-core>, [">= 1.0.0"])
+      s.add_dependency(%q<builder>, ["~> 2.0"])
+      s.add_dependency(%q<rspec>, [">= 1.1.0"])
+      s.add_dependency(%q<mocha>, [">= 0.9.3"])
+    end
+  else
+    s.add_dependency(%q<merb-core>, [">= 1.0.0"])
+    s.add_dependency(%q<builder>, ["~> 2.0"])
+    s.add_dependency(%q<rspec>, [">= 1.1.0"])
+    s.add_dependency(%q<mocha>, [">= 0.9.3"])
+  end
+end

data/spec/fixture/app/controllers/application.rb

@@ -0,0 +1,2 @@
+class Application < Merb::Controller
+end

data/spec/fixture/app/controllers/exceptions.rb

@@ -0,0 +1,13 @@
+class Exceptions < Merb::Controller
+  
+  # handle NotFound exceptions (404)
+  def not_found
+    render :format => :html
+  end
+
+  # handle NotAcceptable exceptions (406)
+  def not_acceptable
+    render :format => :html
+  end
+
+end