millionsend 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f44b4a952ce5037c565e1ba8071a29ddf7d2b7d875fd99cad7719e91155d3054
-  data.tar.gz: a6b58d948cd026fe50ff598cc46129d6e9c164de71453dcdd77855237c0376fd
+  metadata.gz: d9260a596d597a0aad944da04656fb5c99606374b48b9e235f3e883917ef2bc6
+  data.tar.gz: 677e347b5604bd68edf198df96802d652470d3e4aef679460fdb24bce3563993
 SHA512:
-  metadata.gz: 4c16c5f8ee728136b872cc3f6a83d78052c62649c7b69497973d72845fb318669073078eb54406863fb0d83cd5336868896e098da794677b50667eefb4f0ec7f
-  data.tar.gz: d492c8d93ddcfff8e5f887f50aa7200fa0e30856effd041530a19a62cd2c2ad07ed47520c9f5fb57a32e4078103d6edad6619cb45cbba888cb94e0f01ff0faf8
+  metadata.gz: fb4c0031b1c2b22911ebba5b0f5d45c05b613196b2e665c11212d5146c5e7102c4cdbba343245acf814bffc6e8394d603c2c124d325a25c4c70fc1a49ac21789
+  data.tar.gz: bae43393a0387f459f882638a9eb6a7961cdc6d9b94b602d914cd199c071ce7e403706610e89e1426273e347cb1a3d6393518cf7d9f91d567352692c8765f2fe

data/README.md

@@ -5,7 +5,7 @@ self-hostable, Resend-compatible email API on AWS SES.
 
 The API is wire-compatible with Resend, and this gem deliberately mirrors the shape of
 [`resend`](https://github.com/resend/resend-ruby), so migrating is mostly a find-and-replace:
-swap the constant, set `base_url` to your instance.
+swap the constant (and, on a self-hosted instance, set `base_url`).
 
 ## Install
 
@@ -26,8 +26,8 @@ Requires Ruby 3.0+. Only the standard library is used at runtime (`net/http`, `j
 ```ruby
 require "millionsend"
 
-Millionsend.api_key  = "ms_123"
-Millionsend.base_url = "https://mail.acme.dev"
+Millionsend.api_key = "ms_123"
+# Millionsend.base_url = "https://mail.acme.dev" # self-hosted only; defaults to MillionSend Cloud
 
 email = Millionsend::Emails.send(
   from: "Acme <onboarding@acme.dev>",
@@ -47,12 +47,12 @@ on any non-2xx response (see [Error handling](#error-handling)).
 ```ruby
 Millionsend.api_key  = "ms_123"                # falls back to ENV["MILLIONSEND_API_KEY"]
 Millionsend.base_url = "https://mail.acme.dev" # falls back to ENV["MILLIONSEND_BASE_URL"],
-                                               # then http://localhost:3001
+                                               # then https://api.millionsend.com (Cloud)
 Millionsend.allow_insecure_http = false        # accept a non-loopback http:// base_url
 ```
 
-MillionSend is self-hosted, so there is no cloud default — **set `base_url` to your
-deployment in production.** An explicitly assigned value always wins over the environment.
+MillionSend Cloud works with just the API key; a self-hosted instance sets `base_url` to
+its origin. An explicitly assigned value always wins over the environment.
 Plain `http://` is only accepted for loopback hosts (`localhost`, `127.0.0.1`, `::1`); any
 other `http://` URL raises `Millionsend::ApplicationError` on the first call, since the API
 key is sent as a bearer header. Set `allow_insecure_http = true` to talk to a non-TLS
@@ -127,6 +127,8 @@ Millionsend::Contacts.list(limit: 50)
 # Topic subscriptions (granular unsubscribe) — PATCH /contacts/:id/topics
 Millionsend::Contacts::Topics.update(email: "ada@acme.dev", topics: [{ id: topic_id, subscription: "opt_out" }]) # resend-ruby shape
 Millionsend::Contacts.topics_update("ada@acme.dev", [{ id: topic_id, subscription: "opt_out" }])                 # positional
+Millionsend::Contacts::Topics.list(email: "ada@acme.dev") # GET /contacts/:id/topics — every topic with its effective
+                                                          # subscription; explicit: false when it is the topic's default
 
 # Segment membership — POST / DELETE /contacts/:id/segments/:segment_id
 Millionsend::Contacts::Segments.add("ada@acme.dev", segment_id)
@@ -243,7 +245,7 @@ Millionsend::Webhooks.remove(hook[:id])
 
 Events: `email.sent`, `email.delivered`, `email.delivery_delayed`, `email.bounced`,
 `email.complained`, `email.opened`, `email.clicked`, `deliverability.warning`,
-`deliverability.paused`, `quota.warning`, `quota.reached`.
+`deliverability.paused`, `quota.warning`, `quota.reached`, `quota.paused`.
 
 ### API keys
 
@@ -326,12 +328,16 @@ rescue Millionsend::Error => e
 end
 ```
 
-Subclasses: `ValidationError`, `NotFoundError`, `MissingApiKeyError`, `InvalidApiKeyError`,
-`RestrictedApiKeyError`, `SendingPausedError`, `BroadcastsPausedError`, `RateLimitExceededError`,
-`DailyQuotaExceededError`, `InvalidIdempotentRequestError`, `ConcurrentIdempotentRequestsError`,
-`InternalServerError`, and `ApplicationError` (the fallback for unknown names). Client-side and
+Subclasses: `ValidationError`, `AllRecipientsSuppressedError`, `NotFoundError`,
+`MissingApiKeyError`, `InvalidApiKeyError`, `RestrictedApiKeyError`, `SendingPausedError`,
+`BroadcastsPausedError`, `RateLimitExceededError`, `DailyQuotaExceededError`,
+`InvalidIdempotentRequestError`, `ConcurrentIdempotentRequestsError`, `InternalServerError`, and
+`ApplicationError` (the fallback for unknown names). Client-side and
 transport failures that never reached the API raise `ApplicationError` with `#status_code == nil`.
 
+`Emails.send` and `Batch.send` raise `AllRecipientsSuppressedError` (`all_recipients_suppressed`,
+422) when every `to` recipient is on the suppression list or opted out of the send's `topic_id`.
+
 ## Migrating from Resend
 
 ```diff
@@ -340,7 +346,7 @@ transport failures that never reached the API raise `ApplicationError` with `#st
 - Resend::Emails.send(from: "...", to: "...", subject: "Hi", html: "<p>hi</p>")
 + require "millionsend"
 + Millionsend.api_key  = "ms_123"
-+ Millionsend.base_url = "https://mail.acme.dev"
++ Millionsend.base_url = "https://mail.acme.dev" # self-hosted only
 + Millionsend::Emails.send(from: "...", to: "...", subject: "Hi", html: "<p>hi</p>")
 ```
 
@@ -354,6 +360,7 @@ works as in resend-ruby. Notes:
   accepts both.
 - `Contacts` member methods and `Contacts::Segments` / `Contacts::Topics` accept resend-ruby's
   addressing hashes (`id:` / `email:` / `contact_id:`, `segment_id:`) as well as bare values.
+  `Contacts::Topics.list` is unpaginated, so resend-ruby's `limit:`/`after:`/`before:` are not sent.
   `Suppressions::Batch` is nested as in resend-ruby.
 - **No audiences** — contacts are team-global, so there is no `Audiences` resource and no
   `audience_id` params. The API's `/audiences/*` routes are a compatibility shim and are not

data/lib/millionsend/contacts.rb

@@ -53,6 +53,14 @@ module Millionsend
     # Topic subscriptions of one contact, in resend-ruby's nested shape.
     module Topics
       class << self
+        # GET /contacts/:id_or_email/topics — { id: | email: } or a bare id/email.
+        # Every topic comes back with the contact's effective subscription;
+        # explicit: false means it is the topic's default, not a stored choice.
+        # Unpaginated, like Topics.list.
+        def list(params)
+          Millionsend::Request.new(method: :get, path: "#{Millionsend::Contacts.member_path(params)}/topics").perform
+        end
+
         # PATCH /contacts/:id_or_email/topics — { id: | email:, topics: [{ id:, subscription: }] }.
         def update(params)
           Millionsend::Contacts.topics_update(params, params[:topics])

data/lib/millionsend/error.rb

@@ -31,6 +31,7 @@ module Millionsend
   end
 
   class ValidationError < Error; end
+  class AllRecipientsSuppressedError < Error; end
   class NotFoundError < Error; end
   class MissingApiKeyError < Error; end
   class InvalidApiKeyError < Error; end
@@ -46,6 +47,7 @@ module Millionsend
 
   ERROR_TYPES = {
     "validation_error" => ValidationError,
+    "all_recipients_suppressed" => AllRecipientsSuppressedError,
     "not_found" => NotFoundError,
     "missing_api_key" => MissingApiKeyError,
     "invalid_api_key" => InvalidApiKeyError,

data/lib/millionsend/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Millionsend
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/millionsend.rb

@@ -28,13 +28,13 @@ require "millionsend/deliverability"
 #                            subject: "Hi", html: "<strong>it works</strong>")
 #
 # api_key falls back to the MILLIONSEND_API_KEY env var; base_url to
-# MILLIONSEND_BASE_URL and then http://localhost:3001 (MillionSend is
-# self-hosted, so there is no cloud default). Plain http is only accepted for
+# MILLIONSEND_BASE_URL and then MillionSend Cloud, so a self-hosted instance
+# sets its own origin. Plain http is only accepted for
 # loopback hosts unless allow_insecure_http is set, since the API key travels
 # as a bearer header. Every call returns a symbol-keyed Hash on success and
 # raises a Millionsend::Error on any non-2xx response.
 module Millionsend
-  DEFAULT_BASE_URL = "http://localhost:3001"
+  DEFAULT_BASE_URL = "https://api.millionsend.com"
   USER_AGENT = "millionsend-ruby/#{VERSION}"
 
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: millionsend
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - MillionSend
@@ -55,7 +55,7 @@ dependencies:
 description: 'Ruby client for the MillionSend HTTP API: emails, batch, contacts, contact
   properties, topics, broadcasts, segments, suppressions, domains, webhooks, API keys,
   templates and usage. Wire-compatible with Resend and mirror-shaped after resend-ruby,
-  so migrating is mostly an import swap plus a base_url.'
+  so migrating is mostly an import swap.'
 email:
 executables: []
 extensions: []