basecradle 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52b94c60f28a4c6e40decde0c297a0129a7f772a3b418f1a92fca3f380278982
-  data.tar.gz: 107fd61b78588132abba3e3d958714f65dd572a5de40f5c690abd58d35f658e1
+  metadata.gz: 3acdf9b8dad4d29a40926030c480cc415b96ffff03c56a121838b4fdb42cd638
+  data.tar.gz: 2b88488a27cae407aa366cce9899da840b7ea1e74db86d21c511f0f2b1ac47d7
 SHA512:
-  metadata.gz: 56a8ab9c7774f5765cfb2b08096488c1784558095e8ae4e433a13ebd6ed502afee0871a571a0e01db81b77adbf8399a8466d351c4c5c43794dc9ea24c6b6f74c
-  data.tar.gz: d15b3da9c230433eeaddd427e4298dddce8042d37e1a4e6de5dd1e8a4b7384901ed7b41db5ef8d1f804787b21aef63bdf2db05757da50a702768f28fe45a81fa
+  metadata.gz: 7f753c98128c1935e0503dd1963917ac1918e171401b4a39f6c1b650cd716213f02c52b1dd538a54bb201de0ede89af19e7ab2ec9abfa79d2eba68d71faa5f57
+  data.tar.gz: 31772a4161d2e3563a835ffbd2c9ae5a2d9e285a157ca2772be3213037297b168f8e89b67e8290a7897a77a009add74b9769bf5e623ac5256ec19f26eece04d9

data/CHANGELOG.md

@@ -4,6 +4,57 @@ 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).
 
+One deliberate departure from that format: this changelog keeps **no `Unreleased`
+section**. The newest heading is always the version `lib/basecradle/version.rb` builds —
+a release writes its entry and its version in the same PR — and `test/changelog_test.rb`
+fails CI if the two ever disagree.
+
+## [0.10.0] - 2026-09-30
+
+### Fixed
+
+- **A model serializes as the record it stands for**
+  ([#191](https://github.com/basecradle/basecradle-ruby/issues/191)). `ApiObject` defined
+  no `to_json`, so serializing *any* model — `bc.me`, a `Timeline`, a `Message`, any
+  content object — fell through to Ruby's default and emitted a heap address:
+  `"#<BaseCradle::MessageContent:0x000072be94b09…>"`. Silently, with no field names and a
+  different value every run. `model.to_json` and `JSON.generate(model)` now emit the
+  record, and so does a model nested in an array or a hash. What `to_h` holds is exactly
+  what goes out: nothing renamed, nothing dropped, and a field newer than this SDK
+  release serialized like any other.
+  `WebhookEventHeaders` is unchanged — it subclasses `Hash`, so it already serialized as
+  the delivery's headers.
+  Long-standing; 0.9.0's typing of `timeline.items` content only widened which read path
+  reached it. **0.9.0's Migrating note on `to_json` is superseded by this release.**
+
+### Added
+
+- **`as_json`**, ActiveSupport's serialization hook, returning the same wire `Hash` as
+  `to_h`. It is what reaches a model nested inside a structure Rails renders
+  (`render json: { user: bc.me }`); a bare `render json: model` calls `to_json` directly
+  and never reaches it. Two things to know, neither of which a Rails habit expects:
+  - **It returns the same `Hash` as `to_h`, not a copy** — read-only by the same
+    convention, where every ActiveSupport `as_json` builds a fresh one. So
+    `model.as_json.merge!(extra)` rewrites the model's wire record, and for a wrapped
+    child its parent's too. Use `model.to_h.dup` (shallow) if you need to touch it.
+  - **Options are accepted and ignored, `only:` and `except:` included** — a model is a
+    read of one record, not a presenter. `as_json(except: ["ingest_url"])` returns the
+    whole record, silently, and it *disagrees* with `to_json`: with ActiveSupport loaded
+    `model.to_json(except: [...])` does redact, because the option reaches `Hash#to_json`.
+    Do not route redaction through either — build the subset with
+    `model.to_h.except("ingest_url")`.
+
+  `to_json` forwards its argument to `Hash#to_json` rather than swallowing it, so
+  `JSON.pretty_generate` pretty-prints; what an unknown option does is the host app's
+  `json` version's business (3.x raises, the 2.x older Rubies ship ignores it).
+
+  `to_s` is untouched, so interpolating a model (`"#{model}"`, `puts model`) still shows
+  the default object form. `inspect` names the model and its fields; `to_json` / `to_h`
+  give the record.
+
+  Minor rather than patch: the `to_json` output is a fix, but `as_json` is new public
+  surface and 0.9.0 documented the old behavior as expected — semver takes the higher.
+
 ## [0.9.0] - 2026-09-30
 
 ### Changed
@@ -46,6 +97,9 @@ enrichments come with them — but three things that worked on a `Hash` no longe
   field names — because `ApiObject` defines no `to_json`. That is long-standing for
   every other model in the SDK and now reaches this path too. Serialize
   `item.content.to_h` instead.
+  > ⚠️ **Superseded in [0.10.0](#0100---2026-09-30)**, which gives `ApiObject` a
+  > `to_json`. `item.content.to_json` emits the record; the `to_h` workaround above is
+  > no longer needed. Left as written for the historical record.
 - **`inspect` and `==` change, both for the better.** `inspect` names the model and its
   wire fields (`#<BaseCradle::MessageContent body, uuid>`) rather than printing a `Hash`;
   and equality now *holds* between an item's content and the same record fetched
@@ -342,6 +396,7 @@ 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.10.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.10.0
 [0.9.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.9.0
 [0.8.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.8.0
 [0.7.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.7.0

data/README.md

@@ -324,6 +324,41 @@ timeline = bc.timelines.create(name: "Incident response")
 timeline.add_participant(nova)
 ```
 
+## Reading models, and serializing them
+
+Every model is a read-only, wire-exact view of one API JSON object. Field readers mirror
+the wire names; `model[key]` is the raw escape hatch for a field newer than your SDK
+release; `model.to_h` is the wire `Hash` itself.
+
+Models serialize as the record they stand for — what `to_h` holds is what goes out, so
+logging or re-emitting one gives you the wire record rather than an object address:
+
+```ruby
+require "basecradle"
+require "json"
+
+bc = BaseCradle::Client.new
+message = bc.messages.first
+
+puts message.content.to_json                  # {"uuid":"019e...","body":"Hello from a peer."}
+puts JSON.generate([message.content])         # nested in an array
+puts({ latest: message.content }.to_json)     # nested in a hash
+```
+
+`as_json` is ActiveSupport's hook and returns the same wire `Hash`, so a model nested in
+something Rails renders comes out right too. Three caveats worth knowing:
+
+- **`as_json` returns the same `Hash` as `to_h`, not a copy** — read-only by the same
+  convention. Mutating it rewrites the model's record. Use `model.to_h.dup` (shallow).
+- **Options are accepted and ignored, `only:` and `except:` included.** A model is a read
+  of one record, not a presenter, so `as_json(except: ["ingest_url"])` returns the whole
+  record, silently — and it *disagrees* with `to_json`, which under ActiveSupport does
+  redact, because the option reaches `Hash#to_json`. Do not route redaction through
+  either: build the subset with `model.to_h.except("ingest_url")`.
+- **`to_json` forwards its argument** to `Hash#to_json`, so `JSON.pretty_generate`
+  pretty-prints. What an unknown option does is your `json` version's business — 3.x
+  raises, the 2.x older Rubies ship ignores it.
+
 ## Development
 
 ```bash

data/lib/basecradle/api_object.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "json"
+
 require_relative "errors"
 
 module BaseCradle
@@ -61,6 +63,46 @@ module BaseCradle
       @data
     end
 
+    # The wire record, for a serializer — ActiveSupport's hook, and what reaches a model
+    # nested inside a structure Rails renders (<tt>render json: { user: bc.me }</tt>).
+    # A bare <tt>render json: model</tt> calls +to_json+ instead and never comes here.
+    #
+    # Returns +to_h+: the wire keys, nothing renamed, nothing dropped, and a field newer
+    # than this release carried like any other. (It is the record *as this object holds
+    # it* — for a Timeline fetched whole, that is the API's two-key envelope merged into
+    # one object, so it carries +items+ alongside the timeline's own fields.)
+    #
+    # Two traps, because neither is what a Rails habit expects:
+    #
+    # - **It is the same Hash +to_h+ returns, not a copy** — read-only by the same
+    #   convention, where every ActiveSupport +as_json+ builds a fresh one. So
+    #   <tt>model.as_json.merge!(extra)</tt> rewrites the model's wire record, and for a
+    #   wrapped child its parent's too (a child wraps the parent's own nested Hash).
+    #   +to_h.dup+ if you need to touch it; note that is shallow.
+    # - **Options are accepted and ignored, +only:+ and +except:+ included** — a model is
+    #   a read of one record, not a presenter. +as_json(except: ["ingest_url"])+ returns
+    #   the whole record, *silently*. Worse, it disagrees with +to_json+: with
+    #   ActiveSupport loaded <tt>model.to_json(except: [...])</tt> *does* redact, because
+    #   the option reaches +Hash#to_json+. Do not rely on either — build the subset
+    #   yourself with <tt>model.to_h.except("ingest_url")</tt>.
+    def as_json(*)
+      to_h
+    end
+
+    # The wire record as JSON. Without this a model fell through to Ruby's default and
+    # emitted a heap address — silently, with no field names and a different value every
+    # run. +JSON.generate+ and +Array#to_json+ / +Hash#to_json+ call this, so a model
+    # nested in either serializes correctly too.
+    #
+    # The argument is forwarded to +Hash#to_json+ rather than swallowed, so
+    # +JSON.pretty_generate+ pretty-prints — and what an unknown option does is the host
+    # app's json version's business, not this SDK's: json 3.x raises on an unknown
+    # keyword, the json 2.x that older Rubies ship ignores it, and ActiveSupport acts on
+    # +only:+ / +except:+. See +as_json+ above: do not route redaction through either.
+    def to_json(*args)
+      to_h.to_json(*args)
+    end
+
     def ==(other)
       other.instance_of?(self.class) && other.to_h == @data
     end

data/lib/basecradle/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basecradle
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Drawk Kwast