VvanGemert-ar_mailer 2.1.8 → 2.2.0

data/README.rdoc

@@ -16,4 +16,9 @@ http://github.com/adzap/ar_mailer/wikis
 
 == Changes to the Adzap_ar_mailer version
 
-- Added priority
+- Added priority, the higher the priority the faster it will send
+- Added newsletter support, loops through user table and is connected with the batch size
+- Added bounce check support, updates user with bounced_at field when bounced
+- Added dry run support, dry run doesn't send emails and doesn't check for bounced
+
+Use "ar_sendmail -h" for all the options

data/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'rake/gempackagetask'
-require 'rake/testtask'
 require 'rake/rdoctask'
 
 $:.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
@@ -44,9 +43,7 @@ ar_mailer_gemspec = Gem::Specification.new do |s|
   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"]
-  s.add_development_dependency "minitest", ">= 1.5.0"
-  s.add_development_dependency "mocha", ">= 0.9.8"
+  s.test_files = []
 end
 
 Rake::GemPackageTask.new(ar_mailer_gemspec) do |pkg|
@@ -64,13 +61,3 @@ desc "Build packages and install"
 task :install => :package do
   sh %{sudo gem install --local --test pkg/VvanGemert-ar_mailer-#{ActionMailer::ARSendmail::VERSION}}
 end
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the ar_mailer gem.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib' << 'test'
-  t.test_files = FileList['test/**/test_*.rb'].exclude("test/test_helper.rb")
-  t.verbose = true
-end

data/lib/action_mailer/ar_mailer.rb

@@ -9,6 +9,8 @@ class ActionMailer::Base
   # Set the email class for deliveries. Handle class reloading issues which prevents caching the email class.
   #
   @@email_class_name = 'Email'
+  @@newsletter_class_name = 'EmailNewsletter'
+  @@user_class_name = 'User'
   @@priority = 100
   
   def self.email_class=(klass)
@@ -19,6 +21,22 @@ class ActionMailer::Base
     @@email_class_name.constantize
   end
 
+  def self.newsletter_class=(klass)
+  	@@newsletter_class_name = klass.to_s
+  end
+  
+  def self.newsletter_class
+    @@newsletter_class_name.constantize
+  end
+ 
+  def self.user_class=(klass)
+  	@@user_class_name = klass.to_s
+  end
+  
+  def self.user_class
+    @@user_class_name.constantize
+  end
+   
   ##
   # Adds +mail+ to the Email table.  Only the first From address for +mail+ is
   # used.

data/lib/action_mailer/ar_sendmail.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 require 'net/smtp'
+require 'net/imap'
 require 'smtp_tls' unless Net::SMTP.instance_methods.include?("enable_starttls_auto")
 
 ##
@@ -146,6 +147,11 @@ class ActionMailer::ARSendmail
     options[:MaxAge] = 86400 * 7
     options[:Once] = false
     options[:RailsEnv] = ENV['RAILS_ENV']
+    options[:Port] = 993
+    options[:Login] = ''
+    options[:Imap] = ''
+    options[:Password] = ''
+    options[:DryRun] = false
     options[:Pidfile] = options[:Chdir] + '/log/ar_sendmail.pid'
 
     opts = OptionParser.new do |opts|
@@ -229,7 +235,43 @@ class ActionMailer::ARSendmail
               "Default: #{options[:Verbose]}") do |verbose|
         options[:Verbose] = verbose
       end
-
+			
+			opts.on("-i", "--imap IMAP",
+              "Imap server used to check for bounces",
+              "Default: false", String) do |imap|
+        options[:Imap] = imap
+      end
+      
+      opts.on("-l", "--login LOGIN",
+              "login name to check for bounces",
+              "Default: false", String) do |login|
+        options[:Login] = login
+      end
+      
+      opts.on( "--password PASSWORD",
+              "password name to check for bounces",
+              "Default: false", String) do |password|
+        options[:Password] = password
+      end
+      
+      opts.on( "--port PORT",
+              "port to check for bounces",
+              "Default: #{options[:Port]}", Integer) do |port|
+        options[:Port] = port
+      end
+      
+      opts.on( "-k", "--bouncecheck",
+              "check for bounces",
+              "Default: false") do |bounce_check|
+        options[:Bouncecheck] = true
+      end
+      
+      opts.on("-f", "--dry-run",
+							"Dry run: don't send any emails",
+              "Default: Deliver all available emails\n", options[:DryRun]) do |dry_run|
+        options[:DryRun] = dry_run
+      end
+      
       opts.on("-h", "--help",
               "You're looking at it") do
         usage opts
@@ -335,7 +377,9 @@ class ActionMailer::ARSendmail
     @once = options[:Once]
     @verbose = options[:Verbose]
     @max_age = options[:MaxAge]
-
+		@dry_run = options[:DryRun]
+		@imap = { :host => options[:Imap], :port => options[:Port], :user => options[:Login], :password => options[:Password] }
+		@bouncecheck = options[:Bouncecheck]
     @failed_auth_count = 0
   end
 
@@ -375,8 +419,12 @@ class ActionMailer::ARSendmail
       until emails.empty? do
         email = emails.shift
         begin
-          res = session.send_message email.mail, email.from, email.to
-          email.destroy
+        	if @dry_run
+              res = 'DRY RUN'
+          else
+          	res = session.send_message email.mail, email.from, email.to
+          	email.destroy
+          end
           log "sent email %011d from %s to %s: %p" %
                 [email.id, email.from, email.to, res]
         rescue Net::SMTPFatalError => e
@@ -389,7 +437,7 @@ class ActionMailer::ARSendmail
           return
         rescue Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError, Timeout::Error => e
           email.last_send_attempt = Time.now.to_i
-          email.save rescue nil
+          email.save rescue nil unless @dry_run
           log "error sending email %d: %p(%s):\n\t%s" %
                 [email.id, e.message, e.class, e.backtrace.join("\n\t")]
           session.reset
@@ -409,6 +457,61 @@ class ActionMailer::ARSendmail
     # ignore SMTPServerBusy/EPIPE/ECONNRESET from Net::SMTP.start's ensure
   end
 
+  def deliver_newsletter(newsletter, users)
+  
+      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 users.empty? do
+      	  user = users.shift
+      	  begin
+      	  	if @dry_run
+              res = 'DRY RUN'
+           else
+            res = session.send_message newsletter.mail, newsletter.from, user.email
+           end
+            log "sent email %011d from %s to %s: %p" %
+                [newsletter.id, newsletter.from, user.email, 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")]
+            session.reset
+          rescue Net::SMTPServerBusy => e
+            log "server too busy, stopping delivery cycle"
+          return
+          rescue Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError, Timeout::Error => e
+            log "error sending email %d: %p(%s):\n\t%s" %
+                [email.id, e.message, e.class, e.backtrace.join("\n\t")]
+            session.reset
+          end
+        end
+  	  end
+  	  rescue Net::SMTPAuthenticationError => e
+        @failed_auth_count += 1
+        if @failed_auth_count >= MAX_AUTH_FAILURES then
+      	  log "authentication error, giving up: #{e.message}"
+      	  raise e
+       else
+          log "authentication error, retrying: #{e.message}"
+        end
+        sleep delay
+  	  rescue Net::SMTPServerBusy, SystemCallError, OpenSSL::SSL::SSLError
+      # ignore SMTPServerBusy/EPIPE/ECONNRESET from Net::SMTP.start's ensure
+  end
+
   ##
   # Prepares ar_sendmail for exiting
 
@@ -430,7 +533,31 @@ class ActionMailer::ARSendmail
     log "found #{mail.length} emails to send"
     mail
   end
-
+  
+  def find_newsletter
+  
+  	options = { :conditions => ['cancelled != 1 AND completed != 1'] }
+    newsletter = ActionMailer::Base.newsletter_class.find :first, options
+
+    log "found newsletter with title: #{newsletter.title}" unless newsletter.nil?
+    log "no newsletters found" unless !newsletter.nil?
+    newsletter
+  
+  end
+   	
+  def find_users(limit, offset)
+  	
+  	options = { :conditions => ['newsletter = 1 AND email IS NOT NULL'], :limit => limit, :offset => offset, :order => "id" }
+  	users = ActionMailer::Base.user_class.find :all, options
+  
+  	if !users.nil? && users.length < limit
+      
+  	end
+  	log "found #{users.length} users to send a newsletter"
+    users
+    
+  end 	
+   	
   ##
   # Installs signal handlers to gracefully exit.
 
@@ -457,8 +584,35 @@ class ActionMailer::ARSendmail
     loop do
       begin
         cleanup
+        
         emails = find_emails
+        already_send = emails.empty? ? 0 : emails.length
         deliver(emails) unless emails.empty?
+        
+        newsletter = find_newsletter
+        
+        unless newsletter.nil? || batch_size.nil?
+ 	      	offset = newsletter.mails_send.nil? ? 0 : newsletter.mails_send
+ 		  		limit = batch_size - already_send
+ 					 
+          users = find_users(limit, offset)
+        
+          update = {}
+          update[:mails_send] = offset + users.length unless users.empty?
+        	
+          if (!users.empty? && users.length < limit) || users.empty?
+            update[:completed] = 1
+          end
+          
+          # Deliver newsletter
+          newsletter.update_attributes(update) unless @dry_run
+          deliver_newsletter(newsletter, users) unless users.empty?
+          
+        end
+        
+        # Check for bounces
+        check_bounces unless @dry_run
+        
       rescue ActiveRecord::Transactions::TransactionError
       end
       break if @once
@@ -478,4 +632,92 @@ class ActionMailer::ARSendmail
     ActionMailer::Base.smtp_settings rescue ActionMailer::Base.server_settings
   end
 
+	def check_bounces
+
+		if @bouncecheck
+	    begin
+	      imap = Net::IMAP.new(@imap[:host], @imap[:port], true)
+	      imap.login(@imap[:user], @imap[:password])
+	      imap.select('INBOX')
+	    
+	      imap.uid_search(["NOT", "DELETED"]).each do |message_id|
+	        msg = imap.uid_fetch(message_id,'RFC822')[0].attr['RFC822']
+	        email = TMail::Mail.parse(msg)
+	        receive(email)
+	        #Mark message as deleted and it will be removed from storage when user session closed
+	        imap.uid_store(message_id, "+FLAGS", [:Deleted])
+	      end
+	      # tell server to permanently remove all messages flagged as :Deleted
+	      imap.expunge
+	      imap.logout
+	      imap.disconnect
+	    rescue Net::IMAP::NoResponseError => e
+	      log e
+	    rescue Net::IMAP::ByeResponseError => e
+	      log e
+	    rescue => e
+	      log e
+	    end
+		end
+		
+  end
+
+  def receive(email)
+     bounce = BouncedDelivery.from_email(email)
+     if(bounce.status_info > 3)
+        log "User bounced with email: #{bounce.sender}"
+        user = ActionMailer::Base.user_class.find_by_email(bounce.sender)
+  
+  			if !user.nil?
+      		user.update_attribute(:bounced_at, Time.now)
+  			end
+     end
+  end
+
 end
+
+##
+# Checking for bounced delivery
+# 
+
+class BouncedDelivery
+
+  attr_accessor :status_info, :sender, :subject
+
+  def self.from_email(email)
+    returning(bounce = self.new) do
+      
+      if(email.subject.match(/Mail delivery failed/i))
+        bounce.status_info = 6
+      elsif(email.subject.match(/Delivery Status Notification/i))
+        bounce.status_info = 8
+      elsif(email.header.to_s.match(/X-Failed-Recipient/i))
+        bounce.status_info = 10
+      else
+        bounce.status_info = 2
+      end
+      
+      if bounce.status_info > 3
+        bounce.subject = email.subject
+        bounce.sender = bounce.check_recipient(email.header)
+      end
+    end
+  end
+
+  def check_recipient(header)
+      header['x-failed-recipients'].body.to_s unless header['x-failed-recipients'].nil?
+  end
+
+  def status
+    case status_info
+    when 10
+      'Failed - X-Failed-Recipient'
+    when 8
+      'Failed - Delivery Status Notification'
+    when 6
+      'Failed - Mail delivery failed'
+    when 2
+      'Success'
+    end
+  end
+end

data/lib/adzap-ar_mailer.rb

@@ -1 +1,2 @@
 require 'action_mailer/ar_mailer'
+require 'action_mailer/ar_newsletter'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: VvanGemert-ar_mailer
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 7
   prerelease: false
   segments: 
   - 2
-  - 1
-  - 8
-  version: 2.1.8
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Eric Hodel
@@ -18,39 +18,8 @@ cert_chain: []
 
 date: 2010-03-17 00:00:00 +01:00
 default_executable: ar_sendmail
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 5
-        - 0
-        version: 1.5.0
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
-        version: 0.9.8
-  type: :development
-  version_requirements: *id002
+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: vincent@floorplanner.com
 executables: