convert_sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16cc235aa36baea77098bf6d47a5d479e840ca95a416b36b87f8f178b95895c1
-  data.tar.gz: 1354d6d78384ebea2f6b187ae601da34e7090de152fc6ca4fa95480e406c04a0
+  metadata.gz: aab5bea865be444282ecd0fdcea5b30b5928204e4fecee1bb8b455c3ad54c550
+  data.tar.gz: 2753c4042b733710dde55260479205dcc81bcc637c3d5c473b4c3a2671f6f05e
 SHA512:
-  metadata.gz: 5fc43abd0fbf174055ef97a00c3c983f232287f886151990931f2635a733fcd0a626e1b35a7f7ef564b2953bcc3cee32b6fe7cb96a9e9ba7dce40b5dfc2e7ae7
-  data.tar.gz: 74e704ae66077b55a6e92a008a44933190208f8b3caaacefbea041801b4e9bfe8e8498f082205bfa71b4901834ed9cca2ce5d3e80b5e317848e4fc4a2b925e6e
+  metadata.gz: 8be2456929af9052ff3522b4004320056d526e6f5ea768ba1cb2f9c47116f80cffe79b8123a141db54d7afb2d70553393ee03ad6fa1d7abb0b9e11baaae39268
+  data.tar.gz: a1273013c76b64bb5598767cf9a3d87273f7fda3a4a8a65f2803473bdd123222b8b0dbe67437547dc8d6d0a28b850387e9be01a887b0d51b0e27a0489147c5d3

data/README.md

@@ -1,7 +1,7 @@
 # Convert Ruby SDK
 
 [![Quality Checks](https://github.com/convertcom/ruby-sdk/actions/workflows/qa.yml/badge.svg)](https://github.com/convertcom/ruby-sdk/actions/workflows/qa.yml)
-[![Gem Version](https://badge.fury.io/rb/convert_sdk.svg)](https://rubygems.org/gems/convert_sdk)
+[![Gem Version](https://img.shields.io/gem/v/convert_sdk.svg)](https://rubygems.org/gems/convert_sdk)
 [![API docs](https://img.shields.io/badge/API_docs-YARD-blue)](https://convertcom.github.io/ruby-sdk)
 
 The official Convert Experiences FullStack Ruby SDK — server-side A/B testing,

data/lib/convert_sdk/data_manager.rb

@@ -18,19 +18,21 @@ module ConvertSdk
   #
   # == No raw config hash crosses the boundary
   #
-  # The parsed config envelope is wrapped here and exposed ONLY through
-  # hand-written reader methods (+#experiences+, +#feature_by_key(key)+, …) that
-  # return frozen sub-hashes / arrays. There is no public accessor for the raw
-  # snapshot and no OpenAPI codegen — the reader inventory is derived by hand
-  # from the actual config wire shape (the vendored +test-config.json+ fixture).
+  # The parsed config snapshot is exposed ONLY through hand-written reader methods
+  # (+#experiences+, +#feature_by_key(key)+, …) that return frozen sub-hashes /
+  # arrays. There is no public accessor for the raw snapshot and no OpenAPI codegen
+  # — the reader inventory is derived by hand from the actual config wire shape
+  # (the vendored +test-config.json+ fixture).
   #
-  # == Wire shape
+  # == Wire shape (flat/root — JS/PHP/Android parity)
   #
-  # The config envelope is +{"environment" => ..., "data" => {...}}+; the entity
-  # collections (+experiences+, +features+, +goals+, +audiences+, +segments+,
-  # optional +locations+) plus +account_id+ and the +project+ sub-hash live under
-  # +"data"+. +#project_id+ is +data.project.id+. Readers tolerate sparse or
-  # absent keys (return +nil+ / +[]+) so a partial config never crashes a reader.
+  # Entities live at the ROOT of the config snapshot: +account_id+, +project+,
+  # +experiences+, +features+, +goals+, +audiences+, +segments+,
+  # +archived_experiences+, and optional +locations+. +#project_id+ is
+  # +root["project"]["id"]+. This matches the live endpoint shape (no +"data"+
+  # wrapper), the JS SDK, the PHP SDK, and the Android OpenAPI-generated schema.
+  # Readers tolerate sparse or absent keys (return +nil+ / +[]+) so a partial
+  # config never crashes a reader.
   #
   # == Degrade-gracefully (NFR12)
   #
@@ -138,8 +140,8 @@ module ConvertSdk
     # marker, so exactly one install in the manager's lifetime is +:first+ even
     # under concurrent installs.
     #
-    # @param hash [Hash{String=>Object}] the parsed config envelope
-    #   (+{"environment" => ..., "data" => {...}}+).
+    # @param hash [Hash{String=>Object}] the parsed flat config snapshot
+    #   (entities at the root — +account_id+, +project+, +experiences+, etc.).
     # @return [Symbol, false] +:first+ on the first successful install,
     #   +:updated+ on any subsequent install, or +false+ when the argument was
     #   rejected (non-Hash) and no swap happened.
@@ -223,22 +225,31 @@ module ConvertSdk
       (@clock.call - fetched_at) > effective_ttl
     end
 
-    # @return [Boolean] true once a config snapshot has been installed.
+    # @return [Boolean] true once a USABLE config (account_id + project.id both
+    #   present) is installed. Mirrors JS SDK's +isValidConfigData+ check
+    #   (+account_id && project.id+). A snapshot that carries a +project+ key but
+    #   no id (e.g. +project: {}+) or a malformed +project+ value is NOT considered
+    #   available — avoids silently serving nil reads to decision paths.
     def config_available?
-      !@config.nil?
+      !account_id.nil? && !project_id.nil?
     end
 
-    # @return [String, nil] the account id (+data.account_id+), or nil pre-config.
+    # @return [String, nil] the account id (+account_id+ at the config root), or nil pre-config.
     def account_id
       data&.fetch("account_id", nil)
     end
 
-    # @return [String, nil] the project id (+data.project.id+), or nil pre-config.
+    # @return [String, nil] the project id (+project.id+ at the config root), or nil pre-config.
+    #   Type-safe against a non-Hash +project+ value (e.g. a String in a malformed
+    #   direct-data config): +&.+ guards nil only; a non-nil non-Hash would raise
+    #   NoMethodError on +#fetch+. Mirrors JS optional-chaining safety
+    #   (+data?.project?.id+).
     def project_id
-      project&.fetch("id", nil)
+      p = project
+      p.is_a?(Hash) ? p.fetch("id", nil) : nil
     end
 
-    # @return [Hash, nil] the frozen +data.project+ sub-hash, or nil pre-config.
+    # @return [Hash, nil] the frozen +project+ sub-hash at the config root, or nil pre-config.
     def project
       data&.fetch("project", nil)
     end
@@ -856,13 +867,14 @@ module ConvertSdk
       @ttl || ConvertSdk::DEFAULT_CONFIG_TTL
     end
 
-    # The frozen +"data"+ sub-hash of the live snapshot, or nil pre-config.
-    # Read lock-free: @config is either nil or a fully-frozen graph.
+    # The live snapshot root (entities live at the root — JS/PHP/Android parity),
+    # or nil pre-config. Read lock-free: @config is either nil or a fully-frozen
+    # graph.
     def data
-      @config&.fetch("data", nil)
+      @config
     end
 
-    # Fetch a frozen collection under +"data"+, defaulting to a frozen empty
+    # Fetch a frozen collection at the config root, defaulting to a frozen empty
     # array when the snapshot or the key is absent.
     def collection(name)
       found = data&.fetch(name, nil)

data/lib/convert_sdk/version.rb

@@ -10,5 +10,5 @@ module ConvertSdk
   # derives its version from this run's git tag, not from this file (FR66).
   # Mirrors the Android SDK's `0.0.0` placeholder in gradle/libs.versions.toml.
   # @return [String]
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: convert_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Convert Insights, Inc.