gurgitate-mail 1.10.0 → 1.10.1

data/lib/gurgitate/mailmessage.rb

@@ -1,30 +1,56 @@
-#!/opt/bin/ruby -w
-
-#------------------------------------------------------------------------
-# Handles a complete mail message
-#------------------------------------------------------------------------
+# Contains the class Gurgitate::Mailmessage, used to handle the parsing
+# of existing messages and the creation of new messages.
 
 require 'gurgitate/headers'
+require 'gurgitate/message'
 
 module Gurgitate
 
-    # A complete mail message.
-    class Mailmessage
+    # A complete mail message.  This is the base class for
+    # gurgitate-mail itself: if you want to use gurgitate-mail to create
+    # new messages, this is what you want to use.
+    class Mailmessage < Message
 
         Fromregex=/([^ ]+@[^ ]+) \(.*\)|[^<][<](.*@.*)[>]|([^ ]+@[^ ]+)/;
 
-        # The headers of the message
-        attr_reader :headers
-        # The body of the message
-        attr_accessor :body
-
         # The envelope sender and recipient, if anyone thought to
         # mention them to us.
         attr_accessor :sender
         attr_accessor :recipient
 
-        # Creates a new mail message with headers built from the options hash,
-        # and the body of the message in a string.
+        # Creates a new mail message from the options hash, and the body of the
+        # message in a string.
+        #
+        # This can actually be invoked in several ways:
+        #
+        #    Gurgitate::Mailmessage.create "This is the message body",
+        #       :from    => "from_address@example.com",
+        #       :to      => "to_address@example.com",
+        #       :subject => "This is the message subject"
+        #
+        # This results in an email message that, when rendered via to_s, will
+        # look like this:
+        #
+        #   From: from_address@example.com
+        #   To: to_address@example.com
+        #   Subject: This is the message subject
+        #
+        #   This is the message body
+        #
+        # If you prefer to do things entirely by options hashes, as some do,
+        # you can substitute a :body key for the first argument:
+        #
+        #    Gurgitate::Mailmessage.create(
+        #        :body    => "This is the message body",
+        #        :from    => "from_address@example.com",
+        #        :to      => "to_address@example.com",
+        #        :subject => "This is the message subject"
+        #    )
+        #
+        # There are two other special options you can use: :sender and
+        # :recipient.  These are used to specify the sender and recipient of
+        # email messages, when the message is sent via SMTP.
+        #
         def self.create(*args)
             options = body = nil
 
@@ -51,7 +77,7 @@ module Gurgitate
                     end
                 end
 
-                @headers = Headers.new(options)
+                @headers = MailHeaders.new(options)
             end
 
             message
@@ -64,30 +90,33 @@ module Gurgitate
 
             if text
                 (@headertext,@body)=text.split(/\n\n/,2)
-                @headers=Headers.new(@headertext);
+                @headers=MailHeaders.new(@headertext);
                 Fromregex.match(@headers["From"][0].contents);
                 @from=$+
             else
-                @headers = Headers.new
-                @body = ""
+                super(text)
             end
         end
 
-        # Returns the header +name+
-        def header(name)
-            @headers[name].each { |h| h.contents }.join(", ")
-        end
-
         # custom accessors
     
         # Returns the message's sender
         def from; @sender || @headers.from; end
 
         # Returns all the candidates for a recipient
-        def to; @recipient || @headers["To", "Cc"][0].contents; end
-
-        # Returns the formatted mail message
-        def to_s; @headers.to_s + "\n\n" + ( @body || ""); end
+        def to
+            if @recipient
+                then @recipient
+            elsif @headers["To"]
+                then @headers["To"][0].contents
+            elsif @headers["Cc"]
+                then @headers["Cc"][0].contents
+            elsif @headers["X-Original-To"]
+                then @headers["X-Original-To"][0].contents
+            else
+                ""
+            end
+        end
 
         # Returns the mail message formatted for mbox
         def to_mbox; @headers.to_mbox + "\n\n" + @body; end

data/lib/gurgitate/message.rb

@@ -0,0 +1,113 @@
+#!/opt/bin/ruby -w
+
+#------------------------------------------------------------------------
+# Handles a complete mail message
+#------------------------------------------------------------------------
+
+require 'gurgitate/mail_headers'
+
+module Gurgitate
+
+    # A complete mail message.
+    class Message
+
+        # The headers of the message
+        attr_reader :headers
+        # The body of the message
+        attr_accessor :body
+
+        # Creates a new message from the options hash, and the body of the
+        # message in a string.
+        #
+        # This can actually be invoked in several ways:
+        #
+        #    Gurgitate::Mailmessage.create "This is the message body",
+        #       :from    => "from_address@example.com",
+        #       :to      => "to_address@example.com",
+        #       :subject => "This is the message subject"
+        #
+        # This results in an email message that, when rendered via to_s, will
+        # look like this:
+        #
+        #   From: from_address@example.com
+        #   To: to_address@example.com
+        #   Subject: This is the message subject
+        #
+        #   This is the message body
+        #
+        # If you prefer to do things entirely by options hashes, as some do,
+        # you can substitute a :body key for the first argument:
+        #
+        #    Gurgitate::Mailmessage.create(
+        #        :body    => "This is the message body",
+        #        :from    => "from_address@example.com",
+        #        :to      => "to_address@example.com",
+        #        :subject => "This is the message subject"
+        #    )
+        #
+        # There are two other special options you can use: :sender and
+        # :recipient.  These are used to specify the sender and recipient of
+        # email messages, when the message is sent via SMTP.
+        #
+        def self.create(*args)
+            options = body = nil
+
+            if String === args[0]
+                options = args[1]
+                body = args[0]
+            elsif Hash === args[0]
+                options = args[0]
+            else
+                options = {}
+            end
+
+            message = self.new
+
+            message.instance_eval do
+                if body
+                    @body=body
+                end
+
+                @headers = Headers.new(options)
+            end
+
+            message
+        end
+
+        # Creates a new Gurgitate message from a pre-existing message.
+        # This is what is used when gurgitate-mail is used as a mail filter.
+        #
+        # ARGUMENTS::
+        # +text+      :: An RFC822-formatted message.
+        # +recipient+ :: The recipient of the email message, from the MTA
+        # +sender+    :: The sender of the email message, also from the MTA
+        #
+        # All of its arguments can be nil: if called with no arguments,
+        # it simply returns an empty email message, which can be populated
+        # after the fact.
+        def initialize(text=nil)
+            if text
+                (@headertext,@body)=text.split(/\n\n/,2)
+                @headers=Headers.new(@headertext);
+            else
+                @headers = Headers.new
+                @body = ""
+            end
+        end
+
+        # Returns the header +name+, which is, note, a HeaderBag of all
+        # headers by that name, not just a single header.
+        #
+        # If you want the text of the header, then you have to coerce it to a
+        # string:
+        #
+        #    header("name").to_s
+        #
+        def header(name)
+            @headers[name].each { |h| h.contents }.join(", ")
+        end
+
+        # Returns the formatted mail message
+        def to_s; @headers.to_s + "\n\n" + ( @body || ""); end
+    end
+end

data/test/gurgitate-test.rb

@@ -1,11 +1,17 @@
+builddir = File.dirname(File.dirname(__FILE__))
+
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require 'test/unit'
 require 'test/unit/ui/console/testrunner'
 require 'stringio'
 require 'fileutils'
 require 'pathname'
 require 'irb'
-$:.unshift File.dirname(__FILE__) + "/.."
 require "gurgitate-mail"
+require "etc"
 
 class GurgitateTest < Test::Unit::TestCase
 	def setup

data/test/runtests.rb

@@ -1,14 +1,23 @@
-#!/opt/bin/ruby -w
-
-#------------------------------------------------------------------------
-# Unit tests for gurgitate-mail
-#------------------------------------------------------------------------
-
 require 'test/unit'
-require 'test/unit/ui/console/testrunner'
+tester = nil
+begin
+    require 'test/unit/ui/console/testrunner'
+    tester = Test::Unit::UI::Console::TestRunner
+rescue LoadError  # ruby 1.9
+    require 'test/unit'
+    tester = Test::Unit
+end
 require 'stringio'
 require 'pathname'
 
+builddir = File.dirname(File.dirname(__FILE__))
+
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
+require "test/gurgitate-test"
+
 def runtests(testcases)
     testcases.each do |testcase|
         Test::Unit::UI::Console::TestRunner.run testcase

data/test/test_configuration.rb

@@ -1,3 +1,9 @@
+builddir = File.dirname(File.dirname(__FILE__))
+
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require "test/gurgitate-test"
 require "etc"
 

data/test/test_deliver.rb

@@ -1,3 +1,9 @@
+builddir = File.dirname(File.dirname(__FILE__))
+
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require 'test/unit'
 require 'test/unit/ui/console/testrunner'
 require 'stringio'

data/test/test_delivery.rb

@@ -1,3 +1,9 @@
+builddir = File.dirname(File.dirname(__FILE__))
+
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require 'test/unit'
 require 'test/unit/ui/console/testrunner'
 require 'stringio'

data/test/test_execute_rules.rb

@@ -0,0 +1,43 @@
+builddir = File.join(File.dirname(__FILE__),"..")
+
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
+require "test/gurgitate-test"
+require "test/test_rules"
+require "etc"
+
+class TC_Execute_rules < TC_Rules
+    def setup
+        super
+        @invalidrules = File.join(@testdir, "rules_invalid.rb")
+        File.open @invalidrules, "w" do |f|
+            f.puts "invalid syntax"
+        end
+        @exceptionrules = File.join(@testdir, "rules_exception.rb")
+        File.open @exceptionrules, "w" do |f|
+            f.puts "raise RuntimeError, 'testing'"
+        end
+    end
+
+    def teardown
+        File.unlink @invalidrules if File.exists? @invalidrules
+    end
+
+    def test_process_default
+        @gurgitate.add_rules :default
+        assert_nothing_raised do
+            @gurgitate.process
+        end
+    end
+
+    def test_process_rules_not_found
+        @gurgitate.add_rules @rulesfile
+        File.unlink @rulesfile
+        assert_nothing_raised do 
+            @gurgitate.process
+        end
+        assert File.exists?(@spoolfile)
+    end
+end

data/test/test_gurgitate_delivery.rb

@@ -1,3 +1,9 @@
+builddir = File.dirname(File.dirname(__FILE__))
+
+unless $:[0] == builddir
+    $:.unshift builddir
+end
+
 require 'test/unit'
 require 'test/unit/ui/console/testrunner'
 require 'stringio'
@@ -8,6 +14,40 @@ require "test/gurgitate-test"
 require "gurgitate-mail"
 
 class TC_Gurgitate_delivery < GurgitateTest
+    def ensure_empty_maildir(dir)
+        assert File.exists?(dir)
+        assert File.stat(dir).directory?
+        assert File.exists?(File.join(dir, "new"))
+
+        assert_equal 0, Dir[File.join(dir, "new", "*")].length
+        assert_equal 0, Dir[File.join(dir, "cur", "*")].length
+    end
+
+    def ensure_maildir_with_n_messages(dir, n)
+        assert File.exists?(dir)
+        assert File.stat(dir).directory?
+        assert File.exists?(File.join(dir, "new"))
+        assert File.stat(File.join(dir, "new")).directory?
+        assert_equal 0, Dir[File.join(dir, "cur", "*")].length
+        assert_equal n, Dir[File.join(dir, "new", "*")].length
+    end
+
+    def ensure_empty_mhdir(dir)
+        assert File.exists?(dir)
+        assert File.stat(dir).directory?
+
+        assert_equal 0, Dir[File.join(dir, "*")].length
+    end
+
+    def ensure_mhdir_with_messages(dir, *messages)
+        assert File.exists?(dir)
+        assert File.stat(dir).directory?
+        messages.each do |message|
+            assert File.exists?(File.join(dir, message.to_s))
+            assert File.stat(File.join(dir,message.to_s)).file?
+        end
+    end
+
     #************************************************************************
     # tests
     #************************************************************************
@@ -78,12 +118,7 @@ class TC_Gurgitate_delivery < GurgitateTest
     def test_save_guess_maildir
         maildirmake File.join(@folders,"test")
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert File.exists?(File.join(@folders, "test", "new"))
-
-        assert_equal 0, Dir[File.join(@folders, "test", "new", "*")].length
-        assert_equal 0, Dir[File.join(@folders, "test", "cur", "*")].length
+        ensure_empty_maildir File.join(@folders, "test")
 
         assert_nothing_raised do
             @gurgitate.process do
@@ -92,21 +127,13 @@ class TC_Gurgitate_delivery < GurgitateTest
             end
         end
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert File.exists?(File.join(@folders, "test", "new"))
-        assert File.stat(File.join(@folders, "test","new")).directory?
-        assert_equal 0, Dir[File.join(@folders, "test", "cur", "*")].length
-        assert_equal 1, Dir[File.join(@folders, "test", "new", "*")].length
+        ensure_maildir_with_n_messages(File.join(@folders, "test"), 1)
     end
 
     def test_save_guess_mh
         mhdirmake File.join(@folders,"test")
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-
-        assert_equal 0, Dir[File.join(@folders, "test", "*")].length
+        ensure_empty_mhdir File.join(@folders, "test")
 
         assert_nothing_raised do
             @gurgitate.process do
@@ -115,10 +142,7 @@ class TC_Gurgitate_delivery < GurgitateTest
             end
         end
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert File.exists?(File.join(@folders, "test", "1"))
-        assert File.stat(File.join(@folders, "test","1")).file?
+        ensure_mhdir_with_messages(File.join(@folders,"test"),1)
         assert File.exists?(File.join(@folders, "test", ".mh_sequences"))
         assert File.stat(File.join(@folders, "test", ".mh_sequences")).file?
         assert_equal "unseen: 1\n", 
@@ -128,12 +152,7 @@ class TC_Gurgitate_delivery < GurgitateTest
     def test_save_maildir_collision
         maildirmake File.join(@folders,"test")
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert File.exists?(File.join(@folders, "test", "new"))
-
-        assert_equal 0, Dir[File.join(@folders, "test", "new", "*")].length
-        assert_equal 0, Dir[File.join(@folders, "test", "cur", "*")].length
+        ensure_empty_maildir(File.join(@folders, "test"))
 
         assert_nothing_raised do
             @gurgitate.process do
@@ -143,20 +162,13 @@ class TC_Gurgitate_delivery < GurgitateTest
             end
         end
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert File.exists?(File.join(@folders, "test", "new"))
-        assert File.stat(File.join(@folders, "test","new")).directory?
-        assert_equal 0, Dir[File.join(@folders, "test", "cur", "*")].length
-        assert_equal 2, Dir[File.join(@folders, "test", "new", "*")].length
+        ensure_maildir_with_n_messages(File.join(@folders,"test"),2)
     end
 
     def test_save_mh_collision
         mhdirmake File.join(@folders,"test")
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert_equal 0, Dir[File.join(@folders, "test", "*")].length
+        ensure_empty_mhdir File.join(@folders,"test")
 
         assert_nothing_raised do
             @gurgitate.process do
@@ -166,12 +178,8 @@ class TC_Gurgitate_delivery < GurgitateTest
             end
         end
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert File.exists?(File.join(@folders, "test", "1"))
-        assert File.stat(File.join(@folders, "test","1")).file?
-        assert File.exists?(File.join(@folders, "test", "2"))
-        assert File.stat(File.join(@folders, "test","2")).file?
+        ensure_mhdir_with_messages(File.join(@folders, "test"), 1, 2)
+
         assert File.exists?(File.join(@folders, "test", ".mh_sequences"))
         assert File.stat(File.join(@folders, "test", ".mh_sequences")).file?
         assert_equal "unseen: 1-2\n", 
@@ -190,12 +198,7 @@ class TC_Gurgitate_delivery < GurgitateTest
             end
         end
 
-        assert File.exists?(File.join(@spoolfile, ".test"))
-        assert File.stat(File.join(@spoolfile, ".test")).directory?
-        assert File.exists?(File.join(@spoolfile, ".test", "new"))
-        assert File.stat(File.join(@spoolfile, ".test","new")).directory?
-        assert_equal 0, Dir[File.join(@spoolfile, ".test", "cur", "*")].length
-        assert_equal 1, Dir[File.join(@spoolfile, ".test", "new", "*")].length
+        ensure_maildir_with_n_messages(File.join(@spoolfile,".test"),1)
     end
 
     def test_save_create_mh
@@ -210,12 +213,9 @@ class TC_Gurgitate_delivery < GurgitateTest
             end
         end
 
-        assert File.exists?(File.join(@spoolfile, "test"))
-        assert File.stat(File.join(@spoolfile, "test")).directory?
+        ensure_mhdir_with_messages(File.join(@spoolfile,"test"),1)
         assert File.exists?(File.join(@spoolfile, "test", ".mh_sequences"))
         assert File.stat(File.join(@spoolfile, "test",".mh_sequences")).file?
-        assert File.exists?(File.join(@spoolfile, "test", "1"))
-        assert File.stat(File.join(@spoolfile, "test", "1")).file?
     end
 
     def test_save_bad_filename
@@ -266,12 +266,7 @@ class TC_Gurgitate_delivery < GurgitateTest
             end
         end
 
-        assert File.exists?(File.join(@folders, "test"))
-        assert File.stat(File.join(@folders, "test")).directory?
-        assert File.exists?(File.join(@folders, "test", "new"))
-        assert File.stat(File.join(@folders, "test","new")).directory?
-        assert_equal 0, Dir[File.join(@folders, "test", "cur", "*")].length
-        assert_equal 1, Dir[File.join(@folders, "test", "new", "*")].length
+        ensure_maildir_with_n_messages(File.join(@folders, "test"), 1)
     end
 
     def test_message_parsed_correctly