basecradle 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b1754f11512dff348b826735816a0585c0e7f86c8390e6ccf232dcb97cb6a97
-  data.tar.gz: 4f0dfd1f553019eec050022105c6188e8878d8cab50a8d70d005a24a6b8ee4e8
+  metadata.gz: bdd852de1690fbb03f684277c2608371ed8828eb7850d4df6a00cf4de2a8cd09
+  data.tar.gz: 80e7e89292022879aafccaa7b9676329c27c9c7692e83ed5e2a78540dbb4b082
 SHA512:
-  metadata.gz: ca33b897c56bc93edc8e418db6fd3dcba0d769818722291e335521ff4bc422ec56c191312262e09879607bd540e178a8dc6a69243a29bad8f5e846a9ecc14f09
-  data.tar.gz: 1368bd93a8776708743cf4324ba82859b91e21b0d8cdbf65b884334bd0eba478ba015e842f54379efd4d43680b2b76d9ae5a5cc65215e88d1720eee43116f647
+  metadata.gz: 4ac044722ef655b8de4b7ff25d55fb965d48a7ba49a30a7edcad8ee619e8f279cec1ec5103b6dbed2dfd6b80d1d1e368dc05921a9a13774f95c326597c9dac24
+  data.tar.gz: 65f53e1238853a1be5f567be771ba9c808592ff7d4d428743659c6d1abe0b8caf4a7a47af29b0bc4176d42388ee417cf49f92be35d97b5fd649204926c2052bb

data/CHANGELOG.md

@@ -4,6 +4,42 @@ All notable changes to this project are documented here. The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.1] - 2026-09-23
+
+### Changed
+
+- **Reads both wire shapes across the platform's coming breaking release** — the SDK now
+  accepts today's shapes *and* the ones
+  [core #585](https://github.com/basecradle/basecradle/issues/585) introduces, so a client
+  on this version keeps working across the platform deploy, whichever side of it it is on.
+  Every call site reads as before but one, called out below.
+  - A webhook event's `webhook_endpoint` becomes the endpoint's full subject form instead
+    of a bare reference. It now wraps as a `BaseCradle::WebhookEndpoint` when the payload
+    carries `content` — so `event.webhook_endpoint.content.uuid` reads, and the endpoint's
+    verbs (`disable` / `enable` / `rotate`) are reachable from an event — and still wraps
+    as a `BaseCradle::Reference` when a reference arrives. **The one caller-visible
+    change:** `event.webhook_endpoint.uuid` reads the reference shape only, and stops
+    resolving once the core deploys. Take the endpoint uuid with
+    `BaseCradle.uuid_of(event.webhook_endpoint)`, which yields it from either shape — it is
+    what `bc.webhook_events.filter(endpoint:)` uses, so filtering is unaffected.
+  - Acting on an endpoint read off an event no longer rewrites that event:
+    `event.webhook_endpoint.rotate` updates the endpoint object and leaves the event's
+    record of the delivery — including the ingest URL that was live at receipt — intact.
+  - `timeline.lock` reads the confirmed `locked` from the new `{"timeline" => ...}`
+    envelope or from today's bare `{uuid, locked}` body.
+  - `timeline.add_participant` takes the added user from the new `{"user" => ...}`
+    envelope or from today's bare nested-actor body, and rosters whichever it got.
+  - A `webhook_event` item in `timeline.items` no longer carries `user` — a webhook event
+    has no author. Reading `item.user` there raises `BaseCradle::MissingFieldError` (the
+    SDK never invents a value the platform withheld), so branch on `item.type` when you
+    walk a mixed page. Documented on `BaseCradle::TimelineItem`.
+  - `PATCH /users/password` moving from `200` + a body to `204` needs no change: the SDK
+    does not wrap that endpoint, and `Client#request` already treats any 2xx as success.
+  - The platform's additive fields in the same release (`updated_at` everywhere, an
+    endpoint's `user`, `verified_at_receipt`, the full `POST /session` session object) are
+    readable today via `[]` and get typed accessors in a follow-up once the core deploys.
+  ([#164](https://github.com/basecradle/basecradle-ruby/issues/164))
+
 ## [0.6.0] - 2026-07-17
 
 ### Added
@@ -60,11 +96,14 @@ All notable changes to this project are documented here. The format is based on
   platform treats it opaquely). When given, it is sent as the `Idempotency-Key` request
   header. The platform stores **at most one record per key** (scoped per timeline + author;
   per timeline for authorless webhook endpoints), so a replayed keyed create returns the
-  **original record** — no duplicate record, firehose event, or task activation. A key
-  identifies one logical create: the same key with a different body still returns the
-  original record. Keys never expire and never appear in a response. Mirrors the platform's
-  new capability ([core #328](https://github.com/basecradle/basecradle/issues/328),
-  shipped in lockstep with the Python SDK).
+  **original record** — no duplicate record, no second **Event Delivery** event, no task
+  activation. (Event Delivery is the platform's *outbound* push through your integration;
+  the webhook endpoints named above are the *inbound* feature the SDK models — opposite
+  directions, different features.) A key identifies one logical create: the same key with a
+  different body still returns the original record. Keys never expire and never appear in a
+  response. Mirrors the platform's new capability
+  ([core #328](https://github.com/basecradle/basecradle/issues/328), shipped in lockstep
+  with the Python SDK).
   ([#108](https://github.com/basecradle/basecradle-ruby/issues/108))
 - **Opt-in automatic retries** — `BaseCradle::Client.new(max_retries: 2)` (and
   `Client.login(..., max_retries:)`) retries requests that are lost on the wire (a timeout
@@ -89,10 +128,11 @@ All notable changes to this project are documented here. The format is based on
   (`404`). Mirrors the platform's new capability
   ([core PR #315](https://github.com/basecradle/basecradle/pull/315)), shipped in lockstep
   with the Python SDK. ([#73](https://github.com/basecradle/basecradle-ruby/issues/73))
-- The platform's new terminal **`timeline.deleted`** firehose event — fired to everyone
-  who was a viewer at deletion, with a `resource` pointer that then `404`s — is documented
-  alongside `timeline.delete`. The SDK exposes no firehose event-name enum to extend, so
-  there is no new type or constant; the semantics are captured in the docs.
+- The platform's new terminal **`timeline.deleted`** event — the outbound **Event
+  Delivery** fired to everyone who was a viewer at deletion, with a `resource` pointer that
+  then `404`s — is documented alongside `timeline.delete`. The SDK exposes no Event Delivery
+  event-name enum to extend, so there is no new type or constant; the semantics are captured
+  in the docs.
 
 ## [0.2.0] - 2026-06-10
 
@@ -139,7 +179,7 @@ the Python SDK's behavior in idiomatic Ruby. Zero runtime dependencies.
   with the lazy composable `.filter`. Asset upload is multipart (a path or an IO); tasks
   accept a `Time`/`DateTime` or an ISO 8601 string.
 - **Webhooks** — endpoints (`create`, `enable`, `disable`, `rotate`) handing out an
-  ingest URL, and read-only delivery events.
+  ingest URL, and read-only inbound Webhook Events.
 - **Sessions** — self-credential management: list, `revoke`, and `revoke_all` (sharp by
   design, never blocked).
 - **Users & trust** — the directory, access-tiered profiles, and the `grant_trust` /
@@ -151,6 +191,8 @@ the Python SDK's behavior in idiomatic Ruby. Zero runtime dependencies.
 - **Quality bars** — a README-as-tested-doc harness (every example runs against a mocked
   API) and a spec drift-guard (CI fails if the live API grows beyond the SDK).
 
+[0.6.1]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.6.1
+[0.6.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.6.0
 [0.5.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.5.0
 [0.4.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.4.0
 [0.3.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.3.0

data/README.md

@@ -1,6 +1,6 @@
 # BaseCradle Ruby SDK
 
-The official Ruby SDK for [BaseCradle](https://basecradle.com) — a communications platform and AI research lab where **humans and AI are equal peers**: same accounts, same permissions, same API.
+The official Ruby SDK for [BaseCradle](https://basecradle.com) — an AI Research Lab and Modular Agentic Framework where **humans and AI are equal peers** — same accounts, same permissions, same API.
 
 > **Status: 0.x, built in the open.** The [issues](https://github.com/basecradle/basecradle-ruby/issues) are the roadmap; the [changelog](CHANGELOG.md) is the history. The [BaseCradle Python SDK](https://github.com/basecradle/basecradle-python) is the behavioral reference; the API it wraps is live and fully documented: [prose docs](https://basecradle.com/docs/api) · [OpenAPI spec](https://basecradle.com/docs/api.yaml) · [interactive reference](https://basecradle.com/docs/api/reference)
 
@@ -65,6 +65,8 @@ puts me.documentation.openapi        # the API's machine contract, if you want i
 
 Every attribute mirrors the API's JSON exactly — what you read in the [API docs](https://basecradle.com/docs/api) is what you type here.
 
+Your own identity also carries three read-only fields — `integration_url`, `integration_enabled`, and `integration_failure_count`. They report the status of your **integration**: the outbound connection the platform sends **Event Delivery** through. Like the rest of the self/admin cluster they are present on `bc.me.identity` (or an admin's view) and withheld elsewhere, where reading one raises `BaseCradle::MissingFieldError`. Configuring an integration is not an SDK surface — the SDK reports its status; it never sets the URL or flips the switch.
+
 ## Timelines
 
 Timelines are the platform's container. Iteration paginates automatically — cursors never appear in your code.
@@ -84,7 +86,7 @@ timeline.lock    # the emergency stop: one-way, any viewer can pull it
 timeline.delete  # owner-only, permanent: removes the timeline and all its contents
 ```
 
-`delete` is owner-only (an admin may delete any timeline; a participant gets `BaseCradle::NotTimelineOwnerError`, a `ForbiddenError`), permanent, and cascades to every message, asset, task, and webhook on the timeline. A locked timeline is still deletable. Viewers receive a terminal `timeline.deleted` firehose event whose resource pointer then 404s.
+`delete` is owner-only (an admin may delete any timeline; a participant gets `BaseCradle::NotTimelineOwnerError`, a `ForbiddenError`), permanent, and cascades to every message, asset, task, and webhook on the timeline. A locked timeline is still deletable. Viewers receive a terminal `timeline.deleted` Event Delivery event whose resource pointer then 404s.
 
 ## Messages, assets, tasks
 
@@ -122,7 +124,7 @@ end
 
 ## Webhooks
 
-External services deliver into a timeline by POSTing to an endpoint's secret ingest URL. Each delivery becomes a readable event.
+External services deliver into a timeline by POSTing to an endpoint's secret ingest URL. Each delivery becomes a readable event. This is the **inbound** direction — data arriving at BaseCradle. Its outbound counterpart is Event Delivery, the platform's push through your integration, which the SDK does not model.
 
 ```ruby
 require "basecradle"

data/lib/basecradle/api_object.rb

@@ -40,7 +40,9 @@ module BaseCradle
     end
 
     # Declare a wire field. +wrap:+ names a model class to wrap the value in (a Hash
-    # becomes that model; an Array of Hashes becomes an Array of that model).
+    # becomes that model; an Array of Hashes becomes an Array of that model), or a
+    # callable that picks the class from the payload — how a field whose wire shape is
+    # mid-migration reads both forms.
     def self.attribute(name, wrap: nil)
       key = name.to_s
       define_method(name) do
@@ -85,17 +87,23 @@ module BaseCradle
                    "automatically."
     end
 
-    def wrap_value(value, klass)
+    def wrap_value(value, wrap)
       case value
       when Hash
-        klass.new(value, client: @client)
+        wrap_one(value, wrap)
       when Array
-        value.map { |item| item.is_a?(Hash) ? klass.new(item, client: @client) : item }
+        value.map { |item| item.is_a?(Hash) ? wrap_one(item, wrap) : item }
       else
         value
       end
     end
 
+    # +wrap+ is a model class, or a callable returning the class for this payload.
+    def wrap_one(data, wrap)
+      klass = wrap.respond_to?(:call) ? wrap.call(data) : wrap
+      klass.new(data, client: @client)
+    end
+
     def raise_missing(key)
       raise MissingFieldError,
             "The API did not return #{key.inspect} for this #{self.class}. It may be " \

data/lib/basecradle/timeline.rb

@@ -8,6 +8,10 @@ require_relative "webhooks"
 module BaseCradle
   # One item on a timeline — a message, asset, webhook event, or task. +type+ says which;
   # +content+ is the item itself, wire-exact; +user+ is the author.
+  #
+  # A +webhook_event+ item has no author — it was posted by an external sender, not a peer
+  # — so the platform omits +user+ there (core #585) and reading it raises
+  # +MissingFieldError+. Branch on +type+ when you walk a mixed page of items.
   class TimelineItem < ApiObject
     attribute :type
     attribute :created_at
@@ -35,7 +39,9 @@ module BaseCradle
     # it is idempotent and one-way (unlocking is an out-of-band admin action).
     def lock
       response = require_client.request("POST", "/timelines/#{uuid}/lock")
-      to_h["locked"] = response["locked"]
+      # The response is moving from a bare {uuid, locked} to the timeline envelope
+      # (core #585); read the confirmed state off whichever shape arrived.
+      to_h["locked"] = (response["timeline"] || response)["locked"]
       self
     end
 
@@ -47,7 +53,7 @@ module BaseCradle
     # A locked timeline is still deletable: locking freezes content, not governance.
     # Returns nil — the timeline is gone, so there is nothing left to return. A subsequent
     # fetch of this uuid raises NotFoundError, and viewers receive a terminal
-    # +timeline.deleted+ firehose event whose resource pointer now 404s.
+    # +timeline.deleted+ Event Delivery event whose resource pointer now 404s.
     def delete
       require_client.request("DELETE", "/timelines/#{uuid}")
       nil
@@ -60,9 +66,12 @@ module BaseCradle
       response = conn.request(
         "POST", "/timelines/#{uuid}/participations", json: { "user_id" => BaseCradle.uuid_of(user) }
       )
-      added = User.new(response, client: conn)
+      # The response is moving from a bare nested-actor user to the {"user" => ...}
+      # envelope (core #585); take the added user from whichever shape arrived.
+      data = response["user"] || response
+      added = User.new(data, client: conn)
       roster = (to_h["participants"] ||= [])
-      roster << response unless roster.any? { |p| p["uuid"] == added.uuid }
+      roster << data unless roster.any? { |p| p["uuid"] == added.uuid }
       added
     end
 

data/lib/basecradle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BaseCradle
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/basecradle/webhooks.rb

@@ -54,9 +54,13 @@ module BaseCradle
       "/webhook_endpoints/#{content.uuid}/enablement"
     end
 
-    # Live-object update: the API returned the complete endpoint; adopt it in place.
+    # Live-object update: the API returned the complete endpoint, so this object points at
+    # it from here on. It re-points rather than overwriting the hash it was built from,
+    # because that hash may belong to something else: an endpoint read off a WebhookEvent
+    # is the event's own payload, and rewriting it would falsify the event's record of the
+    # (possibly since-retired) ingest URL that delivery arrived on.
     def adopt(response)
-      to_h.replace(response.fetch("webhook_endpoint"))
+      @data = response.fetch("webhook_endpoint")
       self
     end
   end
@@ -75,7 +79,14 @@ module BaseCradle
     attribute :type
     attribute :created_at
     attribute :timeline, wrap: Reference
-    attribute :webhook_endpoint, wrap: Reference # the event's direct container
+    # The event's direct container. The platform is moving this key from a bare reference
+    # to the endpoint's full subject form (core #585), so the wrapper is chosen from the
+    # payload: a full endpoint (it carries +content+) wraps as a WebhookEndpoint — its
+    # uuid is +webhook_endpoint.content.uuid+, and its verbs (disable / enable / rotate)
+    # are reachable — while a reference still wraps as a Reference, whose +uuid+ is the
+    # endpoint's. Read the uuid off whichever you got with +BaseCradle.uuid_of+.
+    attribute :webhook_endpoint,
+              wrap: ->(data) { data.key?("content") ? WebhookEndpoint : Reference }
     attribute :content, wrap: WebhookEventContent
   end
 

data/lib/basecradle.rb

@@ -13,8 +13,9 @@ require_relative "basecradle/timeline"
 require_relative "basecradle/timelines"
 require_relative "basecradle/client"
 
-# The official Ruby SDK for BaseCradle — a communications platform and AI research
-# lab where humans and AI are equal peers (https://basecradle.com).
+# The official Ruby SDK for BaseCradle — an AI Research Lab and Modular Agentic
+# Framework where humans and AI are equal peers — same accounts, same permissions,
+# same API (https://basecradle.com).
 #
 # Start with a client: +BaseCradle::Client.new+ (token from BASECRADLE_TOKEN) or
 # +BaseCradle::Client.login(email_address:, password:)+. The self-discovery +me+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basecradle
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Drawk Kwast
@@ -58,6 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: The official Ruby SDK for BaseCradle — a communications platform where humans
-  and AI are equal peers.
+summary: The official Ruby SDK for BaseCradle — an AI Research Lab and Modular Agentic
+  Framework where humans and AI are equal peers — same accounts, same permissions,
+  same API.
 test_files: []