mailtrap 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab906395e1a92aac49d71c10d3e8935982997a51b05b52efd6ceee3c847e49a8
-  data.tar.gz: a86a0f2d5a265742d8801533c8c1566f2dd96af21af3d22197aea1dd7b788d4e
+  metadata.gz: 23acecf40de87c9ec6c68cee1a63244548f699819ce122b9f37877e6429a25e9
+  data.tar.gz: 5e2009cefd12428d8274ac79a57644f3b5bfcd6b4e266afc62ee5d274b22daa2
 SHA512:
-  metadata.gz: e2d3a90dabf85ebc515b5213a087c65eb6ca444c3848b913d550a4ebf937b5e318cecc8307261a2ae21f033e367bd5f3113d3191d7a0a4f70acd5e4ede738d20
-  data.tar.gz: 4d30beda4f75470bf4f3d72145d0ff1f0ed784261df3954de17fa56d3c54a9a77ebddead2d468e7b4f53172bf5df498fac773e92198ad033e474b5e139a53d09
+  metadata.gz: '00157801f3ae86ee16ffb51850c4af77f0213d736371fffacd3799c045f60955455f27c03283d8df16b41c5f0c635cfc22c1808c7d268c7b40c3d2ccd672e92c'
+  data.tar.gz: f8b80546c0dd317a64882cfb61ddbc8e646057da495508913fbefc9f26cd75a71129d807752a3cd41aa4df5ad38888e7c4a06247d2bbce8233af52d6507aa3e3

data/.rubocop.yml

@@ -13,6 +13,9 @@ Naming/MethodParameterName:
 RSpec/MultipleExpectations:
   Max: 4
 
+RSpec/NestedGroups:
+  Max: 4
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -5,3 +5,12 @@
 ## [1.0.1] - 2022-06-20
 
 - Update packed files list
+
+
+## [1.1.0] - 2022-07-22
+
+- Add ActionMailer support
+
+## [1.1.1] - 2022-10-14
+
+- Fix custom port and host usage

data/Gemfile

@@ -4,6 +4,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'mail'
+gem 'net-smtp'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rspec-its'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailtrap (1.0.1)
+    mailtrap (1.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +13,10 @@ GEM
       rexml
     diff-lcs (1.5.0)
     hashdiff (1.0.1)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.1.2)
+    net-smtp (0.1.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -62,7 +66,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  mail
   mailtrap!
+  net-smtp
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-its

data/README.md

@@ -87,6 +87,27 @@ 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`):
+```ruby
+config.action_mailer.delivery_method = :mailtrap
+config.action_mailer.mailtrap_settings = {
+  api_key: ENV.fetch('MAILTRAP_API_KEY')
+}
+```
+And continue to use ActionMailer as usual.
+
+To add `category` and `custom_variables`, add them to the mail generation:
+```ruby
+mail(
+  to: 'your@email.com',
+  subject: 'You are awesome!',
+  category: 'Test category',
+  custom_variables: { test_variable: 'abc' }
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/mailtrap/action_mailer/delivery_method.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  module ActionMailer
+    class DeliveryMethod
+      attr_accessor :settings
+
+      def initialize(settings)
+        self.settings = settings
+      end
+
+      def deliver!(message)
+        mail = Mailtrap::Sending::Convert.from_message(message)
+
+        client.send(mail)
+      end
+
+      private
+
+      def client
+        @client ||= Mailtrap::Sending::Client.new(**settings.slice(:api_key, :api_host, :api_port))
+      end
+    end
+  end
+end

data/lib/mailtrap/action_mailer/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  module ActionMailer
+    class Railtie < Rails::Railtie
+      initializer 'mailtrap_action_mailer.add_delivery_method', before: 'action_mailer.set_configs' do
+        ActiveSupport.on_load(:action_mailer) do
+          ::ActionMailer::Base.add_delivery_method(:mailtrap, Mailtrap::ActionMailer::DeliveryMethod)
+        end
+      end
+    end
+  end
+end

data/lib/mailtrap/action_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'action_mailer/delivery_method'
+require_relative 'action_mailer/railtie' if defined? Rails
+
+module Mailtrap
+  module ActionMailer; end
+end

data/lib/mailtrap/sending/client.rb

@@ -30,7 +30,7 @@ module Mailtrap
       private
 
       def http_client
-        @http_client ||= Net::HTTP.new(API_HOST, API_PORT).tap { |client| client.use_ssl = true }
+        @http_client ||= Net::HTTP.new(api_host, api_port).tap { |client| client.use_ssl = true }
       end
 
       def post_request(path, body)

data/lib/mailtrap/sending/convert.rb

@@ -0,0 +1,83 @@
+# 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

data/lib/mailtrap/sending.rb

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

data/lib/mailtrap/version.rb

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

data/lib/mailtrap.rb

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

data/mailtrap.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mailtrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mailtrap'
+  spec.version = Mailtrap::VERSION
+  spec.authors = ['Railsware Products Studio, Inc.']
+  spec.email = ['support@mailtrap.io']
+
+  spec.summary = 'Official mailtrap.io API client'
+  spec.description = 'Official mailtrap.io API client'
+  spec.homepage = 'https://github.com/railsware/mailtrap-ruby'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/railsware/mailtrap-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/railsware/mailtrap-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|github|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailtrap
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Railsware Products Studio, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-20 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies: []
 description: Official mailtrap.io API client
 email:
@@ -28,11 +28,16 @@ files:
 - README.md
 - Rakefile
 - lib/mailtrap.rb
+- lib/mailtrap/action_mailer.rb
+- lib/mailtrap/action_mailer/delivery_method.rb
+- lib/mailtrap/action_mailer/railtie.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
 licenses:
 - MIT