recaptchaed 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Dave Paroulek
+
+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

@@ -0,0 +1,121 @@
+Recaptchaed
+==========
+
+Rails Plugin for adding "recaptcha(recaptcha)":http://www.google.com/recaptcha to a form. 
+
+Install
+==========
+
+# First, go to "recaptcha(recaptcha)":http://www.google.com/recaptcha and sign up for a api key.
+
+# Next, install the recaptchaed gem: 
+
+@gem install recaptchaed@
+
+# Tell Rails to use the gem
+
+Open config/environment.rb and enter the following: 
+
+@config.gem "recaptchaed"@
+
+# Run the generator to create config files and to add customizable error messages
+
+@script/generate recaptchaed@
+
+If it runs successfully, you should see the following: 
+
+@
+      create  config/recaptchaed.yml
+      create  config/initializers/recaptchaed.rb
+      added  recaptcha i18n error message to config/locales/en.yml
+@
+
+# Edit the config/recaptcaed.yml file and add your personal recaptcha public and private api keys
+
+Uninstall
+==========
+
+# Run script/destroy recaptchaed
+
+# remove any related custom logic from your views and controllers
+
+Example Usage
+=============
+
+This example shows how to protect a comment model with a recaptcha
+
+# Include the recaptcha javascript library in app/views/layouts/comments.html.erb. 
+
+@<%=javascript_include_tag 'http://www.google.com/recaptcha/api/js/recaptcha_ajax.js' %>@
+
+# Add the recaptcha markup to the app/views/comments/new.html.erb. 
+
+@<h1>New comment</h1>
+
+<% form_for(@comment) do |f| %>
+  <%= f.error_messages %>
+
+  <p>
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </p>
+  <p>
+    <%= f.label :body %><br />
+    <%= f.text_area :body %>
+  </p>
+  <%= recaptcha_tag (RECAPTCHAED["RECAPTCHA_PUBLIC_KEY"], "recaptcha_div", "blackglass") %>
+  <p>
+    <%= f.submit 'Create' %>
+  </p>
+<% end %>
+
+<%= link_to 'Back', comments_path %>
+@
+
+The "recaptcha site(recaptcha)":http://code.google.com/apis/recaptcha/docs/customization.html has several options for different themes/styles. For example, you can change the theme of the recaptcha to 'white' by passing a different theme string.
+
+@  <%= recaptcha_tag (RECAPTCHAED["RECAPTCHA_PUBLIC_KEY"], "recaptcha_div", "white") %> @
+
+# Add logic to create action inside the comments controller to validate the captcha. 
+
+First, include the library in the comments controller: 
+
+@
+class CommentsController < ApplicationController
+  include Recaptchaed
+  ...rest of controller...
+end
+@
+
+Then, protect the create method using the 'validate_captcha(..)' method
+
+@ 
+  # POST /comments
+  # POST /comments.xml
+  def create
+    @comment = Comment.new(params[:comment])
+
+    @recaptcha = validate_captcha(RECAPTCHAED["RECAPTCHA_PRIVATE_KEY"], request.remote_ip, params['recaptcha_challenge_field'], params['recaptcha_response_field'])
+
+    respond_to do |format|
+      if @recaptcha && @recaptcha['success'] && @comment.save	
+        flash[:notice] = 'Comment was successfully created.'
+        format.html { redirect_to(@comment) }
+        format.xml  { render :xml => @comment, :status => :created, :location => @comment }
+      else
+        if(!@recaptcha['success'])
+          @comment.errors.add('recaptcha_response_field', :"recaptcha.invalid")
+        end
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @comment.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+@
+
+When a user fails to enter the correct captcha, the error message that is displayed is defined inside 'config/locales/en.yml'. Feel free to update that to whatever you like. And, it can also be internationalized, if needed. 
+
+Enjoy!
+
+http://upgradingdave.com
+Copyright (c) 2010 Dave Paroulek, released under the MIT license

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: gem'
+task :default => :gem
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'spec/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "recaptchaed"
+  s.version = "1.0.0"
+  s.author = "Dave Paroulek"
+  s.email = "dave@daveparoulek.com"
+  s.homepage = "http://upgradingdave.com"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Rails Plugin that makes it super easy to add recaptcha to any model form"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc 'Generate documentation for the recaptchaed plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Recaptchaed'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/recaptchaed/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Configures the recaptchaed gem rails plugin.
+
+Usage:
+    ./script/generate recaptchaed
+
+    This will create:
+        config/recaptchaed.yml
+	config/initializers/recaptchaed.rb
+ 
+    And this also adds an i18n error message to the config/locales/en.yml file
+
+
+    ./script/destroy recaptchaed will undo everything that generate created and/or added

data/generators/recaptchaed/recaptchaed_generator.rb

@@ -0,0 +1,69 @@
+require 'rails_generator'
+require 'rails_generator/commands'
+
+module Recaptchaed #:nodoc:
+  module Generator #:nodoc:
+    module Commands #:nodoc:
+# This is the text we want to apped to the end of config/locales/en.yml: 
+CONTENT = <<END
+
+en:  
+  activerecord:
+    errors:
+      full_messages: 
+        recaptcha:
+          invalid: "{{message}}"
+      models:
+        comment:
+          attributes:
+            recaptcha_response_field:
+              recaptcha:
+                invalid: "The characters you entered didn't quite match up to the image. Please make sure to match the letters in the image exactly."
+END
+
+      I18N_PATH = 'config/locales/en.yml'
+
+      module Create
+        def recaptcha_i18n
+          logger.added "recaptcha i18n error message to #{I18N_PATH}"
+          look_for = '$'
+          unless options[:pretend]
+            gsub_file(I18N_PATH, /\z/mi){|match| "#{match}\n  #{CONTENT}\n"}
+          end
+        end
+      end
+
+      module Destroy
+        def recaptcha_i18n
+          logger.removed "recaptcha i18n error message from #{I18N_PATH}"
+          gsub_file I18N_PATH, /#{Regexp.escape(CONTENT)}/mi, ''
+        end
+      end
+
+      module List
+        def recaptcha_i18n
+        end
+      end
+
+      module Update
+        def recaptcha_i18n
+        end
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Create.send   :include,  Recaptchaed::Generator::Commands::Create
+Rails::Generator::Commands::Destroy.send  :include,  Recaptchaed::Generator::Commands::Destroy
+Rails::Generator::Commands::List.send     :include,  Recaptchaed::Generator::Commands::List
+Rails::Generator::Commands::Update.send   :include,  Recaptchaed::Generator::Commands::Update
+
+class RecaptchaedGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file "recaptchaed.yml", "config/recaptchaed.yml"
+      m.file "recaptchaed.rb", "config/initializers/recaptchaed.rb"
+      m.recaptcha_i18n
+    end
+  end
+end

data/generators/recaptchaed/templates/recaptchaed.rb

@@ -0,0 +1 @@
+RECAPTCHAED = YAML.load_file("#{RAILS_ROOT}/config/recaptchaed.yml")[RAILS_ENV]

data/generators/recaptchaed/templates/recaptchaed.yml

@@ -0,0 +1,14 @@
+development:
+  RECAPTCHA_ENABLED: true
+  RECAPTCHA_PUBLIC_KEY: your recaptcha private key here
+  RECAPTCHA_PRIVATE_KEY: your recaptcha private key here
+
+test:
+  RECAPTCHA_ENABLED: false
+  RECAPTCHA_PUBLIC_KEY: your recaptcha private key here
+  RECAPTCHA_PRIVATE_KEY: your recaptcha private key here
+
+production:
+  RECAPTCHA_ENABLED: true
+  RECAPTCHA_PUBLIC_KEY: your recaptcha private key here
+  RECAPTCHA_PRIVATE_KEY: your recaptcha private key here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/recaptchaed.rb

@@ -0,0 +1 @@
+require 'recaptchaed/recaptchaed'

data/lib/recaptchaed/recaptchaed.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'action_view'
+require 'net/http'
+require 'uri'
+
+module Recaptchaed
+  def validate_captcha(private_key, remote_ip, recaptcha_challenge_field, recaptcha_response_field)
+    site = "http://www.google.com/recaptcha/api/verify"
+    url = URI.parse(site)
+    req = Net::HTTP::Post.new(url.path)
+    req.set_form_data({'privatekey' => private_key, 
+                        'remoteip' => remote_ip, 
+                        'challenge' => recaptcha_challenge_field, 
+                        'response' => recaptcha_response_field})
+    h = Net::HTTP.new(url.host, url.port)
+    # h.set_debug_output $stderr
+    res = h.start { |http| http.request(req) }
+
+    case res
+    when Net::HTTPSuccess, Net::HTTPRedirection
+      success, message = res.body.split.map { |s| s.chomp }
+      success = success =~ /^true$/i ? true : false
+      message = message =~ /^incorrect-captcha-sol$/ ? "Oops, the text you entered doesn't match the image exactly, please try again" : message
+      result = { 'success' => success, 'message' => message }
+    else
+      result = { 'success' => false, 'message' => res.error! }
+    end
+  end  
+
+  ActionView::Helpers::FormTagHelper.class_eval do 
+    def recaptcha_tag (public_key, div_id = "recaptcha_div", theme="red")
+      @result ||= "<div id=\"#{div_id}\"></div>
+                <script type=\"text/javascript\">
+                   Recaptcha.create('#{public_key}', '#{div_id}', { theme: '#{theme}' })
+                </script>"
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'recaptchaed'

data/spec/#recaptcha_form_tag_spec.rb#

@@ -0,0 +1,14 @@
+require 'test_helper.rb'
+require 'rubygems'
+require 'action_view'
+include ActionView::Helpers::FormTagHelper
+include ActionView::Helpers::TagHelper
+
+describe Recaptchaed, 'form_tag' do
+  it "should add a form helper" do
+    recaptcha_tag("12345", "test", "blackglass").should == "<div id=\"test\"></div>
+                <script type=\"text/javascript\">
+                   Recaptcha.create('12345', 'test', { theme: 'blackglass' })
+                </script>"
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,83 @@
+require 'test_helper.rb'
+# require File.join(File.expand_path(File.dirname(__FILE__)), "../lib", "recaptchaed")
+# include Recaptchaed
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+describe Recaptchaed, 'generator' do 
+
+  before(:all) do 
+    FileUtils.mkdir_p(fake_initializers_dir)
+    FileUtils.mkdir_p(fake_locales_dir)
+    @original_config_files = config_file_list
+    @original_initializers_files = initializers_file_list
+
+    content = <<-END
+      # Sample localization file for English. Add more files in this directory for other locales.
+      # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+      en:
+        hello: "Hello world"
+    END
+    File.open(fake_i18n_path, 'wb') {|f| f.write(content) }
+  end
+
+  after(:all) do 
+    FileUtils.rm_r(fake_config_dir)
+  end
+
+  it "should generate a config file, an initializer, and add i18n error message" do 
+    Rails::Generator::Scripts::Generate.new.run(["recaptchaed"], :destination => fake_rails_root)
+
+    new_file = (config_file_list - @original_config_files).first
+    File.basename(new_file).should == "recaptchaed.yml"
+
+    new_file = (initializers_file_list - @original_initializers_files).first
+    File.basename(new_file).should == "recaptchaed.rb"
+
+    File.read(fake_i18n_path).should match(/recaptcha_response_field/)
+  end
+
+  # it "should remove config file, initializer, and should remove i18n error message" do
+  #   Rails::Generator::Scripts::Destroy.new.run(["recaptchaed"], :destination => fake_rails_root)
+
+  #   new_file = (config_file_list - @original_config_files)
+  #   new_file.should be nil
+
+  #   new_file = (initializers_file_list - @original_initializers_files)
+  #   new_file.should be nil
+
+  #   File.read(fake_i18n_path).should_not match(/recaptcha_response_field/)
+  # end
+
+  private
+
+    def fake_rails_root
+      File.join(File.dirname(__FILE__), 'rails_root')
+    end
+
+    def fake_initializers_dir
+      @fake_initializers_dir ||= "#{fake_rails_root}/config/initializers"
+    end
+
+    def fake_config_dir
+      @fake_config_dir ||= "#{fake_rails_root}/config"
+    end
+
+    def fake_locales_dir
+      @fake_locales_dir ||= "#{fake_rails_root}/config/locales"
+    end
+
+    def fake_i18n_path
+      @fake_i18n_path ||= "#{fake_rails_root}/config/locales/en.yml"
+    end
+  
+    def config_file_list
+      Dir.glob(File.join(fake_config_dir, "*"))
+    end
+
+    def initializers_file_list
+      Dir.glob(File.join(fake_initializers_dir, "*"))
+    end
+
+end

data/spec/recaptcha_form_tag_spec.rb

@@ -0,0 +1,14 @@
+require 'test_helper.rb'
+require 'rubygems'
+require 'action_view'
+include ActionView::Helpers::FormTagHelper
+include ActionView::Helpers::TagHelper
+
+describe Recaptchaed, 'form_tag' do
+  it "should add a form helper" do
+    recaptcha_tag("12345", "test", "blackglass").should == "<div id=\"test\"></div>
+                <script type=\"text/javascript\">
+                   Recaptcha.create('12345', 'test', { theme: 'blackglass' })
+                </script>"
+  end
+end

data/spec/recaptchaed_spec.rb

@@ -0,0 +1,21 @@
+require 'test_helper.rb'
+include Recaptchaed
+
+## 
+# its kind of a pain to test this because, by nature, a captcha
+# shouldn't be able to be programmatically solved. So, to test, go to
+# a page with a form protected by recaptcha. View the source and update the
+# corresponding values below from the recaptcha form that is generated
+
+REMOTE_IP="changeme"
+CHALLENGE_FIELD="changeme"
+RESPONSE_FIELD="changeme"
+
+describe Recaptchaed, "#validate_captcha" do
+  it "should return true when valid captcha is submitted" do
+    result = validate_captcha(RECAPTCHAED["RECAPTCHA_PRIVATE_KEY"], REMOTE_IP, CHALLENGE_FIELD, RESPONSE_FIELD)
+    puts "Success: #{result['success']}, Message: #{result['message']}"
+    result['success'].should be true
+  end
+end
+

data/spec/test_helper.rb

@@ -0,0 +1,5 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+# require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/initializers/recaptchaed.rb'))

data/tasks/recaptchaed_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :recaptchaed do
+#   # Task goes here
+# end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: recaptchaed
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dave Paroulek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dave@daveparoulek.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- uninstall.rb
+- generators/recaptchaed/recaptchaed_generator.rb
+- generators/recaptchaed/templates/recaptchaed.rb
+- generators/recaptchaed/templates/recaptchaed.yml
+- generators/recaptchaed/USAGE
+- lib/recaptchaed/commands.rb
+- lib/recaptchaed/recaptchaed.rb
+- lib/recaptchaed.rb
+- rails/init.rb
+- tasks/recaptchaed_tasks.rake
+- spec/#recaptcha_form_tag_spec.rb#
+- spec/generator_spec.rb
+- spec/recaptcha_form_tag_spec.rb
+- spec/recaptchaed_spec.rb
+- spec/test_helper.rb
+has_rdoc: true
+homepage: http://upgradingdave.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails Plugin that makes it super easy to add recaptcha to any model form
+test_files: []
+