eppo-server-sdk 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d2f2b75ea023c388c50b7db7ad56e017b217c21811310116938f35409153520
-  data.tar.gz: 1fb5b4873b50f1197fcec8ea91ab071d8a5a75c7790e8cd956f011c621a88425
+  metadata.gz: 5fd8f3093395da766b70f3e7cba84b6fc712f58c05092b3594ab53cb0d0f827d
+  data.tar.gz: f773c3f04448a9a63c2e495c07099d952df7579b87472f9cf281e22d69698127
 SHA512:
-  metadata.gz: debd90881651fa4d3f85d6af2ce71673c59378b3238f7443a2b851f16a762f667198e61f8494d28957da2ecb28dc896c5a99564a54e6fb5ec14ddde0c1a4c06a
-  data.tar.gz: 2559d1d149a37e6dd8f6779511e72532a7a4046feda48e9657939de1db34ba30d2c5d52b5df6d413279f67ff4d9cfcd03a5b905bc723e0d13c236be5295e3a66
+  metadata.gz: bdf91e318a7a4ef6e8eeb90650b94f6ce712ca58b35fdf99e08e60a71c79ef91c769e0798e709c1b59da8c060bffcb765ff8e9afc06d58330ceab2155d71d26a
+  data.tar.gz: 22f8876c55dd41194a25bd9b31174f3cb84e8a760507afe72f5eb8a9f9859e8d32d4938b1a6c82147fafd011bcfd1df1f848bea818bd9d927bbd2051db657dd5

data/lib/client.rb

@@ -8,10 +8,13 @@ require 'custom_errors'
 require 'rules'
 require 'shard'
 require 'validation'
+require 'variation_type'
 
 module EppoClient
   # The main client singleton
+  # rubocop:disable Metrics/ClassLength
   class Client
+    extend Gem::Deprecate
     include Singleton
     attr_accessor :config_requestor, :assignment_logger, :poller
 
@@ -19,24 +22,123 @@ module EppoClient
       Client.instance
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def get_string_assignment(
+      subject_key,
+      flag_key,
+      subject_attributes = {},
+      log_level = EppoClient::DEFAULT_LOGGER_LEVEL
+    )
+      logger = Logger.new($stdout)
+      logger.level = log_level
+      assigned_variation = get_assignment_variation(
+        subject_key, flag_key, subject_attributes,
+        EppoClient::VariationType::STRING_TYPE, logger
+      )
+      assigned_variation&.typed_value
+    end
+
+    def get_numeric_assignment(
+      subject_key,
+      flag_key,
+      subject_attributes = {},
+      log_level = EppoClient::DEFAULT_LOGGER_LEVEL
+    )
+      logger = Logger.new($stdout)
+      logger.level = log_level
+      assigned_variation = get_assignment_variation(
+        subject_key, flag_key, subject_attributes,
+        EppoClient::VariationType::NUMERIC_TYPE, logger
+      )
+      assigned_variation&.typed_value
+    end
+
+    def get_boolean_assignment(
+      subject_key,
+      flag_key,
+      subject_attributes = {},
+      log_level = EppoClient::DEFAULT_LOGGER_LEVEL
+    )
+      logger = Logger.new($stdout)
+      logger.level = log_level
+      assigned_variation = get_assignment_variation(
+        subject_key, flag_key, subject_attributes,
+        EppoClient::VariationType::BOOLEAN_TYPE, logger
+      )
+      assigned_variation&.typed_value
+    end
+
+    def get_parsed_json_assignment(
+      subject_key,
+      flag_key,
+      subject_attributes = {},
+      log_level = EppoClient::DEFAULT_LOGGER_LEVEL
+    )
+      logger = Logger.new($stdout)
+      logger.level = log_level
+      assigned_variation = get_assignment_variation(
+        subject_key, flag_key, subject_attributes,
+        EppoClient::VariationType::JSON_TYPE, logger
+      )
+      assigned_variation&.typed_value
+    end
+
+    def get_json_string_assignment(
+      subject_key,
+      flag_key,
+      subject_attributes = {},
+      log_level = EppoClient::DEFAULT_LOGGER_LEVEL
+    )
+      logger = Logger.new($stdout)
+      logger.level = log_level
+      assigned_variation = get_assignment_variation(
+        subject_key, flag_key, subject_attributes,
+        EppoClient::VariationType::JSON_TYPE, logger
+      )
+      assigned_variation&.value
+    end
+
     def get_assignment(
       subject_key,
-      flag_or_experiment_key,
+      flag_key,
       subject_attributes = {},
       log_level = EppoClient::DEFAULT_LOGGER_LEVEL
     )
       logger = Logger.new($stdout)
       logger.level = log_level
+      assigned_variation = get_assignment_variation(subject_key, flag_key,
+                                                    subject_attributes, nil,
+                                                    logger)
+      assigned_variation&.value
+    end
+    deprecate :get_assignment, 'the get_<typed>_assignment methods', 2024, 1
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def get_assignment_variation(
+      subject_key,
+      flag_key,
+      subject_attributes,
+      expected_variation_type,
+      logger
+    )
       EppoClient.validate_not_blank('subject_key', subject_key)
-      EppoClient.validate_not_blank('flag_or_experiment_key', flag_or_experiment_key)
-      experiment_config = @config_requestor.get_configuration(flag_or_experiment_key)
+      EppoClient.validate_not_blank('flag_key', flag_key)
+      experiment_config = @config_requestor.get_configuration(flag_key)
       override = get_subject_variation_override(experiment_config, subject_key)
-      return override unless override.nil?
+      unless override.nil?
+        unless expected_variation_type.nil?
+          variation_is_expected_type =
+            EppoClient::VariationType.expected_type?(
+              override, expected_variation_type
+            )
+          return nil unless variation_is_expected_type
+        end
+        return override
+      end
 
       if experiment_config.nil? || experiment_config.enabled == false
         logger.debug(
-          "[Eppo SDK] No assigned variation. No active experiment or flag for key: #{flag_or_experiment_key}"
+          '[Eppo SDK] No assigned variation. No active experiment or flag for '\
+          "key: #{flag_key}"
         )
         return nil
       end
@@ -44,7 +146,8 @@ module EppoClient
       matched_rule = EppoClient.find_matching_rule(subject_attributes, experiment_config.rules)
       if matched_rule.nil?
         logger.debug(
-          "[Eppo SDK] No assigned variation. Subject attributes do not match targeting rules: #{subject_attributes}"
+          '[Eppo SDK] No assigned variation. Subject attributes do not match '\
+          "targeting rules: #{subject_attributes}"
         )
         return nil
       end
@@ -52,22 +155,41 @@ module EppoClient
       allocation = experiment_config.allocations[matched_rule.allocation_key]
       unless in_experiment_sample?(
         subject_key,
-        flag_or_experiment_key,
+        flag_key,
         experiment_config.subject_shards,
         allocation.percent_exposure
       )
         logger.debug(
-          '[Eppo SDK] No assigned variation. Subject is not part of experiment sample population'
+          '[Eppo SDK] No assigned variation. Subject is not part of experiment'\
+          ' sample population'
         )
         return nil
       end
 
-      shard = EppoClient.get_shard("assignment-#{subject_key}-#{flag_or_experiment_key}", experiment_config.subject_shards)
-      assigned_variation = allocation.variations.find { |var| var.shard_range.shard_in_range?(shard) }.value
+      shard = EppoClient.get_shard(
+        "assignment-#{subject_key}-#{flag_key}",
+        experiment_config.subject_shards
+      )
+      assigned_variation = allocation.variations.find do |var|
+        var.shard_range.shard_in_range?(shard)
+      end
+
+      assigned_variation_value_to_log = nil
+      unless assigned_variation.nil?
+        assigned_variation_value_to_log = assigned_variation.value
+        unless expected_variation_type.nil?
+          variation_is_expected_type = EppoClient::VariationType.expected_type?(
+            assigned_variation, expected_variation_type
+          )
+          return nil unless variation_is_expected_type
+        end
+      end
 
       assignment_event = {
-        "experiment": flag_or_experiment_key,
-        "variation": assigned_variation,
+        "allocation": matched_rule.allocation_key,
+        "experiment": "#{flag_key}-#{matched_rule.allocation_key}",
+        "featureFlag": flag_key,
+        "variation": assigned_variation_value_to_log,
         "subject": subject_key,
         "timestamp": Time.now.utc.iso8601,
         "subjectAttributes": subject_attributes
@@ -76,7 +198,7 @@ module EppoClient
       begin
         @assignment_logger.log_assignment(assignment_event)
       rescue EppoClient::AssignmentLoggerError => e
-        # This error means that log_assignment was not set up. This is okay to ignore.
+        # Error means log_assignment was not set up. This is okay to ignore.
       rescue StandardError => e
         logger.error("[Eppo SDK] Error logging assignment event: #{e}")
       end
@@ -89,14 +211,28 @@ module EppoClient
       @poller.stop
     end
 
+    # rubocop:disable Metrics/MethodLength
     def get_subject_variation_override(experiment_config, subject)
       subject_hash = Digest::MD5.hexdigest(subject.to_s)
-      experiment_config&.overrides && experiment_config.overrides[subject_hash]
+      if experiment_config&.overrides &&
+         experiment_config.overrides[subject_hash] &&
+         experiment_config.typed_overrides[subject_hash]
+        EppoClient::VariationDto.new(
+          'override',
+          experiment_config.overrides[subject_hash],
+          experiment_config.typed_overrides[subject_hash],
+          EppoClient::ShardRange.new(0, 1000)
+        )
+      end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    def in_experiment_sample?(subject, experiment_key, subject_shards, percent_exposure)
-      shard = EppoClient.get_shard("exposure-#{subject}-#{experiment_key}", subject_shards)
+    def in_experiment_sample?(subject, experiment_key, subject_shards,
+                              percent_exposure)
+      shard = EppoClient.get_shard("exposure-#{subject}-#{experiment_key}",
+                                   subject_shards)
       shard <= percent_exposure * subject_shards
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/configuration_requestor.rb

@@ -6,11 +6,12 @@ require 'constants'
 module EppoClient
   # A class for the variation object
   class VariationDto
-    attr_reader :name, :value, :shard_range
+    attr_reader :name, :value, :typed_value, :shard_range
 
-    def initialize(name, value, shard_range)
+    def initialize(name, value, typed_value, shard_range)
       @name = name
       @value = value
+      @typed_value = typed_value
       @shard_range = shard_range
     end
   end
@@ -27,13 +28,15 @@ module EppoClient
 
   # A class for the experiment configuration object
   class ExperimentConfigurationDto
-    attr_reader :subject_shards, :enabled, :name, :overrides, :rules, :allocations
+    attr_reader :subject_shards, :enabled, :name, :overrides,
+                :typed_overrides, :rules, :allocations
 
     def initialize(exp_config)
       @subject_shards = exp_config['subjectShards']
       @enabled = exp_config['enabled']
       @name = exp_config['name'] || nil
       @overrides = exp_config['overrides'] || {}
+      @typed_overrides = exp_config['typedOverrides'] || {}
       @rules = exp_config['rules'] || []
       @allocations = exp_config['allocations']
     end
@@ -41,7 +44,6 @@ module EppoClient
 
   # A class for getting exp configs from the local cache or API
   class ExperimentConfigurationRequestor
-
     attr_reader :config_store
 
     def initialize(http_client, config_store)
@@ -50,7 +52,8 @@ module EppoClient
     end
 
     def get_configuration(experiment_key)
-      @http_client.is_unauthorized && raise(EppoClient::UnauthorizedError, 'please check your API key')
+      @http_client.is_unauthorized && raise(EppoClient::UnauthorizedError,
+                                            'please check your API key')
       @config_store.retrieve_configuration(experiment_key)
     end
 
@@ -58,16 +61,19 @@ module EppoClient
     def fetch_and_store_configurations
       configs = {}
       begin
-        exp_configs = @http_client.get(EppoClient::RAC_ENDPOINT).fetch('flags', {})
+        exp_configs = @http_client.get(EppoClient::RAC_ENDPOINT).fetch(
+          'flags', {}
+        )
+        # rubocop: disable Metrics/BlockLength
         exp_configs.each do |exp_key, exp_config|
           exp_config['allocations'].each do |k, v|
             exp_config['allocations'][k] = EppoClient::AllocationDto.new(
               v['percentExposure'],
               v['variations'].map do |var|
                 EppoClient::VariationDto.new(
-                  var['name'],
-                  var['value'],
-                  EppoClient::ShardRange.new(var['shardRange']['start'], var['shardRange']['end'])
+                  var['name'], var['value'], var['typedValue'],
+                  EppoClient::ShardRange.new(var['shardRange']['start'],
+                                             var['shardRange']['end'])
                 )
               end
             )
@@ -84,11 +90,16 @@ module EppoClient
               allocation_key: rule['allocationKey']
             )
           end
-          configs[exp_key] = EppoClient::ExperimentConfigurationDto.new(exp_config)
+          configs[exp_key] = EppoClient::ExperimentConfigurationDto.new(
+            exp_config
+          )
         end
+        # rubocop: enable Metrics/BlockLength
         @config_store.assign_configurations(configs)
       rescue EppoClient::HttpRequestError => e
-        Logger.new($stdout).error("Error retrieving assignment configurations: #{e}")
+        Logger.new($stdout).error(
+          "Error retrieving assignment configurations: #{e}"
+        )
       end
       configs
     end

data/lib/eppo_client.rb

@@ -29,21 +29,28 @@ module EppoClient
   end
   # rubocop:enable Metrics/MethodLength
 
-  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
   def init(config)
     config.validate
-    sdk_version = ParseGemspec::Specification.load('eppo-server-sdk.gemspec').to_hash_object[:version]
+    sdk_version = ParseGemspec::Specification.load(
+      'eppo-server-sdk.gemspec'
+    ).to_hash_object[:version]
     sdk_params = EppoClient::SdkParams.new(config.api_key, 'ruby', sdk_version)
-    http_client = EppoClient::HttpClient.new(config.base_url, sdk_params.formatted)
-    config_store = EppoClient::ConfigurationStore.new(EppoClient::MAX_CACHE_ENTRIES)
+    http_client = EppoClient::HttpClient.new(config.base_url,
+                                             sdk_params.formatted)
+    config_store = EppoClient::ConfigurationStore.new(
+      EppoClient::MAX_CACHE_ENTRIES
+    )
     config_store.lock.with_write_lock do
       EppoClient.initialize_client(
-        EppoClient::ExperimentConfigurationRequestor.new(http_client, config_store),
+        EppoClient::ExperimentConfigurationRequestor.new(
+          http_client, config_store
+        ),
         config.assignment_logger
       )
     end
   end
-  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
   module_function :init, :initialize_client
 end

data/lib/rules.rb

@@ -47,7 +47,7 @@ module EppoClient
     true
   end
 
-  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
   def evaluate_condition(subject_attributes, condition)
     subject_value = subject_attributes[condition.attribute]
     return false if subject_value.nil?
@@ -63,7 +63,7 @@ module EppoClient
       subject_value.is_a?(Numeric) && evaluate_numeric_condition(subject_value, condition)
     end
   end
-  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
   # rubocop:disable Metrics/MethodLength
   def evaluate_numeric_condition(subject_value, condition)
@@ -82,5 +82,6 @@ module EppoClient
   end
   # rubocop:enable Metrics/MethodLength
 
-  module_function :find_matching_rule, :matches_rule, :evaluate_condition, :evaluate_numeric_condition
+  module_function :find_matching_rule, :matches_rule, :evaluate_condition,
+                  :evaluate_numeric_condition
 end

data/lib/shard.rb

@@ -18,6 +18,8 @@ module EppoClient
     end
   end
 
+  module_function
+
   def get_shard(input, subject_shards)
     hash_output = Digest::MD5.hexdigest(input)
     # get the first 4 bytes of the md5 hex string and parse it using base 16
@@ -25,6 +27,4 @@ module EppoClient
     int_from_hash = hash_output[0...8].to_i(16)
     int_from_hash % subject_shards
   end
-
-  module_function :get_shard
 end

data/lib/validation.rb

@@ -4,9 +4,11 @@ require 'custom_errors'
 
 # The helper module to validate keys
 module EppoClient
+  module_function
+
   def validate_not_blank(field_name, field_value)
-    (field_value.nil? || field_value == '') && raise(EppoClient::InvalidValueError, "#{field_name} cannot be blank")
+    (field_value.nil? || field_value == '') && raise(
+      EppoClient::InvalidValueError, "#{field_name} cannot be blank"
+    )
   end
-
-  module_function :validate_not_blank
 end

data/lib/variation_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module EppoClient
+  # The class for configuring the Eppo client singleton
+  module VariationType
+    STRING_TYPE = 'string'
+    NUMERIC_TYPE = 'numeric'
+    BOOLEAN_TYPE = 'boolean'
+    JSON_TYPE = 'json'
+
+    module_function
+
+    # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+    def expected_type?(assigned_variation, expected_variation_type)
+      case expected_variation_type
+      when STRING_TYPE
+        assigned_variation.typed_value.is_a?(String)
+      when NUMERIC_TYPE
+        assigned_variation.typed_value.is_a?(Numeric)
+      when BOOLEAN_TYPE
+        assigned_variation.typed_value.is_a?(TrueClass) ||
+          assigned_variation.typed_value.is_a?(FalseClass)
+      when JSON_TYPE
+        begin
+          parsed_json = JSON.parse(assigned_variation.value)
+          JSON.dump(assigned_variation.typed_value)
+          parsed_json == assigned_variation.typed_value
+        rescue JSON::JSONError
+          false
+        end
+      else
+        false
+      end
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eppo-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Eppo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -136,14 +136,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: 0.82.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: 0.82.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +184,7 @@ files:
 - lib/rules.rb
 - lib/shard.rb
 - lib/validation.rb
+- lib/variation_type.rb
 homepage: https://github.com/Eppo-exp/ruby-sdk
 licenses:
 - MIT
@@ -201,14 +202,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.0.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Eppo SDK for Ruby