imap_to_rss 1.0.1 → 1.1

data/.autotest

@@ -2,22 +2,18 @@
 
 require 'autotest/restart'
 
-# Autotest.add_hook :initialize do |at|
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception 'vendor'
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-# end
+Autotest.add_hook :initialize do |at|
+
+  at.testlib = 'minitest/unit'
+
+  def at.path_to_classname(s)
+    sep = File::SEPARATOR
+    f = s.sub(/^test#{sep}/, '').sub(/\.rb$/, '').split(sep)
+    f = f.map { |path| path.split(/_|(\d+)/).map { |seg| seg.capitalize }.join }
+    f = f.map { |path| path =~ /^Test/ ? path : "Test#{path}"  }
+    name = f.join('::').sub 'ImapToRss', 'IMAPToRSS'
+    name.sub 'Hsbc', 'HSBC'
+  end
+
+end
 
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/History.txt

@@ -1,3 +1,16 @@
+=== 1.1 / 2009-09-01
+
+* 1 major enhancement
+  * Added iTunes handler
+
+* 1 bug fix
+  * Fixed various bugs in the Amazon handler
+
+=== 1.0.2 / 2009-05-21
+
+* 1 bug fix
+  * Don't crash when found messages weren't handled
+
 === 1.0.1 / 2009-05-18
 
 * 1 bug fix

data/Manifest.txt

@@ -8,4 +8,10 @@ lib/imap_to_rss.rb
 lib/imap_to_rss/handler.rb
 lib/imap_to_rss/handler/amazon.rb
 lib/imap_to_rss/handler/hsbc.rb
+lib/imap_to_rss/handler/itunes.rb
 lib/imap_to_rss/handler/ups.rb
+lib/imap_to_rss/test_case.rb
+test/test_imap_to_rss_handler_amazon.rb
+test/test_imap_to_rss_handler_hsbc.rb
+test/test_imap_to_rss_handler_itunes.rb
+test/test_imap_to_rss_handler_ups.rb

data/Rakefile

@@ -2,16 +2,20 @@
 
 require 'rubygems'
 require 'hoe'
-$:.unshift 'lib'
-require 'imap_to_rss'
 
-Hoe.new 'imap_to_rss', IMAPToRSS::VERSION do |itor|
-  itor.rubyforge_name = 'seattlerb'
-  itor.developer 'Eric Hodel', 'drbrain@example.com'
+Hoe.add_include_dirs "../../imap_processor/dev/lib"
 
-  itor.extra_deps << ['imap_processor', '~> 1.1']
-  itor.extra_deps << ['nokogiri',       '~> 1.2']
-  itor.extra_deps << ['tmail',          '~> 1.2']
+Hoe.plugin :seattlerb
+
+Hoe.spec 'imap_to_rss' do
+  developer 'Eric Hodel', 'drbrain@example.com'
+
+  self.rubyforge_name = 'seattlerb'
+  self.testlib = :minitest
+
+  extra_deps << ['imap_processor', '~> 1.1']
+  extra_deps << ['nokogiri',       '~> 1.2']
+  extra_deps << ['tmail',          '~> 1.2']
 end
 
 # vim: syntax=Ruby

data/lib/imap_to_rss.rb

@@ -14,7 +14,7 @@ class IMAPToRSS < IMAPProcessor
   ##
   # The version of IMAPToRSS you are using
 
-  VERSION = '1.0.1'
+  VERSION = '1.1'
 
   ##
   # A Struct representing an RSS item for the RSS feed.  Contains fields
@@ -70,7 +70,7 @@ class IMAPToRSS < IMAPProcessor
   ##
   # Creates a new IMAPToRSS and connects to the selected server.
 
-  def initialize(options)
+  def initialize(options = {})
     super
 
     @handlers = []
@@ -177,13 +177,13 @@ class IMAPToRSS < IMAPProcessor
 
         handled = handler.handle messages
 
+        # only tag handled messages, examined messages may be handled in the
+        # future
+        next if handled.empty?
+
         @imap.store handled, '+FLAGS', %w[IMAP_TO_RSS]
 
-        if dest_mailbox then
-          @imap.copy handled, dest_mailbox
-          @imap.store handled, '+FLAGS', [:Deleted]
-          @imap.expunge
-        end
+        move_messages handled, dest_mailbox if dest_mailbox
       end
 
       build_rss

data/lib/imap_to_rss/handler/amazon.rb

@@ -86,11 +86,11 @@ class IMAPToRSS::Handler::Amazon < IMAPToRSS::Handler
 
   def aws_bill
     @mail.body =~ /^Total: (.*)/
-    total = $1
+    total = $1.strip
 
     @mail.body =~ /^(http.*)/
 
-    add_item "Amazon Web Services Bill: #{total}", '', $1
+    add_item "Amazon Web Services Bill: #{total}", '', $1.strip
   end
 
   ##
@@ -99,20 +99,20 @@ class IMAPToRSS::Handler::Amazon < IMAPToRSS::Handler
   def gift_card
     url = "https://www.amazon.com/gp/css/account/payment/view-gc-balance.html"
     @mail.body =~ /^Amount: (.*)/
-    amount = $1
+    amount = $1.strip
 
     @mail.body =~ /^From: (.*)/
-    from = $1
+    from = $1.strip
 
     @mail.body =~ /^Gift Message: (.*)/
-    message = $1
+    message = $1.strip
 
     @mail.body =~ /^Claim code (.*)/
-    claim_code = $1
+    claim_code = $1.strip
 
     subject = "Amazon Gift Card from #{from} - #{amount}!"
 
-    description = "<p><strong>#{from} send you a #{amount} gift card!</strong>\n\n"
+    description = "<p><strong>#{from} sent you a #{amount} gift card!</strong>\n\n"
     description << "<p>#{message}\n\n"
     description << "<h2>#{claim_code}</h2>\n\n"
     description << "<p><a href=\"#{url}\">Claim your gift card</a>"
@@ -130,8 +130,8 @@ class IMAPToRSS::Handler::Amazon < IMAPToRSS::Handler
     items = @mail.body.scan(/(\d?) of (.*)/)
 
     url = order_url order_number
-    subject = "Amazon order cancelation #{order_number}"
-    description = "<p>You canceled your order:\n\n"
+    subject = "Amazon order cancellation #{order_number}"
+    description = "<p>You cancelled your order:\n\n"
 
     description << order_table(items)
 
@@ -143,28 +143,33 @@ class IMAPToRSS::Handler::Amazon < IMAPToRSS::Handler
 
   def order_shipped
     @mail.body =~ /^(The following items .*?:\r\n.*?)(Shipping Carrier|Item Subtotal)/m
+
     items = $1.map do |item|
       next unless item =~ /\d+\s(.*?)\$[\d.]+\s+(\d+)/
       [$2, $1.strip]
     end.compact
 
-    carrier = $1.strip         if @mail.body =~ /Shipping Carrier: (.*)/
+    carrier = $1.strip         if
+      @mail.body =~ /(?:Shipping Carrier:|Shipped via) (.*)/
     date = $1.strip            if @mail.body =~ /Ship Date: (.*)/
     speed = $1.strip           if @mail.body =~ /Shipping Speed: (.*)/
-    tracking_number = $1.strip if @mail.body =~ /Carrier Tracking ID: (.*)/
+    tracking_number = $1.strip if
+      @mail.body =~ /(?:Carrier Tracking ID|Tracking number): (.*)/
 
-    @mail.body =~ /Your shipping address:\r\n\r\n(.*?)\r\n\r\n/m
+    @mail.body =~ /(?:Your shipping address|This shipment was sent to):\r\n\r\n(.*?)\r\n\r\n/m
     address = $1.split("\n").map { |line| line.strip }.join "<br />\n" if $1
 
     if tracking_number then
       url = case carrier
             when 'USPS' then
-                "http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=#{tracking_number}"
+              "http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=#{tracking_number}"
             when 'FedEx' then
-                "http://fedex.com/Tracking?tracknumbers=#{tracking_number}"
+              "http://fedex.com/Tracking?tracknumbers=#{tracking_number}"
+            when 'UPS' then
+              "http://wwwapps.ups.com/WebTracking/processInputRequest?InquiryNumber1=#{tracking_number}"
             else
               log "Unknown carrier: %p" % carrier
-              nil
+              "http://www.google.com/search?q=#{tracking_number}"
             end
     end
 

data/lib/imap_to_rss/handler/hsbc.rb

@@ -18,47 +18,76 @@ class IMAPToRSS::Handler::HSBC < IMAPToRSS::Handler
 
   def handle(uids)
     each_message uids, 'text/plain' do |uid, mail|
-      url = nil
-      description = nil
+      @mail = mail
+      @url = nil
+      @description = nil
 
       case mail.from.first
-      when 'HSBC@email.hsbcusa.com' then
-        mail.body =~ /^Dear.*?,
-                      ([ \t]*\r?\n){2,}
-                      (.*?)
-                      ([ \t]*\r?\n){2,}/mx
-        next false unless $2
-
-        description = $2
       when 'A2ATransfer@us.hsbc.com' then
-        mail.body =~ /^Dear.*?[,:]
-                      ([ \t]*\r?\n){2,}
-                      (.*?)
-                      ([ \t]*\r?\n){2,}
-                      Sincerely,/mx
-        next false unless $2
-
-        body = $2
-
-        body.gsub!(/[*\r]/, '')
-        body.gsub!(/[ \t]*\n/, "\n")
-        body = body.split(/\n\n+/).map { |para| "<p>#{para}</p>" }
-
-        description = body.join "\n\n"
+        next false unless handle_a2atransfer
       when 'alerts@email.hsbcusa.com' then
-        mail.body =~ /^(http:.*)/
-        next false unless $1
-
-        url = $1
+        next false unless handle_alert
+      when 'HSBC@email.hsbcusa.com' then
+        next false unless handle_hsbc
       else
         log "Unknown From: #{mail.from.join ', '}"
         next false
       end
 
-      add_item mail.subject, description, mail.from, mail.date, url,
+      add_item mail.subject, @description, mail.from, mail.date, @url,
                mail.message_id, 'HSBC'
     end
   end
 
+  def handle_a2atransfer
+    @mail.body =~ /^Dear.*?[,:]
+                   ([ \t]*\r?\n){2,}
+                   (.*?)
+                   ([ \t]*\r?\n){2,}
+                   Sincerely,/mx
+
+    return false unless $2
+
+    body = $2
+
+    body.gsub!(/[*\r]/, '')
+    body.gsub!(/[ \t]*\n/, "\n")
+    body = body.split(/\n\n+/).map { |para| "<p>#{para}</p>" }
+
+    @description = body.join "\n\n"
+  end
+
+  def handle_alert
+    @mail.body =~ /^Dear.*?,
+                   ([ \t]*\r?\n){2,}
+                   (.*?)
+                   ([ \t]*\r?\n){2,}/mx
+    return false unless $2
+
+    @description = $2
+  end
+
+  def handle_hsbc
+    case @mail.body
+    when /purchase exceeding/ then
+      @mail.body =~ /Description: (.*)/
+      purchase = $1.strip
+      @mail.body =~ /^Amount: \$\s+([\d.]+)/
+      amount = $1
+
+      @description = <<-DESC
+<p>Your purchase of #{purchase} was for $#{amount} which exceeds your
+notification limit
+      DESC
+    when /^Dear.*?,
+          ([ \t]*\r?\n){2,}
+          (.*?)
+          ([ \t]*\r?\n){2,}/mx
+      @description = $2
+    end
+
+    return false unless @description
+  end
+
 end
 

data/lib/imap_to_rss/handler/itunes.rb

@@ -0,0 +1,49 @@
+require 'imap_to_rss/handler'
+
+##
+# Processes iTunes receipts
+
+class IMAPToRSS::Handler::Itunes < IMAPToRSS::Handler
+
+  def initialize
+    @search = 'FROM', 'itunes'
+  end
+
+  def handle(uids)
+    each_message uids, 'text/plain' do |uid, mail|
+      body = ''
+      mail.body =~ /Order Number: ([^\s]*)/
+      order_number = $1
+
+      next false unless order_number
+
+      mail.body =~ /Order Total: (\$[\d.]+)/
+      total = $1
+
+      mail.body =~ /Purchase History:.*?(https:.*?)\r/m
+      url = $1
+
+      mail.body =~ /^Item\sNumber.*?
+                    (^-+\r?\n)
+                    (.*?)
+                    \1/mx
+
+      body << "<table>\n<tr><th>Item<th>Price\n"
+
+      $2.scan(/^([^\s]+)\s+(.*?)\s+(Free|\$[\d.]+)/) do |item, name, price|
+        body << "<tr><td>#{name}<td>#{price}\n"
+      end
+
+      body << "</table>\n"
+
+      body << "<p>Total: #{total}"
+
+      subject = "iTunes Receipt ##{order_number}, #{total}"
+
+      add_item subject, body, mail.from, mail.date, url,
+               mail.message_id, 'iTunes'
+    end
+  end
+
+end
+

data/lib/imap_to_rss/test_case.rb

@@ -0,0 +1,66 @@
+require 'minitest/autorun'
+require 'imap_to_rss'
+
+# :stopdoc:
+class IMAPToRSS
+  def connect(*args)
+    o = Object.new
+    def o.imap() end
+    o
+  end
+end
+
+class IMAPToRSS::Handler
+  attr_accessor :mail
+end
+# :startdoc:
+
+##
+# Test case for IMAPToRSS handlers
+
+class IMAPToRSS::TestCase < MiniTest::Unit::TestCase
+
+  ##
+  # Sets this test case up with +handler+.  Provides instance variables
+  # <tt>@itor</tt> and <tt>@handler</tt>
+
+  def setup(handler)
+    @itor = IMAPToRSS.new
+    @handler = handler
+    @handler.setup @itor
+  end
+
+  ##
+  # Returns a new TMail::Mail from +options+.  Defaults are:
+  #
+  # from:: from@example.com
+  # date:: Time.at 0
+  # to:: to@example.com
+  # subject:: subject for this mail
+  # body:: Hi! I'm a body!
+  #
+  # The mail body will be normalized to \r\n line breaks.
+
+  def util_mail(options = {})
+    options = {
+      :from => 'from@example.com',
+      :date => Time.at(0),
+      :to => 'to@example.com',
+      :subject => 'subject for this mail',
+      :body => 'Hi! I\'m a body!'
+    }.merge options
+
+    body = options[:body].split(/\r?\n/).join "\r\n"
+
+    TMail::Mail.parse <<-MAIL
+From: #{options[:from]}\r
+Date: #{options[:date].rfc2822}\r
+To: #{options[:to]}\r
+Subject: #{options[:subject]}\r
+\r
+#{body}
+    MAIL
+  end
+
+end
+