green_eggs_and_spam 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in green_eggs_and_spam.gemspec
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+Green Eggs and Spam
+===================
+
+A simple way to filter spam in your rails forms. Green eggs and spam presents the user with a simple question: **What color is this image?**
+
+You'll supply the images and a key of which one's which. The gem will handle the rest.
+
+
+** ----- under development ----- **
+
+
+Usage
+-----
+
+Install the gem just like you would any other:
+
+    (sudo) gem install green_eggs_and_spam
+    
+    # or with bundler
+    
+    gem 'green_eggs_and_spam', '>= 0.1.0'
+        
+
+Create a handful of color coded images and name them `1.png`, `2.png`, etc. Tell Green Eggs and Spam which ones which with an initializer:
+
+    # config/initializers/green_eggs_and_spam.rb
+    
+    GreenEggsAndSpam::AntiSpam.key_index = { "1" => "blue", "2" => "green", "3" => "red" }
+
+
+In your controller:
+
+    class CommentsController < ApplicationController
+    
+      has_anti_spam
+      
+      def create
+        ... # your code
+        
+        # add an error unless the anti spam question was answered correctly
+        @comment.errors[:base] << "Spam Detected! Please make sure you've properly answered the anti spam question." unless anti_spam_valid?        
+        
+        ... # the rest of your action
+      end
+      
+    end
+    
+    
+In your form:
+
+    = form_for @comment, :url => comment_path do |f|
+      %p
+		    = f.label :comment
+		    = f.text_field :comment
+		    
+	    // Here's what your interested in:
+	    %p
+	     = anti_spam_form, "What color is this piece of bacon?" # the optional argument is your custom question
+        
+		  = f.submit 'send'
+		
+
+Customization:
+
+So you're using `.gif`'s or you don't want the images stored in `/images/antispam`. Here's some available options for the form helper.
+
+    # the defaults
+    {
+      :alt => 'AntiSpam Image',
+      :class => 'antispam-image',
+      :path => '/images/antispam',
+      :extension => 'jpg'
+    }
+    
+    # usage
+    anti_spam_form, "Your custom color question?", { :extension => 'png', :path => '/images' }
+      
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/green_eggs_and_spam.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "green_eggs_and_spam/version"
+
+Gem::Specification.new do |s|
+  s.name        = "green_eggs_and_spam"
+  s.version     = GreenEggsAndSpam::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Spencer Steffen"]
+  s.email       = ["spencer@citrusme.com"]
+  s.homepage    = ""
+  s.summary     = %q{A simple way to filter spam in your rails forms.}
+  s.description = %q{Green eggs and spam presents the user with a simple question: What color is this image? You'll supply the images and a key of which one's which, and the gem will help with the rest.}
+
+  s.rubyforge_project = "green_eggs_and_spam"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("rails", ">= 3.0.0")
+end

data/lib/green_eggs_and_spam.rb

@@ -0,0 +1,7 @@
+require 'green_eggs_and_spam/anti_spam'
+require 'green_eggs_and_spam/action_controller'
+require 'green_eggs_and_spam/form_helper'
+
+module GreenEggsAndSpam
+  # Your code goes here...
+end

data/lib/green_eggs_and_spam/action_controller.rb

@@ -0,0 +1,33 @@
+module GreenEggsAndSpam  
+  
+  module ActionController
+    
+    def self.included(base)
+      base.extend GreenEggsAndSpam::ActionController::ClassMethods
+    end
+    
+    module ClassMethods
+      def has_anti_spam
+        self.send(:include, GreenEggsAndSpam::ActionController::InstanceMethods)
+        self.class_eval do
+          helper GreenEggsAndSpam::AntiSpamFormHelper
+          before_filter :setup_anti_spam, :only => [:index,:new, :create]
+          private
+            def setup_anti_spam         
+              @antispam_key = GreenEggsAndSpam::AntiSpam.random_key
+            end
+        end
+      end
+    end
+    
+    module InstanceMethods
+      def anti_spam_valid?
+        GreenEggsAndSpam::AntiSpam.valid?(params)
+      end
+    end
+    
+  end
+  
+end
+
+ActionController::Base.send(:include, GreenEggsAndSpam::ActionController) if defined?(ActionController)

data/lib/green_eggs_and_spam/anti_spam.rb

@@ -0,0 +1,29 @@
+module GreenEggsAndSpam
+  module AntiSpam
+    
+    extend self
+    
+    def key_index
+      @key_index ||= { "1" => "blue", "2" => "green", "3" => "red" }
+    end
+    
+    def key_index=(value)
+      @key_index = value
+    end
+    
+    def random_key
+      rand(key_index.keys.length) + 1    
+    end
+    
+    def valid?(params={})    
+      key = params[:antispam_key].to_s
+      val = params[:antispam].to_s
+      return false if key.empty? || val.empty?
+      answer = key_index[key.to_s]
+      regex = Regexp.new(answer, 'i')
+      return val.match(regex) != nil
+    end
+
+  end
+  
+end

data/lib/green_eggs_and_spam/form_helper.rb

@@ -0,0 +1,22 @@
+module GreenEggsAndSpam
+
+  module AntiSpamFormHelper
+
+    def anti_spam_form(question="What color is this image?", options={})
+      key = @antispam_key || 0
+      options = { :alt => 'AntiSpam Image', :class => 'antispam-image', :path => '/images/antispam', :extension => 'jpg' }.merge(options)
+      choices = GreenEggsAndSpam::AntiSpam.key_index.values.to_a
+      choices[choices.length - 1] = "or #{choices.last}"
+      [
+        label_tag(:antispam, question, :class => 'antispam-label'),
+        tag(:br),          
+      	text_field_tag(:antispam, '', :class => 'antispam-field text required', :title => choices.join(", ")),
+      	hidden_field_tag(:antispam_key, key),
+        tag(:br, :class => 'clear'),
+      	image_tag(File.join(options[:path], "#{key}.#{options[:extension]}"), :alt => options[:alt], :class => options[:class])
+      ].join("\n").html_safe
+    end
+  
+  end
+  
+end

data/lib/green_eggs_and_spam/version.rb

@@ -0,0 +1,3 @@
+module GreenEggsAndSpam
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: green_eggs_and_spam
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Spencer Steffen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: "Green eggs and spam presents the user with a simple question: What color is this image? You'll supply the images and a key of which one's which, and the gem will help with the rest."
+email: 
+- spencer@citrusme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- green_eggs_and_spam.gemspec
+- lib/green_eggs_and_spam.rb
+- lib/green_eggs_and_spam/action_controller.rb
+- lib/green_eggs_and_spam/anti_spam.rb
+- lib/green_eggs_and_spam/form_helper.rb
+- lib/green_eggs_and_spam/version.rb
+- public/images/antispam/1.jpg
+- public/images/antispam/2.jpg
+- public/images/antispam/3.jpg
+has_rdoc: true
+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: green_eggs_and_spam
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: A simple way to filter spam in your rails forms.
+test_files: []
+