action_mailer-logged_smtp_delivery 1.1.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d781ad070664a975fffad82071e7aeedf7ed601
+  data.tar.gz: 761658d0f91601a056abe97f9a3abdddfb51e4b4
+SHA512:
+  metadata.gz: ff13c8e7ee92190f904e893d3a10cca6605a6b9cecff368d71a016289990619b76fa5ddffa18f0909e366a710811e44ed05ff2034f5656d170870b0f82b8ba4b
+  data.tar.gz: 1c9f076ced8d21c1b81183feb3821748acedc71722f8f063631c1eab5ce0cdd13320b294357000c3c849dead56add05484d426f654e535c2f5285e11bff3bd0f

data/README.md

@@ -1,33 +1,48 @@
-### Logged SMTP Delivery
-
-A few features:
-  1. Detailed log stream with message id prefix. Example:
-   ```
-   <4e2b38d772949_b81ac212@localhost> stored at example/log/mails/outbound/2011-07-23/7_13462_2.eml
-   <4e2b38d772949_b81ac212@localhost> X-Delivery-Context: [users/1/welcome]
-   <4e2b38d772949_b81ac212@localhost> sender: support@support.localhost
-   <4e2b38d772949_b81ac212@localhost> destinations: support@system.example.com
-   <4e2b38d772949_b81ac212@localhost> done #<Net::SMTP::Response:0x10bbee680 @string="250 2.0.0 Ok: queued as 87BF716D7901\n", @status="250">
-   ```
-
-  2. Logs an identification header to quickly locate logs for a specific email/entity
-    ```ruby
-    config.action_mailer.smtp_settings[:log_header] = 'X-Delivery-Context'
-
-    class UsersMailer < ActionMailer::Base
-      
-      def welcome(user)
-        headers['X-Delivery-Context'] = "users/#{user.id}/welcome"
-        
-        # ...
-      end
-    end
+# Logged SMTP Delivery
+
+```Ruby
+require 'action_mailer/logged_smtp_delivery'
+config.action_mailer.logged_smtp_settings = {
+  ... normal smtp settings ...,
+  logger: Logger.new, # progress info
+  mail_file_logger: Logger.new # log full encoded mails for storage
+}
+
+
+```
+
+
+### Detailed log stream with message id prefix. Example:
+
+```
+<4e2b38d772949_b81ac212@localhost> stored at example/log/mails/outbound/2011-07-23/7_13462_2.eml
+<4e2b38d772949_b81ac212@localhost> X-Delivery-Context: [users/1/welcome]
+<4e2b38d772949_b81ac212@localhost> sender: support@support.localhost
+<4e2b38d772949_b81ac212@localhost> destinations: support@system.example.com
+<4e2b38d772949_b81ac212@localhost> done #<Net::SMTP::Response:0x10bbee680 @string="250 2.0.0 Ok: queued as 87BF716D7901\n", @status="250">
+```
+
+### Logs an identification header to quickly locate logs for a specific email/entity
+
+```ruby
+config.action_mailer.logged_smtp_settings[:log_header] = 'X-Delivery-Context'
+
+class UsersMailer < ActionMailer::Base
+  
+  def welcome(user)
+    headers['X-Delivery-Context'] = "users/#{user.id}/welcome"
     
+    # ...
+  end
+end
+
 
-    UsersMailer.deliver_welcome(user)
-    # ActionMailer::Base.logger -> 
-    # <4e2b38d772949_b81ac212@localhost> X-Delivery-Context: [users/1/welcome]
-    ```
+UsersMailer.welcome(user).deliver
+# ActionMailer::Base.logger -> 
+# <4e2b38d772949_b81ac212@localhost> X-Delivery-Context: [users/1/welcome]
+```
   
-  3. Doesn't render BCC recipients
+### Doesn't render BCC recipients
+
+License: Apache V2
 

data/lib/action_mailer/logged_smtp_delivery.rb

@@ -1,41 +1,31 @@
 require 'action_mailer'
-require 'active_support/core_ext/class/attribute'
 require 'net/smtp'
 
-#TODO: Add mail file logger
-
-# A few features:
-# Hides BCC recipients
-# Detailed log stream with message id token
-# Logs an identification header to quickly locate logs for a specific email
-# Can optionally log the raw email
-# TLS support
 module ActionMailer::LoggedSMTPDelivery
+  class Mailer
+    def initialize(settings)
+      @settings = settings
+    end
 
-  def self.included(base)
-    base.class_attribute :mail_file_logger
-  end
+    def deliver!(mail)
+      delivery = SMTPDelivery.new(mail, @settings, @settings.fetch(:logger))
 
-  def perform_delivery_logged_smtp(mail)
-    delivery        = SMTPDelivery.new(mail, smtp_settings)
-    delivery.logger = logger
+      if logger = @settings[:mail_file_logger]
+        path = logger.log(mail.encoded)
+        delivery.log "stored at #{path}"
+      end
 
-    if mail_file_logger
-      path = mail_file_logger.log(mail.encoded)
-      delivery.log "stored at #{path}"
+      delivery.perform
     end
-
-    delivery.perform
   end
 
   class SMTPDelivery
+    attr_reader   :mail, :settings, :logger
 
-    attr_reader   :mail, :settings
-    attr_accessor :logger
-
-    def initialize(mail, settings)
+    def initialize(mail, settings, logger)
       @mail         = mail
       @settings     = settings
+      @logger       = logger
     end
 
     def perform
@@ -76,7 +66,7 @@ module ActionMailer::LoggedSMTPDelivery
     end
 
     def log_headers
-      log "#{log_header}: [#{mail[log_header]}]" unless log_header.nil?
+      log "#{log_header}: [#{mail[log_header]}]" if log_header
     end
 
     def log(message)
@@ -90,7 +80,7 @@ module ActionMailer::LoggedSMTPDelivery
     def smtp_adaptor
       settings[:adaptor] || Net::SMTP
     end
-
   end
-
 end
+
+ActionMailer::Base.add_delivery_method :logged_smtp, ActionMailer::LoggedSMTPDelivery::Mailer

metadata

@@ -1,46 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: action_mailer-logged_smtp_delivery
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Eric Chapweske
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.16
+        version: 3.2.19
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.16
+        version: 3.2.19
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: bump
+  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'
 description: ActionMailer SMTP delivery strategy with advanced logging and Bcc support
@@ -49,34 +86,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/action_mailer/logged_smtp_delivery.rb
-- test/helper.rb
-- test/logged_smtp_delivery_test.rb
 - README.md
-homepage: https://github.com/eac/action_mailer-logged_smtp_delivery
-licenses: []
+- lib/action_mailer/logged_smtp_delivery.rb
+homepage: https://github.com/grosser/action_mailer-logged_smtp_delivery
+licenses:
+- Apache V2
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An ActionMailer delivery strategy
-test_files:
-- test/helper.rb
-- test/logged_smtp_delivery_test.rb
+test_files: []

data/test/helper.rb

@@ -1,57 +0,0 @@
-require 'bundler/setup'
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib'))) # lib
-require 'minitest/autorun'
-
-class MemoryLogger
-
-  def log(message)
-    messages << message
-  end
-
-  def messages
-    @messages ||= []
-  end
-
-  def clear
-    messages.clear
-  end
-
-end
-
-class FakeSMTP
-
-  attr_reader :address, :port, :credentials
-
-  def self.deliveries
-    @deliveries ||= []
-  end
-
-  def initialize(address, port)
-    @address = address
-    @port    = port
-  end
-
-  def start(*credentials)
-    @credentials = credentials
-    @started     = true
-
-    yield(self)
-  end
-
-  def send_message(message, from, recipients)
-    self.class.deliveries << [ message, from, recipients ]
-  end
-
-  def enable_starttls_auto
-    @starttls = :auto
-  end
-
-  def starttls_auto?
-    @starttls == :auto
-  end
-
-  def inspect
-    "#<#{self.class} #{@address}:#{@port} started=#{@started}>"
-  end
-
-end

data/test/logged_smtp_delivery_test.rb

@@ -1,132 +0,0 @@
-require_relative 'helper'
-require 'action_mailer/logged_smtp_delivery'
-require 'logger'
-
-class LoggedSMTPDeliveryTest < MiniTest::Unit::TestCase
-
-  class TestMailer < ActionMailer::Base
-    include ActionMailer::LoggedSMTPDelivery
-
-    self.mail_file_logger = MemoryLogger.new
-    self.logger           = Logger.new(StringIO.new)
-    self.delivery_method  = :logged_smtp
-    self.smtp_settings    = { :adaptor => FakeSMTP }
-
-    def welcome
-      recipients 'to@example.com'
-      from       'me@example.com'
-      body       'hello'
-
-      # Keep the message simple and consistent between test runs
-      headers['mime-version'] = ''
-      charset nil
-      headers['date'] = ''
-    end
-
-  end
-
-  describe 'delivering via actionmailer' do
-    before do
-      TestMailer.mail_file_logger.clear
-      FakeSMTP.deliveries.clear
-    end
-
-    it 'logs the mail to a file when the mail file logger is available' do
-      TestMailer.deliver_welcome
-      assert_equal "From: me@example.com\r\nTo: to@example.com\r\nContent-Type: text/plain\r\n\r\nhello", TestMailer.mail_file_logger.messages.last
-      TestMailer.mail_file_logger.messages.clear
-
-      original_logger = TestMailer.mail_file_logger
-      TestMailer.mail_file_logger = nil
-      assert TestMailer.deliver_welcome
-      TestMailer.mail_file_logger = original_logger
-    end
-
-    it 'delivers the mail' do
-      TestMailer.deliver_welcome
-      delivery = ["From: me@example.com\r\nTo: to@example.com\r\nContent-Type: text/plain\r\n\r\nhello", "me@example.com", ["to@example.com"]]
-
-      assert_equal delivery, FakeSMTP.deliveries.last
-    end
-
-  end
-
-  describe 'SMTP Delivery' do
-    before do
-      @settings = { :adaptor => FakeSMTP }
-      @mail     = TMail::Mail.new.tap do |mail|
-        mail.message_id = '<12345@example.com>'
-      end
-      @delivery = ActionMailer::LoggedSMTPDelivery::SMTPDelivery.new(@mail, @settings)
-      @log      = StringIO.new
-      @delivery.logger = Logger.new(@log)
-      @delivery.logger.formatter = lambda { |severity, datetime, progname, msg| msg }
-    end
-
-    it 'has the sender via the first from address' do
-      @mail.from = [ 'a@example.com', 'b@example.com' ]
-      assert_equal 'a@example.com', @delivery.sender
-    end
-
-    it 'has a list of destination addresses' do
-      @mail.to  = 'to@example.com'
-      @mail.cc  = 'cc@example.com'
-      @mail.bcc = 'bcc@example.com'
-
-      assert_equal [ 'to@example.com', 'cc@example.com','bcc@example.com' ], @delivery.destinations
-    end
-
-    it 'has an smtp connection' do
-      @delivery.settings[:address] = 'example.com'
-      @delivery.settings[:port]    = 26
-
-      smtp = @delivery.smtp
-      assert_equal 26,            smtp.port
-      assert_equal 'example.com', smtp.address
-      assert_equal true,          smtp.starttls_auto?
-
-      @delivery.settings[:tls]    = false
-      assert_equal false,         @delivery.smtp.starttls_auto?
-    end
-
-    it 'logs with the mail message id' do
-      @delivery.log 'hello'
-
-      assert_equal '<12345@example.com> hello', @log.string
-    end
-
-    it 'logs headers when the log header is provided' do
-      @delivery.log_headers
-      assert_equal '', @log.string
-
-      @delivery.settings[:log_header] = 'X-Delivery-Context'
-      @delivery.mail['X-Delivery-Context'] = 'hello-33'
-      @delivery.log_headers
-
-      assert_equal '<12345@example.com> X-Delivery-Context: [hello-33]', @log.string
-    end
-
-    it 'sends the mail' do
-      @mail.from = 'me@example.com'
-      @mail.to   = 'to@example.com'
-      @mail.cc   = 'cc@example.com'
-      @mail.bcc  = 'bcc@example.com'
-      @mail.body = 'hello'
-      message = [
-        "From: me@example.com\r\nTo: to@example.com\r\nCc: cc@example.com\r\nMessage-Id: <12345@example.com>\r\n\r\nhello",
-        "me@example.com",
-        ["to@example.com", "cc@example.com", "bcc@example.com"]
-      ]
-      @delivery.perform
-
-      assert_equal message, FakeSMTP.deliveries.last
-    end
-
-    it 'does not include BCC addresses in the message' do
-      @mail.bcc = 'bcc@example.com'
-      assert_equal false, @delivery.message.include?('bcc@example.com')
-    end
-
-  end
-
-end