despamilator_rails 1.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require=./spec/spec_helper.rb

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@despamilator-rails

data/Gemfile

@@ -0,0 +1,17 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem 'hoe', '>= 2.7.0'
+gem 'newgem', '>= 1.5.3'
+gem 'activesupport', '>= 2.3.10'
+
+# while we're fetching from git, we need to execute everything with 'bundle exec'
+#gem 'despamilator', :git => 'git://github.com/moowahaha/despamilator.git'
+gem 'despamilator', '>= 1.0'
+
+group :test do
+  gem 'rspec', '>= 2.4.0'
+  gem 'sqlite3', '>= 0.1.1'
+  gem 'activerecord', '>= 2.3.10'
+  gem 'one_hundred_percent_coverage'
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    activerecord (2.3.10)
+      activesupport (= 2.3.10)
+    activesupport (2.3.10)
+    despamilator (1.0)
+    diff-lcs (1.1.2)
+    ffi (1.0.4)
+      rake (>= 0.8.7)
+    hoe (2.8.0)
+      rake (>= 0.8.7)
+    newgem (1.5.3)
+      RedCloth (>= 4.1.1)
+      activesupport (~> 2.3.4)
+      hoe (>= 2.4.0)
+      rubigen (>= 1.5.3)
+      syntax (>= 1.0.0)
+    one_hundred_percent_coverage (0.0.2)
+      simplecov (>= 0.3.7)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    rubigen (1.5.5)
+      activesupport (~> 2.3.5)
+    simplecov (0.3.7)
+      simplecov-html (>= 0.3.7)
+    simplecov-html (0.3.9)
+    sqlite3 (0.1.1)
+      ffi (>= 0.6.3)
+    syntax (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 2.3.10)
+  activesupport (>= 2.3.10)
+  despamilator (>= 1.0)
+  hoe (>= 2.7.0)
+  newgem (>= 1.5.3)
+  one_hundred_percent_coverage
+  rspec (>= 2.4.0)
+  sqlite3 (>= 0.1.1)

data/History.txt

@@ -0,0 +1,7 @@
+=== 1.0 2011-09-01
+
+* First release of standalone Rails plugin. Improvements on old one are...
+  * No longer part of Despamilator, so more obvious!
+  * Better syntactic sugar.
+  * Behaves much more like a regular ActiveRecord validation routine.
+  * Load of tests.

data/Manifest.txt

@@ -0,0 +1,15 @@
+.rspec
+.rvmrc
+Gemfile
+Gemfile.lock
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+despamilator-rails.gemspec
+lib/despamilator_rails.rb
+spec/active_record_integration_spec.rb
+spec/despamilator_rails_spec.rb
+spec/fixtures/active_record_test_class.rb
+spec/spec_helper.rb
+spec/test_db_migrations/create_test_model_table.rb

data/README.rdoc

@@ -0,0 +1,92 @@
+= despamilator_rails
+
+* https://github.com/moowahaha/despamilator-rails
+
+== DESCRIPTION:
+
+Spam detection plugin for Rails & ActiveRecord. Uses all the standard Rails conventions and
+my Despamilator gem.
+
+== FEATURES/PROBLEMS:
+
+* To fix the iconv error when developing with Ruby 1.9.2 and RVM,
+  see: http://blog.footle.org/2010/07/29/installing-ruby-1-9-2-via-rvm-on-os-x/ .
+
+* Stuck with lower version of ActiveRecord in Gemfile until Hoe is fixed to support
+  newer versions.
+
+* DataMapper not yet supported. That's on the list!
+
+
+== SYNOPSIS:
+
+Somewhere (such as your environment.rb...)
+
+   require 'despamilator_rails'
+
+In your model (basic example):
+
+   class YourModel < ActiveRecord::Base
+     validate_with_despamilator :attributes => [:some_field]
+   end
+
+When "some_field" is assigned a spammy value, it will add to the errors. For example...
+
+   YourModel.new(:some_field => spammy_value).save! #=> ActiveRecord::RecordInvalid exception!
+
+Or...
+
+   your_instance = YourModel.new(:some_field => spammy_value)
+   your_instance.save
+   your_instance.errors.full_messages.should #=> ["Some field looks like spam"]
+
+If you want to configure the threshold (which defaults to 1) or add your own callback, you can do the following:
+
+   class YourModel < ActiveRecord::Base
+     validate_with_despamilator :attributes => [:some_field], :threshold => 1 do |field, value, despamilator|
+       raise "spam! field: #{field}, value: #{value}, score: #{despamailtor.score}"
+     end
+   end
+
+This example will...
+
+   your_instance = YourModel.new(:some_field => "spammy string")
+   your_instance.save! #=> Exception "spam! field: some_field, value: spammy string, score: 123"
+
+The callback will receive the field name, the value and the instance of the Despamilator class.
+
+See the various examples in "spec/fixtures".
+
+== REQUIREMENTS:
+
+* ActiveRecord >= 2.3.2
+* Despamilator >= 1.0
+
+== INSTALL:
+
+* gem install despamilator_rails
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Stephen Hardisty
+
+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/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/despamilator_rails'
+
+Hoe.plugin :newgem
+
+$hoe = Hoe.spec 'despamilator_rails' do
+  self.developer 'Stephen Hardisty', 'moowahaha@hotmail.com'
+  self.rubyforge_name       = self.name
+  self.extra_deps         = [['despamilator','>= 1.0'], ['activesupport', '>= 2.3.2']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec]
+task :test => [:spec]
+
+desc "Generate appropriate rdoc"
+task :rdoc do
+  sh "rdoc README.rdoc lib/despamilator_rails.rb"
+end
+
+task :cultivate do
+  sh "rm -f *.sqlite3"
+  sh "touch Manifest.txt; rake check_manifest |grep -v \"(in \" | patch"
+  sh "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec"
+end

data/despamilator-rails.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{despamilator_rails}
+  s.version = "1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Stephen Hardisty"]
+  s.date = %q{2011-01-09}
+  s.description = %q{FIX (describe your package)}
+  s.email = ["moowahaha@hotmail.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = [".rspec", ".rvmrc", "Gemfile", "Gemfile.lock", "History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "despamilator-rails.gemspec", "lib/despamilator_rails.rb", "spec/active_record_integration_spec.rb", "spec/despamilator_rails_spec.rb", "spec/fixtures/active_record_test_class.rb", "spec/spec_helper.rb", "spec/test_db_migrations/create_test_model_table.rb"]
+  s.homepage = %q{https://github.com/moowahaha/despamilator-rails}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{despamilator_rails}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{FIX (describe your package)}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<despamilator>, [">= 1.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_development_dependency(%q<hoe>, [">= 2.8.0"])
+    else
+      s.add_dependency(%q<despamilator>, [">= 1.0"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_dependency(%q<hoe>, [">= 2.8.0"])
+    end
+  else
+    s.add_dependency(%q<despamilator>, [">= 1.0"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+    s.add_dependency(%q<hoe>, [">= 2.8.0"])
+  end
+end

data/lib/despamilator_rails.rb

@@ -0,0 +1,103 @@
+require 'despamilator'
+require 'active_support'
+require 'active_record'
+
+module DespamilatorRails
+  VERSION = "1.0"
+end
+
+module ActiveRecord
+
+  class Base
+
+    # Somewhere (such as your environment.rb...)
+    #
+    #    require 'despamilator_rails'
+    #
+    # In your model (basic example):
+    #
+    #    class YourModel < ActiveRecord::Base
+    #      validate_with_despamilator :attributes => [:some_field]
+    #    end
+    #
+    # When "some_field" is assigned a spammy value, it will add to the errors. For example...
+    #
+    #    YourModel.new(:some_field => spammy_value).save! #=> ActiveRecord::RecordInvalid exception!
+    #
+    # Or...
+    #
+    #    your_instance = YourModel.new(:some_field => spammy_value)
+    #    your_instance.save
+    #    your_instance.errors.full_messages.should #=> ["Some field looks like spam"]
+    #
+    # If you want to configure the threshold (which defaults to 1) or add your own callback, you can do the following:
+    #
+    #    class YourModel < ActiveRecord::Base
+    #      validate_with_despamilator :attributes => [:some_field], :threshold => 1 do |field, value, despamilator|
+    #        raise "spam! field: #{field}, value: #{value}, score: #{despamailtor.score}"
+    #      end
+    #    end
+    #
+    # This example will...
+    #
+    #    your_instance = YourModel.new(:some_field => "spammy string")
+    #    your_instance.save! #=> Exception "spam! field: some_field, value: spammy string, score: 123"
+    #
+    # The callback will receive the field name, the value and the instance of the Despamilator class.
+
+    def self.validate_with_despamilator settings, &block
+      assign_despamilator_attributes settings
+      assign_despamilator_threshold settings
+      assign_despamilator_callback block
+
+      add_despamilator_validation settings
+    end
+
+    private
+
+    class << self
+
+      def add_despamilator_validation settings
+
+        send(validation_method(:save), settings) do |record|
+
+          record.despamilator_checked_attributes.each do |attribute|
+            text  = record.send(attribute)
+            dspam = Despamilator.new(text)
+
+            record.despamilator_callback(attribute, text, dspam) if dspam.score >= record.despamilator_threshold
+          end
+
+        end
+
+      end
+
+      def assign_despamilator_attributes(settings)
+        clean_attributes = settings[:attributes].reject do |attribute|
+          attribute.blank?
+        end
+
+        raise('At least one attribute must be defined') if clean_attributes.empty?
+
+        define_method(:despamilator_checked_attributes, lambda { clean_attributes })
+      end
+
+      def assign_despamilator_threshold(settings)
+        define_method(:despamilator_threshold, lambda { settings[:threshold] || 1 })
+      end
+
+      def assign_despamilator_callback(block)
+        define_method(:despamilator_callback, block || default_despamilator_detection_response)
+      end
+
+      def default_despamilator_detection_response
+        lambda { |attribute, value, dspam|
+          errors.add(attribute, "looks like spam")
+        }
+      end
+
+    end
+
+  end
+
+end

data/spec/active_record_integration_spec.rb

@@ -0,0 +1,8 @@
+describe "active_record integration" do
+  it "should check for spam on save" do
+    some_instance = SomeModel.new
+    some_instance.some_field = Despamilator.gtubs_test_string
+
+    -> {some_instance.save!}.should raise_error(ActiveRecord::RecordInvalid)
+  end
+end

data/spec/despamilator_rails_spec.rb

@@ -0,0 +1,120 @@
+describe "despamilator_rails" do
+
+  it "should notify of spam detection in a railsy way" do
+
+    class SomeModelWithSpam < ActiveRecord::Base
+      set_table_name 'some_models'
+      validate_with_despamilator :attributes => [:some_field]
+    end
+
+    some_model            = SomeModelWithSpam.new
+    some_model.some_field = Despamilator.gtubs_test_string
+
+    -> {some_model.save!}.should raise_error(ActiveRecord::RecordInvalid)
+    some_model.errors.full_messages.should == ["Some field looks like spam"]
+  end
+
+  describe "threshold" do
+
+    it "should default to 1" do
+
+      class SomeModelWithDefaultThreshold < ActiveRecord::Base
+        set_table_name 'some_models'
+        validate_with_despamilator :attributes => [:some_field]
+      end
+
+      some_model            = SomeModelWithDefaultThreshold.new
+      some_model.despamilator_threshold.should == 1
+    end
+
+    it "should be settable" do
+
+      class SomeModelWithDefinedThreshold < ActiveRecord::Base
+        set_table_name 'some_models'
+        validate_with_despamilator :attributes => [:some_field], :threshold => 9
+      end
+
+      some_model            = SomeModelWithDefinedThreshold.new
+      some_model.despamilator_threshold.should == 9
+
+    end
+
+  end
+
+  describe "attributes" do
+
+    it "should cause an exception when an empty array is passed" do
+
+      ->{
+      class SomeModelWithMissingAttributes < ActiveRecord::Base
+        validate_with_despamilator :attributes => []
+      end
+      }.should raise_error('At least one attribute must be defined')
+
+    end
+
+    it "should cause an exception when an empty string is passed" do
+
+      -> {
+      class SomeModelWithEmptyAttributes < ActiveRecord::Base
+        validate_with_despamilator :attributes => ['']
+      end
+      }.should raise_error('At least one attribute must be defined')
+
+    end
+
+  end
+
+  it "should allow a block to be specified" do
+
+    class SomeModelWithABlock < ActiveRecord::Base
+      set_table_name 'some_models'
+
+      def do_something field, value, despamilator
+      end
+
+      validate_with_despamilator :attributes => [:some_field] do |field, value, despamilator|
+        do_something(field, value, despamilator)
+      end
+    end
+
+    fake_despamilator = mock('despamilator')
+    Despamilator.should_receive(:new).and_return(fake_despamilator)
+    fake_despamilator.should_receive(:score).and_return(10000)
+
+    some_model = SomeModelWithABlock.new
+    some_model.should_receive(:do_something).with(:some_field, 'blah', fake_despamilator)
+    some_model.some_field = 'blah'
+    some_model.save
+
+  end
+
+  it "should work nicely with other validate methods" do
+    class SomeModelWithAnotherValidate < ActiveRecord::Base
+      set_table_name 'some_models'
+
+      validate_with_despamilator :attributes => [:some_field] do |field, value, despamilator|
+        do_something
+      end
+
+      def do_something
+      end
+
+      def do_something_else
+      end
+
+      def validate
+        do_something_else
+      end
+
+    end
+
+    some_model            = SomeModelWithAnotherValidate.new
+    some_model.should_receive(:do_something)
+    some_model.should_receive(:do_something_else)
+    some_model.some_field = Despamilator.gtubs_test_string
+    some_model.save
+
+  end
+
+end

data/spec/fixtures/active_record_test_class.rb

@@ -0,0 +1,5 @@
+class SomeModel < ActiveRecord::Base
+
+  validate_with_despamilator :attributes => [:some_field]
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'one_hundred_percent_coverage'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'despamilator_rails')
+require 'active_record'
+
+Dir.glob(File.join(File.dirname(__FILE__), 'test_db_migrations', '*.rb')).each do |file|
+  require file
+end
+
+db_file = 'test.sqlite3'
+
+File.unlink(db_file) if File.exists?(db_file)
+
+ActiveRecord::Base.establish_connection(
+    :adapter  => 'sqlite3',
+    :database => db_file
+)
+
+CreateSomeModel.migrate(:up)
+
+Dir.glob(File.join(File.dirname(__FILE__), 'fixtures', '*.rb')).each do |file|
+  require file
+end

data/spec/test_db_migrations/create_test_model_table.rb

@@ -0,0 +1,10 @@
+class CreateSomeModel < ActiveRecord::Migration
+  ActiveRecord::Migration.verbose = false
+
+  def self.up
+    create_table :some_models do |t|
+      t.text :some_field
+    end
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: despamilator_rails
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Stephen Hardisty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-09 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: despamilator
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  Spam detection plugin for Rails & ActiveRecord. Uses all the standard Rails conventions and
+  my Despamilator gem.
+email: 
+- moowahaha@hotmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- despamilator-rails.gemspec
+- lib/despamilator_rails.rb
+- spec/active_record_integration_spec.rb
+- spec/despamilator_rails_spec.rb
+- spec/fixtures/active_record_test_class.rb
+- spec/spec_helper.rb
+- spec/test_db_migrations/create_test_model_table.rb
+has_rdoc: true
+homepage: https://github.com/moowahaha/despamilator-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: despamilator_rails
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Spam detection plugin for Rails & ActiveRecord
+test_files: []
+