eppo-server-sdk 3.6.0-arm64-darwin → 3.7.0-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe0467b4be07dddb1f9bc51d299b08c28f7b3cf93a028463fc7e7b49a48711a
-  data.tar.gz: 5880fbb3d30c337e8938bca5adb25dc9efc469ee48b2e6c894b86655b13484f3
+  metadata.gz: 5ace4b9f12eb28590bb8fdce1ee23c754be1cc5866049a69c9c7351bc5e6a1eb
+  data.tar.gz: '080b59b10af6bd3452f46c3bb0c5e09d25165c59ce4a3d93d1ebfd0f31e5cda9'
 SHA512:
-  metadata.gz: 96885d19a09b844d6afb4e33537c87e4920bb8a2154bf2b355fe5cbe9f9d6f8a04be19c8352ce77d8292f05e820c8d670348fb8c3a1f8a6736f6654f8f94f087
-  data.tar.gz: 9cf95bdd5f948d0592db01571faf2e91d6b4646c5e1ea6a89c3dd2926a2f9570ebba8317592252248e9c525c0febc1473888c8c9af4bd1c816c98dbc2a95b8eb
+  metadata.gz: 4e3667f2f2d94f9a23b184fb1e12798c0641df2891337df90b862656073018d829a1bc8c622bfa427c0cc75d600aa779475568a2abd5a6ad7362e528c399586c
+  data.tar.gz: 163a53a725ad85973ec25924e6c73705df1652b19f9607b4f516d9ce81163405593b2734510a71aa7732fe0756667da1bbd8bf9f68c4f5caddc16e2e1d14bdbc

data/lib/eppo_client/client.rb

@@ -40,69 +40,201 @@ module EppoClient
     #
     # 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 @@ module EppoClient
       }
     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 @@ module EppoClient
 
     private
 
-    # rubocop:disable Metrics/MethodLength
     def get_assignment_inner(flag_key, subject_key, subject_attributes, expected_type, default_value)
       logger = Logger.new($stdout)
       begin

data/lib/eppo_client/version.rb

@@ -2,5 +2,5 @@
 
 # TODO: this version and ext/eppo_client/Cargo.toml should be in sync
 module EppoClient
-  VERSION = "3.6.0"
+  VERSION = "3.7.0"
 end

data/lib/eppo_client.rb

@@ -6,6 +6,14 @@ require_relative "eppo_client/version"
 # 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eppo-server-sdk
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: arm64-darwin
 authors:
 - Eppo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: