zendesk-ar_mailer 1.4.5 → 1.4.6

data/README.txt

@@ -1,6 +1,12 @@
 = ar_mailer
 
-A two-phase delivery agent for ActionMailer
+A two-phase delivery agent for ActionMailer. 
+
+This fork allows you to add some context to the ar_mailer log, i.e. you can track "lost emails" such that when a customer complains of a missing email, you are able to find out what "identifier" in your system became what SMTP message-id, and continue tracking to the SMTP server logs.
+
+This fork also logs in its own log file rather than using the Rails logger.
+
+This fork is based on the fork by adzap (http://github.com/adzap/ar_mailer/tree/master) and includes the connectivity patches from gefilte (http://github.com/gefilte/ar_mailer/tree/master)
 
 Rubyforge Project:
 
@@ -34,7 +40,7 @@ First, if you haven't already
 
 Then
 
-  $ sudo gem install adzap-ar_mailer
+  $ sudo gem install zendesk-ar_mailer
 
 See ActionMailer::ARMailer for instructions on converting to ARMailer.
 
@@ -43,7 +49,7 @@ See ar_sendmail -h for options to ar_sendmail.
 NOTE: You may need to delete an smtp_tls.rb file if you have one lying
 around.  ar_mailer supplies it own.
 
-=== Getting context aware logging
+=== Getting context aware logging (this fork)
 
 If you want to log some extra information that you can use to tie a specific send email to
 something in your application, do this:
@@ -54,9 +60,11 @@ something in your application, do this:
   
 2. Set the information you want ar_sendmail to log alongside the message-id in your mailer class:
 
-  headers(ActionMailer::ARMailer.context_header => 'Hello there')
+  headers('X-Delivery-Context' => 'Hello there')
 
-This will print 'Hello there' in the line that also contains the message-id of the sent email.
+This will print 'Hello there' in the line that also contains the message-id of the sent email, like so:
+
+ar_sendmail Fri Oct 17 12:04:58 +0000 2008: sent email 00000579421 [Hello there] from someone@somewhere.com to someone.else@somewhere.else.com: "250 OK id=1Kqo4g-0006Nx-MP\n"
 
 === init.d/rc.d scripts
 
@@ -68,3 +76,5 @@ the config file /etc/ar_sendmail.conf in place before starting.
 
 For FreeBSD or NetBSD script is share/bsd/ar_sendmail. This is old and does not
 support the config file unless someone wants to submit a patch.
+
+Alternatively, use a monitoring solution like monit or god, or google: cron @reboot

data/Rakefile

@@ -18,7 +18,7 @@ ar_mailer_gemspec = Gem::Specification.new do |s|
   s.email = %q{drbrain@segment7.net}
   s.executables = ["ar_sendmail"]
   s.extra_rdoc_files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/ar_sendmail", "lib/action_mailer/ar_mailer.rb", "lib/action_mailer/ar_sendmail.rb", "lib/smtp_tls.rb", "share/bsd/ar_sendmail", "share/linux/ar_sendmail", "share/linux/ar_sendmail.conf", "test/action_mailer.rb", "test/test_armailer.rb", "test/test_arsendmail.rb"]
+  s.files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/ar_sendmail", "lib/action_mailer/ar_mailer.rb", "lib/action_mailer/ar_sendmail.rb", "lib/ar_sendmail_logger.rb", "lib/smtp_tls.rb", "share/bsd/ar_sendmail", "share/linux/ar_sendmail", "share/linux/ar_sendmail.conf", "test/action_mailer.rb", "test/test_armailer.rb", "test/test_arsendmail.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://seattlerb.org/ar_mailer}
   s.rdoc_options = ["--main", "README.txt"]

data/lib/action_mailer/ar_mailer.rb

@@ -96,10 +96,10 @@ class ActionMailer::ARMailer < ActionMailer::Base
   def perform_delivery_activerecord(mail)
     mail.destinations.each do |destination|
       # If the email has the context header set, assume that the caller added a context column
-      if @@context_header && mail.key?(@@context_header) && !mail[@@context_header].body.strip.blank?
+      if @@context_header && mail.header_string(@@context_header)
         @@email_class.create(
           :mail => mail.encoded, :to => destination, 
-          :from => mail.from.first, :context => mail[@@context_header].body.strip
+          :from => mail.from.first, :context => mail.header_string(@@context_header)
         )
       else
         @@email_class.create(:mail => mail.encoded, :to => destination, :from => mail.from.first)

data/lib/action_mailer/ar_sendmail.rb

@@ -1,6 +1,7 @@
 require 'optparse'
 require 'net/smtp'
 require 'smtp_tls'
+require 'ar_sendmail_logger'
 require 'rubygems'
 
 class Object # :nodoc:
@@ -54,7 +55,7 @@ class ActionMailer::ARSendmail
   ##
   # The version of ActionMailer::ARSendmail you are running.
 
-  VERSION = '1.4.4'
+  VERSION = '1.4.6'
 
   ##
   # Maximum number of times authentication will be consecutively retried
@@ -85,6 +86,8 @@ class ActionMailer::ARSendmail
   # ActiveRecord class that holds emails
 
   attr_reader :email_class
+  
+  attr_reader :logger
 
   ##
   # True if only one delivery attempt will be made per call to run
@@ -201,6 +204,7 @@ end
     options[:RailsEnv] = ENV['RAILS_ENV']
     options[:TableName] = 'Email'
     options[:Pidfile] = options[:Chdir] + '/log/ar_sendmail.pid'
+    options[:LogFile] = nil
 
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: #{name} [options]"
@@ -253,6 +257,12 @@ end
         options[:Pidfile] = pidfile
       end
 
+      opts.on("-l", "--logfile LOGFILE",
+              "Set the logfile location",
+              "Default: #{options[:Chdir]}#{options[:LogFile]}", String) do |logfile|
+        options[:LogFile] = logfile
+      end          
+
       opts.on(      "--mailq",
               "Display a list of emails waiting to be sent") do |mailq|
         options[:MailQ] = true
@@ -417,6 +427,7 @@ end
     @max_age = options[:MaxAge]
 
     @failed_auth_count = 0
+    @logger = ArSendmailLogger.new(options[:LogFile] || options[:Chdir] + '/log/ar_sendmail.log')
   end
 
   ##
@@ -449,7 +460,7 @@ end
         begin
           res = smtp.send_message email.mail, email.from, email.to
           email.destroy
-          if email.respond_to?(:context)
+          if email.respond_to?(:context) && email.context.to_s != ''
             log "sent email %011d [%s] from %s to %s: %p" % [email.id, email.context, email.from, email.to, res]
           else
             log "sent email %011d from %s to %s: %p" % [email.id, email.from, email.to, res]
@@ -519,8 +530,9 @@ end
   # Logs +message+ if verbose
 
   def log(message)
+    message = "ar_sendmail #{Time.now}: #{message}"
     $stderr.puts message if @verbose
-    ActionMailer::Base.logger.info "ar_sendmail #{Time.now}: #{message}"
+    logger.info(message)
   end
 
   ##

data/lib/ar_sendmail_logger.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+class ArSendmailLogger < ::Logger
+
+  def format_message(severity, timestamp, progname, message)
+    "#{message}\n"
+  end
+
+end

data/test/action_mailer.rb

@@ -105,7 +105,7 @@ class Email
 
   START = Time.parse 'Thu Aug 10 2006 11:19:48'
 
-  attr_accessor :from, :to, :mail, :last_send_attempt, :created_on, :id
+  attr_accessor :from, :to, :mail, :last_send_attempt, :created_on, :id, :context
 
   @records = []
   @id = 0
@@ -114,7 +114,7 @@ class Email
 
   def self.create(record)
     record = new record[:from], record[:to], record[:mail],
-                 record[:last_send_attempt]
+                 record[:last_send_attempt], record[:context]
     records << record
     return record
   end
@@ -147,13 +147,14 @@ class Email
     records.clear
   end
 
-  def initialize(from, to, mail, last_send_attempt = nil)
+  def initialize(from, to, mail, last_send_attempt = nil, context = nil)
     @from = from
     @to = to
     @mail = mail
     @id = self.class.id += 1
     @created_on = START + @id
     @last_send_attempt = last_send_attempt || 0
+    @context = context
   end
 
   def destroy

data/test/test_armailer.rb

@@ -12,7 +12,9 @@ class Mailer < ActionMailer::ARMailer
     def @mail.encoded() 'email' end
     def @mail.from() ['nobody@example.com'] end
     def @mail.destinations() %w[user1@example.com user2@example.com] end
-    def @mail.key?(header_name) end  
+    def @mail.header_string(header_name, default = nil) 
+      default
+    end  
   end
 
 end

data/test/test_arsendmail.rb

@@ -362,7 +362,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     end
 
     assert_equal '', out
-    assert_equal "expired 1 emails from the queue\n", err
+    assert err.index("expired 1 emails from the queue\n")
     assert_equal 2, Email.records.length
 
     assert_equal [e1, e2], Email.records
@@ -383,6 +383,24 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal 2, Email.records.length
   end
 
+  def test_context
+    email = Email.create :mail => 'body', :to => 'to', :from => 'from', :context => 'lemon'
+
+    out, err = util_capture do
+      @sm.deliver [email]
+    end
+
+    assert err.index('[lemon]')
+    
+    email = Email.create :mail => 'body', :to => 'to', :from => 'from', :context => ''
+
+    out, err = util_capture do
+      @sm.deliver [email]
+    end
+
+    assert !err.index('[]')
+  end    
+
   def test_deliver
     email = Email.create :mail => 'body', :to => 'to', :from => 'from'
 
@@ -396,7 +414,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal 0, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
 
     assert_equal '', out
-    assert_equal "sent email 00000000001 from from to to: \"queued\"\n", err
+    assert err.index("sent email 00000000001 from from to to: \"queued\"\n")
   end
 
   def test_deliver_auth_error
@@ -422,7 +440,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal [60], @sm.slept
 
     assert_equal '', out
-    assert_equal "authentication error, retrying: try again\n", err
+    assert err.index("authentication error, retrying: try again\n")
   end
 
   def test_deliver_auth_error_recover
@@ -452,7 +470,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     end
 
     assert_equal 2, @sm.failed_auth_count
-    assert_equal "authentication error, giving up: try again\n", err
+    assert err.index("authentication error, giving up: try again\n")
   end
 
   def test_deliver_no_auth_without_emails
@@ -490,7 +508,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal 1, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
 
     assert_equal '', out
-    assert_equal "error sending email 1: \"try again\"(Net::SMTPSyntaxError):\n\tone\n\ttwo\n\tthree\n", err
+    assert err.index("error sending email 1: \"try again\"(Net::SMTPSyntaxError):\n\tone\n\ttwo\n\tthree\n")
   end
 
   def test_deliver_5xx_error
@@ -513,7 +531,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal 1, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
 
     assert_equal '', out
-    assert_equal "5xx error sending email 1, removing from queue: \"unknown recipient\"(Net::SMTPFatalError):\n\tone\n\ttwo\n\tthree\n", err
+    assert err.index("5xx error sending email 1, removing from queue: \"unknown recipient\"(Net::SMTPFatalError):\n\tone\n\ttwo\n\tthree\n")
   end
 
   def test_deliver_errno_epipe
@@ -560,7 +578,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal [60], @sm.slept
 
     assert_equal '', out
-    assert_equal "server too busy, sleeping 60 seconds\n", err
+    assert err.index("server too busy, sleeping 60 seconds\n")
   end
 
   def test_deliver_syntax_error
@@ -586,7 +604,9 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_operator now, :<=, Email.records.first.last_send_attempt
 
     assert_equal '', out
-    assert_equal "error sending email 1: \"blah blah blah\"(Net::SMTPSyntaxError):\n\tone\n\ttwo\n\tthree\nsent email 00000000002 from from to to: \"queued\"\n", err
+
+    assert err.index("error sending email 1: \"blah blah blah\"(Net::SMTPSyntaxError):\n\tone\n\ttwo\n\tthree\n")
+    assert err.index("sent email 00000000002 from from to to: \"queued\"\n")
   end
 
   def test_deliver_timeout
@@ -610,7 +630,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal 1, Net::SMTP.reset_called, 'Reset connection on Timeout'
 
     assert_equal '', out
-    assert_equal "error sending email 1: \"timed out\"(Timeout::Error):\n\tone\n\ttwo\n\tthree\n", err
+    assert err.index("error sending email 1: \"timed out\"(Timeout::Error):\n\tone\n\ttwo\n\tthree\n")
   end
 
   def test_do_exit
@@ -621,7 +641,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     end
 
     assert_equal '', out
-    assert_equal "caught signal, shutting down\n", err
+    assert err.index("caught signal, shutting down\n")
   end
 
   def test_log
@@ -629,7 +649,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
       @sm.log 'hi'
     end
 
-    assert_equal "hi\n", err
+    assert err.index("hi\n")
   end
 
   def test_find_emails
@@ -655,7 +675,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal emails, found_emails
 
     assert_equal '', out
-    assert_equal "found 3 emails to send\n", err
+    assert err.index("found 3 emails to send\n")
   end
 
   def test_smtp_settings

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zendesk-ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors: 
 - Eric Hodel
@@ -33,6 +33,7 @@ files:
 - bin/ar_sendmail
 - lib/action_mailer/ar_mailer.rb
 - lib/action_mailer/ar_sendmail.rb
+- lib/ar_sendmail_logger.rb
 - lib/smtp_tls.rb
 - share/bsd/ar_sendmail
 - share/linux/ar_sendmail