tangofoxtrot-tmail_bouncer 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tangofoxtrot
+
+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.rdoc

@@ -0,0 +1,9 @@
+= tmail_bouncer
+
+Additional functionality to Tmail to handle and parse bounce back emails.
+
+Original code came from http://github.com/dmarkow/tmail_bounce_parser/tree/master
+
+== Copyright
+
+Copyright (c) 2009 tangofoxtrot. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tmail_bouncer"
+    gem.summary = %Q{TODO}
+    gem.email = "richard.luther@gmail.com"
+    gem.homepage = "http://github.com/tangofoxtrot/tmail_bouncer"
+    gem.authors = ["tangofoxtrot"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tmail_bouncer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/bouncers/base.rb

@@ -0,0 +1,69 @@
+module TmailBouncer
+  class Base
+    attr_accessor :status_info, :original_message_id, :original_sender, :original_recipient, :original_subject, :handling_server, :status_part, :original_message
+
+    
+    def initialize(email)
+      @email = email
+      determine_status_part
+      determine_original_message_part
+      parse_status_part
+      parse_original_message_part    
+      parse_original_recipient
+      parse_original_sender 
+      parse_original_subject     
+    end
+    
+    def self.available_bouncers
+      @@bouncers ||= [TmailBouncer::StandardBouncer]
+    end 
+
+
+    def self.determine_bouncer(email)
+      if klass = available_bouncers.find {|bouncer| bouncer.recognize? email}
+        klass.new(email)
+      else
+        TmailBouncer::NoBouncer.new
+      end
+    end 
+ 
+    def self.from_email(email)
+      bounce = determine_bouncer(email)
+      # lets start by trying to extract the message/delivery-status part
+      
+      bounce
+    end
+
+    def status
+      case status_info['Status']
+      when /^5/
+        'Failure'
+      when /^4/
+        'Temporary Failure'
+      when /^2/
+        'Success'
+      end
+    end
+
+
+    # def determine_status_part
+    # end
+    # 
+    # def determine_original_message_part
+    # end
+    # 
+    # def parse_status_part
+    # end
+    # 
+    # def parse_original_message_part
+    #  
+    # end
+
+    
+  end
+      
+  def undeliverable_info
+    TmailBouncer::Base.from_email(self)
+  end
+  
+end

data/lib/bouncers/no_bouncer.rb

@@ -0,0 +1,12 @@
+module TmailBouncer
+  class NoBouncer < Base
+    
+    def initialize
+      
+    end
+    
+    def status
+      "Success"
+    end
+  end
+end

data/lib/bouncers/standard_bouncer.rb

@@ -0,0 +1,48 @@
+module TmailBouncer
+  class StandardBouncer < Base
+    
+    def self.recognize?(email)
+      email.parts.detect do |part|
+        part.content_type == "message/delivery-status"
+      end
+    end
+    
+    def determine_status_part
+      self.status_part = @email.parts.detect { |part| part.content_type == "message/delivery-status" }
+    end
+
+    def determine_original_message_part
+      self.original_message = @email.parts.detect do |part|
+        part.content_type == "message/rfc822"
+      end      
+    end
+
+
+    def parse_status_part
+      statuses = self.status_part.body.gsub("\n ","").split(/\n/)
+      self.status_info = statuses.inject({}) do |hash,line|
+        key,value = line.split(/:/,2)
+        hash[key] = value.strip rescue nil
+        hash
+      end  
+    end
+
+    def parse_original_message_part
+      self.original_message = TMail::Mail.parse(self.original_message.body)
+      self.original_message_id = self.original_message.message_id      
+    end
+    
+    def parse_original_recipient
+      self.original_recipient = self.status_info["Final-Recipient"].to_s.gsub("Final-Recipient: ","").gsub("rfc822;","").strip
+    end
+
+    def parse_original_sender
+      self.original_sender = self.original_message.from.to_a.first
+    end
+
+    def parse_original_subject
+      self.original_subject = self.original_message.subject
+    end
+    
+  end
+end

data/lib/tmail_bouncer.rb

@@ -0,0 +1,5 @@
+require 'tmail'
+require 'bouncers/base'
+require 'bouncers/standard_bouncer'
+require 'bouncers/no_bouncer'
+TMail::Mail.send :include, TmailBouncer

data/test/fixtures/yahoo.eml

@@ -0,0 +1,72 @@
+Return-Path: <>
+X-Original-To: joe@example.com
+Delivered-To: joe@example.com
+Received: by mail.example.com (Postfix)
+	id CD6DE1780F5; Thu, 28 May 2009 14:03:11 -0700 (PDT)
+Date: Thu, 28 May 2009 14:03:11 -0700 (PDT)
+From: MAILER-DAEMON@example.com (Mail Delivery System)
+Subject: Undelivered Mail Returned to Sender
+To: joe@example.com
+MIME-Version: 1.0
+Content-Type: multipart/report; report-type=delivery-status;
+	boundary="A6CFB1785AB.1243544591/mail.example.com"
+Message-Id: <20090528210311.CD6DE1780F5@mail.example.com>
+
+This is a MIME-encapsulated message.
+
+--A6CFB1785AB.1243544591/mail.example.com
+Content-Description: Notification
+Content-Type: text/plain
+
+This is the Postfix program at host mail.example.com.
+
+I'm sorry to have to inform you that your message could not
+be delivered to one or more recipients. It's attached below.
+
+For further assistance, please send mail to <postmaster>
+
+If you do so, please include this problem report. You can
+delete your own text from the attached returned message.
+
+			The Postfix program
+
+<fred@somewhere.com>: host mail.somewhere.com[1.1.1.1] said: 554
+    delivery error: dd Sorry your message to fred@somewhere.com cannot be
+    delivered. This account has been disabled or discontinued [#102]. -
+    mail.somewhere.com (in reply to end of DATA command)
+
+--A6CFB1785AB.1243544591/mail.example.com
+Content-Description: Delivery report
+Content-Type: message/delivery-status
+
+Reporting-MTA: dns; mail.example.com
+X-Postfix-Queue-ID: A6CFB1785AB
+X-Postfix-Sender: rfc822; joe@example.com
+Arrival-Date: Thu, 28 May 2009 13:26:56 -0700 (PDT)
+
+Final-Recipient: rfc822; fred@somewhere.com
+Action: failed
+Status: 5.0.0
+Diagnostic-Code: X-Postfix; host mail.somewhere.com[1.1.1.1] said: 554
+    delivery error: dd Sorry your message to fred@somewhere.com cannot be
+    delivered. This account has been disabled or discontinued [#102]. -
+    mail.somewhere.com (in reply to end of DATA command)
+
+--A6CFB1785AB.1243544591/mail.example.com
+Content-Description: Undelivered Message
+Content-Type: message/rfc822
+
+Received: from mail.example.com (example.com [2.2.2.2])
+	by mail.example.com (Postfix) with ESMTP id A6CFB1785AB
+	for <fred@somewhere.com>; Thu, 28 May 2009 13:26:56 -0700 (PDT)
+Date: Thu, 28 May 2009 13:26:06 -0700
+From: joe@example.com
+To: fred@somewhere.com
+Subject: I like turtles
+Mime-Version: 1.0
+Content-Type: text/html; charset=utf-8
+Message-Id: <1234.1212@example.com>
+
+Hi
+
+--A6CFB1785AB.1243544591/mail.example.com--

data/test/fixtures/yahoo_legit.eml

@@ -0,0 +1,42 @@
+Return-Path: <joe@example.com>
+X-Original-To: fred@somewhere.com
+Delivered-To: fred@somewhere.com
+Received: from mail.mud.yahoo.com (mail.pnn.com [8.12.160.195])
+	by mail.somewhere.com (Postfix) with SMTP id 618E317804A
+	for <fred@somewhere.com>; Thu, 28 May 2009 23:13:11 -0700 (PDT)
+Received: from mail.mud.yahoo.com ([68.142.200.144]
+	helo=mail.mud.yahoo.com) by ASSP.nospam; 28 May 2009
+	23:13:11 -0700
+Received: (qmail 3737 invoked by uid 60001); 29 May 2009 06:06:40 -0000
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yahoo.com; s=s1024; t=1243577200; bh=jq9T7juj3eU1mLVzXoF9iug+sOAeLdokzpK7l6424R0=; h=Message-ID:X-YMail-OSG:Received:X-Mailer:Date:From:Subject:To:MIME-Version:Content-Type; b=DFynmvLugBnhvJRnSgOKYtXDUQHVYBQbu4ZIaw8HrtBcfVXdunZUAXfalf2wL22pQpBI4jd70OVucAWhAi7g8IqpdDYCZ5EMApRQP8yOlelrCULXnvv8hqbPO8IL/nenNq1W+2gOY9zTgHNubWBvOd8pAxF3odwlPJqqx7XgQb4=
+DomainKey-Signature:a=rsa-sha1; q=dns; c=nofws;
+  s=s1024; d=yahoo.com;
+  h=Message-ID:X-YMail-OSG:Received:X-Mailer:Date:From:Subject:To:MIME-Version:Content-Type;
+  b=0PXdCXj2w/uWB5Cvl1Aau1YBGeITW4Ep333GHD8NkGFt+87rTzn8Kz2Zxup//fqCjfUv5rU3mLt35ALNmzJ1pwX9odVsz2lpGQxZS0ExDizP+WBLlI51/1q11ufv6EJ7dlTo0E8Ia9x2pc9MdrOImKkEbUTzdzLTVzdGR34cXrs=;
+Message-ID: <381499.2516.qm@web30801.mail.mud.yahoo.com>
+X-YMail-OSG: hjm_1hIVM1k3pRgaY.b.u55HvX..XUf4Kr8T.rVbhY8FeitCmjki3l2l70Zr4q3KCc0MXf0.2Oo6Mg80Tj.gwa.yZ_sS79Ecp_JSaummtL54K.3FM4vtPI.bBy6O9pqXU5mesTKuK8tUMU5LQFkIK1XLhcCwpu96BXag9EMFXW0Ttvt_2KojLGAv14ul0_28Xy883D8s_AYimofrN..ywdsTSir3_3W1fKiyFIo.EXgo16Qqt8OcwEqE0qIBpkSaEmC4a6qxg8JuqPiIAKNvp_hkn8pmoOEa4yW.614Y
+Received: from [75.62.232.23] by web30801.mail.mud.yahoo.com via HTTP; Thu, 28 May 2009 23:06:40 PDT
+X-Mailer: YahooMailClassic/5.3.9 YahooMailWebService/0.7.289.10
+Date: Thu, 28 May 2009 23:06:40 -0700 (PDT)
+From: Richard L <joe@example.com>
+Subject: Hi
+To: Richard <fred@somewhere.com>
+MIME-Version: 1.0
+Content-Type: multipart/alternative; boundary="0-1875523946-1243577200=:2516"
+X-Assp-Received-RBL: pass
+
+
+--0-1875523946-1243577200=:2516
+Content-Type: text/plain; charset=us-ascii
+
+Hello
+
+
+      
+--0-1875523946-1243577200=:2516
+Content-Type: text/html; charset=us-ascii
+
+<table cellspacing="0" cellpadding="0" border="0" ><tr><td valign="top" style="font: inherit;">Hello</td></tr></table><br>
+
+      
+--0-1875523946-1243577200=:2516--

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tmail_bouncer'
+
+class Test::Unit::TestCase
+end

data/test/unit/tmail_bouncer_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+class TmailBouncerTest < Test::Unit::TestCase
+
+  context "Yahoo Bounce" do    
+    setup do
+      @email = read_email('yahoo.eml')
+    end
+    
+    should "be a tmail object" do
+      assert @email.is_a?(TMail::Mail), "Whoops Im a #{@email.class}"
+    end
+
+    should "return StandardBouncer" do
+      assert @email.undeliverable_info.is_a?(TmailBouncer::StandardBouncer) , "Whoops Im a #{@email.class}"
+    end
+    
+    should "detect bounced" do
+      assert_equal @email.undeliverable_info.status, "Failure"
+    end
+    
+    should "detect original sender" do
+      assert_equal @email.undeliverable_info.original_sender, "joe@example.com"      
+    end
+    
+    should "detect original recipient" do
+      assert_equal @email.undeliverable_info.original_recipient, "fred@somewhere.com"      
+    end
+
+    should "detect original subject" do
+      assert_equal @email.undeliverable_info.original_subject, "I like turtles"            
+    end    
+
+    should "detect original_message_id" do
+      assert_equal @email.undeliverable_info.original_message_id, "<1234.1212@example.com>"
+    end
+    
+    should "return status of failure" do
+      assert_equal "Failure",  @email.undeliverable_info.status
+    end           
+  end
+
+  context "Yahoo Legit Email" do
+  
+    setup do
+      @email = read_email('yahoo_legit.eml')
+    end  
+    
+
+    should "be a tmail object" do
+      assert @email.is_a?(TMail::Mail), "Whoops Im a #{@email.class}"
+    end
+
+    should "return NoBouce" do
+      assert @email.undeliverable_info.is_a?(TmailBouncer::NoBouncer) , "Whoops Im a #{@email.class}"
+    end
+
+    should "return status of Success" do
+      assert_equal "Success",  @email.undeliverable_info.status
+    end 
+                    
+  end
+  
+
+protected
+
+  def read_email(name)
+    TMail::Mail.parse(File.read('test/fixtures/' + name))
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: tangofoxtrot-tmail_bouncer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- tangofoxtrot
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: richard.luther@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/bouncers/base.rb
+- lib/bouncers/no_bouncer.rb
+- lib/bouncers/standard_bouncer.rb
+- lib/tmail_bouncer.rb
+- test/fixtures/yahoo.eml
+- test/fixtures/yahoo_legit.eml
+- test/test_helper.rb
+- test/unit/tmail_bouncer_test.rb
+has_rdoc: true
+homepage: http://github.com/tangofoxtrot/tmail_bouncer
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/test_helper.rb
+- test/unit/tmail_bouncer_test.rb