ar_mailer_revised 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e31b96ff2c52c7ea6de5612eaf78aaac96f0c848
-  data.tar.gz: 8bee7faa04dd6dc0b6e873fd8c54d9bd6f2832b9
+  metadata.gz: 03b52bdd415b8935da01f8f64f5635861733ebd3
+  data.tar.gz: c95fdf08080ad676f99d1c62e9ee4eee27668011
 SHA512:
-  metadata.gz: e2c952822e0eef6031bcb68d4441dc8dbc50c8940f04390c9dcffa59fd3a7c1bc4f456e8b0252cb6e646a136489b8cf0a8fd2f4cac699fa7e496d1108d9ebe5d
-  data.tar.gz: 09de5500a627fb78d1259476b458d17c5a62629e6e472700be4c736491a071b706beef0a849d9fdee269b385bbe25e8d686b3ba3b96bf32bd5d7c2be779cbd95
+  metadata.gz: 09a63f87e618d4279a869cba103058b9560476d3bad0b9d7d8fa6cfbc6ddd5fef533a2f151ee58fe55060f29bfb42356e9762cdc26335bf81a4c9f9b7bc0c67d
+  data.tar.gz: 806906086e593191fab222b53c708d30ed0a87913d3de18283695ad18e2d989f870e8d1cbae1bcf0d1fbbf793e1465d6234414651bd3b393c15c3c0156571a07

data/README.md

@@ -1,6 +1,7 @@
+**Important**: The Rails 4 Gem Versions are **1.x**
+
 # ArMailerRevised
 
-[![Gem Version](https://badge.fury.io/rb/ar_mailer_revised.svg)](http://badge.fury.io/rb/ar_mailer_revised)
 [![Code Climate](https://codeclimate.com/github/Stex/ar_mailer_revised.png)](https://codeclimate.com/github/Stex/ar_mailer_revised)
 [![Build Status](https://travis-ci.org/Stex/ar_mailer_revised.svg?branch=rails_4)](https://travis-ci.org/Stex/ar_mailer_revised)
 

data/ar_mailer_revised.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = ArMailerRevised::VERSION
   spec.authors       = ['Stefan Exner']
   spec.email         = ['stex@sterex.de']
-  spec.description   = %q{Extension of the great ArMailer gem by Eric Hodel.}
+  spec.description   = %q{Allows Batch-Sending emails in Ruby on Rails applications including delayed emails and custom SMTP settings per email}
   spec.summary       = 'Batch email sending for rails applications'
   spec.homepage      = 'http://www.github.com/stex/ar_mailer_revised'
   spec.license       = 'MIT'
@@ -23,14 +23,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.3'
   spec.add_development_dependency 'yard', '~> 0.8'
   spec.add_development_dependency 'redcarpet', '~> 2.3'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'shoulda'
-  spec.add_development_dependency 'mailcatcher'
+  spec.add_development_dependency 'sqlite3', '~> 1'
+  spec.add_development_dependency 'minitest', '~> 5.3'
+  spec.add_development_dependency 'shoulda', '~> 3.5'
+  spec.add_development_dependency 'mailcatcher', '~> 0.2'
 
   spec.add_dependency 'rails', '~> 4'
-  spec.add_dependency 'log4r'
-  spec.add_dependency 'hirb'
+  spec.add_dependency 'log4r', '~> 1'
+  spec.add_dependency 'hirb', '~> 0'
 
   spec.required_ruby_version = '~> 2'
 end

data/lib/ar_mailer_revised/helpers/command_line.rb

@@ -67,7 +67,7 @@ module ArMailerRevised
         options             = {}
         options[:chdir]     = '.'
         options[:max_age]   = 86400 * 7
-        options[:rails_env] = ENV['RAILS_ENV']
+        options[:rails_env] = ENV['RAILS_ENV'] || 'production'
         options[:log_level] = 'info'
         options[:verbose]   = false
 

data/lib/ar_mailer_revised/mailman.rb

@@ -24,9 +24,7 @@ module ArMailerRevised
     end
 
     def run
-     logger.debug 'ArMailerRevised initialized with the following options:'
-     logger.debug Hirb::Helpers::AutoTable.render @options
-
+     logger.debug "ArMailerRevised initialized with the following options:\n" + Hirb::Helpers::AutoTable.render(@options)
      deliver_emails
     end
 
@@ -58,7 +56,6 @@ 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
@@ -85,10 +82,10 @@ module ArMailerRevised
           #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
+        rescue OpenSSL::SSL::SSLError => e
+          handle_ssl_error(setting, e, grouped_emails)
         rescue Exception => e
-          logger.warn 'Other Error, trying again next batch.'
-          logger.warn 'Complete Error: ' + e.to_s
-          puts e.backtrace
+          handle_other_exception(setting, e, grouped_emails)
         end
       end
     end
@@ -138,14 +135,37 @@ module ArMailerRevised
     def setup_tls(smtp, setting)
       if setting.enable_starttls_auto
         logger.debug 'Using STARTTLS, if the server accepts it'
-        smtp.enable_starttls_auto
+        smtp.enable_starttls_auto(build_ssl_context(setting))
       elsif setting.enable_starttls
         logger.debug 'Forcing STARTTLS'
-        smtp.enable_starttls
+        smtp.enable_starttls(build_ssl_context(setting))
       elsif setting.tls
         logger.debug 'Forcing TLS'
-        smtp.enable_tls
+        smtp.enable_tls(build_ssl_context(setting))
+      else
+        logger.debug 'Disabling TLS'
+        smtp.disable_tls
+      end
+    end
+
+    #
+    # @return [Boolean] +true+ if TLS is used in any kind (STARTLS auto, STARTLS or TLS)
+    #
+    def use_tls?(setting)
+      setting.enable_starttls_auto || setting.enable_starttls || setting.enable_tls
+    end
+
+    #
+    # Builds an SSL context to be used if TLS is enabled for the given setting
+    # At the moment it only sets the chosen verify_mode, but it might be extended later.
+    #
+    def build_ssl_context(setting)
+      c = OpenSSL::SSL::SSLContext.new
+      if use_tls?(setting)
+        logger.debug "Using SSL verify mode: #{setting.openssl_verify_mode}"
+        c.verify_mode = setting.openssl_verify_mode
       end
+      c
     end
 
     #
@@ -221,6 +241,18 @@ module ArMailerRevised
       end
     end
 
+    #
+    # Handles SSL errors (mostly invalid certificates)
+    # @see #handle_smtp_timeout
+    #
+    # Custom SMTP settings will be deleted and the default server will be used.
+    #
+    def handle_ssl_error(setting, exception, emails)
+      logger.warn "SSL error while connecting to '#{setting.address}:#{setting.port}'"
+      logger.warn 'Complete Error: ' + exception.to_s
+      handle_custom_setting_removal(setting, emails)
+    end
+
     #
     # Handles authentication errors occuring while connecting to an SMTP server.
     # @see #handle_smtp_timeout
@@ -229,35 +261,50 @@ module ArMailerRevised
     # as it isn't very likely that time will solve the error.
     #
     def handle_smtp_authentication_error(setting, exception, emails)
-      logger.warn "SMTP authentication error while connecting to '#{setting.host}:#{setting.port}'"
+      logger.warn "SMTP authentication error while connecting to '#{setting.address}:#{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
-        logger.error "Your application's base setting ('#{setting.host}:#{setting.port}') produced an authentication error!"
-        emails.each { |email| adjust_last_send_attempt!(email) }
-      end
+      handle_custom_setting_removal(setting, emails)
     end
 
+    #
+    # Handles SMTP syntax errors.
+    # @see #handle_smtp_timeout
+    #
     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
+      handle_custom_setting_removal(setting, emails)
+    end
+
+    #
+    # Handles other errors occuring while sending the email
+    # Custom settings are removed here as well as the gem itself
+    # most likely has to be altered to send these emails out using
+    # the custom settings - which might take a while.
+    #
+    def handle_other_exception(setting, exception, emails)
+      logger.warn "Other error while connecting to '#{setting.host}:#{setting.port}'"
+      logger.warn "Complete Error (#{exception.class.to_s}): " + exception.to_s
+      handle_custom_setting_removal(setting, emails)
+    end
+
+    #----------------------------------------------------------------
+    #                    Email Record Alteration
+    #----------------------------------------------------------------
 
+    #
+    # Removes custom settings for all given emails
+    #
+    def handle_custom_setting_removal(setting, emails)
       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!"
+        logger.error "Your application's base setting ('#{setting.host}:#{setting.port}') produced an error!"
       end
     end
 
-    #----------------------------------------------------------------
-    #                    Email Record Alteration
-    #----------------------------------------------------------------
-
     #
     # Adjusts the last send attempt timestamp in the given
     # email to the current time.

data/lib/ar_mailer_revised/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_mailer_revised
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Stefan Exner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,58 +70,58 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: mailcatcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -140,31 +140,32 @@ dependencies:
   name: log4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: hirb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Extension of the great ArMailer gem by Eric Hodel.
+description: Allows Batch-Sending emails in Ruby on Rails applications including delayed
+  emails and custom SMTP settings per email
 email:
 - stex@sterex.de
 executables: