openfeature-sdk 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01c5b0fe23e56edfe9142031b5ad8b25e9f55b42e7eeb4ccb36692ee297b543f
-  data.tar.gz: 87c4f9c43567db36526725b79c9a7075b3acb47949f07820b444ef31fd59af5f
+  metadata.gz: d79e98004b058036248ba05928ee5debe398a607a0d079f3d8d366fcde9bce07
+  data.tar.gz: 76c896c762a1e5a7828f7785864c0bbb2034214c5ffcc12988af044ad23d2806
 SHA512:
-  metadata.gz: 82b18ea505c33933f3a8798013cfac8d660d2560badcb45f11a9ec1036ab40ba2b61d14f347754f9d679dd07214228ae953a6a5e4e153b1196d53e3163c94cfd
-  data.tar.gz: 5af77fb1f0668477663dc04c1b7d759fc76ba899c693acf7cb53823133f89834b82ebe2591d8efb31d88638e950b33c53f91aa328c06a8abf98ce42fa795b5ea
+  metadata.gz: 62d7a0aa1d5110d346afd5d39317064ef5f5722138bdd90cf31f96aa3587cd3fc1083cfade3b7d8f9b02560075078010e82104fcba9939621e301dfa12e3cf85
+  data.tar.gz: 10540bcff19a5d57113d4b298f2f0ed9ddf13f3e1b2bdcff116ef27e6ac55c233a8b2ee4aba3468c40a31c698e9f3cbeb8208c2964f9df67551e632dd0190564

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.1"
+  ".": "0.3.0"
 }

data/.standard.yml

@@ -1,5 +1,5 @@
 parallel: true
-formatter: progress
+format: progress
 ruby_version: 3.1
 plugins:
   - standard-performance

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [0.3.0](https://github.com/open-feature/ruby-sdk/compare/v0.2.1...v0.3.0) (2024-04-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* Add `EvaluationContext` helpers and context merging to flag evaluation ([#119](https://github.com/open-feature/ruby-sdk/issues/119))
+* Separate `Client` and `Provider` metadata, add client creation tests ([#116](https://github.com/open-feature/ruby-sdk/issues/116))
+
+### Features
+
+* Add `EvaluationContext` helpers and context merging to flag evaluation ([#119](https://github.com/open-feature/ruby-sdk/issues/119)) ([34e4795](https://github.com/open-feature/ruby-sdk/commit/34e47956d66e0c6763f58c818461aa52f628bd21))
+* Add evaluation context based on requirement 3.1 ([#114](https://github.com/open-feature/ruby-sdk/issues/114)) ([f8e016f](https://github.com/open-feature/ruby-sdk/commit/f8e016f1cf7bf1ca7fddce7a41efdeb4d3d522c1))
+* Flag Evaluation Requirement 1.1.4 and 1.1.5 and Provider Requirement 2.1.1 ([#112](https://github.com/open-feature/ruby-sdk/issues/112)) ([aac74b1](https://github.com/open-feature/ruby-sdk/commit/aac74b1e80a4b3e69983e55cf5c75b9cee37b71b))
+
+
+### Code Refactoring
+
+* Separate `Client` and `Provider` metadata, add client creation tests ([#116](https://github.com/open-feature/ruby-sdk/issues/116)) ([f028c39](https://github.com/open-feature/ruby-sdk/commit/f028c398db3e2317847fe7e7bcbe6bbe96bb0b1c))
+
 ## [0.2.1](https://github.com/open-feature/ruby-sdk/compare/v0.2.0...v0.2.1) (2024-03-29)
 
 

data/Gemfile

@@ -4,5 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in openfeature-sdk.gemspec
 gemspec
-
-gem "concurrent-ruby", require: "concurrent"

data/Gemfile.lock

@@ -1,72 +1,69 @@
 PATH
   remote: .
   specs:
-    openfeature-sdk (0.2.1)
+    openfeature-sdk (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.1.1)
-    concurrent-ruby (1.2.3)
-    debug (1.9.1)
+    debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     io-console (0.7.2)
-    irb (1.11.2)
+    irb (1.12.0)
       rdoc
       reline (>= 0.4.2)
-    json (2.6.3)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
     markly (0.10.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    racc (1.7.1)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rdoc (6.6.2)
+    rake (13.1.0)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    regexp_parser (2.8.1)
-    reline (0.4.3)
+    regexp_parser (2.9.0)
+    reline (0.5.0)
       io-console (~> 0.5)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
+    rspec-core (3.12.3)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec-expectations (3.12.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+    rspec-mocks (3.12.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.56.3)
-      base64 (~> 0.1.1)
+    rspec-support (3.12.2)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.19.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -77,20 +74,20 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.31.1)
+    standard (1.35.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.56.2)
+      rubocop (~> 1.62.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.2)
+      standard-performance (~> 1.3)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.2.0)
+    standard-performance (1.3.1)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.19.0)
+      rubocop-performance (~> 1.20.2)
     stringio (3.1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-21
@@ -104,7 +101,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  concurrent-ruby
   debug
   markly
   openfeature-sdk!

data/README.md

@@ -50,12 +50,18 @@ OpenFeature::SDK.configure do |config|
   ))
   # alternatively, you can bind multiple providers to different domains
   config.set_provider(OpenFeature::SDK::Provider::NoOpProvider.new, domain: "legacy_flags")
+  # you can set a global evaluation context here
+  config.evaluation_context = OpenFeature::SDK::EvaluationContext.new("host" => "myhost.com")
 end
 
 # Create a client
 client = OpenFeature::SDK.build_client
 # Create a client for a different domain, this will use the provider assigned to that domain
 legacy_flag_client = OpenFeature::SDK.build_client(domain: "legacy_flags")
+# Evaluation context can be set on a client as well
+client_with_context = OpenFeature::SDK.build_client(
+  evaluation_context: OpenFeature::SDK::EvaluationContext.new("controller_name" => "admin")
+)
 
 # fetching boolean value feature flag
 bool_value = client.fetch_boolean_value(flag_key: 'boolean_flag', default_value: false)
@@ -69,6 +75,15 @@ integer_value = client.fetch_number_value(flag_key: 'number_value', default_valu
 
 # get an object value
 object = client.fetch_object_value(flag_key: 'object_value', default_value: JSON.dump({ name: 'object'}))
+
+# Invocation evaluation context can also be passed in during flag evaluation.
+# During flag evaluation, invocation context takes precedence over client context
+# which takes precedence over API (aka global) context.
+bool_value = client.fetch_boolean_value(
+  flag_key: 'boolean_flag',
+  default_value: false,
+  evaluation_context: OpenFeature::SDK::EvaluationContext.new("is_friday" => true)
+)
 ```
 
 For complete documentation, visit: https://openfeature.dev/docs/category/concepts

data/lib/open_feature/sdk/api.rb

@@ -4,9 +4,11 @@ require "forwardable"
 require "singleton"
 
 require_relative "configuration"
+require_relative "evaluation_context"
+require_relative "evaluation_context_builder"
 require_relative "evaluation_details"
+require_relative "client_metadata"
 require_relative "client"
-require_relative "metadata"
 require_relative "provider"
 
 module OpenFeature
@@ -30,7 +32,7 @@ module OpenFeature
       include Singleton # Satisfies Flag Evaluation API Requirement 1.1.1
       extend Forwardable
 
-      def_delegators :configuration, :provider, :set_provider, :hooks, :context
+      def_delegators :configuration, :provider, :set_provider, :hooks, :evaluation_context
 
       def configuration
         @configuration ||= Configuration.new
@@ -42,12 +44,12 @@ module OpenFeature
         block.call(configuration)
       end
 
-      def build_client(name: nil, version: nil, domain: nil)
-        client_options = Metadata.new(name: name, version: version, domain: domain).freeze
-
+      def build_client(domain: nil, evaluation_context: nil)
         active_provider = provider(domain:).nil? ? Provider::NoOpProvider.new : provider(domain:)
 
-        Client.new(provider: active_provider, client_options:, context:)
+        Client.new(provider: active_provider, domain:, evaluation_context:)
+      rescue
+        Client.new(provider: Provider::NoOpProvider.new, evaluation_context:)
       end
     end
   end

data/lib/open_feature/sdk/client.rb

@@ -8,14 +8,14 @@ module OpenFeature
       RESULT_TYPE = %i[boolean string number object].freeze
       SUFFIXES = %i[value details].freeze
 
-      attr_reader :metadata
+      attr_reader :metadata, :evaluation_context
 
       attr_accessor :hooks
 
-      def initialize(provider:, client_options: nil, context: nil)
+      def initialize(provider:, domain: nil, evaluation_context: nil)
         @provider = provider
-        @metadata = client_options
-        @context = context
+        @metadata = ClientMetadata.new(domain:)
+        @evaluation_context = evaluation_context
         @hooks = []
       end
 
@@ -26,7 +26,8 @@ module OpenFeature
             #   result = @provider.fetch_boolean_value(flag_key: flag_key, default_value: default_value, evaluation_context: evaluation_context)
             # end
             def fetch_#{result_type}_#{suffix}(flag_key:, default_value:, evaluation_context: nil)
-              resolution_details = @provider.fetch_#{result_type}_value(flag_key:, default_value:, evaluation_context:)
+              built_context = EvaluationContextBuilder.new.call(api_context: OpenFeature::SDK.evaluation_context, client_context: self.evaluation_context, invocation_context: evaluation_context)
+              resolution_details = @provider.fetch_#{result_type}_value(flag_key:, default_value:, evaluation_context: built_context)
               evaluation_details = EvaluationDetails.new(flag_key:, resolution_details:)
               #{"evaluation_details.value" if suffix == :value}
             end

data/lib/open_feature/sdk/client_metadata.rb

@@ -0,0 +1,5 @@
+module OpenFeature
+  module SDK
+    ClientMetadata = Struct.new(:domain, keyword_init: true)
+  end
+end

data/lib/open_feature/sdk/configuration.rb

@@ -1,21 +1,17 @@
 # frozen_string_literal: true
 
-require "concurrent"
-
 require_relative "api"
 
 module OpenFeature
   module SDK
     # Represents the configuration object for the global API where <tt>Provider</tt>, <tt>Hook</tt>,
-    # and <tt>Context</tt> are configured.
+    # and <tt>EvaluationContext</tt> are configured.
     # This class is not meant to be interacted with directly but instead through the <tt>OpenFeature::SDK.configure</tt>
     # method
     class Configuration
       extend Forwardable
 
-      attr_accessor :context, :hooks
-
-      def_delegator :provider, :metadata
+      attr_accessor :evaluation_context, :hooks
 
       def initialize
         @hooks = []
@@ -23,7 +19,7 @@ module OpenFeature
       end
 
       def provider(domain: nil)
-        @providers[domain]
+        @providers[domain] || @providers[nil]
       end
 
       # When switching providers, there are a few lifecycle methods that need to be taken care of.

data/lib/open_feature/sdk/evaluation_context.rb

@@ -0,0 +1,32 @@
+module OpenFeature
+  module SDK
+    class EvaluationContext
+      TARGETING_KEY = "targeting_key"
+
+      attr_reader :fields
+
+      def initialize(**fields)
+        @fields = fields.transform_keys(&:to_s)
+      end
+
+      def targeting_key
+        fields[TARGETING_KEY]
+      end
+
+      def field(key)
+        fields[key]
+      end
+
+      def merge(overriding_context)
+        EvaluationContext.new(
+          targeting_key: overriding_context.targeting_key || targeting_key,
+          **fields.merge(overriding_context.fields)
+        )
+      end
+
+      def ==(other)
+        fields == other.fields
+      end
+    end
+  end
+end

data/lib/open_feature/sdk/evaluation_context_builder.rb

@@ -0,0 +1,16 @@
+module OpenFeature
+  module SDK
+    # Used to combine evaluation contexts from different sources
+    class EvaluationContextBuilder
+      def call(api_context:, client_context:, invocation_context:)
+        available_contexts = [api_context, client_context, invocation_context].compact
+
+        return nil if available_contexts.empty?
+
+        available_contexts.reduce(EvaluationContext.new) do |built_context, context|
+          built_context.merge(context)
+        end
+      end
+    end
+  end
+end

data/lib/open_feature/sdk/provider/in_memory_provider.rb

@@ -5,8 +5,10 @@ module OpenFeature
       class InMemoryProvider
         NAME = "In-memory Provider"
 
+        attr_reader :metadata
+
         def initialize(flags = {})
-          @metadata = Metadata.new(name: NAME).freeze
+          @metadata = ProviderMetadata.new(name: NAME).freeze
           @flags = flags
         end
 

data/lib/open_feature/sdk/provider/no_op_provider.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../metadata"
-
 # rubocop:disable Lint/UnusedMethodArgument
 module OpenFeature
   module SDK
@@ -31,7 +29,7 @@ module OpenFeature
         attr_reader :metadata
 
         def initialize
-          @metadata = Metadata.new(name: NAME).freeze
+          @metadata = ProviderMetadata.new(name: NAME).freeze
         end
 
         def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)

data/lib/open_feature/sdk/provider/provider_metadata.rb

@@ -0,0 +1,7 @@
+module OpenFeature
+  module SDK
+    module Provider
+      ProviderMetadata = Struct.new(:name, keyword_init: true)
+    end
+  end
+end

data/lib/open_feature/sdk/provider.rb

@@ -1,6 +1,7 @@
 require_relative "provider/error_code"
 require_relative "provider/reason"
 require_relative "provider/resolution_details"
+require_relative "provider/provider_metadata"
 require_relative "provider/no_op_provider"
 require_relative "provider/in_memory_provider"
 

data/lib/open_feature/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenFeature
   module SDK
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - OpenFeature Authors
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -147,13 +147,16 @@ files:
 - lib/open_feature/sdk.rb
 - lib/open_feature/sdk/api.rb
 - lib/open_feature/sdk/client.rb
+- lib/open_feature/sdk/client_metadata.rb
 - lib/open_feature/sdk/configuration.rb
+- 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/metadata.rb
 - lib/open_feature/sdk/provider.rb
 - lib/open_feature/sdk/provider/error_code.rb
 - lib/open_feature/sdk/provider/in_memory_provider.rb
 - lib/open_feature/sdk/provider/no_op_provider.rb
+- lib/open_feature/sdk/provider/provider_metadata.rb
 - lib/open_feature/sdk/provider/reason.rb
 - lib/open_feature/sdk/provider/resolution_details.rb
 - lib/open_feature/sdk/version.rb

data/lib/open_feature/sdk/metadata.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module OpenFeature
-  module SDK
-    # Metadata structure that defines general metadata relating to a <tt>Provider</tt> or <tt>Client</tt>
-    #
-    # Within the Metadata structure, the following attribute readers are available:
-    #
-    # * <tt>name</tt> - Defines the name of the structure
-    #
-    # * <tt>version</tt> - Allows you to specify version of the Metadata structure
-    #
-    # * <tt>domain</tt> - Allows you to specify the domain of the Metadata structure
-    #
-    # Usage:
-    #
-    #   metadata = Metadata.new(name: 'name-for-metadata', version: 'v1.1.3', domain: 'test')
-    #   metadata.name # 'name-for-metadata'
-    #   metadata.version # version
-    #   metadata_two = Metadata.new(name: 'name-for-metadata')
-    #   metadata_two == metadata # true - equality based on values
-    class Metadata
-      attr_reader :name, :version, :domain
-
-      def initialize(name:, version: nil, domain: nil)
-        @name = name
-        @version = version
-        @domain = domain
-      end
-
-      def ==(other)
-        raise ArgumentError("Expected comparison to be between Metadata object") unless other.is_a?(Metadata)
-
-        @name == other.name && @version == other.version
-      end
-    end
-  end
-end