ar_mailer 1.0.0

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2006, Eric Hodel, The Robot Co-op.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Manifest.txt

@@ -0,0 +1,10 @@
+LICENSE
+Manifest.txt
+README
+Rakefile
+bin/ar_sendmail
+lib/action_mailer/ar_mailer.rb
+lib/action_mailer/ar_sendmail.rb
+test/action_mailer.rb
+test/test_armailer.rb
+test/test_arsendmail.rb

data/README

@@ -0,0 +1,26 @@
+= ar_mailer
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/rctools
+
+Documentation:
+
+http://dev.robotcoop.com/Libraries/ar_mailer
+
+== About
+
+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.
+
+== Installing ar_mailer
+
+Just install the gem:
+
+  $ sudo gem install ar_mailer
+
+See ActionMailer::ARMailer for instructions on converting to ARMailer.
+
+See ar_sendmail -h for options to ar_sendmail.
+

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$VERBOSE = nil
+
+spec = Gem::Specification.new do |s|
+  s.name = 'ar_mailer'
+  s.version = '1.0.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'
+  s.email = 'eric@robotcoop.com'
+
+  s.has_rdoc = true
+  s.files = File.read('Manifest.txt').split($/)
+  s.require_path = 'lib'
+
+  s.executables = ['ar_sendmail']
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Update Manifest.txt'
+task :update_manifest do
+  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t ar_mailer'
+end
+
+desc 'Generate RDoc for dev.robotcoop.com'
+Rake::RDocTask.new :dev_rdoc do |rd|
+  rd.rdoc_dir = '../../../www/trunk/dev/html/Tools/ar_mailer'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t ar_mailer'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]
+
+# vim: syntax=Ruby

data/bin/ar_sendmail

@@ -0,0 +1,11 @@
+#!/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

@@ -0,0 +1,66 @@
+require 'action_mailer'
+
+##
+# Adds sending email through an ActiveRecord table as a delivery method for
+# ActionMailer.
+#
+# == Converting to ActionMailer::ARMailer
+#
+# Go to your Rails project:
+# 
+#   $ cd your_rails_project
+# 
+# Create a new migration:
+# 
+#   $ ar_sendmail --create-migration
+# 
+# You'll need to redirect this into a file.  If you want a different name
+# provide the --table-name option.
+# 
+# Create a new model:
+# 
+#   $ ar_sendmail --create-model
+# 
+# You'll need to redirect this into a file.  If you want a different name
+# provide the --table-name option.
+# 
+# Change your email classes to inherit from ActionMailer::ARMailer instead of
+# ActionMailer::Base:
+# 
+#   --- app/model/emailer.rb.orig   2006-08-10 13:16:33.000000000 -0700
+#   +++ app/model/emailer.rb        2006-08-10 13:16:43.000000000 -0700
+#   @@ -1,4 +1,4 @@
+#   -class Emailer < ActionMailer::Base
+#   +class Emailer < ActionMailer::ARMailer
+#    
+#   def comment_notification(comment)
+#     from comment.author.email
+# 
+# Edit config/environment/production.rb and set the delivery agent:
+# 
+#   $ ActionMailer::Base.delivery_method = :activerecord
+# 
+# Run ar_sendmail:
+# 
+#   $ ar_sendmail
+# 
+# You can also run it from cron with -o, or as a daemon with -d.
+#
+# See <tt>ar_sendmail -h</tt> for full details.
+
+class ActionMailer::ARMailer < ActionMailer::Base
+
+  ##
+  # Adds +mail+ to the Email table.  Only the first From address for +mail+ is
+  # used.
+
+  def perform_delivery_activerecord(mail)
+    mail.destinations.each do |destination|
+      Email.create :mail => mail.encoded,
+                   :to => destination,
+                   :from => mail.from.first
+    end
+  end
+
+end
+

data/lib/action_mailer/ar_sendmail.rb

@@ -0,0 +1,351 @@
+require 'optparse'
+require 'rubygems'
+require 'action_mailer'
+
+class Object # :nodoc:
+  unless respond_to? :path2class then
+    def self.path2class(path)
+      path.split(/::/).inject self do |k,n| k.const_get n end
+    end
+  end
+end
+
+##
+# ActionMailer::ARSendmail delivers email from the email table to the
+# configured SMTP server.
+#
+# See ar_sendmail -h for the full list of supported options.
+#
+# The interesting options are:
+# * --daemon
+# * --mailq
+# * --create-migration
+# * --create-model
+# * --table-name
+
+class ActionMailer::ARSendmail
+
+  ##
+  # Email delivery attempts per run
+
+  attr_accessor :batch_size
+
+  ##
+  # Seconds to delay between runs
+
+  attr_accessor :delay
+
+  ##
+  # Be verbose
+
+  attr_accessor :verbose
+
+  ##
+  # ActiveRecord class that holds emails
+
+  attr_reader :email_class
+
+  ##
+  # True if only one delivery attempt will be made per call to run
+
+  attr_reader :once
+
+  ##
+  # Creates a new migration using +table_name+ and prints it on $stdout.
+
+  def self.create_migration(table_name)
+    migration = <<-EOF
+class Add#{table_name.classify} < ActiveRecord::Migration
+  def self.up
+    create_table :#{table_name.tableize} do |t|
+      t.column :from, :string
+      t.column :to, :string
+      t.column :last_send_attempt, :integer, :default => 0
+      t.column :mail, :text
+    end
+  end
+
+  def self.down
+    drop_table :email
+  end
+end
+    EOF
+
+    $stdout.puts migration
+  end
+
+  ##
+  # Creates a new model using +table_name+ and prints it on $stdout.
+
+  def self.create_model(table_name)
+    model = <<-EOF
+class #{table_name.classify} < ActiveRecord::Base
+end
+    EOF
+
+    $stdout.puts model
+  end
+
+  ##
+  # Prints a list of unsent emails and the last delivery attempt, if any.
+  #
+  # If ActiveRecord::Timestamp is not being used the arrival time will not be
+  # known.  See http://api.rubyonrails.org/classes/ActiveRecord/Timestamp.html
+  # to learn how to enable ActiveRecord::Timestamp.
+
+  def self.mailq
+    emails = Email.find :all
+
+    if emails.empty? then
+      $stdout.puts "Mail queue is empty"
+      return
+    end
+
+    total_size = 0
+
+    $stdout.puts "-Queue ID- --Size-- ----Arrival Time---- -Sender/Recipient-------"
+    emails.each do |email|
+      size = email.mail.length
+      total_size += size
+
+      create_timestamp = email.created_at rescue
+                         email.created_on rescue
+                         Time.at(email.created_date) rescue # for Robot Co-op
+                         nil
+
+      created = if create_timestamp.nil? then
+                  '             Unknown'
+                else
+                  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}"
+      end
+      $stdout.puts "                                         #{email.to}"
+      $stdout.puts
+    end
+
+    $stdout.puts "-- #{total_size/1024} Kbytes in #{emails.length} Requests."
+  end
+
+  ##
+  # Processes command line options in +args+
+
+  def self.process_args(args)
+    name = File.basename $0
+
+    options = {}
+    options[:Daemon] = false
+    options[:Delay] = 60
+    options[:Once] = false
+    options[:TableName] = 'Email'
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{name} [options]"
+      opts.separator ''
+
+      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 ''
+      opts.separator 'Sendmail options:'
+
+      opts.on("-b", "--batch-size BATCH_SIZE",
+              "Maximum number of emails to send per delay",
+              "Default: Deliver all available emails", Integer) do |batch_size|
+        options[:BatchSize] = batch_size
+      end
+
+      opts.on(      "--delay DELAY",
+              "Delay between checks for new mail",
+              "in the database",
+              "Default: #{options[:Delay]}", Integer) do |delay|
+        options[:Delay] = delay
+      end
+
+      opts.on("-o", "--once",
+              "Only check for new mail and deliver once",
+              "Default: #{options[:Once]}") do |once|
+        options[:Once] = once
+      end
+
+      opts.on("-d", "--daemonize",
+              "Run as a daemon process",
+              "Default: #{options[:Daemon]}") do |daemon|
+        options[:Daemon] = true
+      end
+
+      opts.on(      "--mailq",
+              "Display a list of emails waiting to be sent") do |mailq|
+        options[:MailQ] = true
+      end
+
+      opts.separator ''
+      opts.separator 'Setup Options:'
+
+      opts.on(      "--create-migration",
+              "Prints a migration to add an Email table",
+              "to $stdout") do |create|
+        options[:Migrate] = true
+      end
+
+      opts.on(      "--create-model",
+              "Prints a model for an Email ActiveRecord",
+              "object to $stdout") do |create|
+        options[:Model] = true
+      end
+
+      opts.separator ''
+      opts.separator 'Generic Options:'
+
+      opts.on("-t", "--table-name TABLE_NAME",
+              "Name of table holding emails",
+              "Used for both sendmail and",
+              "migration creation",
+              "Default: #{options[:TableName]}") do |name|
+        options[:TableName] = name
+      end
+
+      opts.on("-v", "--[no-]verbose",
+              "Be verbose",
+              "Default: #{options[:Verbose]}") do |verbose|
+        options[:Verbose] = verbose
+      end
+
+      opts.on("-h", "--help",
+              "You're looking at it") do
+        $stderr.puts opts
+        exit 1
+      end
+
+      opts.separator ''
+    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
+    end
+
+    return options
+  end
+
+  ##
+  # Processes +args+ and runs as appropriate
+
+  def self.run(args = ARGV)
+    options = process_args args
+
+    if options.include? :Migrate then
+      create_migration options[:TableName]
+      exit
+    elsif options.include? :Model then
+      create_model options[:TableName]
+      exit
+    elsif options.include? :Mailq then
+      mailq
+      exit
+    end
+
+    if options[:Daemon] then
+      require 'webrick/server'
+      WEBrick::Daemon.start
+    end
+
+    new(options).run
+  end
+
+  ##
+  # Creates a new ARSendmail.
+  #
+  # Valid options are:
+  # <tt>:BatchSize</tt>:: Maximum number of emails to send per delay
+  # <tt>:Delay</tt>:: Delay between deliver attempts
+  # <tt>:TableName</tt>:: Table name that stores the emails
+  # <tt>:Once</tt>:: Only attempt to deliver emails once when run is called
+  # <tt>:Verbose</tt>:: Be verbose.
+
+  def initialize(options = {})
+    options[:Delay] ||= 60
+    options[:TableName] ||= 'Email'
+
+    @batch_size = options[:BatchSize]
+    @delay = options[:Delay]
+    @email_class = Object.path2class options[:TableName]
+    @once = options[:Once]
+    @verbose = options[:Verbose]
+  end
+
+  ##
+  # Delivers +emails+ to ActionMailer's SMTP server and destroys them.
+
+  def deliver(emails)
+    Net::SMTP.start server_settings[:address], server_settings[:port],
+                    server_settings[:domain], server_settings[:user],
+                    server_settings[:password],
+                    server_settings[:authentication] do |smtp|
+      emails.each do |email|
+        begin
+          res = smtp.send_message email.mail, email.to, email.from
+          email.destroy
+          log "sent email from %s to %s: %p" % [email.from, email.to, res]
+        rescue Net::SMTPServerBusy, Net::SMTPFatalError,
+               Net::SMTPUnknownError, TimeoutError
+          email.last_send_attempt = Time.now.to_i
+        end
+      end
+    end
+  end
+
+  ##
+  # Returns emails in email_class that haven't had a delivery attempt in the
+  # last 300 seconds.
+
+  def find_emails
+    options = { :conditions => ['last_send_attempt < ?', Time.now.to_i - 300] }
+    options[:limit] = batch_size unless batch_size.nil?
+    mail = @email_class.find :all, options
+
+    log "found #{mail.length} emails to send"
+    mail
+  end
+
+  ##
+  # Logs +message+ if verbose
+
+  def log(message)
+    $stderr.puts message if @verbose
+    ActionMailer::Base.logger.info "ar_sendmail: #{message}"
+  end
+
+  ##
+  # Scans for emails and delivers them every delay seconds.  Only returns if
+  # once is true.
+
+  def run
+    loop do
+      deliver find_emails
+      break if @once
+      sleep @delay
+    end
+  end
+
+  ##
+  # Proxy to ActionMailer::Base#server_settings.  See
+  # http://api.rubyonrails.org/classes/ActionMailer/Base.html
+  # for instructions on how to configure ActionMailer's SMTP server.
+
+  def server_settings
+    ActionMailer::Base.server_settings
+  end
+
+end
+

data/test/action_mailer.rb

@@ -0,0 +1,131 @@
+require 'net/smtp'
+require 'time'
+
+class Net::SMTP
+
+  @deliveries = []
+
+  @send_message_block = nil
+
+  class << self
+
+    attr_reader :deliveries
+    attr_reader :send_message_block
+
+    alias old_start start
+
+  end
+
+  def self.start(*args)
+    yield new(nil)
+  end
+
+  def self.on_send_message(&block)
+    @send_message_block = block
+  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]
+  end
+
+end
+
+##
+# Stub for ActionMailer::Base
+
+module ActionMailer; end
+
+class ActionMailer::Base
+
+  @server_settings = {}
+
+  def self.logger
+    o = Object.new
+    def o.info(arg) end
+    return o
+  end
+
+  def self.method_missing(meth, *args)
+    meth.to_s =~ /deliver_(.*)/
+    super unless $1
+    new($1, *args).deliver!
+  end
+
+  def self.server_settings
+    @server_settings
+  end
+
+  def initialize(meth = nil)
+    send meth if meth
+  end
+
+  def deliver!
+    perform_delivery_activerecord @mail
+  end
+
+end
+
+##
+# Stub for an ActiveRecord model
+
+class Email
+
+  START = Time.parse 'Thu Aug 10 11:19:48'
+
+  attr_accessor :from, :to, :mail, :last_send_attempt, :created_on, :id
+
+  @records = []
+  @id = 0
+
+  class << self; attr_accessor :records, :id; end
+
+  def self.create(record)
+    record = new record[:from], record[:to], record[:mail]
+    records << record
+    return record
+  end
+
+  def self.find(_, conditions = nil)
+    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
+    end
+  end
+
+  def initialize(from, to, mail)
+    @from = from
+    @to = to
+    @mail = mail
+    @id = self.class.id += 1
+    @created_on = START + @id
+  end
+
+  def destroy
+    self.class.records.delete self
+    self.freeze
+  end
+
+  def ==(other)
+    other.from == from and
+    other.to == to and
+    other.mail == mail
+  end
+
+end
+
+class String
+  def classify
+    self
+  end
+
+  def tableize
+    self.downcase
+  end
+
+end
+

data/test/test_armailer.rb

@@ -0,0 +1,39 @@
+require 'test/unit'
+require 'action_mailer'
+require 'action_mailer/ar_mailer'
+
+##
+# Pretend mailer
+
+class Mailer < ActionMailer::ARMailer
+
+  def mail
+    @mail = Object.new
+    def @mail.encoded() 'email' end
+    def @mail.from() ['nobody@example.com'] end
+    def @mail.destinations() %w[user1@example.com user2@example.com] end
+  end
+
+end
+
+class TestARMailer < Test::Unit::TestCase
+
+  def setup
+    Email.records.clear
+  end
+
+  def test_perform_delivery_activerecord
+    Mailer.deliver_mail
+
+    assert_equal 2, Email.records.length
+
+    record = Email.records.first
+    assert_equal 'email', record.mail
+    assert_equal 'user1@example.com', record.to
+    assert_equal 'nobody@example.com', record.from
+
+    assert_equal 'user2@example.com', Email.records.last.to
+  end
+
+end
+

data/test/test_arsendmail.rb

@@ -0,0 +1,367 @@
+require 'test/unit'
+require 'action_mailer'
+require 'action_mailer/ar_sendmail'
+require 'rubygems'
+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
+
+    @sm = ActionMailer::ARSendmail.new
+
+    @include_c_e = ! $".grep(/config\/environment.rb/).empty?
+    $" << 'config/environment.rb' unless @include_c_e
+  end
+
+  def teardown
+    $".delete 'config/environment.rb' unless @include_c_e
+  end
+
+  def test_class_create_migration
+    out, = util_capture do
+      ActionMailer::ARSendmail.create_migration 'Email'
+    end
+
+    expected = <<-EOF
+class AddEmail < ActiveRecord::Migration
+  def self.up
+    create_table :email do |t|
+      t.column :from, :string
+      t.column :to, :string
+      t.column :last_send_attempt, :integer, :default => 0
+      t.column :mail, :text
+    end
+  end
+
+  def self.down
+    drop_table :email
+  end
+end
+    EOF
+
+    assert_equal expected, out.string
+  end
+
+  def test_class_create_migration_table_name
+    out, = util_capture do
+      ActionMailer::ARSendmail.create_migration 'Mail'
+    end
+
+    expected = <<-EOF
+class AddMail < ActiveRecord::Migration
+  def self.up
+    create_table :mail do |t|
+      t.column :from, :string
+      t.column :to, :string
+      t.column :last_send_attempt, :integer, :default => 0
+      t.column :mail, :text
+    end
+  end
+
+  def self.down
+    drop_table :email
+  end
+end
+    EOF
+
+    assert_equal expected, out.string
+  end
+
+  def test_class_create_model
+    out, = util_capture do
+      ActionMailer::ARSendmail.create_model 'Email'
+    end
+
+    expected = <<-EOF
+class Email < ActiveRecord::Base
+end
+    EOF
+
+    assert_equal expected, out.string
+  end
+
+  def test_class_create_model_table_name
+    out, = util_capture do
+      ActionMailer::ARSendmail.create_model 'Mail'
+    end
+
+    expected = <<-EOF
+class Mail < ActiveRecord::Base
+end
+    EOF
+
+    assert_equal expected, out.string
+  end
+
+  def test_class_mailq
+    Email.create :from => nobody, :to => 'recip@h1.example.com',
+                 :mail => 'body0'
+    Email.create :from => nobody, :to => 'recip@h1.example.com',
+                 :mail => 'body1'
+    last = Email.create :from => nobody, :to => 'recip@h2.example.com',
+                        :mail => 'body2'
+
+    last.last_send_attempt = Time.parse 'Thu Aug 10 11:40:05'
+
+    out, err = util_capture do
+      ActionMailer::ARSendmail.mailq
+    end
+
+    expected = <<-EOF
+-Queue ID- --Size-- ----Arrival Time---- -Sender/Recipient-------
+         1        5 Thu Aug 10 11:19:49  nobody@example.com
+                                         recip@h1.example.com
+
+         2        5 Thu Aug 10 11:19:50  nobody@example.com
+                                         recip@h1.example.com
+
+         3        5 Thu Aug 10 11:19:51  nobody@example.com
+Last send attempt: Thu Aug 10 11:40:05 -0700 2006
+                                         recip@h2.example.com
+
+-- 0 Kbytes in 3 Requests.
+    EOF
+
+    assert_equal expected, out.string
+  end
+
+  def test_class_mailq_empty
+    out, err = util_capture do
+      ActionMailer::ARSendmail.mailq
+    end
+
+    assert_equal "Mail queue is empty\n", out.string
+  end
+
+  def test_class_new
+    assert_equal 60, @sm.delay
+    assert_equal Email, @sm.email_class
+    assert_equal nil, @sm.once
+    assert_equal nil, @sm.verbose
+    assert_equal nil, @sm.batch_size
+
+    @sm = ActionMailer::ARSendmail.new :Delay => 75, :Verbose => true,
+                                       :TableName => 'Object', :Once => true,
+                                       :BatchSize => 1000
+
+    assert_equal 75, @sm.delay
+    assert_equal Object, @sm.email_class
+    assert_equal true, @sm.once
+    assert_equal true, @sm.verbose
+    assert_equal 1000, @sm.batch_size
+  end
+
+  def test_class_parse_args_batch_size
+    options = ActionMailer::ARSendmail.process_args %w[-b 500]
+
+    assert_equal 500, options[:BatchSize]
+
+    options = ActionMailer::ARSendmail.process_args %w[--batch-size 500]
+
+    assert_equal 500, options[:BatchSize]
+  end
+
+  def test_class_parse_args_daemon
+    argv = %w[-d]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal true, options[:Daemon]
+
+    argv = %w[--daemon]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal true, options[:Daemon]
+  end
+
+  def test_class_parse_args_delay
+    argv = %w[--delay 75]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal 75, options[:Delay]
+  end
+
+  def test_class_parse_args_mailq
+    options = ActionMailer::ARSendmail.process_args []
+    deny_includes options, :MailQ
+
+    argv = %w[--mailq]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal true, options[:MailQ]
+  end
+
+  def test_class_parse_args_migration
+    options = ActionMailer::ARSendmail.process_args []
+    deny_includes options, :Migrate
+
+    argv = %w[--create-migration]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal true, options[:Migrate]
+  end
+
+  def test_class_parse_args_model
+    options = ActionMailer::ARSendmail.process_args []
+    deny_includes options, :Model
+
+    argv = %w[--create-model]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal true, options[:Model]
+  end
+
+  def test_class_parse_args_no_config_environment
+    $".delete 'config/environment.rb'
+
+    assert_raise SystemExit do
+      out, err = util_capture do
+        ActionMailer::ARSendmail.process_args []
+      end
+    end
+
+  ensure
+    $" << 'config/environment.rb' if @include_c_e
+  end
+
+  def test_class_parse_args_no_config_environment_migrate
+    $".delete 'config/environment.rb'
+
+    out, err = util_capture do
+      ActionMailer::ARSendmail.process_args %w[--create-migration]
+    end
+
+    assert true # count
+
+  ensure
+    $" << 'config/environment.rb' if @include_c_e
+  end
+
+  def test_class_parse_args_no_config_environment_model
+    $".delete 'config/environment.rb'
+
+    out, err = util_capture do
+      ActionMailer::ARSendmail.process_args %w[--create-model]
+    end
+
+    assert true # count
+
+  rescue SystemExit
+    flunk 'Should not exit'
+
+  ensure
+    $" << 'config/environment.rb' if @include_c_e
+  end
+
+  def test_class_parse_args_once
+    argv = %w[-o]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal true, options[:Once]
+
+    argv = %w[--once]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal true, options[:Once]
+  end
+
+  def test_class_parse_args_table_name
+    argv = %w[-t Email]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal 'Email', options[:TableName]
+
+    argv = %w[--table-name=Email]
+    
+    options = ActionMailer::ARSendmail.process_args argv
+
+    assert_equal 'Email', options[:TableName]
+  end
+
+  def test_deliver
+    email = Email.create :mail => 'body', :to => 'to', :from => 'from'
+
+    @sm.deliver [email]
+
+    assert_equal 1, Net::SMTP.deliveries.length
+    assert_equal ['body', 'to', 'from'], Net::SMTP.deliveries.first
+    assert_equal 0, Email.records.length
+  end
+
+  def test_deliver_500
+    Net::SMTP.on_send_message do
+      raise Net::SMTPServerBusy
+    end
+
+    now = Time.now.to_i
+
+    email = Email.create :mail => 'body', :to => 'to', :from => 'from'
+
+    @sm.deliver [email]
+
+    assert_equal 0, Net::SMTP.deliveries.length
+    assert_equal 1, Email.records.length
+    assert_operator now, :<=, Email.records.first.last_send_attempt
+  end
+
+  def test_log
+    @sm = ActionMailer::ARSendmail.new :Verbose => true
+
+    out, err = util_capture do
+      @sm.log 'hi'
+    end
+
+    assert_equal "hi\n", err.string
+  end
+
+  def test_find_emails
+    emails = [
+      { :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
+
+    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
+
+    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'),
+    ]
+
+    assert_equal expected, found_emails
+  end
+
+  def test_server_settings
+    ActionMailer::Base.server_settings[:address] = 'localhost'
+
+    assert_equal 'localhost', @sm.server_settings[:address]
+  end
+
+  def nobody
+    'nobody@example.com'
+  end
+
+end
+

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.99
+specification_version: 1
+name: ar_mailer
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-08-10 00:00:00 -07:00
+summary: A two-phase deliver agent for ActionMailer
+require_paths: 
+- lib
+email: eric@robotcoop.com
+homepage: 
+rubyforge_project: 
+description: Queues emails from ActionMailer in the database and uses a separate process to send them.  Reduces sending overhead when sending hundreds of emails.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Eric Hodel
+files: 
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- bin/ar_sendmail
+- lib/action_mailer/ar_mailer.rb
+- lib/action_mailer/ar_sendmail.rb
+- test/action_mailer.rb
+- test/test_armailer.rb
+- test/test_arsendmail.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- ar_sendmail
+extensions: []
+
+requirements: []
+
+dependencies: []
+