despamilator 0.8 → 1.0

data/README.rdoc

@@ -10,13 +10,15 @@ some commonly used heuristics from the world of anti-spam to help you decide whe
 
 == FEATURES/PROBLEMS:
 
-* Added sexy rails validation!! :D
+* Moved Rails-esque validation gem to the despamilator-rails gem.
 
 == SYNOPSIS:
 
-  # using Despamilator
-  require 'rubygems'
-  require 'desplamilator'
+Using Despamilator:
+
+  require 'despamilator'
+
+  # some time later...
 
   dspam = Despamilator.new('some text with an <h2> tag qthhg')
 
@@ -27,35 +29,6 @@ some commonly used heuristics from the world of anti-spam to help you decide whe
   first_match.description #=> some string to describe
   first_match.score #=> the individual score assigned by this filter
 
-  # adding a new filter! example: detecting the letter "a"
-  # put the following code in lib/despamilator/filter/detect_letter_a.rb
-  def name
-    'Detecting the letter A'
-  end
-
-  def description
-    'Detects the letter "a" in a string for no reason other than a demo'
-  end
-
-  def parse
-    if self.text.downcase.scan(/a/)
-      # add 0.1 to the score of the text
-      self.append_score = 0.1
-    end
-  end
-
-== RAILS SYNOPSIS:
-
-    # in your environment.rb
-    require 'despamilator/validation'
-
-    # in your model
-    include DespamilatorValidation
-
-    def validate
-      validates_despamilation_of :text, :threshold => 1
-    end
-
 == FILTERING:
 
 As stated, this is a heuristic scanner so its up to the user to decide the thresholds of the scanner. I usually
@@ -76,17 +49,44 @@ They should always supply the following methods:
 
  * name #=> the name of your filter.
  * description #=> what your filter will look for.
- * parse #=> the method that will be called when parsing.
+ * parse(text) #=> the method that will be called when parsing. A copy of the message is passed in.
 
 Along side the above, the following methods are made available to each filter:
 
- * text #=> a copy of the text your parser will parse
  * append_score= #=> method to append a score to the text if there are matches in your parser.
  * matched? #=> whether or not any filter has so far detected something suspect
  * score #=> the current score assigned to the text
 
-spec tests are an absolute must!
+Take a look at the "naughty_q" code and tests in "spec/filters/naughty_q.rb".
+
+==== Example Filter:
+
+This example is to detect the letter "a". Put the code in
+lib/despamilator/filter/detect_letter_a.rb:
+
+  require 'despamilator/filter_base'
+
+  module DespamilatorFilter
+
+    class DetectLetterA < Despamilator::FilterBase
+
+      def name
+        'Detecting the letter A'
+      end
+
+      def description
+        'Detects the letter "a" in a string for no reason other than a demo'
+      end
+
+      def parse text
+        if text.downcase.scan(/a/)
+        # add 0.1 to the score of the text
+        self.append_score = 0.1
+      end
+    end
+  end
 
+As previously stated, ensure you put a spec test together as well!
 
 == REQUIREMENTS:
 
@@ -100,7 +100,7 @@ spec tests are an absolute must!
 
 == LICENSE:
 
-Copyright (c) 2010 Stephen Hardisty
+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

data/Rakefile

@@ -27,7 +27,14 @@ task :test => [:spec]
 task :default => [:test]
 task :install => [:install_gem]
 
+desc 'Generate relevant documentation.'
+task :rdoc do
+    sh 'rdoc lib/despamilator.rb lib/despamilator/filter_base.rb'
+end
+
 task :cultivate do
-  system "touch Manifest.txt; rake check_manifest | grep -v \"(in \" | patch"
-  system "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec |grep -v _spec.rb |grep -v _corpus"
-end
+  sh "touch Manifest.txt; rake check_manifest |grep -v \"(in \" | patch"
+  sh "cat Manifest.txt  | grep -v 'bundle/config' | grep -v '_corpus' > Manifest.txt2"
+  sh "mv Manifest.txt2 Manifest.txt"
+  sh "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec"
+end

data/despamilator.gemspec

@@ -2,38 +2,35 @@
 
 Gem::Specification.new do |s|
   s.name = %q{despamilator}
-  s.version = "0.7"
+  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{2010-09-01}
+  s.date = %q{2010-12-11}
   s.description = %q{Despamilator is a plugin based spam detector designed for use on your web forms borne out of two annoyances:
 Spam being submitted in my web forms and CAPTCHAS being intrusive. Despamilator will apply
 some commonly used heuristics from the world of anti-spam to help you decide whether your users are human or machine.}
   s.email = ["moowahaha@hotmail.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
-  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "despamilator.gemspec", "lib/despamilator.rb", "lib/despamilator/filter.rb", "lib/despamilator/filter/funky_consonant.rb", "lib/despamilator/filter/html_tags.rb", "lib/despamilator/filter/ip_address_url.rb", "lib/despamilator/filter/long_words.rb", "lib/despamilator/filter/naughty_q.rb", "lib/despamilator/filter/naughty_words.rb", "lib/despamilator/filter/numbers_and_words.rb", "lib/despamilator/filter/script_tag.rb", "lib/despamilator/filter/shouting.rb", "lib/despamilator/filter/square_brackets.rb", "lib/despamilator/filter/urls.rb", "lib/despamilator/filter_base.rb", "lib/despamilator/validation.rb", "scripts/despamilator_score.rb", "spec/clean_corpus/101.txt.gz", "spec/clean_corpus/103.txt.gz", "spec/clean_corpus/105.txt.gz", "spec/clean_corpus/107.txt.gz", "spec/clean_corpus/109.txt.gz", "spec/clean_corpus/111.txt.gz", "spec/clean_corpus/113.txt.gz", "spec/clean_corpus/115.txt.gz", "spec/clean_corpus/117.txt.gz", "spec/clean_corpus/119.txt.gz", "spec/clean_corpus/121.txt.gz", "spec/clean_corpus/123.txt.gz", "spec/clean_corpus/125.txt.gz", "spec/clean_corpus/127.txt.gz", "spec/clean_corpus/129.txt.gz", "spec/clean_corpus/131.txt.gz", "spec/clean_corpus/133.txt.gz", "spec/clean_corpus/135.txt.gz", "spec/clean_corpus/137.txt.gz", "spec/clean_corpus/139.txt.gz", "spec/clean_corpus/141.txt.gz", "spec/clean_corpus/143.txt.gz", "spec/clean_corpus/145.txt.gz", "spec/clean_corpus/147.txt.gz", "spec/clean_corpus/149.txt.gz", "spec/clean_corpus/151.txt.gz", "spec/clean_corpus/153.txt.gz", "spec/clean_corpus/155.txt.gz", "spec/clean_corpus/157.txt.gz", "spec/clean_corpus/159.txt.gz", "spec/clean_corpus/161.txt.gz", "spec/clean_corpus/163.txt.gz", "spec/clean_corpus/165.txt.gz", "spec/clean_corpus/167.txt.gz", "spec/clean_corpus/169.txt.gz", "spec/clean_corpus/171.txt.gz", "spec/clean_corpus/173.txt.gz", "spec/clean_corpus/175.txt.gz", "spec/clean_corpus/177.txt.gz", "spec/clean_corpus/179.txt.gz", "spec/clean_corpus/18.txt.gz", "spec/clean_corpus/181.txt.gz", "spec/clean_corpus/183.txt.gz", "spec/clean_corpus/185.txt.gz", "spec/clean_corpus/187.txt.gz", "spec/clean_corpus/189.txt.gz", "spec/clean_corpus/191.txt.gz", "spec/clean_corpus/193.txt.gz", "spec/clean_corpus/195.txt.gz", "spec/clean_corpus/197.txt.gz", "spec/clean_corpus/199.txt.gz", "spec/clean_corpus/20.txt.gz", "spec/clean_corpus/201.txt.gz", "spec/clean_corpus/203.txt.gz", "spec/clean_corpus/205.txt.gz", "spec/clean_corpus/207.txt.gz", "spec/clean_corpus/209.txt.gz", "spec/clean_corpus/211.txt.gz", "spec/clean_corpus/213.txt.gz", "spec/clean_corpus/215.txt.gz", "spec/clean_corpus/217.txt.gz", "spec/clean_corpus/219.txt.gz", "spec/clean_corpus/22.txt.gz", "spec/clean_corpus/221.txt.gz", "spec/clean_corpus/223.txt.gz", "spec/clean_corpus/225.txt.gz", "spec/clean_corpus/24.txt.gz", "spec/clean_corpus/26.txt.gz", "spec/clean_corpus/27.txt.gz", "spec/clean_corpus/29.txt.gz", "spec/clean_corpus/31.txt.gz", "spec/clean_corpus/33.txt.gz", "spec/clean_corpus/35.txt.gz", "spec/clean_corpus/37.txt.gz", "spec/clean_corpus/39.txt.gz", "spec/clean_corpus/41.txt.gz", "spec/clean_corpus/43.txt.gz", "spec/clean_corpus/45.txt.gz", "spec/clean_corpus/47.txt.gz", "spec/clean_corpus/49.txt.gz", "spec/clean_corpus/51.txt.gz", "spec/clean_corpus/53.txt.gz", "spec/clean_corpus/55.txt.gz", "spec/clean_corpus/57.txt.gz", "spec/clean_corpus/59.txt.gz", "spec/clean_corpus/61.txt.gz", "spec/clean_corpus/63.txt.gz", "spec/clean_corpus/65.txt.gz", "spec/clean_corpus/67.txt.gz", "spec/clean_corpus/69.txt.gz", "spec/clean_corpus/71.txt.gz", "spec/clean_corpus/73.txt.gz", "spec/clean_corpus/75.txt.gz", "spec/clean_corpus/77.txt.gz", "spec/clean_corpus/79.txt.gz", "spec/clean_corpus/81.txt.gz", "spec/clean_corpus/83.txt.gz", "spec/clean_corpus/85.txt.gz", "spec/clean_corpus/87.txt.gz", "spec/clean_corpus/89.txt.gz", "spec/clean_corpus/91.txt.gz", "spec/clean_corpus/93.txt.gz", "spec/clean_corpus/95.txt.gz", "spec/clean_corpus/97.txt.gz", "spec/clean_corpus/99.txt.gz", "spec/clean_corpus_spec.rb", "spec/despamilator_spec.rb", "spec/despamilator_validation_spec.rb", "spec/filters/funky_consonant_spec.rb", "spec/filters/html_tags_spec.rb", "spec/filters/ip_address_url_spec.rb", "spec/filters/long_words_spec.rb", "spec/filters/naughty_q_spec.rb", "spec/filters/naughty_words_spec.rb", "spec/filters/numbers_and_words_spec.rb", "spec/filters/script_tag_spec.rb", "spec/filters/shouting_spec.rb", "spec/filters/square_brackets_spec.rb", "spec/filters/urls_spec.rb", "spec/spam_corpus/0.txt.gz", "spec/spam_corpus/1.txt.gz", "spec/spam_corpus/10.txt.gz", "spec/spam_corpus/100.txt.gz", "spec/spam_corpus/102.txt.gz", "spec/spam_corpus/104.txt.gz", "spec/spam_corpus/106.txt.gz", "spec/spam_corpus/108.txt.gz", "spec/spam_corpus/11.txt.gz", "spec/spam_corpus/110.txt.gz", "spec/spam_corpus/112.txt.gz", "spec/spam_corpus/114.txt.gz", "spec/spam_corpus/116.txt.gz", "spec/spam_corpus/118.txt.gz", "spec/spam_corpus/12.txt.gz", "spec/spam_corpus/120.txt.gz", "spec/spam_corpus/122.txt.gz", "spec/spam_corpus/124.txt.gz", "spec/spam_corpus/126.txt.gz", "spec/spam_corpus/128.txt.gz", "spec/spam_corpus/13.txt.gz", "spec/spam_corpus/130.txt.gz", "spec/spam_corpus/132.txt.gz", "spec/spam_corpus/134.txt.gz", "spec/spam_corpus/136.txt.gz", "spec/spam_corpus/138.txt.gz", "spec/spam_corpus/14.txt.gz", "spec/spam_corpus/140.txt.gz", "spec/spam_corpus/142.txt.gz", "spec/spam_corpus/144.txt.gz", "spec/spam_corpus/146.txt.gz", "spec/spam_corpus/148.txt.gz", "spec/spam_corpus/15.txt.gz", "spec/spam_corpus/150.txt.gz", "spec/spam_corpus/152.txt.gz", "spec/spam_corpus/154.txt.gz", "spec/spam_corpus/156.txt.gz", "spec/spam_corpus/158.txt.gz", "spec/spam_corpus/16.txt.gz", "spec/spam_corpus/160.txt.gz", "spec/spam_corpus/162.txt.gz", "spec/spam_corpus/164.txt.gz", "spec/spam_corpus/166.txt.gz", "spec/spam_corpus/168.txt.gz", "spec/spam_corpus/170.txt.gz", "spec/spam_corpus/172.txt.gz", "spec/spam_corpus/174.txt.gz", "spec/spam_corpus/176.txt.gz", "spec/spam_corpus/178.txt.gz", "spec/spam_corpus/180.txt.gz", "spec/spam_corpus/182.txt.gz", "spec/spam_corpus/184.txt.gz", "spec/spam_corpus/186.txt.gz", "spec/spam_corpus/188.txt.gz", "spec/spam_corpus/190.txt.gz", "spec/spam_corpus/192.txt.gz", "spec/spam_corpus/194.txt.gz", "spec/spam_corpus/196.txt.gz", "spec/spam_corpus/198.txt.gz", "spec/spam_corpus/2.txt.gz", "spec/spam_corpus/200.txt.gz", "spec/spam_corpus/202.txt.gz", "spec/spam_corpus/204.txt.gz", "spec/spam_corpus/206.txt.gz", "spec/spam_corpus/208.txt.gz", "spec/spam_corpus/210.txt.gz", "spec/spam_corpus/212.txt.gz", "spec/spam_corpus/214.txt.gz", "spec/spam_corpus/216.txt.gz", "spec/spam_corpus/218.txt.gz", "spec/spam_corpus/220.txt.gz", "spec/spam_corpus/222.txt.gz", "spec/spam_corpus/224.txt.gz", "spec/spam_corpus/226.txt.gz", "spec/spam_corpus/228.txt.gz", "spec/spam_corpus/230.txt.gz", "spec/spam_corpus/232.txt.gz", "spec/spam_corpus/234.txt.gz", "spec/spam_corpus/236.txt.gz", "spec/spam_corpus/238.txt.gz", "spec/spam_corpus/240.txt.gz", "spec/spam_corpus/242.txt.gz", "spec/spam_corpus/244.txt.gz", "spec/spam_corpus/246.txt.gz", "spec/spam_corpus/248.txt.gz", "spec/spam_corpus/250.txt.gz", "spec/spam_corpus/252.txt.gz", "spec/spam_corpus/254.txt.gz", "spec/spam_corpus/256.txt.gz", "spec/spam_corpus/258.txt.gz", "spec/spam_corpus/260.txt.gz", "spec/spam_corpus/262.txt.gz", "spec/spam_corpus/264.txt.gz", "spec/spam_corpus/266.txt.gz", "spec/spam_corpus/268.txt.gz", "spec/spam_corpus/270.txt.gz", "spec/spam_corpus/272.txt.gz", "spec/spam_corpus/274.txt.gz", "spec/spam_corpus/276.txt.gz", "spec/spam_corpus/278.txt.gz", "spec/spam_corpus/28.txt.gz", "spec/spam_corpus/280.txt.gz", "spec/spam_corpus/282.txt.gz", "spec/spam_corpus/284.txt.gz", "spec/spam_corpus/286.txt.gz", "spec/spam_corpus/288.txt.gz", "spec/spam_corpus/290.txt.gz", "spec/spam_corpus/292.txt.gz", "spec/spam_corpus/294.txt.gz", "spec/spam_corpus/296.txt.gz", "spec/spam_corpus/298.txt.gz", "spec/spam_corpus/3.txt.gz", "spec/spam_corpus/30.txt.gz", "spec/spam_corpus/300.txt.gz", "spec/spam_corpus/302.txt.gz", "spec/spam_corpus/304.txt.gz", "spec/spam_corpus/306.txt.gz", "spec/spam_corpus/308.txt.gz", "spec/spam_corpus/310.txt.gz", "spec/spam_corpus/312.txt.gz", "spec/spam_corpus/314.txt.gz", "spec/spam_corpus/316.txt.gz", "spec/spam_corpus/318.txt.gz", "spec/spam_corpus/32.txt.gz", "spec/spam_corpus/320.txt.gz", "spec/spam_corpus/322.txt.gz", "spec/spam_corpus/324.txt.gz", "spec/spam_corpus/326.txt.gz", "spec/spam_corpus/328.txt.gz", "spec/spam_corpus/330.txt.gz", "spec/spam_corpus/332.txt.gz", "spec/spam_corpus/334.txt.gz", "spec/spam_corpus/336.txt.gz", "spec/spam_corpus/338.txt.gz", "spec/spam_corpus/34.txt.gz", "spec/spam_corpus/340.txt.gz", "spec/spam_corpus/342.txt.gz", "spec/spam_corpus/344.txt.gz", "spec/spam_corpus/346.txt.gz", "spec/spam_corpus/348.txt.gz", "spec/spam_corpus/350.txt.gz", "spec/spam_corpus/352.txt.gz", "spec/spam_corpus/354.txt.gz", "spec/spam_corpus/356.txt.gz", "spec/spam_corpus/358.txt.gz", "spec/spam_corpus/36.txt.gz", "spec/spam_corpus/360.txt.gz", "spec/spam_corpus/362.txt.gz", "spec/spam_corpus/364.txt.gz", "spec/spam_corpus/366.txt.gz", "spec/spam_corpus/368.txt.gz", "spec/spam_corpus/370.txt.gz", "spec/spam_corpus/372.txt.gz", "spec/spam_corpus/374.txt.gz", "spec/spam_corpus/376.txt.gz", "spec/spam_corpus/378.txt.gz", "spec/spam_corpus/38.txt.gz", "spec/spam_corpus/380.txt.gz", "spec/spam_corpus/382.txt.gz", "spec/spam_corpus/384.txt.gz", "spec/spam_corpus/386.txt.gz", "spec/spam_corpus/388.txt.gz", "spec/spam_corpus/390.txt.gz", "spec/spam_corpus/392.txt.gz", "spec/spam_corpus/394.txt.gz", "spec/spam_corpus/396.txt.gz", "spec/spam_corpus/398.txt.gz", "spec/spam_corpus/4.txt.gz", "spec/spam_corpus/40.txt.gz", "spec/spam_corpus/400.txt.gz", "spec/spam_corpus/402.txt.gz", "spec/spam_corpus/404.txt.gz", "spec/spam_corpus/406.txt.gz", "spec/spam_corpus/408.txt.gz", "spec/spam_corpus/410.txt.gz", "spec/spam_corpus/412.txt.gz", "spec/spam_corpus/414.txt.gz", "spec/spam_corpus/416.txt.gz", "spec/spam_corpus/418.txt.gz", "spec/spam_corpus/42.txt.gz", "spec/spam_corpus/420.txt.gz", "spec/spam_corpus/422.txt.gz", "spec/spam_corpus/424.txt.gz", "spec/spam_corpus/426.txt.gz", "spec/spam_corpus/428.txt.gz", "spec/spam_corpus/430.txt.gz", "spec/spam_corpus/432.txt.gz", "spec/spam_corpus/434.txt.gz", "spec/spam_corpus/436.txt.gz", "spec/spam_corpus/438.txt.gz", "spec/spam_corpus/44.txt.gz", "spec/spam_corpus/440.txt.gz", "spec/spam_corpus/442.txt.gz", "spec/spam_corpus/444.txt.gz", "spec/spam_corpus/446.txt.gz", "spec/spam_corpus/448.txt.gz", "spec/spam_corpus/450.txt.gz", "spec/spam_corpus/452.txt.gz", "spec/spam_corpus/454.txt.gz", "spec/spam_corpus/456.txt.gz", "spec/spam_corpus/458.txt.gz", "spec/spam_corpus/46.txt.gz", "spec/spam_corpus/460.txt.gz", "spec/spam_corpus/462.txt.gz", "spec/spam_corpus/464.txt.gz", "spec/spam_corpus/466.txt.gz", "spec/spam_corpus/468.txt.gz", "spec/spam_corpus/470.txt.gz", "spec/spam_corpus/472.txt.gz", "spec/spam_corpus/474.txt.gz", "spec/spam_corpus/476.txt.gz", "spec/spam_corpus/478.txt.gz", "spec/spam_corpus/48.txt.gz", "spec/spam_corpus/480.txt.gz", "spec/spam_corpus/482.txt.gz", "spec/spam_corpus/484.txt.gz", "spec/spam_corpus/486.txt.gz", "spec/spam_corpus/488.txt.gz", "spec/spam_corpus/490.txt.gz", "spec/spam_corpus/492.txt.gz", "spec/spam_corpus/494.txt.gz", "spec/spam_corpus/496.txt.gz", "spec/spam_corpus/498.txt.gz", "spec/spam_corpus/5.txt.gz", "spec/spam_corpus/50.txt.gz", "spec/spam_corpus/500.txt.gz", "spec/spam_corpus/502.txt.gz", "spec/spam_corpus/504.txt.gz", "spec/spam_corpus/506.txt.gz", "spec/spam_corpus/508.txt.gz", "spec/spam_corpus/510.txt.gz", "spec/spam_corpus/512.txt.gz", "spec/spam_corpus/514.txt.gz", "spec/spam_corpus/516.txt.gz", "spec/spam_corpus/518.txt.gz", "spec/spam_corpus/52.txt.gz", "spec/spam_corpus/520.txt.gz", "spec/spam_corpus/522.txt.gz", "spec/spam_corpus/524.txt.gz", "spec/spam_corpus/526.txt.gz", "spec/spam_corpus/528.txt.gz", "spec/spam_corpus/530.txt.gz", "spec/spam_corpus/532.txt.gz", "spec/spam_corpus/534.txt.gz", "spec/spam_corpus/536.txt.gz", "spec/spam_corpus/538.txt.gz", "spec/spam_corpus/54.txt.gz", "spec/spam_corpus/540.txt.gz", "spec/spam_corpus/542.txt.gz", "spec/spam_corpus/544.txt.gz", "spec/spam_corpus/546.txt.gz", "spec/spam_corpus/548.txt.gz", "spec/spam_corpus/550.txt.gz", "spec/spam_corpus/552.txt.gz", "spec/spam_corpus/554.txt.gz", "spec/spam_corpus/556.txt.gz", "spec/spam_corpus/558.txt.gz", "spec/spam_corpus/56.txt.gz", "spec/spam_corpus/560.txt.gz", "spec/spam_corpus/562.txt.gz", "spec/spam_corpus/564.txt.gz", "spec/spam_corpus/566.txt.gz", "spec/spam_corpus/568.txt.gz", "spec/spam_corpus/570.txt.gz", "spec/spam_corpus/572.txt.gz", "spec/spam_corpus/574.txt.gz", "spec/spam_corpus/576.txt.gz", "spec/spam_corpus/578.txt.gz", "spec/spam_corpus/58.txt.gz", "spec/spam_corpus/580.txt.gz", "spec/spam_corpus/582.txt.gz", "spec/spam_corpus/584.txt.gz", "spec/spam_corpus/586.txt.gz", "spec/spam_corpus/588.txt.gz", "spec/spam_corpus/590.txt.gz", "spec/spam_corpus/592.txt.gz", "spec/spam_corpus/594.txt.gz", "spec/spam_corpus/596.txt.gz", "spec/spam_corpus/598.txt.gz", "spec/spam_corpus/6.txt.gz", "spec/spam_corpus/60.txt.gz", "spec/spam_corpus/600.txt.gz", "spec/spam_corpus/602.txt.gz", "spec/spam_corpus/604.txt.gz", "spec/spam_corpus/606.txt.gz", "spec/spam_corpus/608.txt.gz", "spec/spam_corpus/610.txt.gz", "spec/spam_corpus/612.txt.gz", "spec/spam_corpus/614.txt.gz", "spec/spam_corpus/616.txt.gz", "spec/spam_corpus/618.txt.gz", "spec/spam_corpus/62.txt.gz", "spec/spam_corpus/620.txt.gz", "spec/spam_corpus/622.txt.gz", "spec/spam_corpus/624.txt.gz", "spec/spam_corpus/626.txt.gz", "spec/spam_corpus/628.txt.gz", "spec/spam_corpus/630.txt.gz", "spec/spam_corpus/632.txt.gz", "spec/spam_corpus/634.txt.gz", "spec/spam_corpus/636.txt.gz", "spec/spam_corpus/638.txt.gz", "spec/spam_corpus/64.txt.gz", "spec/spam_corpus/640.txt.gz", "spec/spam_corpus/642.txt.gz", "spec/spam_corpus/644.txt.gz", "spec/spam_corpus/646.txt.gz", "spec/spam_corpus/648.txt.gz", "spec/spam_corpus/650.txt.gz", "spec/spam_corpus/652.txt.gz", "spec/spam_corpus/654.txt.gz", "spec/spam_corpus/656.txt.gz", "spec/spam_corpus/658.txt.gz", "spec/spam_corpus/66.txt.gz", "spec/spam_corpus/660.txt.gz", "spec/spam_corpus/662.txt.gz", "spec/spam_corpus/664.txt.gz", "spec/spam_corpus/666.txt.gz", "spec/spam_corpus/668.txt.gz", "spec/spam_corpus/670.txt.gz", "spec/spam_corpus/672.txt.gz", "spec/spam_corpus/674.txt.gz", "spec/spam_corpus/676.txt.gz", "spec/spam_corpus/678.txt.gz", "spec/spam_corpus/68.txt.gz", "spec/spam_corpus/680.txt.gz", "spec/spam_corpus/682.txt.gz", "spec/spam_corpus/684.txt.gz", "spec/spam_corpus/686.txt.gz", "spec/spam_corpus/688.txt.gz", "spec/spam_corpus/690.txt.gz", "spec/spam_corpus/692.txt.gz", "spec/spam_corpus/694.txt.gz", "spec/spam_corpus/696.txt.gz", "spec/spam_corpus/698.txt.gz", "spec/spam_corpus/7.txt.gz", "spec/spam_corpus/70.txt.gz", "spec/spam_corpus/700.txt.gz", "spec/spam_corpus/702.txt.gz", "spec/spam_corpus/704.txt.gz", "spec/spam_corpus/706.txt.gz", "spec/spam_corpus/708.txt.gz", "spec/spam_corpus/710.txt.gz", "spec/spam_corpus/712.txt.gz", "spec/spam_corpus/714.txt.gz", "spec/spam_corpus/716.txt.gz", "spec/spam_corpus/718.txt.gz", "spec/spam_corpus/72.txt.gz", "spec/spam_corpus/720.txt.gz", "spec/spam_corpus/722.txt.gz", "spec/spam_corpus/724.txt.gz", "spec/spam_corpus/726.txt.gz", "spec/spam_corpus/728.txt.gz", "spec/spam_corpus/730.txt.gz", "spec/spam_corpus/732.txt.gz", "spec/spam_corpus/734.txt.gz", "spec/spam_corpus/736.txt.gz", "spec/spam_corpus/738.txt.gz", "spec/spam_corpus/74.txt.gz", "spec/spam_corpus/740.txt.gz", "spec/spam_corpus/742.txt.gz", "spec/spam_corpus/744.txt.gz", "spec/spam_corpus/746.txt.gz", "spec/spam_corpus/748.txt.gz", "spec/spam_corpus/750.txt.gz", "spec/spam_corpus/752.txt.gz", "spec/spam_corpus/754.txt.gz", "spec/spam_corpus/756.txt.gz", "spec/spam_corpus/758.txt.gz", "spec/spam_corpus/76.txt.gz", "spec/spam_corpus/760.txt.gz", "spec/spam_corpus/762.txt.gz", "spec/spam_corpus/764.txt.gz", "spec/spam_corpus/766.txt.gz", "spec/spam_corpus/768.txt.gz", "spec/spam_corpus/770.txt.gz", "spec/spam_corpus/772.txt.gz", "spec/spam_corpus/774.txt.gz", "spec/spam_corpus/776.txt.gz", "spec/spam_corpus/778.txt.gz", "spec/spam_corpus/78.txt.gz", "spec/spam_corpus/780.txt.gz", "spec/spam_corpus/782.txt.gz", "spec/spam_corpus/784.txt.gz", "spec/spam_corpus/786.txt.gz", "spec/spam_corpus/788.txt.gz", "spec/spam_corpus/790.txt.gz", "spec/spam_corpus/792.txt.gz", "spec/spam_corpus/794.txt.gz", "spec/spam_corpus/796.txt.gz", "spec/spam_corpus/798.txt.gz", "spec/spam_corpus/8.txt.gz", "spec/spam_corpus/80.txt.gz", "spec/spam_corpus/800.txt.gz", "spec/spam_corpus/802.txt.gz", "spec/spam_corpus/804.txt.gz", "spec/spam_corpus/806.txt.gz", "spec/spam_corpus/808.txt.gz", "spec/spam_corpus/810.txt.gz", "spec/spam_corpus/812.txt.gz", "spec/spam_corpus/814.txt.gz", "spec/spam_corpus/816.txt.gz", "spec/spam_corpus/818.txt.gz", "spec/spam_corpus/82.txt.gz", "spec/spam_corpus/820.txt.gz", "spec/spam_corpus/822.txt.gz", "spec/spam_corpus/824.txt.gz", "spec/spam_corpus/826.txt.gz", "spec/spam_corpus/828.txt.gz", "spec/spam_corpus/830.txt.gz", "spec/spam_corpus/832.txt.gz", "spec/spam_corpus/834.txt.gz", "spec/spam_corpus/836.txt.gz", "spec/spam_corpus/838.txt.gz", "spec/spam_corpus/84.txt.gz", "spec/spam_corpus/840.txt.gz", "spec/spam_corpus/842.txt.gz", "spec/spam_corpus/844.txt.gz", "spec/spam_corpus/846.txt.gz", "spec/spam_corpus/848.txt.gz", "spec/spam_corpus/850.txt.gz", "spec/spam_corpus/852.txt.gz", "spec/spam_corpus/854.txt.gz", "spec/spam_corpus/856.txt.gz", "spec/spam_corpus/858.txt.gz", "spec/spam_corpus/86.txt.gz", "spec/spam_corpus/860.txt.gz", "spec/spam_corpus/862.txt.gz", "spec/spam_corpus/864.txt.gz", "spec/spam_corpus/866.txt.gz", "spec/spam_corpus/868.txt.gz", "spec/spam_corpus/870.txt.gz", "spec/spam_corpus/872.txt.gz", "spec/spam_corpus/874.txt.gz", "spec/spam_corpus/876.txt.gz", "spec/spam_corpus/878.txt.gz", "spec/spam_corpus/88.txt.gz", "spec/spam_corpus/880.txt.gz", "spec/spam_corpus/882.txt.gz", "spec/spam_corpus/884.txt.gz", "spec/spam_corpus/886.txt.gz", "spec/spam_corpus/888.txt.gz", "spec/spam_corpus/890.txt.gz", "spec/spam_corpus/892.txt.gz", "spec/spam_corpus/894.txt.gz", "spec/spam_corpus/896.txt.gz", "spec/spam_corpus/898.txt.gz", "spec/spam_corpus/9.txt.gz", "spec/spam_corpus/90.txt.gz", "spec/spam_corpus/900.txt.gz", "spec/spam_corpus/902.txt.gz", "spec/spam_corpus/904.txt.gz", "spec/spam_corpus/906.txt.gz", "spec/spam_corpus/908.txt.gz", "spec/spam_corpus/910.txt.gz", "spec/spam_corpus/912.txt.gz", "spec/spam_corpus/914.txt.gz", "spec/spam_corpus/916.txt.gz", "spec/spam_corpus/918.txt.gz", "spec/spam_corpus/92.txt.gz", "spec/spam_corpus/920.txt.gz", "spec/spam_corpus/922.txt.gz", "spec/spam_corpus/924.txt.gz", "spec/spam_corpus/926.txt.gz", "spec/spam_corpus/928.txt.gz", "spec/spam_corpus/930.txt.gz", "spec/spam_corpus/932.txt.gz", "spec/spam_corpus/934.txt.gz", "spec/spam_corpus/936.txt.gz", "spec/spam_corpus/938.txt.gz", "spec/spam_corpus/94.txt.gz", "spec/spam_corpus/940.txt.gz", "spec/spam_corpus/942.txt.gz", "spec/spam_corpus/944.txt.gz", "spec/spam_corpus/946.txt.gz", "spec/spam_corpus/948.txt.gz", "spec/spam_corpus/950.txt.gz", "spec/spam_corpus/952.txt.gz", "spec/spam_corpus/954.txt.gz", "spec/spam_corpus/956.txt.gz", "spec/spam_corpus/958.txt.gz", "spec/spam_corpus/96.txt.gz", "spec/spam_corpus/960.txt.gz", "spec/spam_corpus/962.txt.gz", "spec/spam_corpus/964.txt.gz", "spec/spam_corpus/966.txt.gz", "spec/spam_corpus/968.txt.gz", "spec/spam_corpus/970.txt.gz", "spec/spam_corpus/972.txt.gz", "spec/spam_corpus/974.txt.gz", "spec/spam_corpus/98.txt.gz", "spec/spam_corpus/debugyouradd.com.txt.gz", "spec/spam_corpus/humandesignconsulting.comm.txt.gz", "spec/spam_corpus_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
+  s.files = [".rspec", ".rvmrc", "Gemfile", "Gemfile.lock", "History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "despamilator.gemspec", "lib/despamilator.rb", "lib/despamilator/filter.rb", "lib/despamilator/filter/funky_consonant.rb", "lib/despamilator/filter/html_tags.rb", "lib/despamilator/filter/ip_address_url.rb", "lib/despamilator/filter/long_words.rb", "lib/despamilator/filter/naughty_q.rb", "lib/despamilator/filter/naughty_words.rb", "lib/despamilator/filter/numbers_and_words.rb", "lib/despamilator/filter/script_tag.rb", "lib/despamilator/filter/shouting.rb", "lib/despamilator/filter/square_brackets.rb", "lib/despamilator/filter/urls.rb", "lib/despamilator/filter_base.rb", "scripts/despamilator_score.rb", "spec/despamilator_spec.rb", "spec/filter_base_spec.rb", "spec/filters/funky_consonant_spec.rb", "spec/filters/html_tags_spec.rb", "spec/filters/ip_address_url_spec.rb", "spec/filters/long_words_spec.rb", "spec/filters/naughty_q_spec.rb", "spec/filters/naughty_words_spec.rb", "spec/filters/numbers_and_words_spec.rb", "spec/filters/script_tag_spec.rb", "spec/filters/shouting_spec.rb", "spec/filters/square_brackets_spec.rb", "spec/filters/urls_spec.rb", "spec/helpers/corpus_helper.rb", "spec/helpers/filter_helper.rb", "spec/helpers/spec_helper.rb", "tasks/test.rake"]
   s.homepage = %q{http://github.com/moowahaha/despamilator}
   s.post_install_message = %q{PostInstall.txt}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{despamilator}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Despamilator is a plugin based spam detector designed for use on your web forms borne out of two annoyances: Spam being submitted in my web forms and CAPTCHAS being intrusive}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rubyforge>, [">= 2.0.4"])
-      s.add_development_dependency(%q<hoe>, [">= 2.6.0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 2.7.0"])
     else
-      s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
-      s.add_dependency(%q<hoe>, [">= 2.6.0"])
+      s.add_dependency(%q<hoe>, [">= 2.7.0"])
     end
   else
-    s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
-    s.add_dependency(%q<hoe>, [">= 2.6.0"])
+    s.add_dependency(%q<hoe>, [">= 2.7.0"])
   end
 end

data/lib/despamilator.rb

@@ -2,18 +2,43 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) ||
 
 require 'despamilator/filter'
 
+#== SYNOPSIS:
+#
+#  require 'despamilator'
+#
+#  # some time later...
+#
+#  dspam = Despamilator.new('some text with an <h2> tag qthhg')
+#
+#  dspam.score #=> the total score for this string (1 is normally my threshold)
+#  dspam.matched_by #=> array of matching filters
+
 class Despamilator
-  VERSION = "0.8"
+  VERSION = "1.0"
+
+  # Constructor. Takes the text you which to parse and score.
 
   def initialize text
     @filters = Despamilator::Filter.new text
   end
 
+  # Returns the total score as a Float.
+
   def score
     @filters.score
   end
 
+  # Returns an array of filters that have matched and contributed to the score.
+  # Each element is a a child of the Despamilator::FilterBase class.
+
   def matched_by
     @filters.matches
   end
+
+  # Generic Test for Unsolicited Bulk Submissions. Similar to SpamAssassin's GTUBE.
+  # A string that will result in a spam score of at least 100. Handy for testing.
+
+  def self.gtubs_test_string
+    '89913b8a065b7092721fe995877e097681683af9d3ab767146d5d6fd050fc0bda7ab99f4232d94a1'
+  end
 end

data/lib/despamilator/filter.rb

@@ -3,46 +3,35 @@ class Despamilator
     attr_accessor :matches, :score
 
     def initialize text
-      @filters ||= []
       @matches ||= []
       @score ||= 0
-      load_filters text
-      run_filters
+      run_filters text
     end
 
     private
 
-    def load_filters text
-      Dir.glob(File.dirname(__FILE__) + "/filter/*.rb").each do |filter_file|
-        filter_name = classify_filename filter_file
+    def run_filters text
+      filter_namespace = Object.const_get('DespamilatorFilter')
 
-        filter_code = File.open(filter_file, File::RDWR).read
-        filter = Class.new
-        filter.class_eval(
-                "require 'despamilator/filter_base'\nclass #{filter_name} < Despamilator::FilterBase\n#{filter_code}\nend"
-        )
-
-        @filters.push(filter.const_get(filter_name).new(text.to_s.dup, File.basename(filter_file)))
+      filter_namespace.constants.each do |filter_class|
+        execute_filter(filter_namespace.const_get(filter_class).new, text)
       end
     end
 
-    def run_filters
-      @filters.each do |filter|
-        filter.parse
+    private
+
+    def execute_filter filter, text
+      filter.parse text.dup
 
-        if filter.matched?
-          @matches.push(filter)
-          @score += filter.score
-        end
+      if filter.matched?
+        @matches.push(filter)
+        @score += filter.score
       end
     end
 
-    def classify_filename filename
-      classname = ''
-      File.basename(filename).gsub(/\.rb$/, '').split('_').each do |filename_part|
-        classname += filename_part.capitalize
-      end
-      classname || filename.capitalize
+    Dir.glob(File.join(File.dirname(__FILE__), 'filter', '*.rb')).each do |filter_file|
+      require filter_file
     end
+
   end
 end

data/lib/despamilator/filter/funky_consonant.rb

@@ -1,21 +1,31 @@
-def name
-  'Funky Consonant'
-end
+require 'despamilator/filter_base'
 
-def description
-  'Detects and scores each occurrence of a consonant next to an unlikely character'
-end
+module DespamilatorFilter
+
+  class FunkyConsonant < Despamilator::FilterBase
 
-def parse
-  text = self.text.downcase
+    def name
+      'Funky Consonant'
+    end
 
-  consonant_pairs.each do |pair|
-    [pair, pair.reverse].each do |combo_pair|
-      self.append_score = 0.05 unless text.scan(/#{combo_pair}/).empty?
+    def description
+      'Detects and scores each occurrence of a consonant next to an unlikely character'
     end
+
+    def parse text
+      text.downcase!
+
+      consonant_pairs.each do |pair|
+        [pair, pair.reverse].each do |combo_pair|
+          self.append_score = 0.05 unless text.scan(/#{combo_pair}/).empty?
+        end
+      end
+    end
+
+    def consonant_pairs
+      %w{ zt gb vk vt jk mj dm jm xz bn }
+    end
+    
   end
-end
 
-def consonant_pairs
-  %w{ zt gb vk vt jk mj dm jm }
-end
+end

data/lib/despamilator/filter/html_tags.rb

@@ -1,116 +1,127 @@
-def parse
-  html = self.text.downcase
+require 'despamilator/filter_base'
 
-  html_tags.each do |tag|
-    if html.match(/<\s*#{tag}\W/) || html.match(/<\n*#{tag}\W/) || html.match(/\W#{tag}\s*\//) || html.match(/\W#{tag}\n*\//)
-      self.append_score = 0.3
+module DespamilatorFilter
+
+  class HtmlTags < Despamilator::FilterBase
+
+    def parse text
+      text.downcase!
+
+      html_tags.each do |tag|
+        if text.match(/<\s*#{tag}\W/) || text.match(/<\n*#{tag}\W/) || text.match(/\W#{tag}\s*\//) || text.match(/\W#{tag}\n*\//)
+          self.append_score = 0.3
+        end
+      end
     end
-  end
-end
 
-def name
-  'Detects HTML tags in text'
-end
+    def name
+      'HTML tags'
+    end
 
-def description
-  'Searches for various HTML tags'
-end
+    def description
+      'Detects HTML tags in text'
+    end
+
+    def html_tags
+      # make sure these are lowercase, in order to save processing
+      [
+              '!--',
+              '!doctype',
+              'a',
+              'abbr',
+              'acronym',
+              'address',
+              'applet',
+              'area',
+              'b',
+              'base',
+              'basefont',
+              'bdo',
+              'big',
+              'blockquote',
+              'body',
+              'br',
+              'button',
+              'caption',
+              'center',
+              'cite',
+              'code',
+              'col',
+              'colgroup',
+              'dd',
+              'del',
+              'dfn',
+              'dir',
+              'div',
+              'dl',
+              'dt',
+              'em',
+              'fieldset',
+              'font',
+              'form',
+              'frame',
+              'frameset',
+              'h1',
+              'h2',
+              'h3',
+              'h4',
+              'h5',
+              'h6',
+              'head',
+              'hr',
+              'html',
+              'i',
+              'iframe',
+              'img',
+              'input',
+              'ins',
+              'isindex',
+              'kbd',
+              'label',
+              'legend',
+              'li',
+              'link',
+              'map',
+              'menu',
+              'meta',
+              'noframes',
+              'noscript',
+              'object',
+              'ol',
+              'optgroup',
+              'option',
+              'p',
+              'param',
+              'pre',
+              'q',
+              's',
+              'samp',
+              'select',
+              'small',
+              'span',
+              'strike',
+              'strong',
+              'style',
+              'sub',
+              'sup',
+              'table',
+              'tbody',
+              'td',
+              'textarea',
+              'tfoot',
+              'th',
+              'thead',
+              'title',
+              'tr',
+              'tt',
+              'u',
+              'ul',
+              'var',
+              'xmp'
+      ]
+
+    end
 
-def html_tags
-  # make sure these are lowercase, in order to save processing
-  [
-          '!--',
-          '!doctype',
-          'a',
-          'abbr',
-          'acronym',
-          'address',
-          'applet',
-          'area',
-          'b',
-          'base',
-          'basefont',
-          'bdo',
-          'big',
-          'blockquote',
-          'body',
-          'br',
-          'button',
-          'caption',
-          'center',
-          'cite',
-          'code',
-          'col',
-          'colgroup',
-          'dd',
-          'del',
-          'dfn',
-          'dir',
-          'div',
-          'dl',
-          'dt',
-          'em',
-          'fieldset',
-          'font',
-          'form',
-          'frame',
-          'frameset',
-          'h1',
-          'h2',
-          'h3',
-          'h4',
-          'h5',
-          'h6',
-          'head',
-          'hr',
-          'html',
-          'i',
-          'iframe',
-          'img',
-          'input',
-          'ins',
-          'isindex',
-          'kbd',
-          'label',
-          'legend',
-          'li',
-          'link',
-          'map',
-          'menu',
-          'meta',
-          'noframes',
-          'noscript',
-          'object',
-          'ol',
-          'optgroup',
-          'option',
-          'p',
-          'param',
-          'pre',
-          'q',
-          's',
-          'samp',
-          'select',
-          'small',
-          'span',
-          'strike',
-          'strong',
-          'style',
-          'sub',
-          'sup',
-          'table',
-          'tbody',
-          'td',
-          'textarea',
-          'tfoot',
-          'th',
-          'thead',
-          'title',
-          'tr',
-          'tt',
-          'u',
-          'ul',
-          'var',
-          'xmp'
-  ]
-end
+  end
+
+end