molasses_jar 0.0.2 → 0.0.3

data/README.md

@@ -2,23 +2,56 @@
 
 A simple ActiveRecord extension for creating honeypot style captchas.
 
+== Nuts and Bolts
+
+MolassesJar will add simple honeypot verification to any model you wish. It creates an attribute called :molasses_jar on the desired object and then checks to see if there is a value assigned to it. 
+
+MolassesJar will look for a boolean attribute called ```spam``` on your model.  If it finds it, it will update the attribute to be true if it thinks the record is being submitted by a robot, thus preventing the loss of legitimate content.
+
+If it does not find a ```spam``` attribute on your model, it will add an error to the molasses_jar attribute, thus preventing the model from validating and saving.
+
 == How To Use
 
-MolassesJar will add simple honeypot verification to any model you wish. It creates an attribute called :molasses_jar on the desired object and then checks to see if there is a value assigned to it. If there is, then the object does not validate. You will need to add an input to your objects form with the attribute :molasses_jar and then using your css, either display: none or move the form off the screen using absolute positioning.
+=== Install the gem through Bundler
+
+	gem "molasses_jar"
+
+=== If flagging is desired, add a spam attribute to your Model
+
+Generate a migration to add the spam attribute to your model. It is recommended that you index the attribute sice it will appear in a where clause through the included scope
+
+	def change
+		add_column :contact_forms, :spam, :boolean, :default => false
+		add_index :contact_forms, :spam
+		ContactForm.update_all(:spam => false)
+	end
+
+=== Add the Extensions to your Model
 
 	class ContactForm < ActiveRecord::Base  
 		include MolassesJar::Extensions  
 	end
 
-MolassesJar will look for a boolean attribute called ```spam``` on your model.  If it finds it, it will update the attribute to be true if it thinks the record is being submitted by a robot. This method prevents losing legitimate content.
+=== Add the input to your forms
+
+You will need to add an input to your object's form with the attribute :molasses_jar. Then use css, to either ```display: none;``` or move the form off the screen using absolute positioning.  Best practices suggests you include a label with your input field and include some sort of message that says "If you're a human, please leave this field blank" to insure accessability.
+
+HTML/HAML
 
-Coming Soon:
+	= form.label :molasses_jar, "If you are a human, please leave this field blank", :class => "agglutinative"
+	= form.text_field :molasses_jar, :class => "agglutinative"
+
+CSS
+
+	.agglutinative {
+		display: none;
+	}
+
+== Coming Soon
 
 * Form Helper to create the form input
-* Database flagging to prevent false positives
+* Migration generator for the spam attribute
 * Stylesheet generator to create the stylesheet
-* Accessibility improvements for readers
-
 
 == Interesting Reads on the Honeypot Approach
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/molasses_jar/extensions.rb

@@ -3,20 +3,37 @@ module MolassesJar
 	  extend ActiveSupport::Concern
 
 	  included do
-	    attr_accessor :molasses_jar, :spam
+	    attr_accessor :molasses_jar
 
-	    scope :spammy, where(:spam => true)	    
+	    scope :spammy, where(:spam => true)
 	    scope :not_spammy, where(:spam => false)
 
 			validate :mark_as_spam?
 
 			def mark_as_spam?
-				self.spam = true if self.molasses_jar.present?
+				if has_spam_attribute? and caught_something?
+					self.spam = true
+				elsif !has_spam_attribute? and caught_something?
+					errors.add(:molasses_jar, "")
+				end
 			end
-			
+
 			def spam?
-				self.spam
+				if has_spam_attribute?
+					self.spam
+				else
+					caught_something?
+				end
+			end
+
+			def caught_something?
+				self.molasses_jar.present?
 			end
+
+			def has_spam_attribute?
+				self.attributes.include?("spam")
+			end
+
 	  end
 	end
 end

data/molasses_jar.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "molasses_jar"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mindtonic"]

data/spec/molasses_jar_spec.rb

@@ -2,6 +2,148 @@ require 'spec_helper'
 
 describe MolassesJar do
 
-	it_should_behave_like "a molasses_jar", :contact_form
+	describe "a Molasses Jar without a Spam attribute" do
+		before(:each) do
+			@model = ContactForm.new
+		end
+
+		context "molasses_jar attributes" do
+			it "should have a molasses_jar attribute" do
+				lambda{ @model.molasses_jar }.should_not raise_error
+			end
+
+			it "should initialize as nil" do
+				@model.molasses_jar.nil?.should be true
+			end
+			
+			it "should not have a spam attribute" do
+				@model.has_spam_attribute?.should be false
+			end
+		end
+
+		context "scopes" do
+			it "should respond to spammy" do
+				ContactForm.respond_to?(:spammy).should be true
+			end
+
+			it "should respond to not_spammy" do
+				ContactForm.respond_to?(:not_spammy).should be true
+			end
+		end
+
+		context "with a molasses_jar value" do
+			before(:each) do
+				@model.update_attributes(:molasses_jar => "I am a robot")
+			end
+
+			it "should be valid" do
+				@model.should_not be_valid
+			end
+
+			it "should return true for spam?" do
+				@model.spam?.should be true
+			end
+			
+			it "should have caught_something?" do
+				@model.caught_something?.should be true
+			end
+		end
+
+		context "without a molasses_jar value" do
+			before(:each) do
+				@model.update_attributes(:molasses_jar => "")
+			end
+
+			it "should be valid" do
+				@model.should be_valid
+			end
+
+			it "should return false for spam?" do
+				@model.spam?.should be false
+			end
+			
+			it "should not have caught_something?" do
+				@model.caught_something?.should be false
+			end
+		end
+	end
+
+	describe "a Molasses Jar with a Spam attribute" do
+		before(:each) do
+			@model = Feedback.new
+		end
+
+		context "molasses_jar attributes" do
+			it "should have a molasses_jar attribute" do
+				lambda{ @model.molasses_jar }.should_not raise_error
+			end
+
+			it "should initialize as nil" do
+				@model.molasses_jar.nil?.should be true
+			end
+			
+			it "should have a spam attribute" do
+				@model.has_spam_attribute?.should be true
+			end
+
+			it "should initialize as nil" do
+				@model.spam.nil?.should be true
+			end
+		end
+
+		context "scopes" do
+			it "should respond to spammy" do
+				Feedback.respond_to?(:spammy).should be true
+			end
+
+			it "should respond to not_spammy" do
+				Feedback.respond_to?(:not_spammy).should be true
+			end
+		end
+
+		context "with a molasses_jar value" do
+			before(:each) do
+				@model.update_attributes(:molasses_jar => "I am a robot")
+			end
+
+			it "should be valid" do
+				@model.should be_valid
+			end
+
+			it "should be marked as spam" do
+				@model.spam.should be true
+			end
+
+			it "should return true for spam?" do
+				@model.spam?.should be true
+			end
+			
+			it "should have caught_something?" do
+				@model.caught_something?.should be true
+			end
+		end
+
+		context "without a molasses_jar value" do
+			before(:each) do
+				@model.update_attributes(:molasses_jar => "")
+			end
+
+			it "should be valid" do
+				@model.should be_valid
+			end
+
+			it "should not be marked as spam" do
+				@model.spam.should be (false || nil)
+			end
+
+			it "should return false for spam?" do
+				@model.spam?.should be (false || nil)
+			end
+			
+			it "should not have caught_something?" do
+				@model.caught_something?.should be false
+			end
+		end
+	end
 
 end

data/spec/spec_helper.rb

@@ -31,82 +31,18 @@ ActiveRecord::Schema.define do
     table.column :email, :string
     table.column :message, :text
   end
+  
+  create_table :feedbacks do |table|
+    table.column :email, :string
+    table.column :message, :text
+    table.column :spam, :boolean
+  end
 end
 
 class ContactForm < ActiveRecord::Base
 	include MolassesJar::Extensions
 end
 
-
-#
-# Molasses Jar Example Group
-#
-# Usage Example:
-# In your model spec, it_should_behave_like "a molasses_jar", :singular_model_name
-#
-
-shared_examples "a molasses_jar" do |model|
-
-	describe "a Molasses Jar" do
-		before(:each) do
-			eval "@model = #{model.to_s.camelize}.new"
-		end
-	
-		context "molasses_jar attributes" do
-			it "should have a molasses_jar attribute" do
-				lambda{ @model.molasses_jar }.should_not raise_error
-			end
-			
-			it "should initialize as nil" do
-				@model.molasses_jar.nil?.should be true
-			end
-		end
-
-		context "scopes" do
-			it "should respond to spammy" do
-				eval "#{model.to_s.camelize}.respond_to?(:spammy).should be true"
-			end
-
-			it "should respond to not_spammy" do
-				eval "#{model.to_s.camelize}.respond_to?(:not_spammy).should be true"
-			end
-		end
-
-		context "with a molasses_jar value" do
-			before(:each) do 
-				@model.update_attributes(:molasses_jar => "I am a robot")
-			end
-
-			it "should be valid" do
-				@model.should be_valid
-			end
-
-			it "should be marked as spam" do
-				@model.spam.should be true
-			end
-
-			it "should return true for spam?" do
-				@model.spam?.should be true
-			end
-		end
-
-		context "without a molasses_jar value" do
-			before(:each) do 
-				@model.update_attributes(:molasses_jar => "")
-			end
-
-			it "should be valid" do
-				@model.should be_valid
-			end
-
-			it "should not be marked as spam" do
-				@model.spam.should be (false || nil)
-			end
-
-			it "should return false for spam?" do
-				@model.spam?.should be (false || nil)
-			end
-		end
-	end
-
-end
+class Feedback < ActiveRecord::Base
+	include MolassesJar::Extensions
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: molasses_jar
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -176,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4352536654887980733
+      hash: -4059900841103394163
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: