action_mailer-logged_smtp_delivery 1.0.1

data/README.md

@@ -0,0 +1,33 @@
+### Logged SMTP Delivery
+
+A few features:
+  1. Detailed log stream with message id prefix. Example:
+   ```
+   <4e2b38d772949_b81ac212@localhost> stored at example/log/mails/outbound/2011-07-23/7_13462_2.eml
+   <4e2b38d772949_b81ac212@localhost> X-Delivery-Context: [users/1/welcome]
+   <4e2b38d772949_b81ac212@localhost> sender: support@support.localhost
+   <4e2b38d772949_b81ac212@localhost> destinations: support@system.example.com
+   <4e2b38d772949_b81ac212@localhost> done #<Net::SMTP::Response:0x10bbee680 @string="250 2.0.0 Ok: queued as 87BF716D7901\n", @status="250">
+   ```
+
+  2. Logs an identification header to quickly locate logs for a specific email/entity
+    ```ruby
+    config.action_mailer.smtp_settings[:log_header] = 'X-Delivery-Context'
+
+    class UsersMailer < ActionMailer::Base
+      
+      def welcome(user)
+        headers['X-Delivery-Context'] = "users/#{user.id}/welcome"
+        
+        # ...
+      end
+    end
+    
+
+    UsersMailer.deliver_welcome(user)
+    # ActionMailer::Base.logger -> 
+    # <4e2b38d772949_b81ac212@localhost> X-Delivery-Context: [users/1/welcome]
+    ```
+  
+  3. Doesn't render BCC recipients
+

data/lib/action_mailer/logged_smtp_delivery.rb

@@ -0,0 +1,111 @@
+require 'actionmailer'
+require 'active_support/core_ext/class/attribute'
+require 'net/smtp'
+
+#TODO: Add mail file logger
+
+# A few features:
+# Hides BCC recipients
+# Detailed log stream with message id token
+# Logs an identification header to quickly locate logs for a specific email
+# Can optionally log the raw email
+# TLS support
+module ActionMailer::LoggedSMTPDelivery
+  class DeliveryFailure < StandardError
+
+    delegate :message, :backtrace, :to_s, :to => :original_exception
+
+    attr_reader :original_exception, :destinations
+
+    def initialize(original_exception, destinations)
+      @original_exception = original_exception
+      @destinations       = destinations
+    end
+
+  end
+
+  def self.included(base)
+    base.class_attribute :mail_file_logger
+  end
+
+  def perform_delivery_logged_smtp(mail)
+    delivery        = SMTPDelivery.new(mail, smtp_settings)
+    delivery.logger = logger
+
+    if mail_file_logger
+      path = mail_file_logger.log(mail.encoded)
+      delivery.log "stored at #{path}"
+    end
+
+    delivery.perform
+  end
+
+  class SMTPDelivery
+
+    attr_reader   :mail, :settings
+    attr_accessor :logger
+
+    def initialize(mail, settings)
+      @mail         = mail
+      @settings     = settings
+    end
+
+    def perform
+      log_headers
+      log "sender: #{sender}"
+      log "destinations: #{destinations.inspect}"
+
+      smtp.start(*settings.values_at(:domain, :user_name, :password, :authentication)) do |session|
+        response = session.send_message(message, sender, destinations)
+        log "done #{response.inspect}"
+      end
+    rescue Exception => e
+      log "failed #{e.message}"
+      raise DeliveryFailure.new(e, destinations)
+    end
+
+    def destinations
+      mail.destinations
+    end
+
+    def message
+      original_bcc = mail.bcc
+      mail.bcc     = nil
+      mail.encoded
+    ensure
+      mail.bcc = original_bcc
+    end
+
+    def sender
+      mail.from.first
+    end
+
+    def log_header
+      settings[:log_header]
+    end
+
+    def smtp
+      smtp_adaptor.new(settings[:address], settings[:port]).tap do |smtp|
+        smtp.enable_starttls_auto if enable_tls?
+      end
+    end
+
+    def log_headers
+      log "#{log_header}: [#{mail[log_header]}]" unless log_header.nil?
+    end
+
+    def log(message)
+      logger.info("#{mail.message_id} #{message}")
+    end
+
+    def enable_tls?
+      settings[:tls] != false
+    end
+
+    def smtp_adaptor
+      settings[:adaptor] || Net::SMTP
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,57 @@
+require 'bundler/setup'
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib'))) # lib
+require 'minitest/autorun'
+
+class MemoryLogger
+
+  def log(message)
+    messages << message
+  end
+
+  def messages
+    @messages ||= []
+  end
+
+  def clear
+    messages.clear
+  end
+
+end
+
+class FakeSMTP
+
+  attr_reader :address, :port, :credentials
+
+  def self.deliveries
+    @deliveries ||= []
+  end
+
+  def initialize(address, port)
+    @address = address
+    @port    = port
+  end
+
+  def start(*credentials)
+    @credentials = credentials
+    @started     = true
+
+    yield(self)
+  end
+
+  def send_message(message, from, recipients)
+    self.class.deliveries << [ message, from, recipients ]
+  end
+
+  def enable_starttls_auto
+    @starttls = :auto
+  end
+
+  def starttls_auto?
+    @starttls == :auto
+  end
+
+  def inspect
+    "#<#{self.class} #{@address}:#{@port} started=#{@started}>"
+  end
+
+end

data/test/logged_smtp_delivery_test.rb

@@ -0,0 +1,171 @@
+require_relative 'helper'
+require 'action_mailer/logged_smtp_delivery'
+require 'logger'
+
+class LoggedSMTPDeliveryTest < MiniTest::Unit::TestCase
+
+  class TestMailer < ActionMailer::Base
+    include ActionMailer::LoggedSMTPDelivery
+
+    self.mail_file_logger = MemoryLogger.new
+    self.logger           = Logger.new(StringIO.new)
+    self.delivery_method  = :logged_smtp
+    self.smtp_settings    = { :adaptor => FakeSMTP }
+
+    def welcome
+      recipients 'to@example.com'
+      from       'me@example.com'
+      body       'hello'
+
+      # Keep the message simple and consistent between test runs
+      headers['mime-version'] = ''
+      charset nil
+      headers['date'] = ''
+    end
+
+  end
+
+  describe 'delivering via actionmailer' do
+    before do
+      TestMailer.mail_file_logger.clear
+      FakeSMTP.deliveries.clear
+    end
+
+    it 'logs the mail to a file when the mail file logger is available' do
+      TestMailer.deliver_welcome
+      assert_equal "From: me@example.com\r\nTo: to@example.com\r\nContent-Type: text/plain\r\n\r\nhello", TestMailer.mail_file_logger.messages.last
+      TestMailer.mail_file_logger.messages.clear
+
+      original_logger = TestMailer.mail_file_logger
+      TestMailer.mail_file_logger = nil
+      assert TestMailer.deliver_welcome
+      TestMailer.mail_file_logger = original_logger
+    end
+
+    it 'delivers the mail' do
+      TestMailer.deliver_welcome
+      delivery = ["From: me@example.com\r\nTo: to@example.com\r\nContent-Type: text/plain\r\n\r\nhello", "me@example.com", ["to@example.com"]]
+
+      assert_equal delivery, FakeSMTP.deliveries.last
+    end
+
+  end
+
+  describe 'SMTP Delivery' do
+    before do
+      @settings = { :adaptor => FakeSMTP }
+      @mail     = TMail::Mail.new.tap do |mail|
+        mail.message_id = '<12345@example.com>'
+      end
+      @delivery = ActionMailer::LoggedSMTPDelivery::SMTPDelivery.new(@mail, @settings)
+      @log      = StringIO.new
+      @delivery.logger = Logger.new(@log)
+      @delivery.logger.formatter = lambda { |severity, datetime, progname, msg| msg }
+    end
+
+    it 'has the sender via the first from address' do
+      @mail.from = [ 'a@example.com', 'b@example.com' ]
+      assert_equal 'a@example.com', @delivery.sender
+    end
+
+    it 'has a list of destination addresses' do
+      @mail.to  = 'to@example.com'
+      @mail.cc  = 'cc@example.com'
+      @mail.bcc = 'bcc@example.com'
+
+      assert_equal [ 'to@example.com', 'cc@example.com','bcc@example.com' ], @delivery.destinations
+    end
+
+    it 'has an smtp connection' do
+      @delivery.settings[:address] = 'example.com'
+      @delivery.settings[:port]    = 26
+
+      smtp = @delivery.smtp
+      assert_equal 26,            smtp.port
+      assert_equal 'example.com', smtp.address
+      assert_equal true,          smtp.starttls_auto?
+
+      @delivery.settings[:tls]    = false
+      assert_equal false,         @delivery.smtp.starttls_auto?
+    end
+
+    it 'logs with the mail message id' do
+      @delivery.log 'hello'
+
+      assert_equal '<12345@example.com> hello', @log.string
+    end
+
+    it 'logs headers when the log header is provided' do
+      @delivery.log_headers
+      assert_equal '', @log.string
+
+      @delivery.settings[:log_header] = 'X-Delivery-Context'
+      @delivery.mail['X-Delivery-Context'] = 'hello-33'
+      @delivery.log_headers
+
+      assert_equal '<12345@example.com> X-Delivery-Context: [hello-33]', @log.string
+    end
+
+    it 'sends the mail' do
+      @mail.from = 'me@example.com'
+      @mail.to   = 'to@example.com'
+      @mail.cc   = 'cc@example.com'
+      @mail.bcc  = 'bcc@example.com'
+      @mail.body = 'hello'
+      message = [
+        "From: me@example.com\r\nTo: to@example.com\r\nCc: cc@example.com\r\nMessage-Id: <12345@example.com>\r\n\r\nhello",
+        "me@example.com",
+        ["to@example.com", "cc@example.com", "bcc@example.com"]
+      ]
+      @delivery.perform
+
+      assert_equal message, FakeSMTP.deliveries.last
+    end
+
+    it 'does not include BCC addresses in the message' do
+      @mail.bcc = 'bcc@example.com'
+      assert_equal false, @delivery.message.include?('bcc@example.com')
+    end
+
+    describe "failure" do
+      before do
+        @delivery.settings[:adaptor] = Class.new do
+          def initialize(*args)
+            raise StandardError.new("Invalid address")
+          end
+        end
+
+        begin
+          @mail.from = 'me@example.com'
+          @mail.to   = 'to@example.com'
+          @mail.cc   = 'cc@example.com'
+          @delivery.perform
+          assert false, "Delivery didn't raise an exception"
+        rescue StandardError => e
+          @failure = e
+        end
+      end
+
+      it "provides the original exception" do
+        original_exception = @failure.original_exception
+        assert_equal StandardError,     original_exception.class
+        assert_equal "Invalid address", original_exception.message
+      end
+
+      it "provides the destinations that it failed delivery to" do
+        assert_equal [ 'to@example.com', 'cc@example.com' ], @failure.destinations
+      end
+
+      it "acts displays the original exception" do
+        original_exception = @failure.original_exception
+
+        assert_equal original_exception.backtrace, @failure.backtrace
+        assert_equal original_exception.message,   @failure.message
+        assert_equal original_exception.to_s,      @failure.to_s
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: action_mailer-logged_smtp_delivery
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Chapweske
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.16
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActionMailer SMTP delivery strategy with advanced logging and Bcc support
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/action_mailer/logged_smtp_delivery.rb
+- test/helper.rb
+- test/logged_smtp_delivery_test.rb
+- README.md
+homepage: https://github.com/eac/action_mailer-logged_smtp_delivery
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: An ActionMailer delivery strategy
+test_files:
+- test/helper.rb
+- test/logged_smtp_delivery_test.rb