eppo-server-sdk 3.5.1-x86_64-linux → 3.7.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb132dd4964a2170d3df0950ffb3611cd8dd8815a6f75cbdf37400784c6e0f17
-  data.tar.gz: 462ca2091414b3baad9b8cc6368d44284ecaa488ba134e8701e71dde07267635
+  metadata.gz: 8b7d687153203134ae5a693a16bc1d21d85e440958772705c3fdd07d168a9fc9
+  data.tar.gz: 3b24c1c17e0443f757d4d8c7dd3db1c0cecce154fef70819a7960f6329a0d7b0
 SHA512:
-  metadata.gz: 870223d034afb153182ea555187a789180e98aa96f50ac7c94d2dc02ce825c2dbdcaf4a32f0dbe837174b3390a8eabf6595bbc1c4839fd5b95ff7cfcbd1c70b8
-  data.tar.gz: c2f2c2d292f61ce6fc0d686074785127ac5c04dc168cd19a518892907227ec83773ddfc1072e4614beead4c412e2de618b57d7322d07828fee982ffd7b8e6b20
+  metadata.gz: a6d6abc0f1231872b1405738c63c650f780f84e6ed4f286d57aa60961ba0a5d5c1f40b18d3bcf2db24d2692367c8f447b3e23d2657ef9071268b977430882642
+  data.tar.gz: d4ef5a889090f64d5059462c48e31bbb7e06d4a7a610b9ba43b0d934dd662a54ae8b44d7e93c9dfb087efbc94d4455b372ed58f9ac0ca73db43981a5e8b5accc

data/lib/eppo_client/client.rb

@@ -31,64 +31,210 @@ module EppoClient
       @core = EppoClient::Core::Client.new(config)
     end
 
+    ##
+    # Waits for client to fetch configuration and get ready to serve
+    # assignments.
+    #
+    # This method blocks the current thread until configuration is
+    # successfully fetched or +timeout+ seconds passed.
+    #
+    # 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)] }
@@ -103,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)] }
@@ -120,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.5.1"
+  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.5.1
+  version: 3.7.0
 platform: x86_64-linux
 authors:
 - Eppo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: