convert_sdk 1.0.0

data/steep/config_contract_probe.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# Steep-checked contract probe — SYNTHETIC VALUES ONLY. NOT runtime code.
+#
+# This file lives OUTSIDE lib/ (register #18 / architecture Decision 5) and is
+# never required by the SDK. It exists solely as the build-time drift gate:
+# Steep checks it as part of the :probe target (strict diagnostics), and any
+# field the SDK depends on that has been dropped or renamed in the regenerated
+# RBS will cause Steep to fail on the probe line that includes it.
+#
+# == How the drift gate fires
+#
+# Each call below passes a hash literal containing every field the SDK depends on
+# to a typed helper method (sig/convert_sdk/config/probe_helpers.rbs). With
+# strict diagnostics in the :probe Steepfile target:
+#
+#   1. When a depended field is REMOVED from the regenerated record type, the
+#      hash literal here still includes that key.
+#   2. Steep raises `UnknownRecordKey` (warning) + `ArgumentTypeMismatch` (error)
+#      on the exact literal line — surfacing which field drifted.
+#   3. `steep check` exits non-zero, blocking the backend-opened PR pre-merge.
+#
+# This is the true Ruby analogue of JS's typed consumers: the probe curates the
+# "fields we depend on" surface explicitly. Adding a new reader dependency means
+# adding that field to the literal below.
+#
+# == Additive-safe (AC2)
+#
+# When a NEW field is added to the record, the probe does NOT include it. Steep
+# is silent (no error). The runtime readers use plain-hash `fetch`/`[]` which
+# ignore unknown fields — additive changes never break either gate.
+#
+# == Field coverage rules (D6)
+#
+# Include ONLY fields the SDK reads AND that are declared in the generated RBS.
+# Fields the SDK reads that the spec OMITS (spec-completeness gaps) are COMMENTED
+# with a "D6 spec-gap" note — including them would produce a false positive.
+#
+# Current D6 spec-completeness gaps (backend follow-up required):
+#   - goal fields: is_system, selected_default, status — absent from config_goal
+#     (present in real config; recorded in research:F3/D6)
+
+module ConvertSdk
+  # ── config_response_data (the top-level "data" envelope) ──────────────────
+  probe_response_data_fields(
+    "account_id" => nil,            # => DataManager#account_id reads data["account_id"]
+    "project" => nil,               # => DataManager#project reads data["project"]
+    "experiences" => nil,           # => DataManager#experiences reads data["experiences"]
+    "archived_experiences" => nil,  # => DataManager#archived_experiences (:297) -> archived?
+    "features" => nil,              # => DataManager#features reads data["features"]
+    "goals" => nil,                 # => DataManager#goals reads data["goals"]
+    "audiences" => nil,             # => DataManager#audiences reads data["audiences"]
+    "segments" => nil,              # => DataManager#segments reads data["segments"]
+    "locations" => nil              # => DataManager#locations reads data["locations"]
+  )
+
+  # ── config_project ─────────────────────────────────────────────────────────
+  probe_project_fields(
+    "id" => nil, # => DataManager#project_id reads project["id"]
+    "name" => nil,
+    "type" => nil
+  )
+
+  # ── config_experience ──────────────────────────────────────────────────────
+  probe_experience_fields(
+    "id" => nil,          # => eligible_experience, archived?, build_bucketed_variation
+    "key" => nil,         # => find_by_key, build_bucketed_variation
+    "name" => nil,        # => build_bucketed_variation
+    "type" => nil,        # => present in spec; read via various gates
+    "status" => nil,      # => environment + status gates
+    "environment" => nil, # => environment_match? reads experience["environment"]
+    "locations" => nil,   # => match_locations reads experience["locations"]
+    "site_area" => nil,   # => match_locations reads experience["site_area"]
+    "audiences" => nil,   # => audiences_to_check, custom_segments_matched?
+    "variations" => nil,  # => variation_list reads experience["variations"]
+    "goals" => nil,       # => experience["goals"] consumed by readers
+    "settings" => { "matching_options" => { "audiences" => nil } } # => all_match_required? (:730-731)
+  )
+
+  # ── experience_variation ───────────────────────────────────────────────────
+  probe_variation_fields(
+    "id" => nil,                 # => build_bucketed_variation, retrieve_variation, build_buckets
+    "key" => nil,                # => build_bucketed_variation
+    "name" => nil,               # => build_bucketed_variation
+    "status" => nil,             # => bucketable_variation? reads variation["status"]
+    "traffic_allocation" => nil, # => bucketable_variation?, build_buckets, build_bucketed_variation
+    "changes" => nil             # => build_bucketed_variation reads variation["changes"]
+  )
+
+  # ── config_goal ────────────────────────────────────────────────────────────
+  # D6 spec-gaps: "is_system", "selected_default", "status" omitted (present in
+  # real config per test-config.json; absent from config_goal spec — F3/D6).
+  probe_goal_fields(
+    "id" => nil,   # => DataManager#convert reads goal["id"] for dedup + wire payload
+    "name" => nil,
+    "key" => nil,  # => find_by_key (goal_by_key) matches on goal["key"]
+    "type" => nil, # => goal_type discriminator union (all 10 values — AC4)
+    "rules" => nil # => rule walks reference goal["rules"]
+  )
+
+  # ── config_audience ────────────────────────────────────────────────────────
+  probe_audience_fields(
+    "id" => nil,   # => items_by_ids matching
+    "key" => nil,  # => find_by_key
+    "name" => nil,
+    "type" => nil, # => audiences_to_check reads audience["type"] == "permanent"
+    "rules" => nil # => matched_audiences walks audience["rules"]
+  )
+
+  # ── config_location ────────────────────────────────────────────────────────
+  probe_location_fields(
+    "id" => nil,   # => match_location_list / items_by_ids
+    "key" => nil,  # => find_by_key
+    "name" => nil,
+    "rules" => nil # => match_location_list walks location["rules"]
+  )
+
+  # ── config_segment ─────────────────────────────────────────────────────────
+  probe_segment_fields(
+    "id" => nil,   # => custom_segments_matched? reads seg["id"]
+    "key" => nil,  # => find_by_key
+    "name" => nil,
+    "rules" => nil
+  )
+
+  # ── config_feature ─────────────────────────────────────────────────────────
+  probe_feature_fields(
+    "id" => nil,       # => feature_by_key resolution chain
+    "key" => nil,      # => find_by_key
+    "name" => nil,
+    "variables" => nil # => FeatureManager reads feature["variables"]
+  )
+
+  # ── feature_variable ───────────────────────────────────────────────────────
+  probe_variable_fields(
+    "key" => nil, # => FeatureManager reads variable["key"]
+    "type" => nil # => feature_variable_type discriminator
+  )
+
+  # ── ga integration ─────────────────────────────────────────────────────────
+  probe_ga_fields(
+    "type" => nil, # => ga_integration_type discriminator (ga3 | ga4)
+    "enabled" => nil
+  )
+
+  # ── feature_change_data (variation change substructure — Facet 2) ──────────
+  probe_change_fields(
+    "type" => nil, # => FeatureManager reads change["type"] == FULLSTACK_FEATURE (:199)
+    "data" => {    # => change["data"] (:213)
+      "feature_id" => nil,    # => data["feature_id"] (:223)
+      "variables_data" => nil # => data["variables_data"] (:217)
+    }
+  )
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: convert_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Convert Insights, Inc.
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: The official Convert Experiences Ruby SDK. Provides bucketing-compatible
+  A/B testing, feature flag evaluation, and personalizations for server-side Ruby
+  applications (Rails, Sinatra, Hanami, and plain scripts). Zero runtime dependencies.
+email:
+- support@convert.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- RELEASE.md
+- Rakefile
+- convert_sdk.gemspec
+- lib/convert_sdk.rb
+- lib/convert_sdk/api_manager.rb
+- lib/convert_sdk/background_timer.rb
+- lib/convert_sdk/bucketed_feature.rb
+- lib/convert_sdk/bucketed_variation.rb
+- lib/convert_sdk/bucketing_manager.rb
+- lib/convert_sdk/client.rb
+- lib/convert_sdk/comparisons.rb
+- lib/convert_sdk/config.rb
+- lib/convert_sdk/config_validator.rb
+- lib/convert_sdk/context.rb
+- lib/convert_sdk/data_manager.rb
+- lib/convert_sdk/data_store_manager.rb
+- lib/convert_sdk/enums/bucketing_error.rb
+- lib/convert_sdk/enums/feature_status.rb
+- lib/convert_sdk/enums/goal_data_key.rb
+- lib/convert_sdk/enums/log_level.rb
+- lib/convert_sdk/enums/rule_error.rb
+- lib/convert_sdk/enums/system_events.rb
+- lib/convert_sdk/event_manager.rb
+- lib/convert_sdk/experience_manager.rb
+- lib/convert_sdk/feature_manager.rb
+- lib/convert_sdk/fork_guard.rb
+- lib/convert_sdk/http_client.rb
+- lib/convert_sdk/log_manager.rb
+- lib/convert_sdk/murmur_hash3.rb
+- lib/convert_sdk/redactor.rb
+- lib/convert_sdk/rule_manager.rb
+- lib/convert_sdk/segments_manager.rb
+- lib/convert_sdk/sentinel.rb
+- lib/convert_sdk/stores/memory_store.rb
+- lib/convert_sdk/stores/redis_store.rb
+- lib/convert_sdk/version.rb
+- lib/convert_sdk/visitors_queue.rb
+- scripts/check-generated-rbs-header.sh
+- steep/config_contract_probe.rb
+homepage: https://www.convert.com
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://www.convert.com
+  source_code_uri: https://github.com/convertcom/ruby-sdk
+  changelog_uri: https://github.com/convertcom/ruby-sdk/releases
+  documentation_uri: https://github.com/convertcom/ruby-sdk/wiki
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Convert Experiences FullStack Ruby SDK for A/B testing, feature flags, and
+  personalizations.
+test_files: []