simple_connect-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7ccdbb67c4b168087543c5244805676d3e81d7b4522396047828cba666a56a
-  data.tar.gz: 723170ac99fdd68572c96d883337ef29715fca4741997d65b2b4a53827595ac3
+  metadata.gz: 80608e802aa6273143cb24d056f08abc1541dac6223371eae39c2611ed2ab99e
+  data.tar.gz: 9c8e9130fd84bda6b19eaccf5f57a68ff81dc186070f19ef1834114981dbb8bb
 SHA512:
-  metadata.gz: 71a6195f53d733026560728f7c1d93774c5aa196ec54400fad876296ff387d59000166d0141e5a3a6eb661a813e0c09f2e76bf90b87bd156670f965291cfe513
-  data.tar.gz: bb9c5d523968ae07cf3306dab93a2302f389bac9992dac0bee67b37693b06222aa1562fdc46f230db251c97d99a535f8d6566510101ecc53621f489b90e878bf
+  metadata.gz: ad8d5b28164c2598aeb32ee7bf0db42eec12ab15a0fed501d12b4cd9e33dfda11ac69ae24e21be0def68773c1119c40d020d31c0e77aae5b993458a1cc02e7b9
+  data.tar.gz: 2d578d852fa29a83400e6fecd49918cbddc118ebe7e846f64496e04d79b88ea7c3d3844c4f6f2c22c55900085e3b6872c2b8cc1a0a04810cc9c5b1cc63abfd29

data/CHANGELOG.md

@@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2026-04-30
+
+### Added
+
+- `events.deliver` response now embeds the persisted event-log row plus
+  the (optional) linked WhatsApp message under the same
+  `event_log` / `message` keys that `events.detail` already uses. The
+  new `DeliverResponse#event` returns this as an `EventResponse` —
+  callers can read `result.data.event.status`, `.error_text`,
+  `.skipped?`, `.dispatched?`, `.message`, etc., to see at a glance
+  whether the event was actually queued for dispatch (`"received"`) or
+  skipped because the integration is paused / the per-event flow is
+  disabled (both still return 202 server-side, because the event was
+  logged for audit). Previously the only deliver-time signal was
+  `#log_id` / `#event_id`, so a paused integration looked identical to
+  a healthy one from the sender's perspective.
+- `EventResponse` is now reused for both endpoints — no new response
+  class. Its existing public surface is unchanged.
+
+### Compatibility
+
+- **Server requirement**: the new `event_log` / `message` fields are
+  populated by SimpleWaConnect server ≥ v0.3.0. Older servers return
+  the v0.2.0 shape (`status`, `log_id`, `event_id`, `duplicate`,
+  `used_previous_secret`); `DeliverResponse#event` returns `nil` in
+  that case so existing code continues to work unmodified.
+- The flat `#log_id` / `#event_id` accessors on `DeliverResponse` are
+  preserved — existing callers do not need to change anything.
+
 ## [0.2.0] - 2026-04-21
 
 ### Changed
@@ -51,6 +80,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Ruby 3.2+.
 - No runtime gem dependencies (stdlib only).
 
-[unreleased]: https://github.com/GemsEssence/SimpleWaConnect/compare/simple_connect-client-v0.2.0...HEAD
+[unreleased]: https://github.com/GemsEssence/SimpleWaConnect/compare/simple_connect-client-v0.3.0...HEAD
+[0.3.0]: https://github.com/GemsEssence/SimpleWaConnect/compare/simple_connect-client-v0.2.0...simple_connect-client-v0.3.0
 [0.2.0]: https://github.com/GemsEssence/SimpleWaConnect/compare/simple_connect-client-v0.1.0...simple_connect-client-v0.2.0
 [0.1.0]: https://github.com/GemsEssence/SimpleWaConnect/releases/tag/simple_connect-client-v0.1.0

data/lib/simple_connect/responses/deliver_response.rb

@@ -5,14 +5,32 @@ module SimpleConnect
     # Wraps the `events.deliver` acknowledgement.
     #
     # Server returns:
-    #   202 on a new event → { status, log_id, event_id }
-    #   200 on an idempotent replay → { status, log_id, event_id, duplicate: true }
+    #   202 on a new event       → { status, log_id, event_id, event_log, message }
+    #   200 on a duplicate replay → { status, log_id, event_id, event_log, message, duplicate: true }
     # Either code is a success; consumers check `#duplicate?` to distinguish.
     # If the request was signed with a recently-rotated previous secret, the
     # server adds `"used_previous_secret": true` at the top level — a hint
     # to rotate credentials before the grace window ends.
+    #
+    # As of server v0.3.0, the response also carries the persisted
+    # event-log row + symmetric message under the same `event_log` /
+    # `message` keys that `events.detail` uses, so the same `EventResponse`
+    # parser wraps both. `#event` returns that wrapped row — the caller can
+    # read `#event.status`, `#event.error_text`, `#event.skipped?`, etc., to
+    # see at a glance whether the event was actually queued for dispatch
+    # (`"received"`) or skipped because the integration is paused / the
+    # per-event flow is disabled. Without this, a paused integration looked
+    # identical to a live one from the sender's perspective.
+    #
+    # `#event.message` is almost always `nil` at deliver time — dispatch is
+    # async and the outbound Message does not exist yet at the moment of
+    # the ack; populated only on duplicate replays of an already-dispatched
+    # event.
+    #
+    # The flat `#log_id` / `#event_id` accessors are preserved for backward
+    # compatibility.
     class DeliverResponse
-      attr_reader :status, :log_id, :event_id
+      attr_reader :status, :log_id, :event_id, :event
 
       def initialize(json)
         @json                 = json.is_a?(Hash) ? json : {}
@@ -21,6 +39,7 @@ module SimpleConnect
         @event_id             = @json["event_id"]
         @duplicate            = @json["duplicate"] == true
         @used_previous_secret = @json["used_previous_secret"] == true
+        @event                = @json["event_log"].is_a?(Hash) ? EventResponse.new(@json) : nil
       end
 
       def duplicate?

data/lib/simple_connect/responses/event_response.rb

@@ -2,9 +2,15 @@
 
 module SimpleConnect
   module Responses
-    # Wraps the `events.detail` success payload. Holds the event-log row
-    # and, optionally, a nested `MessageResponse` if a WhatsApp message is
-    # linked to the event.
+    # Wraps the persisted event-log row and (optionally) the linked
+    # WhatsApp message. Returned from two endpoints:
+    #
+    #   * `events.detail` — the full GET payload, where the server wraps
+    #     the log under an `"event_log"` key alongside `"message"`.
+    #   * `events.deliver` (server ≥ 0.3.0) — the same shape, embedded
+    #     under the `"event"` key on the deliver ack so callers know
+    #     immediately whether the event was queued (`"received"`) or
+    #     skipped (`"skipped_paused"`, `"skipped_disabled"`, …).
     class EventResponse
       attr_reader :event_id, :event_key, :status, :occurred_at, :created_at,
                   :updated_at, :error_text, :payload, :message

data/lib/simple_connect/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleConnect
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_connect-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ramkrishan Patidar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-04-21 00:00:00.000000000 Z
+date: 2026-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake