rack-recaptcha 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,95 @@
+# rack-recaptcha
+
+Drop this Rack middleware in your web application to enable CAPTCHA verification via Recaptcha API.
+
+## How to Use
+
+### Configuration
+
+First, install the library with:
+    [sudo] gem install rack-recaptcha
+
+You have to require 'rack-recaptcha' in your gemfile.
+
+    ## Gemfile
+    gem 'rack-recaptcha', :require => 'rack/recaptcha'
+    
+    
+    Available options for `Rack::Recaptcha` middleware are:
+
+    * :public_key -- your ReCaptcha API public key *(required)*
+    * :private_key -- your ReCaptcha API private key *(required)*
+    * :login_path -- where user goes to login or access the recaptcha   
+
+
+Now configure your app to use the middleware. This might be different across each web framework.
+
+#### Sinatra
+
+    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :login_path => 'PATH'
+    helpers Rack::Recaptcha::Helpers
+
+#### Padrino
+
+    ## app/app.rb
+    use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :login_path => 'PATH'
+    helpers Rack::Recaptcha::Helpers
+
+
+#### Rails
+
+    ## environment.rb:
+    config.middleware.use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET', :login_path => 'PATH'
+
+    ## application_controller.rb
+    include Rack::Recaptcha::Helpers
+
+### Helpers
+
+The `Rack::Recaptcha::Helpers` module (for Sinatra, Rails, Padrino) adds these methods to your app:
+
+* `recaptcha_tag(type,options={})` -- generates the appropriate recaptcha scripts. must be included in a form_tag
+  - recaptcha\_tag(:challenge) => generates a recaptcha script
+  - recaptcha\_tag(:ajax) => generates an ajax recaptcha script
+    - if passed in a :display option, you can further alter the recaptcha\_tag
+      - recaptcha\_tag(:ajax, :display => {:theme => 'white'}) - recaptcha tag in white theme.
+  - recaptcha\_tag(:noscript) => generates a recaptcha noscript
+  - you can also pass in :public\_key manually as well.
+    - recaptcha\_tag(:challenge,:public\_key => 'PUBLIC')
+
+* `verified?` -- returns whether or not the verification passed.
+
+#### Example
+
+In Padrino, here's how you would use the helpers.
+
+    ## new.haml
+    - form_tag '/login', :class => 'some_form', :method => 'post' do
+      = text_field_tag :email
+      = password_field_tag :password
+      = recaptcha_tag(:challenge)
+      = submit_tag "Submit"
+      
+    ## sessions.rb
+    post :create, :map => '/login' do
+      if verified?
+        "passed!"
+        else
+        "failed!"
+      end
+    end
+
+
+== 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 Chiu. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/{rack-recaptcha → rack}/recaptcha.rb

@@ -1,3 +1,11 @@
+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__),'recaptcha','helpers'))
+
 module Rack
   class Recaptcha
     attr_reader :options
@@ -32,4 +40,4 @@ module Rack
     end
 
   end
-end
+end

data/rack-recaptcha.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-recaptcha}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Arthur Chiu"]
+  s.date = %q{2010-04-22}
+  s.description = %q{Rack middleware Captcha verification using Recaptcha API.}
+  s.email = %q{mr.arthur.chiu@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/rack/recaptcha.rb",
+     "lib/rack/recaptcha/helpers.rb",
+     "rack-recaptcha.gemspec",
+     "test.watchr",
+     "test/helpers_test.rb",
+     "test/recaptcha_test.rb",
+     "test/teststrap.rb"
+  ]
+  s.homepage = %q{http://github.com/achiu/rack-recaptcha}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Rack middleware for Recaptcha}
+  s.test_files = [
+    "test/helpers_test.rb",
+     "test/recaptcha_test.rb",
+     "test/teststrap.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<json>, [">= 0"])
+      s.add_development_dependency(%q<riot>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<riot>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<riot>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+  end
+end
+

data/test/helpers_test.rb

@@ -1,5 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__),'teststrap'))
-require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack-recaptcha','helpers'))
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack','recaptcha','helpers'))
 require 'riot/rr'
 
 class Helper

data/test/teststrap.rb

@@ -7,7 +7,7 @@ require 'rack/builder'
 require 'rr'
 require 'riot'
 require 'riot/rr'
-require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack-recaptcha'))
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','rack','recaptcha'))
 
 PUBLIC_KEY = '0'*40
 PRIVATE_KEY = 'X'*40

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Arthur Chiu
@@ -73,17 +73,17 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
-- lib/rack-recaptcha.rb
-- lib/rack-recaptcha/helpers.rb
-- lib/rack-recaptcha/recaptcha.rb
+- lib/rack/recaptcha.rb
+- lib/rack/recaptcha/helpers.rb
+- rack-recaptcha.gemspec
 - test.watchr
 - test/helpers_test.rb
 - test/recaptcha_test.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= 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/lib/rack-recaptcha.rb

@@ -1,9 +0,0 @@
-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'))