ar_mailer_revised 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b1e7179059d80144067968beac5f41151eda097
-  data.tar.gz: 42554e87ed8bfb15baef54d94a7c0e28e0c7b515
+  metadata.gz: e31b96ff2c52c7ea6de5612eaf78aaac96f0c848
+  data.tar.gz: 8bee7faa04dd6dc0b6e873fd8c54d9bd6f2832b9
 SHA512:
-  metadata.gz: 0cb4f0f7c22ebf0e85ff61ded487ac20acf38036e0b8f45dd074923f153aeda836e416af01d73fa14263fe9f2203f76e7b8a653d938e8408f2d670899ccd2d2e
-  data.tar.gz: 827bb354ebb58010182591543be6ee60774146de9e5b9f5eda8649f39daf44d6c309c2cd986b3bb7a73e7e9812ce4b133099507b4b6b3613d6b4d0d846f966db
+  metadata.gz: e2c952822e0eef6031bcb68d4441dc8dbc50c8940f04390c9dcffa59fd3a7c1bc4f456e8b0252cb6e646a136489b8cf0a8fd2f4cac699fa7e496d1108d9ebe5d
+  data.tar.gz: 09de5500a627fb78d1259476b458d17c5a62629e6e472700be4c736491a071b706beef0a849d9fdee269b385bbe25e8d686b3ba3b96bf32bd5d7c2be779cbd95

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Version 1.0.2
+-------------
+
+- Remove custom SMTP settings on SMTP SyntaxErrors.
+  This makes more sense than simply trying to re-deliver them
+  in the next batch as it will most likely still be bad syntax.
+- Emails with Syntax or Authentication errors without custom SMTP
+  settings are now handled by adjusting their last send attempt.
+  This causes them to go to the end of the sending queue where they
+  will either be deleted after some time or - hopefully - eventually
+  sent when the developer corrects his application's SMTP settings.

data/ar_mailer_revised.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'shoulda'
+  spec.add_development_dependency 'mailcatcher'
 
   spec.add_dependency 'rails', '~> 4'
   spec.add_dependency 'log4r'

data/lib/action_mailer/ar_mailer.rb

@@ -46,14 +46,14 @@ class ActionMailer::Base
   #
   def ar_mailer_setting(key, value = nil)
     if headers[:ar_mailer_settings]
-      settings = YAML.load(headers[:ar_mailer_settings]).stringify_keys
+      settings = YAML::load(headers[:ar_mailer_settings]).stringify_keys
     else
       settings = {}
     end
 
     if value
       settings[key.to_s] = value
-      headers[:ar_mailer_settings] = YAML.dump(settings)
+      headers[:ar_mailer_settings] = YAML::dump(settings)
     else
       settings[key.to_s]
     end
@@ -78,7 +78,7 @@ module ActionMailer
     #
     def deliver!(mail)
       if mail['ar_mailer_settings']
-        ar_settings = YAML.load(mail['ar_mailer_settings'].value).stringify_keys
+        ar_settings                = YAML::load(mail['ar_mailer_settings'].value).stringify_keys
         mail['ar_mailer_settings'] = nil
       else
         ar_settings = {}
@@ -86,7 +86,7 @@ module ActionMailer
 
       email_options = {}
       email_options[:delivery_time] = ar_settings.delete('delivery_time')
-      email_options[:smtp_settings] = ar_settings.delete('smtp_settings')
+      email_options[:smtp_settings] = ar_settings.delete('smtp_settings').try(:symbolize_keys)
       email_options[:mail]          = mail.encoded
       email_options[:from]          = (mail['return-path'] && mail['return-path'].spec) || mail.from.first
       email_options.reverse_merge!(ar_settings['custom_attributes'] || {})

data/lib/ar_mailer_revised/mailman.rb

@@ -58,6 +58,7 @@ module ArMailerRevised
       group_emails_by_settings(emails).each do |settings_hash, grouped_emails|
         setting = OpenStruct.new(settings_hash)
         logger.info "Using setting #{setting.address}:#{setting.port}/#{setting.user_name}"
+        logger.info setting.inspect
 
         smtp = Net::SMTP.new(setting.address, setting.port)
         smtp.open_timeout = 10
@@ -73,12 +74,14 @@ module ArMailerRevised
           end
         rescue Net::SMTPAuthenticationError => e
           handle_smtp_authentication_error(setting, e, grouped_emails)
+        rescue Net::SMTPSyntaxError => e
+          handle_smtp_syntax_error(setting, e, grouped_emails)
         rescue Net::SMTPServerBusy => e
           logger.warn 'Server is busy, trying again next batch.'
           logger.warn 'Complete Error: ' + e.to_s
         rescue Net::OpenTimeout, Net::ReadTimeout => e
           handle_smtp_timeout(setting, e, grouped_emails)
-        rescue Net::SMTPSyntaxError, Net::SMTPFatalError, Net::SMTPUnknownError => e
+        rescue Net::SMTPFatalError, Net::SMTPUnknownError => e
           #TODO: Should we remove the custom SMTP settings here as well?
           logger.warn 'Other SMTP error, trying again next batch.'
           logger.warn 'Complete Error: ' + e.to_s
@@ -207,9 +210,9 @@ module ArMailerRevised
       logger.warn 'Complete Error: ' + exception.to_s
 
       if setting.custom_setting
+        logger.warn 'Setting default SMTP settings for all affected emails, they will be sent next batch.'
         emails.each do |email|
           if email.previously_attempted?
-            logger.warn 'Setting default SMTP settings for all affected emails, they will be sent next batch.'
             remove_custom_smtp_settings!(email)
           else
             adjust_last_send_attempt!(email)
@@ -231,12 +234,23 @@ module ArMailerRevised
 
       if setting.custom_setting
         logger.warn 'Setting default SMTP settings for all affected emails, they will be sent next batch.'
-
-        if setting.custom_setting
-          emails.each { |email| remove_custom_smtp_settings!(email) }
-        end
+        emails.each { |email| remove_custom_smtp_settings!(email) }
       else
         logger.error "Your application's base setting ('#{setting.host}:#{setting.port}') produced an authentication error!"
+        emails.each { |email| adjust_last_send_attempt!(email) }
+      end
+    end
+
+    def handle_smtp_syntax_error(setting, exception, emails)
+      logger.warn "SMTP syntax error while connecting to '#{setting.host}:#{setting.port}'"
+      logger.warn 'Complete Error: ' + exception.to_s
+
+      if setting.custom_setting
+        logger.warn 'Setting default SMTP settings for all affected emails, they will be sent next batch.'
+        emails.each { |email| remove_custom_smtp_settings!(email) }
+      else
+        emails.each { |email| adjust_last_send_attempt!(email) }
+        logger.error "Your application's base setting ('#{setting.host}:#{setting.port}') produced a syntax error!"
       end
     end
 

data/lib/ar_mailer_revised/version.rb

@@ -1,3 +1,3 @@
 module ArMailerRevised
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/test/dummy/test/mailers/test_mailer_test.rb

@@ -1,7 +1,13 @@
-require 'test_helper'
+# require 'test_helper'
+require 'open-uri'
+require 'ar_mailer_revised/mailman'
 
 class TestMailerTest < ActionMailer::TestCase
 
+  #----------------------------------------------------------------
+  #                     Email Generation Testing
+  #----------------------------------------------------------------
+
   context 'ActionMailer::Base.deliver' do
     setup do
       #@todo: Check if there is a way to set this in the dummy application itself,
@@ -51,4 +57,75 @@ class TestMailerTest < ActionMailer::TestCase
       assert_equal 42, email.a_number
     end
   end
+
+  #----------------------------------------------------------------
+  #                         SMTP Testing
+  #----------------------------------------------------------------
+
+  context 'Email sending' do
+    setup do
+      ActionMailer::Base.delivery_method = :activerecord
+      if mailcatcher_running?
+        setup_mailcatcher_settings
+        @old_email_count = received_emails.size
+      else
+        puts 'Mailcatcher is not running, SMTP tests are skipped'
+      end
+    end
+
+    should 'send out basic emails correctly' do
+      if mailcatcher_running?
+        assert TestMailer.basic_email.deliver
+        run_ar_sendmail
+        assert_equal @old_email_count + 1, received_emails.count, 'Email was not sent to local SMTP server'
+      end
+    end
+
+  end
+
+  private
+
+  #
+  # Executes ar_sendmail to send deliverable emails
+  #
+  def run_ar_sendmail
+    run_options = {
+        :chdir => Rails.root,
+        :rails_env => 'test',
+        :log_level => 'debug'
+    }
+    ArMailerRevised::Mailman.new(run_options).run
+  end
+
+  #
+  # @return [Boolean] +true+ if mailcatcher is running
+  #
+  def mailcatcher_running?
+    begin
+      open('http://localhost:1080')
+      true
+    rescue Errno::ECONNREFUSED
+      false
+    end
+  end
+
+  def setup_mailcatcher_settings
+    ActionMailer::Base.smtp_settings = {
+        :address   => 'localhost',
+        :port      => 1025,
+        :domain    => 'localhost.localdomain',
+        :user_name => 'some.user',
+        :password  => 'some.password',
+        :authentication => :plain,
+        :enable_starttls_auto => true
+    }
+  end
+
+  #
+  # @return [Array<Hash>] Message Meta-Data for all received emails
+  #
+  def received_emails
+    json = open('http://localhost:1080/messages')
+    JSON.load(json)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_mailer_revised
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Stefan Exner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-20 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mailcatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +176,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - MIT-LICENSE
@@ -252,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Batch email sending for rails applications
@@ -309,3 +324,4 @@ test_files:
 - test/dummy/test/mailers/test_mailer_test.rb
 - test/generators/install_generator_test.rb
 - test/test_helper.rb
+has_rdoc: