ar_mailer 1.0.1 → 1.1.0

data/Manifest.txt

@@ -5,6 +5,7 @@ Rakefile
 bin/ar_sendmail
 lib/action_mailer/ar_mailer.rb
 lib/action_mailer/ar_sendmail.rb
+share/ar_sendmail
 test/action_mailer.rb
 test/test_armailer.rb
 test/test_arsendmail.rb

data/README

@@ -6,7 +6,7 @@ http://rubyforge.org/projects/rctools
 
 Documentation:
 
-http://dev.robotcoop.com/Libraries/ar_mailer
+http://dev.robotcoop.com/Tools/ar_mailer
 
 == About
 
@@ -24,3 +24,7 @@ See ActionMailer::ARMailer for instructions on converting to ARMailer.
 
 See ar_sendmail -h for options to ar_sendmail.
 
+=== ar_sendmail on FreeBSD or NetBSD
+
+An rc.d script is included in share/ar_sendmail.
+

data/Rakefile

@@ -8,7 +8,7 @@ $VERBOSE = nil
 
 spec = Gem::Specification.new do |s|
   s.name = 'ar_mailer'
-  s.version = '1.0.1'
+  s.version = '1.1.0'
   s.summary = 'A two-phase deliver agent for ActionMailer'
   s.description = 'Queues emails from ActionMailer in the database and uses a separate process to send them.  Reduces sending overhead when sending hundreds of emails.'
   s.author = 'Eric Hodel'

data/bin/ar_sendmail

@@ -1,10 +1,5 @@
 #!/usr/local/bin/ruby
 
-begin
-  require 'config/environment'
-rescue LoadError
-  # process_args will handle with sane message
-end
 require 'action_mailer/ar_sendmail'
 
 ActionMailer::ARSendmail.run

data/lib/action_mailer/ar_mailer.rb

@@ -36,9 +36,10 @@ require 'action_mailer'
 #   def comment_notification(comment)
 #     from comment.author.email
 # 
-# Edit config/environment/production.rb and set the delivery agent:
+# Edit config/environments/production.rb and set the delivery agent:
 # 
-#   $ ActionMailer::Base.delivery_method = :activerecord
+#   $ grep delivery_method config/environments/production.rb
+#   ActionMailer::Base.delivery_method = :activerecord
 # 
 # Run ar_sendmail:
 # 

data/lib/action_mailer/ar_sendmail.rb

@@ -10,6 +10,22 @@ class Object # :nodoc:
   end
 end
 
+##
+# Hack in RSET
+
+class Net::SMTP # :nodoc:
+
+  unless instance_methods.include? 'reset' then
+    ##
+    # Resets the SMTP connection.
+
+    def reset
+      getok 'RSET'
+    end
+  end
+
+end
+
 ##
 # ActionMailer::ARSendmail delivers email from the email table to the
 # configured SMTP server.
@@ -51,10 +67,10 @@ class ActionMailer::ARSendmail
   attr_reader :once
 
   ##
-  # Creates a new migration using +table_name+ and prints it on $stdout.
+  # Creates a new migration using +table_name+ and prints it on stdout.
 
   def self.create_migration(table_name)
-    migration = <<-EOF
+    puts <<-EOF
 class Add#{table_name.classify} < ActiveRecord::Migration
   def self.up
     create_table :#{table_name.tableize} do |t|
@@ -70,20 +86,16 @@ class Add#{table_name.classify} < ActiveRecord::Migration
   end
 end
     EOF
-
-    $stdout.puts migration
   end
 
   ##
-  # Creates a new model using +table_name+ and prints it on $stdout.
+  # Creates a new model using +table_name+ and prints it on stdout.
 
   def self.create_model(table_name)
-    model = <<-EOF
+    puts <<-EOF
 class #{table_name.classify} < ActiveRecord::Base
 end
     EOF
-
-    $stdout.puts model
   end
 
   ##
@@ -97,13 +109,13 @@ end
     emails = Email.find :all
 
     if emails.empty? then
-      $stdout.puts "Mail queue is empty"
+      puts "Mail queue is empty"
       return
     end
 
     total_size = 0
 
-    $stdout.puts "-Queue ID- --Size-- ----Arrival Time---- -Sender/Recipient-------"
+    puts "-Queue ID- --Size-- ----Arrival Time---- -Sender/Recipient-------"
     emails.each do |email|
       size = email.mail.length
       total_size += size
@@ -119,15 +131,15 @@ end
                   create_timestamp.strftime '%a %b %d %H:%M:%S'
                 end
 
-      $stdout.puts "%10d %8d %s  %s" % [email.id, size, created, email.from]
-      if email.last_send_attempt then
-        $stdout.puts "Last send attempt: #{email.last_send_attempt}"
+      puts "%10d %8d %s  %s" % [email.id, size, created, email.from]
+      if email.last_send_attempt > 0 then
+        puts "Last send attempt: #{Time.at email.last_send_attempt}"
       end
-      $stdout.puts "                                         #{email.to}"
-      $stdout.puts
+      puts "                                         #{email.to}"
+      puts
     end
 
-    $stdout.puts "-- #{total_size/1024} Kbytes in #{emails.length} Requests."
+    puts "-- #{total_size/1024} Kbytes in #{emails.length} Requests."
   end
 
   ##
@@ -141,6 +153,8 @@ end
     options[:Delay] = 60
     options[:Once] = false
     options[:TableName] = 'Email'
+    options[:Chdir] = '.'
+    options[:RailsEnv] = ENV['RAILS_ENV']
 
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: #{name} [options]"
@@ -149,7 +163,7 @@ end
       opts.separator "#{name} scans the email table for new messages and sends them to the"
       opts.separator "website's configured SMTP host."
       opts.separator ''
-      opts.separator "#{name} must be run from the application's root."
+      opts.separator "#{name} must be run from a Rails application's root."
 
       opts.separator ''
       opts.separator 'Sendmail options:'
@@ -189,19 +203,33 @@ end
 
       opts.on(      "--create-migration",
               "Prints a migration to add an Email table",
-              "to $stdout") do |create|
+              "to stdout") do |create|
         options[:Migrate] = true
       end
 
       opts.on(      "--create-model",
               "Prints a model for an Email ActiveRecord",
-              "object to $stdout") do |create|
+              "object to stdout") do |create|
         options[:Model] = true
       end
 
       opts.separator ''
       opts.separator 'Generic Options:'
 
+      opts.on("-c", "--chdir PATH",
+              "Use PATH for the application path",
+              "Default: #{options[:Chdir]}") do |path|
+        usage opts, "#{path} is not a directory" unless File.directory? path
+        usage opts, "#{path} is not readable" unless File.readable? path
+        options[:Chdir] = path
+      end
+
+      opts.on("-e", "--environment RAILS_ENV",
+              "Set the RAILS_ENV constant",
+              "Default: #{options[:RailsEnv]}") do |env|
+        options[:RailsEnv] = env
+      end
+
       opts.on("-t", "--table-name TABLE_NAME",
               "Name of table holding emails",
               "Used for both sendmail and",
@@ -218,8 +246,7 @@ end
 
       opts.on("-h", "--help",
               "You're looking at it") do
-        $stderr.puts opts
-        exit 1
+        usage opts
       end
 
       opts.separator ''
@@ -227,12 +254,19 @@ end
 
     opts.parse! args
 
-    unless options.include? :Migrate or options.include? :Model or
-           not $".grep(/config\/environment.rb/).empty? then
-      $stderr.puts "#{name} must be run from a Rails application's root to deliver email."
-      $stderr.puts
-      $stderr.puts opts
-      exit 1
+    return options if options.include? :Migrate or options.include? :Model
+
+    ENV['RAILS_ENV'] = options[:RailsEnv]
+
+    Dir.chdir options[:Chdir] do
+      begin
+        require 'config/environment'
+      rescue LoadError
+        usage opts, <<-EOF
+#{name} must be run from a Rails application's root to deliver email.
+#{Dir.pwd} does not appear to be a Rails application root.
+          EOF
+      end
     end
 
     return options
@@ -261,6 +295,22 @@ end
     end
 
     new(options).run
+
+  rescue Interrupt
+    exit
+  end
+
+  ##
+  # Prints a usage message to $stderr using +opts+ and exits
+
+  def self.usage(opts, message = nil)
+    if message then
+      $stderr.puts message
+      $stderr.puts
+    end
+
+    $stderr.puts opts
+    exit 1
   end
 
   ##
@@ -292,19 +342,38 @@ end
                     server_settings[:domain], server_settings[:user],
                     server_settings[:password],
                     server_settings[:authentication] do |smtp|
-      emails.each do |email|
+      until emails.empty? do
+        email = emails.shift
         begin
           res = smtp.send_message email.mail, email.from, email.to
           email.destroy
-          log "sent email from %s to %s: %p" % [email.from, email.to, res]
-        rescue Net::SMTPServerBusy, Net::SMTPFatalError,
-               Net::SMTPUnknownError, TimeoutError
+          log "sent email %011d from %s to %s: %p" %
+                [email.id, email.from, email.to, res]
+        rescue Net::SMTPFatalError => e
+          log "5xx error sending email %d, removing from queue: %p(%s):\n\t%s" %
+                [email.id, e.message, e.class, e.backtrace.join("\n\t")]
+          email.destroy
+          smtp.reset
+        rescue Net::SMTPServerBusy, Net::SMTPUnknownError,
+               Net::SMTPSyntaxError, TimeoutError => e
           email.last_send_attempt = Time.now.to_i
+          email.save rescue nil
+          log "error sending email %d: %p(%s):\n\t%s" %
+                [email.id, e.message, e.class, e.backtrace.join("\n\t")]
+          smtp.reset
         end
       end
     end
   end
 
+  ##
+  # Prepares ar_sendmail for exiting
+
+  def do_exit
+    log "caught signal, shutting down"
+    raise Interrupt
+  end
+
   ##
   # Returns emails in email_class that haven't had a delivery attempt in the
   # last 300 seconds.
@@ -318,6 +387,14 @@ end
     mail
   end
 
+  ##
+  # Installs signal handlers to gracefully exit.
+
+  def install_signal_handlers
+    trap 'TERM' do do_exit end
+    trap 'INT'  do do_exit end
+  end
+
   ##
   # Logs +message+ if verbose
 
@@ -331,10 +408,16 @@ end
   # once is true.
 
   def run
+    install_signal_handlers
+
     loop do
-      deliver find_emails
+      now = Time.now
+      begin
+        deliver find_emails
+      rescue ActiveRecord::Transactions::TransactionError
+      end
       break if @once
-      sleep @delay
+      sleep @delay if now + @delay > Time.now
     end
   end
 

data/share/ar_sendmail

@@ -0,0 +1,30 @@
+#!/bin/sh
+# PROVIDE: ar_sendmail
+# REQUIRE: DAEMON
+# BEFORE: LOGIN
+# KEYWORD: FreeBSD shutdown
+
+#
+# Add the following lines to /etc/rc.conf to enable ar_sendmail:
+#
+#ar_sendmail_enable="YES"
+
+. /etc/rc.subr
+
+name="ar_sendmail"
+rcvar=`set_rcvar`
+
+command="/usr/local/bin/ar_sendmail"
+command_interpreter="/usr/local/bin/ruby18"
+
+# set defaults
+
+ar_sendmail_rails_env=${ar_sendmail_rails_env:-"production"}
+ar_sendmail_chdir=${ar_sendmail_chdir:-"/"}
+ar_sendmail_enable=${ar_sendmail_enable:-"NO"}
+ar_sendmail_flags=${ar_sendmail_flags:-"-d"}
+
+load_rc_config $name
+export RAILS_ENV=$ar_sendmail_rails_env
+run_rc_command "$1"
+

data/test/action_mailer.rb

@@ -3,6 +3,8 @@ require 'time'
 
 class Net::SMTP
 
+  @reset_called = 0
+
   @deliveries = []
 
   @send_message_block = nil
@@ -11,6 +13,7 @@ class Net::SMTP
 
     attr_reader :deliveries
     attr_reader :send_message_block
+    attr_accessor :reset_called
 
     alias old_start start
 
@@ -24,12 +27,25 @@ class Net::SMTP
     @send_message_block = block
   end
 
+  def self.reset
+    deliveries.clear
+    on_send_message
+    @reset_called = 0
+  end
+
+  alias old_reset reset if instance_methods.include? 'reset'
+
+  def reset
+    self.class.reset_called += 1
+  end
+
   alias old_send_message send_message
 
   def send_message(mail, to, from)
     return self.class.send_message_block.call(mail, to, from) unless
       self.class.send_message_block.nil?
     self.class.deliveries << [mail, to, from]
+    return "queued"
   end
 
 end
@@ -55,6 +71,10 @@ class ActionMailer::Base
     new($1, *args).deliver!
   end
 
+  def self.reset
+    server_settings.clear
+  end
+
   def self.server_settings
     @server_settings
   end
@@ -93,16 +113,22 @@ class Email
     return records if conditions.nil?
     now = Time.now.to_i - 300
     return records.select do |r|
-      r.last_send_attempt.nil? or r.last_send_attempt < now
+      r.last_send_attempt < now
     end
   end
 
+  def self.reset
+    @id = 0
+    records.clear
+  end
+
   def initialize(from, to, mail)
     @from = from
     @to = to
     @mail = mail
     @id = self.class.id += 1
     @created_on = START + @id
+    @last_send_attempt = 0
   end
 
   def destroy
@@ -111,9 +137,10 @@ class Email
   end
 
   def ==(other)
-    other.from == from and
-    other.to == to and
-    other.mail == mail
+    other.id == id
+  end
+
+  def save
   end
 
 end

data/test/test_arsendmail.rb

@@ -7,13 +7,12 @@ require 'test/zentest_assertions'
 class TestARSendmail < Test::Unit::TestCase
 
   def setup
-    ActionMailer::Base.server_settings.clear
-    Email.id = 0
-    Email.records.clear
-    Net::SMTP.deliveries.clear
-    Net::SMTP.on_send_message # reset
+    ActionMailer::Base.reset
+    Email.reset
+    Net::SMTP.reset
 
     @sm = ActionMailer::ARSendmail.new
+    @sm.verbose = true
 
     @include_c_e = ! $".grep(/config\/environment.rb/).empty?
     $" << 'config/environment.rb' unless @include_c_e
@@ -107,7 +106,7 @@ end
     last = Email.create :from => nobody, :to => 'recip@h2.example.com',
                         :mail => 'body2'
 
-    last.last_send_attempt = Time.parse 'Thu Aug 10 11:40:05'
+    last.last_send_attempt = Time.parse('Thu Aug 10 11:40:05').to_i
 
     out, err = util_capture do
       ActionMailer::ARSendmail.mailq
@@ -140,6 +139,8 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
   end
 
   def test_class_new
+    @sm = ActionMailer::ARSendmail.new
+
     assert_equal 60, @sm.delay
     assert_equal Email, @sm.email_class
     assert_equal nil, @sm.once
@@ -167,6 +168,28 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal 500, options[:BatchSize]
   end
 
+  def test_class_parse_args_chdir
+    argv = %w[-c /tmp]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal '/tmp', options[:Chdir]
+
+    argv = %w[--chdir /tmp]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal '/tmp', options[:Chdir]
+
+    argv = %w[-c /nonexistent]
+    
+    out, err = util_capture do
+      assert_raises SystemExit do
+        ActionMailer::ARSendmail.process_args argv
+      end
+    end
+  end
+
   def test_class_parse_args_daemon
     argv = %w[-d]
     
@@ -189,6 +212,24 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal 75, options[:Delay]
   end
 
+  def test_class_parse_args_environment
+    assert_equal nil, ENV['RAILS_ENV']
+
+    argv = %w[-e production]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal 'production', options[:RailsEnv]
+
+    assert_equal 'production', ENV['RAILS_ENV']
+
+    argv = %w[--environment production]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal 'production', options[:RailsEnv]
+  end
+
   def test_class_parse_args_mailq
     options = ActionMailer::ARSendmail.process_args []
     deny_includes options, :MailQ
@@ -225,8 +266,8 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
   def test_class_parse_args_no_config_environment
     $".delete 'config/environment.rb'
 
-    assert_raise SystemExit do
-      out, err = util_capture do
+    out, err = util_capture do
+      assert_raise SystemExit do
         ActionMailer::ARSendmail.process_args []
       end
     end
@@ -292,35 +333,127 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal 'Email', options[:TableName]
   end
 
+  def test_class_usage
+    out, err = util_capture do
+      assert_raises SystemExit do
+        ActionMailer::ARSendmail.usage 'opts'
+      end
+    end
+
+    assert_equal '', out.string
+    assert_equal "opts\n", err.string
+
+    out, err = util_capture do
+      assert_raises SystemExit do
+        ActionMailer::ARSendmail.usage 'opts', 'hi'
+      end
+    end
+
+    assert_equal '', out.string
+    assert_equal "hi\n\nopts\n", err.string
+  end
+
   def test_deliver
     email = Email.create :mail => 'body', :to => 'to', :from => 'from'
 
-    @sm.deliver [email]
+    out, err = util_capture do
+      @sm.deliver [email]
+    end
 
     assert_equal 1, Net::SMTP.deliveries.length
     assert_equal ['body', 'from', 'to'], Net::SMTP.deliveries.first
     assert_equal 0, Email.records.length
+    assert_equal 0, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
+
+    assert_equal '', out.string
+    assert_equal "sent email 00000000001 from from to to: \"queued\"\n", err.string
+  end
+
+  def test_deliver_4xx_error
+    Net::SMTP.on_send_message do
+      e = Net::SMTPServerBusy.new 'try again'
+      e.set_backtrace %w[one two three]
+      raise e
+    end
+
+    now = Time.now.to_i
+
+    email = Email.create :mail => 'body', :to => 'to', :from => 'from'
+
+    out, err = util_capture do
+      @sm.deliver [email]
+    end
+
+    assert_equal 0, Net::SMTP.deliveries.length
+    assert_equal 1, Email.records.length
+    assert_operator now, :<=, Email.records.first.last_send_attempt
+    assert_equal 1, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
+
+    assert_equal '', out.string
+    assert_equal "error sending email 1: \"try again\"(Net::SMTPServerBusy):\n\tone\n\ttwo\n\tthree\n", err.string
   end
 
-  def test_deliver_500
+  def test_deliver_5xx_error
     Net::SMTP.on_send_message do
-      raise Net::SMTPServerBusy
+      e = Net::SMTPFatalError.new 'unknown recipient'
+      e.set_backtrace %w[one two three]
+      raise e
     end
 
     now = Time.now.to_i
 
     email = Email.create :mail => 'body', :to => 'to', :from => 'from'
 
-    @sm.deliver [email]
+    out, err = util_capture do
+      @sm.deliver [email]
+    end
 
     assert_equal 0, Net::SMTP.deliveries.length
+    assert_equal 0, Email.records.length
+    assert_equal 1, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
+
+    assert_equal '', out.string
+    assert_equal "5xx error sending email 1, removing from queue: \"unknown recipient\"(Net::SMTPFatalError):\n\tone\n\ttwo\n\tthree\n", err.string
+  end
+
+  def test_deliver_syntax_error
+    Net::SMTP.on_send_message do
+      Net::SMTP.on_send_message # clear
+      e = Net::SMTPSyntaxError.new 'blah blah blah'
+      e.set_backtrace %w[one two three]
+      raise e
+    end
+
+    now = Time.now.to_i
+
+    email1 = Email.create :mail => 'body', :to => 'to', :from => 'from'
+    email2 = Email.create :mail => 'body', :to => 'to', :from => 'from'
+
+    out, err = util_capture do
+      @sm.deliver [email1, email2]
+    end
+
+    assert_equal 1, Net::SMTP.deliveries.length
     assert_equal 1, Email.records.length
+    assert_equal 1, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
     assert_operator now, :<=, Email.records.first.last_send_attempt
+
+    assert_equal '', out.string
+    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.string
   end
 
-  def test_log
-    @sm = ActionMailer::ARSendmail.new :Verbose => true
+  def test_do_exit
+    out, err = util_capture do
+      assert_raise Interrupt do
+        @sm.do_exit
+      end
+    end
+
+    assert_equal '', out.string
+    assert_equal "caught signal, shutting down\n", err.string
+  end
 
+  def test_log
     out, err = util_capture do
       @sm.log 'hi'
     end
@@ -329,28 +462,29 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
   end
 
   def test_find_emails
-    emails = [
+    email_data = [
       { :mail => 'body0', :to => 'recip@h1.example.com', :from => nobody },
       { :mail => 'body1', :to => 'recip@h1.example.com', :from => nobody },
       { :mail => 'body2', :to => 'recip@h2.example.com', :from => nobody },
     ]
 
-    emails.each do |email| Email.create email end
+    emails = email_data.map do |email_data| Email.create email_data end
 
     tried = Email.create :mail => 'body3', :to => 'recip@h3.example.com',
                          :from => nobody
 
     tried.last_send_attempt = Time.now.to_i - 258
 
-    found_emails = @sm.find_emails
+    found_emails = []
 
-    expected = [
-      Email.new(nobody, 'recip@h1.example.com', 'body0'),
-      Email.new(nobody, 'recip@h1.example.com', 'body1'),
-      Email.new(nobody, 'recip@h2.example.com', 'body2'),
-    ]
+    out, err = util_capture do
+      found_emails = @sm.find_emails
+    end
+
+    assert_equal emails, found_emails
 
-    assert_equal expected, found_emails
+    assert_equal '', out.string
+    assert_equal "found 3 emails to send\n", err.string
   end
 
   def test_server_settings

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.99
 specification_version: 1
 name: ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2006-08-15 00:00:00 -07:00
+  version: 1.1.0
+date: 2006-08-18 00:00:00 -07:00
 summary: A two-phase deliver agent for ActionMailer
 require_paths: 
 - lib
@@ -36,6 +36,7 @@ files:
 - bin/ar_sendmail
 - lib/action_mailer/ar_mailer.rb
 - lib/action_mailer/ar_sendmail.rb
+- share/ar_sendmail
 - test/action_mailer.rb
 - test/test_armailer.rb
 - test/test_arsendmail.rb