rockdove 0.0.1 → 0.1.0

data/CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ### initial release
 
-* Connects to EWS mailbox
-* Fetches the mail items
-* Parses each item (Signatures, Replies, Forward) 
-* Handles bounce types (Undeliverable,AutoReply)
-* Polls for every interval specified
-* Provides a template of the Daemon for easy plug & play
+* [Feature] Connects to EWS mailbox
+* [Feature] Fetches the mail items
+* [Feature] Parses each item (Signatures, Replies, Forward) 
+* [Feature] Handles bounce types (Undeliverable,AutoReply)
+* [Feature] Polls for every interval specified
+* [Feature] Provides a template of the Daemon for easy plug & play
+
+## v0.1.0
+
+* [Enhancement] Ignore Delivery Failure Notices
+* [Feature] Ignore Mails from specific email(s) list
+* [Enhancement] Handles line breaks issue by setting text only mode for email body

data/README.md

@@ -1,4 +1,4 @@
-rockdove ![rockdove](http://kiran.gnufied.org/wp-content/uploads/2012/07/1341725724_bird.png) [![Build Status](https://secure.travis-ci.org/kiranh/rockdove.png)](http://travis-ci.org/kiranh/rockdove)
+rockdove ![rockdove](http://kiran.gnufied.org/wp-content/uploads/2012/07/1341725724_bird.png) [![Build Status](https://secure.travis-ci.org/kiranh/rockdove.png?branch=master)](http://travis-ci.org/kiranh/rockdove)
 ========
 
 Incoming mail processing daemon for Exchange Web Services 1.0 (EWS). This Ruby Gem connects to the EWS mailbox, fetches the mail items, parses each mail item (Signatures, Replies, Forward), handles bounce types (Undeliverable,AutoReply) and polls the mailbox for every interval specified. 

data/lib/rockdove/collect_mail.rb

@@ -3,6 +3,7 @@ module Rockdove
     UNDELIVERABLE = /Undeliverable/i
     AUTO_REPLY = /Automatic reply/i
     SPAM = /SPAM/i
+    FAILURE = /Delivery(.+)Failure/i
 
     class << self
       attr_accessor :mail_stack, :inbox_connection
@@ -28,7 +29,7 @@ module Rockdove
     def send_rockdove_to_watch_mail(&block)
       Rockdove.logger.info "Rockdove on watch for new mail..."
       parsed_mails = group_of_mails
-      if parsed_mails
+      if parsed_mails        
         Rockdove.logger.info "Rockdove calling App block"
         block.call(parsed_mails)
         process()
@@ -36,32 +37,45 @@ module Rockdove
     end
 
     def group_of_mails
-      return no_mail_alert unless fetch_from_box
-      Rockdove.logger.info "Rockdove collected #{fetch_from_box.count} mail(s)."
+      return no_mail_alert unless fetch_from_box      
+      Rockdove.logger.info "Rockdove collected #{@mail_stack.count} mail(s)."
       letters = RockdoveCollection.new
       @mail_stack.reverse.each do |item|
-        if bounce_type_mail?(item)
+        if ignore_mail?(item) || bounce_type_mail?(item)
+          item.delete!
           @mail_stack.delete(item)
-        else
-          letters << retrieve_mail(@inbox_connection.get_item(item.id))
+        else           
+          letters << retrieve_mail(item)
         end
       end
       letters
     end
 
+    def ignore_mail?(item)
+      email = item.from.email_address
+      ignore_list = Rockdove::Config.ignore_mails
+      return false unless ignore_list && !(ignore_list.empty?)
+      if ignore_list.include?(email)
+        Rockdove.logger.info "Rockdove detected #{email} under ignore mail list."
+        true 
+      else
+        false
+      end
+    end
+
     def bounce_type_mail?(item)
       case item.subject
-      when UNDELIVERABLE, AUTO_REPLY, SPAM
-        Rockdove.logger.info "Rockdove deleted this mail: #{item.subject}."
-        item.delete!
+      when UNDELIVERABLE, AUTO_REPLY, SPAM, FAILURE
+        Rockdove.logger.info "Rockdove deleting this mail: #{item.subject}."
         true
       else
         false
       end
     end
 
-    def retrieve_mail(fetched_mail)
-      Rockdove::ExchangeMail.new(fetched_mail)
+    def retrieve_mail(fetched_mail) 
+      @inbox_connection ||= inbox
+      Rockdove::ExchangeMail.new(fetched_mail, @inbox_connection)
     end
 
     def no_mail_alert

data/lib/rockdove/config.rb

@@ -1,7 +1,7 @@
 module Rockdove
   class Config
     class << self
-      attr_accessor :url, :username, :password, :incoming_folder, :archive_folder, :watch_interval
+      attr_accessor :url, :username, :password, :incoming_folder, :archive_folder, :watch_interval, :ignore_mails
     end
 
     def self.configure(&block)
@@ -33,6 +33,10 @@ module Rockdove
       @watch_interval = value || 60
     end
 
+    def self.ews_ignore_mails(value)
+      @ignore_mails = value || []
+    end
+
     def self.connect
       Viewpoint::EWS::EWS.endpoint = @url
       Viewpoint::EWS::EWS.set_auth @username, @password

data/lib/rockdove/email_parser.rb

@@ -1,14 +1,14 @@
 module Rockdove
   class EmailParser
     HTML_REGEXP = /<\/?[^>]*>/
-    FWD_REGEXP = /^(On(.+)wrote:.+\z)$/nm
+    FWD_REGEXP = /^(On(.+)wrote:.+\z)$/inm
     SIGNATURE_REGEXP = /^(Thanks(.+)Regards.+\z)$/inm
-    REPLY_REGEXP = /^(From:(.+)Sent:.+\z)$/nm
+    REPLY_REGEXP = /^(From:(.+)Sent:.+\z)$/inm
+    SENT_VIA = /^(Sent(.+)Via.+\z)$/inm
     DASHES = "________________________________________"
 
     def self.parse_mail(mail, body_type)
-      email_parser = new()
-      email_parser.parse_email_tags(mail,body_type)
+      new().parse_email_tags(mail,body_type)
     end
 
     def parse_email_tags(mail,body_type)
@@ -16,13 +16,14 @@ module Rockdove
       return nil unless mail
       mail.gsub!(HTML_REGEXP, "").strip! if body_type == "HTML"
       parsed_content = EmailReplyParser.parse_reply(mail)
-      content = choose_and_parse(parsed_content)
-      handle_outlook_extra_line_breaks(content)
+      choose_and_parse(parsed_content)      
     end
 
     def choose_and_parse(content)
       content.gsub!(DASHES,"")      
-      case content     
+      case content 
+      when SENT_VIA
+        content.gsub(SENT_VIA,"").strip! 
       when SIGNATURE_REGEXP 
         content.gsub(SIGNATURE_REGEXP,"").strip! 
       when REPLY_REGEXP
@@ -33,14 +34,5 @@ module Rockdove
         content
       end      
     end   
-
-    def handle_outlook_extra_line_breaks(content)
-      if content && !(content.split("\n").first.include?(" "))
-        content.sub!("\n", "")
-      end
-      content
-    rescue
-      content
-    end
   end
 end

data/lib/rockdove/exchange_mail.rb

@@ -6,11 +6,14 @@ module Rockdove
   class ExchangeMail
     extend Forwardable
 
-    def_delegators :@mail_item, :to_recipients, :date_time_created, :date_time_sent, :from
-    def_delegators :@mail_item, :subject, :body, :has_attachments?, :attachments
+    def_delegators :@mail_item, :to_recipients, :date_time_created, :date_time_sent, :from, :body, :body_type
+    def_delegators :@mail_item, :subject, :body, :has_attachments?, :attachments, :text_only=, :text_only? 
+
+    attr_accessor :connection
     
-    def initialize(mail_item)
+    def initialize(mail_item, connection)
       @mail_item = mail_item
+      @connection = connection
     end
 
     def to_recipients
@@ -30,7 +33,12 @@ module Rockdove
     end
 
     def body
-      parse_it(@mail_item.body, @mail_item.body_type) unless @mail_item.body.empty?
+      mail = get_items(@mail_item)
+      parse_it(mail.first.body, mail.first.body_type) unless mail.first.body.empty?
+    end
+
+    def get_items(mail)
+      @connection.get_items([mail.id], nil, {:item_shape => retrieve_text_type})
     end
 
     def attachments
@@ -47,6 +55,10 @@ module Rockdove
 
     def parse_it(mail_body, type)
       Rockdove::EmailParser.parse_mail(mail_body, type)
-    end   
+    end  
+
+    def retrieve_text_type
+      {:base_shape=>"AllProperties", :body_type=>"Text"}
+    end 
   end
 end

data/lib/rockdove/script/rockdove_server.rb

@@ -19,6 +19,7 @@ class RockdoveServer
       config.ews_archive_folder 'Archive' # by default, it deletes the mail after processing, mention ews_archive_folder if it 
       # has to be archived to a different folder
       config.ews_watch_interval 60 # by default, the polling interval is 60
+      config.ews_ignore_mails ["postmaster@ewsdomain.com"] # an array of emails to be ignored
     end
     #Raad.env = "production"
   end

data/lib/rockdove/version.rb

@@ -1,3 +1,3 @@
 module Rockdove
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/rockdove/collect_mail_spec.rb

@@ -14,6 +14,7 @@ describe "CollectParseArchive" do
     mails = []
     mails << fetch_mail("new_mail") << fetch_mail("forwarded_mail") << fetch_mail("replied_mail")
     handle_inbox(mails)
+    mails.map {|mail| from_object = convert_to_class(mail.from) ; mail.should_receive(:from).at_most(3).times.and_return(from_object) }
     result = @mail_retriever.group_of_mails
     result.should be_an_instance_of(Rockdove::RockdoveCollection)
     result.count.should == 3
@@ -23,6 +24,7 @@ describe "CollectParseArchive" do
   it "should archive the mail at the end of collection cycle if user assigns ews move folder" do
     mail = fetch_mail("new_mail") 
     handle_inbox(Array(mail))
+    convert_from_hash(mail)
     @mail_retriever.group_of_mails.should be_an_instance_of(Rockdove::RockdoveCollection)
     stub_destination_point 
     lambda { @mail_retriever.process }.should_not raise_error
@@ -33,6 +35,7 @@ describe "CollectParseArchive" do
     @connection.archive_folder = nil
     mail = fetch_mail("new_mail") 
     handle_inbox(Array(mail))
+    convert_from_hash(mail)
     @mail_retriever.group_of_mails.should be_an_instance_of(Rockdove::RockdoveCollection)
     lambda { @mail_retriever.process }.should_not raise_error
     @log_stream.string.should =~ /Rockdove delivered & deleted the mail/
@@ -40,6 +43,7 @@ describe "CollectParseArchive" do
 
   it "should parse the signature of the mail" do
     mail = fetch_mail("mail_type_text") 
+    convert_from_hash(mail)
     parsed_content = Rockdove::EmailParser.parse_mail(mail.body, mail.body_type)
     parsed_content.should == "This is a new post"
   end 
@@ -53,6 +57,7 @@ describe "CollectParseArchive" do
   it "should watch for new mail when called" do
     mail = fetch_mail("new_mail") 
     handle_inbox(Array(mail))
+    convert_from_hash(mail)
     output = @mail_retriever.send_rockdove_to_watch_mail do |mail|
      true
     end
@@ -63,15 +68,26 @@ describe "CollectParseArchive" do
   it "should handle undeliverable bounce type" do
     mail = fetch_mail("auto_reply_mail")
     handle_inbox(Array(mail))
+    convert_from_hash(mail)
     @mail_retriever.group_of_mails.should be_an_instance_of(Rockdove::RockdoveCollection)
-    @log_stream.string.should include("Rockdove deleted this mail: Automatic reply: Out of Office Message")
+    @log_stream.string.should include("Rockdove deleting this mail: Automatic reply: Out of Office Message")
+  end
+
+  it "should ignore mails when specified under ews_ignore_mails list" do
+    mail = fetch_mail("undeliverable_mail")
+    handle_inbox(Array(mail))
+    convert_from_hash(mail)
+    @mail_retriever.group_of_mails.should be_an_instance_of(Rockdove::RockdoveCollection)
+    @log_stream.string.should include("Rockdove detected postmaster@ewsdomain.com under ignore mail list.")
   end
 
   it "should handle auto reply bounce type" do
+    @connection.ews_ignore_mails([])
     mail = fetch_mail("undeliverable_mail")
     handle_inbox(Array(mail))
+    convert_from_hash(mail)
     @mail_retriever.group_of_mails.should be_an_instance_of(Rockdove::RockdoveCollection)
-    @log_stream.string.should include("Rockdove deleted this mail: Undeliverable: New Post")
+    @log_stream.string.should include("Rockdove deleting this mail: Undeliverable: New Post")
   end
 
   def handle_inbox(mail_array)

data/spec/rockdove/emails/undeliverable_mail.yml

@@ -39,7 +39,7 @@ is_read_receipt_requested:
 from:
   name:
     text: LastName, User (ewsdomain)
-  email_address: User.LastName@ewsdomain.com
+  email_address: postmaster@ewsdomain.com
   routing_type:
     text: SMTP
 is_read:

data/spec/rockdove/fetch_incoming_mail_spec.rb

@@ -7,6 +7,7 @@ describe "FetchIncomingMail" do
     @mail_retriever = Rockdove::CollectMail.new()
     @log_stream = StringIO.new
     Rockdove.stub!(:logger).and_return(Logger.new(@log_stream))
+    @test_server = Rockdove::EWS.new()
   end
   
   it "should validate the exchange server info provided" do
@@ -28,6 +29,7 @@ describe "FetchIncomingMail" do
   it "is trying to fetch a new forwarded mail" do
     mail = fetch_mail("forwarded_mail")
     mail.should be_an_instance_of(Rockdove::EWS)
+    handle_inbox(Array(mail))
     result = @mail_retriever.retrieve_mail(mail)  
     result.should be_an_instance_of(Rockdove::ExchangeMail)
     result.body.should == "FYI"  
@@ -39,6 +41,7 @@ describe "FetchIncomingMail" do
   it "is trying to fetch a new mail" do
     mail = fetch_mail("new_mail")  
     mail.should be_an_instance_of(Rockdove::EWS)
+    handle_inbox(Array(mail))
     result = @mail_retriever.retrieve_mail(mail) 
     result.should be_an_instance_of(Rockdove::ExchangeMail)   
     result.body.should == "Hi, This is a new post"  
@@ -50,6 +53,7 @@ describe "FetchIncomingMail" do
   it "is trying to fetch a new replied mail" do
     mail = fetch_mail("replied_mail")
     mail.should be_an_instance_of(Rockdove::EWS) 
+    handle_inbox(Array(mail))
     result = @mail_retriever.retrieve_mail(mail)
     result.should be_an_instance_of(Rockdove::ExchangeMail)
     result.body.should == "This is a replied post from outlook"
@@ -65,13 +69,11 @@ describe "FetchIncomingMail" do
     result.date_time_sent.should == mail.date_time_sent 
   end
 
-  def convert_from_hash(mail)
-    from_object = convert_to_class(mail.from)
-    mail.should_receive(:from).twice.and_return(from_object)
-  end
-
-  def convert_to_class(hash)
-    Hash2Class.new(hash)
+  def handle_inbox(mail_array)
+    @mail_retriever.should_receive(:inbox).at_most(:twice).and_return(@test_server)
+    @test_server.should_receive(:find_items).at_most(:twice).and_return(mail_array)
+    @test_server.should_receive(:get_items).at_most(:twice).and_return(mail_array)
+    @mail_retriever.retrieve_mail(mail_array.first).should be_an_instance_of(Rockdove::ExchangeMail)
   end
 
 end

data/spec/rockdove/rockdove_shared_spec.rb

@@ -21,6 +21,10 @@ module Rockdove
       item
     end
 
+    def get_items(mail,key,shape)
+      Array(mail)
+    end
+
     def move!(destination)
       response("Archived the Mail Item")
     end
@@ -42,6 +46,15 @@ class Hash2Class
   end
 end
 
+def convert_from_hash(mail)
+  from_object = convert_to_class(mail.from)
+  mail.should_receive(:from).at_most(3).times.and_return(from_object)
+end
+
+def convert_to_class(hash)
+  Hash2Class.new(hash)
+end
+
 def fetch_mail(name)
   YAML.load(fetch_mail_path(name.to_sym))    
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'simplecov'
 SimpleCov.start do
   add_filter '/vendor/bundle/'
+  add_filter '/spec'
 end
 
 require 'rockdove'
@@ -18,6 +19,7 @@ Rockdove::Config.configure do |config|
   config.ews_folder 'Inbox'
   config.ews_archive_folder 'Archive'
   config.ews_watch_interval 60
+  config.ews_ignore_mails ["postmaster@ewsdomain.com"]
 end
 
 RSpec.configure do |c|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rockdove
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-08 00:00:00.000000000Z
+date: 2012-07-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &86710060 !ruby/object:Gem::Requirement
+  requirement: &80745770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *86710060
+  version_requirements: *80745770
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &86709640 !ruby/object:Gem::Requirement
+  requirement: &80745510 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *86709640
+  version_requirements: *80745510
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &86709160 !ruby/object:Gem::Requirement
+  requirement: &80745180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *86709160
+  version_requirements: *80745180
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &86708860 !ruby/object:Gem::Requirement
+  requirement: &80744910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *86708860
+  version_requirements: *80744910
 - !ruby/object:Gem::Dependency
   name: raad
-  requirement: &86708510 !ruby/object:Gem::Requirement
+  requirement: &80744630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *86708510
+  version_requirements: *80744630
 - !ruby/object:Gem::Dependency
   name: viewpoint
-  requirement: &86708250 !ruby/object:Gem::Requirement
+  requirement: &80688550 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -76,10 +76,10 @@ dependencies:
         version: 0.1.26
   type: :runtime
   prerelease: false
-  version_requirements: *86708250
+  version_requirements: *80688550
 - !ruby/object:Gem::Dependency
   name: email_reply_parser
-  requirement: &86708020 !ruby/object:Gem::Requirement
+  requirement: &80688340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *86708020
+  version_requirements: *80688340
 - !ruby/object:Gem::Dependency
   name: logger
-  requirement: &86707770 !ruby/object:Gem::Requirement
+  requirement: &80688100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *86707770
+  version_requirements: *80688100
 description: Incoming mail processing daemon for Exchange Web Services (EWS). This
   is the Ruby Gem that does fetching, parsing and watching the mailbox for further
   processing.
@@ -152,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -565949649
+      hash: -374666243
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -161,10 +161,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -565949649
+      hash: -374666243
 requirements: []
 rubyforge_project: rockdove
-rubygems_version: 1.8.15
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Incoming mail processing daemon for Exchange Web Services (EWS)