validates_against_stopforumspam 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Richard Hirner <hirner@bitfire.at>
+
+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,60 @@
+ValidatesAgainstStopforumspam
+=============================
+
+Rails gem for ActiveRecord comment model validation against StopForumSpam.com.
+No API key required. Respect their terms of use: http://www.stopforumspam.com/apis
+
+Compatibility: Rails 3, tested with Ruby 1.8.7
+
+
+Installation
+============
+
+Specify the gem in your Gemfile:
+
+  gem "validates_against_stopforumspam"
+
+or for the current edge version:
+
+  gem "validates_against_stopforumspam", :git => 'git://github.com/rfc2822/validates_against_stopforumspam'
+
+and install it with bundler.
+
+
+Example
+=======
+
+Assuming that you have a model +Comment+ with the following fields:
+
+	t.string :name, :null => false
+	t.string :email
+	t.string :ip_address
+	t.string :comment, :null => false
+
+You can use validates_against_stopforumspam to validate new comments:
+
+	class Comment < ActiveRecord::Base
+		validates_against_stopforumspam :fields => { :username => name, :email => :email, :ip => :ip_address }
+	end
+
+The +fields+ parameter is required. It must define at least one of these parameters:
+
+* :username
+* :email
+* :ip
+
+These parameters are used to query StopForumSpam. When the comment may be spam (because at
+least one of the parameters appear on stopforumspam.com), an error is added to the model instance.
+
+
+To do
+=====
+
+If you like and/or use this plug-in, please consider extending it. What is needed:
+
+* i18n'ed error message
+
+Please submit patches via Github.
+
+
+Copyright (c) 2011 Richard Hirner <hirner@bitfire.at>, released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the validates_against_stopforumspam plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the validates_against_stopforumspam plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesAgainstStopforumspam'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/validates_against_stopforumspam.rb

@@ -0,0 +1,33 @@
+require "net/http"
+require "uri"
+
+module ValidatesAgainstStopForumSpam
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def validates_against_stopforumspam(options)
+      validate do |comment|
+        query_options = []
+        options[:fields].each do |type, name|
+          value = comment.read_attribute(name)
+          query_options.push "#{type}=#{URI.escape(value)}" unless value.nil?
+        end
+        return if query_options.empty?
+        url = "http://www.stopforumspam.com/api?" + query_options.join('&')
+        logger.info "Querying StopForumSpam.com: #{url}"
+        begin
+          sfs = Hash.from_xml(Net::HTTP.get(URI.parse(url)))
+					#logger.debug sfs.inspect
+          errors.add :base, "may be spam according to StopForumSpam.com" if [ sfs["response"]["appears"] ].flatten.include?("yes")
+        rescue
+          logger.warn "StopForumSpam validation not successful"
+        end
+      end
+    end
+  end
+end
+
+
+ActiveRecord::Base.send(:include, ValidatesAgainstStopForumSpam)

data/test/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :comments do |t|
+    t.string :name
+    t.string :email
+    t.string :ip
+    t.string :comment
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'logger'
+require 'test/unit'
+require 'active_record'
+require 'active_support'
+
+ENV['RAILS_ENV'] = 'test'
+
+def load_schema
+	ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+  ActiveRecord::Base.establish_connection({
+		:adapter => 'sqlite3',
+		:database => ':memory:'
+	})
+  load(File.dirname(__FILE__) + "/schema.rb")
+end
+

data/test/validates_against_stopforumspam_test.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../rails/init'
+
+class ValidatesAgainstStopForumSpamTest < ActiveSupport::TestCase
+  load_schema
+
+  class Comment < ActiveRecord::Base
+		validates_against_stopforumspam :fields => { :email => :email, :ip => :ip, :username => :name }
+  end
+
+	# test data: see http://www.stopforumspam.com/forum/viewtopic.php?pid=14680
+
+  test "empty comment" do
+    comment = Comment.new
+    assert comment.valid?
+  end
+
+	test "ham email" do
+		comment = Comment.create(:email => 'this-is-not-a@spammer-but-a-hammer.com')
+		assert comment.valid?
+	end
+
+	test "ham email and IP" do
+		comment = Comment.create(:email => 'this-is-not-a@spammer-but-a-hammer.com', :ip => '127.0.0.1')
+		assert comment.valid?
+	end
+
+	test "spam email" do
+		comment = Comment.create(:email => 'test@test.com')
+		assert comment.invalid?
+	end
+
+	test "spam email and ip" do
+		comment = Comment.create(:email => 'test@test.com', :ip => '1.2.3.4')
+		assert comment.invalid?
+	end
+
+	test "spam ip" do
+		comment = Comment.create(:ip => '1.2.3.4')
+		assert comment.invalid?
+	end
+
+	test "spam username" do
+		comment = Comment.create(:name => 'spammer')
+		assert comment.invalid?
+	end
+end

data/validates_against_stopforumspam.gemspec

@@ -0,0 +1,25 @@
+require "rake"
+
+PKG_FILES = FileList[
+	'[a-zA-Z]*',
+	'generators/**/*',
+	'lib/**/*',
+	'rails/**/*',
+	'tasks/**/*',
+	'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+	s.name = "validates_against_stopforumspam"
+	s.version = "0.0.1"
+	s.author = "Richard Hirner"
+	s.email = "hirner@bitfire.at"
+	s.homepage = "http://github.com/rfc2822/validates_against_stopforumspam"
+	s.platform = Gem::Platform::RUBY
+	s.summary = "ActiveRecord model validation against stopforumspam.com"
+	s.files = PKG_FILES.to_a
+	s.require_path = "lib"
+	s.has_rdoc = false
+	s.extra_rdoc_files = ["README"]
+end
+ 

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: validates_against_stopforumspam
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Richard Hirner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: hirner@bitfire.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- validates_against_stopforumspam.gemspec
+- MIT-LICENSE
+- Rakefile
+- README
+- lib/validates_against_stopforumspam.rb
+- test/validates_against_stopforumspam_test.rb
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rfc2822/validates_against_stopforumspam
+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: ActiveRecord model validation against stopforumspam.com
+test_files: []
+