eppo-server-sdk 0.3.0 → 3.1.0

metadata

@@ -1,191 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: eppo-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Eppo
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-07-01 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: semver2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.2
-- !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
+date: 2024-08-16 00:00:00.000000000 Z
+dependencies: []
 description: 
-email: eppo-team@geteppo.com
+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
@@ -203,14 +57,14 @@ 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
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Eppo SDK for Ruby

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

data/lib/eppo_client/lru_cache.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module EppoClient
-  # The LRU cache relies on the fact that Ruby's Hash class maintains insertion order. So deleting
-  # and re-inserting a key-value pair on access moves the key to the last position. When an
-  # entry is added and the cache is full, the first entry is removed.
-  class LRUCache
-    attr_reader :cache, :size
-
-    # Creates a new LRUCache that can hold +size+ entries.
-    def initialize(size)
-      @size = size
-      @cache = {}
-    end
-
-    # Returns the stored value for +key+ or +nil+ if no value was stored under the key.
-    def [](key)
-      (val = @cache.delete(key)).nil? ? nil : @cache[key] = val
-    end
-
-    # Stores the +value+ under the +key+.
-    def []=(key, value)
-      @cache.delete(key)
-      @cache[key] = value
-      @cache.shift if @cache.length > @size
-    end
-  end
-end

data/lib/eppo_client/poller.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'concurrent/atom'
-
-# The poller
-module EppoClient
-  # The poller class invokes a callback and waits on repeat on a separate thread
-  class Poller
-    def initialize(interval_millis, jitter_millis, callback)
-      @jitter_millis = jitter_millis
-      @interval = interval_millis
-      @stopped = Concurrent::Atom.new(false)
-      @callback = callback
-      @thread = nil
-    end
-
-    def start
-      @stopped.reset(false)
-      @thread = Thread.new { poll }
-    end
-
-    def stop
-      @stopped.reset(true)
-      Thread.kill(@thread)
-    end
-
-    def stopped?
-      @stopped.value
-    end
-
-    def poll
-      until stopped?
-        begin
-          @callback.call
-        rescue StandardError => e
-          Logger.new($stdout).error("Unexpected error running poll task: #{e}")
-          break
-        end
-        _wait_for_interval
-      end
-    end
-
-    def _wait_for_interval
-      interval_with_jitter = @interval - rand(@jitter_millis)
-      sleep interval_with_jitter / 1000
-    end
-  end
-end

data/lib/eppo_client/rules.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-require 'semver'
-
-# The helper module for rules
-module EppoClient
-  module OperatorType
-    MATCHES = 'MATCHES'
-    GTE = 'GTE'
-    GT = 'GT'
-    LTE = 'LTE'
-    LT = 'LT'
-    ONE_OF = 'ONE_OF'
-    NOT_ONE_OF = 'NOT_ONE_OF'
-  end
-
-  # A class for the Condition object
-  class Condition
-    attr_accessor :operator, :attribute, :value
-
-    def initialize(operator:, attribute:, value:)
-      @operator = operator
-      @attribute = attribute
-      @value = value
-    end
-  end
-
-  # A class for the Rule object
-  class Rule
-    attr_accessor :allocation_key, :conditions
-
-    def initialize(allocation_key:, conditions:)
-      @allocation_key = allocation_key
-      @conditions = conditions
-    end
-  end
-
-  def find_matching_rule(subject_attributes, rules)
-    rules.each do |rule|
-      return rule if matches_rule(subject_attributes, rule)
-    end
-    nil
-  end
-
-  def matches_rule(subject_attributes, rule)
-    rule.conditions.each do |condition|
-      return false unless evaluate_condition(subject_attributes, condition)
-    end
-    true
-  end
-
-  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-  def evaluate_condition(subject_attributes, condition)
-    subject_value = subject_attributes[condition.attribute]
-    return false if subject_value.nil?
-
-    case condition.operator
-    when OperatorType::MATCHES
-      !!(Regexp.new(condition.value) =~ subject_value.to_s)
-    when OperatorType::ONE_OF
-      condition.value.map(&:downcase).include?(subject_value.to_s.downcase)
-    when OperatorType::NOT_ONE_OF
-      !condition.value.map(&:downcase).include?(subject_value.to_s.downcase)
-    else
-      # Numeric operator: value could be numeric or semver.
-      if subject_value.is_a?(Numeric)
-        evaluate_numeric_condition(subject_value, condition)
-      elsif valid_semver?(subject_value)
-        compare_semver(subject_value, condition.value, condition.operator)
-      end
-    end
-  end
-  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-  # rubocop:disable Metrics/MethodLength
-  def evaluate_numeric_condition(subject_value, condition)
-    case condition.operator
-    when OperatorType::GT
-      subject_value > condition.value
-    when OperatorType::GTE
-      subject_value >= condition.value
-    when OperatorType::LT
-      subject_value < condition.value
-    when OperatorType::LTE
-      subject_value <= condition.value
-    else
-      false
-    end
-  end
-  # rubocop:enable Metrics/MethodLength
-
-  # rubocop:disable Metrics/MethodLength
-  def compare_semver(attribute_value, condition_value, operator)
-    unless valid_semver?(attribute_value) && valid_semver?(condition_value)
-      return false
-    end
-
-    case operator
-    when OperatorType::GT
-      SemVer.parse(attribute_value) > SemVer.parse(condition_value)
-    when OperatorType::GTE
-      SemVer.parse(attribute_value) >= SemVer.parse(condition_value)
-    when OperatorType::LT
-      SemVer.parse(attribute_value) < SemVer.parse(condition_value)
-    when OperatorType::LTE
-      SemVer.parse(attribute_value) <= SemVer.parse(condition_value)
-    else
-      false
-    end
-  end
-  # rubocop:enable Metrics/MethodLength
-
-  def valid_semver?(string)
-    !SemVer.parse(string).nil?
-  end
-
-  module_function :find_matching_rule, :matches_rule, :evaluate_condition,
-                  :evaluate_numeric_condition, :valid_semver?, :compare_semver
-end

data/lib/eppo_client/shard.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-# The helper module for shard logic
-module EppoClient
-  # A class for checking if a shard is in a range
-  class ShardRange
-    attr_reader :start, :end
-
-    def initialize(range_start, range_end)
-      @start = range_start
-      @end = range_end
-    end
-
-    def shard_in_range?(shard)
-      shard >= @start && shard < @end
-    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
-    # (8 hex characters represent 4 bytes, e.g. 0xffffffff represents the max 4-byte integer)
-    int_from_hash = hash_output[0...8].to_i(16)
-    int_from_hash % subject_shards
-  end
-end