scambra-ar_mailer 2.1.6 → 2.1.7

data/History.txt

@@ -1,3 +1,21 @@
+= 2.1.7
+
+* Miscellaneous Updates
+  * Added adzap-ar_mailer file to end the need for the config.gem :lib option
+
+* Bugs fixed
+  * Fix from address being set as address header object.
+
+= 2.1.6
+
+* Miscellaneous Updates
+  * Use return-path as from address if set, as per default ActionMailer::Base SMTP delivery (Dustin Tinney)
+  * Always wait full delay between deliveries (cyu)
+
+* Bugs fixed
+  * Non-zero return code returned in init.d script (hennk)
+  * Use updated Timeout error class (hennk)
+
 = 2.1.5
 
 * Bugs fixed
@@ -21,7 +39,7 @@
   * 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
@@ -55,7 +73,7 @@
 = 1.4.3
 
 * Bugs fixed
-  * Replaced mistaken call to log when removing pid file artifact for 
+  * Replaced mistaken call to log when removing pid file artifact for
     non-running daemon
 
 = 1.4.2
@@ -65,11 +83,11 @@
     config file. See files share/linux/ar_sendmail and ar_sendmail.conf
 * Bugs fixed
   * Proper handling for relative and absolute paths for the pid file
-* Removed hoe dependency since we need the explicit gemspec file for github and 
+* Removed hoe dependency since we need the explicit gemspec file for github and
   not deploying to RubyForge its not as useful.
-* Moved old BSD rc.d script to share/bsd folder 
+* Moved old BSD rc.d script to share/bsd folder
 * Updated README with github gem install, docs and init script info
- 
+
 = 1.4.1
 
 * Bugs fixed

data/README.rdoc

@@ -30,19 +30,17 @@ Before installing you will need to make sure the original gem is uninstalled as
 
   $ 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'
+
+  config.gem "adzap-ar_mailer", :lib => 'action_mailer/ar_mailer'
+
+  # or since version 2.1.7 of this gem you can now just do
+
+  config.gem "adzap-ar_mailer"
 
 For Rails 2.0, in an initializer file:
 
@@ -88,9 +86,9 @@ Or if you need to, you can set each mailer class delivery method individually:
   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 
+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 
+override ExceptionNofitier delivery method to be smtp or set the other
 mailer classes to use ARMailer explicitly.
 
 Then to run it:
@@ -116,7 +114,7 @@ SMTP server supports it. If you do not want it to automatically enabled then
 set the :tls option to false in your smtp_settings.
 
 If you are on Ruby <= 1.8.6, then the TLS patch included in this plugin will
-be loaded, so you don't need another TLS plugin to add the capability. This 
+be loaded, so you don't need another TLS plugin to add the capability. This
 patch allows you to explicit set if the server supports TLS by setting the
 :tls option to true in your smtp_settings.
 
@@ -129,10 +127,10 @@ 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 
+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 
+'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

data/Rakefile

@@ -6,38 +6,59 @@ require 'rake/rdoctask'
 $:.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
 
 require './lib/action_mailer/ar_sendmail'
- 
+
 ar_mailer_gemspec = Gem::Specification.new do |s|
-  s.name = %q{ar_mailer}
+  s.name = %q{scambra-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", "Adam Meehan"]
+  s.authors = ["Eric Hodel", "Adam Meehan", "Sergio Cambra"]
   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{adam.meehan@gmail.com}
+  s.email = %q{sergio@entrecables.com}
   s.executables = ["ar_sendmail"]
   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", "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.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/adzap-ar_mailer.rb",
+    "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/resources/action_mailer.rb",
+    "test/test_armailer.rb",
+    "test/test_arsendmail.rb",
+    "test/test_helper.rb"
+  ]
   s.has_rdoc = true
-  s.homepage = %q{http://github.com/adzap/ar_mailer}
+  s.homepage = %q{http://github.com/scambra/ar_mailer}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{seattlerb}
   s.summary = %q{A two-phase delivery agent for ActionMailer}
   s.test_files = ["test/test_armailer.rb", "test/test_arsendmail.rb"]
-end 
+  s.add_development_dependency "minitest", ">= 1.5.0"
+  s.add_development_dependency "mocha", ">= 0.9.8"
+end
 
 Rake::GemPackageTask.new(ar_mailer_gemspec) do |pkg|
   pkg.gem_spec = ar_mailer_gemspec
 end
- 
+
 desc "Update ar_mailer.gemspec"
 task :make_spec do
-  File.open("ar_mailer.gemspec", "w") do |f|
+  File.open("adzap-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 --test pkg/ar_mailer-#{ActionMailer::ARSendmail::VERSION}}

data/lib/action_mailer/ar_mailer.rb

@@ -23,8 +23,9 @@ class ActionMailer::Base
   # used.
 
   def perform_delivery_activerecord(mail)
+    sender = (mail['return-path'] && mail['return-path'].spec) || mail.from.first
     mail.destinations.each do |destination|
-      self.class.email_class.create :mail => mail.encoded, :to => destination, :from => mail.from.first
+      self.class.email_class.create :mail => mail.encoded, :to => destination, :from => sender
     end
   end
 

data/lib/action_mailer/ar_sendmail.rb

@@ -42,7 +42,7 @@ class ActionMailer::ARSendmail
   ##
   # The version of ActionMailer::ARSendmail you are running.
 
-  VERSION = '2.1.5'
+  VERSION = '2.1.7'
 
   ##
   # Maximum number of times authentication will be consecutively retried
@@ -68,7 +68,7 @@ class ActionMailer::ARSendmail
   # Be verbose
 
   attr_accessor :verbose
- 
+
 
   ##
   # True if only one delivery attempt will be made per call to run
@@ -282,7 +282,7 @@ class ActionMailer::ARSendmail
         File.open(@@pid_file, 'r') {|f| pid = f.read.chomp }
         if system("ps -p #{pid} | grep #{pid}") # returns true if process is running, o.w. false
           $stderr.puts "Warning: The pid file #{@@pid_file} exists and ar_sendmail is running. Shutting down."
-          exit
+          exit -1
         else
           # not running, so remove existing pid file and continue
           self.remove_pid_file
@@ -303,7 +303,7 @@ class ActionMailer::ARSendmail
   rescue Exception => e
     $stderr.puts "Unhandled exception #{e.message}(#{e.class}):"
     $stderr.puts "\t#{e.backtrace.join "\n\t"}"
-    exit 1
+    exit -2
   end
 
   ##
@@ -364,7 +364,7 @@ class ActionMailer::ARSendmail
       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
@@ -386,14 +386,13 @@ class ActionMailer::ARSendmail
                 [email.id, e.message, e.class, e.backtrace.join("\n\t")]
           email.destroy
           session.reset
-        rescue Net::SMTPServerBusy, Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError => e
+        rescue Net::SMTPServerBusy, Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError, Timeout::Error => e
           email.last_send_attempt = Time.now.to_i
           email.save rescue nil
           log "error sending email %d: %p(%s):\n\t%s" %
                 [email.id, e.message, e.class, e.backtrace.join("\n\t")]
           if e.is_a? Net::SMTPServerBusy
-            log "server too busy, sleeping #{@delay} seconds"
-            sleep delay
+            log "server too busy, stopping delivery cycle"
             return
           else
             session.reset
@@ -420,7 +419,7 @@ class ActionMailer::ARSendmail
   def do_exit
     log "caught signal, shutting down"
     self.class.remove_pid_file
-    exit
+    exit 130
   end
 
   ##
@@ -460,7 +459,6 @@ class ActionMailer::ARSendmail
     install_signal_handlers
 
     loop do
-      now = Time.now
       begin
         cleanup
         emails = find_emails
@@ -469,7 +467,7 @@ class ActionMailer::ARSendmail
       rescue ActiveRecord::Transactions::TransactionError
       end
       break if @once
-      sleep @delay if now + @delay > Time.now
+      sleep @delay
     end
   end
 

data/lib/adzap-ar_mailer.rb

@@ -0,0 +1 @@
+require 'action_mailer/ar_mailer'

data/share/linux/ar_sendmail

@@ -14,11 +14,11 @@ begin
   config = YAML::load(IO.read(config_file)) || {}
   if config.empty? || (config.has_key?('defaults') && config.size == 1)
     puts "No mailers defined. Exiting."
-    exit
+    exit -2
   end
 rescue Errno::ENOENT
   puts "Config file not found at '#{config_file}'!"
-  exit
+  exit -3
 end
 
 default_options = {'pidfile' => './log/ar_sendmail.pid'}.merge(config.delete('defaults') || {})
@@ -57,7 +57,7 @@ end
 
 def command_error(msg)
   puts msg
-  exit
+  exit -1
 end
 
 if ['start', 'stop', 'restart'].include?(command)

data/test/test_armailer.rb

@@ -7,6 +7,7 @@ class Mailer < ActionMailer::Base
     @mail = Object.new
     def @mail.encoded() 'email' end
     def @mail.from() ['nobody@example.com'] end
+    def @mail.[](key) {'return-path' => $return_path, 'from' => 'nobody@example.com'}[key] end
     def @mail.destinations() %w[user1@example.com user2@example.com] end
   end
 
@@ -15,6 +16,7 @@ end
 class TestARMailer < Test::Unit::TestCase
 
   def setup
+    $return_path = nil
     Mailer.email_class = Email
 
     Email.records.clear
@@ -28,6 +30,15 @@ class TestARMailer < Test::Unit::TestCase
 
     assert_equal 2, Newsletter.records.length
   end
+  
+  def test_perform_delivery_activerecord_when_return_path_is_present
+    $return_path = stub(:spec => 'return-path@example.com')
+    Mailer.deliver_mail
+
+    assert_equal 2, Email.records.length
+    record = Email.records.first
+    assert_equal 'return-path@example.com', record.from
+  end
 
   def test_perform_delivery_activerecord
     Mailer.deliver_mail

data/test/test_arsendmail.rb

@@ -98,19 +98,19 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
 
   def test_class_parse_args_chdir
     argv = %w[-c /tmp]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal '/tmp', options[:Chdir]
 
     argv = %w[--chdir /tmp]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal '/tmp', options[:Chdir]
 
     argv = %w[-c /nonexistent]
-    
+
     out, err = capture_io do
       assert_raises SystemExit do
         ActionMailer::ARSendmail.process_args argv
@@ -120,35 +120,35 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
 
   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_pidfile
     argv = %w[-p ./log/ar_sendmail.pid]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal './log/ar_sendmail.pid', options[:Pidfile]
 
     argv = %w[--pidfile ./log/ar_sendmail.pid]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal './log/ar_sendmail.pid', options[:Pidfile]
   end
-  
+
   def test_class_parse_args_delay
     argv = %w[--delay 75]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal 75, options[:Delay]
@@ -158,7 +158,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal nil, ENV['RAILS_ENV']
 
     argv = %w[-e production]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal 'production', options[:RailsEnv]
@@ -166,7 +166,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal 'production', ENV['RAILS_ENV']
 
     argv = %w[--environment production]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal 'production', options[:RailsEnv]
@@ -177,7 +177,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     refute_includes options, :MailQ
 
     argv = %w[--mailq]
-    
+
     options = ActionMailer::ARSendmail.process_args argv
 
     assert_equal true, options[:MailQ]
@@ -209,13 +209,13 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
 
   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]
@@ -420,31 +420,6 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal '', err
   end
 
-  def test_deliver_server_busy
-    Net::SMTP.on_send_message do
-      e = Net::SMTPServerBusy.new 'try again'
-      e.set_backtrace %w[one two three]
-      raise e
-    end
-
-    now = Time.now.to_i
-
-    email = Email.create :mail => 'body', :to => 'to', :from => 'from'
-
-    out, err = capture_io do
-      @sm.deliver [email]
-    end
-
-    assert_equal 0, Net::SMTP.deliveries.length
-    assert_equal 1, Email.records.length
-    assert_operator now, :>=, Email.records.first.last_send_attempt
-    assert_equal 0, Net::SMTP.reset_called, 'Reset connection on SyntaxError'
-    assert_equal [60], @sm.slept
-
-    assert_equal '', out
-    assert_equal "server too busy, sleeping 60 seconds\n", err
-  end
-
   def test_deliver_syntax_error
     Net::SMTP.on_send_message do
       Net::SMTP.on_send_message # clear

metadata

@@ -1,20 +1,39 @@
 --- !ruby/object:Gem::Specification 
 name: scambra-ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 2.1.6
+  version: 2.1.7
 platform: ruby
 authors: 
-- Sergio Cambra
 - Eric Hodel
 - Adam Meehan
+- Sergio Cambra
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 +02:00
+date: 2010-01-19 00:00:00 +01:00
 default_executable: ar_sendmail
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
 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: sergio@entrecables.com
 executables: 
@@ -34,6 +53,7 @@ files:
 - generators/ar_mailer/ar_mailer_generator.rb
 - generators/ar_mailer/templates/migration.rb
 - generators/ar_mailer/templates/model.rb
+- lib/adzap-ar_mailer.rb
 - lib/action_mailer/ar_mailer.rb
 - lib/action_mailer/ar_sendmail.rb
 - lib/smtp_tls.rb