broadcast-ruby 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 771ab33d93d10794aea6559a3f8f37bda6805a113ea5b64c4fbd01492f441c4c
-  data.tar.gz: 9cee98c3ca42375be3b153e6636654506d7284f3970b5f9810d94441be5b974e
+  metadata.gz: 046bdebddc0d68f63776039530a40783734df10ca736d3f8212f598f72927c12
+  data.tar.gz: 5f1e53c5af9d8654410849eaf485e3f45657e02fb30cb575254585e49eda88e6
 SHA512:
-  metadata.gz: 8e87a6e53d2fa236d6acf3cbd0ce0c03da8483a4761c90bd5b3464bac82590e2ea754f1b358a24a03c155d42c48e49f2090202584937b210d6304e77fed1b4c0
-  data.tar.gz: 4e7ca3f59f4845ce25b8ab24d6f446fb8ed277b3b6804e559cbe4008ec88fccf573e93819716b1272a067a5abbfbc9c3d215169825b0e9793ae5426f555185de
+  metadata.gz: 718ae1afd1950d245ae33084763e96fcc9c186ca56ebe6e4f44a8109b944bf8674d87ca9357ac9782c6ebac6ee4f8e46a6a92a86053c1dc73099c13fa5a1fb8d
+  data.tar.gz: d61a1d23973470942c06de04d732b01d0df32e3ab098f88ac7b82d68b68a142535de1ab93085f53cf0b18a4981f1c52b0d77c91c3217db2a566d774d9e0be10b

data/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.11.0] - 2026-11-07
+
+### Removed
+
+- **Breaking:** `client.migration` (`Broadcast::Resources::Migration`): `manifest`,
+  the 19 export collections, `each_record` and `download_file_asset`. Broadcast 3
+  removes the `/api/migration/v1` export API. A server before 3.0 still serves
+  it; stay on 0.10.x to keep using it.
+
 ## [0.10.0] - 2026-10-17
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    broadcast-ruby (0.10.0)
+    broadcast-ruby (0.11.0)
       base64
 
 GEM
@@ -177,7 +177,7 @@ CHECKSUMS
   ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
   base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
   bigdecimal (4.0.1) sha256=8b07d3d065a9f921c80ceaea7c9d4ae596697295b584c296fe599dd0ad01c4a7
-  broadcast-ruby (0.10.0)
+  broadcast-ruby (0.11.0)
   builder (3.3.0) sha256=497918d2f9dca528fdca4b88d84e4ef4387256d984b8154e9d5d3fe5a9c8835f
   concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
   connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a

data/README.md

@@ -1461,75 +1461,6 @@ raise 'channel not ready to send' unless client.status.dig('readiness', 'broadca
 
 ---
 
-## Export & Migration
-
-Read-only endpoints under `/api/migration/v1` for backups and moving a channel
-between instances. Two constraints differ from the rest of the API:
-
-- **Admin tokens only.** Channel-scoped tokens are rejected.
-- **`broadcast_channel_id` is required on every call.** Set it once on the
-  client and the gem attaches it for you.
-
-```ruby
-client = Broadcast::Client.new(
-  api_token: ENV['BROADCAST_ADMIN_TOKEN'],
-  host: 'https://mail.example.com',
-  broadcast_channel_id: 1
-)
-
-# Size the export first
-manifest = client.migration.manifest
-manifest['counts']            # => { 'subscribers' => 5000, 'templates' => 12, ... }
-manifest['export_format_version']
-
-# Time-bounded counts (broadcasts, receipts, histories) default to 90 days
-client.migration.manifest(days_history: 365)
-```
-
-Each collection is a paginated list returning `data` and `pagination`:
-
-```ruby
-page = client.migration.subscribers(limit: 250, offset: 0)
-page['data']
-page['pagination']  # => { 'total' => 5000, 'limit' => 250, 'offset' => 0, 'has_more' => true }
-```
-
-`each_record` handles the paging for you, advancing by the page size the server
-actually granted rather than the one you asked for:
-
-```ruby
-CSV.open('subscribers.csv', 'w') do |csv|
-  client.migration.each_record(:subscribers) do |subscriber|
-    csv << [subscriber['email'], subscriber['first_name'], subscriber['created_at']]
-  end
-end
-
-# Without a block you get an Enumerator
-client.migration.each_record(:tags).map { |tag| tag['name'] }
-```
-
-Available collections:
-
-```
-channels  subscribers  templates  segments  sequences  email_servers
-opt_in_forms  broadcasts  outbound_receipts  webhook_endpoints  tokens
-suppressions  unsubscribed_emails  tags  users  link_redirects
-link_clicks  subscriber_histories  file_assets
-```
-
-`suppressions` is the global suppression list (GlobalSuppression rows, global
-or scoped to the channel). `unsubscribed_emails` is the channel's own
-suppression list. Export both to keep every suppressed address.
-
-File assets are downloaded separately and return raw bytes:
-
-```ruby
-bytes = client.migration.download_file_asset(7)
-File.binwrite('logo.png', bytes)
-```
-
----
-
 ## Errors
 
 All API errors inherit from `Broadcast::Error`. Put specific errors before general ones:

data/SDK-COVERAGE.md

@@ -53,11 +53,6 @@ Two details worth knowing when reading the map below:
 - **PATCH is canonical.** Rails' `resources` routes `update` to both PATCH and
   PUT. They are one operation; the generator drops the PUT alias. Counting both
   would inflate the denominator by 8 and make this gem look 8 endpoints short.
-- **Metaprogrammed endpoints are declared.** The 19 migration collections are
-  defined by `define_method` over `Migration::COLLECTIONS`, so no path literal
-  exists to scan. They are listed in `.api-coverage.yml` and marked
-  *(generated)* below. That file is produced from the gem's own constants — it
-  is not a hand-written promise.
 
 ---
 
@@ -247,39 +242,6 @@ payload so a fetch-modify-save cannot destroy the stored credential.
 naming the missing prerequisites. `trigger_run` returns 202 — generation is
 asynchronous, so poll `runs`.
 
-### Migration / export — 20/20
-
-Admin tokens only. `broadcast_channel_id` is required on every call; set it once
-on the client and the gem attaches it.
-
-| Method | Path | Gem |
-|---|---|---|
-| GET | `/api/migration/v1/manifest` | `Migration#manifest` |
-| GET | `/api/migration/v1/file_assets/{id}/download` | `Migration#download_file_asset` — raw bytes |
-| GET | `/api/migration/v1/channels` | *(generated)* `Migration#channels` |
-| GET | `/api/migration/v1/subscribers` | *(generated)* `Migration#subscribers` |
-| GET | `/api/migration/v1/templates` | *(generated)* `Migration#templates` |
-| GET | `/api/migration/v1/segments` | *(generated)* `Migration#segments` |
-| GET | `/api/migration/v1/sequences` | *(generated)* `Migration#sequences` |
-| GET | `/api/migration/v1/email_servers` | *(generated)* `Migration#email_servers` |
-| GET | `/api/migration/v1/opt_in_forms` | *(generated)* `Migration#opt_in_forms` |
-| GET | `/api/migration/v1/broadcasts` | *(generated)* `Migration#broadcasts` |
-| GET | `/api/migration/v1/outbound_receipts` | *(generated)* `Migration#outbound_receipts` |
-| GET | `/api/migration/v1/webhook_endpoints` | *(generated)* `Migration#webhook_endpoints` |
-| GET | `/api/migration/v1/tokens` | *(generated)* `Migration#tokens` |
-| GET | `/api/migration/v1/suppressions` | *(generated)* `Migration#suppressions` |
-| GET | `/api/migration/v1/unsubscribed_emails` | *(generated)* `Migration#unsubscribed_emails` |
-| GET | `/api/migration/v1/tags` | *(generated)* `Migration#tags` |
-| GET | `/api/migration/v1/users` | *(generated)* `Migration#users` |
-| GET | `/api/migration/v1/link_redirects` | *(generated)* `Migration#link_redirects` |
-| GET | `/api/migration/v1/link_clicks` | *(generated)* `Migration#link_clicks` |
-| GET | `/api/migration/v1/subscriber_histories` | *(generated)* `Migration#subscriber_histories` |
-| GET | `/api/migration/v1/file_assets` | *(generated)* `Migration#file_assets` |
-
-`Migration#each_record(:collection)` pages any of them automatically, advancing
-by the page size the **server granted** rather than the one requested (the
-server clamps `limit` to 250).
-
 ---
 
 ## Transport coverage
@@ -301,10 +263,10 @@ complete while quietly losing information.
 | Retry on 5xx and timeout | ✅ | `retry_attempts`, `retry_delay` |
 | Typed errors | ✅ | 401/403/404/409/422/429/5xx each distinct |
 | Redirect handling | ✅ | Same-host GET follows; writes and cross-host refuse |
-| Raw/text responses | ✅ | `client.skill`, `download_file_asset` |
+| Raw/text responses | ✅ | `client.skill` |
 | Channel scoping | ✅ | `broadcast_channel_id:`, `with_channel(id) { }` |
 | Debug logging | ✅ | Credentials redacted |
-| Pagination helper | ⚠️ Migration only | `each_record`; v1 endpoints page manually |
+| Pagination helper | ❌ | v1 endpoints page manually |
 | ActionMailer integration | ✅ | `:broadcast` delivery method + Railtie |
 
 Error mapping in full:
@@ -355,9 +317,9 @@ this is an API gap, not a gem gap, and nothing here is actionable in this repo.
 | **Channel management** | Web UI | Creating channels, domain/sender setup, onboarding |
 | **User & permission management** | Web UI | Users, system permissions, per-channel permissions |
 | **Settings** | Web UI | General, AI, DNS checks, ESP integrations, sender details |
-| **Global suppressions** | Web UI + migration export | Read-only via `migration.suppressions`; no v1 CRUD |
-| **File assets** | Web UI + migration export | Read-only via migration; no v1 upload |
-| **Link tracking config** | Web UI | Click data readable via `statistics_links` and migration |
+| **Global suppressions** | Web UI | No v1 CRUD |
+| **File assets** | Web UI | No v1 upload |
+| **Link tracking config** | Web UI | Click data readable via `statistics_links` |
 | **Admin / platform** | Web UI | Admin API tokens, SaaS platform admin |
 | **Confirmation templates & pages** | Partly API | Configurable as template attributes; no dedicated endpoints |
 

data/lib/broadcast/client.rb

@@ -158,12 +158,6 @@ module Broadcast
       @file_assets ||= Resources::FileAssets.new(self)
     end
 
-    # Read-only export endpoints under /api/migration/v1. Requires an admin
-    # (system) API token.
-    def migration
-      @migration ||= Resources::Migration.new(self)
-    end
-
     # @api private
     # rubocop:disable Metrics/ParameterLists -- transport options passed straight through to Connection
     def request(method, path, body_or_params = nil, headers: {}, raw: false, multipart: false)

data/lib/broadcast/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Broadcast
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

data/lib/broadcast.rb

@@ -27,7 +27,6 @@ require_relative 'broadcast/resources/suppressions'
 require_relative 'broadcast/resources/global_suppressions'
 require_relative 'broadcast/resources/channel'
 require_relative 'broadcast/resources/file_assets'
-require_relative 'broadcast/resources/migration'
 
 # ActionMailer integration — only loaded when Rails is present
 if defined?(Rails::Railtie)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: broadcast-ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Simon Chiu
@@ -56,7 +56,6 @@ files:
 - lib/broadcast/resources/email_servers.rb
 - lib/broadcast/resources/file_assets.rb
 - lib/broadcast/resources/global_suppressions.rb
-- lib/broadcast/resources/migration.rb
 - lib/broadcast/resources/opt_in_forms.rb
 - lib/broadcast/resources/segments.rb
 - lib/broadcast/resources/sequences.rb

data/lib/broadcast/resources/migration.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module Broadcast
-  module Resources
-    # Read-only export endpoints under /api/migration/v1 — the surface behind
-    # backups and instance-to-instance migration.
-    #
-    # Two things differ from the v1 API:
-    #
-    # 1. **Admin tokens only.** Channel-scoped tokens are rejected outright;
-    #    the controller looks up AdminApiToken and nothing else.
-    # 2. **broadcast_channel_id is required on every call.** Set it once via
-    #    `Client.new(broadcast_channel_id:)` or `client.with_channel(id)` and
-    #    the gem attaches it automatically; otherwise pass it per call.
-    #
-    # Every list endpoint pages with `limit:` (1..250, default 250) and
-    # `offset:`, and returns `{"data" => [...], "pagination" => {...}}`.
-    class Migration < Base
-      # Endpoints that are a plain paginated list of the channel's records.
-      COLLECTIONS = %i[
-        channels subscribers templates segments sequences email_servers
-        opt_in_forms broadcasts outbound_receipts webhook_endpoints tokens
-        suppressions unsubscribed_emails tags users link_redirects link_clicks
-        subscriber_histories file_assets
-      ].freeze
-
-      COLLECTIONS.each do |collection|
-        define_method(collection) do |**params|
-          get("/api/migration/v1/#{collection}", params)
-        end
-      end
-
-      # Export summary: format version, channel identity, per-resource counts,
-      # and recent-history totals. Call this first to size an export.
-      #
-      # @param days_history [Integer] window for the time-bounded counts
-      #   (broadcasts, receipts, histories). Server clamps to 1..365, default 90.
-      def manifest(**params)
-        get('/api/migration/v1/manifest', params)
-      end
-
-      # Binary contents of a stored file asset. Returns a String of bytes, not
-      # JSON — write it straight to disk.
-      def download_file_asset(id, **params)
-        @client.request(:get, "/api/migration/v1/file_assets/#{id}/download", params, raw: true)
-      end
-
-      # Pages through a collection, yielding each record.
-      #
-      #   client.migration.each_record(:subscribers) { |sub| csv << sub }
-      #
-      # Stops when the server reports `has_more: false`, so it stays correct if
-      # the page size is clamped server-side.
-      def each_record(collection, limit: 250, **params, &block)
-        return enum_for(:each_record, collection, limit: limit, **params) unless block_given?
-
-        offset = 0
-        loop do
-          page = public_send(collection, limit: limit, offset: offset, **params)
-          records = Array(page['data'])
-          records.each(&block)
-
-          pagination = page['pagination'] || {}
-          break unless pagination['has_more']
-
-          # Advance by what the server actually returned — it clamps `limit`.
-          advanced = pagination['limit'] || records.size
-          break if advanced.to_i.zero?
-
-          offset += advanced.to_i
-        end
-      end
-    end
-  end
-end