basecradle 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a044c2738074a7dab0cb39dc2d311324fd589bca99aa27cfe62fc0c844feea
-  data.tar.gz: 4df34781e48954ce10bdf0bd4107cc30036f20b2652c7735f4e942964c29d2ef
+  metadata.gz: 9766c4ae3f22a8dcb26bb88bac8931e8257dd429ea8ba4a56af26d4eda9fb8ae
+  data.tar.gz: 1504a5d791f9a5874cbbfea13abff10a64f17c9f6b5f557898e90c19a03182cb
 SHA512:
-  metadata.gz: 7f1b9755e5cfb944f65283d460ea364044e2d0278c786b81d3adf3a8da49c2173515daa61c0bcedd17975b0378ed1ec0b19fdccfcd3dfb15ac772926ba80c540
-  data.tar.gz: 21a11fbcccae45b4dab82e31eab89e963016b1fd4d54c98548a8064294bd9e2e68dfac4e9521d7ff6a0cef3db8fdf5d4a731c0288d5cbf69a00d63093379f1ca
+  metadata.gz: 5c0677055d1b17309e17a5303ac381c5364f4083403626279236d1f214f3d40a203126d71b27b658ebd808642565523ea27690feedbd4ee9d595d440f9b77b72
+  data.tar.gz: acb01b5cdfc88eb6d62006b221d2f84c876151dad8169ce3020bed6d73acc6cb7a6c2777de0efaea183b2c4fab5c02f1ab437b222b80adb5d13a0c44ffe60a7e

data/CHANGELOG.md

@@ -4,6 +4,39 @@ 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.8.0] - 2026-09-30
+
+### Changed
+
+- **`event.content.headers` folds case on lookup**, the way HTTP names headers
+  ([#173](https://github.com/basecradle/basecradle-ruby/issues/173)). BaseCradle stores
+  header names in canonical Title-Case per segment and does not preserve the sender's
+  casing, and the API docs tell consumers to "look them up case-insensitively rather than
+  by a vendor's preferred spelling" — but the plain `Hash` the SDK handed back was
+  case-sensitive, so a caller who wrote the spelling a vendor publishes (GitHub's
+  `X-GitHub-Delivery`) or the lowercase form an HTTP/2 sender emits read a silent `nil`.
+  `headers["X-GitHub-Delivery"]`, `headers["X-Github-Delivery"]` and
+  `headers["x-github-delivery"]` now all read the header that arrived, and so does every
+  other read that takes a header name — `fetch`, `dig`, `values_at`, `fetch_values` and
+  `key?` (with `has_key?`, `include?` and `member?`). Only *lookup* folds: the value is
+  still a `Hash` of exactly what the wire carried, so `each`, `keys`, `to_h` and `to_json`
+  read the platform's own canonical spelling, nothing is renamed, and the methods that
+  reshape it (`slice`, `except`, `select`) work on those stored names.
+  Matches the Python SDK's
+  [#209](https://github.com/basecradle/basecradle-python/pull/209), decided in lockstep.
+- **A header that was not delivered is absent, never `nil`** — `headers[name]` and a
+  fallback-less `headers.fetch(name)` raise `KeyError` naming the headers that did
+  arrive, where before a `nil` could equally have meant "you spelled it wrong".
+  `headers.fetch(name, default)` (or a block, which is handed the name as written) and
+  `headers.dig(name)` answer for an absent header the way `Hash` does, and a name that is
+  not a `String` is not a header name, so it is never matched. A missing *field* is still
+  `BaseCradle::MissingFieldError`; a missing *header* is a `KeyError`.
+- **Documented the two paths that do not fold**: `event.content["headers"]`, `ApiObject`'s
+  raw-wire escape hatch, and a `webhook_event` row of `timeline.items`, whose content is a
+  union of four record types (so it is not a `WebhookEventContent`) — both hand back the
+  plain wire `Hash`. `bc.webhook_events` and `timeline.webhook_events` give the
+  case-folding headers.
+
 ## [0.7.0] - 2026-09-23
 
 ### Changed
@@ -261,6 +294,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.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
 [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

data/README.md

@@ -150,6 +150,8 @@ endpoint.rotate   # leaked URL? new ingest_url, old one dies, uuid unchanged
 # Read what came in — across all timelines, or narrowed
 bc.webhook_events.filter(endpoint: endpoint).each do |event|
   puts [event.content.content_type, event.content.payload].inspect
+  puts event.content.headers["X-Example-Event"]       # the request headers, as delivered
+  puts event.content.headers["x-example-event"]       # ...found under any casing, as HTTP means it
   puts event.content.verified_at_receipt              # was this delivery's signature verified?
   puts event.webhook_endpoint.content.ingest_url      # the endpoint's URL *now*
 end
@@ -167,6 +169,30 @@ Each event embeds its endpoint **in full**, so `event.webhook_endpoint` is a liv
 `content.verified_at_receipt` (whether its signature was verified). Everything inside the
 embedded endpoint is current.
 
+`content.headers` is the delivery's request headers — one pair per header **as sent**,
+`Content-Type` and `Content-Length` included — and `content.payload` is the raw request
+body. BaseCradle stores header names in canonical **Title-Case per segment** and does
+*not* preserve the sender's casing, so the spelling a vendor publishes is often not the
+spelling on the wire: `X-Github-Delivery` is stored where GitHub documents
+`X-GitHub-Delivery`. So **lookup folds case**, the way HTTP names headers —
+`headers["X-GitHub-Delivery"]`, `headers["X-Github-Delivery"]` and
+`headers["x-github-delivery"]` all read the header that arrived, and you never have to
+guess a casing. Every read that takes a header name folds with it — `fetch`, `dig`,
+`values_at`, `fetch_values` and `key?` (with `has_key?`, `include?` and `member?`). A
+header that was **not** delivered is *absent*, never `nil`: `headers[name]` and a
+fallback-less `fetch` raise `KeyError` naming the headers that did arrive, while
+`headers.fetch(name, default)`, `headers.dig(name)` and `values_at` answer for it the way
+`Hash` does. It is otherwise a plain Ruby `Hash` of exactly what the wire carried —
+`each`, `keys`, `to_h` and `to_json` read the platform's own spelling, nothing is renamed,
+and the methods that reshape it (`slice`, `except`, `select`) work on those stored names,
+case-sensitively.
+
+Two paths hand back the raw wire hash instead, case-sensitive as a plain `Hash` is:
+`event.content["headers"]` — `ApiObject`'s raw-wire escape hatch, which wraps nothing —
+and a `webhook_event` row of `timeline.items`, whose content is a union of four record
+types, so `item.content["headers"]` is the `Hash` the API returned. `bc.webhook_events`
+and `timeline.webhook_events` give the case-folding one.
+
 ## Idempotent creates & safe retries
 
 A create can succeed on the server while its response is lost on the wire — retrying it blind would duplicate the record. Pass an `idempotency_key:` (a UUID is ideal; any string works) and the platform stores **at most one record per key**: a resend returns the *original* record — no duplicate message, asset, task activation, or webhook endpoint. All four create methods accept it.

data/lib/basecradle/version.rb

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

data/lib/basecradle/webhooks.rb

@@ -72,13 +72,139 @@ module BaseCradle
     end
   end
 
+  # One delivery's request headers: the wire's own spelling, looked up case-insensitively.
+  #
+  # A +Hash+ of exactly what the wire carried — one pair per header, +Content-Type+ and
+  # +Content-Length+ included — so iterating, +keys+, +to_h+, +to_json+ and +==+ all read
+  # the platform's own spelling and nothing is renamed. Only *lookup* folds case, because
+  # header names are case-insensitive by RFC and the platform does not preserve the
+  # sender's casing: it stores names canonicalized to Title-Case per segment
+  # (+X-Github-Delivery+, not +X-GitHub-Delivery+). So a vendor's published spelling finds
+  # the header it names, and so does any other casing of it:
+  #
+  #   event.content.headers["X-GitHub-Delivery"] # GitHub's own published spelling
+  #   event.content.headers["x-github-delivery"] # the lowercase form
+  #   event.content.headers["X-Github-Delivery"] # what the wire actually carried
+  #
+  # Every read that takes a header name folds: +fetch+, +dig+, +values_at+, +fetch_values+,
+  # +to_proc+ and +key?+ (with +has_key?+, +include?+ and +member?+). A header that was
+  # genuinely not delivered is *absent*, never +nil+ — +[]+ and a fallback-less +fetch+ or
+  # +fetch_values+ raise +KeyError+ naming the headers that did arrive, while +fetch+ with
+  # a fallback, +dig+ and +values_at+ answer for it the way +Hash+ does.
+  #
+  # The methods that *reshape* the hash rather than read one name — +slice+, +except+,
+  # +select+, +transform_values+ — and the mutators are left exactly as +Hash+ defines
+  # them: case-sensitive, on the platform's own spelling. This is a read of one delivery
+  # that already happened. Converting away from this type gives up the folding too
+  # (+to_h+, <tt>{**headers}</tt>, and anything else that hands back a plain +Hash+);
+  # +merge+ and +dup+ keep it.
+  class WebhookEventHeaders < Hash
+    # Hash's own exact-match membership, kept under a private name before the case-folding
+    # +key?+ below takes the name: a caller who wrote the wire's own spelling is answered
+    # without a scan, and it is the tiebreak if a derived copy holds two casings of one
+    # name.
+    alias_method :exact_key?, :key?
+    private :exact_key?
+
+    NO_FALLBACK = Object.new.freeze
+    private_constant :NO_FALLBACK
+
+    # +client:+ is unused — headers carry no verbs — but every wrapped model is built with
+    # it (see ApiObject.attribute's +wrap:+), so it is accepted.
+    def initialize(data, client: nil)
+      super()
+      update(data)
+    end
+
+    # The header's value, matched case-insensitively. Raises +KeyError+ when no casing of
+    # the name was delivered.
+    def [](name)
+      wire = wire_name(name)
+      wire.nil? ? raise_missing(name) : super(wire)
+    end
+
+    # Hash-like: the value, or the fallback — a default argument, or a block, which is
+    # handed the name as written — when the header was not delivered. With no fallback it
+    # behaves like +[]+.
+    def fetch(name, fallback = NO_FALLBACK, &block)
+      wire = wire_name(name)
+      return super(wire) if wire
+      return yield(name) if block
+      return fallback unless fallback.equal?(NO_FALLBACK)
+
+      raise_missing(name)
+    end
+
+    # Did this delivery carry the header, under any casing?
+    def key?(name)
+      !wire_name(name).nil?
+    end
+    alias_method :has_key?, :key?
+    alias_method :include?, :key?
+    alias_method :member?, :key?
+
+    # Ruby's nil-returning read, case folded: the value, or +nil+ for a header that was
+    # not delivered.
+    def dig(name, *rest)
+      wire = wire_name(name)
+      wire.nil? ? nil : super(wire, *rest)
+    end
+
+    # Several headers at once, folded the same way — +nil+ for one that was not delivered,
+    # as +Hash+ answers for a key it has no value for.
+    def values_at(*names)
+      names.map { |name| dig(name) }
+    end
+
+    # As +values_at+, but a header that was not delivered raises, exactly as +fetch+ does.
+    def fetch_values(*names, &block)
+      names.map { |name| block ? fetch(name, &block) : fetch(name) }
+    end
+
+    # +&headers+ — a header name to its value, folded, +nil+ for one not delivered.
+    def to_proc
+      ->(name) { dig(name) }
+    end
+
+    private
+
+    # The wire's own spelling of +name+, or nil if no casing of it was delivered. Anything
+    # but a String is not a header name, so it is never matched rather than being coerced
+    # into one: +headers[:host]+ finds nothing, and so misses like any other absent name.
+    # Keys are type-checked too — +merge+ hands back one of these, so a caller's derived
+    # copy can hold a key that never came off the wire.
+    def wire_name(name)
+      return nil unless name.is_a?(String)
+      return name if exact_key?(name)
+
+      each_key { |wire| return wire if wire.is_a?(String) && wire.casecmp?(name) }
+      nil
+    end
+
+    def raise_missing(name)
+      raise KeyError.new(
+        "No #{name.inspect} header on this delivery. Header names are matched " \
+        "case-insensitively, so no casing of it was delivered either. " \
+        "Headers present: #{keys.sort_by(&:to_s).inspect}",
+        receiver: self, key: name
+      )
+    end
+  end
+
   # One inbound delivery: what was sent, and the two facts about the endpoint as it was at
   # the moment of receipt. Everything in the event's embedded endpoint is *current*; these
   # two are historical, and they are the only ones.
+  #
+  # +headers+ is the delivery's request headers as a +WebhookEventHeaders+ — the wire's
+  # own pairs, looked up case-insensitively. Reached instead through a +webhook_event+ row
+  # of +timeline.items+, +content+ is the generic wire-exact Hash — a timeline item's
+  # content is a union of four record types, so it is not a +WebhookEventContent+ — and
+  # +item.content["headers"]+ is the plain Hash the API returned. +bc.webhook_events+ and
+  # +timeline.webhook_events+ give the case-folding one.
   class WebhookEventContent < ApiObject
     attribute :uuid
     attribute :content_type
-    attribute :headers
+    attribute :headers, wrap: WebhookEventHeaders
     attribute :payload # the raw request body, exactly as delivered
     # The ingest token this delivery arrived on. Because the token rotates, comparing it
     # to the end of the embedded endpoint's current +ingest_url+ tells you whether the

metadata

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