fix(ruby): correct spelling of evaluationDetails (#268)

* fix(ruby): correct spelling of evaluationDetails

* docs(ruby): add documentation comments for public methods

Author: rasendubi

.changeset/twelve-cherries-teach.md

@@ -0,0 +1,10 @@
+---
+"eppo_core": minor
+"ruby-sdk": minor
+---
+
+Fix casing of `evaluationDetails`.
+
+In Ruby SDK v3.4.0, the name of `evaluationDetails` was inadvertently changed to `evaluation_details`. This was a bug that caused backward incompatibility in a minor release.
+
+This release fixes the casing back to `evaluationDetails`.

eppo_core/src/eval/eval_details.rs

@@ -282,7 +282,7 @@ mod magnus_impl {
             let _ = hash.aset(handle.sym_new("variation"), self.variation);
             let _ = hash.aset(handle.sym_new("action"), self.action);
             let _ = hash.aset(
-                handle.sym_new("evaluation_details"),
+                handle.sym_new("evaluationDetails"),
                 self.evaluation_details.as_ref(),
             );
             hash.as_value()

python-sdk/src/client.rs

@@ -452,7 +452,7 @@ impl EppoClient {
         config.is_some()
     }
 
-    /// Wait for configuration to get fetches.
+    /// Wait for configuration to get fetched.
     ///
     /// This method releases GIL, so other Python thread can make progress.
     fn wait_for_initialization(&self, py: Python) -> PyResult<()> {

ruby-sdk/CHANGELOG.md

@@ -6,6 +6,9 @@
 
 - [#247](https://github.com/Eppo-exp/eppo-multiplatform/pull/247) [`2e3bf09`](https://github.com/Eppo-exp/eppo-multiplatform/commit/2e3bf093d23a2b63f55f3e5336662489ed689a09) Thanks [@rasendubi](https://github.com/rasendubi)! - Add `wait_for_initialization()` method.
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.5.1
 
 ### Patch Changes
@@ -16,12 +19,18 @@
 
 - [#223](https://github.com/Eppo-exp/eppo-multiplatform/pull/223) [`9504e92`](https://github.com/Eppo-exp/eppo-multiplatform/commit/9504e928c37f82147e65fe25aab558cad3bbac2a) Thanks [@dependabot](https://github.com/apps/dependabot)! - chore(deps): bump rb_sys from 0.9.110 to 0.9.111
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.5.0
 
 ### Minor Changes
 
 - [#197](https://github.com/Eppo-exp/eppo-multiplatform/pull/197) [`a4da91f`](https://github.com/Eppo-exp/eppo-multiplatform/commit/a4da91f1a962708924063f3f076d3064441c2f76) Thanks [@rasendubi](https://github.com/rasendubi)! - Change TLS implementation from openssl to rustls.
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.4.6
 
 ### Patch Changes
@@ -32,18 +41,27 @@
 
 - [#213](https://github.com/Eppo-exp/eppo-multiplatform/pull/213) [`9ea7865`](https://github.com/Eppo-exp/eppo-multiplatform/commit/9ea78657dbbfe8fb733dd67fb71357872db9f8b2) Thanks [@rasendubi](https://github.com/rasendubi)! - Bump Minimum Supported Rust Version (MSRV) to 1.80.0.
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.4.5
 
 ### Patch Changes
 
 - [#201](https://github.com/Eppo-exp/eppo-multiplatform/pull/201) [`1d310c7`](https://github.com/Eppo-exp/eppo-multiplatform/commit/1d310c7019dde1aa5a965e064eab15187b064d96) Thanks [@felipecsl](https://github.com/felipecsl)! - [Unstable] Event Ingestion: Fix JSON serialization of Event timestamp field
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.4.4
 
 ### Patch Changes
 
 - [#198](https://github.com/Eppo-exp/eppo-multiplatform/pull/198) [`9c6990e`](https://github.com/Eppo-exp/eppo-multiplatform/commit/9c6990ec77dc3ffe8f1b6384f92fcc24db94916f) Thanks [@felipecsl](https://github.com/felipecsl)! - [unstable] Event Ingestion: Fix JSON serialization of Event type field
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.4.3
 
 ### Patch Changes
@@ -56,20 +74,29 @@
 
   This changes API of the core but should be invisible for SDKs. The only noticeable difference is that client should be more responsive to graceful shutdown requests.
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.4.2
 
 ### Patch Changes
 
 - Updated dependencies [[`aa0ca89`](https://github.com/Eppo-exp/eppo-multiplatform/commit/aa0ca8912bab269613d3da25c06f81b1f19ffb36)]:
   - [email protected]
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.4.1
 
 ### Patch Changes
 
 - Updated dependencies [[`82d05ae`](https://github.com/Eppo-exp/eppo-multiplatform/commit/82d05aea0263639be56ba5667500f6940b4832ab)]:
   - [email protected]
 
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.
+
 ## 3.4.0
 
 ### Minor Changes
@@ -115,3 +142,6 @@
 
 - Updated dependencies [[`3a18f95`](https://github.com/Eppo-exp/eppo-multiplatform/commit/3a18f95f0aa25030aeba6676b76e20862a5fcead)]:
   - [email protected]
+
+### Known Issues
+- Starting with v3.4.0, in result of evaluation details methods, the name of `evaluationDetails` key is spelled as `evaluation_details`. This is fixed in 3.7.0.

ruby-sdk/Cargo.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eppo-server-sdk (3.5.0)
+    eppo-server-sdk (3.6.0)
       rb_sys (~> 0.9.102)
 
 GEM

ruby-sdk/Gemfile.lock

@@ -6,6 +6,14 @@
 # EppoClient is the main module for initializing the Eppo client.
 # It provides a method to initialize the client with a given configuration.
 module EppoClient
+  ##
+  # Initializes the Eppo client singleton.
+  #
+  # @note The client returned by this method may still be in the process of initializing.
+  #       Use the `#wait_for_initialization` method to wait for the client to be ready.
+  #
+  # @param config [EppoClient::Config] The configuration for the client.
+  # @return [EppoClient::Client] The client.
   def init(config)
     client = EppoClient::Client.instance
     client.init(config)

ruby-sdk/lib/eppo_client.rb

@@ -40,69 +40,201 @@ def init(config)
     #
     # Note: this method returns immediately if configuration poller
     # has been disabled.
+    #
+    # @param timeout [Numeric] Maximum time to wait in seconds
+    # @return [nil]
     def wait_for_initialization(timeout=1)
       return unless @core
       @core.wait_for_initialization(timeout)
     end
 
+    ##
+    # Returns the currently active configuration.
     def configuration
       @core.configuration
     end
 
+    ##
+    # Sets the currently active configuration.
     def configuration=(configuration)
       @core.configuration = configuration
     end
 
+    ##
+    # Prepare the client for shutdown.
+    #
+    # This method stops the configuration poller and any other background threads.
+    #
+    # @return [nil]
     def shutdown
       @core.shutdown
     end
 
-    # Unstable
-    # Enqueues an arbitrary event. Events must have a type and a payload
+    ##
+    # Tracks an arbitrary event. Events must have a type and a payload.
+    #
+    # @note This method is considered unstable and may change in future versions.
+    #
+    # @param event_type [String] The type of the event to track.
+    # @param payload [Hash] The payload of the event to track.
     def unstable_track(event_type, payload)
       @core.track(event_type, payload)
     end
 
+    ##
+    # Returns a string assignment for the given flag key and subject.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [String] The default value to return if the flag is not found or no assignment can be made.
+    # @return [String] The assignment for the given flag key and subject.
     def get_string_assignment(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_inner(flag_key, subject_key, subject_attributes, "STRING", default_value)
     end
 
+    ##
+    # Returns a numeric assignment for the given flag key and subject.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Numeric] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Numeric] The assignment for the given flag key and subject.
     def get_numeric_assignment(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_inner(flag_key, subject_key, subject_attributes, "NUMERIC", default_value)
     end
 
+    ##
+    # Returns an integer assignment for the given flag key and subject.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Integer] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Integer] The assignment for the given flag key and subject.
     def get_integer_assignment(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_inner(flag_key, subject_key, subject_attributes, "INTEGER", default_value)
     end
 
+    ##
+    # Returns a boolean assignment for the given flag key and subject.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Boolean] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Boolean] The assignment for the given flag key and subject.
     def get_boolean_assignment(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_inner(flag_key, subject_key, subject_attributes, "BOOLEAN", default_value)
     end
 
+    ##
+    # Returns a JSON assignment for the given flag key and subject.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Hash] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Hash] The assignment for the given flag key and subject.
     def get_json_assignment(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_inner(flag_key, subject_key, subject_attributes, "JSON", default_value)
     end
 
+    ##
+    # Returns detailed information about a string assignment for the given flag key and subject.
+    #
+    # @note This method is intended for debugging purposes and is discouraged from use in
+    #   production. It is a couple of times slower than the non-detail methods. The evaluation
+    #   details format is primarily designed for human consumption (debugging) and is therefore
+    #   unstable and may change between SDK versions.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [String] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Hash] A hash containing {:variation => assigned_value, :action => nil, :evaluationDetails => {detailed_evaluation_info}}
     def get_string_assignment_details(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_details_inner(flag_key, subject_key, subject_attributes, "STRING", default_value)
     end
 
+    ##
+    # Returns detailed information about a numeric assignment for the given flag key and subject.
+    #
+    # @note This method is intended for debugging purposes and is discouraged from use in
+    #   production. It is a couple of times slower than the non-detail methods. The evaluation
+    #   details format is primarily designed for human consumption (debugging) and is therefore
+    #   unstable.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Numeric] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Hash] A hash containing {:variation => assigned_value, :action => nil, :evaluationDetails => {detailed_evaluation_info}}
     def get_numeric_assignment_details(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_details_inner(flag_key, subject_key, subject_attributes, "NUMERIC", default_value)
     end
 
+    ##
+    # Returns detailed information about an integer assignment for the given flag key and subject.
+    #
+    # @note This method is intended for debugging purposes and is discouraged from use in
+    #   production. It is a couple of times slower than the non-detail methods. The evaluation
+    #   details format is primarily designed for human consumption (debugging) and is therefore
+    #   unstable and may change between SDK versions.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Integer] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Hash] A hash containing {:variation => assigned_value, :action => nil, :evaluationDetails => {detailed_evaluation_info}}
     def get_integer_assignment_details(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_details_inner(flag_key, subject_key, subject_attributes, "INTEGER", default_value)
     end
 
+    ##
+    # Returns detailed information about a boolean assignment for the given flag key and subject.
+    #
+    # @note This method is intended for debugging purposes and is discouraged from use in
+    #   production. It is a couple of times slower than the non-detail methods. The evaluation
+    #   details format is primarily designed for human consumption (debugging) and is therefore
+    #   unstable and may change between SDK versions.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Boolean] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Hash] A hash containing {:variation => assigned_value, :action => nil, :evaluationDetails => {detailed_evaluation_info}}
     def get_boolean_assignment_details(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_details_inner(flag_key, subject_key, subject_attributes, "BOOLEAN", default_value)
     end
 
+    ##
+    # Returns detailed information about a JSON assignment for the given flag key and subject.
+    #
+    # @note This method is intended for debugging purposes and is discouraged from use in
+    #   production. It is a couple of times slower than the non-detail methods. The evaluation
+    #   details format is primarily designed for human consumption (debugging) and is therefore
+    #   unstable and may change between SDK versions.
+    #
+    # @param flag_key [String] The key of the flag to get an assignment for.
+    # @param subject_key [String] The key of the subject to get an assignment for.
+    # @param subject_attributes [Hash] The attributes of the subject to get an assignment for.
+    # @param default_value [Hash] The default value to return if the flag is not found or no assignment can be made.
+    # @return [Hash] A hash containing {:variation => assigned_value, :action => nil, :evaluationDetails => {detailed_evaluation_info}}
     def get_json_assignment_details(flag_key, subject_key, subject_attributes, default_value)
       get_assignment_details_inner(flag_key, subject_key, subject_attributes, "JSON", default_value)
     end
 
+    ##
+    # Returns a bandit action based on the flag key, subject, and available actions.
+    #
+    # @param flag_key [String] The key of the flag to get an action for.
+    # @param subject_key [String] The key of the subject to get an action for.
+    # @param subject_attributes [Hash] The attributes of the subject.
+    # @param actions [Hash] A map of available actions and their attributes.
+    # @param default_variation [String] The default variation to return if no assignment can be made.
+    # @return [Hash] A hash containing the assigned variation and action.
     def get_bandit_action(flag_key, subject_key, subject_attributes, actions, default_variation)
       attributes = coerce_context_attributes(subject_attributes)
       actions = actions.to_h { |action, attributes| [action, coerce_context_attributes(attributes)] }
@@ -117,6 +249,20 @@ def get_bandit_action(flag_key, subject_key, subject_attributes, actions, defaul
       }
     end
 
+    ##
+    # Returns detailed information about a bandit action based on the flag key, subject, and available actions.
+    #
+    # @note This method is intended for debugging purposes and is discouraged from use in
+    #   production. It is a couple of times slower than the non-detail methods. The evaluation
+    #   details format is primarily designed for human consumption (debugging) and is therefore
+    #   unstable and may change between SDK versions.
+    #
+    # @param flag_key [String] The key of the flag to get an action for.
+    # @param subject_key [String] The key of the subject to get an action for.
+    # @param subject_attributes [Hash] The attributes of the subject.
+    # @param actions [Hash] A map of available actions and their attributes.
+    # @param default_variation [String] The default variation to return if no assignment can be made.
+    # @return [Hash] A hash containing {:variation => assigned_variation, :action => assigned_action, :evaluationDetails => {detailed_evaluation_info}}
     def get_bandit_action_details(flag_key, subject_key, subject_attributes, actions, default_variation)
       attributes = coerce_context_attributes(subject_attributes)
       actions = actions.to_h { |action, attributes| [action, coerce_context_attributes(attributes)] }
@@ -134,7 +280,6 @@ def get_bandit_action_details(flag_key, subject_key, subject_attributes, actions
 
     private
 
-    # rubocop:disable Metrics/MethodLength
     def get_assignment_inner(flag_key, subject_key, subject_attributes, expected_type, default_value)
       logger = Logger.new($stdout)
       begin