mailpace-rails 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e00e92354ac88a5a1ad8d1f2f8a35c513358b40768ee1bb78f15fdfdf56fc6b
-  data.tar.gz: 886f86f439920c14262128adef015a7339c67d63a5e188d06872d6a9ba5d91d8
+  metadata.gz: 116f3c2d1a6a94ee97b33eccd6b576ffa86146e262fa18fea458fd30cc6ce9bb
+  data.tar.gz: 367ca296eff427a12a36a56096a04ebc0e694f635d9667c629db4b67c67f65bd
 SHA512:
-  metadata.gz: 8f4733e58983c60e330627190116b508d4df6962165fedcf7ea3d3ddfd2772bbb3b176860cd02cdd2b627e00fb7c18404b9f1e545efb23c6f29ff4ff14ad5ed7
-  data.tar.gz: e90bd2efb8b4cd34abe58cdc9f8bbd5d0fa7d6e27f18871fab6ca37f6d82bd1a409a3ac80ea35bed5271c408b61ce3f37ff9e25c1cdfbfbb3b3dd156e5ca2cbd
+  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.2'
+    VERSION = '0.4.0'
   end
 end

data/lib/mailpace-rails.rb

@@ -31,6 +31,8 @@ module Mailpace
           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)
@@ -88,9 +92,15 @@ module Mailpace
         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.2
+  version: 0.4.0
 platform: ruby
 authors:
 - MailPace
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 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: 7.0.4.1
+        version: 7.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.4.1
+        version: 7.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -88,7 +116,7 @@ licenses:
 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+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
 test_files: []