sortah 0.5.2 → 0.6.0

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+##11/04/11
+
+### IMPROVEMENTS
+
+- if you specify "type :maildir" in the sortah rc file, then sortah will
+  automatically scaffold your destinations into maildir directories (eg, it'll
+  `mkdir -p #{maildir}/#{dest}/{cur,new,tmp}` your destinations), and it will
+  automatically write any new mail into the `/new` subdirectory of your
+  destination.
+
+- Rather than dumping error-causing emails into the vast oblivion, sortah now
+  puts them in the directory specified by the `#error_dest` method 
+
+### ADDITIONS
+
+- added `#error_dest` to the main sortah file
+
 ##11/02/11
 
 ### BUG FIXES

data/bin/sortah

@@ -18,13 +18,38 @@ email = Mail.new(ARGF.read)
 puts "Loading sortah rc" if opts[:verbose]
 load File.expand_path(opts[:rc])
 
-dest = sortah.sort(email).full_destination
+if sortah.type == :maildir 
+  puts "detected maildir format, building maildir directories." if opts[:verbose]
+  maildir = sortah.maildir
+  puts "creating: #{maildir}/#{dest}/{tmp,cur,new}" if opts[:verbose]
+  unless opts[:"dry-run"]
+    sortah.destinations.values.each do |dest|
+      puts dest
+       
+      system "mkdir -p #{maildir}/#{dest}/tmp" 
+      system "mkdir -p #{maildir}/#{dest}/cur"
+      system "mkdir -p #{maildir}/#{dest}/new" 
+    end
+  end
+end
+
+
+begin
+  dest = sortah.sort(email).full_destination
+rescue
+  STDERR.puts "DELIVERY ERROR: #{$!.message}"
+  dest = sortah.full_error_destination
+end
 puts "writing email to: #{dest}" if opts[:"dry-run"] || opts[:verbose]
 
+if sortah.type == :maildir
+  puts "adjusting destination to maildir style" if opts[:verbose]
+  dest = dest + "new" 
+end
+
 exit 0 if opts[:"dry-run"]
 
 #no need to check for dry-run here, we would have exited otherwise
-system "mkdir -p #{dest}" 
 File.open("#{dest}/#{Digest::SHA1.hexdigest(email.to_s)}.eml", 'w') do |f|
   f << email.to_s
 end

data/lib/sortah/handler.rb

@@ -12,7 +12,7 @@ module Sortah
       self
     end
 
-    attr_reader :destinations, :lenses, :routers, :maildir
+    attr_reader :destinations, :lenses, :routers, :maildir, :error_dest, :type
 
     def metadata(key)
       @result.metadata(key)
@@ -26,6 +26,10 @@ module Sortah
       maildir + destination.to_s
     end
 
+    def full_error_destination
+      maildir + error_dest.to_s
+    end
+
     private
 
     def clear_state! 
@@ -40,7 +44,9 @@ module Sortah
       @destinations = context.destinations
       @lenses       = context.lenses
       @routers      = context.routers
+      @error_dest   = context.error_dest
       @maildir      = context.maildir
+      @type         = context.type
     end
   end
 end

data/lib/sortah/parser.rb

@@ -41,6 +41,18 @@ module Sortah
       @maildir
     end
 
+    #double-duty getter/setter
+    def error_dest(dest = nil)
+      @error_dest = dest if dest
+      @error_dest
+    end
+
+    #double-duty getter/setter
+    def type(type = nil)
+      @type = type if type
+      @type
+    end
+
     ## language elements
     def destination(name, args)
       @destinations << Destination.new(name, args)

data/lib/sortah/version.rb

@@ -1,3 +1,3 @@
 module Sortah
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/spec/bin_spec.rb

@@ -1,7 +1,7 @@
 def run_with(arg, email = "")
   #uses the sortah defn in spec/fixtures/rc
   cmd =<<-CMD
-bundle exec bin/sortah #{arg} --rc "spec/fixtures/rc" <<-EMAIL
+bundle exec bin/sortah #{arg} --rc "spec/fixtures/rc" 2>/dev/null <<-EMAIL
 #{email}
 EMAIL
 CMD
@@ -29,6 +29,19 @@ describe "the sortah executable" do
           NOPE. CHUCK TESTA
       TXT
     end
+
+    @failing_email = Mail.new do
+      to 'fail@example.com'
+      from 'fail@nope.com'
+      subject "Taximerdizin'"
+      body <<-TXT
+          OJAI VALLEY TAXIDERMY
+
+          BET YOU THOUGHT THIS EMAIL WAS REAL
+
+          NOPE. CHUCK TESTA
+      TXT
+    end
   end
 
   before :each do
@@ -48,7 +61,18 @@ describe "the sortah executable" do
     end
 
     it "should print to STDOUT the location it intends to write the file" do
-      run_with('--dry-run', @email.to_s)[:result].should =~ %r|writing email to: /tmp/\.mail/foo/|
+      run_with('--dry-run', @email.to_s)[:result].
+        should =~ %r|writing email to: /tmp/\.mail/foo/|
+    end
+
+    it "should write to the destination specified by #error_dest when an exception is raised during sorting" do
+      run_with('--dry-run', @failing_email.to_s)[:result].
+        should =~ %r|writing email to: /tmp/\.mail/errors/|
+    end
+
+    it "should try to create maildir directories if the maildir type is maildir" do
+      run_with('--dry-run --verbose', @failing_email.to_s)[:result].
+        should =~ %r|detected maildir format, building maildir directories.|
     end
   end
 end

data/spec/fixtures/rc

@@ -1,8 +1,11 @@
 sortah do
   maildir '/tmp/.mail/'
+  error_dest 'errors/'
+  type :maildir
   destination :foo, 'foo/'
 
   router do
+    raise RuntimeException if email.from && email.from.any? { |e| e =~ /fail/ }
     send_to :foo
   end
 end

data/spec/parser_spec.rb

@@ -15,7 +15,6 @@ describe Sortah::Parser do
         sortah.should_not be_nil
       end
 
-
       it "should parse defined 'simple' destinations"  do
         expect {
           sortah do
@@ -198,6 +197,35 @@ describe Sortah::Parser do
     end
 
     context "when dealing in general with sortah, " do
+      it "should parse a 'type' clause" do
+        expect {
+          sortah do 
+            type :maildir
+          end
+        }.should_not raise_error
+      end
+
+      it "should provide an inspection method to determine the maildir type" do
+        sortah do 
+          type :maildir
+        end
+        sortah.type.should == :maildir 
+      end
+
+      it "should parse an 'error_dest' clause" do
+        expect {
+          sortah do
+            error_dest 'errors/'
+          end
+        }.should_not raise_error
+      end
+
+      it "error_dest should provide access via a #error_dest method" do
+        sortah do
+          error_dest 'errors/'
+        end
+        sortah.error_dest.should == "errors/"
+      end
 
       it "should maintain one state across multiple sortah blocks" do
         expect {

data/spec/sortah_handler_spec.rb

@@ -2,20 +2,17 @@ require 'spec_helper'
 
 describe Sortah::Handler do
   context "when building the handler" do
-    before :all do
-    end
-
     it "should ask for the parsed content" do
       context = mock(:context)
       context.should_receive(:destinations).and_return(instance_of(Sortah::Destinations))
       context.should_receive(:lenses).and_return(instance_of(Sortah::Lenses))
       context.should_receive(:routers).and_return(instance_of(Sortah::Routers))
       context.should_receive(:maildir).and_return(instance_of(String))
+      context.should_receive(:error_dest).and_return(instance_of(String))
+      context.should_receive(:type).and_return(instance_of(Symbol))
 
       Sortah::Handler.build_from(context)
     end
   end
-
-
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sortah
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-03 00:00:00.000000000Z
+date: 2011-11-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &2161518260 !ruby/object:Gem::Requirement
+  requirement: &2161248620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161518260
+  version_requirements: *2161248620
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &2161517580 !ruby/object:Gem::Requirement
+  requirement: &2161247740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161517580
+  version_requirements: *2161247740
 description: ! "\n    Sortah provides a simple, declarative internal DSL for sorting
   \n    your email. It provides an executable which may serve as an external\n    mail
   delivery agent for such programs as `getmail`. Finally, since\n    your sorting