Merge pull request #8 from railsware/mail-class-refactoring

Refactor Mail class: move to the top level to be used with both sandbox and sending APIs

Author: r4do

README.md

@@ -30,7 +30,7 @@ Or install it yourself as:
 require 'mailtrap'
 
 # create mail object
-mail = Mailtrap::Sending::Mail.new(
+mail = Mailtrap::Mail::Base.new(
   from: { email: '[email protected]', name: 'Mailtrap Test' },
   to: [
     { email: '[email protected]' }
@@ -50,7 +50,7 @@ client.send(mail)
 require 'mailtrap'
 require 'base64'
 
-mail = Mailtrap::Sending::Mail.new(
+mail = Mailtrap::Mail::Base.new(
   from: { email: '[email protected]', name: 'Mailtrap Test' },
   to: [
     { email: '[email protected]', name: 'Your name' }
@@ -93,7 +93,7 @@ client.send(mail)
 require 'mailtrap'
 
 # create mail object
-mail = Mailtrap::Sending::MailFromTemplate.new(
+mail = Mailtrap::Mail::FromTemplate.new(
   from: { email: '[email protected]', name: 'Mailtrap Test' },
   to: [
     { email: '[email protected]' }

lib/mailtrap.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'mailtrap/action_mailer' if defined? ActionMailer
+require_relative 'mailtrap/mail'
 require_relative 'mailtrap/sending'
 require_relative 'mailtrap/version'
 

lib/mailtrap/action_mailer/delivery_method.rb

@@ -10,7 +10,7 @@ def initialize(settings)
       end
 
       def deliver!(message)
-        mail = Mailtrap::Sending::Convert.from_message(message)
+        mail = Mailtrap::Mail.from_message(message)
 
         client.send(mail)
       end

lib/mailtrap/mail.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+require_relative 'mail/base'
+require_relative 'mail/from_template'
+
+module Mailtrap
+  module Mail
+    class << self
+      def from_message(message) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+        Mailtrap::Mail::Base.new(
+          from: prepare_address(address_list(message['from'])&.addresses&.first),
+          to: prepare_addresses(address_list(message['to'])&.addresses),
+          cc: prepare_addresses(address_list(message['cc'])&.addresses),
+          bcc: prepare_addresses(address_list(message['bcc'])&.addresses),
+          subject: message.subject,
+          text: prepare_text_part(message),
+          html: prepare_html_part(message),
+          headers: prepare_headers(message),
+          attachments: prepare_attachments(message.attachments),
+          category: message['category']&.unparsed_value,
+          custom_variables: message['custom_variables']&.unparsed_value
+        )
+      end
+
+      private
+
+      PROCESSED_HEADERS = %w[
+        from
+        to
+        cc
+        bcc
+        subject
+        category
+        customvariables
+        contenttype
+      ].freeze
+
+      def address_list(header)
+        header.respond_to?(:element) ? header.element : header&.address_list
+      end
+
+      def prepare_addresses(addresses)
+        Array(addresses).map { |address| prepare_address(address) }
+      end
+
+      def prepare_headers(message)
+        message
+          .header_fields
+          .reject { |header| PROCESSED_HEADERS.include?(header.name.downcase.delete('-')) }
+          .to_h { |header| [header.name, header.value] }
+          .compact
+      end
+
+      def prepare_address(address)
+        {
+          email: address.address,
+          name: address.display_name
+        }.compact
+      end
+
+      def prepare_attachments(attachments_list = [])
+        attachments_list.map do |attachment|
+          {
+            content: Base64.strict_encode64(attachment.body.decoded),
+            type: attachment.mime_type,
+            filename: attachment.filename,
+            disposition: attachment.header[:content_disposition]&.disposition_type,
+            content_id: attachment&.cid
+          }.compact
+        end
+      end
+
+      def prepare_html_part(message)
+        return message.body.decoded if message.mime_type == 'text/html'
+
+        message.html_part&.decoded
+      end
+
+      def prepare_text_part(message)
+        return message.body.decoded if message.mime_type == 'text/plain' || message.mime_type.nil?
+
+        message.text_part&.decoded
+      end
+    end
+  end
+end

lib/mailtrap/sending/base.rb renamed to lib/mailtrap/mail/base.rb

@@ -3,39 +3,51 @@
 require 'json'
 
 module Mailtrap
-  module Sending
+  module Mail
     class Base
-      attr_accessor :from, :to, :cc, :bcc, :headers, :custom_variables
+      attr_accessor :from, :to, :cc, :bcc, :headers, :custom_variables, :subject, :text, :html, :category
       attr_reader :attachments
 
-      def initialize( # rubocop:disable Metrics/ParameterLists
+      def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
         from: nil,
         to: [],
         cc: [],
         bcc: [],
+        subject: nil,
+        text: nil,
+        html: nil,
         attachments: [],
         headers: {},
-        custom_variables: {}
+        custom_variables: {},
+        category: nil
       )
         @from = from
         @to = to
         @cc = cc
         @bcc = bcc
+        @subject = subject
+        @text = text
+        @html = html
         self.attachments = attachments
         @headers = headers
         @custom_variables = custom_variables
+        @category = category
       end
 
-      def as_json
+      def as_json # rubocop:disable Metrics/MethodLength
         {
-          'to' => to,
           'from' => from,
+          'to' => to,
           'cc' => cc,
           'bcc' => bcc,
+          'subject' => subject,
+          'text' => text,
+          'html' => html,
           'attachments' => attachments.map(&:as_json),
           # TODO: update headers and custom_variables with as_json method
           'headers' => headers,
-          'custom_variables' => custom_variables
+          'custom_variables' => custom_variables,
+          'category' => category
         }.compact
       end
 

lib/mailtrap/sending/mail_from_template.rb renamed to lib/mailtrap/mail/from_template.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mailtrap
-  module Sending
-    class MailFromTemplate < Base
+  module Mail
+    class FromTemplate < Base
       attr_accessor :template_uuid, :template_variables
 
       def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength

lib/mailtrap/sending.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'sending/attachment'
-require_relative 'sending/base'
 require_relative 'sending/client'
-require_relative 'sending/convert'
-require_relative 'sending/mail'
-require_relative 'sending/mail_from_template'
 
 module Mailtrap
   module Sending

lib/mailtrap/sending/client.rb

@@ -19,7 +19,7 @@ def initialize(api_key: ENV.fetch('MAILTRAP_API_KEY'), api_host: API_HOST, api_p
       end
 
       def send(mail)
-        raise ArgumentError, 'should be Mailtrap::Sending::Base object' unless mail.is_a? Base
+        raise ArgumentError, 'should be Mailtrap::Mail::Base object' unless mail.is_a? Mail::Base
 
         request = post_request('/api/send', mail.to_json)
         response = http_client.request(request)