rockdove 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+Gemfile.lock
+pkg/*
+coverage
+vendor/cache

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## v0.0.1
+
+### 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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rockdove.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2012-2015 Kiran Soumya Bosetti
+
+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.md

@@ -0,0 +1,87 @@
+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)
+========
+
+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. 
+
+It provides a template of the rockdove server which is a simple plug and play daemon.
+
+## Installation
+
+  ```ruby
+  #Under Gemfile
+  gem 'rockdove', :require => false
+
+  #After bundle install, run this command below
+  bundle exec rails g rockdove:install
+  ```
+  It copies a template of rockdove server under you script folder which contains the following snippet:
+
+  ```ruby
+  
+  # ...
+  
+  Rockdove::Config.configure do |config| 
+    config.ews_url 'https://ewsdomain.com/ews/exchange.asmx'
+    config.ews_username 'ews_username'
+    config.ews_password 'ews_password'
+    config.ews_folder 'Inbox' # ews_folder is Inbox by default
+    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
+  end
+  
+  # ...
+
+  Rockdove::CollectMail.watch do |rockdove_parsed_mail|
+    begin
+      #Model.method(rockdove_parsed_mail)
+    rescue Exception => e
+      Rockdove.logger.error "Exception occurred while receiving message:#{rockdove_parsed_mail}"
+      Rockdove.logger.error [e, *e.backtrace].join("\n")
+    end
+  end
+
+  ```
+  You need to change the Model into the one being used in your project that would require this behavior of Mail Processing for Exchange Web Services 1.0 and further process the mail as per the requirements in your project.
+
+  - And then you can run the script in console mode, `^C` will stop it, calling the stop method
+
+  ``` sh
+  $ ruby ./script/rockdove_server.rb start #from your project root
+  ```
+  - or run it daemonized, by default `./rockdove_server.log` and `./rockdove_server.pid` will be created
+
+  ``` sh
+  $ ruby ./script/rockdove_server.rb  -d start
+  ```
+
+  - you can stop the daemon, removing `./rockdove_server.pid` or
+  
+  ``` sh
+  $ ruby ./script/rockdove_server.rb stop
+  ```
+  ---
+
+## Compatibility
+
+  Tested on all Ruby versions (1.8.7, 1.9.2, 1.9.3) with Travis CI. 
+
+## Contributors
+
+ Welcome for any code optmizations or issue fixes or enhancements
+
+### Setup:
+
+  ```ruby
+    git clone git@github.com:kiranh/rockdove.git
+    cd rockdove
+    bundle exec rake # to run tests or bundle exec guard
+  ```
+
+## Acknowledgements
+
+  To [Biju Shoolapani](https://github.com/bijushoolapani) for support and encouragement. And the Code Reviewer, [Hemant Kumar](http://github.com/gnufied).
+
+## Copyright
+
+Copyright (c) 2012-2015 Kiran Soumya Bosetti. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/generators/rockdove/install_generator.rb

@@ -0,0 +1,12 @@
+module Rockdove
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../rockdove/script", __FILE__)
+      
+      desc "This generator copies the rockdove_server script file to your rails project"
+      def copy_script
+        copy_file "rockdove_server.rb", "script/rockdove_server.rb"
+      end
+    end
+  end
+end

data/lib/rockdove/collect_mail.rb

@@ -0,0 +1,120 @@
+module Rockdove
+  class CollectMail
+    UNDELIVERABLE = /Undeliverable/i
+    AUTO_REPLY = /Automatic reply/i
+    SPAM = /SPAM/i
+
+    class << self
+      attr_accessor :mail_stack, :inbox_connection
+    end
+
+    def initialize(mail_stack = nil, inbox = nil)
+      @mail_stack = mail_stack
+      @inbox_connection = inbox
+    end
+
+    def self.watch &block
+      loop do
+        begin
+          new().send_rockdove_to_watch_mail(&block)
+        rescue Exception => e
+          Rockdove.logger.error [e, *e.backtrace].join("\n")
+        ensure
+          sleep(Rockdove::Config.watch_interval)
+        end
+      end
+    end
+
+    def send_rockdove_to_watch_mail(&block)
+      Rockdove.logger.info "Rockdove on watch for new mail..."
+      parsed_mails = group_of_mails
+      if parsed_mails
+        Rockdove.logger.info "Rockdove calling App block"
+        block.call(parsed_mails)
+        process()
+      end
+    end
+
+    def group_of_mails
+      return no_mail_alert unless fetch_from_box
+      Rockdove.logger.info "Rockdove collected #{fetch_from_box.count} mail(s)."
+      letters = RockdoveCollection.new
+      @mail_stack.reverse.each do |item|
+        if bounce_type_mail?(item)
+          @mail_stack.delete(item)
+        else
+          letters << retrieve_mail(@inbox_connection.get_item(item.id))
+        end
+      end
+      letters
+    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!
+        true
+      else
+        false
+      end
+    end
+
+    def retrieve_mail(fetched_mail)
+      Rockdove::ExchangeMail.new(fetched_mail)
+    end
+
+    def no_mail_alert
+      Rockdove.logger.info "Rockdove observed no mail yet."
+      nil
+    end
+
+    def fetch_from_box
+      @inbox_connection = inbox
+      return nil if @inbox_connection.nil? || @inbox_connection == true
+      @mail_stack = @inbox_connection.find_items
+      return nil if @mail_stack.empty?
+      @mail_stack
+    end
+
+    def inbox
+      @incoming_folder = Rockdove::Config.incoming_folder
+      Viewpoint::EWS::Folder.get_folder_by_name(@incoming_folder)
+    rescue
+      reconnect_and_raise_error
+    end
+
+    def reconnect_and_raise_error
+      Rockdove.logger.info "Reconnecting to the Exchange Server & Fetching the mail now."
+      Rockdove::Config.connect
+      Viewpoint::EWS::Folder.get_folder_by_name(@incoming_folder)
+    rescue Viewpoint::EWS::EwsError
+      send_connection_failed_message
+    end
+
+    def send_connection_failed_message
+      Rockdove.logger.info "Rockdove unable to connect to the Exchange Server"
+      return nil
+    end
+
+    def process
+      @to_folder = Rockdove::Config.archive_folder
+      @mail_stack.each {|item| archive(item) }
+      @mail_stack = nil
+    end
+
+    def archive(item)
+      if @to_folder.blank?
+        item.delete!
+        Rockdove.logger.info "Rockdove delivered & deleted the mail."
+      else
+        item.move!(destination(@to_folder))
+        Rockdove.logger.info "Rockdove delivered & archived the mail."
+      end
+    end
+
+    def destination(to_folder)
+      Viewpoint::EWS::Folder.get_folder_by_name(to_folder)
+    end
+  end
+end

data/lib/rockdove/config.rb

@@ -0,0 +1,42 @@
+module Rockdove
+  class Config
+    class << self
+      attr_accessor :url, :username, :password, :incoming_folder, :archive_folder, :watch_interval
+    end
+
+    def self.configure(&block)
+      block.call(self)
+      connect
+    end
+
+    def self.ews_url(value)
+      @url = value
+    end
+
+    def self.ews_username(value)
+      @username = value
+    end
+
+    def self.ews_password(value)
+      @password = value
+    end
+
+    def self.ews_folder(value)
+      @incoming_folder = value || 'Inbox'
+    end
+
+    def self.ews_archive_folder(value)
+      @archive_folder = value
+    end
+
+    def self.ews_watch_interval(value)
+      @watch_interval = value || 60
+    end
+
+    def self.connect
+      Viewpoint::EWS::EWS.endpoint = @url
+      Viewpoint::EWS::EWS.set_auth @username, @password
+      Viewpoint::EWS::EWS.instance
+    end
+  end
+end

data/lib/rockdove/dovetie.rb

@@ -0,0 +1,18 @@
+require 'rockdove'
+require 'rails'
+require 'pathname'
+
+dir = Pathname.new File.expand_path(File.dirname(__FILE__))
+
+GENERATOR_PATH = dir + '../generators/rockdove' 
+
+module Rockdove
+  class Dovetie < Rails::Railtie
+    #initializer "dovetie.configure_rails_initialization" do |app|
+    #  app.middleware.use Dovetie::Middleware
+    #end
+    generators do
+      require "#{GENERATOR_PATH}/install_generator.rb"
+    end
+  end
+end

data/lib/rockdove/email_parser.rb

@@ -0,0 +1,46 @@
+module Rockdove
+  class EmailParser
+    HTML_REGEXP = /<\/?[^>]*>/
+    FWD_REGEXP = /^(On(.+)wrote:.+\z)$/nm
+    SIGNATURE_REGEXP = /^(Thanks(.+)Regards.+\z)$/inm
+    REPLY_REGEXP = /^(From:(.+)Sent:.+\z)$/nm
+    DASHES = "________________________________________"
+
+    def self.parse_mail(mail, body_type)
+      email_parser = new()
+      email_parser.parse_email_tags(mail,body_type)
+    end
+
+    def parse_email_tags(mail,body_type)
+      Rockdove.logger.info "Rockdove is parsing the mail content now..."
+      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)
+    end
+
+    def choose_and_parse(content)
+      content.gsub!(DASHES,"")      
+      case content     
+      when SIGNATURE_REGEXP 
+        content.gsub(SIGNATURE_REGEXP,"").strip! 
+      when REPLY_REGEXP
+        content.gsub(REPLY_REGEXP,"").strip!
+      when FWD_REGEXP
+        content.gsub(FWD_REGEXP,"").strip!
+      else
+        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

@@ -0,0 +1,52 @@
+module Rockdove
+
+  class RockdoveCollection < Array
+  end
+
+  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 initialize(mail_item)
+      @mail_item = mail_item
+    end
+
+    def to_recipients
+      @mail_item.to_recipients.collect &:email_address if @mail_item.to_recipients
+    end
+
+    def cc_recipients
+      @mail_item.cc_recipients.collect &:email_address if @mail_item.cc_recipients
+    end
+
+    def from
+      @mail_item.from.email_address if @mail_item.from
+    end
+
+    def subject
+      @mail_item.subject
+    end
+
+    def body
+      parse_it(@mail_item.body, @mail_item.body_type) unless @mail_item.body.empty?
+    end
+
+    def attachments
+      @mail_item.attachments
+    end
+
+    def date_time_created
+      @mail_item.date_time_created
+    end
+
+    def date_time_sent
+      @mail_item.date_time_sent
+    end
+
+    def parse_it(mail_body, type)
+      Rockdove::EmailParser.parse_mail(mail_body, type)
+    end   
+  end
+end

data/lib/rockdove/script/rockdove_server.rb

@@ -0,0 +1,46 @@
+# script/rockdove_server
+#!/usr/bin/env ruby
+
+# Run this file as ruby ./script/rockdove_server.rb start
+
+require File.dirname(__FILE__) + '/../config/environment'
+require "rubygems"
+require "rockdove"
+require "raad"
+
+class RockdoveServer
+  def initialize
+    Rockdove::Config.configure do |config| 
+      # (EDIT THIS CONTENT BELOW)
+      config.ews_url 'https://ewsdomain.com/ews/exchange.asmx'
+      config.ews_username 'ews_username'
+      config.ews_password 'ews_password'
+      config.ews_folder 'Inbox' # ews_folder is Inbox by default
+      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
+    end
+    #Raad.env = "production"
+  end
+
+  def start
+    Raad::Logger.debug("Rockdove Daemon started in #{Raad.env} env")    
+    process_rockdove_job    
+  end
+
+  def stop
+    Raad::Logger.debug("Rockdove Daemon stopped")
+  end
+
+  def process_rockdove_job
+    Rockdove::CollectMail.watch do |rockdove_parsed_mail|
+      begin
+        #Model.method(rockdove_parsed_mail) (EDIT THIS)
+      rescue Exception => e
+        Rockdove.logger.error "Exception occurred while receiving message:\n#{rockdove_parsed_mail}"
+        Rockdove.logger.error [e, *e.backtrace].join("\n")
+      end
+    end
+  end
+end
+

data/lib/rockdove/version.rb

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

data/lib/rockdove.rb

@@ -0,0 +1,24 @@
+require 'viewpoint'
+require 'email_reply_parser'
+require "rockdove/version"
+require "rockdove/config"
+require "rockdove/exchange_mail"
+require "rockdove/email_parser"
+require "rockdove/collect_mail"
+require "rockdove/dovetie" if defined?(Rails)
+
+module Rockdove
+
+  class << self
+    attr_accessor :logger
+  end
+
+  #
+  # Enabling the logger for Rockdove to track its where-abouts during the delivery process of the mail.
+  #
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+end

data/rockdove.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rockdove/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rockdove"
+  s.version     = Rockdove::VERSION
+  s.authors     = ["Kiran Soumya"]
+  s.email       = ["kiran.soumya@gmail.com"]
+  s.homepage    = "https://github.com/kiranh/rockdove"
+  s.summary     = %q{Incoming mail processing daemon for Exchange Web Services (EWS)}
+  s.description = %q{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.}
+
+  s.rubyforge_project = "rockdove"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rake", "~>0.9.2.2"
+  s.add_development_dependency "simplecov"
+  
+  s.add_runtime_dependency "raad" 
+  s.add_runtime_dependency "viewpoint", "= 0.1.26"
+  s.add_runtime_dependency "email_reply_parser"
+  s.add_runtime_dependency "logger" 
+end

data/spec/rockdove/collect_mail_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper.rb'
+
+describe "CollectParseArchive" do
+
+  before(:each) do
+    @connection = Rockdove::Config
+    @mail_retriever = Rockdove::CollectMail.new()
+    @test_server = Rockdove::EWS.new()
+    @log_stream = StringIO.new
+    Rockdove.stub!(:logger).and_return(Logger.new(@log_stream))
+  end
+
+  it "is trying to fetch a group of mails at one polling cycle" do
+    mails = []
+    mails << fetch_mail("new_mail") << fetch_mail("forwarded_mail") << fetch_mail("replied_mail")
+    handle_inbox(mails)
+    result = @mail_retriever.group_of_mails
+    result.should be_an_instance_of(Rockdove::RockdoveCollection)
+    result.count.should == 3
+    @log_stream.string.should include("Rockdove collected 3 mail(s)")
+  end
+
+  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))
+    @mail_retriever.group_of_mails.should be_an_instance_of(Rockdove::RockdoveCollection)
+    stub_destination_point 
+    lambda { @mail_retriever.process }.should_not raise_error
+    @log_stream.string.should =~ /Rockdove delivered & archived the mail/
+  end
+
+  it "should delete the mail at the end of collection cycle if user doesn't assign ews move folder" do
+    @connection.archive_folder = nil
+    mail = fetch_mail("new_mail") 
+    handle_inbox(Array(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/
+  end
+
+  it "should parse the signature of the mail" do
+    mail = fetch_mail("mail_type_text") 
+    parsed_content = Rockdove::EmailParser.parse_mail(mail.body, mail.body_type)
+    parsed_content.should == "This is a new post"
+  end 
+
+  it "should parse the forwarded mail of gmail" do
+    mail = fetch_mail("gmail_fwd_mail") 
+    parsed_content = Rockdove::EmailParser.parse_mail(mail.body, mail.body_type)
+    parsed_content.should == "I get proper rendering as well."
+  end 
+
+  it "should watch for new mail when called" do
+    mail = fetch_mail("new_mail") 
+    handle_inbox(Array(mail))
+    output = @mail_retriever.send_rockdove_to_watch_mail do |mail|
+     true
+    end
+    @log_stream.string.should include("Rockdove calling App block")
+    @log_stream.string.should include("Rockdove collected 1 mail(s)")
+  end
+
+  it "should handle undeliverable bounce type" do
+    mail = fetch_mail("auto_reply_mail")
+    handle_inbox(Array(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")
+  end
+
+  it "should handle auto reply bounce type" do
+    mail = fetch_mail("undeliverable_mail")
+    handle_inbox(Array(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")
+  end
+
+  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)
+    @mail_retriever.retrieve_mail(mail_array.first).should be_an_instance_of(Rockdove::ExchangeMail)
+  end
+
+  def stub_destination_point
+    @mail_retriever.should_receive(:destination).and_return(@connection.archive_folder)
+  end
+end
+
+describe "RockdoveLogs" do
+  it "should log" do
+    Rockdove.logger.should be_an_instance_of(Logger)
+  end
+end