statsig 0.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe488b916b3d18b4f227e9783251537b8197ba6e449521bec56489a1c871988
-  data.tar.gz: 49bda9345b2436a8715997b3a57330f10ceb304448106a38519c6d5a8f2ffe01
+  metadata.gz: 90f13c55a79aa919b94e633f69d39b3cb997a92cceec3e27bdb3e00e00e8e3ef
+  data.tar.gz: cd40c863516da1b3ff0730959ccbc3fa664afe0e613775f0369a1377ccc06123
 SHA512:
-  metadata.gz: b8cf69b8e91ae507188de12dd3addd8ccbc7389bc630d175ee940f00a12aea28adf1080dc335229170ff95db330a04e4c74d42446ff29439c4de9ba6c75506d2
-  data.tar.gz: fd23228461be6058ead19eaa9b4fce3705a0717b8eb8970ddcdd0b06bdb4734e9d103e2a910aaa09c31ab175d2d1776db199122dcf4c6d38fc77884b3fef65da
+  metadata.gz: a4c73b125853c8128d5aa57a60acfe1e80a0aa8ffc9f1fdcd89ea74e9a6ac033c93262103850d0c13ec84052ca9b9a464627836a1af945e6100c036c0fbc1359
+  data.tar.gz: 86bf2fe76cdc5cdc29126bd188a33e746f2a143e56fce1cd2e7d5a242622acb4b3783694f01e11a6e8ce10c707bc38a57a055694e15c965ee584bb951c6acb0d

data/lib/evaluation_helpers.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module EvaluationHelpers
   def self.compare_numbers(a, b, func)
     return false unless self.is_numeric(a) && self.is_numeric(b)
@@ -5,16 +7,28 @@ module EvaluationHelpers
   end
 
   # returns true if array contains value, ignoring case when comparing strings
-  def self.array_contains(array, value)
+  def self.array_contains(array, value, ignore_case)
     return false unless array.is_a?(Array) && !value.nil?
-    return array.include?(value) unless value.is_a?(String)
-    array.any?{ |s| s.is_a?(String) && s.casecmp(value) == 0 } rescue false
+    if value.is_a?(String) && match_string_in_array(array, value, ignore_case, ->(a, b) { a == b })
+      return true
+    end
+    return array.include?(value)
   end
 
   # returns true if array has any element that evaluates to true with value using func lambda, ignoring case
-  def self.match_string_in_array(array, value, func)
+  def self.match_string_in_array(array, value, ignore_case, func)
     return false unless array.is_a?(Array) && value.is_a?(String)
-    array.any?{ |s| s.is_a?(String) && func.call(value.downcase, s.downcase) } rescue false
+    array.any?{ |s| s.is_a?(String) && ((ignore_case && func.call(value.downcase, s.downcase)) || func.call(value, s)) } rescue false
+  end
+
+  def self.compare_times(a, b, func)
+    begin
+      time_1 = self.get_epoch_time(a)
+      time_2 = self.get_epoch_time(b)
+      func.call(time_1, time_2)
+    rescue
+      false
+    end
   end
 
   private
@@ -22,4 +36,13 @@ module EvaluationHelpers
   def self.is_numeric(v)
     !(v.to_s =~ /\A[-+]?\d*\.?\d+\z/).nil?
   end
+
+  def self.get_epoch_time(v)
+    time = self.is_numeric(v) ? Time.at(v.to_f) : Time.parse(v)
+    if time.year > Time.now.year + 100
+      # divide by 1000 when the epoch time is in milliseconds instead of seconds
+      return time.to_i / 1000
+    end
+    return time.to_i
+  end
 end

data/lib/evaluator.rb

@@ -1,8 +1,11 @@
-require 'browser'
 require 'config_result'
+require 'country_lookup'
 require 'digest'
 require 'evaluation_helpers'
 require 'spec_store'
+require 'time'
+require 'user_agent_parser'
+require 'user_agent_parser/operating_system'
 
 $fetch_from_server = :fetch_from_server
 $type_dynamic_config = 'dynamic_config'
@@ -11,6 +14,8 @@ class Evaluator
   def initialize(store)
     @spec_store = store
     @initialized = true
+    @ua_parser = UserAgentParser::Parser.new
+    CountryLookup.initialize
   end
 
   def check_gate(user, gate_name)
@@ -65,8 +70,10 @@ class Evaluator
     target = condition['targetValue']
     type = condition['type']
     operator = condition['operator']
+    additional_values = condition['additionalValues']
+    additional_values = Hash.new unless additional_values.is_a? Hash
 
-    return $fetch_from_server unless type.is_a?(String)
+    return $fetch_from_server unless type.is_a? String
     type = type.downcase
 
     case type
@@ -76,7 +83,7 @@ class Evaluator
     when 'pass_gate'
       other_gate_result = self.check_gate(user, target)
       return $fetch_from_server if other_gate_result == $fetch_from_server
-      return type == 'pass_gate' ? other_gate_result[:gate_value] : !other_gate_result[:gate_value]
+      return type == 'pass_gate' ? other_gate_result.gate_value : !other_gate_result.gate_value
     when 'ip_based'
       value = get_value_from_user(user, field) || get_value_from_ip(user&.value_lookup['ip'], field)
       return $fetch_from_server if value == $fetch_from_server
@@ -85,8 +92,19 @@ class Evaluator
       return $fetch_from_server if value == $fetch_from_server
     when 'user_field'
       value = get_value_from_user(user, field)
+    when 'environment_field'
+      value = get_value_from_environment(user, field)
     when 'current_time'
       value = Time.now.to_f # epoch time in seconds
+    when 'user_bucket'
+      begin
+        salt = additional_values['salt']
+        user_id = user.user_id || ''
+        # there are only 1000 user buckets as opposed to 10k for gate pass %
+        value = compute_user_hash("#{salt}.#{user_id}") % 1000
+      rescue
+        return false
+      end
     else
       return $fetch_from_server
     end
@@ -124,17 +142,21 @@ class Evaluator
 
       # array operations
     when 'any'
-      return EvaluationHelpers::array_contains(target, value)
+      return EvaluationHelpers::array_contains(target, value, true)
     when 'none'
-      return !EvaluationHelpers::array_contains(target, value)
+      return !EvaluationHelpers::array_contains(target, value, true)
+    when 'any_case_sensitive'
+      return EvaluationHelpers::array_contains(target, value, false)
+    when 'none_case_sensitive'
+      return !EvaluationHelpers::array_contains(target, value, false)
 
       #string
     when 'str_starts_with_any'
-      return EvaluationHelpers::match_string_in_array(target, value, ->(a, b) { a.start_with?(b) })
+      return EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a.start_with?(b) })
     when 'str_ends_with_any'
-      return EvaluationHelpers::match_string_in_array(target, value, ->(a, b) { a.end_with?(b) })
+      return EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a.end_with?(b) })
     when 'str_contains_any'
-      return EvaluationHelpers::match_string_in_array(target, value, ->(a, b) { a.include?(b) })
+      return EvaluationHelpers::match_string_in_array(target, value, true, ->(a, b) { a.include?(b) })
     when 'str_matches'
       return (value.is_a?(String) && !(value =~ Regexp.new(target)).nil? rescue false)
     when 'eq'
@@ -144,11 +166,11 @@ class Evaluator
 
       # dates
     when 'before'
-      # TODO - planned future conditions
+      return EvaluationHelpers::compare_times(value, target, ->(a, b) { a < b })
     when 'after'
-      # TODO - planned future conditions
+      return EvaluationHelpers::compare_times(value, target, ->(a, b) { a > b })
     when 'on'
-      # TODO - planned future conditions
+      return EvaluationHelpers::compare_times(value, target, ->(a, b) { a.year == b.year && a.month == b.month && a.day == b.day })
     else
       return $fetch_from_server
     end
@@ -164,47 +186,61 @@ class Evaluator
     user_custom = user_lookup_table['custom']
     return nil unless user_custom.is_a?(Hash)
     user_custom.each do |key, value|
-      return value if key.downcase.casecmp(field.downcase)
+      return value if key.downcase.casecmp?(field.downcase)
+    end
+    nil
+  end
+
+  def get_value_from_environment(user, field)
+    return nil unless user.instance_of?(StatsigUser) && field.is_a?(String)
+    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)
     end
+    nil
   end
 
   def get_value_from_ip(ip, field)
     return nil unless ip.is_a?(String) && field.is_a?(String)
-    # TODO
-    $fetch_from_server
+
+    if field.downcase != 'country'
+      return $fetch_from_server
+    end
+    CountryLookup.lookup_ip_string(ip)
   end
 
   def get_value_from_ua(ua, field)
     return nil unless ua.is_a?(String) && field.is_a?(String)
-    b = Browser.new(ua)
+    parsed = @ua_parser.parse ua
+    os = parsed.os
     case field.downcase
-    when 'os_name'
-      os_name = b.platform.name
-      # special case for iOS because value is 'iOS (iPhone)'
-      if os_name.include?('iOS') || os_name.include?('ios')
-        return 'iOS'
-      else
-        return os_name
-      end
-    when 'os_version'
-      return b.platform.version
-    when 'browser_name'
-      return b.name
-    when 'browser_version'
-      return b.full_version
+    when 'os_name', 'osname'
+      return os&.family
+    when 'os_version', 'osversion'
+      return os&.version unless os&.version.nil?
+    when 'browser_name', 'browsername'
+      return parsed.family
+    when 'browser_version', 'browserversion'
+      return parsed.version.to_s
     else
       nil
     end
   end
 
-  def eval_pass_percent(user, rule, salt)
-    return false unless salt.is_a?(String) && !rule['passPercentage'].nil?
+  def eval_pass_percent(user, rule, config_salt)
+    return false unless config_salt.is_a?(String) && !rule['passPercentage'].nil?
     begin
       user_id = user.user_id || ''
-      hash = Digest::SHA256.digest("#{salt}.#{rule['name']}.#{user_id}").unpack('Q>')[0]
-      return hash % 10000 < rule['passPercentage'].to_f * 100
+      rule_salt = rule['salt'] || rule['id'] || ''
+      hash = compute_user_hash("#{config_salt}.#{rule_salt}.#{user_id}")
+      return (hash % 10000) < (rule['passPercentage'].to_f * 100)
     rescue
       return false
     end
   end
+
+  def compute_user_hash(user_hash)
+    Digest::SHA256.digest(user_hash).unpack('Q>')[0]
+  end
 end

data/lib/network.rb

@@ -8,17 +8,24 @@ class Network
     unless api.end_with?('/')
       api += '/'
     end
-    @http = HTTP
-        .headers({"STATSIG-API-KEY" => server_secret, "Content-Type" => "application/json; charset=UTF-8"})
-        .accept(:json)
+    @server_secret = server_secret
     @api = api
     @last_sync_time = 0
   end
 
+  def post_helper(endpoint, body)
+    http = HTTP.headers(
+      {"STATSIG-API-KEY" => @server_secret,
+       "STATSIG-CLIENT-TIME" => (Time.now.to_f * 1000).to_s,
+       "Content-Type" => "application/json; charset=UTF-8"
+      }).accept(:json)
+    http.post(@api + endpoint, body: body)
+  end
+
   def check_gate(user, gate_name)
     begin
       request_body = JSON.generate({'user' => user&.serialize, 'gateName' => gate_name})
-      response = @http.post(@api + 'check_gate', body: request_body)
+      response = post_helper('check_gate', request_body)
       return JSON.parse(response.body)
     rescue
       return false
@@ -28,7 +35,7 @@ class Network
   def get_config(user, dynamic_config_name)
     begin
       request_body = JSON.generate({'user' => user&.serialize, 'configName' => dynamic_config_name})
-      response = @http.post(@api + 'get_config', body: request_body)
+      response = post_helper('get_config', request_body)
       return JSON.parse(response.body)
     rescue
       return nil
@@ -37,7 +44,7 @@ class Network
 
   def download_config_specs
     begin
-      response = @http.post(@api + 'download_config_specs', body: JSON.generate({'sinceTime' => @last_sync_time}))
+      response = post_helper('download_config_specs', JSON.generate({'sinceTime' => @last_sync_time}))
       json_body = JSON.parse(response.body)
       @last_sync_time = json_body['time']
       return json_body
@@ -61,7 +68,7 @@ class Network
   def post_logs(events, statsig_metadata)
     begin
       json_body = JSON.generate({'events' => events, 'statsigMetadata' => statsig_metadata})
-      @http.post(@api + 'log_event', body: json_body)
+      post_helper('log_event', body: json_body)
     rescue
       # TODO: retries
     end

data/lib/statsig.rb

@@ -1,28 +1,33 @@
 require 'statsig_driver'
 
 module Statsig
-  def self.initialize(secret_key)
+  def self.initialize(secret_key, options = nil)
     unless @shared_instance.nil?
       puts 'Statsig already initialized.'
       return @shared_instance
     end
 
-    @shared_instance = StatsigDriver.new(secret_key)
+    @shared_instance = StatsigDriver.new(secret_key, options)
   end
 
   def self.check_gate(user, gate_name)
     self.ensure_initialized
-    @shared_instance.check_gate(user, gate_name)
+    @shared_instance&.check_gate(user, gate_name)
   end
 
   def self.get_config(user, dynamic_config_name)
     self.ensure_initialized
-    @shared_instance.get_config(user, dynamic_config_name)
+    @shared_instance&.get_config(user, dynamic_config_name)
+  end
+
+  def self.get_experiment(user, experiment_name)
+    self.ensure_initialized
+    @shared_instance&.get_config(user, experiment_name)
   end
 
   def self.log_event(user, event_name, value, metadata)
     self.ensure_initialized
-    @shared_instance.log_event(user, event_name, value, metadata)
+    @shared_instance&.log_event(user, event_name, value, metadata)
   end
 
   def self.shutdown

data/lib/statsig_driver.rb

@@ -3,18 +3,24 @@ require 'evaluator'
 require 'network'
 require 'statsig_event'
 require 'statsig_logger'
+require 'statsig_options'
 require 'statsig_user'
 require 'spec_store'
 
 class StatsigDriver
-  def initialize(secret_key)
+  def initialize(secret_key, options = nil)
     super()
     if !secret_key.is_a?(String) || !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)
+      raise 'Invalid options provided. Either provide a valid StatsigOptions object or nil'
+    end
+
+    @options = options || StatsigOptions.new()
     @shutdown = false
     @secret_key = secret_key
-    @net = Network.new(secret_key, 'https://api.statsig.com/v1/')
+    @net = Network.new(secret_key, @options.api_url_base)
     @statsig_metadata = {
       'sdkType' => 'ruby-server',
       'sdkVersion' => Gem::Specification::load('statsig.gemspec')&.version,
@@ -33,9 +39,8 @@ class StatsigDriver
   end
 
   def check_gate(user, gate_name)
-    if !user.nil? && !user.instance_of?(StatsigUser)
-      raise 'Must provide a valid StatsigUser'
-    end
+    validate_user(user)
+    user = normalize_user(user)
     if !gate_name.is_a?(String) || gate_name.empty?
       raise 'Invalid gate_name provided'
     end
@@ -58,9 +63,8 @@ class StatsigDriver
   end
 
   def get_config(user, dynamic_config_name)
-    if !user.nil? && !user.instance_of?(StatsigUser)
-      raise 'Must provide a valid StatsigUser or nil'
-    end
+    validate_user(user)
+    user = normalize_user(user)
     if !dynamic_config_name.is_a?(String) || dynamic_config_name.empty?
       raise "Invalid dynamic_config_name provided"
     end
@@ -89,6 +93,8 @@ class StatsigDriver
     end
     check_shutdown
 
+    user = normalize_user(user)
+
     event = StatsigEvent.new(event_name)
     event.user = user&.serialize
     event.value = value
@@ -105,6 +111,19 @@ class StatsigDriver
 
   private
 
+  def validate_user(user)
+    if user.nil? || !user.instance_of?(StatsigUser) || !user.user_id.is_a?(String)
+      raise 'Must provide a valid StatsigUser with a user_id to use the server SDK. See https://docs.statsig.com/messages/serverRequiredUserID/ for more details.'
+    end
+  end
+
+  def normalize_user(user)
+    if !@options&.environment.nil?
+      user.statsig_environment = @options.environment
+    end
+    user
+  end
+
   def check_shutdown
     if @shutdown
       puts 'SDK has been shutdown.  Updates in the Statsig Console will no longer reflect.'

data/lib/statsig_event.rb

@@ -5,7 +5,7 @@ class StatsigEvent
   attr_accessor :statsig_metadata
   def initialize(event_name)
     @event_name = event_name
-    @time = Time.now.to_i * 1000
+    @time = Time.now.to_f * 1000
   end
 
   def serialize

data/lib/statsig_options.rb

@@ -0,0 +1,9 @@
+class StatsigOptions
+  attr_reader :environment
+  attr_reader :api_url_base
+
+  def initialize(environment = nil, api_url_base = 'https://api.statsig.com/v1')
+    @environment = environment.is_a?(Hash) ? environment : nil
+    @api_url_base = api_url_base
+  end
+end

data/lib/statsig_user.rb

@@ -5,7 +5,8 @@ class StatsigUser
   attr_accessor :user_agent
   attr_accessor :country
   attr_accessor :locale
-  attr_accessor :client_version
+  attr_accessor :app_version
+  attr_accessor :statsig_environment
 
   def custom
     @custom
@@ -15,16 +16,19 @@ class StatsigUser
     @custom = value.is_a?(Hash) ? value : Hash.new
   end
 
-  def initialize(user_hash = nil)
+  def initialize(user_hash)
+    @statsig_environment = Hash.new
     if user_hash.is_a?(Hash)
-      @user_id = user_hash['userID']
+      @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_agent = user_hash['userAgent'] || user_hash['user_agent']
       @country = user_hash['country']
       @locale = user_hash['locale']
-      @client_version = user_hash['clientVersion']
+      @app_version = user_hash['appVersion'] || user_hash['app_version']
       @custom = user_hash['custom']
+      @statsig_environment = user_hash['statsigEnvironment']
     end
   end
 
@@ -36,8 +40,9 @@ class StatsigUser
       'userAgent' => @user_agent,
       'country' => @country,
       'locale' => @locale,
-      'clientVersion' => @client_version,
+      'appVersion' => @app_version,
       'custom' => @custom,
+      'statsigEnvironment' => @statsig_environment,
     }
   end
 
@@ -53,9 +58,9 @@ class StatsigUser
       'user_agent' => @user_agent,
       'country' => @country,
       'locale' => @locale,
-      'clientVersion' => @client_version,
-      'clientversion' => @client_version,
-      'client_version' => @client_version,
+      'appVersion' => @app_version,
+      'appversion' => @app_version,
+      'app_version' => @app_version,
       'custom' => @custom,
     }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsig
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Statsig, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-05 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,25 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: browser
+  name: user_agent_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.1
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.1
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -51,9 +45,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -61,9 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
-    - - ">="
+- !ruby/object:Gem::Dependency
+  name: ip3country
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: '0.1'
 description: Statsig server SDK for feature gates and experimentation in Ruby
 email: support@statsig.com
 executables: []
@@ -80,6 +82,7 @@ files:
 - lib/statsig_driver.rb
 - lib/statsig_event.rb
 - lib/statsig_logger.rb
+- lib/statsig_options.rb
 - lib/statsig_user.rb
 homepage: https://rubygems.org/gems/statsig
 licenses: