keycloak-sdk 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c092fe05aa83b05dbdeff11100f82093a4e757085d503c9e7f0bf2c25686823
-  data.tar.gz: ca6060f7b57451442cb91d57df7d2d711d7ce5568dd8e60dcd2a120aa9df9a64
+  metadata.gz: 39cf848bf3f01443707855e1a981e8bcaf4fdbb3a5ac9fbf17a7b6ac010e33f4
+  data.tar.gz: 489cfcf03654e7da757bfcd6020cf148d3fb9550c89ea9f14c09569977aa47b8
 SHA512:
-  metadata.gz: f0acfdff469b5e3b7962e93219394ec0cf982e0bfa9cd779f5cf57696c832bd36102904338fb8e94aa19e54e8aed5f1a5a975bfeadd8c54742c97fecbbb3756a
-  data.tar.gz: 61043f7b7e7912fb3c3fbb5d29a006483dbc16e768f0b1678e60ccfb1725901573bd4538762ea57dda26a8beca1f0a03d7ca94d996e1c656ef676692da68f09a
+  metadata.gz: a2c51c7d06751f6ae0c6ed76d83083400f679354a011d1dbc720c93fd374cf1047092c4dc8214931ea8f25fd2a6099e5103577c35aee998194e0c56b7645c9fb
+  data.tar.gz: 3d112a01d129df0a1bbebb7ef3b0ba75b4947fd5bb1014a7471beef728f2d22be9020d264f98660d887f1820e58e6014caa4bf12cd0dc8787571568b4c320a56

data/README.md

@@ -4,7 +4,7 @@ Authentication (OIDC / OAuth2) and the Admin REST API for [Keycloak](https://www
 
 Part of a **nine-language polyglot SDK** (Java · Python · Node · Go · C# · PHP · Rust · Ruby · Kotlin) — one API surface, isomorphic across all of them: [github.com/xzawed/KeyCloakSDK](https://github.com/xzawed/KeyCloakSDK).
 
-> **Pre-release** — the first release candidate (`0.1.0.rc1`) is on RubyGems; there is no stable release yet. ⚠️ **RubyGems does not install a pre-release by default**: a bare `gem install keycloak-sdk` finds nothing until a stable version exists. Ask for it explicitly — `gem install keycloak-sdk --pre`, or pin the exact version as shown below.
+> **`1.0.0` is on RubyGems** — the first release carrying the stability guarantee. A bare `gem install keycloak-sdk` resolves it.
 
 ## Requirements
 
@@ -14,16 +14,16 @@ Part of a **nine-language polyglot SDK** (Java · Python · Node · Go · C# ·
 ## Install
 
 ```bash
-gem install keycloak-sdk -v 0.1.0.rc1
+gem install keycloak-sdk
 ```
 
 Or in a `Gemfile`:
 
 ```ruby
-gem "keycloak-sdk", "0.1.0.rc1"
+gem "keycloak-sdk", "~> 1.0"
 ```
 
-While `0.1.0.rc1` is the only release, the version must be explicit — `gem install keycloak-sdk` and a bare `gem "keycloak-sdk"` both skip pre-releases and resolve nothing. Drop the pin once a stable release exists.
+`~> 1.0` accepts every `1.x` release and stops before `2.0` — the boundary a breaking change has to cross under the promise below.
 
 > **Name mismatch, on purpose:** the gem is `keycloak-sdk` (hyphen) but the require path and module are `keycloak_sdk` / `KeycloakSdk` (underscore) — this avoids colliding with the existing `keycloak` gem's `Keycloak` module.
 
@@ -73,11 +73,18 @@ Masking covers this SDK's own `#inspect`; it cannot cover what your logging fram
 
 ## Versioning and support
 
-This SDK is **pre-1.0**. Under SemVer a `0.x` **minor** bump may carry breaking changes, so read the release notes before upgrading. Only the newest released version of each language SDK receives security fixes — there are no LTS lines, and older `0.x` releases are not backported to. Full policy: [SECURITY.md](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md).
+This SDK is **`1.0`** and follows SemVer: a breaking change to the public API requires a **major** bump. That promise is machine-backed — CI diffs this lane's public API against the **previously published artifact** on every build (`yard diff`), and a removal or an incompatible change fails the build. ⚠️ **This lane’s gate is narrower than its siblings’**: Ruby has no equivalent of `japicmp`/`gorelease`, so the gate catches a **removed** public object but not a changed method signature — that case is caught by review, not by machine. ⚠️ **The gate compares the API _surface_.** A change that leaves the surface identical but alters behaviour is not caught by it, so read the release notes before upgrading.
+
+Only the newest released version of each language SDK receives security fixes; there are no long-term-support lines and older releases are not backported to.
+
+**Each of the nine languages versions independently.** All nine reached `1.0.0` on the same day because they earned the same guarantee at the same time — they do **not** move in lockstep afterwards.
 
 ## Documentation
 
-- [Getting started](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/getting-started.md#ruby) — install, quickstart, and the compatibility matrix
+- [Project overview](https://github.com/xzawed/KeyCloakSDK) — all nine languages, what is identical and what is not
+- [Changelog](https://github.com/xzawed/KeyCloakSDK/blob/main/CHANGELOG.md) — **read this before upgrading**; breaking changes are listed per language
+- [Getting started](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/getting-started.md#ruby) — install and quickstart for this language
+- [Compatibility](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/reference/compatibility.md) — which Keycloak server range and base libraries each published version shipped against
 - [Deploying a Keycloak server](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/deploying-keycloak-server.md) — the server this SDK talks to
 - [Security policy](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md)
 - Full example: [`examples/quickstart.rb`](https://github.com/xzawed/KeyCloakSDK/blob/main/ruby/examples/quickstart.rb)

data/lib/keycloak_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KeycloakSdk
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - xzawed