mailpace-rails 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810e29220dad031ea534f019a029ff4d476687b2fd1b32a52fec6c4560411ec8
-  data.tar.gz: 4f989e26f0198db062f9ef63f1d4e31e03decad52fbd90b4a23589d59884b8f2
+  metadata.gz: 116f3c2d1a6a94ee97b33eccd6b576ffa86146e262fa18fea458fd30cc6ce9bb
+  data.tar.gz: 367ca296eff427a12a36a56096a04ebc0e694f635d9667c629db4b67c67f65bd
 SHA512:
-  metadata.gz: ee5ae6d07eea2abc0b0455dece234474c4e32a27e8b32a615415baf5f7a87937eb8ec85eead066ab2f66111a033340272847acd8f7f3e6fe9dd5990e22412bc4
-  data.tar.gz: 22fbd9a58c476999f6dd8d77fa186af27c2c5911d0b018ca5f13fc981d3e755e8ff6bb8f434327852d9f34c6e6c5349bd6ade43b26926127b41e7a32047f42bc
+  metadata.gz: 2c93b6b5261b781d2692f76732deea6940ab615229cb548986d44023245e5426fdb98937a046cb7dc7f57b5f3c14301107784b22aca641f6c5e10fc1c4ae3467
+  data.tar.gz: 9a4e461785290e63f2bced09602a6c9770ca747d120ba8ac1247d9fc7a792bf91347f74ef759473604baefdb46cdaf9a9cf56c351ba8e6b4d87b1db97d9c09ce

data/README.md

@@ -8,6 +8,8 @@
 
 The MailPace Rails Gem is a plug in for ActionMailer to send emails via [MailPace](https://mailpace.com) to make sending emails from Rails apps super simple.
 
+> **New in 0.4.0: [Idempotent Requests](https://docs.mailpace.com/guide/idempotency/), Improved Error Handling, InReplyTo and References support**
+
 > **New in 0.3.0: The ability to consume [inbound emails](https://docs.mailpace.com/guide/inbound/) from MailPace via ActionMailbox**
 
 ##  Usage
@@ -133,6 +135,26 @@ Alternatively, provide the password in the `RAILS_INBOUND_EMAIL_PASSWORD` enviro
 `https://actionmailbox:PASSWORD@example.com/rails/action_mailbox/mailpace/inbound_emails`
 
 That's it! Emails should start flowing into your app just like magic.
+
+## Idempotent Requests
+
+Mailpace supports [idempotency](https://docs.mailpace.com/guide/idempotency) for safely retrying requests without accidentally sending the same email twice. This is useful to guarantee that an email is not sent to the same recipient multiple times, e.g. through a network error, or a bug in your application logic.
+
+To do this, when writing your mailer, generate and add a unique `idempotency_key`:
+
+```ruby
+class TestMailer < ApplicationMailer
+  default from: 'notifications@example.com'
+  def idempotent_mail
+    email = 'email@example.com'
+    mail(
+      to: email,
+      idempotency_key: Digest::SHA256.hexdigest("#{email}-#{Time.now.to_i / 3600}")
+    )
+  end
+end
+```
+
 ## Support
 
 For support please check the [MailPace Documentation](https://docs.mailpace.com)  or contact us at support@mailpace.com

data/lib/mailpace-rails/version.rb

@@ -1,5 +1,5 @@
 module Mailpace
   module Rails
-    VERSION = '0.3.1'
+    VERSION = '0.4.0'
   end
 end

data/lib/mailpace-rails.rb

@@ -21,16 +21,18 @@ module Mailpace
       result = HTTParty.post(
         'https://app.mailpace.com/api/v1/send',
         body: {
-          from: mail.header[:from]&.address_list&.addresses&.first.to_s,
+          from: address_list(mail.header[:from])&.addresses&.first.to_s,
           to: mail.to.join(','),
           subject: mail.subject,
           htmlbody: mail.html_part ? mail.html_part.body.decoded : mail.body.to_s,
           textbody: if mail.multipart?
                       mail.text_part ? mail.text_part.body.decoded : nil
                     end,
-          cc: mail.cc&.join(','),
-          bcc: mail.bcc&.join(','),
+          cc: address_list(mail.header[:cc])&.addresses&.join(','),
+          bcc: address_list(mail.header[:bcc])&.addresses&.join(','),
           replyto: mail.reply_to&.join(','),
+          inreplyto: mail.header['In-Reply-To'].to_s,
+          references: mail.header['References'].to_s,
           list_unsubscribe: mail.header['list_unsubscribe'].to_s,
           attachments: format_attachments(mail.attachments),
           tags: mail.header['tags'].to_s
@@ -39,7 +41,8 @@ module Mailpace
           'User-Agent' => "MailPace Rails Gem v#{Mailpace::Rails::VERSION}",
           'Accept' => 'application/json',
           'Content-Type' => 'application/json',
-          'Mailpace-Server-Token' => settings[:api_token]
+          'Mailpace-Server-Token' => settings[:api_token],
+          'Idempotency-Key' => mail.header['idempotency_key'].to_s
         }
       )
 
@@ -63,9 +66,10 @@ module Mailpace
     def handle_response(result)
       return result unless result.code != 200
 
-      # TODO: Improved error handling
-      res = result.parsed_response
-      raise res['error']&.to_s || res['errors']&.to_s
+      parsed_response = result.parsed_response
+      error_message = join_error_messages(parsed_response)
+
+      raise DeliveryError, "MAILPACE Error: #{error_message}" unless error_message.empty?
     end
 
     def format_attachments(attachments)
@@ -78,9 +82,25 @@ module Mailpace
         }.compact
       end
     end
+
+    def address_list(obj)
+      if obj&.respond_to?(:element)
+        # Mail 2.8+
+        obj.element
+      else
+        # Mail <= 2.7.x
+        obj&.address_list
+      end
+    end
+
+    def join_error_messages(response)
+      # Join 'error' and 'errors' keys from response into a single string
+      [response['error'], response['errors']].compact.join(', ')
+    end
   end
 
   class Error < StandardError; end
+  class DeliveryError < StandardError; end
 
   def self.root
     Pathname.new(File.expand_path(File.join(__dir__, '..')))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailpace-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - MailPace
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: actionmailbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: 7.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: 7.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +113,9 @@ files:
 homepage: https://mailpace.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/mailpace/mailpace-rails
+  changelog_uri: https://github.com/mailpace/mailpace-rails/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -101,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Lets you send transactional emails from your app over an easy to use API