From 382c00b07c1af80155bff10fa1f7be443bf2ad08 Mon Sep 17 00:00:00 2001 From: Roshan Jonnalagadda <20136098+roshanjonah@users.noreply.github.com> Date: Fri, 20 Nov 2026 10:41:50 +1100 Subject: [PATCH] docs: consume published Qubrics Ruby surface gems --- developer-tools/sdks/index.mdx | 2 +- developer-tools/sdks/ruby.mdx | 38 +++++++++---------- developer-tools/sdks/versioning-support.mdx | 2 + ...rand-qubrics-docs75-ruby-facts-20261120.md | 17 +++++++++ 4 files changed, 39 insertions(+), 20 deletions(-) create mode 100644 evidence/rebrand-qubrics-docs75-ruby-facts-20261120.md diff --git a/developer-tools/sdks/index.mdx b/developer-tools/sdks/index.mdx index 7a3da0f..4969016 100644 --- a/developer-tools/sdks/index.mdx +++ b/developer-tools/sdks/index.mdx @@ -52,7 +52,7 @@ TypeScript, Python, Go, PHP, Ruby, and Rust clients also accept [REST OAuth toke | Python | See the language guide | `qubrics-sending`, `qubrics-mailbox`, `qubrics-management` | | Go | `sendmux.ai/go/v3` | `sending`, `mailbox`, `management`, and `sdk` subpackages | | PHP | `qubrics/sdk` | `qubrics/sending`, `qubrics/mailbox`, `qubrics/management` | -| Ruby | See the language guide | `sendmux-sending`, `sendmux-mailbox`, `qubrics-management` | +| Ruby | See the language guide | `qubrics-sending`, `qubrics-mailbox`, `qubrics-management` | | Rust | `sendmux` | `sending`, `mailbox`, and `management` modules inside the `sendmux` crate | The Python and Ruby guides list the published surface versions and their matching imports. Check [package names and imports](/developer-tools/sdks/versioning-support#package-names-and-imports) before upgrading an existing installation. diff --git a/developer-tools/sdks/ruby.mdx b/developer-tools/sdks/ruby.mdx index ac513a3..04f4530 100644 --- a/developer-tools/sdks/ruby.mdx +++ b/developer-tools/sdks/ruby.mdx @@ -5,8 +5,8 @@ keywords: [ "Ruby SDK", "qubrics-core", - "sendmux-sending", - "sendmux-mailbox", + "qubrics-sending", + "qubrics-mailbox", "qubrics-management", "Qubrics SDKs", ] @@ -27,16 +27,16 @@ Use the Ruby SDK when your application needs gems for the Sending, Mailbox, or M ## Install -Install the gem for each API surface your application uses. These examples use `qubrics-management` 3.0.0, `sendmux-sending` 1.5.0 and `sendmux-mailbox` 2.0.2. +Install a gem for each surface you use. These examples use `qubrics-sending` 2.0.0, `qubrics-mailbox` 3.0.0 and `qubrics-management` 3.0.0. ```bash Sending -gem install sendmux-sending --version 1.5.0 +gem install qubrics-sending --version 2.0.0 ``` ```bash Mailbox -gem install sendmux-mailbox --version 2.0.2 +gem install qubrics-mailbox --version 3.0.0 ``` ```bash Management @@ -45,7 +45,7 @@ gem install qubrics-management --version 3.0.0 -Management uses the `Qubrics` namespace. The Sending and Mailbox versions above use `Sendmux`. Keep the gem version and namespace together. See [package names and imports](/developer-tools/sdks/versioning-support#package-names-and-imports) before changing an existing installation. +Use the `Qubrics` namespace with these gem versions, and check [package names and imports](/developer-tools/sdks/versioning-support#package-names-and-imports) before changing an existing installation so your gem version and namespace stay together. ## OAuth access tokens @@ -68,17 +68,17 @@ Require the surface gem you installed, then create its client. ```ruby Sending -require 'sendmux/sending' +require 'qubrics/sending' -client = Sendmux::Sending::Client.new( +client = Qubrics::Sending::Client.new( api_key: ENV.fetch('QUBRICS_MAILBOX_API_KEY') ) ``` ```ruby Mailbox -require 'sendmux/mailbox' +require 'qubrics/mailbox' -client = Sendmux::Mailbox::Client.new( +client = Qubrics::Mailbox::Client.new( api_key: ENV.fetch('QUBRICS_MAILBOX_API_KEY') ) ``` @@ -93,14 +93,14 @@ client = Qubrics::Management::Client.new( -Surface gems expose `Sendmux::Sending::Client`, `Sendmux::Mailbox::Client`, and `Qubrics::Management::Client` directly. +Surface gems expose `Qubrics::Sending::Client`, `Qubrics::Mailbox::Client`, and `Qubrics::Management::Client` directly. ## Choose a surface | Surface | Gem | Client or helper | API key | | --- | --- | --- | --- | -| Sending | `sendmux-sending` | `Sendmux::Sending::Client`, `client.emails` | `smx_mbx_` or owner-approved `smx_agent_` with `email.send` | -| Mailbox | `sendmux-mailbox` | `Sendmux::Mailbox::Client`, `client.mailbox_api` | `smx_mbx_` or scoped `smx_agent_` | +| Sending | `qubrics-sending` | `Qubrics::Sending::Client`, `client.emails` | `smx_mbx_` or owner-approved `smx_agent_` with `email.send` | +| Mailbox | `qubrics-mailbox` | `Qubrics::Mailbox::Client`, `client.mailbox_api` | `smx_mbx_` or scoped `smx_agent_` | | Management | `qubrics-management` | `Qubrics::Management::Client`, `client.mailboxes` | `smx_root_` | @@ -109,13 +109,13 @@ Surface gems expose `Sendmux::Sending::Client`, `Sendmux::Mailbox::Client`, and exchange the durable token for a one-hour Sending-resource token before sending. -Management 3.0.0 uses `https://app.qubrics.com/api/v1` by default. The Sending and Mailbox versions above default to `https://smtp.sendmux.ai/api/v1` and `https://app.sendmux.ai/api/v1`, respectively. +Sending 2.0.0 defaults to `https://smtp.qubrics.com/api/v1`. Mailbox 3.0.0 and Management 3.0.0 default to `https://app.qubrics.com/api/v1`. ## Shared API behaviour Surface clients validate API key prefixes, configure bearer auth, and map generated API errors. -The helper examples below use `qubrics-core` 2.0.0, installed with Management 3.0.0. The Sending and Mailbox versions above use `Sendmux::Core` helpers. +The helper examples below use `qubrics-core` 2.0.0, installed with these surface gems. ### Pagination @@ -123,9 +123,9 @@ List responses use cursor pagination with `pagination.has_more` and `pagination. ### Retries and rate limits -Management clients call `Qubrics::Core::Retry.configure()` by default. Retries apply to safe methods and retry-safe `POST` requests that include `Idempotency-Key`, then honour `Retry-After` and `X-RateLimit-Reset` response headers. +Surface clients call `Qubrics::Core::Retry.configure()` by default. Retries apply to safe methods and retry-safe `POST` requests that include `Idempotency-Key`, then honour `Retry-After` and `X-RateLimit-Reset` response headers. -Pass `Qubrics::Core::RetryOptions` into a Management client to change attempts, delays, or jitter. +Pass `Qubrics::Core::RetryOptions` into a surface client to change attempts, delays, or jitter. ### Idempotency and ETags @@ -140,7 +140,7 @@ Use `Idempotency-Key` for retry-safe mutating requests. Use `If-Match` and `If-N ### Errors -Management API errors are mapped to `Qubrics::Core::ApiError`. The Sending and Mailbox versions above use `Sendmux::Core::ApiError`. The error includes status, code, retryability, request ID, param, nested errors, response body, and response headers when available. +API errors are mapped to `Qubrics::Core::ApiError`. The error includes status, code, retryability, request ID, param, nested errors, response body, and response headers when available. Use the request ID when contacting support. @@ -154,7 +154,7 @@ Use the request ID when contacting support. Check compatibility, support, and upgrade guidance. - Review the Sending API contract used by `sendmux-sending`. + Review the Sending API contract used by `qubrics-sending`. Create and scope the credentials used by SDK clients. diff --git a/developer-tools/sdks/versioning-support.mdx b/developer-tools/sdks/versioning-support.mdx index 5c6a0a6..2ba1ad4 100644 --- a/developer-tools/sdks/versioning-support.mdx +++ b/developer-tools/sdks/versioning-support.mdx @@ -38,6 +38,8 @@ Keep the package version and import path together. Installing an old-name distri | PyPI | `sendmux-management` | `3.0.0` | `qubrics.management` | | RubyGems | `qubrics-core` | `2.0.0` | `qubrics/core` | | RubyGems | `sendmux-core` | `2.0.0` | `qubrics/core` | +| RubyGems | `qubrics-sending` | `2.0.0` | `qubrics/sending` | +| RubyGems | `qubrics-mailbox` | `3.0.0` | `qubrics/mailbox` | | RubyGems | `qubrics-management` | `3.0.0` | `qubrics/management` | Use the language guides for client examples. Each release covers one package. Check the version and namespace for every language, umbrella package or related developer tool you use. diff --git a/evidence/rebrand-qubrics-docs75-ruby-facts-20261120.md b/evidence/rebrand-qubrics-docs75-ruby-facts-20261120.md new file mode 100644 index 0000000..9f47946 --- /dev/null +++ b/evidence/rebrand-qubrics-docs75-ruby-facts-20261120.md @@ -0,0 +1,17 @@ +# Public Ruby Sending and Mailbox facts + +Docs75 consumes two qualified public RubyGems releases: `qubrics-sending` 2.0.0, require `qubrics/sending`, client `Qubrics::Sending::Client`, default `https://smtp.qubrics.com/api/v1`; `qubrics-mailbox` 3.0.0, require `qubrics/mailbox`, client `Qubrics::Mailbox::Client`, default `https://app.qubrics.com/api/v1`. + +Owning receipts: SDK MAIN `.claude/tasks/rebrand-qubrics-sdk344/docs75-ruby-public-facts-20261119.md`, `ruby-sending-public-20261119.md` and `ruby-mailbox-public-20261119.md`. They prove public archive equality, isolated installs/imports/dependency resolution, defaults and calendar absence. Fresh official version metadata on 20 November confirms both unyanked and the same hashes: Sending `8dd5350aebf55dd588cc2c350dc906c3bb635f608b20dc7f71f0774455bee462`; Mailbox `7577dd99a64aebaac44c517943ca84bc8fd1058ca8b03ff5e9cd692d6226d602`. Raw JSON: docs MAIN `.claude/artifacts/rebrand-qubrics-docs75/ruby-{sending,mailbox}-metadata-20261120.json`. + +Read the retained public archives' `lib/qubrics/{sending,mailbox}/client.rb`: both use the Qubrics namespace, call `Qubrics::Core::Retry.configure`, map generated errors with `Qubrics::Core::ErrorMapper`, and expose the same `emails` / `mailbox_api` helpers documented here. Compatibility upload-token headers, `smx_` credential prefixes and environment aliases remain unchanged. This docs slice changes no producer code or contracts. + +Updated three existing pages: Ruby guide, SDK overview Ruby row, and version/support table. No umbrella gem release, old-name Sending/Mailbox pointer, MCP, calendar or unrelated language claim added. Existing qualified Core/Management facts retained. No rename announcement outside the already-published changelog. + +Placement: Developer tools → SDKs → existing Ruby / overview / versioning pages. Disposition keep. Existing navigation/group ordering and links unchanged. Fresh-reader polish critique passes all applicable rubric lines for all three changed pieces; one humanize pass follows. Protected-set comparison confirms identical auth/method tokens, headings and Markdown link destinations. The only keyword substitutions are the authorised two gem names. No new test or executable logic: existing native gates cover these static docs. + +Local checks: confidentiality, external-link safety, `mint validate`, `mint broken-links` and `git diff --check` pass. Logs `ruby-*-20261120.log` in the docs MAIN artifact directory. Local preview returns HTTP200 for all three pages; browser Sending/Mailbox tabs display exact install, require and client examples; version table rows match the public versions, and SDK overview uses the two Qubrics gems. `ruby-browser-preview-20261120.json`, `ruby-version-table-preview-20261120.json`, and saved preview HTML/headers carry proof. The initial Sending proof lost apostrophes through shell quoting; reading the rendered code directly with explicit quote handling proves exact text, with no source correction required. Local Socket.io connection messages only. + +Status: branch candidate, not published. Repository CI and independent spec/standards review follow. Publication needs its own Ops ASK. Rollback: revert the eventual merge with mainline parent 1 and let native docs publication restore the previous pages; pre-slice source anchor `4ffdf27f`, successful native deployment `7928578795`. Re-read the live anchor before the publish ASK. After approval require native publication success, changed-page HTTP200 and exact rendered tokens, canonical origin/public exports, and retained redirects. No DNS/domain/Worker/routing writes, Re-verify or vendor send. + +Whole docs75/901 remain open for the remaining qualified SDK344 package/CLI/MCP facts. PR78 was already narrowed to changelog and merged/published as `ab2a2465`; no open overlapping PR78 work remains. Favicon PR90 `4ffdf27f` is shipped with OpsA acceptance of native transformations, source `d3e2e8c1…cec21a` and public SVG `103e0953…2d0f`; header/share images unchanged.