quicknode_sdk 0.1.0.pre.alpha.26 → 0.1.0.pre.alpha.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0967efbdaee116172b51da65212c55f6a3f03183e11e79a5ca55122f4d7ede9e'
-  data.tar.gz: f070ee769525280a210d050e65d3767765edaef8cb6b20d0ab4b43c8791a6781
+  metadata.gz: 30f2ad12b7b844cdad9a5702defa7ff2aeb42f994422ed5fedc623107bbfed71
+  data.tar.gz: 26958bd53b70e087a5389a1750cf316b36656cf64cbce358771619f22f67be04
 SHA512:
-  metadata.gz: 9bfb50ebea710c550844773bc9efd16c12cefe5f115413482ec3625736f107cdd6fc3a4d630fb1e4af4f16c2ebf7bd9131b3a745cda08fd4e9cfeacab9f5b61c
-  data.tar.gz: 2be501071f49cf7bbb4d02a9b8111731b4e9046a3df98fe0a46ea40417f1d37325c05cdb9cae2dc244f6a5fc657f629b66347f84ecb852f24471a3396ad26c49
+  metadata.gz: 14692c35c4278c46626cf9d1f27cf824566c1c77f8fdc7d450cacdf2041fb8c96dbb2c70e86aa9c4fac0bbd6894da2bd799f6766fb200f99075eb5179ade521e
+  data.tar.gz: 8e72cef358d0da3cd399d5b2c4c06fe620c77d4898f01a49d5cdec421ea66ebc5b6ac1cf5f6957281972b5a1b1a838911cc97596017a0b6f776e805e2e231d25

data/README.md

@@ -9,6 +9,7 @@ This is one of four language bindings published from the same Rust core. See the
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Configuration](#configuration)
+- [Platform Support](#platform-support)
 - [API Reference](#api-reference)
   - [Admin Client](#admin-client)
     - [Endpoints](#endpoints)
@@ -69,6 +70,10 @@ There are two ways to configure the SDK.
 
 ### Option A — Pass config directly
 
+```ruby
+qn = QuicknodeSdk::SDK.from_config(api_key: "your-key")
+```
+
 ### Option B — Load from environment (`from_env()`)
 
 ```ruby
@@ -87,6 +92,44 @@ Environment variables (prefix `QN_SDK__`, separator `__`):
 | `QN_SDK__STREAMS__BASE_URL` | no | `https://api.quicknode.com/streams/rest/v1/` | Override streams base URL |
 | `QN_SDK__WEBHOOKS__BASE_URL` | no | `https://api.quicknode.com/webhooks/rest/v1/` | Override webhooks base URL |
 | `QN_SDK__KVSTORE__BASE_URL` | no | `https://api.quicknode.com/kv/rest/v1/` | Override KV store base URL |
+| `QN_SDK__HTTP__HEADERS__<NAME>` | no | — | Custom HTTP header sent on every request. Overrides SDK-managed headers (see below). |
+
+### Custom headers and `User-Agent`
+
+Every outbound HTTP request includes an auto-generated `User-Agent` of the form:
+
+```
+quicknode-sdk-<language>/<sdk-version> (<os>-<arch>; <language>-<runtime-version>)
+```
+
+You can attach arbitrary headers via `HttpConfig.headers`. **These headers OVERRIDE any SDK-managed header with the same name**, including `User-Agent`, `x-api-key`, `Accept`, and `Content-Type`. Use this to inject correlation IDs, proxy auth, or to replace the default `User-Agent`. Header names are matched case-insensitively.
+
+```ruby
+qn = QuicknodeSdk::SDK.from_config(
+  api_key: "your-key",
+  http: {
+    headers: {
+      "X-Correlation-Id" => "abc-123",
+      "User-Agent" => "my-app/1.0", # overrides SDK default
+    },
+  },
+)
+```
+
+You can also set custom headers via env vars (`QN_SDK__HTTP__HEADERS__<NAME>`) when using `from_env`.
+
+## Platform Support
+
+Precompiled platform gems are published for:
+
+| Platform | Targets |
+|---|---|
+| Linux (glibc) | `x86_64-linux`, `aarch64-linux` — glibc **2.17+** (manylinux2014) |
+| macOS | Apple Silicon (`arm64-darwin`) |
+
+Linux gems are built against glibc 2.17 so they load on any distro from 2014 onward — RHEL 7+, Ubuntu 14.04+, Debian 8+, Amazon Linux 2+, SLES 12+, Fedora 19+.
+
+**Not supported:** Alpine and other musl-libc distros (the Rust cdylib that backs the gem requires the dynamic linker glibc provides), RHEL/CentOS 6 (glibc 2.12), Debian 7 (glibc 2.13), Ubuntu 12.04 (glibc 2.15), Intel macOS, Windows. The `ruby`-platform fallback gem is present only so Bundler's resolver can complete on those platforms — `require "quicknode_sdk"` raises a `LoadError` listing the supported platforms.
 
 ## API Reference
 

data/lib/quicknode_sdk/sdk.rb

@@ -4,6 +4,17 @@ module QuicknodeSdk
       new(Native::SDK.from_env)
     end
 
+    # Build an SDK from an explicit config hash. Supports custom headers,
+    # timeouts, and base URLs without relying on env vars.
+    #
+    #   QuicknodeSdk::SDK.from_config(
+    #     api_key: "...",
+    #     http: { headers: { "X-Correlation-Id" => "abc" } }
+    #   )
+    def self.from_config(opts)
+      new(Native::SDK.from_config(opts))
+    end
+
     def initialize(native)
       @native = native
     end

data/sig/quicknode_sdk.rbs

@@ -27,6 +27,7 @@ module QuicknodeSdk
 
   class SDK
     def self.from_env: () -> SDK
+    def self.from_config: (Hash[Symbol | String, untyped] opts) -> SDK
     def initialize: (untyped native) -> void
     def admin: () -> Admin
     def streams: () -> Streams

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quicknode_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.26
+  version: 0.1.0.pre.alpha.29
 platform: ruby
 authors:
 - Quicknode
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-22 00:00:00.000000000 Z
+date: 2026-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie