mailtrap 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5423fd6ba2817ace06e724da478e925615f3c8b4dfcbf24eb271f6bb12fded4c
-  data.tar.gz: b331be242b93d7176adf0ca92d01f33d0bc7a9407766d8d139d8bb39d7d2382b
+  metadata.gz: 314cfc7c3cd8a6e45f719fc3d8063a5ca9d9cb96109989d558699460c5246735
+  data.tar.gz: 6db332cea7a1c9e8409c22a47145b74b9a5a45d74cc34a3663bc138fd7bf52a7
 SHA512:
-  metadata.gz: 9c2556e7ea3b7405ec76910a718ba949694563dabc4547fc6b33771bd52a2bd0e444e287bcc341c6c5e1bdab07bd12573c3ce9607cbcc84afbd8398aafbccf4c
-  data.tar.gz: 06f0ea3e473461ad889e101540ba2d2a37cfda75ce3a4677ab58708ddae8ce4cae53d16426f4b30e54bf899e9a5f3cca0c46e0616c49b9da80be9c1e8c308c67
+  metadata.gz: 9d86a290cd93fea1c62a5bf5c5ee1d32a49bf23bd9736edf1d4cffe5d1c40d474b62cda3741deb388ff24e937eb036ce618605155f5b7e66f4a95918d400315e
+  data.tar.gz: 51548a285463a11ef0c408f9cb03d2621bb0ede07c75c63773218a85616fcd727724b15687389350fdaf4907f6c173a95fee1d17d4648c5f0d315817acf7bbec

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [2.1.2] - 2024-12-13
+
+- Improved handling of invalid `from`, `to`, `cc`, `bcc` headers when sending
+  with Action Mailer
+
+## [2.1.1] - 2024-12-11
+
+- Improved handling of empty `from` header when sending with Action Mailer
+
 ## [2.1.0] - 2024-07-08
 
 - Fixed extraneous headers added by ActionMailer #21

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailtrap (2.1.0)
+    mailtrap (2.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -46,8 +46,7 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.1)
-      strscan
+    rexml (3.3.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -82,7 +81,6 @@ GEM
     rubocop-rspec (3.0.2)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
     thor (1.3.1)
     timeout (0.4.1)
     unicode-display_width (2.5.0)

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/mail.rb

@@ -4,13 +4,16 @@ require 'base64'
 
 require_relative 'mail/base'
 require_relative 'mail/from_template'
+require_relative 'errors'
 
 module Mailtrap
   module Mail
     class << self
-      def from_message(message) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+      # @param message [Mail::Message]
+      # @return [Mailtrap::Mail::Base]
+      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),
@@ -50,10 +53,19 @@ module Mailtrap
 
       HEADERS_TO_REMOVE = (SPECIAL_HEADERS + ACTIONMAILER_ADDED_HEADERS).freeze
 
+      # @param header [Mail::Field, nil]
+      # @return [Mail::AddressList, nil]
       def address_list(header)
-        header.respond_to?(:element) ? header.element : header&.address_list
+        return nil unless header
+
+        unless header.errors.empty?
+          raise Mailtrap::Error, ["failed to parse '#{header.name}': '#{header.unparsed_value}'"]
+        end
+
+        header.respond_to?(:element) ? header.element : header.address_list
       end
 
+      # @param addresses [Array<Mail::Address>, nil]
       def prepare_addresses(addresses)
         Array(addresses).map { |address| prepare_address(address) }
       end
@@ -66,6 +78,7 @@ module Mailtrap
           .compact
       end
 
+      # @param address [Mail::Address]
       def prepare_address(address)
         {
           email: address.address,

data/lib/mailtrap/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailtrap
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Railsware Products Studio LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-12-13 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

data/.ruby-version

@@ -1 +0,0 @@
-3.3.3