antage-merb-recaptcha 1.0.0

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.textile

@@ -0,0 +1,45 @@
+h1. merb-recaptcha
+
+h2. About
+
+Merb-recaptcha is plugin for "Merb":http://github.com/wycats/merb web-framework. It provides view and controller helpers for "Recaptcha":http://recaptcha.net service.
+
+h2. Installation
+
+Install gem from github.com:
+<pre><code>gem install antage-merb-recaptcha --source=http://gems.github.com</code></pre>
+
+Add following line in <tt>config/dependencies.rb</tt> of your web application:
+<pre><code>dependency "antage-merb-recaptcha", "~> 1.0.0", :require_as => "merb-recaptcha"</code></pre>
+
+Sign up at "Recaptcha":http://recaptcha.net and get public and private keys. Add keys in <tt>config/init.rb</tt>:
+<pre><code>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</code></pre>
+
+h2. Usage
+
+Just add helper in your form:
+<pre><code><%= form_for @users, :action => resource(:users), :method => :post do %>
+  .....
+  <%= recaptcha_tags %>
+  <%= submit "Send" %>
+<% end %></code></pre>
+
+And then check captcha in controller:
+<pre><code>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</code></pre>

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/clean'
+
+require 'spec/rake/spectask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb-recaptcha"
+GEM_VERSION = "1.0.0"
+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.textile", "LICENSE", 'TODO']
+  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.textile 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"
+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
+
+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/controller_mixin.rb

@@ -0,0 +1,29 @@
+require 'net/http'
+
+module Merb
+  module RecaptchaMixin
+    def recaptcha_valid?
+      response = Net::HTTP.post_form(URI.parse("http://api-verify.recaptcha.net/verify"), {
+        :privatekey => Merb::Plugins.config[:merb_recaptcha][:private_key],
+        :remoteip => request.remote_ip,
+        :challenge => params[:recaptcha_challenge_field],
+        :response => params[:recaptcha_response_field]
+      })
+      answer, error = response.body.split.map { |s| s.chomp }
+      if answer == "true"
+        true
+      else
+        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,10 @@
+module Merb
+  module Recaptcha
+    class GenericError < RuntimeError; end
+    class InvalidSitePublicKey < GenericError; end
+    class InvalidSitePrivateKey < GenericError; end
+    class InvalidRequestCookie < GenericError; end
+    class VerifyParamsIncorrect < GenericError; end
+    class InvalidReferrer < GenericError; end
+  end
+end

data/lib/merb-recaptcha/view_helpers.rb

@@ -0,0 +1,72 @@
+require 'builder'
+
+module Merb
+  module Helpers
+    module Recaptcha
+      API_SERVER = "http://api.recaptcha.net"
+      API_SECURE_SERVER = "https://api-secure.recaptcha.net"
+
+      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?
+          API_SECURE_SERVER
+        else
+          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
+            options_and_callback = callback.nil? ? options : options.merge(:callback => callback)
+            xhtml.text!("var options = #{hash_to_json(options_and_callback)};\n")
+            if ajax == :jquery
+              xhtml.text!("$(document).ready(function() { Recaptcha.create('#{public_key}', document.getElementById('#{element_id}'), options); });\n")
+            else
+              xhtml.text!("window.onload = function() { Recaptcha.create('#{public_key}', document.getElementById('#{element_id}'), options); }\n")
+            end
+          end
+        else
+          unless options.empty?
+            xhtml.script(:type => "text/javascript") do
+              xhtml.text!("var RecaptchaOptions = #{hash_to_json(options)};\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/lib/merb-recaptcha.rb

@@ -0,0 +1,28 @@
+# 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 => ""
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    # require code that must be loaded before the application
+    require 'merb-recaptcha/view_helpers.rb'
+    require 'merb-recaptcha/exceptions.rb'
+    require 'merb-recaptcha/controller_mixin.rb'
+    module Merb::GlobalHelpers
+      include Merb::Helpers::Recaptcha
+    end
+    class Merb::Controller
+      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/merb-recaptcha.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{merb-recaptcha}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anton Ageev"]
+  s.date = %q{2008-12-10}
+  s.description = %q{Merb plugin that provides helpers for recaptcha.net service}
+  s.email = %q{antage@gmail.com}
+  s.extra_rdoc_files = ["README.textile", "LICENSE", "TODO"]
+  s.files = ["LICENSE", "README.textile", "Rakefile", "TODO", "merb-recaptcha.gemspec", "lib/merb-recaptcha.rb", "lib/merb-recaptcha/exceptions.rb", "lib/merb-recaptcha/view_helpers.rb", "lib/merb-recaptcha/controller_mixin.rb", "lib/merb-recaptcha/merbtasks.rb", "spec/spec_helper.rb", "spec/recaptcha_ajax_with_callback_spec.rb", "spec/recaptcha_noajax_with_noscript_spec.rb", "spec/recaptcha_noajax_with_options_spec.rb", "spec/recaptcha_ajax_spec.rb", "spec/recaptcha_ajax_with_jquery_spec.rb", "spec/recaptcha_ajax_with_options_spec.rb", "spec/recaptcha_noajax_without_noscript_spec.rb", "spec/recaptcha_valid_spec.rb", "spec/fixture/app/views/layout/application.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_callback.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_noscript.html.erb", "spec/fixture/app/views/recaptcha/ajax.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_jquery.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_options.html.erb", "spec/fixture/app/views/recaptcha/noajax_without_noscript.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_options.html.erb", "spec/fixture/app/views/exceptions/not_acceptable.html.erb", "spec/fixture/app/views/exceptions/not_found.html.erb", "spec/fixture/app/controllers/exceptions.rb", "spec/fixture/app/controllers/application.rb", "spec/fixture/app/controllers/recaptcha.rb", "spec/fixture/app/helpers/recaptcha_helpers.rb", "spec/fixture/app/helpers/global_helpers.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/antage/merb-recaptcha/}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{merb-recaptcha}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Merb plugin that provides helpers for recaptcha.net service}
+  s.test_files = ["spec/spec_helper.rb", "spec/recaptcha_ajax_with_callback_spec.rb", "spec/recaptcha_noajax_with_noscript_spec.rb", "spec/recaptcha_noajax_with_options_spec.rb", "spec/recaptcha_ajax_spec.rb", "spec/recaptcha_ajax_with_jquery_spec.rb", "spec/recaptcha_ajax_with_options_spec.rb", "spec/recaptcha_noajax_without_noscript_spec.rb", "spec/recaptcha_valid_spec.rb", "spec/fixture/app/views/layout/application.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_callback.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_noscript.html.erb", "spec/fixture/app/views/recaptcha/ajax.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_jquery.html.erb", "spec/fixture/app/views/recaptcha/noajax_with_options.html.erb", "spec/fixture/app/views/recaptcha/noajax_without_noscript.html.erb", "spec/fixture/app/views/recaptcha/ajax_with_options.html.erb", "spec/fixture/app/views/exceptions/not_acceptable.html.erb", "spec/fixture/app/views/exceptions/not_found.html.erb", "spec/fixture/app/controllers/exceptions.rb", "spec/fixture/app/controllers/application.rb", "spec/fixture/app/controllers/recaptcha.rb", "spec/fixture/app/helpers/recaptcha_helpers.rb", "spec/fixture/app/helpers/global_helpers.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 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"])
+    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"])
+    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"])
+  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

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

@@ -0,0 +1,29 @@
+class Recaptcha < Application
+  def ajax
+    render
+  end
+
+  def ajax_with_jquery
+    render
+  end
+
+  def ajax_with_callback
+    render
+  end
+  
+  def ajax_with_options
+    render
+  end
+
+  def noajax_without_noscript
+    render
+  end
+
+  def noajax_with_noscript
+    render
+  end
+  
+  def noajax_with_options
+    render
+  end
+end

data/spec/fixture/app/helpers/global_helpers.rb

@@ -0,0 +1,5 @@
+module Merb
+  module GlobalHelpers
+    # helpers defined here available to all views.  
+  end
+end

data/spec/fixture/app/helpers/recaptcha_helpers.rb

@@ -0,0 +1,4 @@
+module Merb
+  module RecaptchaHelper
+  end
+end

data/spec/fixture/app/views/exceptions/not_acceptable.html.erb

@@ -0,0 +1,63 @@
+<div id="container">
+  <div id="header-container">
+    <img src="/images/merb.jpg" />
+    <!-- <h1>Mongrel + Erb</h1> -->
+    <h2>pocket rocket web framework</h2>
+    <hr />
+  </div>
+
+  <div id="left-container">
+    <h3>Exception:</h3>
+    <p><%= request.exceptions.first.message %></p>
+  </div>
+
+  <div id="main-container">
+    <h3>Why am I seeing this page?</h3>
+    <p>Merb couldn't find an appropriate content_type to return,
+      based on what you said was available via provides() and
+      what the client requested.</p>
+
+    <h3>How to add a mime-type</h3>
+    <pre><code>
+      Merb.add_mime_type :pdf, :to_pdf, %w[application/pdf], &quot;Content-Encoding&quot; =&gt; &quot;gzip&quot;
+    </code></pre>
+    <h3>What this means is:</h3>
+    <ul>
+      <li>Add a mime-type for :pdf</li>
+      <li>Register the method for converting objects to PDF as <code>#to_pdf</code>.</li>
+      <li>Register the incoming mime-type "Accept" header as <code>application/pdf</code>.</li>
+      <li>Specify a new header for PDF types so it will set <code>Content-Encoding</code> to gzip.</li>
+    </ul>
+
+    <h3>You can then do:</h3>
+    <pre><code>
+      class Foo &lt; Application
+        provides :pdf
+      end
+    </code></pre>
+
+    <h3>Where can I find help?</h3>
+    <p>If you have any questions or if you can't figure something out, please take a
+      look at our <a href="http://merbivore.com/"> project page</a>,
+      feel free to come chat at irc.freenode.net, channel #merb,
+      or post to <a href="http://groups.google.com/group/merb">merb mailing list</a>
+      on Google Groups.</p>
+      
+    <h3>What if I've found a bug?</h3>
+    <p>If you want to file a bug or make your own contribution to Merb,
+      feel free to register and create a ticket at our
+      <a href="http://merb.lighthouseapp.com/">project development page</a>
+      on Lighthouse.</p>
+
+    <h3>How do I edit this page?</h3>
+    <p>You can change what people see when this happens by editing <tt>app/views/exceptions/not_acceptable.html.erb</tt>.</p> 
+
+  </div>
+
+  <div id="footer-container">
+    <hr />
+    <div class="left"></div>
+    <div class="right">&copy; 2008 the merb dev team</div>
+    <p>&nbsp;</p>
+  </div>
+</div>

data/spec/fixture/app/views/exceptions/not_found.html.erb

@@ -0,0 +1,47 @@
+<div id="container">
+  <div id="header-container">
+    <img src="/images/merb.jpg" />
+    <!-- <h1>Mongrel + Erb</h1> -->
+    <h2>pocket rocket web framework</h2>
+    <hr />
+  </div>
+
+  <div id="left-container">
+    <h3>Exception:</h3>
+    <p><%= request.exceptions.first.message %></p>
+  </div>
+
+  <div id="main-container">
+    <h3>Welcome to Merb!</h3>
+    <p>Merb is a light-weight MVC framework written in Ruby.  We hope you enjoy it.</p>
+    
+    <h3>Where can I find help?</h3>
+    <p>If you have any questions or if you can't figure something out, please take a
+      look at our <a href="http://merbivore.com/"> project page</a>,
+      feel free to come chat at irc.freenode.net, channel #merb,
+      or post to <a href="http://groups.google.com/group/merb">merb mailing list</a>
+      on Google Groups.</p>
+      
+    <h3>What if I've found a bug?</h3>
+    <p>If you want to file a bug or make your own contribution to Merb,
+      feel free to register and create a ticket at our
+      <a href="http://merb.lighthouseapp.com/">project development page</a>
+      on Lighthouse.</p>
+
+    <h3>How do I edit this page?</h3>
+    <p>You're seeing this page because you need to edit the following files:
+      <ul>
+        <li>config/router.rb <strong><em>(recommended)</em></strong></li>
+        <li>app/views/exceptions/not_found.html.erb <strong><em>(recommended)</em></strong></li>
+        <li>app/views/layout/application.html.erb <strong><em>(change this layout)</em></strong></li>
+      </ul>
+    </p>
+  </div>
+
+  <div id="footer-container">
+    <hr />
+    <div class="left"></div>
+    <div class="right">&copy; 2008 the merb dev team</div>
+    <p>&nbsp;</p>
+  </div>
+</div>

data/spec/fixture/app/views/layout/application.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <title>Fresh Merb App</title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  </head>
+  <body>
+    <%= catch_content :for_layout %>
+  </body>
+</html>

data/spec/fixture/app/views/recaptcha/ajax.html.erb

@@ -0,0 +1,2 @@
+<%= recaptcha_tags :ajax => true, :element_id => "recaptcha_without_callback" %>
+<div id="recaptcha_without_callback"></div>

data/spec/fixture/app/views/recaptcha/ajax_with_callback.html.erb

@@ -0,0 +1,2 @@
+<%= recaptcha_tags :ajax => true, :element_id => "recaptcha_with_callback", :callback => "test_callback" %>
+<div id="recaptcha_with_callback"></div>

data/spec/fixture/app/views/recaptcha/ajax_with_jquery.html.erb

@@ -0,0 +1,2 @@
+<%= recaptcha_tags :ajax => :jquery, :element_id => "recaptcha_without_callback" %>
+<div id="recaptcha_without_callback"></div>

data/spec/fixture/app/views/recaptcha/ajax_with_options.html.erb

@@ -0,0 +1,2 @@
+<%= recaptcha_tags :ajax => true, :element_id => "recaptcha_without_callback", :theme => "clean", :tabindex => 2 %>
+<div id="recaptcha_without_callback"></div>

data/spec/fixture/app/views/recaptcha/noajax_with_noscript.html.erb

@@ -0,0 +1 @@
+<%= recaptcha_tags :ajax => false, :noscript => true, :iframe_height => 250, :iframe_width => 250 %>

data/spec/fixture/app/views/recaptcha/noajax_with_options.html.erb

@@ -0,0 +1 @@
+<%= recaptcha_tags :ajax => false, :noscript => false, :theme => "clean", :tabindex => 2 %>

data/spec/fixture/app/views/recaptcha/noajax_without_noscript.html.erb

@@ -0,0 +1 @@
+<%= recaptcha_tags :ajax => false, :noscript => false %>

data/spec/recaptcha_ajax_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Recaptcha#ajax" do
+  describe "HTTP" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax")
+    end
+
+    it "should load script from api url" do
+      @response.should have_xpath("//script[@src='http://api.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it "should invoke Recaptcha.create using onload event" do
+      @response.should have_xpath("//script[contains(., 'window.onload = function() { Recaptcha.create')]")
+    end
+
+    it "should send element_id ('recaptcha_without_callback')" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., \"getElementById('recaptcha_without_callback')\")]")
+    end
+    
+    it "should create empty options array" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., 'var options = {};')]")
+    end
+    
+    it_should_behave_like "ajax recaptcha"
+  end
+
+  describe "HTTPS" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax", {}, { "HTTPS" => "on" })
+    end
+
+    it "should load script from secure api url" do
+      @response.should have_xpath("//script[@src='https://api-secure.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it_should_behave_like "ajax recaptcha"
+  end
+end

data/spec/recaptcha_ajax_with_callback_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Recaptcha#ajax_with_callback" do
+  describe "HTTP" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax_with_callback")
+    end
+
+    it "should load script from api url" do
+      @response.should have_xpath("//script[@src='http://api.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it "should send element_id ('recaptcha_with_callback')" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., \"getElementById('recaptcha_with_callback')\")]")
+    end
+    
+    it "should create options array containing callback value ('test_callback')" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., 'var options = {\"callback\": test_callback};')]")
+    end
+    
+    it_should_behave_like "ajax recaptcha"
+  end
+
+  describe "HTTPS" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax_with_callback", {}, { "HTTPS" => "on" })
+    end
+
+    it "should load script from secure api url" do
+      @response.should have_xpath("//script[@src='https://api-secure.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it_should_behave_like "ajax recaptcha"
+  end
+end

data/spec/recaptcha_ajax_with_jquery_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Recaptcha#ajax_with_jquery" do
+  describe "HTTP" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax_with_jquery")
+    end
+
+    it "should load script from api url" do
+      @response.should have_xpath("//script[@src='http://api.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it "should invoke Recaptcha.create using onload event" do
+      @response.should have_xpath("//script[contains(., '$(document).ready(function() { Recaptcha.create')]")
+    end
+
+    it "should send element_id ('recaptcha_without_callback')" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., \"getElementById('recaptcha_without_callback')\")]")
+    end
+    
+    it "should create empty options array" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., 'var options = {};')]")
+    end
+    
+    it_should_behave_like "ajax recaptcha"
+  end
+
+  describe "HTTPS" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax_with_jquery", {}, { "HTTPS" => "on" })
+    end
+
+    it "should load script from secure api url" do
+      @response.should have_xpath("//script[@src='https://api-secure.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it_should_behave_like "ajax recaptcha"
+  end
+end

data/spec/recaptcha_ajax_with_options_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Recaptcha#ajax_with_options" do
+  describe "HTTP" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax_with_options")
+    end
+
+    it "should load script from api url" do
+      @response.should have_xpath("//script[@src='http://api.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it "should send element_id ('recaptcha_without_callback')" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., \"getElementById('recaptcha_without_callback')\")]")
+    end
+    
+    it "should create options array containing custom options (theme = 'clean', tabindex = 2)" do
+      @response.should have_xpath("//script[contains(., 'Recaptcha.create') and (contains(., 'var options = {\"theme\": \"clean\", \"tabindex\": 2};') or contains(., 'var options = {\"tabindex\": 2, \"theme\": \"clean\"};'))]")
+    end
+
+    it_should_behave_like "ajax recaptcha"
+  end
+
+  describe "HTTPS" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "ajax_with_options", {}, { "HTTPS" => "on" })
+    end
+
+    it "should load script from secure api url" do
+      @response.should have_xpath("//script[@src='https://api-secure.recaptcha.net/js/recaptcha_ajax.js']")
+    end
+
+    it_should_behave_like "ajax recaptcha"
+  end
+end

data/spec/recaptcha_noajax_with_noscript_spec.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Recaptcha#noajax_with_noscript" do
+  describe "HTTP" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "noajax_with_noscript")
+    end
+
+    it "should load script from api url" do
+      @response.should have_xpath("//script[@src='http://api.recaptcha.net/challenge?k=#{Merb::Plugins.config[:merb_recaptcha][:public_key]}']")
+    end
+
+    it "should not send private key to anything" do
+      @response.should_not have_xpath("//*[contains(., '#{Merb::Plugins.config[:merb_recaptcha][:private_key]}')]")
+    end
+
+    it "should not have RecaptchaOptions array initialization" do
+      @response.should_not have_xpath("//script[contains(., 'var RecaptchaOptions')]")
+    end
+    
+    it "should have noscript element" do
+      @response.should have_xpath("//noscript")
+    end
+
+    it "should have iframe in noscript element" do
+      @response.should have_xpath("//noscript/iframe")
+    end
+
+    it "should have iframe with specified height and width (250x250)" do
+      @response.should have_xpath("//noscript/iframe[@height=250 and @width=250]")
+    end
+
+    it "should have br element in noscript element" do
+      @response.should have_xpath("//noscript/br")
+    end
+
+    it "should have textarea in noscript element" do
+      @response.should have_xpath("//noscript/textarea[@name='recaptcha_challenge_field']")
+    end
+
+    it "should have hidden input element in noscript element" do
+      @response.should have_xpath("//noscript/input[@name='recaptcha_response_field' and @type='hidden' and @value='manual_challenge']")
+    end
+  end
+
+  describe "HTTPS" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "noajax_with_noscript", {}, { "HTTPS" => "on" })
+    end
+
+    it "should load script from secure api url" do
+      @response.should have_xpath("//script[@src='https://api-secure.recaptcha.net/challenge?k=#{Merb::Plugins.config[:merb_recaptcha][:public_key]}']")
+    end
+
+    it "should not send private key to anything" do
+      @response.should_not have_xpath("//*[contains(., '#{Merb::Plugins.config[:merb_recaptcha][:private_key]}')]")
+    end
+  end
+end

data/spec/recaptcha_noajax_with_options_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Recaptcha#noajax_with_options" do
+  describe "HTTP" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "noajax_with_options")
+    end
+
+    it "should load script from api url" do
+      @response.should have_xpath("//script[@src='http://api.recaptcha.net/challenge?k=#{Merb::Plugins.config[:merb_recaptcha][:public_key]}']")
+    end
+
+    it "should not send private key to anything" do
+      @response.should_not have_xpath("//*[contains(., '#{Merb::Plugins.config[:merb_recaptcha][:private_key]}')]")
+    end
+
+    it "should not have noscript element" do
+      @response.should_not have_xpath("//noscript")
+    end
+    
+    it "should have RecaptchaOptions array intialization (theme = 'clean', tabindex = 2)" do
+      @response.should have_xpath("//script[contains(., 'var RecaptchaOptions = {\"theme\": \"clean\", \"tabindex\": 2};') or contains(., 'var RecaptchaOptions = {\"tabindex\": 2, \"theme\": \"clean\"};')]")
+    end
+  end
+
+  describe "HTTPS" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "noajax_with_options", {}, { "HTTPS" => "on" })
+    end
+
+    it "should load script from secure api url" do
+      @response.should have_xpath("//script[@src='https://api-secure.recaptcha.net/challenge?k=#{Merb::Plugins.config[:merb_recaptcha][:public_key]}']")
+    end
+
+    it "should not send private key to anything" do
+      @response.should_not have_xpath("//*[contains(., '#{Merb::Plugins.config[:merb_recaptcha][:private_key]}')]")
+    end
+  end
+end

data/spec/recaptcha_noajax_without_noscript_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Recaptcha#noajax_without_noscript" do
+  describe "HTTP" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "noajax_without_noscript")
+    end
+
+    it "should load script from api url" do
+      @response.should have_xpath("//script[@src='http://api.recaptcha.net/challenge?k=#{Merb::Plugins.config[:merb_recaptcha][:public_key]}']")
+    end
+
+    it "should not send private key to anything" do
+      @response.should_not have_xpath("//*[contains(., '#{Merb::Plugins.config[:merb_recaptcha][:private_key]}')]")
+    end
+
+    it "should not have noscript element" do
+      @response.should_not have_xpath("//noscript")
+    end
+    
+    it "should not have RecaptchaOptions array initialization" do
+      @response.should_not have_xpath("//script[contains(., 'var RecaptchaOptions')]")
+    end
+  end
+
+  describe "HTTPS" do
+    before(:each) do
+      @response = dispatch_to(Recaptcha, "noajax_without_noscript", {}, { "HTTPS" => "on" })
+    end
+
+    it "should load script from secure api url" do
+      @response.should have_xpath("//script[@src='https://api-secure.recaptcha.net/challenge?k=#{Merb::Plugins.config[:merb_recaptcha][:public_key]}']")
+    end
+
+    it "should not send private key to anything" do
+      @response.should_not have_xpath("//*[contains(., '#{Merb::Plugins.config[:merb_recaptcha][:private_key]}')]")
+    end
+  end
+end

data/spec/recaptcha_valid_spec.rb

@@ -0,0 +1,97 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+class FakeController < Merb::Controller
+  def check_recaptcha
+    return recaptcha_valid?.to_s
+  end
+end
+
+describe "FakeController#check_recaptcha" do
+  def do_request
+    @response = dispatch_to(FakeController, "check_recaptcha", { :recaptcha_challenge_field => "blabla", :recaptcha_response_field => "blabla" })
+  end
+
+  def stub_response(body)
+    Net::HTTP.stub!(:post_form).and_return mock("Net::HTTPResponse", :body => body)
+  end
+
+  describe "with correct response" do
+    before(:each) do
+      stub_response("true\n")
+    end
+
+    it "should render 'true'" do
+      do_request
+      @response.should have_selector("*:contains('true')")
+    end
+    
+    it "should not raise any exception" do
+      lambda { do_request }.should_not raise_error
+    end
+  end
+
+  describe "with incorrect response" do
+    before(:each) do
+      stub_response("false\nincorrect-captcha-sol\n")
+    end
+
+    it "should render 'false'" do
+      do_request
+      @response.should have_selector("*:contains('false')")
+    end
+    
+    it "should not raise any exception" do
+      lambda { do_request }.should_not raise_error
+    end
+  end
+  
+  describe "with incorrect public key" do
+    before(:each) do
+      stub_response("false\ninvalid-site-public-key\n")
+    end
+
+    it "should raise Merb::Recaptcha::InvalidSitePublicKey" do
+      lambda { do_request }.should raise_error(Merb::Recaptcha::InvalidSitePublicKey)
+    end
+  end
+  
+  describe "with incorrect private key" do
+    before(:each) do
+      stub_response("false\ninvalid-site-private-key\n")
+    end
+
+    it "should raise Merb::Recaptcha::InvalidSitePrivateKey" do
+      lambda { do_request }.should raise_error(Merb::Recaptcha::InvalidSitePrivateKey)
+    end
+  end
+  
+  describe "with invalid request cookie" do
+    before(:each) do
+      stub_response("false\ninvalid-request-cookie\n")
+    end
+
+    it "should raise Merb::Recaptcha::InvalidRequestCookie" do
+      lambda { do_request }.should raise_error(Merb::Recaptcha::InvalidRequestCookie)
+    end
+  end
+
+  describe "with verify parameters incorrect" do
+    before(:each) do
+      stub_response("false\nverify-params-incorrect\n")
+    end
+
+    it "should raise Merb::Recaptcha::VerifyParamsIncorrect" do
+      lambda { do_request }.should raise_error(Merb::Recaptcha::VerifyParamsIncorrect)
+    end
+  end
+
+  describe "with invalid referrer" do
+    before(:each) do
+      stub_response("false\ninvalid-referrer\n")
+    end
+
+    it "should raise Merb::Recaptcha::IvalidReferrer" do
+      lambda { do_request }.should raise_error(Merb::Recaptcha::InvalidReferrer)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'spec'
+require 'merb-core'
+
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'merb-recaptcha')
+
+default_options = {
+  :testing     => true,
+  :adapter     => 'runner',
+  :merb_root   => File.dirname(__FILE__) / 'fixture',
+  :log_stream  => STDOUT
+}
+options = default_options.merge($START_OPTIONS || {})
+
+Merb.disable(:initfile)
+Merb::BootLoader.after_app_loads do
+  Merb::Plugins.config[:merb_recaptcha][:public_key] = "QAAAAAA--public-key--AAAAAAQ"
+  Merb::Plugins.config[:merb_recaptcha][:private_key] = "QAAAAAA--private-key--AAAAAAAQ"
+
+  Merb::Router.prepare { default_routes }
+end
+Merb.start_environment(options)
+
+Spec::Runner.configure do |config|
+  config.include Merb::Test::ViewHelper
+  config.include Merb::Test::RouteHelper
+  config.include Merb::Test::ControllerHelper
+end
+
+describe "ajax recaptcha", :shared => true do
+  it "should invoke Recaptcha.create" do
+    @response.should have_xpath("//script[contains(., 'Recaptcha.create')]")
+  end
+
+  it "should send public key to Recaptcha.create" do
+    @response.should have_xpath("//script[contains(., 'Recaptcha.create') and contains(., '#{Merb::Plugins.config[:merb_recaptcha][:public_key]}')]")
+  end
+
+  it "should not send private key to anything" do
+    @response.should_not have_xpath("//*[contains(., '#{Merb::Plugins.config[:merb_recaptcha][:private_key]}')]")
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: antage-merb-recaptcha
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Anton Ageev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+description: Merb plugin that provides helpers for recaptcha.net service
+email: antage@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- TODO
+- merb-recaptcha.gemspec
+- lib/merb-recaptcha.rb
+- lib/merb-recaptcha/exceptions.rb
+- lib/merb-recaptcha/view_helpers.rb
+- lib/merb-recaptcha/controller_mixin.rb
+- lib/merb-recaptcha/merbtasks.rb
+- spec/spec_helper.rb
+- spec/recaptcha_ajax_with_callback_spec.rb
+- spec/recaptcha_noajax_with_noscript_spec.rb
+- spec/recaptcha_noajax_with_options_spec.rb
+- spec/recaptcha_ajax_spec.rb
+- spec/recaptcha_ajax_with_jquery_spec.rb
+- spec/recaptcha_ajax_with_options_spec.rb
+- spec/recaptcha_noajax_without_noscript_spec.rb
+- spec/recaptcha_valid_spec.rb
+- spec/fixture/app/views/layout/application.html.erb
+- spec/fixture/app/views/recaptcha/ajax_with_callback.html.erb
+- spec/fixture/app/views/recaptcha/noajax_with_noscript.html.erb
+- spec/fixture/app/views/recaptcha/ajax.html.erb
+- spec/fixture/app/views/recaptcha/ajax_with_jquery.html.erb
+- spec/fixture/app/views/recaptcha/noajax_with_options.html.erb
+- spec/fixture/app/views/recaptcha/noajax_without_noscript.html.erb
+- spec/fixture/app/views/recaptcha/ajax_with_options.html.erb
+- spec/fixture/app/views/exceptions/not_acceptable.html.erb
+- spec/fixture/app/views/exceptions/not_found.html.erb
+- spec/fixture/app/controllers/exceptions.rb
+- spec/fixture/app/controllers/application.rb
+- spec/fixture/app/controllers/recaptcha.rb
+- spec/fixture/app/helpers/recaptcha_helpers.rb
+- spec/fixture/app/helpers/global_helpers.rb
+has_rdoc: true
+homepage: http://github.com/antage/merb-recaptcha/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb-recaptcha
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides helpers for recaptcha.net service
+test_files: 
+- spec/spec_helper.rb
+- spec/recaptcha_ajax_with_callback_spec.rb
+- spec/recaptcha_noajax_with_noscript_spec.rb
+- spec/recaptcha_noajax_with_options_spec.rb
+- spec/recaptcha_ajax_spec.rb
+- spec/recaptcha_ajax_with_jquery_spec.rb
+- spec/recaptcha_ajax_with_options_spec.rb
+- spec/recaptcha_noajax_without_noscript_spec.rb
+- spec/recaptcha_valid_spec.rb
+- spec/fixture/app/views/layout/application.html.erb
+- spec/fixture/app/views/recaptcha/ajax_with_callback.html.erb
+- spec/fixture/app/views/recaptcha/noajax_with_noscript.html.erb
+- spec/fixture/app/views/recaptcha/ajax.html.erb
+- spec/fixture/app/views/recaptcha/ajax_with_jquery.html.erb
+- spec/fixture/app/views/recaptcha/noajax_with_options.html.erb
+- spec/fixture/app/views/recaptcha/noajax_without_noscript.html.erb
+- spec/fixture/app/views/recaptcha/ajax_with_options.html.erb
+- spec/fixture/app/views/exceptions/not_acceptable.html.erb
+- spec/fixture/app/views/exceptions/not_found.html.erb
+- spec/fixture/app/controllers/exceptions.rb
+- spec/fixture/app/controllers/application.rb
+- spec/fixture/app/controllers/recaptcha.rb
+- spec/fixture/app/helpers/recaptcha_helpers.rb
+- spec/fixture/app/helpers/global_helpers.rb