supersendtx 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca4d44a3a130a37fb7055f295cd6f37ed780c145189a1ce40d4318f7fd5d309
-  data.tar.gz: 5a4728dd67281d5323c284c32e21ef03943f602987428c2c76452fee6c80e904
+  metadata.gz: bef605be553360ce670dcf5514b404abbbc9bf9759d33b88de04928932a57ace
+  data.tar.gz: 3732c01fa5d8a27343d950da44d8ffa5c59c06c89e7c24ceb0a4454fa854abb5
 SHA512:
-  metadata.gz: 303ae619a3dc9bc631c2938acf710bf25d63639c2612a96fe1229e6e3d3e5d40ef0a9a24d0a4c8ed837963f41814e6012e1f7eef8c160c0c1494adce1f6d4e7e
-  data.tar.gz: dda61e8e034f98c653c0ca8adb4f75de2226065a6f9126d416487e3f5d20c48f7d94bfd10bea34229dff32f054c5402673d0326cbb8d9bf2e2378a1397a5a51c
+  metadata.gz: 7f33d8b05598877aa6671c38c43f067ed9baf01d008b982b9447a5639e73bc37f0f018304aa712eb6a5fc050e0536bf2e385b3de15fcaf5a3d2c101c9df6c8e6
+  data.tar.gz: fb26b4039af3e90a2d961f9eec4d8af7cab14ba9d5f232f5eb0b89a1a5a566e67218350021daa6edf27e84cd86aa03809ad010ee694a44427e03390bf92dc995

data/Gemfile

@@ -6,4 +6,6 @@ gemspec
 
 group :development, :test do
   gem "minitest", "~> 5.25"
+  gem "mail", ">= 2.8"
+  gem "base64", ">= 0.2"
 end

data/README.md

@@ -21,4 +21,13 @@ result = tx.emails.send(
 puts result["id"], result["status"]
 ```
 
+## Rails ActionMailer
+
+```ruby
+config.action_mailer.delivery_method = :supersendtx
+config.action_mailer.supersendtx_settings = {
+  api_key: ENV.fetch("SUPERSENDTX_API_KEY")
+}
+```
+
 Docs: https://docs.supersendtx.com/sdks/ruby

data/lib/supersendtx/delivery_method.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "mail"
+require_relative "message_mapper"
+
+module SuperSendTX
+  # ActionMailer delivery method: config.action_mailer.delivery_method = :supersendtx
+  class DeliveryMethod
+    def initialize(settings = {})
+      @settings = settings || {}
+      @client = @settings[:client] || build_client
+    end
+
+    def deliver!(mail)
+      params = MessageMapper.to_send_params(mail)
+      result = @client.emails.send(**params)
+      message_id = result.is_a?(Hash) ? (result["id"] || result[:id]) : nil
+      mail.message_id = message_id if message_id && mail.respond_to?(:message_id=)
+      result
+    rescue SuperSendTX::Error => e
+      # Re-raise as SuperSendTX::Error (not a bare String → RuntimeError) so
+      # ActionMailer / rescue_from can read status, details, and error_code.
+      raise SuperSendTX::Error.new(
+        "SuperSend TX API error: #{e.message}",
+        status: e.status,
+        details: e.details,
+        error_code: e.error_code,
+        upgrade_url: e.upgrade_url
+      )
+    end
+
+    private
+
+    def build_client
+      api_key = @settings[:api_key] || @settings["api_key"] || ENV["SUPERSENDTX_API_KEY"]
+      raise ArgumentError, "SUPERSENDTX_API_KEY is not configured." if api_key.nil? || api_key.to_s.empty?
+
+      base_url = @settings[:base_url] || @settings["base_url"] || ENV["SUPERSENDTX_BASE_URL"]
+      if base_url && !base_url.to_s.empty?
+        Client.new(api_key, base_url: base_url)
+      else
+        Client.new(api_key)
+      end
+    end
+  end
+end

data/lib/supersendtx/message_mapper.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "base64"
+
+module SuperSendTX
+  # Maps a Mail::Message into emails.send keyword args.
+  module MessageMapper
+    HEADER_IDEMPOTENCY = "X-SuperSendTX-Idempotency-Key"
+    HEADER_SCHEDULED_AT = "X-SuperSendTX-Scheduled-At"
+    HEADER_TAG = "X-SuperSendTX-Tag"
+
+    RESERVED_HEADERS = %w[
+      from to cc bcc reply-to subject content-type mime-version date message-id
+      x-supersendtx-idempotency-key x-supersendtx-scheduled-at x-supersendtx-tag
+      idempotency-key
+    ].freeze
+
+    module_function
+
+    def to_send_params(mail)
+      from = format_addresses(mail[:from])
+      raise ArgumentError, "Email is missing a From address." if from.empty?
+
+      to = format_addresses(mail[:to])
+      raise ArgumentError, "Email is missing a To recipient." if to.empty?
+
+      html = html_body(mail)
+      text = text_body(mail)
+      raise ArgumentError, "Email must include html or text content." if html.nil? && text.nil?
+
+      params = {
+        from: from.length == 1 ? from[0] : from,
+        to: to.length == 1 ? to[0] : to
+      }
+      params[:subject] = mail.subject if mail.subject && !mail.subject.empty?
+      params[:html] = html if html
+      params[:text] = text if text
+
+      reply_to = format_addresses(mail[:reply_to])
+      params[:reply_to] = reply_to.length == 1 ? reply_to[0] : reply_to unless reply_to.empty?
+
+      cc = format_addresses(mail[:cc])
+      params[:cc] = cc unless cc.empty?
+      bcc = format_addresses(mail[:bcc])
+      params[:bcc] = bcc unless bcc.empty?
+
+      attachments = map_attachments(mail)
+      params[:attachments] = attachments unless attachments.empty?
+
+      tags = extract_tags(mail)
+      params[:tags] = tags unless tags.empty?
+
+      headers = extract_forward_headers(mail)
+      params[:headers] = headers unless headers.empty?
+
+      idem = header_value(mail, HEADER_IDEMPOTENCY) || header_value(mail, "Idempotency-Key")
+      params[:idempotency_key] = idem if idem
+
+      scheduled = header_value(mail, HEADER_SCHEDULED_AT)
+      params[:scheduled_at] = scheduled if scheduled
+
+      params
+    end
+
+    def format_addresses(field)
+      return [] if field.nil?
+
+      Array(field.addrs).filter_map do |addr|
+        email = addr.address.to_s.strip
+        next if email.empty?
+
+        name = addr.display_name.to_s.strip
+        name.empty? ? email : "#{name} <#{email}>"
+      end
+    end
+
+    def html_body(mail)
+      if mail.html_part
+        mail.html_part.decoded
+      elsif mail.mime_type == "text/html"
+        mail.decoded
+      end
+    end
+
+    def text_body(mail)
+      if mail.text_part
+        mail.text_part.decoded
+      elsif mail.mime_type == "text/plain" || (!mail.multipart? && mail.mime_type.nil?)
+        body = mail.body.decoded
+        body && !body.empty? ? body : nil
+      end
+    end
+
+    def map_attachments(mail)
+      mail.attachments.map do |attachment|
+        {
+          "filename" => attachment.filename.to_s.empty? ? "attachment" : attachment.filename,
+          "content_type" => attachment.mime_type || "application/octet-stream",
+          "content" => Base64.strict_encode64(attachment.body.decoded)
+        }
+      end
+    end
+
+    def extract_tags(mail)
+      values = mail.header[HEADER_TAG]
+      return [] unless values
+
+      list = values.respond_to?(:map) ? values.map(&:to_s) : [values.to_s]
+      list.filter_map do |raw|
+        trimmed = raw.strip
+        next if trimmed.empty?
+
+        if trimmed.include?("=")
+          name, value = trimmed.split("=", 2)
+          next if name.strip.empty? || value.strip.empty?
+
+          { "name" => name.strip, "value" => value.strip }
+        else
+          { "name" => "tag", "value" => trimmed }
+        end
+      end
+    end
+
+    def extract_forward_headers(mail)
+      out = {}
+      mail.header.fields.each do |field|
+        name = field.name.to_s
+        lower = name.downcase
+        next if RESERVED_HEADERS.include?(lower)
+        next if lower.start_with?("content-")
+
+        value = field.value.to_s.strip
+        out[name] = value unless value.empty?
+      end
+      out
+    end
+
+    def header_value(mail, name)
+      field = mail.header[name]
+      return nil unless field
+
+      value = field.respond_to?(:last) ? field.last.to_s : field.to_s
+      value = value.strip
+      value.empty? ? nil : value
+    end
+  end
+end

data/lib/supersendtx/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require_relative "delivery_method"
+
+module SuperSendTX
+  class Railtie < ::Rails::Railtie
+    initializer "supersendtx.add_delivery_method" do
+      ActiveSupport.on_load(:action_mailer) do
+        ActionMailer::Base.add_delivery_method :supersendtx, SuperSendTX::DeliveryMethod
+      end
+    end
+  end
+end

data/lib/supersendtx/resources.rb

@@ -19,7 +19,9 @@ module SuperSendTX
       params["to"] = to if to
       body = serialize_send_params(params)
       headers = {}
-      idempotency_key = params["idempotency_key"] || params["idempotencyKey"]
+      idempotency_key =
+        params["idempotency_key"] || params[:idempotency_key] ||
+        params["idempotencyKey"] || params[:idempotencyKey]
       headers["Idempotency-Key"] = idempotency_key.to_s if idempotency_key
 
       @http.request("POST", "/emails", body: body, headers: headers)
@@ -54,7 +56,7 @@ module SuperSendTX
         "to" => params["to"] || params[:to]
       }
 
-      %w[subject html text reply_to replyTo cc bcc tags headers tag template].each do |key|
+      %w[subject html text reply_to replyTo cc bcc tags headers tag template attachments].each do |key|
         value = params[key] || params[key.to_sym]
         next if value.nil?
 

data/lib/supersendtx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SuperSendTX
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/lib/supersendtx.rb

@@ -8,3 +8,21 @@ require_relative "supersendtx/client"
 
 module SuperSendTX
 end
+
+begin
+  require "base64"
+  require "mail"
+rescue LoadError
+  # base64/mail are optional; required for ActionMailer delivery method.
+else
+  require_relative "supersendtx/message_mapper"
+  require_relative "supersendtx/delivery_method"
+end
+
+begin
+  require "rails"
+rescue LoadError
+  # Rails is optional.
+else
+  require_relative "supersendtx/railtie"
+end

data/supersendtx.gemspec

@@ -28,4 +28,8 @@ Gem::Specification.new do |spec|
   end
 
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "base64", ">= 0.2"
+  spec.add_development_dependency "mail", ">= 2.8"
+  spec.add_development_dependency "minitest", "~> 5.25"
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: supersendtx
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - SuperSend TX
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-29 00:00:00.000000000 Z
-dependencies: []
+date: 2026-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
 description: Official Ruby client for the SuperSend TX REST API.
 email:
 - support@supersendtx.com
@@ -22,8 +64,11 @@ files:
 - README.md
 - lib/supersendtx.rb
 - lib/supersendtx/client.rb
+- lib/supersendtx/delivery_method.rb
 - lib/supersendtx/error.rb
 - lib/supersendtx/http.rb
+- lib/supersendtx/message_mapper.rb
+- lib/supersendtx/railtie.rb
 - lib/supersendtx/resources.rb
 - lib/supersendtx/version.rb
 - supersendtx.gemspec