statsig 1.16.2 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 980b704314aa26f9167bcf3fa86ba20d8ee0092232118ce4c43c9df53b839e90
-  data.tar.gz: 7b47108f78e72f85b1ad1386ca5e45b080178f8c6ab4e51d390b8778ad941a67
+  metadata.gz: 5b81f929cdedefaee6f57cb2b0f7aec05bbfd28cf6b4f273fc4fb3bbcf46858f
+  data.tar.gz: 5caa719d8a301cbcd95d68f9bc5802a89f0691600c7b5883bfdbfcc8fa21bb8f
 SHA512:
-  metadata.gz: a511d07303530dee09538427b04dd0932695a54b4241c6b1c3989c58dff3b1c3ec74a28bdbe89e7849aaebf1f489c7c68de34f0008d3a8891103e0f8b3dec2ea
-  data.tar.gz: '0694f51e7735bc6ce83f8244b7a6bcccf70d822e28b0a7051326973351eaa8db98daa1637146ada8c467b8908e94c1239aecf5fc0b703462a1b01eac94534b3b'
+  metadata.gz: 9372cd1b25a0b91054d6315df027833cd2377e51e1f76385dd260fe9a17665da33330c357cf63756f6bc6701e51f76a7d5b81aa99d57a96bfeee807c575c3b19
+  data.tar.gz: 5dd1c6ad849e20c0ed15b451371a78e971f6da4ed83f7bf7f79eb5db65c88ba27f1b8e9da991587d8a46cbd2086d0b30692bbb81e48283e758b84d679a63eb3a

data/lib/client_initialize_helpers.rb

@@ -1,3 +1,4 @@
+# typed: true
 $empty_eval_result = {
   :gate_value => false,
   :json_value => {},

data/lib/config_result.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Statsig
   class ConfigResult
     attr_accessor :name

data/lib/dynamic_config.rb

@@ -1,19 +1,50 @@
+# typed: false
+
+require 'sorbet-runtime'
+
+##
+# Contains the current experiment/dynamic config values from Statsig
+#
+#  Dynamic Config Documentation: https://docs.statsig.com/dynamic-config
+#
+#  Experiments Documentation: https://docs.statsig.com/experiments-plus
 class DynamicConfig
+  extend T::Sig
+
+  sig { returns(String) }
   attr_accessor :name
+
+  sig { returns(T::Hash[String, T.untyped]) }
   attr_accessor :value
+
+  sig { returns(String) }
   attr_accessor :rule_id
 
+  sig { params(name: String, value: T::Hash[String, T.untyped], rule_id: String).void }
   def initialize(name, value = {}, rule_id = '')
     @name = name
     @value = value
     @rule_id = rule_id
   end
 
+  sig { params(index: String, default_value: T.untyped).returns(T.untyped) }
+  ##
+  # Get the value for the given key (index), falling back to the default_value if it cannot be found.
+  #
+  # @param index The name of parameter being fetched
+  # @param default_value The fallback value if the name cannot be found
   def get(index, default_value)
     return default_value if @value.nil? || !@value.key?(index)
     @value[index]
   end
 
+  sig { params(index: String, default_value: T.untyped).returns(T.untyped) }
+  ##
+  # Get the value for the given key (index), falling back to the default_value if it cannot be found
+  # or is found to have a different type from the default_value.
+  #
+  # @param index The name of parameter being fetched
+  # @param default_value The fallback value if the name cannot be found
   def get_typed(index, default_value)
     return default_value if @value.nil? || !@value.key?(index)
     return default_value if @value[index].class != default_value.class and default_value.class != TrueClass and default_value.class != FalseClass

data/lib/evaluation_details.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Statsig
 
   module EvaluationReason

data/lib/evaluation_helpers.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'time'
 
 module EvaluationHelpers

data/lib/evaluator.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'config_result'
 require 'country_lookup'
 require 'digest'
@@ -378,14 +379,14 @@ module Statsig
       user_custom = user_lookup_table['custom']
       if user_custom.is_a?(Hash)
         user_custom.each do |key, value|
-          return value if key.downcase.casecmp?(field.downcase) && !value.nil?
+          return value if key.to_s.downcase.casecmp?(field.downcase) && !value.nil?
         end
       end
 
       private_attributes = user_lookup_table['privateAttributes']
       if private_attributes.is_a?(Hash)
         private_attributes.each do |key, value|
-          return value if key.downcase.casecmp?(field.downcase) && !value.nil?
+          return value if key.to_s.downcase.casecmp?(field.downcase) && !value.nil?
         end
       end
 
@@ -397,7 +398,7 @@ module Statsig
       field = field.downcase
       return nil unless user.statsig_environment.is_a? Hash
       user.statsig_environment.each do |key, value|
-        return value if key.downcase == (field)
+        return value if key.to_s.downcase == (field)
       end
       nil
     end

data/lib/id_list.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Statsig
   class IDList
     attr_accessor :name

data/lib/interfaces/data_store.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Statsig
   module Interfaces
     class IDataStore

data/lib/layer.rb

@@ -1,7 +1,22 @@
+# typed: false
+
+##
+# Contains the current values from Statsig.
+# Will contain layer default values for all shared parameters in that layer.
+# If a parameter is in an active experiment, and the current user is allocated to that experiment,
+# those parameters will be updated to reflect the experiment values not the layer defaults.
+#
+# Layers Documentation: https://docs.statsig.com/layers
 class Layer
+  extend T::Sig
+
+  sig { returns(String) }
   attr_accessor :name
+
+  sig { returns(String) }
   attr_accessor :rule_id
 
+  sig { params(name: String, value: T::Hash[String, T.untyped], rule_id: String, exposure_log_func: T.any(Method, Proc, NilClass)).void }
   def initialize(name, value = {}, rule_id = '', exposure_log_func = nil)
     @name = name
     @value = value
@@ -9,6 +24,12 @@ class Layer
     @exposure_log_func = exposure_log_func
   end
 
+  sig { params(index: String, default_value: T.untyped).returns(T.untyped) }
+  ##
+  # Get the value for the given key (index), falling back to the default_value if it cannot be found.
+  #
+  # @param index The name of parameter being fetched
+  # @param default_value The fallback value if the name cannot be found
   def get(index, default_value)
     return default_value if @value.nil? || !@value.key?(index)
 
@@ -19,6 +40,13 @@ class Layer
     @value[index]
   end
 
+  sig { params(index: String, default_value: T.untyped).returns(T.untyped) }
+  ##
+  # Get the value for the given key (index), falling back to the default_value if it cannot be found
+  # or is found to have a different type from the default_value.
+  #
+  # @param index The name of parameter being fetched
+  # @param default_value The fallback value if the name cannot be found
   def get_typed(index, default_value)
     return default_value if @value.nil? || !@value.key?(index)
     return default_value if @value[index].class != default_value.class and default_value.class != TrueClass and default_value.class != FalseClass

data/lib/network.rb

@@ -1,11 +1,18 @@
+# typed: true
+
 require 'http'
 require 'json'
 require 'securerandom'
+require 'sorbet-runtime'
 
 $retry_codes = [408, 500, 502, 503, 504, 522, 524, 599]
 
 module Statsig
   class Network
+    extend T::Sig
+
+    sig { params(server_secret: String, api: String, local_mode: T::Boolean, backoff_mult: Integer).void }
+
     def initialize(server_secret, api, local_mode, backoff_mult = 10)
       super()
       unless api.end_with?('/')
@@ -18,6 +25,10 @@ module Statsig
       @session_id = SecureRandom.uuid
     end
 
+
+    sig { params(endpoint: String, body: String, retries: Integer, backoff: Integer)
+      .returns([T.any(HTTP::Response, NilClass), T.any(StandardError, NilClass)]) }
+
     def post_helper(endpoint, body, retries = 0, backoff = 1)
       if @local_mode
         return nil, nil

data/lib/spec_store.rb

@@ -1,7 +1,9 @@
+# typed: false
 require 'net/http'
 require 'uri'
 require 'evaluation_details'
 require 'id_list'
+require 'concurrent-ruby'
 
 module Statsig
   class SpecStore
@@ -30,6 +32,12 @@ module Statsig
         :experiment_to_layer => {}
       }
 
+      @id_list_thread_pool = Concurrent::FixedThreadPool.new(
+        options.idlist_threadpool_size,
+        max_queue: 100,
+        fallback_policy: :discard,
+      )
+
       unless @options.bootstrap_values.nil?
         begin
           if !@options.data_store.nil?
@@ -62,6 +70,8 @@ module Statsig
     def shutdown
       @config_sync_thread&.exit
       @id_lists_sync_thread&.exit
+      @id_list_thread_pool.shutdown
+      @id_list_thread_pool.wait_for_termination(timeout = 3)
       unless @options.data_store.nil?
         @options.data_store.shutdown
       end
@@ -221,7 +231,7 @@ module Statsig
         if !server_id_lists.is_a?(Hash) || !local_id_lists.is_a?(Hash)
           return
         end
-        threads = []
+        tasks = []
 
         server_id_lists.each do |list_name, list|
           server_list = IDList.new(list)
@@ -250,11 +260,16 @@ module Statsig
             next
           end
 
-          threads << Thread.new do
+          tasks << Concurrent::Promise.execute(:executor => @id_list_thread_pool) do
             download_single_id_list(local_list)
           end
         end
-        threads.each(&:join)
+
+        result = Concurrent::Promise.all?(*tasks).execute.wait(@id_lists_sync_interval)
+        if result.state != :fulfilled
+          return # timed out
+        end
+
         delete_lists = []
         local_id_lists.each do |list_name, list|
           unless server_id_lists.key? list_name

data/lib/statsig.rb

@@ -1,6 +1,19 @@
+# typed: true
+
 require 'statsig_driver'
+require 'sorbet-runtime'
 
 module Statsig
+  extend T::Sig
+
+
+  sig { params(secret_key: String, options: T.any(StatsigOptions, NilClass), error_callback: T.any(Method, Proc, NilClass)).void }
+  ##
+  # Initializes the Statsig SDK.
+  #
+  # @param secret_key The server SDK key copied from console.statsig.com
+  # @param options The StatsigOptions object used to configure the SDK
+  # @param error_callback A callback function, called if the initialize network call fails
   def self.initialize(secret_key, options = nil, error_callback = nil)
     unless @shared_instance.nil?
       puts 'Statsig already initialized.'
@@ -11,31 +24,70 @@ module Statsig
     @shared_instance = StatsigDriver.new(secret_key, options, error_callback)
   end
 
+  sig { params(user: StatsigUser, gate_name: String).returns(T::Boolean) }
+  ##
+  # Gets the boolean result of a gate, evaluated against the given user. An exposure event will automatically be logged for the gate.
+  #
+  # @param user A StatsigUser object used for the evaluation
+  # @param gate_name The name of the gate being checked
   def self.check_gate(user, gate_name)
     ensure_initialized
     @shared_instance&.check_gate(user, gate_name)
   end
 
+  sig { params(user: StatsigUser, dynamic_config_name: String).returns(DynamicConfig) }
+  ##
+  # Get the values of a dynamic config, evaluated against the given user. An exposure event will automatically be logged for the dynamic config.
+  #
+  # @param user A StatsigUser object used for the evaluation
+  # @param dynamic_config_name The name of the dynamic config
   def self.get_config(user, dynamic_config_name)
     ensure_initialized
     @shared_instance&.get_config(user, dynamic_config_name)
   end
 
+  sig { params(user: StatsigUser, experiment_name: String).returns(DynamicConfig) }
+  ##
+  # Get the values of an experiment, evaluated against the given user. An exposure event will automatically be logged for the experiment.
+  #
+  # @param user A StatsigUser object used for the evaluation
+  # @param experiment_name The name of the experiment
   def self.get_experiment(user, experiment_name)
     ensure_initialized
     @shared_instance&.get_experiment(user, experiment_name)
   end
 
+  sig { params(user: StatsigUser, layer_name: String).returns(Layer) }
+  ##
+  # Get the values of a layer, evaluated against the given user.
+  # Exposure events will be fired when get or get_typed is called on the resulting Layer class.
+  #
+  # @param user A StatsigUser object used for the evaluation
+  # @param layer_name The name of the layer
   def self.get_layer(user, layer_name)
     ensure_initialized
     @shared_instance&.get_layer(user, layer_name)
   end
 
+  sig { params(user: StatsigUser,
+               event_name: String,
+               value: T.any(String, Integer, Float, NilClass),
+               metadata: T.any(T::Hash[String, T.untyped], NilClass)).void }
+  ##
+  # Logs an event to Statsig with the provided values.
+  #
+  # @param user A StatsigUser object to be included in the log
+  # @param event_name The name given to the event
+  # @param value A top level value for the event
+  # @param metadata Any extra values to be logged
   def self.log_event(user, event_name, value = nil, metadata = nil)
     ensure_initialized
     @shared_instance&.log_event(user, event_name, value, metadata)
   end
 
+  sig { void }
+  ##
+  # Stops all Statsig activity and flushes any pending events.
   def self.shutdown
     unless @shared_instance.nil?
       @shared_instance.shutdown
@@ -43,25 +95,48 @@ module Statsig
     @shared_instance = nil
   end
 
+  sig { params(gate_name: String, gate_value: T::Boolean).void }
+  ##
+  # Sets a value to be returned for the given gate instead of the actual evaluated value.
+  #
+  # @param gate_name The name of the gate to be overridden
+  # @param gate_value The value that will be returned
   def self.override_gate(gate_name, gate_value)
     ensure_initialized
     @shared_instance&.override_gate(gate_name, gate_value)
   end
 
+  sig { params(config_name: String, config_value: Hash).void }
+  ##
+  # Sets a value to be returned for the given dynamic config/experiment instead of the actual evaluated value.
+  #
+  # @param config_name The name of the dynamic config or experiment to be overridden
+  # @param config_value The value that will be returned
   def self.override_config(config_name, config_value)
     ensure_initialized
     @shared_instance&.override_config(config_name, config_value)
   end
 
+  sig { params(user: StatsigUser).returns(T.any(T::Hash[String, T.untyped], NilClass)) }
+  ##
+  # Gets all evaluated values for the given user.
+  # These values can then be given to a Statsig Client SDK via bootstrapping.
+  #
+  # @param user A StatsigUser object used for the evaluation
+  #
+  # @note See Ruby Documentation: https://docs.statsig.com/server/rubySDK)
   def self.get_client_initialize_response(user)
     ensure_initialized
     @shared_instance&.get_client_initialize_response(user)
   end
 
+  sig { returns(T::Hash[String, String]) }
+  ##
+  # Internal Statsig metadata for this SDK
   def self.get_statsig_metadata
     {
       'sdkType' => 'ruby-server',
-      'sdkVersion' => '1.16.2',
+      'sdkVersion' => '1.17.0',
     }
   end
 
@@ -72,4 +147,21 @@ module Statsig
       raise 'Must call initialize first.'
     end
   end
+
+  T::Configuration.call_validation_error_handler = lambda do |signature, opts|
+    puts opts[:pretty_message]
+  end
+
+  T::Configuration.inline_type_error_handler = lambda do |error, opts|
+    puts error.message
+  end
+
+  T::Configuration.sig_builder_error_handler = lambda do |error, location|
+    puts error.message
+  end
+
+  T::Configuration.sig_validation_error_handler = lambda do |error, opts|
+    puts error.message
+  end
+
 end

data/lib/statsig_driver.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'config_result'
 require 'evaluator'
 require 'network'
@@ -8,11 +10,15 @@ require 'statsig_user'
 require 'spec_store'
 require 'dynamic_config'
 require 'layer'
+require 'sorbet-runtime'
 
 class StatsigDriver
+  extend T::Sig
+
+  sig { params(secret_key: String, options: T.any(StatsigOptions, NilClass), error_callback: T.any(Method, Proc, NilClass)).void }
+
   def initialize(secret_key, options = nil, error_callback = nil)
-    super()
-    if !secret_key.is_a?(String) || !secret_key.start_with?('secret-')
+    unless secret_key.start_with?('secret-')
       raise 'Invalid secret key provided. Provide your project secret key from the Statsig console'
     end
     if !options.nil? && !options.instance_of?(StatsigOptions)
@@ -27,6 +33,8 @@ class StatsigDriver
     @evaluator = Statsig::Evaluator.new(@net, @options, error_callback)
   end
 
+  sig { params(user: StatsigUser, gate_name: String).returns(T::Boolean) }
+
   def check_gate(user, gate_name)
     user = verify_inputs(user, gate_name, "gate_name")
 
@@ -45,16 +53,22 @@ class StatsigDriver
     res.gate_value
   end
 
+  sig { params(user: StatsigUser, dynamic_config_name: String).returns(DynamicConfig) }
+
   def get_config(user, dynamic_config_name)
     user = verify_inputs(user, dynamic_config_name, "dynamic_config_name")
     get_config_impl(user, dynamic_config_name)
   end
 
+  sig { params(user: StatsigUser, experiment_name: String).returns(DynamicConfig) }
+
   def get_experiment(user, experiment_name)
     user = verify_inputs(user, experiment_name, "experiment_name")
     get_config_impl(user, experiment_name)
   end
 
+  sig { params(user: StatsigUser, layer_name: String).returns(Layer) }
+
   def get_layer(user, layer_name)
     user = verify_inputs(user, layer_name, "layer_name")
 
@@ -115,6 +129,7 @@ class StatsigDriver
 
   def maybe_restart_background_threads
     @evaluator.maybe_restart_background_threads
+    @logger.maybe_restart_background_threads
   end
 
   private

data/lib/statsig_event.rb

@@ -1,3 +1,4 @@
+# typed: true
 class StatsigEvent
   attr_accessor :value
   attr_accessor :metadata

data/lib/statsig_logger.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'statsig_event'
 require 'concurrent-ruby'
 
@@ -117,6 +118,12 @@ module Statsig
       @network.post_logs(flush_events)
     end
 
+    def maybe_restart_background_threads
+      if @background_flush.nil? or !@background_flush.alive?
+        @background_flush = periodic_flush
+      end
+    end
+
     private
 
     def safe_add_eval_details(eval_details, event)

data/lib/statsig_options.rb

@@ -1,18 +1,88 @@
+# typed: true
+
+require 'sorbet-runtime'
+require_relative 'interfaces/data_store'
+
+##
+# Configuration options for the Statsig SDK.
 class StatsigOptions
+  extend T::Sig
+
+  sig { returns(T.any(T::Hash[String, String], NilClass)) }
+  # Hash you can use to set environment variables that apply to all of your users in
+  # the same session and will be used for targeting purposes.
+  # eg. { "tier" => "development" }
   attr_accessor :environment
+
+  sig { returns(String) }
+  # The base url used to make network calls to Statsig.
+  # default: https://statsigapi.net/v1
   attr_accessor :api_url_base
+
+  sig { returns(T.any(Float, Integer)) }
+  # The interval (in seconds) to poll for changes to your Statsig configuration
+  # default: 10s
   attr_accessor :rulesets_sync_interval
+
+  sig { returns(T.any(Float, Integer)) }
+  # The interval (in seconds) to poll for changes to your id lists
+  # default: 60s
   attr_accessor :idlists_sync_interval
+
+  sig { returns(T.any(Float, Integer)) }
+  # How often to flush logs to Statsig
+  # default: 60s
   attr_accessor :logging_interval_seconds
+
+  sig { returns(Integer) }
+  # The maximum number of events to batch before flushing logs to the server
+  # default: 1000
   attr_accessor :logging_max_buffer_size
+
+  sig { returns(T::Boolean) }
+  # Restricts the SDK to not issue any network requests and only respond with default values (or local overrides)
+  # default: false
   attr_accessor :local_mode
+
+  sig { returns(T.any(String, NilClass)) }
+  # A string that represents all rules for all feature gates, dynamic configs and experiments.
+  # It can be provided to bootstrap the Statsig server SDK at initialization in case your server runs
+  # into network issue or Statsig is down temporarily.
   attr_accessor :bootstrap_values
+
+  sig { returns(T.any(Method, Proc, NilClass)) }
+  # A callback function that will be called anytime the rulesets are updated.
   attr_accessor :rules_updated_callback
+
+  sig { returns(T.any(Statsig::Interfaces::IDataStore, NilClass)) }
+  # A class that extends IDataStore. Can be used to provide values from a
+  # common data store (like Redis) to initialize the Statsig SDK.
   attr_accessor :data_store
 
+  sig { returns(Integer) }
+  # The number of threads allocated to syncing IDLists.
+  # default: 3
+  attr_accessor :idlist_threadpool_size
+
+  sig do
+    params(
+      environment: T.any(T::Hash[String, String], NilClass),
+      api_url_base: String,
+      rulesets_sync_interval: T.any(Float, Integer),
+      idlists_sync_interval: T.any(Float, Integer),
+      logging_interval_seconds: T.any(Float, Integer),
+      logging_max_buffer_size: Integer,
+      local_mode: T::Boolean,
+      bootstrap_values: T.any(String, NilClass),
+      rules_updated_callback: T.any(Method, Proc, NilClass),
+      data_store: T.any(Statsig::Interfaces::IDataStore, NilClass),
+      idlist_threadpool_size: Integer
+    ).void
+  end
+
   def initialize(
-    environment=nil,
-    api_url_base='https://statsigapi.net/v1',
+    environment = nil,
+    api_url_base = 'https://statsigapi.net/v1',
     rulesets_sync_interval: 10,
     idlists_sync_interval: 60,
     logging_interval_seconds: 60,
@@ -20,7 +90,8 @@ class StatsigOptions
     local_mode: false,
     bootstrap_values: nil,
     rules_updated_callback: nil,
-    data_store: nil)
+    data_store: nil,
+    idlist_threadpool_size: 3)
     @environment = environment.is_a?(Hash) ? environment : nil
     @api_url_base = api_url_base
     @rulesets_sync_interval = rulesets_sync_interval
@@ -31,5 +102,6 @@ class StatsigOptions
     @bootstrap_values = bootstrap_values
     @rules_updated_callback = rules_updated_callback
     @data_store = data_store
+    @idlist_threadpool_size = idlist_threadpool_size
   end
 end

data/lib/statsig_user.rb

@@ -1,50 +1,78 @@
+# typed: true
+
+require 'sorbet-runtime'
+
+##
+#  The user object to be evaluated against your Statsig configurations (gates/experiments/dynamic configs).
 class StatsigUser
+  extend T::Sig
+
+  sig { returns(T.any(String, NilClass)) }
+  # An identifier for this user. Evaluated against the User ID criteria. (https://docs.statsig.com/feature-gates/conditions#userid)
   attr_accessor :user_id
+
+  sig { returns(T.any(String, NilClass)) }
+  # An identifier for this user. Evaluated against the Email criteria. (https://docs.statsig.com/feature-gates/conditions#email)
   attr_accessor :email
+
+  sig { returns(T.any(String, NilClass)) }
+  # An IP address associated with this user. Evaluated against the IP Address criteria. (https://docs.statsig.com/feature-gates/conditions#ip)
   attr_accessor :ip
+
+  sig { returns(T.any(String, NilClass)) }
+  # A user agent string associated with this user. Evaluated against Browser Version and Name (https://docs.statsig.com/feature-gates/conditions#browser-version)
   attr_accessor :user_agent
+
+  sig { returns(T.any(String, NilClass)) }
+  # The country code associated with this user (e.g New Zealand => NZ). Evaluated against the Country criteria. (https://docs.statsig.com/feature-gates/conditions#country)
   attr_accessor :country
+
+  sig { returns(T.any(String, NilClass)) }
+  # An locale for this user.
   attr_accessor :locale
+
+  sig { returns(T.any(String, NilClass)) }
+  # The current app version the user is interacting with. Evaluated against the App Version criteria. (https://docs.statsig.com/feature-gates/conditions#app-version)
   attr_accessor :app_version
+
+  sig { returns(T.any(T::Hash[String, String], NilClass)) }
+  # A Hash you can use to set environment variables that apply to this user. e.g. { "tier" => "development" }
   attr_accessor :statsig_environment
+
+  sig { returns(T.any(T::Hash[String, String], NilClass)) }
+  # Any Custom IDs to associated with the user. (See https://docs.statsig.com/guides/experiment-on-custom-id-types)
   attr_accessor :custom_ids
+
+  sig { returns(T.any(T::Hash[String, String], NilClass)) }
+  # Any value you wish to use in evaluation, but do not want logged with events, can be stored in this field.
   attr_accessor :private_attributes
 
+  sig { returns(T.any(T::Hash[String, T.untyped], NilClass)) }
+
   def custom
     @custom
   end
 
+  sig { params(value: T.any(T::Hash[String, T.untyped], NilClass)).void }
+  # Any custom fields for this user. Evaluated against the Custom criteria. (https://docs.statsig.com/feature-gates/conditions#custom)
   def custom=(value)
     @custom = value.is_a?(Hash) ? value : Hash.new
   end
 
+  sig { params(user_hash: T.any(T::Hash[T.any(String, Symbol), T.untyped], NilClass)).void }
+
   def initialize(user_hash)
-    @user_id = nil
-    @email = nil
-    @ip = nil
-    @user_agent = nil
-    @country = nil
-    @locale = nil
-    @app_version = nil
-    @custom = nil
-    @private_attributes = nil
-    @custom_ids = nil
-    @statsig_environment = Hash.new
-    if user_hash.is_a?(Hash)
-      @user_id = user_hash['userID'] || user_hash['user_id']
-      @user_id = @user_id.to_s unless @user_id.nil?
-      @email = user_hash['email']
-      @ip = user_hash['ip']
-      @user_agent = user_hash['userAgent'] || user_hash['user_agent']
-      @country = user_hash['country']
-      @locale = user_hash['locale']
-      @app_version = user_hash['appVersion'] || user_hash['app_version']
-      @custom = user_hash['custom'] if user_hash['custom'].is_a? Hash
-      @statsig_environment = user_hash['statsigEnvironment']
-      @private_attributes = user_hash['privateAttributes'] if user_hash['privateAttributes'].is_a? Hash
-      custom_ids = user_hash['customIDs'] || user_hash['custom_ids']
-      @custom_ids = custom_ids if custom_ids.is_a? Hash
-    end
+    @user_id = from_hash(user_hash, [:user_id, :userID], String)
+    @email = from_hash(user_hash, [:email], String)
+    @ip = from_hash(user_hash, [:ip], String)
+    @user_agent = from_hash(user_hash, [:user_agent, :userAgent], String)
+    @country = from_hash(user_hash, [:country], String)
+    @locale = from_hash(user_hash, [:locale], String)
+    @app_version = from_hash(user_hash, [:app_version, :appVersion], String)
+    @custom = from_hash(user_hash, [:custom], Hash)
+    @private_attributes = from_hash(user_hash, [:private_attributes, :privateAttributes], Hash)
+    @custom_ids = from_hash(user_hash, [:custom_ids, :customIDs], Hash)
+    @statsig_environment = from_hash(user_hash, [:statsig_environment, :statsigEnvironment], Hash)
   end
 
   def serialize(for_logging)
@@ -86,4 +114,29 @@ class StatsigUser
       'privateAttributes' => @private_attributes,
     }
   end
+
+  private
+
+  sig {
+    params(user_hash: T.any(T::Hash[T.any(String, Symbol), T.untyped], NilClass),
+           keys: T::Array[Symbol],
+           type: T.untyped)
+      .returns(T.untyped)
+  }
+  # Pulls fields from the user hash via Symbols and Strings
+  def from_hash(user_hash, keys, type)
+    if user_hash.nil?
+      return nil
+    end
+
+    keys.each do |key|
+      val = user_hash[key] || user_hash[key.to_s]
+      if not val.nil? and val.is_a? type
+        return val
+      end
+    end
+
+    nil
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.17.0
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -170,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Statsig server SDK for Ruby