openfeature-sdk 0.6.4 → 0.6.6

data/sig/open_feature/sdk/tracking_event_details.rbs

@@ -0,0 +1,10 @@
+module OpenFeature
+  module SDK
+    class TrackingEventDetails
+      attr_reader value: Numeric?
+      attr_reader fields: Hash[String, untyped]
+
+      def initialize: (?value: Numeric?, **untyped fields) -> void
+    end
+  end
+end

data/sig/open_feature/sdk/transaction_context_propagator.rbs

@@ -0,0 +1,11 @@
+module OpenFeature
+  module SDK
+    interface _TransactionContextPropagator
+      def set_transaction_context: (EvaluationContext evaluation_context) -> void
+      def get_transaction_context: () -> EvaluationContext?
+    end
+
+    module TransactionContextPropagator : _TransactionContextPropagator
+    end
+  end
+end

data/sig/open_feature/sdk/version.rbs

@@ -0,0 +1,5 @@
+module OpenFeature
+  module SDK
+    VERSION: String
+  end
+end

data/sig/open_feature/sdk.rbs

@@ -0,0 +1,22 @@
+module OpenFeature
+  module SDK
+    # Delegated to API.instance via method_missing
+    def self.configure: () { (Configuration) -> void } -> void
+    def self.build_client: (?domain: String?, ?evaluation_context: EvaluationContext?) -> Client
+    def self.configuration: () -> Configuration
+    def self.provider: (?domain: String?) -> untyped?
+    def self.set_provider: (untyped provider, ?domain: String?) -> void
+    def self.set_provider_and_wait: (untyped provider, ?domain: String?) -> void
+    def self.hooks: () -> Array[untyped]
+    def self.add_hooks: (*Array[untyped] new_hooks) -> void
+    def self.evaluation_context: () -> EvaluationContext?
+    def self.add_handler: (String event_type, _ToProc handler) -> void
+    def self.remove_handler: (String event_type, _ToProc handler) -> void
+    def self.logger: () -> untyped?
+    def self.logger=: (untyped? new_logger) -> void
+    def self.set_transaction_context_propagator: (_TransactionContextPropagator propagator) -> void
+    def self.set_transaction_context: (EvaluationContext evaluation_context) -> void
+    def self.shutdown: () -> void
+    def self.provider_metadata: (?domain: String?) -> Provider::ProviderMetadata?
+  end
+end

metadata

@@ -1,142 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.6
 platform: ruby
 authors:
 - OpenFeature Authors
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: markly
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: standard-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.10
-description: Ruby SDK for an the specifications for the open standard of feature flag
-  management
+dependencies: []
+description: Ruby SDK for the OpenFeature specification, an open standard for feature
+  flag management
 email:
 - cncf-openfeature-contributors@lists.cncf.io
 executables: []
@@ -146,9 +20,9 @@ files:
 - ".release-please-manifest.json"
 - ".rspec"
 - ".ruby-version"
-- ".simplecov"
 - ".standard.yml"
 - ".tool-versions"
+- ".yardopts"
 - CHANGELOG.md
 - CLAUDE.md
 - CODEOWNERS
@@ -159,9 +33,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- SECURITY.md
+- Steepfile
 - cucumber.yml
-- docs/plans/2026-03-07-telemetry-utility-design.md
-- docs/plans/2026-03-07-telemetry-utility-plan.md
+- examples/basic_usage.rb
+- examples/custom_provider.rb
+- examples/rails_integration.rb
 - lib/open_feature/sdk.rb
 - lib/open_feature/sdk/api.rb
 - lib/open_feature/sdk/client.rb
@@ -170,6 +47,7 @@ files:
 - lib/open_feature/sdk/evaluation_context.rb
 - lib/open_feature/sdk/evaluation_context_builder.rb
 - lib/open_feature/sdk/evaluation_details.rb
+- lib/open_feature/sdk/evaluation_error.rb
 - lib/open_feature/sdk/event_dispatcher.rb
 - lib/open_feature/sdk/hooks.rb
 - lib/open_feature/sdk/hooks/hints.rb
@@ -194,17 +72,53 @@ files:
 - lib/open_feature/sdk/tracking_event_details.rb
 - lib/open_feature/sdk/transaction_context_propagator.rb
 - lib/open_feature/sdk/version.rb
+- openfeature-sdk.gemspec
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - release-please-config.json
 - renovate.json
-homepage: https://github.com/open-feature/openfeature-ruby
+- sig/open_feature/sdk.rbs
+- sig/open_feature/sdk/api.rbs
+- sig/open_feature/sdk/client.rbs
+- sig/open_feature/sdk/client_metadata.rbs
+- sig/open_feature/sdk/configuration.rbs
+- sig/open_feature/sdk/evaluation_context.rbs
+- sig/open_feature/sdk/evaluation_context_builder.rbs
+- sig/open_feature/sdk/evaluation_details.rbs
+- sig/open_feature/sdk/evaluation_error.rbs
+- sig/open_feature/sdk/event_dispatcher.rbs
+- sig/open_feature/sdk/hooks/hints.rbs
+- sig/open_feature/sdk/hooks/hook.rbs
+- sig/open_feature/sdk/hooks/hook_context.rbs
+- sig/open_feature/sdk/hooks/hook_executor.rbs
+- sig/open_feature/sdk/hooks/logging_hook.rbs
+- sig/open_feature/sdk/provider.rbs
+- sig/open_feature/sdk/provider/error_code.rbs
+- sig/open_feature/sdk/provider/event_emitter.rbs
+- sig/open_feature/sdk/provider/in_memory_provider.rbs
+- sig/open_feature/sdk/provider/no_op_provider.rbs
+- sig/open_feature/sdk/provider/provider_metadata.rbs
+- sig/open_feature/sdk/provider/reason.rbs
+- sig/open_feature/sdk/provider/resolution_details.rbs
+- sig/open_feature/sdk/provider_event.rbs
+- sig/open_feature/sdk/provider_initialization_error.rbs
+- sig/open_feature/sdk/provider_state.rbs
+- sig/open_feature/sdk/provider_state_registry.rbs
+- sig/open_feature/sdk/telemetry.rbs
+- sig/open_feature/sdk/thread_local_transaction_context_propagator.rbs
+- sig/open_feature/sdk/tracking_event_details.rbs
+- sig/open_feature/sdk/transaction_context_propagator.rbs
+- sig/open_feature/sdk/version.rbs
+homepage: https://github.com/open-feature/ruby-sdk
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://github.com/open-feature/openfeature-ruby
-  source_code_uri: https://github.com/open-feature/openfeature-ruby
-  changelog_uri: https://github.com/open-feature/openfeature-ruby/blob/main/CHANGELOG.md
-  bug_tracker_uri: https://github.com/open-feature/openfeature-ruby/issues
-  documentation_uri: https://github.com/open-feature/openfeature-ruby/README.md
+  homepage_uri: https://github.com/open-feature/ruby-sdk
+  source_code_uri: https://github.com/open-feature/ruby-sdk
+  changelog_uri: https://github.com/open-feature/ruby-sdk/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/open-feature/ruby-sdk/issues
+  documentation_uri: https://github.com/open-feature/ruby-sdk#readme
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -219,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: OpenFeature SDK for Ruby
 test_files: []

data/.simplecov

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "simplecov-cobertura"
-
-SimpleCov.start do
-  add_filter "/spec/"
-  if ENV["CI"] == "true"
-    formatter SimpleCov::Formatter::CoberturaFormatter
-  else
-    formatter SimpleCov::Formatter::HTMLFormatter
-  end
-end

data/docs/plans/2026-03-07-telemetry-utility-design.md

@@ -1,98 +0,0 @@
-# Telemetry Utility Design
-
-## Overview
-
-Add an OTel-compatible telemetry utility to the OpenFeature Ruby SDK that creates
-structured evaluation events from hook context and evaluation details. This utility
-is dependency-free (no OTel gem required) and follows the pattern established by
-the Go SDK's `telemetry` package.
-
-Addresses: https://github.com/open-feature/ruby-sdk/issues/176
-
-## References
-
-- [OpenFeature Spec Appendix D (Observability)](https://openfeature.dev/specification/appendix-d/)
-- [OTel Semantic Conventions for Feature Flags](https://opentelemetry.io/docs/specs/semconv/feature-flags/feature-flags-logs/)
-- [Go SDK telemetry package](https://github.com/open-feature/go-sdk/tree/main/openfeature/telemetry)
-- [JS SDK reference PR](https://github.com/open-feature/js-sdk/pull/1120)
-
-## Design Decisions
-
-1. **Single public method** accepting `hook_context:` and `evaluation_details:` keyword
-   arguments — mirrors the `finally` hook stage signature for zero-friction integration.
-2. **Returns a Struct** (`EvaluationEvent`) with `name` and `attributes` fields — matches
-   the SDK's existing Struct conventions (`ResolutionDetails`, `ClientMetadata`, etc.).
-3. **Constants in the Telemetry module directly** — flat namespace matching Go SDK and
-   existing Ruby SDK patterns (e.g., `Provider::Reason`).
-4. **Hard-coded metadata mappings only** — maps `contextId`, `flagSetId`, `version` from
-   flag metadata to OTel keys. Unknown metadata keys are ignored. Custom attributes can
-   be added via hooks in ruby-sdk-contrib.
-5. **No third-party dependencies** — pure data transformation using only standard library.
-
-## File Structure
-
-- `lib/open_feature/sdk/telemetry.rb` — module with constants, struct, and utility function
-- `spec/open_feature/sdk/telemetry_spec.rb` — tests
-- `lib/open_feature/sdk.rb` — add `require_relative "sdk/telemetry"`
-
-## Constants
-
-```ruby
-EVENT_NAME        = "feature_flag.evaluation"
-
-FLAG_KEY          = "feature_flag.key"
-CONTEXT_ID_KEY    = "feature_flag.context.id"
-ERROR_MESSAGE_KEY = "error.message"
-ERROR_TYPE_KEY    = "error.type"
-PROVIDER_NAME_KEY = "feature_flag.provider.name"
-RESULT_REASON_KEY = "feature_flag.result.reason"
-RESULT_VALUE_KEY  = "feature_flag.result.value"
-RESULT_VARIANT_KEY = "feature_flag.result.variant"
-FLAG_SET_ID_KEY   = "feature_flag.set.id"
-VERSION_KEY       = "feature_flag.version"
-```
-
-## Public API
-
-```ruby
-OpenFeature::SDK::Telemetry.create_evaluation_event(
-  hook_context:,        # Hooks::HookContext
-  evaluation_details:   # EvaluationDetails or nil
-) # => EvaluationEvent
-```
-
-Returns `EvaluationEvent = Struct.new(:name, :attributes, keyword_init: true)`.
-
-## Attribute Population Rules
-
-| Attribute | Source | Condition |
-|-----------|--------|-----------|
-| `feature_flag.key` | `hook_context.flag_key` | Always |
-| `feature_flag.provider.name` | `hook_context.provider_metadata.name` | When present |
-| `feature_flag.result.variant` | `evaluation_details.variant` | When present (takes precedence over value) |
-| `feature_flag.result.value` | `evaluation_details.value` | Only when variant is nil |
-| `feature_flag.result.reason` | `evaluation_details.reason.downcase` | When present |
-| `error.type` | `evaluation_details.error_code.downcase` | When error occurred |
-| `error.message` | `evaluation_details.error_message` | When error occurred |
-| `feature_flag.context.id` | `targeting_key` or metadata `contextId` | Metadata takes precedence |
-| `feature_flag.set.id` | metadata `flagSetId` | When present in flag_metadata |
-| `feature_flag.version` | metadata `version` | When present in flag_metadata |
-
-## Error Handling
-
-No defensive `rescue` in the utility — it is a pure data transformation. Nil inputs
-are handled via guard clauses. The calling hook is responsible for exception safety
-(consistent with the existing hook executor pattern).
-
-## Test Plan
-
-1. Happy path with all attributes populated
-2. Variant vs value precedence
-3. Enum downcasing (reason and error_code)
-4. Error attributes present only on error
-5. Nil evaluation_details
-6. Nil/empty flag_metadata
-7. Metadata contextId overrides targeting_key
-8. Targeting key fallback when no contextId
-9. Unknown metadata keys ignored
-10. Return type verification