mailtrap 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23acecf40de87c9ec6c68cee1a63244548f699819ce122b9f37877e6429a25e9
-  data.tar.gz: 5e2009cefd12428d8274ac79a57644f3b5bfcd6b4e266afc62ee5d274b22daa2
+  metadata.gz: 7dee4a202b02e16f840e8fc74526903e10418a0073c2392faf964dcdbcdfcde4
+  data.tar.gz: d35cf9fa125e8ec587f96626be7830f4398002173b7dc07c4560dddbbb0ddb3e
 SHA512:
-  metadata.gz: '00157801f3ae86ee16ffb51850c4af77f0213d736371fffacd3799c045f60955455f27c03283d8df16b41c5f0c635cfc22c1808c7d268c7b40c3d2ccd672e92c'
-  data.tar.gz: f8b80546c0dd317a64882cfb61ddbc8e646057da495508913fbefc9f26cd75a71129d807752a3cd41aa4df5ad38888e7c4a06247d2bbce8233af52d6507aa3e3
+  metadata.gz: 5b4c0ba57ab2cab64cec15704bd34c04be134360a2600d2fc530bcae47ab8caf2e8dd79ce7ba5fd342e46dad599153d473006613c953da868182dcff2bb1e2be
+  data.tar.gz: 45d64a548b0cd54e0f98394a8c6739d1bc5dcd90716105100f7bae92f7aa5913c9ff66fde412d8965d3818bc7d6594c1c218d96cfcde59eabc6bd92c1901e2c3

data/.rubocop.yml

@@ -3,6 +3,8 @@ require: rubocop-rspec
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
+  Exclude:
+    - 'gemfiles/**/*'
 
 Layout/LineLength:
   Max: 120
@@ -10,6 +12,9 @@ Layout/LineLength:
 Naming/MethodParameterName:
   MinNameLength: 2
 
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
 RSpec/MultipleExpectations:
   Max: 4
 

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise 'mail-2.7' do
+  gem 'mail', '~> 2.7.0'
+end
+
+appraise 'mail-2.8' do
+  gem 'mail', '~> 2.8.0'
+end

data/CHANGELOG.md

@@ -1,16 +1,27 @@
-## [1.0.0] - 2022-06-14
+## [1.2.1] - 2023-04-12
 
-- Initial release
+- Set custom user agent
 
-## [1.0.1] - 2022-06-20
+## [1.2.0] - 2023-01-27
 
-- Update packed files list
+- Breaking changes:
+  - move `Mailtrap::Sending::Mail` class to `Mailtrap::Mail::Base`
+  - move `Mailtrap::Sending::Convert` to `Mailtrap::Mail`
+- Add mail gem 2.8 support
+- Add email template support
 
+## [1.1.1] - 2022-10-14
+
+- Fix custom port and host usage
 
 ## [1.1.0] - 2022-07-22
 
 - Add ActionMailer support
 
-## [1.1.1] - 2022-10-14
+## [1.0.1] - 2022-06-20
 
-- Fix custom port and host usage
+- Update packed files list
+
+## [1.0.0] - 2022-06-14
+
+- Initial release

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'appraisal'
 gem 'mail'
 gem 'net-smtp'
 gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -1,13 +1,17 @@
 PATH
   remote: .
   specs:
-    mailtrap (1.1.1)
+    mailtrap (1.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
     ast (2.4.2)
     crack (0.4.5)
       rexml
@@ -55,6 +59,7 @@ GEM
     rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
+    thor (1.2.1)
     unicode-display_width (2.1.0)
     vcr (6.1.0)
     webmock (3.14.0)
@@ -66,6 +71,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal
   mail
   mailtrap!
   net-smtp

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Railsware Products Studio, Inc.
+Copyright (c) 2022 Railsware Products Studio LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/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: 'mailtrap@example.com', name: 'Mailtrap Test' },
   to: [
     { email: 'your@email.com' }
@@ -50,7 +50,7 @@ client.send(mail)
 require 'mailtrap'
 require 'base64'
 
-mail = Mailtrap::Sending::Mail.new(
+mail = Mailtrap::Mail::Base.new(
   from: { email: 'mailtrap@example.com', name: 'Mailtrap Test' },
   to: [
     { email: 'your@email.com', name: 'Your name' }
@@ -87,6 +87,28 @@ client = Mailtrap::Sending::Client.new(api_key: 'your-api-key')
 client.send(mail)
 ```
 
+### Using email template
+
+```ruby
+require 'mailtrap'
+
+# create mail object
+mail = Mailtrap::Mail::FromTemplate.new(
+  from: { email: 'mailtrap@example.com', name: 'Mailtrap Test' },
+  to: [
+    { email: 'your@email.com' }
+  ],
+  template_uuid: '2f45b0aa-bbed-432f-95e4-e145e1965ba2',
+  template_variables: {
+    'user_name' => 'John Doe'
+  }
+)
+
+# create client and send
+client = Mailtrap::Sending::Client.new(api_key: 'your-api-key')
+client.send(mail)
+```
+
 ### ActionMailer
 
 This gem also adds ActionMailer delivery method. To configure it, add following to your ActionMailer configuration (in Rails projects located in `config/$ENVIRONMENT.rb`):

data/lib/mailtrap/action_mailer/delivery_method.rb

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

data/lib/mailtrap/{sending/mail.rb → mail/base.rb}

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

data/lib/mailtrap/mail/from_template.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  module Mail
+    class FromTemplate < Base
+      attr_accessor :template_uuid, :template_variables
+
+      def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+        from: nil,
+        to: [],
+        cc: [],
+        bcc: [],
+        attachments: [],
+        headers: {},
+        custom_variables: {},
+        template_uuid: nil,
+        template_variables: {}
+      )
+        super(
+          from: from,
+          to: to,
+          cc: cc,
+          bcc: bcc,
+          attachments: attachments,
+          headers: headers,
+          custom_variables: custom_variables
+        )
+        @template_uuid = template_uuid
+        @template_variables = template_variables
+      end
+
+      def as_json
+        super.merge(
+          {
+            'template_uuid' => template_uuid,
+            'template_variables' => template_variables
+          }
+        ).compact
+      end
+    end
+  end
+end

data/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

data/lib/mailtrap/sending/client.rb

@@ -19,7 +19,7 @@ module Mailtrap
       end
 
       def send(mail)
-        raise ArgumentError, 'should be Mailtrap::Sending::Mail object' unless mail.is_a? Mailtrap::Sending::Mail
+        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)
@@ -38,6 +38,7 @@ module Mailtrap
         request.body = body
         request['Authorization'] = "Bearer #{api_key}"
         request['Content-Type'] = 'application/json'
+        request['User-Agent'] = 'mailtrap-ruby (https://github.com/railsware/mailtrap-ruby)'
 
         request
       end

data/lib/mailtrap/sending.rb

@@ -2,8 +2,6 @@
 
 require_relative 'sending/attachment'
 require_relative 'sending/client'
-require_relative 'sending/convert'
-require_relative 'sending/mail'
 
 module Mailtrap
   module Sending

data/lib/mailtrap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailtrap
-  VERSION = '1.1.1'
+  VERSION = '1.2.1'
 end

data/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'
 

data/mailtrap.gemspec

@@ -5,7 +5,7 @@ require_relative 'lib/mailtrap/version'
 Gem::Specification.new do |spec|
   spec.name = 'mailtrap'
   spec.version = Mailtrap::VERSION
-  spec.authors = ['Railsware Products Studio, Inc.']
+  spec.authors = ['Railsware Products Studio LLC']
   spec.email = ['support@mailtrap.io']
 
   spec.summary = 'Official mailtrap.io API client'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailtrap
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
-- Railsware Products Studio, Inc.
+- Railsware Products Studio LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies: []
 description: Official mailtrap.io API client
 email:
@@ -20,6 +20,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -31,11 +32,12 @@ files:
 - lib/mailtrap/action_mailer.rb
 - lib/mailtrap/action_mailer/delivery_method.rb
 - lib/mailtrap/action_mailer/railtie.rb
+- lib/mailtrap/mail.rb
+- lib/mailtrap/mail/base.rb
+- lib/mailtrap/mail/from_template.rb
 - lib/mailtrap/sending.rb
 - lib/mailtrap/sending/attachment.rb
 - lib/mailtrap/sending/client.rb
-- lib/mailtrap/sending/convert.rb
-- lib/mailtrap/sending/mail.rb
 - lib/mailtrap/version.rb
 - mailtrap.gemspec
 homepage: https://github.com/railsware/mailtrap-ruby

data/lib/mailtrap/sending/convert.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require 'base64'
-
-module Mailtrap
-  module Sending
-    module Convert
-      class << self
-        def from_message(message) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-          Mailtrap::Sending::Mail.new(
-            from: prepare_address(message['from']&.address_list&.addresses&.first),
-            to: prepare_addresses(message['to']&.address_list&.addresses),
-            cc: prepare_addresses(message['cc']&.address_list&.addresses),
-            bcc: prepare_addresses(message['bcc']&.address_list&.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 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.header[:content_id]&.field&.content_id
-            }.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
-end