broadcast-ruby 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7866007085ed5d19620669069bdfeb9e7babaad5d08b2198d76e19620ce68bde
-  data.tar.gz: '082d0663d0a5a2501f445f0f7152e6b6a56467d1e0a61d0ae96e45b3137380d0'
+  metadata.gz: 6a0fbeb95adead9eca90faa48afb7e5cd463c7caa23d9e0a217abd2fd4f27350
+  data.tar.gz: abc65de39dfaf74dc17a5f5021f4c2b7a9b24821b3bd9bd87582811153d2901e
 SHA512:
-  metadata.gz: bd9d8c35c4bdcea360c59609be5e366bcd066084328db6380e7f3995cc49e7121937b053c6e09c36d94262d54cfc4d4bb978dcae93a58410407a3da78a6d9182
-  data.tar.gz: c4d0c47df97790a337dc35b882fea9254c1ae8f41d19784f71bebecb253c6b00740356be0cb5b1b7edf2d2c9965f84556f1fcc31fc350dd1e6214adda167fc63
+  metadata.gz: e0b60c030234703fce2c09b864519a227ae7ebf34a60f32e5b5ae92b7650199ef548949d85fa2e190b788527168004c066b29adccf032716b3a968127b35d69b
+  data.tar.gz: 9be0806cdda4c12ab34b5cb03fc2a4e8daee603e90318a469b64be5015a532ec771b6c28cf58a2b3e41cd612c02b2af036345375689107aeb79da9feb699dd6a

data/CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.4.1] - 2026-08-16
+
+### Fixed — sequence enrolment never worked
+
+`Sequences#add_subscriber` and `#remove_subscriber` sent the subscriber
+attributes flat, but the API reads them with `params.require(:subscriber)`.
+Every call was rejected:
+
+    Broadcast::APIError: param is missing or the value is empty or invalid: subscriber
+
+Both now nest the attributes under a `subscriber` key.
+
+### Added
+
+- `Discovery#openapi` for `GET /api/v1/openapi`, which returns the
+  installation's own OpenAPI document.
+
+This was invisible to the test suite because the tests asserted the shape the
+code already sent (`hash_including('email' => ...)` at the top level) rather
+than the shape the server requires — so they encoded the bug instead of
+catching it. Found only by a real enrolment against a live instance; the tests
+now pin the nested payload.
+
 ## [0.4.0] - 2026-08-14
 
 ### Fixed — ActionMailer delivery

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    broadcast-ruby (0.4.0)
+    broadcast-ruby (0.4.1)
       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.4.0)
+  broadcast-ruby (0.4.1)
   builder (3.3.0) sha256=497918d2f9dca528fdca4b88d84e4ef4387256d984b8154e9d5d3fe5a9c8835f
   concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
   connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a

data/lib/broadcast/client.rb

@@ -77,6 +77,10 @@ module Broadcast
       discovery.skill
     end
 
+    def openapi
+      discovery.openapi
+    end
+
     # --- Resource sub-clients ---
 
     def subscribers

data/lib/broadcast/resources/discovery.rb

@@ -31,6 +31,18 @@ module Broadcast
       def skill
         @client.request(:get, '/api/v1/skill', nil, raw: true)
       end
+
+      # This installation's own OpenAPI document, as YAML. Returns a String,
+      # not a Hash — the endpoint serves application/yaml.
+      #
+      # The server URL in the document is rewritten by the installation to the
+      # host that served it, so the result feeds a client generator or an API
+      # explorer without hand-editing. Worth preferring over a spec copied from
+      # anywhere else: a 2.28 install serves the 2.28 surface, so the document
+      # cannot drift from the routes it describes.
+      def openapi
+        @client.request(:get, '/api/v1/openapi', nil, raw: true)
+      end
     end
   end
 end

data/lib/broadcast/resources/sequences.rb

@@ -26,12 +26,17 @@ module Broadcast
 
       # --- Subscriber enrollment ---
 
+      # Both of these nest the attributes under `subscriber`, because the API
+      # reads them with `params.require(:subscriber)`. Sent flat they are
+      # rejected outright with "param is missing or the value is empty or
+      # invalid: subscriber".
       def add_subscriber(sequence_id, **attrs)
-        post("/api/v1/sequences/#{sequence_id}/add_subscriber", attrs)
+        post("/api/v1/sequences/#{sequence_id}/add_subscriber", { subscriber: attrs })
       end
 
       def remove_subscriber(sequence_id, email:)
-        @client.request(:delete, "/api/v1/sequences/#{sequence_id}/remove_subscriber", { email: email })
+        @client.request(:delete, "/api/v1/sequences/#{sequence_id}/remove_subscriber",
+                        { subscriber: { email: email } })
       end
 
       def list_subscribers(sequence_id, page: 1)

data/lib/broadcast/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: broadcast-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Simon Chiu