ar_mailer 1.2.0 → 1.3.1

data/History.txt

@@ -1,3 +1,19 @@
+= 1.3.1
+
+* Fix bug #12530, gmail causes SSL errors.  Submitted by Kyle Maxwell
+  and Alex Ostleitner.
+* Try ActionMailer::Base::server_settings then ::smtp_settings.  Fixes
+  bug #12516.  Submitted by Alex Ostleitner.
+
+= 1.3.0
+
+* New Features
+  * Added automatic mail queue cleanup.
+    * MAY CAUSE LOSS OF DATA.  If you haven't run ar_sendmail within
+      the expiry time, set it to 0.
+* Bugs fixed
+  * Authentication errors are now handled by retrying once.
+
 = 1.2.0
 
 * Bugs fixed

data/README.txt

@@ -16,7 +16,7 @@ http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
 
 == About
 
-Even deliviring email to the local machine may take too long when you have to
+Even delivering email to the local machine may take too long when you have to
 send hundreds of messages.  ar_mailer allows you to store messages into the
 database for later delivery by a separate process, ar_sendmail.
 
@@ -30,6 +30,9 @@ See ActionMailer::ARMailer for instructions on converting to ARMailer.
 
 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.
+
 === ar_sendmail on FreeBSD or NetBSD
 
 An rc.d script is included in share/ar_sendmail.

data/Rakefile

@@ -1,6 +1,8 @@
 require 'hoe'
 
-Hoe.new 'ar_mailer', '1.2.0' do |s|
+require './lib/action_mailer/ar_sendmail'
+
+Hoe.new 'ar_mailer', ActionMailer::ARSendmail::VERSION do |s|
   s.rubyforge_name = 'seattlerb'
   s.summary = s.paragraphs_of('README.txt', 1).join(' ')
   s.description = s.paragraphs_of('README.txt', 9).join(' ')

data/lib/action_mailer/ar_mailer.rb

@@ -67,8 +67,6 @@ require 'action_mailer'
 
 class ActionMailer::ARMailer < ActionMailer::Base
 
-  VERSION = '1.2.0' # :nodoc:
-
   @@email_class = Email
 
   ##

data/lib/action_mailer/ar_sendmail.rb

@@ -51,6 +51,16 @@ module ActionMailer; end # :nodoc:
 
 class ActionMailer::ARSendmail
 
+  ##
+  # The version of ActionMailer::ARSendmail you are running.
+
+  VERSION = '1.3.1'
+
+  ##
+  # Maximum number of times authentication will be consecutively retried
+
+  MAX_AUTH_FAILURES = 2
+
   ##
   # Email delivery attempts per run
 
@@ -61,6 +71,11 @@ class ActionMailer::ARSendmail
 
   attr_accessor :delay
 
+  ##
+  # Maximum age of emails in seconds before they are removed from the queue.
+
+  attr_accessor :max_age
+
   ##
   # Be verbose
 
@@ -76,6 +91,11 @@ class ActionMailer::ARSendmail
 
   attr_reader :once
 
+  ##
+  # Times authentication has failed
+
+  attr_accessor :failed_auth_count
+
   ##
   # Creates a new migration using +table_name+ and prints it on stdout.
 
@@ -94,7 +114,7 @@ class Add#{table_name.classify} < ActiveRecord::Migration
   end
 
   def self.down
-    drop_table :emails
+    drop_table :#{table_name.tableize}
   end
 end
     EOF
@@ -134,8 +154,8 @@ end
       size = email.mail.length
       total_size += size
 
-      create_timestamp = email.created_at rescue
-                         email.created_on rescue
+      create_timestamp = email.created_on rescue
+                         email.created_at rescue
                          Time.at(email.created_date) rescue # for Robot Co-op
                          nil
 
@@ -163,12 +183,13 @@ end
     name = File.basename $0
 
     options = {}
+    options[:Chdir] = '.'
     options[:Daemon] = false
     options[:Delay] = 60
+    options[:MaxAge] = 86400 * 7
     options[:Once] = false
-    options[:TableName] = 'Email'
-    options[:Chdir] = '.'
     options[:RailsEnv] = ENV['RAILS_ENV']
+    options[:TableName] = 'Email'
 
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: #{name} [options]"
@@ -195,6 +216,14 @@ end
         options[:Delay] = delay
       end
 
+      opts.on(      "--max-age MAX_AGE",
+              "Maxmimum age for an email. After this",
+              "it will be removed from the queue.",
+              "Set to 0 to disable queue cleanup.",
+              "Default: #{options[:MaxAge]} seconds", Integer) do |max_age|
+        options[:MaxAge] = max_age
+      end
+
       opts.on("-o", "--once",
               "Only check for new mail and deliver once",
               "Default: #{options[:Once]}") do |once|
@@ -346,24 +375,42 @@ end
   def initialize(options = {})
     options[:Delay] ||= 60
     options[:TableName] ||= 'Email'
+    options[:MaxAge] ||= 86400 * 7
 
     @batch_size = options[:BatchSize]
     @delay = options[:Delay]
     @email_class = Object.path2class options[:TableName]
     @once = options[:Once]
     @verbose = options[:Verbose]
+    @max_age = options[:MaxAge]
+
+    @failed_auth_count = 0
+  end
+
+  ##
+  # Removes emails that have lived in the queue for too long.  If max_age is
+  # set to 0, no emails will be removed.
+
+  def cleanup
+    return if @max_age == 0
+    timeout = Time.now - @max_age
+    conditions = ['last_send_attempt > 0 and created_on < ?', timeout]
+    mail = @email_class.destroy_all conditions
+
+    log "expired #{mail.length} emails from the queue"
   end
 
   ##
   # Delivers +emails+ to ActionMailer's SMTP server and destroys them.
 
   def deliver(emails)
-    user = server_settings[:user] || server_settings[:user_name]
-    Net::SMTP.start server_settings[:address], server_settings[:port],
-                    server_settings[:domain], user,
-                    server_settings[:password],
-                    server_settings[:authentication],
-                    server_settings[:tls] do |smtp|
+    user = smtp_settings[:user] || smtp_settings[:user_name]
+    Net::SMTP.start smtp_settings[:address], smtp_settings[:port],
+                    smtp_settings[:domain], user,
+                    smtp_settings[:password],
+                    smtp_settings[:authentication],
+                    smtp_settings[:tls] do |smtp|
+      @failed_auth_count = 0
       until emails.empty? do
         email = emails.shift
         begin
@@ -378,9 +425,9 @@ end
           smtp.reset
         rescue Net::SMTPServerBusy => e
           log "server too busy, sleeping #{@delay} seconds"
-          sleep delay unless $TESTING
+          sleep delay
           return
-        rescue Net::SMTPServerBusy, Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError => e
+        rescue 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" %
@@ -389,7 +436,16 @@ end
         end
       end
     end
-  rescue Net::SMTPServerBusy, SystemCallError
+  rescue Net::SMTPAuthenticationError => e
+    @failed_auth_count += 1
+    if @failed_auth_count >= MAX_AUTH_FAILURES then
+      log "authentication error, giving up: #{e.message}"
+      raise e
+    else
+      log "authentication error, retrying: #{e.message}"
+    end
+    sleep delay
+  rescue Net::SMTPServerBusy, SystemCallError, OpenSSL::SSL::SSLError
     # ignore SMTPServerBusy/EPIPE/ECONNRESET from Net::SMTP.start's ensure
   end
 
@@ -440,6 +496,7 @@ end
     loop do
       now = Time.now
       begin
+        cleanup
         deliver find_emails
       rescue ActiveRecord::Transactions::TransactionError
       end
@@ -449,12 +506,15 @@ end
   end
 
   ##
-  # Proxy to ActionMailer::Base#server_settings.  See
+  # Proxy to ActionMailer::Base::smtp_settings.  See
   # http://api.rubyonrails.org/classes/ActionMailer/Base.html
   # for instructions on how to configure ActionMailer's SMTP server.
+  #
+  # Falls back to ::server_settings if ::smtp_settings doesn't exist for
+  # backwards compatibility.
 
-  def server_settings
-    ActionMailer::Base.server_settings
+  def smtp_settings
+    ActionMailer::Base.smtp_settings rescue ActionMailer::Base.server_settings
   end
 
 end

data/test/action_mailer.rb

@@ -10,6 +10,8 @@ class Net::SMTP
 
   @send_message_block = nil
 
+  @start_block = nil
+
   class << self
 
     attr_reader :deliveries
@@ -21,6 +23,7 @@ class Net::SMTP
   end
 
   def self.start(*args)
+    @start_block.call if @start_block
     yield new(nil)
   end
 
@@ -28,8 +31,13 @@ class Net::SMTP
     @send_message_block = block
   end
 
+  def self.on_start(&block)
+    @start_block = block
+  end
+
   def self.reset
     deliveries.clear
+    on_start
     on_send_message
     @reset_called = 0
   end
@@ -105,11 +113,27 @@ class Email
   class << self; attr_accessor :records, :id; end
 
   def self.create(record)
-    record = new record[:from], record[:to], record[:mail]
+    record = new record[:from], record[:to], record[:mail],
+                 record[:last_send_attempt]
     records << record
     return record
   end
 
+  def self.destroy_all(conditions)
+    timeout = conditions.last
+    found = []
+
+    records.each do |record|
+      next if record.last_send_attempt == 0
+      next if record.created_on == 0
+      next unless record.created_on < timeout
+      record.destroy
+      found << record
+    end
+
+    found
+  end
+
   def self.find(_, conditions = nil)
     return records if conditions.nil?
     now = Time.now.to_i - 300
@@ -123,13 +147,13 @@ class Email
     records.clear
   end
 
-  def initialize(from, to, mail)
+  def initialize(from, to, mail, last_send_attempt = nil)
     @from = from
     @to = to
     @mail = mail
     @id = self.class.id += 1
     @created_on = START + @id
-    @last_send_attempt = 0
+    @last_send_attempt = last_send_attempt || 0
   end
 
   def destroy

data/test/test_arsendmail.rb

@@ -4,7 +4,13 @@ require 'action_mailer/ar_sendmail'
 require 'rubygems'
 require 'test/zentest_assertions'
 
-$TESTING = true
+class ActionMailer::ARSendmail
+  attr_accessor :slept
+  def sleep(secs)
+    @slept ||= []
+    @slept << secs
+  end
+end
 
 class TestARSendmail < Test::Unit::TestCase
 
@@ -42,7 +48,7 @@ class AddMail < ActiveRecord::Migration
   end
 
   def self.down
-    drop_table :emails
+    drop_table :mail
   end
 end
     EOF
@@ -206,6 +212,17 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal true, options[:MailQ]
   end
 
+  def test_class_parse_args_max_age
+    options = ActionMailer::ARSendmail.process_args []
+    assert_equal 86400 * 7, options[:MaxAge]
+
+    argv = %w[--max-age 86400]
+
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal 86400, options[:MaxAge]
+  end
+
   def test_class_parse_args_migration
     options = ActionMailer::ARSendmail.process_args []
     deny_includes :Migration, options
@@ -318,6 +335,39 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal "hi\n\nopts\n", err.string
   end
 
+  def test_cleanup
+    e1 = Email.create :mail => 'body', :to => 'to', :from => 'from'
+    e1.created_on = Time.now
+    e2 = Email.create :mail => 'body', :to => 'to', :from => 'from'
+    e3 = Email.create :mail => 'body', :to => 'to', :from => 'from'
+    e3.last_send_attempt = Time.now
+
+    out, err = util_capture do
+      @sm.cleanup
+    end
+
+    assert_equal '', out.string
+    assert_equal "expired 1 emails from the queue\n", err.string
+    assert_equal 2, Email.records.length
+
+    assert_equal [e1, e2], Email.records
+  end
+
+  def test_cleanup_disabled
+    e1 = Email.create :mail => 'body', :to => 'to', :from => 'from'
+    e1.created_on = Time.now
+    e2 = Email.create :mail => 'body', :to => 'to', :from => 'from'
+
+    @sm.max_age = 0
+
+    out, err = util_capture do
+      @sm.cleanup
+    end
+
+    assert_equal '', out.string
+    assert_equal 2, Email.records.length
+  end
+
   def test_deliver
     email = Email.create :mail => 'body', :to => 'to', :from => 'from'
 
@@ -334,6 +384,61 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal "sent email 00000000001 from from to to: \"queued\"\n", err.string
   end
 
+  def test_deliver_auth_error
+    Net::SMTP.on_start do
+      e = Net::SMTPAuthenticationError.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_equal 0, Email.records.first.last_send_attempt
+    assert_equal 0, Net::SMTP.reset_called
+    assert_equal 1, @sm.failed_auth_count
+    assert_equal [60], @sm.slept
+
+    assert_equal '', out.string
+    assert_equal "authentication error, retrying: try again\n", err.string
+  end
+
+  def test_deliver_auth_error_recover
+    email = Email.create :mail => 'body', :to => 'to', :from => 'from'
+    @sm.failed_auth_count = 1
+
+    out, err = util_capture do @sm.deliver [email] end
+
+    assert_equal 0, @sm.failed_auth_count
+    assert_equal 1, Net::SMTP.deliveries.length
+  end
+
+  def test_deliver_auth_error_twice
+    Net::SMTP.on_start do
+      e = Net::SMTPAuthenticationError.new 'try again'
+      e.set_backtrace %w[one two three]
+      raise e
+    end
+
+    @sm.failed_auth_count = 1
+
+    out, err = util_capture do
+      assert_raise Net::SMTPAuthenticationError do
+        @sm.deliver []
+      end
+    end
+
+    assert_equal 2, @sm.failed_auth_count
+    assert_equal "authentication error, giving up: try again\n", err.string
+  end
+
   def test_deliver_4xx_error
     Net::SMTP.on_send_message do
       e = Net::SMTPSyntaxError.new 'try again'
@@ -422,6 +527,7 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal 1, Email.records.length
     assert_operator now, :>=, Email.records.first.last_send_attempt
     assert_equal 0, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
+    assert_equal [60], @sm.slept
 
     assert_equal '', out.string
     assert_equal "server too busy, sleeping 60 seconds\n", err.string
@@ -522,10 +628,10 @@ Last send attempt: Thu Aug 10 11:40:05 -0700 2006
     assert_equal "found 3 emails to send\n", err.string
   end
 
-  def test_server_settings
+  def test_smtp_settings
     ActionMailer::Base.server_settings[:address] = 'localhost'
 
-    assert_equal 'localhost', @sm.server_settings[:address]
+    assert_equal 'localhost', @sm.smtp_settings[:address]
   end
 
   def nobody

metadata

@@ -1,22 +1,28 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
+rubygems_version: 0.9.4.3
 specification_version: 1
 name: ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
-date: 2007-06-05 00:00:00 -07:00
+  version: 1.3.1
+date: 2007-07-31 00:00:00 -07:00
 summary: A two-phase delivery agent for ActionMailer
 require_paths: 
 - lib
 email: drbrain@segment7.net
 homepage: http://seattlerb.org/ar_mailer
 rubyforge_project: seattlerb
-description: Even deliviring email to the local machine may take too long when you have to send hundreds of messages.  ar_mailer allows you to store messages into the database for later delivery by a separate process, ar_sendmail.
+description: Even delivering email to the local machine may take too long when you have to send hundreds of messages.  ar_mailer allows you to store messages into the database for later delivery by a separate process, ar_sendmail.
 autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
@@ -63,9 +69,9 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.1
+        version: 1.2.2
     version: