eppo-server-sdk 0.2.5 → 3.0.0

data/lib/eppo_client/config.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require_relative 'validation'
-require_relative 'assignment_logger'
+require_relative "validation"
+require_relative "assignment_logger"
 
 module EppoClient
   # The class for configuring the Eppo client singleton
   class Config
     attr_reader :api_key, :assignment_logger, :base_url
 
-    def initialize(api_key, assignment_logger: AssignmentLogger.new, base_url: 'https://fscdn.eppo.cloud/api')
+    def initialize(api_key, assignment_logger: AssignmentLogger.new, base_url: EppoClient::Core::DEFAULT_BASE_URL)
       @api_key = api_key
       @assignment_logger = assignment_logger
       @base_url = base_url
     end
 
     def validate
-      EppoClient.validate_not_blank('api_key', @api_key)
+      EppoClient.validate_not_blank("api_key", @api_key)
     end
 
     # Hide instance variables (specifically api_key) from logs

data/lib/eppo_client/custom_errors.rb

@@ -8,23 +8,6 @@ module EppoClient
     end
   end
 
-  # A custom error class for unauthorized requests
-  class UnauthorizedError < StandardError
-    def initialize(message)
-      super("Unauthorized: #{message}")
-    end
-  end
-
-  # A custom error class for HTTP requests
-  class HttpRequestError < StandardError
-    attr_reader :status_code
-
-    def initialize(message, status_code)
-      @status_code = status_code
-      super("HttpRequestError: #{message}")
-    end
-  end
-
   # A custom error class for invalid values
   class InvalidValueError < StandardError
     def initialize(message)

data/lib/eppo_client/validation.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'custom_errors'
+require_relative "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(
+    (field_value.nil? || field_value == "") && raise(
       EppoClient::InvalidValueError, "#{field_name} cannot be blank"
     )
   end

data/lib/eppo_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EppoClient
-  VERSION = '0.2.5'
+  VERSION = "3.0.0"
 end

data/lib/eppo_client.rb

@@ -1,53 +1,15 @@
 # frozen_string_literal: true
 
-require_relative 'eppo_client/assignment_logger'
-require_relative 'eppo_client/http_client'
-require_relative 'eppo_client/poller'
-require_relative 'eppo_client/config'
-require_relative 'eppo_client/client'
-require_relative 'eppo_client/constants'
-require_relative 'eppo_client/configuration_requestor'
-require_relative 'eppo_client/configuration_store'
-require_relative 'eppo_client/version'
+require_relative "eppo_client/client"
+require_relative "eppo_client/version"
 
-# This module scopes all the client SDK's classes and functions
+# EppoClient is the main module for initializing the Eppo client.
+# It provides a method to initialize the client with a given configuration.
 module EppoClient
-  # rubocop:disable Metrics/MethodLength
-  def initialize_client(config_requestor, assignment_logger)
-    client = EppoClient::Client.instance
-    !client.poller.nil? && client.shutdown
-    client.config_requestor = config_requestor
-    client.assignment_logger = assignment_logger
-    client.poller = EppoClient::Poller.new(
-      EppoClient::POLL_INTERVAL_MILLIS,
-      EppoClient::POLL_JITTER_MILLIS,
-      proc { client.config_requestor.fetch_and_store_configurations }
-    )
-    client.poller.start
-    client
-  end
-  # rubocop:enable Metrics/MethodLength
-
-  # rubocop:disable Metrics/MethodLength
   def init(config)
-    config.validate
-    sdk_params = EppoClient::SdkParams.new(config.api_key, 'ruby',
-                                           EppoClient::VERSION)
-    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
-        ),
-        config.assignment_logger
-      )
-    end
+    client = EppoClient::Client.instance
+    client.init(config)
   end
-  # rubocop:enable Metrics/MethodLength
 
-  module_function :init, :initialize_client
+  module_function :init
 end

data/sig/eppo_server_sdk.rbs

@@ -0,0 +1,96 @@
+# EppoClient is the main module for initializing the Eppo client.
+# It provides a method to initialize the client with a given configuration.
+module EppoClient
+  def self.init: (Config config) -> void
+
+  # The base assignment logger class to override
+  class AssignmentLogger
+    def log_assignment: (untyped assignment_event) -> void
+
+    def log_bandit_action: (untyped assignment_event) -> void
+  end
+
+  # The main client singleton
+  class Client
+    @assignment_logger: AssignmentLogger
+    @core: Core::Client
+
+    include Singleton
+
+    attr_accessor assignment_logger: AssignmentLogger
+
+    def self.instance: () -> Client
+
+    def init: (Config config) -> void
+
+    def shutdown: () -> void
+
+    def get_string_assignment: (String flag_key, String subject_key, Hash[String, untyped] subject_attributes, String default_value) -> String
+
+    def get_numeric_assignment: (String flag_key, String subject_key, Hash[String, untyped] subject_attributes, Numeric default_value) -> Numeric
+
+    def get_integer_assignment: (String flag_key, String subject_key, Hash[String, untyped] subject_attributes, Integer default_value) -> Integer
+
+    def get_boolean_assignment: (String flag_key, String subject_key, Hash[String, untyped] subject_attributes, bool default_value) -> bool
+
+    def get_json_assignment: (String flag_key, String subject_key, Hash[String, untyped] subject_attributes, Object default_value) -> Object
+
+    def get_bandit_action: (String flag_key, String subject_key, Hash[String, untyped] subject_attributes, Hash[String, untyped] actions, String default_variation) -> { variation: untyped, action: untyped }
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def get_assignment_inner: (untyped flag_key, String subject_key, untyped subject_attributes, untyped expected_type, untyped default_value) -> untyped
+
+    def log_assignment: (untyped event) -> void
+
+    def log_bandit_action: (untyped event) -> void
+
+    def enrich_event_metadata: (untyped event) -> void
+
+    def coerce_context_attributes: (untyped attributes) -> untyped
+  end
+
+  # The class for configuring the Eppo client singleton
+  class Config
+    @api_key: String
+    @assignment_logger: AssignmentLogger
+    @base_url: String
+
+    attr_reader api_key: String
+    attr_reader assignment_logger: AssignmentLogger
+    attr_reader base_url: String
+
+    def initialize: (String api_key, ?assignment_logger: AssignmentLogger, ?base_url: String) -> void
+
+    def validate: () -> void
+
+    # Hide instance variables (specifically api_key) from logs
+    def inspect: () -> ::String
+  end
+
+  # A custom error class for AssignmentLogger
+  class AssignmentLoggerError < StandardError
+    def initialize: (String message) -> void
+  end
+
+  # A custom error class for invalid values
+  class InvalidValueError < StandardError
+    def initialize: (String message) -> void
+  end
+
+  def self?.validate_not_blank: (String field_name, String field_value) -> void
+
+  VERSION: String
+end
+
+# Exposed from Rust
+module EppoClient::Core
+  DEFAULT_BASE_URL: String
+  class Client
+    def self.new: (untyped config) -> Client
+    def shutdown: () -> void
+    def get_assignment: (String flag_key, String subject_key, untyped subject_attributes, String expected_type) -> untyped
+    def get_bandit_action: (String flag_key, String subject_key, untyped attributes, untyped actions, String default_variation) -> untyped
+  end
+end

metadata

@@ -1,171 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: eppo-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Eppo
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.9
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
-- !ruby/object:Gem::Dependency
-  name: faraday-retry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.82.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.82.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.18.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.18.1
-description: 
-email: eppo-team@geteppo.com
+date: 2024-07-24 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- eppo-team@geteppo.com
 executables: []
-extensions: []
+extensions:
+- ext/eppo_client/Cargo.toml
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Cargo.lock
+- Cargo.toml
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- ext/eppo_client/Cargo.toml
+- ext/eppo_client/build.rs
+- ext/eppo_client/extconf.rb
+- ext/eppo_client/src/client.rs
+- ext/eppo_client/src/lib.rs
 - lib/eppo_client.rb
 - lib/eppo_client/assignment_logger.rb
 - lib/eppo_client/client.rb
 - lib/eppo_client/config.rb
-- lib/eppo_client/configuration_requestor.rb
-- lib/eppo_client/configuration_store.rb
-- lib/eppo_client/constants.rb
 - lib/eppo_client/custom_errors.rb
-- lib/eppo_client/http_client.rb
-- lib/eppo_client/lru_cache.rb
-- lib/eppo_client/poller.rb
-- lib/eppo_client/rules.rb
-- lib/eppo_client/shard.rb
 - lib/eppo_client/validation.rb
-- lib/eppo_client/variation_type.rb
 - lib/eppo_client/version.rb
+- sig/eppo_server_sdk.rbs
 homepage: https://github.com/Eppo-exp/ruby-sdk
 licenses:
 - MIT
@@ -175,7 +49,7 @@ metadata:
   homepage_uri: https://geteppo.com/
   source_code_uri: https://github.com/Eppo-exp/ruby-sdk
   wiki_uri: https://github.com/Eppo-exp/ruby-sdk/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,15 +57,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.6
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.11
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Eppo SDK for Ruby
 test_files: []

data/lib/eppo_client/configuration_requestor.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'custom_errors'
-require_relative 'constants'
-
-module EppoClient
-  # A class for the variation object
-  class VariationDto
-    attr_reader :name, :value, :typed_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
-
-  # A class for the allocation object
-  class AllocationDto
-    attr_reader :percent_exposure, :variations
-
-    def initialize(percent_exposure, variations)
-      @percent_exposure = percent_exposure
-      @variations = variations
-    end
-  end
-
-  # A class for the experiment configuration object
-  class ExperimentConfigurationDto
-    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
-  end
-
-  # A class for getting exp configs from the local cache or API
-  class ExperimentConfigurationRequestor
-    attr_reader :config_store
-
-    def initialize(http_client, config_store)
-      @http_client = http_client
-      @config_store = config_store
-    end
-
-    def get_configuration(experiment_key)
-      @http_client.is_unauthorized && raise(EppoClient::UnauthorizedError,
-                                            'please check your API key')
-      @config_store.retrieve_configuration(experiment_key)
-    end
-
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    def fetch_and_store_configurations
-      configs = {}
-      begin
-        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'], var['typedValue'],
-                  EppoClient::ShardRange.new(var['shardRange']['start'],
-                                             var['shardRange']['end'])
-                )
-              end
-            )
-          end
-          exp_config['rules'] = exp_config['rules'].map do |rule|
-            EppoClient::Rule.new(
-              conditions: rule['conditions'].map do |condition|
-                EppoClient::Condition.new(
-                  value: condition['value'],
-                  operator: condition['operator'],
-                  attribute: condition['attribute']
-                )
-              end,
-              allocation_key: rule['allocationKey']
-            )
-          end
-          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}"
-        )
-      end
-      configs
-    end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-  end
-end

data/lib/eppo_client/configuration_store.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'concurrent/atomic/read_write_lock'
-
-require_relative 'lru_cache'
-
-module EppoClient
-  # A thread safe store for the configurations to ensure that retrievals pull from a single source of truth
-  class ConfigurationStore
-    attr_reader :lock, :cache
-
-    def initialize(max_size)
-      @cache = EppoClient::LRUCache.new(max_size)
-      @lock = Concurrent::ReadWriteLock.new
-    end
-
-    def retrieve_configuration(key)
-      @lock.with_read_lock { @cache[key] }
-    end
-
-    def assign_configurations(configs)
-      @lock.with_write_lock do
-        # Create a temporary new cache and populate it.
-        new_cache = EppoClient::LRUCache.new(@cache.size)
-        configs.each do |key, config|
-          new_cache[key] = config
-        end
-
-        # Replace the old cache with the new one.
-        # Performs an atomic swap.
-        @cache = new_cache
-      end
-    end
-  end
-end

data/lib/eppo_client/constants.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-module EppoClient
-  # default level for logging
-  DEFAULT_LOGGER_LEVEL = Logger::INFO
-
-  # configuration cache constants
-  MAX_CACHE_ENTRIES = 1000 # arbitrary; the caching library requires a max limit
-
-  # poller constants
-  SECOND_MILLIS = 1000
-  MINUTE_MILLIS = 60 * SECOND_MILLIS
-  POLL_JITTER_MILLIS = 30 * SECOND_MILLIS
-  POLL_INTERVAL_MILLIS = 5 * MINUTE_MILLIS
-
-  # the configs endpoint
-  RAC_ENDPOINT = 'randomized_assignment/v3/config'
-end

data/lib/eppo_client/http_client.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-require 'faraday/retry'
-
-require_relative 'custom_errors'
-
-REQUEST_TIMEOUT_SECONDS = 2
-# This applies only to failed DNS lookups and connection timeouts,
-# never to requests where data has made it to the server.
-MAX_RETRIES = 3
-
-module EppoClient
-  # The SDK params object
-  class SdkParams
-    attr_reader :api_key, :sdk_name, :sdk_version
-
-    def initialize(api_key, sdk_name, sdk_version)
-      @api_key = api_key
-      @sdk_name = sdk_name
-      @sdk_version = sdk_version
-    end
-
-    # attributes are camelCase because that's what the backend endpoint expects
-    def formatted
-      {
-        'apiKey' => api_key,
-        'sdkName' => sdk_name,
-        'sdkVersion' => sdk_version
-      }
-    end
-
-    # Hide instance variables (specifically api_key) from logs
-    def inspect
-      "#<EppoClient::SdkParams:#{object_id}>"
-    end
-  end
-
-  # The http request client with retry/timeout behavior
-  class HttpClient
-    attr_reader :is_unauthorized
-
-    @retry_options = {
-      max: MAX_RETRIES,
-      interval: 0.05,
-      interval_randomness: 0.5,
-      backoff_factor: 2,
-      exceptions: ['Timeout::Error']
-    }
-
-    def initialize(base_url, sdk_params)
-      @base_url = base_url
-      @sdk_params = sdk_params
-      @is_unauthorized = false
-    end
-
-    def get(resource)
-      conn = Faraday::Connection.new(@base_url, params: @sdk_params) do |f|
-        f.request :retry, @retry_options
-      end
-      conn.options.timeout = REQUEST_TIMEOUT_SECONDS
-      response = conn.get(resource)
-      @is_unauthorized = response.status == 401
-      raise get_http_error(response.status, resource) if response.status != 200
-
-      JSON.parse(response.body)
-    end
-
-    private
-
-    def get_http_error(status_code, resource)
-      EppoClient::HttpRequestError.new("HTTP #{status_code} error while requesting resource #{resource}", status_code)
-    end
-  end
-end