em-spamc 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'eventmachine'
+
+group :development do
+  gem 'bundler'
+  gem 'jeweler', '~> 1.8.4'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Scott Tadman, The Working Group Inc.
+
+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.md

@@ -0,0 +1,8 @@
+#em-spamc
+
+SpamAssassin Connection for EventMachine
+
+##Copyright
+
+Copyright (c) 2013 Scott Tadman, Stephan Leroux, The Working Group Inc.
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "em-spamc"
+  gem.homepage = "http://github.com/twg/em-spamc"
+  gem.license = "MIT"
+  gem.summary = %Q{SpamAssassin Connection for EventMachine}
+  gem.description = %Q{Implementation of the "spamc" protocol for EventMachine}
+  gem.email = "github@tadman.ca"
+  gem.authors = [ "Scott Tadman", "Stephan Leroux" ]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/em-spamc.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "em-spamc"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Tadman", "Stephan Leroux"]
+  s.date = "2013-04-17"
+  s.description = "Implementation of the \"spamc\" protocol for EventMachine"
+  s.email = "github@tadman.ca"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "em-spamc.gemspec",
+    "lib/em-spamc.rb",
+    "lib/em_spamc.rb",
+    "lib/em_spamc/connection.rb",
+    "lib/em_spamc/header_parser.rb",
+    "lib/em_spamc/report_parser.rb",
+    "lib/em_spamc/result.rb",
+    "test/config/spamassassin.yml",
+    "test/config/spamassassin.yml.example",
+    "test/examples/messages/sample.txt",
+    "test/examples/messages/zero-score.txt",
+    "test/examples/reports/spam-report.txt",
+    "test/examples/reports/zero-report.txt",
+    "test/examples/sample.txt",
+    "test/helper.rb",
+    "test/unit/test_em_spamc.rb",
+    "test/unit/test_em_spamc_connection.rb",
+    "test/unit/test_em_spamc_header_parser.rb",
+    "test/unit/test_em_spamc_report_parser.rb",
+    "test/unit/test_em_spamc_result.rb"
+  ]
+  s.homepage = "http://github.com/twg/em-spamc"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "SpamAssassin Connection for EventMachine"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/lib/em-spamc.rb

@@ -0,0 +1 @@
+require 'em_spamc'

data/lib/em_spamc.rb

@@ -0,0 +1,8 @@
+require 'fiber'
+
+module EmSpamc
+  autoload(:Connection, 'em_spamc/connection')
+  autoload(:Result, 'em_spamc/result')
+  autoload(:ReportParser, 'em_spamc/report_parser')
+  autoload(:HeaderParser, 'em_spamc/header_parser')
+end

data/lib/em_spamc/connection.rb

@@ -0,0 +1,105 @@
+require 'fiber'
+require 'eventmachine'
+
+class EmSpamc::Connection < EventMachine::Connection
+  # == Constants ============================================================
+
+  PROTO_VERSION = 'SPAMC/1.2'.freeze
+
+  DEFAULT_OPTIONS = {
+    :host => 'localhost',
+    :port => 783
+  }.freeze
+
+  # == Properties ===========================================================
+
+  attr_reader :error
+
+  # == Class Methods ========================================================
+
+  def self.check(message, options = nil)
+    request('CHECK', message, options)
+  end
+  
+  def self.symbols(message, options = nil)
+    request('SYMBOLS', message, options)
+  end
+
+  def self.report(message, options = nil)
+    request('REPORT', message, options)
+  end
+
+  def self.ping(options = nil)
+    request('PING', nil, options)
+  end
+
+  def self.request(command, message, options = nil)
+    if (options)
+      options = DEFAULT_OPTIONS.merge(options)
+    else
+      options = DEFAULT_OPTIONS
+    end
+
+    EventMachine.connect(
+      options[:host],
+      options[:port],
+      self,
+      [
+        Fiber.current,
+        command,
+        message
+      ]
+    )
+
+    Fiber.yield
+  end
+
+  # == Instance Methods =====================================================
+
+  def initialize(options)
+    @fiber = options[0]
+    @command = options[1]
+    @message = options[2] && (options[2].gsub(/\r?\n/, "\r\n") + "\r\n")
+  end
+
+  # EventMachine hook that's engaged after the client is initialized.
+  def post_init
+    if (error?)
+      @fiber.resume
+    else
+      send_data("#{@command} #{PROTO_VERSION}\r\n")
+
+      if (@message)
+        send_data("Content-length: #{@message.bytesize}\r\n")
+        send_data("\r\n")
+        send_data(@message)
+      else
+        send_data("\r\n")
+      end
+    end
+  end
+
+  def receive_data(data)
+    @data ||= ''
+    @data << data
+  end
+
+  def unbind
+    result = EmSpamc::Result.new
+
+    if (@data)
+      result.headers = EmSpamc::HeaderParser.parse(@data)
+
+      case (@command)
+      when 'REPORT'
+        result.report = EmSpamc::ReportParser.parse(@data)
+      end
+    end
+
+    @fiber.resume(result)
+  end
+
+  def error?
+    !!@error
+  end
+end

data/lib/em_spamc/header_parser.rb

@@ -0,0 +1,27 @@
+class EmSpamc::HeaderParser
+  def self.parse(data)
+    lines = data.split(/\r?\n/)
+    headers = { }
+
+    lines.each do |line|
+      case (line)
+      when /^SPAMD\/(\d+\.\d+) (.*)/
+        code, message = $2.split(/\s+/)
+
+        headers[:version] = $1
+        headers[:code] = code.match(/\d/) ? code.to_i : code
+        headers[:message] = message        
+      when /^(\S+): (.*)\s;\s([0-9]*.[0-9]*)/
+        headers[:spam] = $2 == 'True'
+        headers[:score] = $3.to_f
+      end
+    end
+
+    # Special case: if we only have one header line back, means score of 0
+    if (lines.length == 1)
+      headers.merge!(:score => 0.0, :spam => false)
+    end
+
+    headers
+  end
+end

data/lib/em_spamc/report_parser.rb

@@ -0,0 +1,37 @@
+class EmSpamc::ReportParser
+  LINE_REGEXP = /-$/
+  RULE_REGEXP = /[0-9]*[.][0-9]\s\w*\s/
+
+  def self.parse(data)
+    split_data = data.split(LINE_REGEXP)    
+
+    # Only status line is back - no report returned, no rules
+    if (split_data.length == 1)
+      return [ ]
+    end
+
+    last_part = split_data[1].sub(/^[\n\r]./,'').chomp.chomp
+    
+    points_rules = last_part.gsub(RULE_REGEXP).collect do |sub|
+      sub.chomp(' ')
+    end
+
+    rule_texts = last_part.split(RULE_REGEXP).collect do |text|
+      text.delete("\n").squeeze.chomp(' ').sub(/^\s/, '')
+    end
+
+    rules = [ ]
+
+    points_rules.each_with_index do |points_rule, i|
+      split = points_rule.split(' ')
+
+      rules << {
+        :pts => split[0].to_f,
+        :rule => split[1],
+        :text => rule_texts[i + 1]
+      }
+    end
+
+    rules
+  end
+end

data/lib/em_spamc/result.rb

@@ -0,0 +1,30 @@
+class EmSpamc::Result
+  # == Constants ============================================================
+
+  ATTRIBUTES = [
+    :headers,
+    :threshold,
+    :tags,
+    :report
+  ].freeze
+
+  # == Instance Methods =====================================================
+
+  def initialize(attributes = nil)
+    @attributes = attributes || { }
+  end
+
+  ATTRIBUTES.each do |name|
+    define_method(name) do
+      @attributes[name]
+    end
+
+    define_method(:"#{name}=") do |value|
+      @attributes[name] = value
+    end
+  end
+
+  def spam?
+    headers and headers[:spam]
+  end
+end

data/test/config/spamassassin.yml

@@ -0,0 +1,4 @@
+#host: 127.0.0.1
+#port: 9000
+host: scan1.blue.postageapp.com
+port: 49000

data/test/config/spamassassin.yml.example

@@ -0,0 +1,2 @@
+host: 127.0.0.1
+port: 783

data/test/examples/messages/sample.txt

@@ -0,0 +1,5 @@
+From: Example Person <example@example.com>
+To: Someone <someone@example.net>
+Subject: Harmless Example Message
+
+This is not a very exciting message, but here it is.

data/test/examples/messages/zero-score.txt

@@ -0,0 +1,23 @@
+Delivered-To: test@test.com
+Received: by 10.180.189.141 with SMTP id gi13csp63398wic;
+        Thu, 14 Mar 2013 08:46:03 -0700 (PDT)
+Return-Path: <sender@testapp.com>
+Received: from outbound6.mailer.testapp.com (outbound6.mailer.testapp.com. [199.87.247.245])
+        by mx.google.com with ESMTPS id ep2si2060874qeb.27.2013.03.14.08.46.02
+        (version=TLSv1 cipher=RC4-SHA bits=128/128);
+        Thu, 14 Mar 2013 08:46:03 -0700 (PDT)
+Received-SPF: pass (google.com: domain of sender@testapp.com designates 199.87.247.245 as permitted sender) client-ip=199.87.247.245;
+Authentication-Results: mx.google.com;
+       spf=pass (google.com: domain of sender@testapp.com designates 199.87.247.245 as permitted sender) smtp.mail=sender@testapp.com
+Date: Thu, 14 Mar 2013 15:46:02 +0000
+To: person@test.com
+Message-ID: <17ee1aab2074416831081825744deffb026f0dfe@outbound6.mailer.testapp.com>
+Subject: Test Message RECIPIENT SUBJECT person@test.com
+Mime-Version: 1.0
+Content-Type: text/plain
+Content-Transfer-Encoding: 7bit
+Auto-Submitted: auto-generated
+From: sender@testapp.com
+
+Hey!
+

data/test/examples/reports/spam-report.txt

@@ -0,0 +1,27 @@
+SPAMD/1.1 0 EX_OK
+Spam: True ; 18.1 / 5.0
+
+Spam detection software, running on the system "scan1.blue.postageapp.com", has
+identified this incoming email as possible spam.  The original message
+has been attached to this so you can view it (if it isn't spam) or label
+similar future email.  If you have any questions, see
+the administrator of that system for details.
+
+Content preview:  I found a way to "get even" with the financial market! I've
+   stumbled to this page: http://advertismenmore.com/ This dude is just crazy,
+   he will teach you how you can make up to $87 every minute! No string attached
+   and zero risk for you! and the best fact, its 100% free [...]
+
+Content analysis details:   (18.1 points, 5.0 required)
+
+ pts rule name              description
+---- ---------------------- --------------------------------------------------
+ 3.6 RCVD_IN_PBL            RBL: Received via a relay in Spamhaus PBL
+                            [91.115.88.37 listed in zen.spamhaus.org]
+ 0.7 RCVD_IN_XBL            RBL: Received via a relay in Spamhaus XBL
+ 0.0 RCVD_IN_DNSWL_BLOCKED  RBL: ADMINISTRATOR NOTICE: The query to DNSWL
+                            was blocked.  See
+                            http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block
+                             for more information.
+                            [91.115.88.37 listed in list.dnswl.org]
+ 1.6 RCVD_IN_BRBL_LASTEXT   RBL: RCVD_IN_BRBL_LASTEXT

data/test/examples/reports/zero-report.txt

@@ -0,0 +1 @@
+SPAMD/1.1 0 EX_OK

data/test/examples/sample.txt

@@ -0,0 +1,5 @@
+From: Example Person <example@example.com>
+To: Someone <someone@example.net>
+Subject: Harmless Example Message
+
+This is not a very exciting message, but here it is.

data/test/helper.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'yaml'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'em-spamc'
+require 'eventmachine'
+
+class Test::Unit::TestCase
+  def example_message(name)
+    message_path = File.expand_path("examples/messages/#{name}.txt", File.dirname(__FILE__))
+
+    File.open(message_path).read
+  end
+
+  def example_report(name)
+    message_path = File.expand_path("examples/reports/#{name}.txt", File.dirname(__FILE__))
+
+    File.open(message_path).read
+  end
+
+  def connection_options
+    config_file = File.expand_path('config/spamassassin.yml', File.dirname(__FILE__))
+
+    Hash[
+      YAML.load(File.open(config_file)).collect do |key, value|
+        [ key.to_sym, value ]
+      end
+    ]
+  end
+
+  def eventmachine
+    EventMachine.run do
+      Fiber.new do
+        yield
+        EventMachine.stop_event_loop
+      end.resume
+    end
+  end
+end

data/test/unit/test_em_spamc.rb

@@ -0,0 +1,4 @@
+require_relative '../helper'
+
+class TestEmSpamc < Test::Unit::TestCase
+end

data/test/unit/test_em_spamc_connection.rb

@@ -0,0 +1,44 @@
+require_relative '../helper'
+
+class TestEmSpamcConnection < Test::Unit::TestCase
+  def test_ping
+    eventmachine do
+      result = EmSpamc::Connection.ping(connection_options)
+
+      assert result
+    end
+  end
+
+  def test_symbols
+    eventmachine do
+      message = example_message(:sample)
+      result = EmSpamc::Connection.symbols(message, connection_options)
+
+      assert result
+    end
+  end
+
+  def test_report
+    eventmachine do
+      message = example_message(:sample)
+
+      result = EmSpamc::Connection.report(message, connection_options)
+
+      assert result
+      assert result.report
+      assert result.headers[:score]
+
+      assert_equal result.spam?, false
+    end
+  end
+
+  def test_check
+    eventmachine do
+      message = example_message(:sample)
+
+      result = EmSpamc::Connection.check(message)
+
+      assert result
+    end
+  end
+end

data/test/unit/test_em_spamc_header_parser.rb

@@ -0,0 +1,18 @@
+require_relative '../helper'
+
+class TestEmSpamcHeaderParser < Test::Unit::TestCase
+  def test_score_header
+    report = example_report('spam-report')
+    headers = EmSpamc::HeaderParser.parse(report)
+    assert_equal headers[:spam], true
+    assert headers[:score] >= 0
+  end
+
+  def test_zero_header
+    report = example_report('zero-report')
+    headers = EmSpamc::HeaderParser.parse(report)
+    assert headers[:score]
+    assert_equal headers[:score], 0
+    assert_equal headers[:spam], false
+  end
+end

data/test/unit/test_em_spamc_report_parser.rb

@@ -0,0 +1,20 @@
+require_relative '../helper'
+
+class TestEmSpamcReportParser < Test::Unit::TestCase
+  def test_parsing_spam
+    eventmachine do
+      report = example_report('spam-report')
+      rules = EmSpamc::ReportParser.parse(report)
+      assert rules
+    end
+  end
+
+  def test_parsing_zero
+    eventmachine do
+      report = example_report('zero-report')
+      rules = EmSpamc::ReportParser.parse(report)
+      assert rules
+      assert_equal rules, []
+    end
+  end
+end

data/test/unit/test_em_spamc_result.rb

@@ -0,0 +1,20 @@
+require_relative '../helper'
+
+class TestEmSpamcConnection < Test::Unit::TestCase
+  def test_defaults
+    result = EmSpamc::Result.new
+
+    assert_equal nil, result.headers
+    assert_equal nil, result.report
+  end
+
+  def test_assignment
+    result = EmSpamc::Result.new
+
+    assert_equal nil, result.headers
+    
+    result.headers = { :code => 0 }
+
+    assert_equal 0, result.headers[:code]
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: em-spamc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Tadman
+- Stephan Leroux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Implementation of the "spamc" protocol for EventMachine
+email: github@tadman.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- em-spamc.gemspec
+- lib/em-spamc.rb
+- lib/em_spamc.rb
+- lib/em_spamc/connection.rb
+- lib/em_spamc/header_parser.rb
+- lib/em_spamc/report_parser.rb
+- lib/em_spamc/result.rb
+- test/config/spamassassin.yml
+- test/config/spamassassin.yml.example
+- test/examples/messages/sample.txt
+- test/examples/messages/zero-score.txt
+- test/examples/reports/spam-report.txt
+- test/examples/reports/zero-report.txt
+- test/examples/sample.txt
+- test/helper.rb
+- test/unit/test_em_spamc.rb
+- test/unit/test_em_spamc_connection.rb
+- test/unit/test_em_spamc_header_parser.rb
+- test/unit/test_em_spamc_report_parser.rb
+- test/unit/test_em_spamc_result.rb
+homepage: http://github.com/twg/em-spamc
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: SpamAssassin Connection for EventMachine
+test_files: []