simple_recaptcha 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+gem "rake"
+gem "minitest", :platform => :ruby_18

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Wojciech Wnętrzak
+
+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.md

@@ -0,0 +1,32 @@
+# Simple Recaptcha
+
+Ruby library for [reCAPTCHA](http://www.google.com/recaptcha)
+
+## Usage
+
+```ruby
+require "simple_recaptcha"
+
+SimpleRecaptcha.verify(:private_key => "your-private-key", :ip => "127.0.0.1", :challenge => "challengestring", :response => "user input")
+```
+
+All 4 attributes must be specified: `:private_key`, `:ip`, `:challenge`, `:response`
+
+### Configuration
+
+You can configure Simple Recaptcha in two different ways:
+
+```ruby
+SimpleRecaptcha.private_key = "your-private-key"
+
+SimpleRecaptcha.configure do |confg|
+  config.private_key = "your-private-key"
+  config.public_key = "your-public-key"
+end
+```
+
+You can set `public_key` for consistency, however it is not used during verification
+
+## Copyright
+
+Copyright © 2011 Wojciech Wnętrzak. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/lib/simple_recaptcha.rb

@@ -0,0 +1,24 @@
+require "forwardable"
+
+require "simple_recaptcha/version"
+require "simple_recaptcha/client"
+
+module SimpleRecaptcha
+  VERIFY_URL = "http://www.google.com/recaptcha/api/verify"
+
+  class << self
+    extend Forwardable
+
+    attr_accessor :public_key, :private_key
+
+    def_delegators :client, :verify
+
+    def configure
+      yield self
+    end
+
+    def client
+      @client ||= SimpleRecaptcha::Client.new
+    end
+  end
+end

data/lib/simple_recaptcha/client.rb

@@ -0,0 +1,50 @@
+require "net/http"
+
+class SimpleRecaptcha::Client
+  attr_accessor :ip, :challenge, :response
+  attr_writer :private_key
+  attr_reader :message
+
+  def private_key
+    @private_key ||= SimpleRecaptcha.private_key
+  end
+
+  def verified
+    !!@verified
+  end
+  alias :verified? :verified
+
+  def verify(attributes = {})
+    self.attributes = attributes
+    parse_response if valid?
+    verified?
+  end
+
+  def attributes=(attributes)
+    attributes.each { |key, value| send("#{key}=", value) }
+  end
+
+  def request
+    Net::HTTP.post_form(URI.parse(SimpleRecaptcha::VERIFY_URL), params)
+  end
+
+  def parse_response
+    @verified, @message = request.body.split("\n")
+    @verified = @verified == "true" ? true : false
+  end
+
+  def valid?
+    ["privatekey", "remoteip", "challenge", "response"].none? { |p| params[p].nil? }
+  end
+
+  private
+
+  def params
+    {
+      "privatekey" => private_key,
+      "remoteip"   => ip,
+      "challenge"  => challenge,
+      "response"   => response
+    }
+  end
+end

data/lib/simple_recaptcha/version.rb

@@ -0,0 +1,3 @@
+module SimpleRecaptcha
+  VERSION = "0.0.1"
+end

data/simple_recaptcha.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simple_recaptcha/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Wojciech Wnętrzak"]
+  gem.email         = ["w.wnetrzak@gmail.com"]
+  gem.description   = %q{Simple Google reCAPTCHA library}
+  gem.summary       = %q{Google reCAPTCHA library}
+  gem.homepage      = "https://github.com/objectreload/simple_recaptcha"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "simple_recaptcha"
+  gem.require_paths = ['lib']
+  gem.version       = SimpleRecaptcha::VERSION
+
+  gem.add_development_dependency "mocha"
+end

data/test/client_test.rb

@@ -0,0 +1,109 @@
+require "helper"
+
+describe SimpleRecaptcha::Client do
+  before do
+    @attributes = {:ip => "127.0.0.1", :challenge => "challenge", :response => "response", :private_key => "private_key"}
+    @recaptcha = SimpleRecaptcha::Client.new
+  end
+
+  it "should set attributes on verification" do
+    mock_http
+    @recaptcha.verify(@attributes)
+    @recaptcha.ip.must_equal "127.0.0.1"
+    @recaptcha.challenge.must_equal "challenge"
+    @recaptcha.response.must_equal "response"
+    @recaptcha.private_key.must_equal "private_key"
+  end
+
+  it "should be valid with all attributes set" do
+    @recaptcha.attributes = @attributes
+    @recaptcha.valid?.must_equal true
+  end
+
+  it "should be invalid without ip attribute" do
+    @attributes.delete(:ip)
+    @recaptcha.attributes = @attributes
+    @recaptcha.valid?.wont_equal true
+  end
+
+  it "should be invalid without challenge attribute" do
+    @attributes.delete(:challenge)
+    @recaptcha.attributes = @attributes
+    @recaptcha.valid?.wont_equal true
+  end
+
+  it "should be invalid without respnse attribute" do
+    @attributes.delete(:response)
+    @recaptcha.attributes = @attributes
+    @recaptcha.valid?.wont_equal true
+  end
+
+  it "should be invalid without private_key attribute" do
+    @attributes.delete(:private_key)
+    @recaptcha.attributes = @attributes
+    @recaptcha.valid?.wont_equal true
+  end
+
+  it "should use module private key when not set on instance level" do
+    SimpleRecaptcha.private_key = "moduleprivate"
+    recaptcha = SimpleRecaptcha::Client.new
+    recaptcha.private_key.must_equal "moduleprivate"
+  end
+
+  it "should overwrite module private key on verification" do
+    SimpleRecaptcha.private_key = "moduleprivate"
+    mock_http
+    @attributes[:private_key] = "instanceprivate"
+    recaptcha = SimpleRecaptcha::Client.new
+    recaptcha.verify(@attributes)
+    recaptcha.private_key.must_equal "instanceprivate"
+  end
+
+  it "should return true if verified" do
+    @recaptcha.attributes = @attributes
+    mock_http("true\n")
+    @recaptcha.verify.must_equal true
+  end
+
+  it "should be able to check if verified" do
+    @recaptcha.attributes = @attributes
+    mock_http("true\n")
+    @recaptcha.verify
+    @recaptcha.verified.must_equal true
+    @recaptcha.verified?.must_equal true
+  end
+
+  it "should not request when not valid" do
+    @recaptcha.attributes = @attributes
+    @recaptcha.stubs(:valid?).returns(false)
+    @recaptcha.expects(:request).never
+    @recaptcha.verify
+  end
+
+  it "should return false when not valid during verification" do
+    @recaptcha.attributes = @attributes
+    @recaptcha.stubs(:valid?).returns(false)
+    @recaptcha.verify.wont_equal true
+  end
+
+  it "should return false when not verified" do
+    @recaptcha.attributes = @attributes
+    mock_http("false\ninvalid-request-cookie")
+    @recaptcha.verify.wont_equal true
+  end
+
+  it "should be able to check if not verified" do
+    @recaptcha.attributes = @attributes
+    mock_http("false\ninvalid-request-cookie")
+    @recaptcha.verify
+    @recaptcha.verified.wont_equal true
+    @recaptcha.verified?.wont_equal true
+  end
+
+  it "should be able to read message from not verified response" do
+    @recaptcha.attributes = @attributes
+    mock_http("false\ninvalid-request-cookie")
+    @recaptcha.verify
+    @recaptcha.message.must_equal "invalid-request-cookie"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require "minitest/autorun"
+require "mocha"
+
+require "simple_recaptcha"
+
+class MiniTest::Unit::TestCase
+  def teardown
+    SimpleRecaptcha.public_key = nil
+    SimpleRecaptcha.private_key = nil
+  end
+
+  def mock_http(body = "false\ninvalid-request-cookie")
+    http = mock("Net::HTTPOK")
+    http.stubs(:body => body)
+    Net::HTTP.stubs(:post_form).returns(http)
+  end
+end

data/test/simple_recaptcha_test.rb

@@ -0,0 +1,31 @@
+require "helper"
+
+describe SimpleRecaptcha do
+  it "should be possible to set private key on module level" do
+    SimpleRecaptcha.private_key = "private"
+    SimpleRecaptcha.private_key.must_equal "private"
+  end
+
+  it "should be possible to set public key on module level" do
+    SimpleRecaptcha.public_key = "public"
+    SimpleRecaptcha.public_key.must_equal "public"
+  end
+
+  it "should be possible to configure via block" do
+    SimpleRecaptcha.configure do |config|
+      config.private_key = "privateviablock"
+      config.public_key = "publicviablock"
+    end
+    SimpleRecaptcha.public_key.must_equal "publicviablock"
+    SimpleRecaptcha.private_key.must_equal "privateviablock"
+  end
+
+  it "should be possible to call client on module level" do
+    SimpleRecaptcha.client.must_be_kind_of SimpleRecaptcha::Client
+  end
+
+  it "should be possible to verify on module level" do
+    mock_http("true\n")
+    SimpleRecaptcha.verify(:ip => "127.0.0.1", :challenge => "challenge", :response => "response", :private_key => "privatekey").must_equal true
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: simple_recaptcha
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Wojciech Wnętrzak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &16261820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16261820
+description: Simple Google reCAPTCHA library
+email:
+- w.wnetrzak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simple_recaptcha.rb
+- lib/simple_recaptcha/client.rb
+- lib/simple_recaptcha/version.rb
+- simple_recaptcha.gemspec
+- test/client_test.rb
+- test/helper.rb
+- test/simple_recaptcha_test.rb
+homepage: https://github.com/objectreload/simple_recaptcha
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Google reCAPTCHA library
+test_files: []