adzap-ar_mailer 1.4.4 → 2.0.0

data/History.txt

@@ -1,3 +1,12 @@
+= 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.

data/README.rdoc

@@ -0,0 +1,124 @@
+= ar_mailer
+
+A two-phase delivery agent for ActionMailer
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/seattlerb
+
+Documentation:
+
+http://seattlerb.org/ar_mailer
+
+and for forked additions
+
+http://github.com/adzap/ar_mailer/wikis
+
+Bugs:
+
+http://adzap.lighthouseapp.com/projects/26997-ar_mailer
+
+== About
+
+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.
+
+== Installing ar_mailer (forked)
+
+Before installing you will need to make sure the original gem is uninstalled as they can't coexist:
+
+  $ sudo gem uninstall ar_mailer
+
+Install the gem from GitHub gems server:
+
+First, if you haven't already:
+
+  $ sudo gem sources -a http://gems.github.com
+
+Then
+
+  $ sudo gem install adzap-ar_mailer
+
+For Rails >= 2.1, in your environment.rb:
+  
+  config.gem "adzap-ar_mailer", :lib => 'action_mailer/ar_mailer', :source => 'http://gems.github.com'
+
+For Rails 2.0, in an initializer file:
+
+  require 'action_mailer/ar_mailer'
+
+== Usage
+
+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.
+
+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/environments/production.rb and set the delivery method:
+
+  config.action_mailer.delivery_method = :activerecord
+
+Or if you need to, you can set each mailer class delivery method individually:
+
+  class MyMailer < ActionMailer::Base
+    self.delivery_method = :activerecord
+  end
+
+This can be useful when using plugins like ExceptionNotification. Where it
+might be foolish to tie the sending of the email alert to the database when the 
+database might be causing the exception being raised. In this instance you could
+override ExceptionNofitier delivery method to be smtp or set the other 
+mailer classes to use ARMailer explicitly.
+
+Then to run it:
+
+  $ 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::Base.email_class=
+
+
+=== Help
+
+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.
+
+== Run as a service (init.d/rc.d scripts)
+
+For Linux both script and demo config files are in share/linux. 
+See ar_sendmail.conf for setting up your config. Copy the ar_sendmail file 
+to /etc/init.d/ and make it executable. Then for Debian based distros run
+'sudo update-rc.d ar_sendmail defaults' and it should work. Make sure you have 
+the config file /etc/ar_sendmail.conf in place before starting.
+
+For FreeBSD or NetBSD script is share/bsd/ar_sendmail. This is old and does not
+support the config file unless someone wants to submit a patch.

data/Rakefile

@@ -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/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", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.rdoc", "Rakefile", "bin/ar_sendmail", "lib/action_mailer/ar_mailer.rb", "lib/action_mailer/ar_sendmail.rb", "lib/smtp_tls.rb", "share/bsd/ar_sendmail", "share/linux/ar_sendmail", "share/linux/ar_sendmail.conf", "test/action_mailer.rb", "test/test_armailer.rb", "test/test_arsendmail.rb"]
   s.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 

data/lib/action_mailer/ar_mailer.rb

@@ -4,69 +4,17 @@ 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
 
+  def self.inherited(sub)
+    logger.warn('The ActionMailer::ARMailer class has been deprecated. Will be removed in version 2.1. Just use ActionMailer::Base.')
+  end
+
+end
+
+class ActionMailer::Base
+
   @@email_class = Email
 
   ##

data/lib/action_mailer/ar_sendmail.rb

@@ -1,6 +1,6 @@
 require 'optparse'
 require 'net/smtp'
-require 'smtp_tls'
+require 'smtp_tls' unless Net::SMTP.instance_methods.include?("enable_starttls_auto")
 require 'rubygems'
 
 class Object # :nodoc:
@@ -54,7 +54,7 @@ class ActionMailer::ARSendmail
   ##
   # The version of ActionMailer::ARSendmail you are running.
 
-  VERSION = '1.4.3'
+  VERSION = '2.0.0'
 
   ##
   # Maximum number of times authentication will be consecutively retried
@@ -80,7 +80,7 @@ class ActionMailer::ARSendmail
   # Be verbose
 
   attr_accessor :verbose
-
+ 
   ##
   # ActiveRecord class that holds emails
 
@@ -112,7 +112,7 @@ class ActionMailer::ARSendmail
   def self.create_migration(table_name)
     require 'active_support'
     puts <<-EOF
-class Add#{table_name.classify} < ActiveRecord::Migration
+class Create#{table_name.classify} < ActiveRecord::Migration
   def self.up
     create_table :#{table_name.tableize} do |t|
       t.column :from, :string
@@ -309,13 +309,17 @@ 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
@@ -436,17 +440,26 @@ end
   # Delivers +emails+ to ActionMailer's SMTP server and destroys them.
 
   def deliver(emails)
-    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
+    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
+          res = session.send_message email.mail, email.from, email.to
           email.destroy
           log "sent email %011d from %s to %s: %p" %
                 [email.id, email.from, email.to, res]
@@ -454,7 +467,7 @@ end
           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
@@ -464,7 +477,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
@@ -530,7 +543,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
@@ -551,4 +565,3 @@ end
   end
 
 end
-

data/test/action_mailer.rb

@@ -1,5 +1,5 @@
 require 'net/smtp'
-require 'smtp_tls'
+require 'smtp_tls' unless Net::SMTP.instance_methods.include?("enable_starttls_auto")
 require 'time'
 
 class Net::SMTP
@@ -22,17 +22,20 @@ class Net::SMTP
 
   end
 
-  def self.start(*args)
-    @start_block.call if @start_block
-    yield new(nil)
-  end
-
   def self.on_send_message(&block)
     @send_message_block = block
   end
 
   def self.on_start(&block)
-    @start_block = block
+    if block_given?
+      @start_block = block
+    else
+      @start_block
+    end
+  end
+
+  def self.clear_on_start
+    @start_block = nil
   end
 
   def self.reset
@@ -42,6 +45,11 @@ class Net::SMTP
     @reset_called = 0
   end
 
+  def start(*args)
+    self.class.on_start.call if self.class.on_start
+    yield self
+  end
+
   alias test_old_reset reset if instance_methods.include? 'reset'
 
   def reset
@@ -68,6 +76,10 @@ class ActionMailer::Base
 
   @server_settings = {}
 
+  class << self
+    attr_accessor :delivery_method
+  end
+
   def self.logger
     o = Object.new
     def o.info(arg) end

data/test/test_armailer.rb

@@ -5,7 +5,8 @@ require 'action_mailer/ar_mailer'
 ##
 # Pretend mailer
 
-class Mailer < ActionMailer::ARMailer
+class Mailer < ActionMailer::Base
+  self.delivery_method = :activerecord
 
   def mail
     @mail = Object.new

data/test/test_arsendmail.rb

@@ -3,6 +3,7 @@ require 'action_mailer'
 require 'action_mailer/ar_sendmail'
 require 'rubygems'
 require 'test/zentest_assertions'
+require 'mocha'
 
 class ActionMailer::ARSendmail
   attr_accessor :slept
@@ -22,6 +23,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
@@ -36,7 +39,7 @@ class TestARSendmail < Test::Unit::TestCase
     end
 
     expected = <<-EOF
-class AddMail < ActiveRecord::Migration
+class CreateMail < ActiveRecord::Migration
   def self.up
     create_table :mail do |t|
       t.column :from, :string
@@ -76,8 +79,8 @@ end
                  :mail => 'body1'
     last = Email.create :from => nobody, :to => 'recip@h2.example.com',
                         :mail => 'body2'
-
-    last.last_send_attempt = Time.parse('Thu Aug 10 2006 11:40:05').to_i
+    last_attempt_time = Time.parse('Thu Aug 10 2006 11:40:05')
+    last.last_send_attempt = last_attempt_time.to_i
 
     out, err = util_capture do
       ActionMailer::ARSendmail.mailq 'Email'
@@ -98,7 +101,7 @@ 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
 
@@ -399,6 +402,12 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal "sent email 00000000001 from from to to: \"queued\"\n", 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
     Net::SMTP.on_start do
       e = Net::SMTPAuthenticationError.new 'try again'

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: adzap-ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 1.4.4
+  version: 2.0.0
 platform: ruby
 authors: 
 - Eric Hodel
+- Adam Meehan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-07-04 00:00:00 -07:00
+date: 2009-03-12 00:00:00 -07:00
 default_executable: ar_sendmail
 dependencies: []
 
 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.
-email: drbrain@segment7.net
+email: adam.meehan@gmail.com
 executables: 
 - ar_sendmail
 extensions: []
@@ -23,12 +24,12 @@ extra_rdoc_files:
 - History.txt
 - LICENSE.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 files: 
 - History.txt
 - LICENSE.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - bin/ar_sendmail
 - lib/action_mailer/ar_mailer.rb
@@ -41,11 +42,11 @@ files:
 - test/test_armailer.rb
 - test/test_arsendmail.rb
 has_rdoc: true
-homepage: http://seattlerb.org/ar_mailer
+homepage: http://github.com/adzap/ar_mailer
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README.txt

@@ -1,55 +0,0 @@
-= ar_mailer
-
-A two-phase delivery agent for ActionMailer
-
-Rubyforge Project:
-
-http://rubyforge.org/projects/seattlerb
-
-Documentation:
-
-http://seattlerb.org/ar_mailer
-
-and for forked additions
-
-http://github.com/adzap/ar_mailer/wikis
-
-Bugs:
-
-http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
-
-== About
-
-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.
-
-== Installing ar_mailer (forked)
-
-Install the gem from GitHub gems server:
-
-First, if you haven't already
-
-  $ sudo gem sources -a http://gems.github.com
-
-Then
-
-  $ sudo gem install adzap-ar_mailer
-
-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.
-
-=== init.d/rc.d scripts
-
-For Linux both script and demo config files are in share/linux. 
-See ar_sendmail.conf for setting up your config. Copy the ar_sendmail file 
-to /etc/init.d/ and make it executable. Then for Debian based distros run
-'sudo update-rc.d ar_sendmail defaults' and it should work. Make sure you have 
-the config file /etc/ar_sendmail.conf in place before starting.
-
-For FreeBSD or NetBSD script is share/bsd/ar_sendmail. This is old and does not
-support the config file unless someone wants to submit a patch.