dvdplm-ar_mailer 2.1.1 → 2.1.2

data/README.rdoc

@@ -1,7 +1,7 @@
 = reason for fork
-The purpose of this fork is to keep an archive of sent/unsent emails.
+The purpose of this fork is to keep an archive of sent/unsent emails. The archive is kept for 30 days by default, but can be configured to use any timeperiod by using the --max-archive-age switch.
 
-The Email class (or whatever you prefer to call it) in this for has different attributes.
+The Email class (or whatever you prefer to call it) in this fork has different attributes than the original.
 
 = ar_mailer
 

data/Rakefile

@@ -11,9 +11,9 @@ 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", "Adam Meehan"]
+  s.authors = ["Eric Hodel", "Adam Meehan", 'David Palm']
   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.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. This fork stores the email in the database for easy inspection and tracking.}
   s.email = %q{adam.meehan@gmail.com}
   s.executables = ["ar_sendmail"]
   s.extra_rdoc_files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.rdoc"]
@@ -23,7 +23,7 @@ ar_mailer_gemspec = Gem::Specification.new do |s|
   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.summary = %q{A two-phase delivery agent and outbox archive for ActionMailer}
   s.test_files = ["test/test_armailer.rb", "test/test_arsendmail.rb"]
 end 
 

data/lib/action_mailer/ar_sendmail.rb

@@ -46,7 +46,7 @@ class ActionMailer::ARSendmail
   ##
   # The version of ActionMailer::ARSendmail you are running.
 
-  VERSION = '2.1'
+  VERSION = '2.1.2'
 
   ##
   # Maximum number of times authentication will be consecutively retried
@@ -64,9 +64,14 @@ class ActionMailer::ARSendmail
   attr_accessor :delay
 
   ##
-  # Maximum age of emails in seconds before they are removed from the queue.
+  # Maximum age of unsent emails in seconds before they are removed from the queue.
 
-  attr_accessor :max_age
+  attr_accessor :max_retry_age
+
+  ##
+  # Maximum age of sent emails in days before they are removed from the archive altogether.
+
+  attr_accessor :max_archive_age
 
   ##
   # Be verbose
@@ -213,7 +218,8 @@ EOF
     options[:Chdir] = '.'
     options[:Daemon] = false
     options[:Delay] = 60
-    options[:MaxAge] = 86400 * 7
+    options[:MaxRetryAge] = 86400 * 7
+    options[:MaxArchiveAge] = 30
     options[:Once] = false
     options[:RailsEnv] = ENV['RAILS_ENV']
     options[:TableName] = 'Email'
@@ -244,12 +250,20 @@ EOF
         options[:Delay] = delay
       end
 
-      opts.on(      "--max-age MAX_AGE",
-              "Maxmimum age for an email. After this",
+      opts.on(      "--max-retry-age MAX_RETRY_AGE",
+              "Maxmimum age for an unsent email. After this",
+              "we will not try to send it anymore and ",
               "it will be removed from the queue.",
               "Set to 0 to disable queue cleanup.",
-              "Default: #{options[:MaxAge]} seconds", Integer) do |max_age|
-        options[:MaxAge] = max_age
+              "Default: #{options[:MaxRetryAge]} seconds", Integer) do |max_retry_age|
+        options[:MaxRetryAge] = max_retry_age
+      end
+
+      opts.on(      "--max-archive-age MAX_ARCHIVE_AGE",
+              "Keep sent emails for this number of ",
+              "days, after which they are deleted.",
+              "Default: #{options[:MaxArchiveAge]} days", Integer) do |max_archive_age|
+        options[:MaxArchiveAge] = max_archive_age
       end
 
       opts.on("-o", "--once",
@@ -426,31 +440,45 @@ EOF
   # <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  = options[:TableName].constantize
-    @once         = options[:Once]
-    @verbose      = options[:Verbose]
-    @max_age      = options[:MaxAge]
+    options[:Delay]         ||= 60
+    options[:TableName]     ||= 'Email'
+    options[:MaxRetryAge]   ||= 86400 * 7
+    options[:MaxArchiveAge] ||= 30
+
+    @batch_size       = options[:BatchSize]
+    @delay            = options[:Delay]
+    @email_class      = options[:TableName].constantize
+    @once             = options[:Once]
+    @verbose          = options[:Verbose]
+    @max_retry_age    = options[:MaxRetryAge]
+    @max_archive_age  = options[:MaxArchiveAge]
 
     @failed_auth_count = 0
   end
 
+  def cleanup
+    cleanup_unsent
+    cleanup_old_emails
+  end
+
   ##
   # Removes unsent emails that have lived in the queue for too long. 
-  # If max_age is set to 0, no emails will be removed; max_age defaults
+  # If max_retry_age is set to 0, no emails will be removed; max_retry_age defaults
   # to 7 days (86400 * 7)
-  def cleanup
-    return if @max_age == 0
-    timeout = Time.now - @max_age
+  def cleanup_unsent
+    return if @max_retry_age == 0
+    timeout = Time.now - @max_retry_age
     conditions = ['last_send_attempt > 0 AND created_at < ? AND sent_at IS NULL', timeout]
     mail = @email_class.update_all({:failed => true}, conditions)
 
-    log "#{self.class}#cleanup expired #{mail} emails from the queue"
+    log "#{self.class}#cleanup_unsent expired #{mail} emails from the queue"
+  end
+  
+  # Store 30 days worth of old emails
+  def cleanup_old_emails
+    conditions = ['sent_at < ?', @max_archive_age.days.ago.to_date]
+    log "#{self.class}#cleanup_old_emails Deleting #{@email_class.count(:conditions => conditions)} emails from the archive."
+    @email_class.delete_all(conditions)
   end
 
   ##

data/test/test_arsendmail.rb

@@ -244,13 +244,13 @@ EOF
 
   def test_class_parse_args_max_age
     options = ActionMailer::ARSendmail.process_args []
-    assert_equal 86400 * 7, options[:MaxAge]
+    assert_equal 86400 * 7, options[:MaxRetryAge]
 
-    argv = %w[--max-age 86400]
+    argv = %w[--max-retry-age 86400]
 
     options = ActionMailer::ARSendmail.process_args argv
 
-    assert_equal 86400, options[:MaxAge]
+    assert_equal 86400, options[:MaxRetryAge]
   end
 
   def test_class_parse_args_migration
@@ -365,7 +365,7 @@ EOF
     assert_equal "hi\n\nopts\n", err
   end
 
-  def test_cleanup
+  def test_cleanup_unsent
     e1 = Email.create :mail => 'body', :to => 'to', :from => 'from'
     e1.created_at = Time.now
     e2 = Email.create :mail => 'body', :to => 'to', :from => 'from'
@@ -373,11 +373,11 @@ EOF
     e3.update_attributes(:last_send_attempt => 1.day.ago, :created_at => 3.weeks.ago, :sent_at => nil)
 
     out, err = capture_io do
-      @sm.cleanup
+      @sm.cleanup_unsent
     end
 
     assert_equal "", out
-    assert_equal "ActionMailer::ARSendmail#cleanup expired 1 emails from the queue\n", err
+    assert_equal "ActionMailer::ARSendmail#cleanup_unsent expired 1 emails from the queue\n", err
     assert_equal 2, Email.count(:conditions => {:failed => false})
 
     assert_equal [e1, e2], Email.all(:conditions => {:failed => false})
@@ -388,15 +388,27 @@ EOF
     e1.created_at = Time.now
     e2 = Email.create :mail => 'body', :to => 'to', :from => 'from'
 
-    @sm.max_age = 0
+    @sm.max_retry_age = 0
 
     out, err = capture_io do
-      @sm.cleanup
+      @sm.cleanup_unsent
     end
 
     assert_equal '', out
     assert_equal 2, Email.count
   end
+  
+  def test_cleanup_old_emails
+    e1 = Email.create! :mail => 'body', :to => 'to', :from => 'from', :sent_at => 31.days.ago
+    e2 = Email.create! :mail => 'body', :to => 'to', :from => 'from', :sent_at => 29.days.ago
+    
+    out, err = capture_io do
+      @sm.cleanup_old_emails
+    end
+    
+    assert_equal '', out
+    assert_equal 1, Email.count
+  end
 
   def test_deliver
     pre_count = Email.count

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dvdplm-ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors: 
 - Eric Hodel
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -07:00
+date: 2009-08-04 00:00:00 -07:00
 default_executable: ar_sendmail
 dependencies: []
 
@@ -44,6 +44,7 @@ files:
 - test/test_arsendmail.rb
 has_rdoc: true
 homepage: http://github.com/adzap/ar_mailer
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -65,9 +66,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: seattlerb
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: A two-phase delivery agent and outbox archive for ActionMailer
 test_files: 
 - test/test_armailer.rb