gurgitate-mail 1.8.5 → 1.9.0

data/bin/gurgitate-mail

@@ -49,6 +49,6 @@ end
 
 begin
     gurgitate.process
-rescue 
+rescue CouldNotProcessMailError
     exit 75
 end

data/lib/gurgitate/deliver/maildir.rb

@@ -95,7 +95,7 @@ module Gurgitate
                     File.link(tmpfilename,newfilename)
                 rescue SystemCallError
                     log("Couldn't create maildir link to \"new\"!")
-                    raise
+                    exit 75 # Argh, I tried, it didn't work out
                 end
                 File.delete(tmpfilename)
             end

data/lib/gurgitate/header.rb

@@ -0,0 +1,81 @@
+#!/opt/bin/ruby -w
+
+module Gurgitate
+    class IllegalHeader < RuntimeError ; end
+
+    # A little class for a single header
+    class Header
+        # The name of the header
+        attr_accessor :name
+        # The contents of the header
+        attr_accessor :contents
+
+        alias_method :value, :contents
+
+        # A recent rash of viruses has forced me to canonicalize
+        # the capitalization of headers.  Sigh.
+        def capitalize_words(s)
+            return s.split(/-/).map { |w| w.capitalize }.join("-")
+          rescue
+            return s
+        end
+
+        private :capitalize_words
+
+        # Creates a Header object.
+        # header::
+        #   The text of the email-message header
+        def initialize(*header)
+            name,contents=nil,nil
+            if header.length == 1 then
+                # RFC822 says that a header consists of some (printable,
+                # non-whitespace) crap, followed by a colon, followed by
+                # some more (printable, but can include whitespaces)
+                # crap.
+                if(header[0] =~ /^[\x21-\x39\x3b-\x7e]+:/) then
+                    (name,contents)=header[0].split(/:\s+/,2)
+                    if(name =~ /:$/ and contents == nil) then
+                        # It looks like someone is using Becky!
+                        name=header[0].gsub(/:$/,"")
+                        contents = ""
+                    end
+
+                    raise IllegalHeader, "Empty name" \
+                        if (name == "" or name == nil)
+                    contents="" if contents == nil
+
+                    @@lastname=name
+                else
+                    raise IllegalHeader, "Bad header syntax: no colon in #{header}"
+                end
+            elsif header.length == 2 then
+                name,contents = *header
+            end
+
+            @name=capitalize_words(name)
+            @contents=contents
+        end
+
+        # Extended header
+        def << (text)
+            @contents += "\n" + text
+        end
+
+        # Matches a header's contents.
+        # regex::
+        #   The regular expression to match against the header's contents
+        def matches (regex)
+            if String === regex
+                regex = Regexp.new(Regexp.escape(regex))
+            end
+            @contents =~ regex
+        end
+
+        alias :=~ :matches
+
+        # Returns the header, ready to put into an email message
+        def to_s
+            @name+": "+@contents
+        end
+    end
+end

data/lib/gurgitate/headers.rb

@@ -1,84 +1,10 @@
 #!/opt/bin/ruby -w
 
+require "gurgitate/header"
+
 module Gurgitate
     class IllegalHeader < RuntimeError ; end
 
-    # A little class for a single header
-    class Header
-        # The name of the header
-        attr_accessor :name
-        # The contents of the header
-        attr_accessor :contents
-
-        alias_method :value, :contents
-
-        # A recent rash of viruses has forced me to canonicalize
-        # the capitalization of headers.  Sigh.
-        def capitalize_words(s)
-            return s.split(/-/).map { |w| w.capitalize }.join("-")
-          rescue
-            return s
-        end
-
-        private :capitalize_words
-
-        # Creates a Header object.
-        # header::
-        #   The text of the email-message header
-        def initialize(*header)
-            name,contents=nil,nil
-            if header.length == 1 then
-                # RFC822 says that a header consists of some (printable,
-                # non-whitespace) crap, followed by a colon, followed by
-                # some more (printable, but can include whitespaces)
-                # crap.
-                if(header[0] =~ /^[\x21-\x39\x3b-\x7e]+:/) then
-                    (name,contents)=header[0].split(/:\s+/,2)
-                    if(name =~ /:$/ and contents == nil) then
-                        # It looks like someone is using Becky!
-                        name=header[0].gsub(/:$/,"")
-                        contents = ""
-                    end
-
-                    raise IllegalHeader, "Empty name" \
-                        if (name == "" or name == nil)
-                    contents="" if contents == nil
-
-                    @@lastname=name
-                else
-                    raise IllegalHeader, "Bad header syntax: no colon in #{header}"
-                end
-            elsif header.length == 2 then
-                name,contents = *header
-            end
-
-            @name=capitalize_words(name)
-            @contents=contents
-        end
-
-        # Extended header
-        def << (text)
-            @contents += "\n" + text
-        end
-
-        # Matches a header's contents.
-        # regex::
-        #   The regular expression to match against the header's contents
-        def matches (regex)
-            if String === regex
-                regex = Regexp.new(Regexp.escape(regex))
-            end
-            @contents =~ regex
-        end
-
-        alias :=~ :matches
-
-        # Returns the header, ready to put into an email message
-        def to_s
-            @name+": "+@contents
-        end
-    end
-
 # ========================================================================
 
     class HeaderBag < Array
@@ -223,7 +149,7 @@ module Gurgitate
         # Creates a Headers object.
         # headertext::
         #   The text of the message headers.
-        def initialize(headertext=nil,sender=nil, recipient=nil)
+        def initialize(headertext=nil, sender=nil, recipient=nil)
             @from    = sender
             @to      = recipient
             @headers = Hash.new(nil)

data/lib/gurgitate/mailmessage.rb

@@ -33,9 +33,10 @@ module Gurgitate
                 body = args[0]
             elsif Hash === args[0]
                 options = args[0]
+            else
+                options = {}
             end
 
-            options = options.clone # just in case, since I'm meddling with it
             message = self.new
 
             message.instance_eval do
@@ -46,7 +47,7 @@ module Gurgitate
                 %w/sender recipient body/.each do |key|
                     if options.has_key? key.to_sym
                         instance_variable_set("@#{key}", options[key.to_sym])
-                        options.delete key
+                        options.delete key.to_sym
                     end
                 end
 
@@ -77,12 +78,11 @@ module Gurgitate
 
         # custom accessors
     
-        # Returns the UNIX "from" line
+        # Returns the message's sender
         def from; @sender || @headers.from; end
 
-        # Returns all the candidates for a "to" line
-        def to; @recipient || @headers["To", "Cc"]; end
-        # def to; @headers["To","Cc"]; 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

data/test/gurgitate-test.rb

@@ -4,37 +4,23 @@ require 'stringio'
 require 'fileutils'
 require 'pathname'
 require 'irb'
-require "./gurgitate-mail"
+$:.unshift File.dirname(__FILE__) + "/.."
+require "gurgitate-mail"
 
 class GurgitateTest < Test::Unit::TestCase
 	def setup
         currentdir = Pathname.new(File.join(File.dirname(__FILE__), 
                                          "..")).realpath.to_s
         @testdir = File.join(currentdir,"test-data")
-        testdir = @testdir
         @folders = File.join(@testdir,"folders")
-        folders = @folders
         FileUtils.rmtree @testdir if File.exists? @testdir
         Dir.mkdir @testdir
         Dir.mkdir @folders
 		m = StringIO.new("From: me\nTo: you\nSubject: test\n\nHi.\n")
         @gurgitate = nil
 		@gurgitate = Gurgitate::Gurgitate.new(m)
-
-        @sendmail = File.join(@testdir, "bin", "sendmail")
-        sendmail = @sendmail
-
-        Dir.mkdir File.join(@testdir,"bin")
-
-        File.open(@sendmail,"w") do |f|
-            f.puts "#!/bin/sh"
-            f.puts "exec > #{@testdir}/sendmail_output 2>&1"
-            f.puts 'echo "$@"'
-            f.puts 'cat'
-        end
-
-        FileUtils.chmod 0755, @sendmail
-
+        testdir = @testdir
+        folders = @folders
         @gurgitate.instance_eval do 
             sendmail "/bin/cat" 
             homedir testdir

data/test/test_deliver.rb

@@ -0,0 +1,76 @@
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+require 'stringio'
+require 'fileutils'
+require 'pathname'
+require 'irb'
+require "test/gurgitate-test"
+require "gurgitate/deliver"
+
+class DeliverTest
+    include Gurgitate::Deliver
+
+    attr_accessor :folderstyle
+
+    def to_mbox
+        "From test\n" + to_s
+    end
+
+    def to_s
+        "From: test\nTo:test\nSubject: test\n\nTest\n"
+    end
+end
+
+class TC_Deliver < Test::Unit::TestCase
+    def setup
+        currentdir = Pathname.new(File.join(File.dirname(__FILE__), 
+                                         "..")).realpath.to_s
+        @testdir = File.join(currentdir,"test-data")
+        @folders = File.join(@testdir,"folders")
+        FileUtils.rmtree @testdir if File.exists? @testdir
+        Dir.mkdir @testdir
+        Dir.mkdir @folders
+		m = StringIO.new("From: me\nTo: you\nSubject: test\n\nHi.\n")
+        @deliver_test = DeliverTest.new
+        testdir = @testdir
+        folders = @folders
+        @deliver_test.folderstyle = Gurgitate::Deliver::MBox
+        @spoolfile = File.join(testdir, "default")
+    end
+
+    def teardown
+        FileUtils.rmtree @testdir
+    end
+
+    # ------------------------------------------------------------------------
+    # And the tests
+    # ------------------------------------------------------------------------
+    def test_setup_worked
+        assert true
+    end
+    
+    def test_basic_delivery
+        assert_nothing_raised do
+            @deliver_test.save(@spoolfile)
+        end
+        assert File.exists?(@spoolfile)
+        assert File.file?(@spoolfile)
+        assert_equal File.read(@spoolfile), @deliver_test.to_mbox
+    end
+
+    def test_basic_delivery_maildir
+        @deliver_test.folderstyle = Gurgitate::Deliver::Maildir
+        assert_nothing_raised do
+            @deliver_test.save(@spoolfile)
+        end
+        assert File.exists?(@spoolfile)
+        assert File.directory?(@spoolfile)
+        assert File.exists?(File.join(@spoolfile,"cur"))
+        assert File.exists?(File.join(@spoolfile,"new"))
+        assert File.exists?(File.join(@spoolfile,"tmp"))
+        contents = Dir[File.join(@spoolfile,"new","*")]
+        assert contents.length == 1
+        assert File.exists?(contents[0])
+        assert_equal File.read(contents[0]), @deliver_test.to_s
+    end
+end

data/test/test_gurgitate_delivery.rb

@@ -0,0 +1,212 @@
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+require 'stringio'
+require 'fileutils'
+require 'pathname'
+require 'irb'
+require "./gurgitate-mail"
+require "test/gurgitate-test"
+
+class TC_Gurgitate_delivery < GurgitateTest
+    #************************************************************************
+    # tests
+    #************************************************************************
+    def test_basic_delivery
+        assert_nothing_raised do
+            @gurgitate.process { nil }
+        end
+        assert File.exists?(@spoolfile)
+    end
+
+    def test_detect_mbox
+        Dir.mkdir(@testdir) rescue nil
+        File.open(@spoolfile, File::WRONLY | File::CREAT) do |f|
+            f.print ""
+        end
+
+        assert_nothing_raised do
+            @gurgitate.process { nil }
+        end
+
+        assert File.exists?(@spoolfile)
+    end
+
+    def test_detect_maildir
+        maildirmake @spoolfile
+
+        assert_nothing_raised do
+            @gurgitate.process { nil }
+        end
+
+        assert Dir[File.join(@spoolfile,"new","*")].length > 0
+        assert File.exists?(Dir[File.join(@spoolfile,"new","*")][0])
+        FileUtils.rmtree @spoolfile
+        teardown
+        test_detect_mbox
+        setup
+    end
+
+    def test_save_folders
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "=test"
+                break
+            end
+        end
+
+        assert File.exists?(File.join(@folders, "test"))
+        assert File.stat(File.join(@folders, "test")).file?
+    end
+
+    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
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "=test"
+                break
+            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
+    end
+
+    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
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "=test"
+                save "=test"
+                break
+            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
+    end
+
+    def test_save_create_maildir
+        maildirmake @spoolfile
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                @folderstyle = Gurgitate::Deliver::Maildir
+                @maildir = @spoolfile
+                save "=test"
+                break
+            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
+    end
+
+    def test_save_bad_filename
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "testing"
+            end
+        end
+
+        assert File.exists?(@spoolfile)
+        assert !File.exists?("testing")
+    end
+
+    def test_cannot_save
+        FileUtils.touch @spoolfile
+        FileUtils.chmod 0, @spoolfile
+
+        assert_raises Errno::EACCES do
+            @gurgitate.process do 
+                nil
+            end
+        end
+    end
+
+    def test_mailbox_heuristics_mbox
+        @gurgitate.instance_eval do
+            @folderstyle = nil
+        end
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "=test"
+            end
+        end
+
+        assert File.exists?(File.join(@folders, "test"))
+        assert File.stat(File.join(@folders, "test")).file?
+    end
+
+    def test_mailbox_heuristics_maildir
+        @gurgitate.instance_eval do
+            @folderstyle = nil
+        end
+
+        assert_nothing_raised do
+            @gurgitate.process do
+                save "=test/"
+            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
+    end
+
+    def test_message_parsed_correctly
+        assert_equal("From: me",@gurgitate.header("From"))
+        assert_equal("To: you", @gurgitate.header("To"))
+        assert_equal("Subject: test", @gurgitate.header("Subject"))
+        assert_equal("Hi.\n", @gurgitate.body, "Message body is wrong")
+    end
+
+    def test_message_written_correctly
+        test_message_parsed_correctly
+        assert_nothing_raised do
+            @gurgitate.process
+        end
+
+        mess=nil
+        assert_nothing_raised do
+            mess = Gurgitate::Mailmessage.new(File.read(@spoolfile))
+        end
+
+        assert_equal("From: me", mess.header("From"), "From header is wrong")
+        assert_equal("To: you", mess.header("To"), "To header is wrong")
+        assert_equal("Hi.\n", mess.body, "Body is wrong")
+        assert_equal("Subject: test", mess.header("Subject"), "Subject header wrong")
+    end
+end
+

data/test/test_process.rb

@@ -23,17 +23,6 @@ class TC_Process < GurgitateTest
 		end
     end
 
-    def test_bad_pipe_goes_to_spoolfile_anyway
-        assert_nothing_raised do
-            # if you have a program called this on your system,
-            # I want to see its man page
-            @gurgitate.process { pipe("/bin/flortglenuggets >/dev/null 2>&1") }
-        end
-
-        assert File.exists?(@spoolfile)
-        assert File.stat(@spoolfile).file?
-    end
-
     def test_break_does_not_deliver
 		assert_nothing_raised do
 			@gurgitate.process { break }

data/test/test_rules.rb

@@ -19,7 +19,6 @@ class TC_Rules < GurgitateTest
 
     def teardown
         File.unlink rulesfile if File.exist? rulesfile
-        super
     end
 
     def test_add_rules_normal

data/test/test_writing.rb

@@ -36,6 +36,8 @@ class TC_Writing < Test::Unit::TestCase
             :from => "test@test", 
             :to => "test2@test"
         assert_equal "This is a test", mess.body
+        assert_equal [ "From: test@test", "To: test2@test" ], 
+            mess.headers.to_s.split(/\n/)
     end
 
     def test_initialization_headers_body_in_initialization_hash
@@ -43,6 +45,8 @@ class TC_Writing < Test::Unit::TestCase
             :from => "test@test", 
             :to => "test2@test"
         assert_equal "This is a test", mess.body
+        assert_equal [ "From: test@test", "To: test2@test" ], 
+            mess.headers.to_s.split(/\n/)
     end
 
     def test_creation_round_trip
@@ -53,4 +57,52 @@ class TC_Writing < Test::Unit::TestCase
         reparsed_mess = Gurgitate::Mailmessage.new(mess.to_s)
         assert_equal reparsed_mess.to_s, mess.to_s
     end
+
+    def test_creation_sender_specified
+        mess = Gurgitate::Mailmessage.create :body => "This is a test",
+            :from => "from@test",
+            :to => "to@test",
+            :sender => "sender@test"
+        assert_equal "This is a test", mess.body
+        assert_equal "From: from@test", mess.headers["From"].to_s
+        assert_equal "To: to@test", mess.headers["To"].to_s
+        assert_equal "sender@test", mess.from
+    end
+
+    def test_creation_recipient_specified
+        mess = Gurgitate::Mailmessage.create :body => "This is a test",
+            :from => "from@test",
+            :to => "to@test",
+            :recipient => "recipient@test"
+        assert_equal "This is a test", mess.body
+        assert_equal "From: from@test", mess.headers["From"].to_s
+        assert_equal "To: to@test", mess.headers["To"].to_s
+        assert_equal "recipient@test", mess.to
+    end
+
+    def test_creation_sender_not_specified
+        mess = Gurgitate::Mailmessage.create :body => "This is a test",
+            :from => "from@test",
+            :to => "to@test"
+        assert_equal "This is a test", mess.body
+        assert_equal "From: from@test", mess.headers["From"].to_s
+        assert_equal "To: to@test", mess.headers["To"].to_s
+        assert_equal "", mess.from
+        assert_equal "to@test", mess.to
+    end
+
+    def test_creation_incrementally
+        mess = Gurgitate::Mailmessage.create
+        mess.sender = "sender@test"
+        mess.recipient = "recipient@test"
+        mess.body = "This is a test"
+        mess.headers["From"] = "from@test"
+        mess.headers["To"] = "to@test"
+
+        assert_equal "sender@test", mess.from
+        assert_equal "recipient@test", mess.to
+        assert_equal "This is a test", mess.body
+        assert_equal "From: from@test", mess.headers["From"].to_s
+        assert_equal "To: to@test", mess.headers["To"].to_s
+    end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: gurgitate-mail
 version: !ruby/object:Gem::Version 
-  version: 1.8.5
-date: 2007-05-23 00:00:00 +09:00
+  version: 1.9.0
+date: 2007-12-12 00:00:00 +09:00
 summary: gurgitate-mail is a mail filter (and a mail-delivery agent)
 require_paths: 
 - lib
@@ -30,21 +30,25 @@ authors:
 - Dave Brown
 files: 
 - lib/gurgitate-mail.rb
-- lib/gurgitate/deliver/mbox.rb
-- lib/gurgitate/deliver/maildir.rb
 - lib/gurgitate/deliver.rb
-- lib/gurgitate/mailmessage.rb
 - lib/gurgitate/headers.rb
-test_files: 
+- lib/gurgitate/header.rb
+- lib/gurgitate/mailmessage.rb
+- lib/gurgitate/deliver/maildir.rb
+- lib/gurgitate/deliver/mbox.rb
 - test/test_header.rb
 - test/runtests.rb
-- test/test_delivery.rb
 - test/test_rules.rb
-- test/test_writing.rb
-- test/gurgitate-test.rb
 - test/test_process.rb
 - test/test_configuration.rb
 - test/test_headers.rb
+- test/gurgitate-test.rb
+- test/test_deliver.rb
+- test/test_gurgitate_delivery.rb
+- test/test_writing.rb
+- test/test_delivery.rb
+test_files: 
+- test/runtests.rb
 rdoc_options: []
 
 extra_rdoc_files: []