acts_as_recaptcha 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.rdoc

@@ -0,0 +1,55 @@
+
+=Acts As Recaptcha
+acts_as_recaptcha is a fork of recaptcha, and a rather shameless copy of the method used in the awesome acts_as_textcaptcha gem. This collab brings recaptcha integration with a rails app almost as easy as the integration of the textcaptcha gem, minus some annoying stuff forced by google's horrible recaptcha API.
+
+==Usage
+install: in your gemfile:
+
+  gem "acts_as_recaptcha", :git => "git://github.com/unorthodoxgeek/acts_as_recaptcha.git"
+
+
+first, create a recaptcha.yml file in your config folder, put your private and public keys you get from https://www.google.com/recaptcha/admin/create
+
+  development:
+    private_key: "priv_key"
+    public_key: "pub_key"
+    locale: "he"
+  test:
+    private_key: "priv_key"
+    public_key: "pub_key"
+  production:
+    private_key: "priv_key"
+    public_key: "pub_key"
+
+in the model, simply declare acts_as_recaptcha. This will add the neccesary validations. If you wish to add some logic to showing the captcha, you can override the perform_textcaptcha? method:
+
+
+  def perform textcaptcha?
+  	return (true or false)
+  end
+
+
+did I mention the recaptcha plugin sucks? well, it does. there's no problem to fill in the answer in the right place, but the encrypted answer to check against has to be inside a form element named "recaptcha_challenge_field", which can't be renamed (I tried...), so when we create the object in the controller, we need to put that in the right place. so in the create / update of your object you need to do something like this:
+
+  message_params = params[:message].merge({:recaptcha_challenge => params[:recaptcha_challenge_field], :recaptcha_remote_ip => request.remote_ip })
+  Message.create(message_params)
+
+
+==To show the captcha:
+inside the <%= form_for(whatever) do |f| %> declare a second block:
+
+  <%= recaptcha_fields(f) do -%>
+    <%= recaptcha_image %>
+    <%= f.text_field :recaptcha_answer, :id => "recaptcha_response_field", :dir => "ltr" %> #note that the ID must be "recaptcha_response_field"
+    <a href="javascript:Recaptcha.reload()>Too hard! give me another!</a>
+  <% end %>
+
+it's very recommended you add the refresh element, because recaptcha can be quite impossible to solve for normal mortal beings. you can use anything inside that link, of course.
+This gem uses the custom theme, so you can design it however you wish.
+
+==Want to be an awesome person?
+this gem is very simplistic now, and could use more work, If you want to add some awesomeness, you're more than welcome to fork, do your thing and issue a pull request.
+here's a short TODO list:
+* Write tests
+* Add option to use recaptcha's default themes, right now we use the custom theme
+* Make the gem backward compatible with Rails 2.x

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/acts_as_recaptcha.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_recaptcha/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_recaptcha"
+  s.version     = ActsAsRecaptcha::VERSION
+  s.authors     = ["Tom Caspy"]
+  s.email       = ["tom@sir.co.il"]
+  s.homepage    = ""
+  s.summary     = %q{Simple recaptcha plugin}
+  s.description = %q{Simple recaptcha plugin which allows to add reCAPTCHA validations to your forms}
+
+  s.rubyforge_project = "acts_as_recaptcha"
+
+  s.add_dependency "rails", "~> 3.1.0"
+  s.add_development_dependency "rspec", "~> 2.6"
+
+  s.files         = `git ls-files`.split("\n")
+  # s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/acts_as_recaptcha.rb

@@ -0,0 +1,4 @@
+require "acts_as_recaptcha/recaptcha_helper"
+require "acts_as_recaptcha/validator"
+require "acts_as_recaptcha/acts_as_recaptcha"
+require "acts_as_recaptcha/rails"

data/lib/acts_as_recaptcha/acts_as_recaptcha.rb

@@ -0,0 +1,63 @@
+module ActsAsRecaptcha
+	module Recaptcha
+
+		def acts_as_recaptcha(options = nil)
+			cattr_accessor :recaptcha_config
+			attr_accessor  :recaptcha_answer, :recaptcha_challenge, :skip_recaptcha, :recaptcha_remote_ip
+
+			if respond_to?(:accessible_attributes)
+				if accessible_attributes.nil?
+					attr_protected :skip_recaptcha
+				else
+					attr_accessible :recaptcha_answer, :recaptcha_challenge, :recaptcha_remote_ip
+				end
+			end
+
+			validate :validate_recaptcha
+
+			if options.is_a?(Hash)
+				self.recaptcha_config = options.symbolize_keys!
+			else
+				begin
+					self.recaptcha_config = YAML.load(File.read("#{Rails.root ? Rails.root.to_s : '.'}/config/recaptcha.yml"))[Rails.env].symbolize_keys!
+				rescue
+					raise 'could not find any recaptcha options, in config/recaptcha.yml or model'
+				end
+			end
+			
+			include InstanceMethods
+		end
+
+		module InstanceMethods
+
+			# rewrite this method in your model if you want to add logic
+			# to whether to show this of not.
+
+			def perform_recaptcha?
+				true
+			end
+
+			protected
+
+			def validate_recaptcha
+				# only spam check on new/unsaved records (ie. no spam check on updates/edits)
+				if !respond_to?('new_record?') || new_record?
+					if perform_recaptcha? && !validate_recaptcha_answer
+						errors.add(:recaptcha_answer, :incorrect_answer, :message => "is incorrect, try another question instead")
+						return false
+					end
+				end
+				true
+			end
+
+			def validate_recaptcha_answer
+        status, error = Validator.validate_recaptcha(recaptcha_challenge, recaptcha_answer, recaptcha_remote_ip, self.recaptcha_config[:private_key])
+        if status == "false"
+          return false
+        end
+        return true
+      end
+
+		end
+	end
+end

data/lib/acts_as_recaptcha/rails.rb

@@ -0,0 +1,4 @@
+ActiveRecord::Base.extend ActsAsRecaptcha::Recaptcha
+ActiveSupport.on_load(:action_view) do
+  include ActsAsRecaptcha::RecaptchaHelper
+end

data/lib/acts_as_recaptcha/recaptcha_helper.rb

@@ -0,0 +1,44 @@
+module ActsAsRecaptcha
+	module RecaptchaHelper
+
+		def recaptcha_image
+			"<div id=\"recaptcha_image\"></div>".html_safe
+		end
+
+		def recaptcha_fields(f, &block)
+			model        = f.object
+			captcha_html = "
+			<script type=\"text/javascript\">
+ var RecaptchaOptions = {
+ 		#{"lang: '#{model.recaptcha_config[:locale]}'," if model.recaptcha_config[:locale].present?}
+    theme : 'custom',
+    custom_theme_widget: 'recaptcha_widget'
+ };
+
+ </script>
+<div id=\"recaptcha_widget\" style=\"display:none\">
+			"
+captcha_scripts = "<script type=\"text/javascript\"
+					src=\"http://www.google.com/recaptcha/api/challenge?k=#{model.recaptcha_config[:public_key]}\">
+				</script>
+				<noscript>
+					<iframe src=\"http://www.google.com/recaptcha/api/noscript?k=#{model.recaptcha_config[:public_key]}\"
+						height=\"300\" width=\"500\" frameborder=\"0\"></iframe>
+						<input type=\"hidden\" name=\"recaptcha_response_field\" value=\"manual_challenge\">
+				</noscript>"
+			if model.perform_recaptcha?
+				captcha_html += capture(&block)
+				captcha_html += "</div>"
+				captcha_html += captcha_scripts
+			end
+
+			# Rails 2 compatability
+			if Rails::VERSION::MAJOR < 3
+				concat captcha_html, &block.binding
+			else
+				captcha_html.html_safe
+			end
+		end
+
+	end
+end

data/lib/acts_as_recaptcha/validator.rb

@@ -0,0 +1,18 @@
+require "net/http"
+require "uri"
+
+module ActsAsRecaptcha
+  module Validator
+    def self.validate_recaptcha(challenge, response, remoteip, private_key = ENV['RECAPTCHA_PRIVATE_KEY'] )
+      uri = URI.parse("http://www.google.com/recaptcha/api/verify")
+      params = {
+        :privatekey => private_key,
+        :challenge => challenge,
+        :response => response,
+        :remoteip => remoteip
+      }
+
+      Net::HTTP.post_form(uri, params).body.split("\n")
+    end
+  end
+end

data/lib/acts_as_recaptcha/version.rb

@@ -0,0 +1,3 @@
+module ActsAsRecaptcha
+  VERSION = "0.0.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require "recaptcha"

data/spec/validator_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+require "rspec/mocks/standalone"
+
+describe Recaptcha::Validator do
+  describe "validate_recaptcha" do
+    it "takes 3 args" do
+      expect{ Recaptcha::Validator.validate_recaptcha("first", "second", "third") }.to_not raise_error(ArgumentError)
+    end
+
+    context "returns a series of strings seperated by \\n" do
+      context "when captcha solution correct" do
+        it "returns true" do
+          Net::HTTP.stub_chain(:post_form, :body).and_return("true")
+          Recaptcha::Validator.validate_recaptcha("1", "2", "3").should == ["true"]
+        end
+      end
+
+      context "when incorrect recaptcha key" do
+        it "returns false and invalid-site-private-key" do
+          Net::HTTP.stub_chain(:post_form, :body).and_return("false\ninvalid-site-private-key")
+          Recaptcha::Validator.validate_recaptcha("1", "2", "3").should == ["false", "invalid-site-private-key"]
+        end
+      end
+
+      context "when challenge param incorrect" do
+        it "returns false and invalid-request-cookie" do
+          Net::HTTP.stub_chain(:post_form, :body).and_return("false\ninvalid-request-cookie")
+          Recaptcha::Validator.validate_recaptcha("1", "2", "3").should == ["false", "invalid-request-cookie"]
+        end
+      end
+
+      context "when captcha solution incorrect" do
+        it "returns false and incorrect-captcha-sol" do
+          Net::HTTP.stub_chain(:post_form, :body).and_return("false\nincorrect-captcha-sol")
+          Recaptcha::Validator.validate_recaptcha("1", "2", "3").should == ["false", "incorrect-captcha-sol"]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_recaptcha
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Tom Caspy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70247500577860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70247500577860
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70247500577360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70247500577360
+description: Simple recaptcha plugin which allows to add reCAPTCHA validations to
+  your forms
+email:
+- tom@sir.co.il
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- acts_as_recaptcha.gemspec
+- lib/acts_as_recaptcha.rb
+- lib/acts_as_recaptcha/acts_as_recaptcha.rb
+- lib/acts_as_recaptcha/rails.rb
+- lib/acts_as_recaptcha/recaptcha_helper.rb
+- lib/acts_as_recaptcha/validator.rb
+- lib/acts_as_recaptcha/version.rb
+- spec/spec_helper.rb
+- spec/validator_spec.rb
+homepage: ''
+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: acts_as_recaptcha
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple recaptcha plugin
+test_files: []