is_bot 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+is_bot.database
+is_bot.db

data/README.markdown

@@ -0,0 +1,40 @@
+is_bot
+======
+
+About
+-----
+
+**is_bot** is a clean rewrite of **less_reverse_captcha**
+
+It is a simple way to make your forms bot-proof. The effectiveness of the solution is open to discussion. I have used it on a low traffic site and it seems to have reduced the bot-attack considerably.
+
+
+Usage
+-----
+It is very simple to use. Just install it in your rails app and perform the following steps. 
+
+In your model class:
+    
+    class User < ActiveRecord::Base
+      validate_captcha
+    end
+    
+In your model's view:
+    
+    form_for @user do |F|
+      f.captcha_reverse_field :user
+    end
+    
+And that's it.
+
+
+Bugs
+----
+
+Please report the issues through gitHub's issues.
+
+
+Authors
+-------
+
+* Anuj Dutta - [andHapp.com](http://www.andhapp.com/blog)

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "is_bot"
+    gemspec.summary = "Fight the bot."
+    gemspec.description = "Simple gem to reduce the spam attacks on sign-up, sign-in and other similar sorts of forms."
+    gemspec.email = "anuj@andhapp.com"
+    gemspec.homepage = "http://github.com/andhapp/is_bot"
+    gemspec.authors = ["Anuj Dutta"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), "lib", "is_bot")
+
+ActiveRecord::Base.send(:include, IsBot::CaptchaInReverse)
+ActionView::Base.send(:include, IsBot::ViewHelper)

data/lib/is_bot/is_bot.rb

@@ -0,0 +1,29 @@
+module IsBot
+  module CaptchaInReverse
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        class_inheritable_accessor :captcha_in_reverse
+      end  
+    end
+    
+    module ClassMethods
+      def validate_captcha(options = {})
+        configuration = { :message => 'can not create this because you are a bot.', :on => :save }
+        configuration.merge!(options)
+        validates_each :captcha_in_reverse, configuration do |record, attr, value|
+          record.errors.add attr, configuration[:message] if not value.blank?
+        end
+      end
+    end
+  end
+  
+  module ViewHelper
+    def captcha_reverse_field(object, options={})
+      style = (options.delete(:style) || '') << ";"
+      style << "display: none;"
+      ActionView::Helpers::InstanceTag.new(object, :captcha_in_reverse, self).to_input_field_tag("text", options.merge(:style => style) )
+    end
+  end
+
+end

data/lib/is_bot.rb

@@ -0,0 +1,3 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+require "is_bot/is_bot"

data/spec/database.yml

@@ -0,0 +1,3 @@
+test:
+  :adapter:    sqlite3
+  :database:   is_bot.db

data/spec/is_bot_spec.rb

@@ -0,0 +1,93 @@
+%w(spec_helper ../init models).each{|path| require File.join(File.dirname(__FILE__), path) }
+
+# ********************* SET-UP **************************
+# ---------- Models
+# There are two models that are used for describing IsBot
+# 1. Bot
+# 2. Robot
+# Both the models can be found in the models.rb file
+# 
+# ---------- Schema
+# The schema is described in scehma.rb
+#
+# ---------- Database configuration
+# The specs use sqlite3 adapter and the configuration is described in database.yml
+
+describe IsBot do
+  context "ClassMethods" do
+    context "Set up" do
+      
+      it "should be in the list of included modules" do
+        Bot.included_modules.should include(IsBot::CaptchaInReverse)
+      end
+
+      it "should add a virtual accessor 'captcha_in_reverse' to the class" do
+        bot = Bot.new
+        bot.should.respond_to?(:captcha_in_reverse)
+        bot.should.respond_to?(:captcha_in_reverse=)  
+      end
+
+      it "should add a class method 'validate_captcha'" do
+        Bot.should.respond_to?(:validate_captcha)
+      end
+    end
+
+    context "Validation" do
+
+      before(:each) do
+        @bot = Bot.new
+      end
+
+      # because a bot would fill in the hidden field really
+      it "should add to the errors if 'captcha_in_reverse' is not blank?" do
+        lambda {
+          @bot.captcha_in_reverse = "I am a Bot!"
+          @bot.valid?
+        }.should change(@bot.errors, :size).by(1)
+        @bot.errors.on "captcha_in_reverse" == "can not create this because you are a bot."
+      end
+
+      # because human is not expected to fill this field
+      it "should not add to errors when 'captcha_in_reverse' is blank? " do
+        lambda {
+          @bot.captcha_in_reverse = nil
+          @bot.valid?
+        }.should_not change(@bot.errors, :size).by(1)
+      end    
+
+      context "Custom validation" do
+        it "should accept a custom error message" do
+          robot = Robot.new(:captcha_in_reverse => "I am a Bot!")    
+          robot.valid?
+          robot.errors.on "captcha_in_reverse" == "You are a BOT. Go away."    
+        end
+      end
+
+    end
+  end
+  
+  context "Helper" do
+    context "set up" do
+      it "should include the defined custom helper module" do
+        ViewHelper::ViewField.included_modules.should include(IsBot::ViewHelper)
+      end
+    end
+    
+    context "input tag" do
+      it "should create one for adding captcha" do
+        ViewHelper::ViewField.new.should.respond_to?(:captcha_reverse_field)
+      end
+      
+      it "should be hidden" do
+        captcha_field = ViewHelper::ViewField.new.captcha_reverse_field(:bot)
+        captcha_field.should include("style=\";display: none;\"")
+      end
+      
+      it "should include the custom defined styles" do
+        captcha_field = ViewHelper::ViewField.new.captcha_reverse_field(:bot, {:style => "color:red"})
+        captcha_field.should include("style=\"color:red;display: none;\"")        
+      end
+    end
+  end
+  
+end

data/spec/models.rb

@@ -0,0 +1,7 @@
+class Bot < ActiveRecord::Base
+  validate_captcha
+end
+
+class Robot < ActiveRecord::Base
+  validate_captcha :message => "You are a BOT. Go away."
+end

data/spec/schema.db

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table "bots", :force => true do |t|
+    t.string    "name"
+    t.datetime  "created_at"
+    t.datetime  "updated_at"
+  end
+  
+  create_table "robots", :force => true do |t|
+    t.string    "name"
+    t.datetime  "created_at"
+    t.datetime  "updated_at"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format nested
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "is_bot")
+
+require 'activerecord'
+require 'action_view'
+require 'yaml'
+require 'spec'
+ 
+def connect(environment)
+  conf = YAML::load(File.open(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.establish_connection(conf[environment])
+end
+ 
+connect('test')
+load(File.join(File.dirname(__FILE__), "schema.db"))
+
+module ViewHelper; class ViewField < ActionView::Base; end end
+
+Spec::Runner.configure do |config|
+  config.include(ViewHelper)
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: is_bot
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anuj Dutta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-20 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: Simple gem to reduce the spam attacks on sign-up, sign-in and other similar sorts of forms.
+email: anuj@andhapp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/is_bot.rb
+- lib/is_bot/is_bot.rb
+- spec/database.yml
+- spec/is_bot_spec.rb
+- spec/models.rb
+- spec/schema.db
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/andhapp/is_bot
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Fight the bot.
+test_files: 
+- spec/is_bot_spec.rb
+- spec/models.rb
+- spec/spec_helper.rb