kns_email_endpoint 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kns_email_endpoint.gemspec
+gemspec
+
+
+group :development do
+
+  gem "rspec", ">= 2.0.0"
+  gem "guard-rspec"
+  gem "growl"
+  gem "rb-fsevent"
+  gem "awesome_print"
+
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    kns_email_endpoint (0.1.0)
+      dalli (~> 1.0.0)
+      kns_endpoint (>= 0.1.9)
+      mail (>= 2.2.6.1)
+      work_queue (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    awesome_print (0.3.1)
+    configuration (1.2.0)
+    dalli (1.0.1)
+    diff-lcs (1.1.2)
+    growl (1.0.3)
+    guard (0.2.2)
+      open_gem (~> 1.4.2)
+      thor (~> 0.14.3)
+    guard-rspec (0.1.9)
+      guard (>= 0.2.2)
+    i18n (0.5.0)
+    json (1.4.6)
+    kns_endpoint (0.1.9)
+      json (~> 1.4.0)
+      rest-client (>= 1.6.1)
+    launchy (0.3.7)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    open_gem (1.4.2)
+      launchy (~> 0.3.5)
+    polyglot (0.3.1)
+    rake (0.8.7)
+    rb-fsevent (0.3.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    work_queue (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  dalli (~> 1.0.0)
+  growl
+  guard-rspec
+  kns_email_endpoint!
+  kns_endpoint (>= 0.1.9)
+  mail (>= 2.2.6.1)
+  rb-fsevent
+  rspec (>= 2.0.0)
+  work_queue (~> 1.0.0)

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at http://github.com/guard/guard#readme
+#
+
+guard 'rspec' do
+  watch('^spec/(.*)_spec.rb')
+  watch('^lib/(.*)\.rb') { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('^lib/kns_email_endpoint/(.*)\.rb') { |m| "spec/kns_email_endpoint/lib/#{m[1]}_spec.rb" }
+end
+

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Kynetx Inc.
+
+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 @@
+Coming Soon!

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/kns_email_endpoint.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kns_email_endpoint/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kns_email_endpoint"
+  s.version     = KnsEmailEndpoint::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Farmer"]
+  s.email       = ["mjf@kynetx.com"]
+  s.homepage    = "http://code.kynetx.com"
+  s.summary     = %q{The Kynetx Email Endpoint is a ruby gem that makes setting up an email endpoint very simple.}
+  s.description = %q{The Kynetx Email Endpoint is a ruby gem that makes setting up an email endpoint very simple.}
+
+  s.rubyforge_project = "kns_email_endpoint"
+
+  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"]
+
+  s.add_dependency "kns_endpoint", ">= 0.1.9"
+  s.add_dependency "mail", ">= 2.2.6.1"
+  s.add_dependency "dalli", "~> 1.0.0"
+  s.add_dependency "work_queue", "~> 1.0.0"
+
+  #activesupport (3.0.0)
+	#daemons (1.1.0)
+	#fastthread (1.0.7)
+	#i18n (0.4.1)
+	#json (1.4.6)
+	#mail (2.2.6.1)
+	#mime-types (1.16)
+	#polyglot (0.3.1)
+	#sqlite3-ruby (1.3.1)
+	#tlsmail (0.0.1)
+	#treetop (1.4.8)
+	#work_queue (1.0.0)
+end

data/lib/kns_email_endpoint/configuration.rb

@@ -0,0 +1,87 @@
+require 'yaml'
+require 'logger'
+require 'fileutils'
+
+module KNSEmailEndpoint
+
+
+  class Configuration
+    cattr_writer :logdir, :work_threads, :poll_delay, :connections
+    cattr_reader :storage_engine
+
+    class << self
+
+      def load_from_file(yaml_file)
+        conf = YAML.load_file(yaml_file)
+        @@logdir = conf["logdir"] if conf["logdir"]
+        @@work_threads = conf["workthreads"] if conf["workthreads"]
+        @@poll_delay = conf["polldelayinseconds"] if conf["polldelayinseconds"]
+        @@log_level = conf["logginglevel"] if conf["logginglevel"]
+        @@connections = conf["connections"] if conf["connections"]
+        self.storage = conf["storage"] || {}
+      end
+
+      def to_h
+        {
+          :logdir => logdir,
+          :work_threads => work_threads,
+          :poll_delay => poll_delay,
+          :storage => storage,
+          :connections => connections
+        }
+      end
+
+      def log
+        return @@logger if defined?(@@logger) && ! @logger.nil?
+        if @@logdir && ! @@logdir.empty?
+          FileUtils.mkdir_p @@logdir unless @@logdir == "" || @@logdir.nil?
+          log_dest = File.join(@@logdir, 'email_endpoint.log')
+        else
+          log_dest = STDOUT
+        end
+        @@logger = Logger.new(log_dest, "daily")
+        @@logger.level = eval("Logger::#{@@log_level.upcase}") rescue Logger::DEBUG
+        return @@logger
+      end
+
+      def log_level=(l)
+        @@log_level = l
+        @@log = nil
+        return @@log_level
+      end
+
+      def storage=(opts)
+        @@storage = opts
+        engine = opts.delete("engine")
+        @@storage_engine = MessageState.set_storage(engine, opts)
+        return @@storage
+      end
+
+      # defaults
+      def work_threads; @@work_threads ||= 10 end
+      def poll_delay; @@poll_delay ||= 30 end
+      def logdir; @@logdir ||= "" end
+      def connections; @@connections ||= [] end
+      def storage; @@storage ||= {} end
+
+      # Connection Handling
+
+      def [](name)
+        @@connections.each do |conn| 
+          return conn if conn["name"] == name
+        end
+        raise "Invalid connection (#{name})" 
+      end
+
+      def each_connection
+        @@connections.each do |conn|
+          yield Connection.new conn["name"]
+        end
+      end
+
+
+    end
+  end
+
+end
+

data/lib/kns_email_endpoint/connection.rb

@@ -0,0 +1,97 @@
+require 'net/smtp'
+require 'mail'
+
+module KNSEmailEndpoint
+  class ConnectionException < StandardError  
+  end  
+
+
+  module ConnectionFactory
+    attr_reader :conn_log, :retriever, :sender, :name, :process_mode, :event_args, :appid, :environment, :max_retry_count
+
+    def setup_mail_connections(name)
+      @config = Configuration
+      @conn_config = @config[name]
+      
+      if @config.logdir.empty?
+        log_dest = STDOUT
+      else
+        log_dest = "#{@config.logdir}/#{@conn_config['logfile']}"
+      end
+      @config.log.info "Initializing connection log to: #{log_dest}"
+      @conn_log = Logger.new(log_dest, "daily")
+      @conn_log.level = @config.log.level
+      @name = @conn_config["name"]
+      @process_mode = @conn_config["processmode"].to_sym
+      @max_retry_count = @conn_config["max_retry_count"] || 10
+      @event_args = @conn_config["args"] || {}
+      @appid = @conn_config["appid"]
+      if @conn_config["appversion"] && 
+        (@conn_config["appversion"] == "dev" || @conn_config["appversion"] == "development")
+        @environment = :development
+      else
+        @environment = :production
+      end
+
+
+      @in_method = @conn_config["incoming"]["method"]
+      @out_method = @conn_config["smtp"]["method"]
+
+      @retriever_settings = {
+        :address => @conn_config["incoming"]["host"],
+        :user_name => @conn_config["incoming"]["username"],
+        :password => @conn_config["incoming"]["password"],
+        :enable_ssl => @conn_config["incoming"]["ssl"],
+        :port => @conn_config["incoming"]["port"],
+        :authentication => @conn_config["incoming"]["authentication"] || nil
+      }
+
+      @mailbox = @conn_config["incoming"]["mailbox"]
+      @retriever = lookup_retriever
+
+      @sender_settings = {
+        :address => @conn_config["smtp"]["host"],
+        :user_name => @conn_config["smtp"]["username"],
+        :password => @conn_config["smtp"]["password"],
+        :port => @conn_config["smtp"]["port"],
+        :domain => @conn_config["smtp"]["helo_domain"],
+        :enable_starttls_auto => @conn_config["smtp"]["tls"]
+      }
+      if @conn_config["smtp"]["authentication"]
+        @sender_settings[:authentication] = @conn_config["smtp"]["authentication"].downcase
+      end
+      
+      @sender = lookup_sender
+    end
+
+
+    private
+
+    def lookup_retriever
+      case @in_method 
+        when "imap" then return Mail::IMAP.new(@retriever_settings)
+        when "pop3" then return Mail::POP3.new(@retriever_settings)
+        when "test" then return Mail::TestRetriever.new(@retriever_settings)
+        else return Mail::IMAP.new(@retriever_settings)
+      end   
+    end
+
+    def lookup_sender
+      case @out_method
+      when "smtp" then return Mail::SMTP.new(@sender_settings)
+      when "test" then return Mail::TestMailer.new(@sender_settings)
+      else return Mail::SMTP.new(@sender_settings) 
+      end
+    end
+
+  end
+
+  class Connection
+    include ConnectionFactory
+    def initialize(name)
+      setup_mail_connections name
+      conn_log.info "Setup Connection for '#{name}'"
+    end
+  end
+end
+

data/lib/kns_email_endpoint/core_extensions/class.rb

@@ -0,0 +1,44 @@
+# Mail::TestRetriever uses cattr_accessor from rails. Since I don't want to include rails as a dependency
+# I'm just adding the Rails code here. 
+# (Note, this is older Rails code slightly modified, but it should still work for what I need it for)
+class Class
+  def cattr_accessor(*syms, &blk)
+    cattr_reader(*syms)
+    cattr_writer(*syms, &blk)
+  end
+
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+      EOS
+
+                  
+    end
+  end
+
+  def cattr_writer(*syms)
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+
+      self.send("#{sym}=", yield) if block_given?
+
+    end
+  end
+
+end

data/lib/kns_email_endpoint/core_extensions/hash.rb

@@ -0,0 +1,14 @@
+class Hash
+
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+    options
+    end
+  end
+
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+  
+end

data/lib/kns_email_endpoint/core_extensions/imap.rb

@@ -0,0 +1,36 @@
+# Adding methods to imap for easier access to things we do commonly
+require 'mail'
+
+module Mail
+
+  class IMAP
+
+    # add a delete message
+    # so that we can delete without calling find again
+
+    def delete_messages(mailbox, messages)
+      mailbox = Net::IMAP.encode_utf7(mailbox)
+      messages.each do |message_hash|
+        imap = message_hash[:connection]
+        message_id = message_hash[:message_id]
+        message = message_hash[:message]
+        imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED]) if message.is_marked_for_delete?
+      end
+      start do |imap|
+        begin
+          imap.select(mailbox)
+          imap.expunge
+        rescue => e
+          puts e.message
+          puts e.backtrace.join("\n")
+          raise e
+        end
+      end
+      
+    end
+
+        
+
+  end
+
+end

data/lib/kns_email_endpoint/core_extensions/message.rb

@@ -0,0 +1,26 @@
+module Mail
+  class Message
+    def to_h
+      {
+        :to => to,
+        :from => from,
+        :subject => subject,
+        :body => body.raw_source
+      }
+      
+    end
+
+    def delivered_to
+      # Messages can be sent to multiple people AND if it was forwarded will have multiple
+      # Delivered-To headers. What this bit of code does is take the
+      # intersection of the "to" recipients and the "Delivered-To" recipients to find
+      # out who the message was actually delivered to. There will almost never
+      # be more than one recipient in that intersection, but if there is, we'll just 
+      # return the first.
+      delivered_to_headers = []
+      self.header_fields.each { |f| delivered_to_headers << f.value if f.name == "Delivered-To"} 
+      actual_to = self.to.to_set.intersection delivered_to_headers
+      return actual_to.first
+    end
+  end
+end

data/lib/kns_email_endpoint/core_extensions/test_retriever.rb

@@ -0,0 +1,42 @@
+# Mail::TestRetriever additional methods
+require 'mail'
+module Mail
+  class TestRetriever
+    def delete_all
+      @@emails = []
+    end
+
+    remove_method :find
+
+    # Fix a bug in the find method when only returning a single email
+    def find(options = {}, &block)
+      options[:count] ||= :all
+      options[:order] ||= :asc
+      options[:what] ||= :first
+      emails = @@emails.dup
+      emails.reverse! if options[:what] == :last
+      emails = case count = options[:count]
+               when :all then emails
+               # when 1 then emails.first
+               when Fixnum then emails[0, count]
+               else
+                 raise 'Invalid count option value: ' + count.inspect
+               end
+      if options[:what] == :last && options[:order] == :asc || options[:what] == :first && options[:order] == :desc
+        emails.reverse!
+      end
+      emails.each { |email| email.mark_for_delete = true } if options[:delete_after_find]
+
+      if block_given?
+        emails.each { |email| yield email }
+      else
+        emails
+      end.tap do |results|
+        emails.each { |email| @@emails.delete(email) if email.is_marked_for_delete? } if options[:delete_after_find]
+      end
+      return emails.size == 1 && options[:count] == 1 ? emails.first : emails
+    end
+    
+  end
+end
+

data/lib/kns_email_endpoint/email_endpoint.rb

@@ -0,0 +1,88 @@
+require 'mail'
+
+module KNSEmailEndpoint
+
+  class EmailEndpoint < Kynetx::Endpoint
+    attr_reader :conn, :message_state
+
+    domain :mail
+    event :received do |p|
+      raise "Missing 'msg' parameter'." unless p[:msg]
+      message = p[:msg]
+      p[:to] = message.to.join(",")
+      p[:from] = message.from.join(",")
+      p[:subject] = message.subject
+
+      p[:unique_id] = message.message_id unless p[:unique_id]
+
+      if p[:extract_label]
+        label = message.delivered_to.match(/\+(.*)@/)[1]
+        p[:label] = label.to_s
+      end
+
+    end
+
+    def before_received
+      @message_state = MessageState.new(@conn, params[:msg])
+      @message_state.state = :processing
+    end
+
+    directive :delete 
+    def after_delete(d)
+      @message_state.delete
+    end
+
+    directive :reply
+    def after_reply(d)
+      msg = params[:msg]
+      r_msg = Mail.new(msg)
+      r_msg.to = msg.from
+      r_msg.from = msg.reply_to.nil? ? msg.to : msg.reply_to
+      r_msg.subject = d["subject"] ? d["subject"] : "Re: " + msg.subject.to_s
+      r_msg.body d["body"] ? d["body"] + msg[:body].to_s : msg.body.to_s
+      @sender.deliver!(r_msg) if @sender
+      @message_state.state = :replied
+
+      if d["delete_message"]
+        @message_state.delete
+      end
+    end
+
+    directive :forward
+    def after_forward(d)
+      if d["to"] && @sender
+        msg = params[:msg]
+        f_msg = Mail.new do
+          to d["to"]
+          from msg.to
+          subject d["subject"] ? d["subject"] : "Fwd: " + msg.subject.to_s
+          body d["body"] ? d["body"] + msg[:body].to_s : msg.body.to_s
+        end
+        @sender.deliver!(f_msg)
+        @message_state.state = :forwarded
+      else
+        @message_state.state = :error
+      end
+
+      if d["delete_message"] && status == :forwarded
+        @message_state.delete
+      end
+    end
+
+    directive :processed
+    def after_processed(d)
+      @message_state.state = :processed
+    end
+
+    def initialize(conn, opts={}, sender=nil)
+      @conn = conn
+      @sender = sender
+      super(opts)
+    end
+
+    def status
+      @message_state.state
+    end
+
+  end
+end