mailtrap 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7529f2a048f1670c6eb22f04a9308e17fb3072a0bcacdff87f3772e45f792201
-  data.tar.gz: bc71abbd0af5a9c79d719aaaa69671aa836ec00f3a42c1c94991605ab803494d
+  metadata.gz: 30f80c3c771f5d73e22d3731d3f8d619793be03b378f48251e0e17e0e33d5d60
+  data.tar.gz: 41523de1f211b8ef4900efe6abd2343afb67803921fe495372c1d780d5b0f6fa
 SHA512:
-  metadata.gz: ad794ce35f915afd6ff52da55278c21146630f8f05a5f544477dbeb53c9eb7cf3277632b0f3584c909c6b3d8f2bd339c575f1d32da5065b86f88450053e716c1
-  data.tar.gz: f5b564ce76bc6d9157c5e58654cbfe54ee7f1cf169b53b2d3856ecf8fda1cd7b1fef6becc6eac2ed6bf3bbbed29eb63b8bcfb8c58fb237e37d4b68e43a78a020
+  metadata.gz: 781f8682fec57e56274d6de148bf24cc2d21ae8582e31a00585eaceb15481cf8b8508f9f1ba7f32b54e71c3c18b5062a6f2be407f5e14df0b78b5038a1086e9e
+  data.tar.gz: 1f22fc8e1c76efb7e0050d68b731ea0ceba6a65a8d37cea1da72369d41287f657492e005683648b1b7279e15e059f6c14a4ec724015763f2d212bde1407dd097

data/.rubocop.yml

@@ -1,10 +1,16 @@
-require: rubocop-rspec
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - Exclude
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   NewCops: enable
   Exclude:
-    - 'gemfiles/**/*'
+    - "gemfiles/**/*"
 
 Layout/LineLength:
   Max: 120
@@ -34,8 +40,8 @@ Style/StringLiteralsInInterpolation:
 
 Style/FrozenStringLiteralComment:
   Exclude:
-    - 'examples/**/*'
+    - "examples/**/*"
 
 Style/TrailingCommaInHashLiteral:
   Exclude:
-    - 'examples/**/*'
+    - "examples/**/*"

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [2.1.1] - 2024-12-11
+
+- Improved handling of empty `from`
+
+## [2.1.0] - 2024-07-08
+
+- Fixed extraneous headers added by ActionMailer #21
+- Dropped Ruby 2.7 support and added test coverage for Ruby up to 3.3 #22
+
 ## [2.0.0] - 2024-03-20
 
 - Added arguments for `Mailtrap::Client`

data/Gemfile

@@ -11,6 +11,7 @@ gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rspec-its'
 gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake', require: false
 gem 'rubocop-rspec', require: false
 gem 'vcr'
 gem 'webmock'

data/Gemfile.lock

@@ -1,68 +1,91 @@
 PATH
   remote: .
   specs:
-    mailtrap (2.0.0)
+    mailtrap (2.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    appraisal (2.4.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    appraisal (2.5.0)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
-    crack (0.4.5)
+    bigdecimal (3.1.8)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
-    hashdiff (1.0.1)
-    mail (2.7.1)
+    date (3.3.4)
+    diff-lcs (1.5.1)
+    hashdiff (1.1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    mail (2.8.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)
+      net-imap
+      net-pop
+      net-smtp
+    mini_mime (1.1.5)
+    net-imap (0.4.14)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    parallel (1.25.1)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.7)
+      racc
+    public_suffix (5.1.1)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.4.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
+      rspec-support (~> 3.13.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.11.1)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.29.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    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)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.0.2)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    unicode-display_width (2.5.0)
+    vcr (6.2.0)
+    webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -79,9 +102,10 @@ DEPENDENCIES
   rspec (~> 3.0)
   rspec-its
   rubocop (~> 1.21)
+  rubocop-rake
   rubocop-rspec
   vcr
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.5.14

data/README.md

@@ -1,4 +1,9 @@
 [![test](https://github.com/railsware/mailtrap-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/railsware/mailtrap-ruby/actions/workflows/main.yml)
+[![docs](https://shields.io/badge/docs-rubydoc.info-blue)](https://rubydoc.info/gems/mailtrap)
+[![gem](https://shields.io/gem/v/mailtrap)](https://rubygems.org/gems/mailtrap)
+[![downloads](https://shields.io/gem/dt/mailtrap)](https://rubygems.org/gems/mailtrap)
+
+
 
 # Official Mailtrap Ruby client
 
@@ -26,7 +31,17 @@ Or install it yourself as:
 
 ## Usage
 
-### Minimal
+### Ruby on Rails
+
+```ruby
+# place this code in config/environments/production.rb:
+config.action_mailer.delivery_method = :mailtrap
+
+# then set the MAILTRAP_API_KEY environment variable
+# using your hosting solution.
+```
+
+### Pure Ruby
 
 ```ruby
 require 'mailtrap'
@@ -46,7 +61,7 @@ client = Mailtrap::Client.new(api_key: 'your-api-key')
 client.send(mail)
 ```
 
-Refer to the [`examples`](examples) folder for other examples.
+Refer to the [`examples`](examples) folder for more examples.
 
 - [Full](examples/full.rb)
 - [Email template](examples/email_template.rb)
@@ -55,15 +70,15 @@ Refer to the [`examples`](examples) folder for other examples.
 ### Content-Transfer-Encoding
 
 `mailtrap` gem uses Mailtrap API to send emails. Mailtrap API does not try to
-replicate SMTP. That is why you should expect some limitations when it comes to 
+replicate SMTP. That is why you should expect some limitations when it comes to
 sending. For example, `/api/send` endpoint ignores `Content-Transfer-Encoding`
 (see `headers` in the [API documentation](https://railsware.stoplight.io/docs/mailtrap-api-docs/67f1d70aeb62c-send-email)).
-Meaning your recipients will receive emails only in the default encoding which 
+Meaning your recipients will receive emails only in the default encoding which
 is `quoted-printable`, if you send with Mailtrap API.
 
-For those who does need to use `7bit` or any other encoding, SMTP provides 
-better flexibility in that regard. Go to your _Mailtrap account_ → _Email Sending_ 
-→ _Sending Domains_ → _Your domain_ → _SMTP/API Settings_ to find the SMTP 
+For those who does need to use `7bit` or any other encoding, SMTP provides
+better flexibility in that regard. Go to your _Mailtrap account_ → _Email Sending_
+→ _Sending Domains_ → _Your domain_ → _SMTP/API Settings_ to find the SMTP
 configuration example.
 
 ## Migration guide v1 → v2

data/lib/mailtrap/attachment.rb

@@ -40,7 +40,7 @@ module Mailtrap
 
     def encode(io)
       string = io.read.encode('UTF-8') unless io.respond_to?(:binmode?) && io.binmode?
-      Base64.encode64(string).gsub(/\n/, '')
+      Base64.encode64(string).gsub("\n", '')
     end
 
     def base64?(string)

data/lib/mailtrap/mail.rb

@@ -8,9 +8,9 @@ require_relative 'mail/from_template'
 module Mailtrap
   module Mail
     class << self
-      def from_message(message) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+      def from_message(message) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         Mailtrap::Mail::Base.new(
-          from: prepare_address(address_list(message['from'])&.addresses&.first),
+          from: prepare_addresses(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),
@@ -26,7 +26,7 @@ module Mailtrap
 
       private
 
-      PROCESSED_HEADERS = %w[
+      SPECIAL_HEADERS = %w[
         from
         to
         cc
@@ -37,6 +37,19 @@ module Mailtrap
         contenttype
       ].freeze
 
+      # ActionMailer adds these headers by calling `Mail::Message#encoded`,
+      # as if the message is to be delivered via SMTP.
+      # Since the message will actually be generated on the Mailtrap side from its components,
+      # the headers are redundant and potentially conflicting, so we remove them.
+      ACTIONMAILER_ADDED_HEADERS = %w[
+        contenttransferencoding
+        date
+        messageid
+        mimeversion
+      ].freeze
+
+      HEADERS_TO_REMOVE = (SPECIAL_HEADERS + ACTIONMAILER_ADDED_HEADERS).freeze
+
       def address_list(header)
         header.respond_to?(:element) ? header.element : header&.address_list
       end
@@ -48,7 +61,7 @@ module Mailtrap
       def prepare_headers(message)
         message
           .header_fields
-          .reject { |header| PROCESSED_HEADERS.include?(header.name.downcase.delete('-')) }
+          .reject { |header| HEADERS_TO_REMOVE.include?(header.name.downcase.delete('-')) }
           .to_h { |header| [header.name, header.value] }
           .compact
       end

data/lib/mailtrap/version.rb

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

data/mailtrap.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 3.0.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/railsware/mailtrap-ruby'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailtrap
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Railsware Products Studio LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies: []
 description: Official mailtrap.io API client
 email:
@@ -19,7 +19,6 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -56,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.ruby-version

@@ -1 +0,0 @@
-2.7.6