README.rdoc generators/ar_mailer/ar_mailer_generator.rb generators/ar_mailer/templates/migration.rb generators/ar_mailer/templates/model.rb test/resources/action_mailer.rb test/test_helper.rb @@ -1,3 +1,57 @@ += 2.1.5 + +* Bugs fixed + * Load ar_mailer after environment to fix issue with lazy loading of ActionMailer in Rails 2.3 + += 2.1.4 + +* Bugs fixed + * Explicitly require ar_mailer in ar_sendmail because its not getting loaded by the Rails environment for some reason + += 2.1.3 + +* Tests now pass on gem install +* Removed deprecated ActionMailer::ARMailer class +* Bugs fixed + * Fixed issue with pre-loading ActionMailer. No use ActionMailer::Base.email_class directly rather than store in ARSendmail instance var so no need to pre-load ActionMailer. + += 2.1.2 + +* Bugs fixed + * Require ar_mailer in ar_sendmail since the change to remove TableName and use email_class + += 2.1.1 + + * Force gem rebuild + += 2.1.0 + +* Switched to using a Rails generator for migration and model files. The ar_sendmail options have been removed. + += 2.0.2 + +* Removed TableName option from ar_sendmail options as its redundant. The Rails environment gets loaded so the settings for email class also get loaded +* Bugs fixed + * Email class reloading issue in development mode causing AR email class defaults to be lost when cached + += 2.0.1 + +* Added option to use smtp setting of :tls => false to disable TLS auto start in Ruby 1.8.7+ +* Removed some cruft which can be handled by ActiveSupport + += 2.0.0 + +* Removed need to use ARMailer subclass. Just set the delivery method and you are ready to go. Backwards compatible with a deprecation notice if you subclass old ARMailer class. +* Only include SMTP TLS patch if Ruby version < 1.8.7 as it has an alternative. Changes based on Calvin Yu's [cyu] fork. +* Renamed default migration name to the modern Rails default +* Only authenticate if emails waiting to be sent +* Added --version switch to ar_sendmail binary +* Created a lighthouse account for this project (adzap fork only). See README. + += 1.4.4 + +* Exit init.d script with message if no mailers defined. + = 1.4.3 * Bugs fixed History.txt @@ -11,20 +11,18 @@ ar_mailer_gemspec = Gem::Specification.new do |s| s.name = %q{ar_mailer} s.version = ActionMailer::ARSendmail::VERSION s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= - s.authors = ["Eric Hodel"] - s.date = %q{2008-07-04} + s.authors = ["Eric Hodel", "Adam Meehan"] s.default_executable = %q{ar_sendmail} s.description = %q{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.} - s.email = %q{drbrain@segment7.net} + s.email = %q{adam.meehan@gmail.com} 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/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.extra_rdoc_files = ["History.txt", "LICENSE.txt", "README.rdoc"] + s.files = ["History.txt", "LICENSE.txt", "README.rdoc", "Rakefile", "bin/ar_sendmail", "generators/ar_mailer/ar_mailer_generator.rb", "generators/ar_mailer/templates/migration.rb", "generators/ar_mailer/templates/model.rb", "lib/action_mailer/ar_mailer.rb", "lib/action_mailer/ar_sendmail.rb", "lib/smtp_tls.rb", "lib/ar_sendmail_logger.rb", "share/bsd/ar_sendmail", "share/linux/ar_sendmail", "share/linux/ar_sendmail.conf", "test/resources/action_mailer.rb", "test/test_armailer.rb", "test/test_arsendmail.rb", "test/test_helper.rb"] s.has_rdoc = true - s.homepage = %q{http://seattlerb.org/ar_mailer} - s.rdoc_options = ["--main", "README.txt"] + s.homepage = %q{http://github.com/adzap/ar_mailer} + s.rdoc_options = ["--main", "README.rdoc"] s.require_paths = ["lib"] s.rubyforge_project = %q{seattlerb} - s.rubygems_version = %q{1.2.0} s.summary = %q{A two-phase delivery agent for ActionMailer} s.test_files = ["test/test_armailer.rb", "test/test_arsendmail.rb"] end @@ -33,20 +31,16 @@ Rake::GemPackageTask.new(ar_mailer_gemspec) do |pkg| pkg.gem_spec = ar_mailer_gemspec end -namespace :gem do - namespace :spec do - desc "Update ar_mailer.gemspec" - task :generate do - File.open("ar_mailer.gemspec", "w") do |f| - f.puts(ar_mailer_gemspec.to_ruby) - end - end +desc "Update ar_mailer.gemspec" +task :make_spec do + File.open("ar_mailer.gemspec", "w") do |f| + f.puts(ar_mailer_gemspec.to_ruby) end end desc "Build packages and install" task :install => :package do - sh %{sudo gem install --local pkg/ar_mailer-#{ActionMailer::ARSendmail::VERSION}} + sh %{sudo gem install --local --test pkg/ar_mailer-#{ActionMailer::ARSendmail::VERSION}} end desc 'Default: run unit tests.' @@ -55,6 +49,6 @@ task :default => :test desc 'Test the ar_mailer gem.' Rake::TestTask.new(:test) do |t| t.libs << 'lib' << 'test' - t.pattern = 'test/**/test_*.rb' + t.test_files = FileList['test/**/test_*.rb'].exclude("test/test_helper.rb") t.verbose = true end Rakefile @@ -1,30 +1,31 @@ -Gem::Specification.new do |s| +# -*- encoding: utf-8 -*- + +Gem::Specification.new do |s| s.name = %q{ar_mailer} - s.version = "1.4.6" + s.version = "2.1.5" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= - s.authors = ["Eric Hodel"] - s.date = %q{2008-07-04} + s.authors = ["Eric Hodel", "Adam Meehan"] + s.date = %q{2009-07-06} s.default_executable = %q{ar_sendmail} s.description = %q{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.} - s.email = %q{drbrain@segment7.net} + s.email = %q{adam.meehan@gmail.com} 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/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"] + s.extra_rdoc_files = ["History.txt", "LICENSE.txt", "README.rdoc"] + s.files = ["History.txt", "LICENSE.txt", "README.rdoc", "Rakefile", "bin/ar_sendmail", "generators/ar_mailer/ar_mailer_generator.rb", "generators/ar_mailer/templates/migration.rb", "generators/ar_mailer/templates/model.rb", "lib/action_mailer/ar_mailer.rb", "lib/action_mailer/ar_sendmail.rb", "lib/smtp_tls.rb", "lib/ar_sendmail_logger.rb", "share/bsd/ar_sendmail", "share/linux/ar_sendmail", "share/linux/ar_sendmail.conf", "test/resources/action_mailer.rb", "test/test_armailer.rb", "test/test_arsendmail.rb", "test/test_helper.rb"] + s.homepage = %q{http://github.com/adzap/ar_mailer} + s.rdoc_options = ["--main", "README.rdoc"] s.require_paths = ["lib"] s.rubyforge_project = %q{seattlerb} - s.rubygems_version = %q{1.2.0} + s.rubygems_version = %q{1.3.4} s.summary = %q{A two-phase delivery agent for ActionMailer} s.test_files = ["test/test_armailer.rb", "test/test_arsendmail.rb"] if s.respond_to? :specification_version then current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION - s.specification_version = 2 + s.specification_version = 3 - if current_version >= 3 then + if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then else end else ar_mailer.gemspec @@ -1,111 +1,31 @@ -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 -# -# You'll need to be sure to set the From address for your emails. Something -# like: -# -# def list_send(recipient) -# from 'no_reply@example.com' -# # ... -# -# Edit config/environment.rb and require ar_mailer.rb: -# -# require 'action_mailer/ar_mailer' -# -# Edit config/environments/production.rb and set the delivery agent: -# -# $ grep delivery_method config/environments/production.rb -# 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. -# -# == Alternate Mail Storage -# -# If you want to set the ActiveRecord model that emails will be stored in, -# see ActionMailer::ARMailer::email_class= - -class ActionMailer::ARMailer < ActionMailer::Base - - @@email_class = Email - ## - # Current email class for deliveries. - - def self.email_class - @@email_class - end +class ActionMailer::Base ## - # Sets the email class for deliveries. + # Set the email class for deliveries. Handle class reloading issues which prevents caching the email class. + # + @@email_class_name = 'Email' def self.email_class=(klass) - @@email_class = klass + @@email_class_name = klass.to_s end - @@context_header = 'X-Delivery-Context' - - def self.context_header - @@context_header + def self.email_class + @@email_class_name.constantize end - + ## # 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| - # If the email has the context header set, assume that the caller added a context column - if @@context_header && mail.header_string(@@context_header) - @@email_class.create( - :mail => mail.encoded, :to => destination, - :from => mail.from.first, :context => mail.header_string(@@context_header) - ) - else - @@email_class.create(:mail => mail.encoded, :to => destination, :from => mail.from.first) - end + self.class.email_class.create :mail => mail.encoded, :to => destination, :from => mail.from.first end end end - lib/action_mailer/ar_mailer.rb @@ -1,17 +1,9 @@ require 'optparse' require 'net/smtp' -require 'smtp_tls' +require 'smtp_tls' unless Net::SMTP.instance_methods.include?("enable_starttls_auto") require 'ar_sendmail_logger' require 'rubygems' -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 - ## # Hack in RSET @@ -30,8 +22,6 @@ class SMTP # :nodoc: end end -module ActionMailer; end # :nodoc: - ## # ActionMailer::ARSendmail delivers email from the email table to the # SMTP server configured in your application's config/environment.rb. @@ -46,16 +36,15 @@ module ActionMailer; end # :nodoc: # The interesting options are: # * --daemon # * --mailq -# * --create-migration -# * --create-model -# * --table-name + +module ActionMailer; end class ActionMailer::ARSendmail ## # The version of ActionMailer::ARSendmail you are running. - VERSION = '1.4.6' + VERSION = '2.1.5' ## # Maximum number of times authentication will be consecutively retried @@ -81,13 +70,7 @@ class ActionMailer::ARSendmail # Be verbose attr_accessor :verbose - - ## - # 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 @@ -98,6 +81,11 @@ class ActionMailer::ARSendmail # Times authentication has failed attr_accessor :failed_auth_count + + ## + # Logs the value of this header for successfully sent emails + + attr_accessor :log_header @@pid_file = nil @@ -110,50 +98,14 @@ class ActionMailer::ARSendmail end ## - # Creates a new migration using +table_name+ and prints it on stdout. - - def self.create_migration(table_name) - require 'active_support' - puts <<-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 - t.column :created_on, :datetime - end - end - - def self.down - drop_table :#{table_name.tableize} - end -end - EOF - end - - ## - # Creates a new model using +table_name+ and prints it on stdout. - - def self.create_model(table_name) - require 'active_support' - puts <<-EOF -class #{table_name.classify} < ActiveRecord::Base -end - EOF - 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(table_name) - klass = table_name.split('::').inject(Object) { |k,n| k.const_get n } - emails = klass.find :all + def self.mailq + emails = ActionMailer::Base.email_class.find :all if emails.empty? then puts "Mail queue is empty" @@ -202,9 +154,7 @@ end options[:MaxAge] = 86400 * 7 options[:Once] = false 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]" @@ -257,12 +207,6 @@ 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 @@ -271,18 +215,6 @@ 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:' @@ -294,20 +226,23 @@ end options[:Chdir] = path end + opts.on( "--log-file PATH_AND_FILE", + "Full path to the file the mailer should log to", + "Default: RAILS_ROOT/log/RAILS_ENV.log") do |log_file| + options[:LogFile] = log_file + end + + opts.on( "--log-header SOME_HEADER", + "Logs the value of the specified header once an email gets sent") do |header| + options[:LogHeader] = header + 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", - "migration creation", - "Default: #{options[:TableName]}") do |name| - options[:TableName] = name - end - opts.on("-v", "--[no-]verbose", "Be verbose", "Default: #{options[:Verbose]}") do |verbose| @@ -319,23 +254,26 @@ end usage opts end + opts.on("--version", "Version of ARMailer") do + usage "ar_mailer #{VERSION} (adzap fork)" + end + opts.separator '' end opts.parse! args - return options if options.include? :Migrate or options.include? :Model - ENV['RAILS_ENV'] = options[:RailsEnv] Dir.chdir options[:Chdir] do begin require 'config/environment' + require 'action_mailer/ar_mailer' 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 + EOF end end @@ -348,14 +286,8 @@ end 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 options[:TableName] + if options.include? :MailQ then + mailq exit end @@ -410,24 +342,22 @@ end # 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' 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] - + @log_header = options[:LogHeader] + @failed_auth_count = 0 - @logger = ArSendmailLogger.new(options[:LogFile] || options[:Chdir] + '/log/ar_sendmail.log') + @logger = options[:LogFile] ? ARSendmailLogger.new(options[:LogFile]) : ActionMailer::Base.logger end ## @@ -438,7 +368,7 @@ end 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 + mail = ActionMailer::Base.email_class.destroy_all conditions log "expired #{mail.length} emails from the queue" end @@ -447,29 +377,40 @@ end # Delivers +emails+ to ActionMailer's SMTP server and destroys them. def deliver(emails) - return if emails.empty? - 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| + settings = [ + smtp_settings[:domain], + (smtp_settings[:user] || smtp_settings[:user_name]), + smtp_settings[:password], + smtp_settings[:authentication] + ] + + smtp = Net::SMTP.new(smtp_settings[:address], smtp_settings[:port]) + if smtp.respond_to?(:enable_starttls_auto) + smtp.enable_starttls_auto unless smtp_settings[:tls] == false + else + settings << smtp_settings[:tls] + end + + smtp.start(*settings) do |session| @failed_auth_count = 0 until emails.empty? do email = emails.shift begin - res = smtp.send_message email.mail, email.from, email.to - email.destroy - 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] + res = session.send_message email.mail, email.from, email.to + hdr = '' + + if @log_header && email.mail =~ /#{@log_header}: (.+)/ + hdr = "[#{$1.chomp}] " end + + email.destroy + log "sent email %011d %sfrom %s to %s: %p" % + [email.id, hdr, 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 + session.reset rescue Net::SMTPServerBusy => e log "server too busy, sleeping #{@delay} seconds" sleep delay @@ -479,7 +420,7 @@ end 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 + session.reset end end end @@ -512,7 +453,7 @@ end 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 + mail = ActionMailer::Base.email_class.find :all, options log "found #{mail.length} emails to send" mail @@ -532,7 +473,7 @@ end def log(message) message = "ar_sendmail #{Time.now}: #{message}" $stderr.puts message if @verbose - logger.info(message) + @logger.info message end ## @@ -546,7 +487,8 @@ end now = Time.now begin cleanup - deliver find_emails + emails = find_emails + deliver(emails) unless emails.empty? rescue ActiveRecord::Transactions::TransactionError end break if @once @@ -567,4 +509,3 @@ end end end - lib/action_mailer/ar_sendmail.rb @@ -1,6 +1,11 @@ require 'logger' -class ArSendmailLogger < ::Logger +class ARSendmailLogger < ::Logger + + def initialize(path) + FileUtils.mkdir_p(File.dirname(path)) + super(path) + end def format_message(severity, timestamp, progname, message) "#{message}\n" lib/ar_sendmail_logger.rb @@ -11,7 +11,11 @@ require 'yaml' config_file = '/etc/ar_sendmail.conf' begin - config = YAML::load(IO.read(config_file)) + config = YAML::load(IO.read(config_file)) || {} + if config.empty? || (config.has_key?('defaults') && config.size == 1) + puts "No mailers defined. Exiting." + exit + end rescue Errno::ENOENT puts "Config file not found at '#{config_file}'!" exit @@ -30,8 +34,7 @@ def start(app, options) end def stop(app, options) - path = options['chdir'] - pid_file = File.expand_path(options['pidfile'], path) + pid_file = File.expand_path(options['pidfile'], options['chdir']) if File.exist? pid_file begin pid = open(pid_file).read.to_i share/linux/ar_sendmail @@ -1,20 +1,13 @@ -require 'test/unit' -require 'action_mailer' -require 'action_mailer/ar_mailer' +require File.expand_path(File.dirname(__FILE__) + '/test_helper') -## -# Pretend mailer - -class Mailer < ActionMailer::ARMailer +class Mailer < ActionMailer::Base + self.delivery_method = :activerecord 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 - def @mail.header_string(header_name, default = nil) - default - end end end @@ -25,15 +18,15 @@ class TestARMailer < Test::Unit::TestCase Mailer.email_class = Email Email.records.clear - Mail.records.clear + Newsletter.records.clear end def test_self_email_class_equals - Mailer.email_class = Mail + Mailer.email_class = Newsletter Mailer.deliver_mail - assert_equal 2, Mail.records.length + assert_equal 2, Newsletter.records.length end def test_perform_delivery_activerecord test/test_armailer.rb @@ -1,8 +1,4 @@ -require 'test/unit' -require 'action_mailer' -require 'action_mailer/ar_sendmail' -require 'rubygems' -require 'test/zentest_assertions' +require File.expand_path(File.dirname(__FILE__) + '/test_helper') class ActionMailer::ARSendmail attr_accessor :slept @@ -12,7 +8,7 @@ class ActionMailer::ARSendmail end end -class TestARSendmail < Test::Unit::TestCase +class TestARSendmail < MiniTest::Unit::TestCase def setup ActionMailer::Base.reset @@ -22,6 +18,8 @@ class TestARSendmail < Test::Unit::TestCase @sm = ActionMailer::ARSendmail.new @sm.verbose = true + Net::SMTP.clear_on_start + @include_c_e = ! $".grep(/config\/environment.rb/).empty? $" << 'config/environment.rb' unless @include_c_e end @@ -30,43 +28,8 @@ class TestARSendmail < Test::Unit::TestCase $".delete 'config/environment.rb' unless @include_c_e end - def test_class_create_migration - 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 - t.column :created_on, :datetime - end - end - - def self.down - drop_table :mail - end -end - EOF - - assert_equal expected, out - end - - def test_class_create_model - out, = util_capture do - ActionMailer::ARSendmail.create_model 'Mail' - end - - expected = <<-EOF -class Mail < ActiveRecord::Base -end - EOF - - assert_equal expected, out + def strip_log_prefix(line) + line.gsub(/ar_sendmail .+ \d{4}: /,'') end def test_class_mailq @@ -76,11 +39,11 @@ end :mail => 'body1' last = Email.create :from => nobody, :to => 'recip@h2.example.com', :mail => 'body2' + last_attempt_time = Time.parse('Thu Aug 10 2006 11:40:05') + last.last_send_attempt = last_attempt_time.to_i - last.last_send_attempt = Time.parse('Thu Aug 10 2006 11:40:05').to_i - - out, err = util_capture do - ActionMailer::ARSendmail.mailq 'Email' + out, err = capture_io do + ActionMailer::ARSendmail.mailq end expected = <<-EOF @@ -98,13 +61,13 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 -- 0 Kbytes in 3 Requests. EOF - expected = expected % Time.new.strftime('%z') + expected = expected % last_attempt_time.strftime('%z') assert_equal expected, out end def test_class_mailq_empty - out, err = util_capture do - ActionMailer::ARSendmail.mailq 'Email' + out, err = capture_io do + ActionMailer::ARSendmail.mailq end assert_equal "Mail queue is empty\n", out @@ -114,17 +77,14 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 @sm = ActionMailer::ARSendmail.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 + :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 @@ -155,7 +115,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 argv = %w[-c /nonexistent] - out, err = util_capture do + out, err = capture_io do assert_raises SystemExit do ActionMailer::ARSendmail.process_args argv end @@ -218,7 +178,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 def test_class_parse_args_mailq options = ActionMailer::ARSendmail.process_args [] - deny_includes options, :MailQ + refute_includes options, :MailQ argv = %w[--mailq] @@ -238,33 +198,11 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 assert_equal 86400, options[:MaxAge] end - def test_class_parse_args_migration - options = ActionMailer::ARSendmail.process_args [] - deny_includes options, :Migration - - 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' - out, err = util_capture do - assert_raise SystemExit do + out, err = capture_io do + assert_raises SystemExit do ActionMailer::ARSendmail.process_args [] end end @@ -273,35 +211,6 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 $" << '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] @@ -316,38 +225,24 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 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_class_usage - out, err = util_capture do + out, err = capture_io do assert_raises SystemExit do ActionMailer::ARSendmail.usage 'opts' end end assert_equal '', out - assert_equal "opts\n", err + assert_equal "opts\n", strip_log_prefix(err) - out, err = util_capture do + out, err = capture_io do assert_raises SystemExit do ActionMailer::ARSendmail.usage 'opts', 'hi' end end assert_equal '', out - assert_equal "hi\n\nopts\n", err + assert_equal "hi\n\nopts\n", strip_log_prefix(err) end def test_cleanup @@ -357,12 +252,12 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 e3 = Email.create :mail => 'body', :to => 'to', :from => 'from' e3.last_send_attempt = Time.now - out, err = util_capture do + out, err = capture_io do @sm.cleanup end assert_equal '', out - assert err.index("expired 1 emails from the queue\n") + assert_equal "expired 1 emails from the queue\n", strip_log_prefix(err) assert_equal 2, Email.records.length assert_equal [e1, e2], Email.records @@ -375,7 +270,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 @sm.max_age = 0 - out, err = util_capture do + out, err = capture_io do @sm.cleanup end @@ -383,38 +278,41 @@ 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 => '' + def test_deliver + email = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email] end - assert !err.index('[]') - 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' - def test_deliver - email = Email.create :mail => 'body', :to => 'to', :from => 'from' + assert_equal '', out + assert_equal "sent email 00000000001 from from to to: \"queued\"\n", strip_log_prefix(err) + end - out, err = util_capture do + def test_log_header_setting + email = Email.create :mail => "Mailer: JunkMail 1.0\r\nX-Track: 7890\r\n\r\nbody", :to => 'to', :from => 'from' + @sm.log_header = 'X-Track' + out, err = capture_io 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 - assert err.index("sent email 00000000001 from from to to: \"queued\"\n") + assert_equal "sent email 00000000001 [7890] from from to to: \"queued\"\n", strip_log_prefix(err) + end + + def test_deliver_not_called_when_no_emails + sm = ActionMailer::ARSendmail.new({:Once => true}) + sm.expects(:deliver).never + sm.run end def test_deliver_auth_error @@ -428,7 +326,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 email = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email] end @@ -440,21 +338,20 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 assert_equal [60], @sm.slept assert_equal '', out - assert err.index("authentication error, retrying: try again\n") + assert_equal "authentication error, retrying: try again\n", strip_log_prefix(err) 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 + out, err = capture_io 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 - email = Email.create :mail => 'body', :to => 'to', :from => 'from' Net::SMTP.on_start do e = Net::SMTPAuthenticationError.new 'try again' e.set_backtrace %w[one two three] @@ -463,30 +360,16 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 @sm.failed_auth_count = 1 - out, err = util_capture do - assert_raise Net::SMTPAuthenticationError do - @sm.deliver [email] + out, err = capture_io do + assert_raises Net::SMTPAuthenticationError do + @sm.deliver [] end end assert_equal 2, @sm.failed_auth_count - assert err.index("authentication error, giving up: try again\n") + assert_equal "authentication error, giving up: try again\n", strip_log_prefix(err) end - def test_deliver_no_auth_without_emails - Net::SMTP.on_start do - e = Net::SMTPAuthenticationError.new 'no throw' - e.set_backtrace %w[one two three] - raise e - end - - out, err = util_capture do - @sm.deliver [] - end - assert_equal '', err, "authentication attempt without any emails to send" - assert_equal 0, Net::SMTP.deliveries.length - end - def test_deliver_4xx_error Net::SMTP.on_send_message do e = Net::SMTPSyntaxError.new 'try again' @@ -498,7 +381,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 email = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email] end @@ -508,7 +391,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 err.index("error sending email 1: \"try again\"(Net::SMTPSyntaxError):\n\tone\n\ttwo\n\tthree\n") + assert_equal "error sending email 1: \"try again\"(Net::SMTPSyntaxError):\n\tone\n\ttwo\n\tthree\n", strip_log_prefix(err) end def test_deliver_5xx_error @@ -522,7 +405,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 email = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email] end @@ -531,7 +414,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 err.index("5xx error sending email 1, removing from queue: \"unknown recipient\"(Net::SMTPFatalError):\n\tone\n\ttwo\n\tthree\n") + assert_equal "5xx error sending email 1, removing from queue: \"unknown recipient\"(Net::SMTPFatalError):\n\tone\n\ttwo\n\tthree\n", strip_log_prefix(err) end def test_deliver_errno_epipe @@ -543,7 +426,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 email = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email] end @@ -567,7 +450,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 email = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email] end @@ -578,7 +461,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 assert_equal [60], @sm.slept assert_equal '', out - assert err.index("server too busy, sleeping 60 seconds\n") + assert_equal "server too busy, sleeping 60 seconds\n", strip_log_prefix(err) end def test_deliver_syntax_error @@ -594,7 +477,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 email1 = Email.create :mail => 'body', :to => 'to', :from => 'from' email2 = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email1, email2] end @@ -604,9 +487,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 assert_operator now, :<=, Email.records.first.last_send_attempt assert_equal '', out - - 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") + 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", strip_log_prefix(err) end def test_deliver_timeout @@ -620,7 +501,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 email = Email.create :mail => 'body', :to => 'to', :from => 'from' - out, err = util_capture do + out, err = capture_io do @sm.deliver [email] end @@ -630,26 +511,26 @@ 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 err.index("error sending email 1: \"timed out\"(Timeout::Error):\n\tone\n\ttwo\n\tthree\n") + assert_equal "error sending email 1: \"timed out\"(Timeout::Error):\n\tone\n\ttwo\n\tthree\n", strip_log_prefix(err) end def test_do_exit - out, err = util_capture do - assert_raise SystemExit do + out, err = capture_io do + assert_raises SystemExit do @sm.do_exit end end assert_equal '', out - assert err.index("caught signal, shutting down\n") + assert_equal "caught signal, shutting down\n", strip_log_prefix(err) end def test_log - out, err = util_capture do + out, err = capture_io do @sm.log 'hi' end - assert err.index("hi\n") + assert_equal "hi\n", strip_log_prefix(err) end def test_find_emails @@ -668,14 +549,14 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 found_emails = [] - out, err = util_capture do + out, err = capture_io do found_emails = @sm.find_emails end assert_equal emails, found_emails assert_equal '', out - assert err.index("found 3 emails to send\n") + assert_equal "found 3 emails to send\n", strip_log_prefix(err) end def test_smtp_settings @@ -689,4 +570,3 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006 end end - test/test_arsendmail.rb Manifest.txt README.txt test/action_mailer.rb fefca3700986de39c6e74664c903bc13d99c8ffe Morten Primdahl morten@zendesk.com http://github.com/adzap/ar_mailer/commit/85f8fba9eeb2c8caf7ca3197be2f213794b69d4e 85f8fba9eeb2c8caf7ca3197be2f213794b69d4e 2009-08-31T05:21:05-07:00 2009-08-31T05:21:05-07:00 Updated to Adzaps latest version and using a less intrusive mechanism for logging context headers f2e0f09be21d4839de1684e4893b7a939711b546 Morten Primdahl morten@zendesk.com