leshill-bouncy_bots 0.1.1

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Les Hill
+
+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.textile

@@ -0,0 +1,49 @@
+h1. Bouncy Bots!
+
+A simple negative captcha for rails.
+
+A negative captcha flips the normal captcha on its head, rather than asking humans identify themselves, we trick the bots into identifying themselves.  We do this by placing honey pots in a form that are invisible to a human, but visible to a bot.  When the bot submits the form, we look for the honey pot entries and discard the form submission if we find any.
+
+h2. Installing Bouncy Bots!
+
+Bouncy Bots! is available as a gem from github.  Install the gem with the following command:
+
+  % sudo gem install --source http://gems.github.com/ leshill-bouncy_bots
+
+After you have the gem installed, add a @config.gem@ line to your @environment.rb@ file:
+
+  config.gem 'leshill-bouncy_bots', :lib => 'bouncy_bots', :version => '>= 0.1.1'
+
+h2. Using Bouncy Bots!
+
+h3. Controllers
+
+Use the @bounce_bots@ macro in your controllers to detect and bounce bots.  The macro takes two parameters, the honey pot field name and the redirect path or url.  For example, to check for the field @:blog_url@ and redirect bots to the @pages_path@ :
+
+  bounce_bots :blog_url, :pages_path
+
+You can also pass the standard controller filter options such as @:only@ or @:except@ :
+
+  bounce_bots :blog_url, :pages_path, :only => [:create, :update]
+
+h3. Views
+
+In your form views, add the honey pot field.  If you are using @form_tag@, you can use any form element, for example (using "haml":http://haml.hamptoncatlin.com/):
+
+  = text_field_tag :blog_url, nil, :class => 'long_required'
+
+In your stylesheet, add a rule to 'hide' the field:
+
+  input.long_required { display:none; }
+
+If you use @form_for@, there are two helpers to simplify making the honey pot.
+
+  = f.bounce_label 'Blog Url', :class => 'long_required'
+  %br
+  = f.bounce_field :class => 'long_required'
+
+And that's it.
+
+h2. Copyright
+
+Copyright (c) 2009 Les Hill and Desi McAdam. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bouncy_bots"
+    gem.summary = %Q{Simple negative captcha for Rails}
+    gem.homepage = "http://github.com/leshill/bouncy_bots"
+    gem.authors = ["Les Hill, Desi McAdam"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bouncy_bots #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bouncy_bots.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bouncy_bots}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Les Hill, Desi McAdam"]
+  s.date = %q{2009-07-02}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bouncy_bots.gemspec",
+     "lib/bouncy_bots.rb",
+     "lib/bouncy_bots/form_builder_ext.rb",
+     "spec/bouncy_bots_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/leshill/bouncy_bots}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simple negative captcha for Rails}
+  s.test_files = [
+    "spec/bouncy_bots_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/bouncy_bots.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bouncy_bots/form_builder_ext'
+
+module BouncyBots
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def bounce_bots(field, to, filter_opts = {})
+      before_filter :bounce_bot, filter_opts
+
+      cattr_accessor :bounce_to
+      cattr_accessor :bounce_field
+      bouncy_settings(field, to)
+    end
+
+    protected
+
+    def bouncy_settings(field, to)
+      self.bounce_field = field
+      self.bounce_to = to
+    end
+  end
+
+  protected
+
+  def bounce_bot
+    bot_check = find_bounce_field(params)
+    redirect_to(send(bounce_to)) and return false unless bot_check.blank?
+    true
+  end
+
+  def find_bounce_field(hash)
+    if hash.has_key?(bounce_field)
+      return hash.delete(bounce_field)
+    else
+      hash.values.each do |value|
+        if value.kind_of?(Hash)
+          bounce = find_bounce_field(value)
+          return bounce unless bounce.nil?
+        end
+      end
+      return nil
+    end
+  end
+end
+
+if defined? ActionController
+  ActionController::Base.send(:include, BouncyBots)
+end

data/lib/bouncy_bots/form_builder_ext.rb

@@ -0,0 +1,16 @@
+module BouncyBots
+  module FormBuilderExt
+    def bounce_field(options = {})
+      ActionView::Helpers::InstanceTag.new(object_name, @template.controller.bounce_field, self, options.delete(:object)).to_input_field_tag("text", options)
+    end
+
+    def bounce_label(text = nil, options = {})
+      ActionView::Helpers::InstanceTag.new(object_name, @template.controller.bounce_field, self, options.delete(:object)).to_label_tag(text, options)
+    end
+  end
+end
+
+if defined? ActionView
+  ActionView::Helpers::FormBuilder.send(:include, BouncyBots::FormBuilderExt)
+end
+

data/spec/bouncy_bots_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class MacroTest
+  def self.before_filter(*args); end
+end
+
+class FilterTest
+  def self.before_filter(*args); end
+  def redirect_to(*args); end
+
+  include BouncyBots
+  bounce_bots :three, :bounce_dest
+
+  attr_accessor :params
+end
+
+describe "BouncyBots" do
+  before do
+    MacroTest.stub!(:bouncy_settings)
+  end
+
+  describe ".bounce_bots macro" do
+    it "sets the before filter" do
+      MacroTest.should_receive(:before_filter).with(:bounce_bot, {})
+      MacroTest.class_eval do
+        include BouncyBots
+        bounce_bots :three, :bounce_to
+      end
+    end
+
+    it "breaks out options" do
+      MacroTest.should_receive(:cattr_accessor).with(:bounce_to)
+      MacroTest.should_receive(:cattr_accessor).with(:bounce_field)
+      MacroTest.should_receive(:bouncy_settings).with(:three, :bounce_to)
+      MacroTest.class_eval do
+        include BouncyBots
+        bounce_bots :three, :bounce_to
+      end
+    end
+
+    it "passes on filter options" do
+      MacroTest.should_receive(:before_filter).with(:bounce_bot, {:only => :index})
+      MacroTest.class_eval do
+        include BouncyBots
+        bounce_bots :three, :bounce_to, :only => :index
+      end
+    end
+  end
+
+  describe "#bounce_bot" do
+    it "calls the bounce_to if the field is not blank" do
+      filter = FilterTest.new
+      filter.params = {:one => {:two => {:three => 'something'}}}
+      filter.should_receive(:bounce_dest).and_return('bounced')
+      filter.send(:bounce_bot)
+    end
+
+    it "does not call the bounce_to if the field is blank" do
+      filter = FilterTest.new
+      filter.params = {:one => {:two => {:three => nil}}}
+      filter.should_not_receive(:bounce_dest)
+      filter.send(:bounce_bot)
+    end
+
+    it "redirects if the field is not blank" do
+      filter = FilterTest.new
+      filter.params = {:one => {:two => {:two => 2, :three => 'something'}}}
+      filter.stub!(:bounce_dest).and_return('bounced')
+      filter.should_receive(:redirect_to).with('bounced')
+      filter.send(:bounce_bot)
+    end
+
+    it "returns true when the field does not exist" do
+      filter = FilterTest.new
+      filter.params = {:one => {:two => {:two => 2}}}
+      filter.send(:bounce_bot).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bouncy_bots'
+
+require 'activesupport'
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: leshill-bouncy_bots
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Les Hill, Desi McAdam
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- bouncy_bots.gemspec
+- lib/bouncy_bots.rb
+- lib/bouncy_bots/form_builder_ext.rb
+- spec/bouncy_bots_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/leshill/bouncy_bots
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple negative captcha for Rails
+test_files: 
+- spec/bouncy_bots_spec.rb
+- spec/spec_helper.rb