rack-recaptcha 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Arthur Chiu
+
+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,17 @@
+= rack-recaptcha
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Arthur. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-recaptcha"
+    gem.summary = %Q{Rack middleware for Recaptcha}
+    gem.description = %Q{Rack middleware Captcha verification using Recaptcha API.}
+    gem.email = "mr.arthur.chiu@gmail.com"
+    gem.homepage = "http://github.com/achiu/rack-recaptcha"
+    gem.authors = ["Arthur Chiu"]
+    gem.add_runtime_dependency "json", ">=0"
+    gem.add_development_dependency "riot", ">= 0"
+    gem.add_development_dependency "rack-test", ">=0"
+    gem.add_development_dependency "rr", ">=0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-recaptcha #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack-recaptcha.rb

@@ -0,0 +1,9 @@
+require 'json'
+
+RECAPTCHA_API_URL        = 'http://api.recaptcha.net'
+RECAPTCHA_API_SECURE_URL = 'https://api-secure.recaptcha.net'
+RECAPTCHA_VERIFY_URL     = 'http://api-verify.recaptcha.net/verify'
+
+
+require File.expand_path(File.join(File.dirname(__FILE__),'rack-recaptcha','recaptcha'))
+require File.expand_path(File.join(File.dirname(__FILE__),'rack-recaptcha','helpers'))

data/lib/rack-recaptcha/helpers.rb

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

data/lib/rack-recaptcha/recaptcha.rb

@@ -0,0 +1,35 @@
+module Rack
+  class Recaptcha
+    attr_reader :options
+    class << self
+      attr_accessor :private_key, :public_key
+    end
+
+    def initialize(app,options = {})
+      @app, @options = app,options
+      self.class.private_key = options[:private_key]
+      self.class.public_key = options[:public_key]
+    end
+
+    def call(env)
+      request = Request.new(env)
+      if request.post? and request.path == @options[:login_path]
+        value, msg = verify(request)
+        env.merge!('recaptcha.value' => value, 'recaptcha.msg' => msg)
+      end
+      @app.call(env)
+    end
+
+    def verify(request)
+      params = {
+        :privatekey => Rack::Recaptcha.private_key,
+        :remoteip => request.ip,
+        :challenge => request.params['recaptcha_challenge_field'],
+        :response =>  request.params['recaptcha_response_field']
+      }
+      response = Net::HTTP.post_form URI.parse(RECAPTCHA_VERIFY_URL), params
+      response.body.split("\n")
+    end
+
+  end
+end

data/test.watchr

@@ -0,0 +1,45 @@
+#
+# 'autotest' for riot
+# install watchr
+# $ sudo gem install watchr
+# 
+# Run With:
+# $ watchr test.watchr
+#
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+
+def run(cmd)
+  puts(cmd)
+  system(cmd)
+end
+
+def run_all_tests
+  system( "rake test" )
+end
+
+def sudo(cmd)
+  run("sudo #{cmd}")
+end
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch("^lib.*/(.*)\.rb") { |m| run("ruby test/#{m[1]}_test.rb") }
+watch("test.*/teststrap\.rb") { run_all_tests }
+watch("^test/(.*)_test\.rb")  { |m| run("ruby test/#{m[1]}_test.rb")}
+
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+ 
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }

data/test/helpers_test.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'teststrap'))
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack-recaptcha','helpers'))
+require 'riot/rr'
+
+class Helper
+  attr_accessor :env
+  include Rack::Recaptcha::Helpers
+end
+
+context "Rack::Recaptcha::Helpers" do
+  setup do
+    Rack::Recaptcha.public_key = '0'*40
+    @helper = Helper.new
+  end
+
+
+  context "recaptcha_tag" do
+
+    context "ajax" do
+      context "with display" do
+        setup { @helper.recaptcha_tag(:ajax,:display => {:theme => 'red'}) }
+        asserts("has js") { topic }.matches %r{recaptcha_ajax.js}
+        asserts("has div") { topic }.matches %r{<div id="ajax_recaptcha"></div>}
+        asserts("has display") { topic }.matches %r{RecaptchaOptions}
+        asserts("has red theme") { topic }.matches %r{"theme":"red"}
+      end
+      context "without display" do
+        setup { @helper.recaptcha_tag(:ajax) }
+        asserts("has js") { topic }.matches %r{recaptcha_ajax.js}
+        asserts("has div") { topic }.matches %r{<div id="ajax_recaptcha"></div>}
+        asserts("has display") { topic =~ %r{RecaptchaOptions} }.not!
+        asserts("has red theme") { topic =~ %r{"theme":"red"} }.not!
+      end
+    end
+
+    context "noscript" do
+      setup { @helper.recaptcha_tag :noscript, :public_key => "hello_world_world" }
+      asserts("iframe") { topic }.matches %r{iframe}
+      asserts("no script tag") { topic }.matches %r{<noscript>}
+      asserts("public key") { topic }.matches %r{hello_world_world}
+      asserts("has js") { topic =~ %r{recaptcha_ajax.js} }.not!
+    end
+
+    context "challenge" do
+      setup { @helper.recaptcha_tag(:challenge) }
+      asserts("has script tag") { topic }.matches %r{script}
+      asserts("has challenge js") { topic }.matches %r{challenge}
+      asserts("has js") { topic =~ %r{recaptcha_ajax.js} }.not!
+      asserts("has display") { topic =~ %r{RecaptchaOptions} }.not!
+      asserts("has public_key") { topic }.matches %r{#{'0'*40}}
+    end
+
+    context "server" do
+      asserts("using ssl url") { @helper.recaptcha_tag(:challenge, :ssl => true) }.matches %r{https://api-secure.recaptcha.net}
+      asserts("using non ssl url") { @helper.recaptcha_tag(:ajax) }.matches %r{http://api.recaptcha.net}
+    end
+
+  end
+
+  context "verified?" do
+    
+    context "passing" do
+      setup do
+        mock(@helper.env).[]('recaptcha.value').returns('true')
+        @helper.verified?
+      end
+      asserts_topic
+    end
+
+    context "failing" do
+      setup do
+        mock(@helper.env).[]('recaptcha.value').returns('false')
+        @helper.verified?
+      end
+      asserts_topic.not!
+    end
+
+  end
+end

data/test/recaptcha_test.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'teststrap'))
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+context "Rack::Recaptcha" do
+
+  context "basic request" do
+    setup { get("/")}
+    asserts("status is 200") { last_response.status }.equals 200
+    asserts("body is hello world") { last_response.body }.equals 'Hello world'
+  end
+
+  context "exposes" do
+    setup { Rack::Recaptcha }
+    asserts("private key") { topic.private_key }.equals PRIVATE_KEY
+    asserts("public key") { topic.public_key }.equals PUBLIC_KEY
+  end
+
+  context "login path" do
+
+    context "get" do
+      setup { get('/login') }
+      asserts("get login") { last_response.body }.equals 'login'
+    end
+
+    context "post pass" do
+      setup do
+        FakeWeb.register_uri(:post, RECAPTCHA_VERIFY_URL, :body => "true\nsuccess")
+        post("/login")
+      end
+      asserts("post login") { last_response.body }.equals 'post login'
+    end
+
+    context "post fail" do
+      setup do
+        FakeWeb.register_uri(:post, RECAPTCHA_VERIFY_URL, :body => "false\nfailed")
+        post("/login")
+      end
+      asserts("post fail") { last_response.body }.equals 'post fail'
+    end
+  end
+
+end

data/test/teststrap.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rack/test'
+require 'rack/mock'
+require 'rack/utils'
+require 'rack/session/cookie'
+require 'rack/builder'
+require 'rr'
+require 'riot'
+require 'riot/rr'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack-recaptcha'))
+
+PUBLIC_KEY = '0'*40
+PRIVATE_KEY = 'X'*40
+
+class Riot::Situation
+  include Rack::Test::Methods
+
+  def app
+    main_app = lambda { |env|
+      request = Rack::Request.new(env)
+      return_code, body_text =
+      case request.path
+      when '/' then [200,'Hello world']
+      when '/login'
+        if request.post?
+          env['recaptcha.value'] == 'true' ? [200, 'post login'] : [200, 'post fail']
+        else
+          [200,'login']
+        end
+      else
+        [404,'Nothing here']
+      end
+      [return_code,{'Content-type' => 'text/plain'}, body_text]
+    }
+
+    builder = Rack::Builder.new
+    builder.use Rack::Recaptcha, :private_key => PRIVATE_KEY, :public_key => PUBLIC_KEY, :login_path => '/login'
+    builder.run main_app
+    builder.to_app
+  end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: rack-recaptcha
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: riot
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Rack middleware Captcha verification using Recaptcha API.
+email: mr.arthur.chiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-recaptcha.rb
+- lib/rack-recaptcha/helpers.rb
+- lib/rack-recaptcha/recaptcha.rb
+- test.watchr
+- test/helpers_test.rb
+- test/recaptcha_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://github.com/achiu/rack-recaptcha
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rack middleware for Recaptcha
+test_files: 
+- test/helpers_test.rb
+- test/recaptcha_test.rb
+- test/teststrap.rb