postmortem 0.1.0 → 0.2.1

data/lib/postmortem/adapters/mail.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Postmortem
+  module Adapters
+    # Mail adapter.
+    class Mail < Base
+      private
+
+      def adapted
+        %i[from reply_to to cc bcc subject]
+          .map { |field| [field, @data.public_send(field)] }
+          .to_h
+          .merge({ text_body: @data.text_part, html_body: @data.html_part })
+      end
+
+      def mail
+        @mail ||= @data
+      end
+    end
+  end
+end

data/lib/postmortem/adapters/pony.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Postmortem
+  module Adapters
+    # Pony adapter.
+    class Pony < Base
+      private
+
+      def adapted
+        {
+          from: mail.from,
+          reply_to: mail.reply_to,
+          to: mail.to,
+          cc: mail.cc,
+          bcc: mail.bcc,
+          subject: mail.subject,
+          text_body: @data[:body],
+          html_body: @data[:html_body]
+        }
+      end
+
+      def mail
+        @mail ||= ::Mail.new(@data.select { |key| keys.include?(key) })
+      end
+
+      def keys
+        %i[from reply_to to cc bcc subject text_body html_body]
+      end
+    end
+  end
+end

data/lib/postmortem/configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Postmortem
+  # Provides interface for configuring Postmortem and implements sensible defaults.
+  class Configuration
+    attr_writer :colorize, :mail_skip_delivery
+    attr_accessor :log_path
+
+    def colorize
+      defined?(@colorize) ? @colorize : true
+    end
+
+    def preview_directory=(val)
+      @preview_directory = Pathname.new(val)
+    end
+
+    def layout=(val)
+      @layout = Pathname.new(val)
+    end
+
+    def layout
+      default = File.expand_path(File.join(__dir__, '..', '..', 'layout', 'default'))
+      path = Pathname.new(@layout || default)
+      path.extname.empty? ? path.sub_ext('.html.erb') : path
+    end
+
+    def preview_directory
+      @preview_directory ||= Pathname.new(File.join(Dir.tmpdir, 'postmortem'))
+    end
+
+    def mail_skip_delivery
+      defined?(@mail_skip_delivery) ? @mail_skip_delivery : true
+    end
+  end
+end

data/lib/postmortem/delivery.rb

@@ -3,32 +3,43 @@
 module Postmortem
   # Abstraction of an email delivery. Capable of writing email HTML body to disk.
   class Delivery
-    attr_reader :path
+    attr_reader :path, :index_path
 
-    def initialize(adapter)
-      @adapter = adapter
-      @path = Postmortem.output_directory.join(filename)
+    def initialize(mail)
+      @mail = mail
+      @path = Postmortem.config.preview_directory.join('emails.html')
+      @index_path = Postmortem.config.preview_directory.join('index.html')
     end
 
     def record
       path.parent.mkpath
-      File.write(path, Layout.new(@adapter).content)
+      content = Layout.new(@mail).content
+      path.write(content)
+      index_path.write(index.content)
     end
 
     private
 
-    def filename
-      "#{timestamp}__#{safe_subject}.html"
+    def index
+      @index ||= Index.new(index_path, path, timestamp, @mail)
     end
 
     def timestamp
-      Time.now.strftime('%Y-%m-%d_%H-%M-%S')
+      @timestamp ||= Time.now
     end
 
-    def safe_subject
-      return 'no-subject' if @adapter.subject.empty?
+    def token
+      SecureRandom.hex(4)
+    end
+
+    def subject
+      return 'no-subject' if @mail.subject.nil? || @mail.subject.empty?
 
-      @adapter.subject.tr(' ', '_').split('').select { |char| safe_chars.include?(char) }.join
+      @mail.subject
+    end
+
+    def safe_subject
+      subject.tr(' ', '_').split('').select { |char| safe_chars.include?(char) }.join
     end
 
     def safe_chars

data/lib/postmortem/index.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Postmortem
+  # Generates and parses an index of previously-sent emails.
+  class Index
+    def initialize(index_path, mail_path, timestamp, mail)
+      @index_path = index_path
+      @mail_path = mail_path
+      @timestamp = timestamp.iso8601
+      @mail = mail
+    end
+
+    def content
+      mail_path = @mail_path
+      ERB.new(File.read(template_path), nil, '-').result(binding)
+    end
+
+    def size
+      encoded_index.size
+    end
+
+    private
+
+    def encoded_index
+      return [encoded_mail] unless @index_path.file?
+
+      @encoded_index ||= [encoded_mail] + lines[index(:start)..index(:end)]
+    end
+
+    def encoded_mail
+      Base64.encode64(mail_data.to_json).split("\n").join
+    end
+
+    def mail_data
+      {
+        subject: @mail.subject || '(no subject)',
+        timestamp: @timestamp,
+        path: @mail_path,
+        content: @mail.serializable
+      }
+    end
+
+    def lines
+      @lines ||= @index_path.read.split("\n")
+    end
+
+    def index(position)
+      offset = { start: 1, end: -1 }.fetch(position)
+      lines.index(marker(position)) + offset
+    end
+
+    def marker(position)
+      "### INDEX #{position.to_s.upcase}"
+    end
+
+    def template_path
+      File.expand_path(File.join(__dir__, '..', '..', 'layout', 'index.html.erb'))
+    end
+  end
+end

data/lib/postmortem/layout.rb

@@ -3,13 +3,96 @@
 module Postmortem
   # Wraps provided body in an enclosing layout for presentation purposes.
   class Layout
-    def initialize(adapter)
-      @adapter = adapter
+    def initialize(mail)
+      @mail = mail
+    end
+
+    def format_email_array(array)
+      array&.map { |email| %(<a href="mailto:#{email}">#{email}</a>) }&.join(', ')
     end
 
     def content
-      mail = @adapter
-      ERB.new(Postmortem.layout.read).result(binding)
+      mail = @mail
+      mail.html_body = with_inlined_images(mail.html_body) if defined?(Nokogiri)
+      ERB.new(Postmortem.config.layout.read).result(binding)
+    end
+
+    def styles
+      default_layout_directory.join('layout.css').read
+    end
+
+    def javascript
+      default_layout_directory.join('layout.js').read
+    end
+
+    def css_dependencies
+      default_layout_directory.join('dependencies.css').read
+    end
+
+    def javascript_dependencies
+      default_layout_directory.join('dependencies.js').read
+    end
+
+    def headers_template
+      default_layout_directory.join('headers_template.html').read
+    end
+
+    private
+
+    def default_layout_directory
+      Postmortem.root.join('layout')
+    end
+
+    def with_inlined_images(body)
+      parsed = Nokogiri::HTML.parse(body)
+      parsed.css('img').each do |img|
+        uri = try_uri(img['src'])
+        next unless local_file?(uri)
+
+        path = located_image(uri)
+        img['src'] = encoded_image(path) unless path.nil?
+      end
+      parsed.to_s
+    end
+
+    def local_file?(uri)
+      return false if uri.nil?
+      return true if uri.host.nil?
+      return true if /^www\.example\.[a-z]+$/.match(uri.host)
+      return true if %w[127.0.0.1 localhost].include?(uri.host)
+
+      false
+    end
+
+    def try_uri(uri)
+      URI(uri)
+    rescue URI::InvalidURIError
+      nil
+    end
+
+    def located_image(uri)
+      path = uri.path.partition('/').last
+      common_locations.each do |location|
+        full_path = location.join(path)
+        next unless full_path.file?
+
+        return full_path
+      end
+
+      nil
+    end
+
+    def encoded_image(path)
+      "data:#{mime_type(path)};base64,#{Base64.encode64(path.read)}"
+    end
+
+    def common_locations
+      ['public/assets', 'app/assets/images'].map { |path| Pathname.new(path) }
+    end
+
+    def mime_type(path)
+      extension = path.extname.partition('.').last
+      extension == 'jpg' ? 'jpeg' : extension
     end
   end
 end

data/lib/postmortem/plugins/mail.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Mail::SMTP.class_eval do
+  alias_method :_original_deliver!, :deliver!
+
+  def deliver!(mail)
+    result = _original_deliver!(mail) unless Postmortem.config.mail_skip_delivery
+    Postmortem.record_delivery(Postmortem::Adapters::Mail.new(mail))
+    result
+  end
+end

data/lib/postmortem/plugins/pony.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Pony monkey-patch.
+module Pony
+  class << self
+    alias _original_mail mail
+
+    def mail(options)
+      # SMTP delivery is handled by Mail plugin further down the stack
+      return _original_mail(options) if options[:via].to_s == 'smtp'
+
+      result = _original_mail(options) unless Postmortem.config.mail_skip_delivery
+      Postmortem.record_delivery(Postmortem::Adapters::Pony.new(options))
+      result
+    end
+  end
+end

data/lib/postmortem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Postmortem
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/postmortem.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'mail', '~> 2.7'
 
   spec.add_development_dependency 'actionmailer', '~> 6.0'
+  spec.add_development_dependency 'pony', '~> 1.13'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'rubocop', '~> 0.88.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postmortem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bob Farrell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-15 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,22 +132,35 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- doc/screenshot.png
 - layout/default.html.erb
+- layout/dependencies.css
+- layout/dependencies.js
+- layout/headers_template.html
+- layout/index.html.erb
+- layout/layout.css
+- layout/layout.js
 - lib/postmortem.rb
-- lib/postmortem/action_mailer.rb
 - lib/postmortem/adapters.rb
 - lib/postmortem/adapters/action_mailer.rb
 - lib/postmortem/adapters/base.rb
+- lib/postmortem/adapters/mail.rb
+- lib/postmortem/adapters/pony.rb
+- lib/postmortem/configuration.rb
 - lib/postmortem/delivery.rb
+- lib/postmortem/index.rb
 - lib/postmortem/layout.rb
+- lib/postmortem/plugins/action_mailer.rb
+- lib/postmortem/plugins/mail.rb
+- lib/postmortem/plugins/pony.rb
 - lib/postmortem/version.rb
 - postmortem.gemspec
 homepage: https://github.com/bobf/postmortem
@@ -143,7 +170,7 @@ metadata:
   homepage_uri: https://github.com/bobf/postmortem
   source_code_uri: https://github.com/bobf/postmortem
   changelog_uri: https://github.com/bobf/postmortem/blob/master/README.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +185,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: Development HTML Email Inspection Tool
 test_files: []