growthbook 0.3.0 → 1.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: growthbook
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - GrowthBook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2023-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,19 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: fnv
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-shields-badge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
 description: Official GrowthBook SDK for Ruby
 email: jeremy@growthbook.io
 executables: []
@@ -45,29 +87,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/growthbook.rb
-- lib/growthbook/client.rb
 - lib/growthbook/conditions.rb
 - lib/growthbook/context.rb
-- lib/growthbook/experiment.rb
-- lib/growthbook/experiment_result.rb
+- lib/growthbook/decryption_util.rb
 - lib/growthbook/feature.rb
+- lib/growthbook/feature_repository.rb
 - lib/growthbook/feature_result.rb
 - lib/growthbook/feature_rule.rb
+- lib/growthbook/fnv.rb
 - lib/growthbook/inline_experiment.rb
 - lib/growthbook/inline_experiment_result.rb
-- lib/growthbook/lookup_result.rb
-- lib/growthbook/user.rb
+- lib/growthbook/tracking_callback.rb
 - lib/growthbook/util.rb
-- spec/cases.json
-- spec/client_spec.rb
-- spec/context_spec.rb
-- spec/json_spec.rb
-- spec/user_spec.rb
-- spec/util_spec.rb
 homepage: https://github.com/growthbook/growthbook-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -76,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -87,10 +123,4 @@ rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: GrowthBook SDK for Ruby
-test_files:
-- spec/json_spec.rb
-- spec/user_spec.rb
-- spec/util_spec.rb
-- spec/context_spec.rb
-- spec/client_spec.rb
-- spec/cases.json
+test_files: []

data/lib/growthbook/client.rb

@@ -1,67 +0,0 @@
-module Growthbook
-  class Client
-    # @returns [Boolean]
-    attr_accessor :enabled
-    
-    # @returns [Array<Growthbook::Experiment>]
-    attr_accessor :experiments
-
-    # @param config [Hash]
-    # @option config [Boolean] :enabled (true) Set to false to disable all experiments
-    # @option config [Array<Growthbook::Experiment>] :experiments ([]) Array of Growthbook::Experiment objects
-    def initialize(config = {})
-      @enabled = config.has_key?(:enabled) ? config[:enabled] : true
-      @experiments = config[:experiments] || []
-      @resultsToTrack = []
-    end
-
-    # Look up a pre-configured experiment by id
-    # 
-    # @param id [String] The experiment id to look up
-    # @return [Growthbook::Experiment, nil] the experiment object or nil if not found
-    def getExperiment(id)
-      match = nil;
-      @experiments.each do |exp|
-        if exp.id == id
-          match = exp
-          break
-        end
-      end
-      return match
-    end
-
-    # Get a User object you can run experiments against
-    # 
-    # @param params [Hash]
-    # @option params [String, nil] :id The logged-in user id
-    # @option params [String, nil] :anonId The anonymous id (session id, ip address, cookie, etc.)
-    # @option params [Hash, nil] :attributes Any user attributes you want to use for experiment targeting
-    #    Values can be any type, even nested arrays and hashes
-    # @return [Growthbook::User] the User object
-    def user(params = {})
-      Growthbook::User.new(
-        params[:anonId] || nil,
-        params[:id] || nil,
-        params[:attributes] || nil,
-        self
-      )
-    end
-
-    def importExperimentsHash(experimentsHash = {})
-      @experiments = []
-      experimentsHash.each do |id, data|
-        variations = data["variations"]
-
-        options = {}
-        options[:coverage] = data["coverage"] if data.has_key?("coverage")
-        options[:weights] = data["weights"] if data.has_key?("weights")
-        options[:force] = data["force"] if data.has_key?("force")
-        options[:anon] = data["anon"] if data.has_key?("anon")
-        options[:targeting] = data["targeting"] if data.has_key?("targeting")
-        options[:data] = data["data"] if data.has_key?("data")
-
-        @experiments << Growthbook::Experiment.new(id, variations, options)
-      end
-    end
-  end
-end

data/lib/growthbook/experiment.rb

@@ -1,72 +0,0 @@
-module Growthbook
-  class Experiment
-    # @returns [String]
-    attr_accessor :id
-
-    # @returns [Integer]
-    attr_accessor :variations
-
-    # @returns [Float]
-    attr_accessor :coverage
-
-    # @returns [Array<Float>]
-    attr_accessor :weights
-
-    # @returns [Boolean]
-    attr_accessor :anon
-
-    # @returns [Array<String>]
-    attr_accessor :targeting
-
-    # @returns [Integer, nil]
-    attr_accessor :force
-
-    # @returns [Hash]
-    attr_accessor :data
-
-    # Constructor for an Experiment
-    # 
-    # @param id [String] The unique id for this experiment
-    # @param variations [Integer] The number of variations in this experiment (including the Control)
-    # @param options [Hash]
-    # @option options [Float] :coverage (1.0) The percent of elegible traffic to include in the experiment
-    # @option options [Array<Float>] :weights The relative weights of the variations. 
-    #    Length must be the same as the number of variations. Total should add to 1.0.
-    #    Default is an even split between variations
-    # @option options [Boolean] :anon (false) If false, the experiment uses the logged-in user id for bucketing
-    #    If true, the experiment uses the anonymous id for bucketing
-    # @option options [Array<String>] :targeting Array of targeting rules in the format "key op value"
-    #    where op is one of: =, !=, <, >, ~, !~
-    # @option options [Integer, nil] :force If an integer, force all users to get this variation
-    # @option options [Hash] :data Data to attach to the variations
-    def initialize(id, variations, options = {})
-      @id = id
-      @variations = variations
-      @coverage = options[:coverage] || 1
-      @weights = options[:weights] || getEqualWeights()
-      @force = options.has_key?(:force) ? options[:force] : nil
-      @anon = options.has_key?(:anon) ? options[:anon] : false
-      @targeting = options[:targeting] || []
-      @data = options[:data] || {}
-    end
-
-    def getScaledWeights
-      scaled = @weights.map do |n|
-        n*@coverage
-      end
-
-      return scaled
-    end
-
-    private
-
-    def getEqualWeights
-      weights = []
-      n = @variations
-      for i in 1..n
-        weights << (1.0 / n)
-      end
-      return weights
-    end
-  end
-end

data/lib/growthbook/experiment_result.rb

@@ -1,43 +0,0 @@
-module Growthbook
-  class ExperimentResult
-    # The experiment that was performed
-    # @return [Growthbook::Experiment, nil] If nil, then the experiment with the required id could not be found
-    attr_reader :experiment
-
-    # The user that was experimented on
-    # @return [Growthbook::User]
-    attr_reader :user
-
-    # The chosen variation. -1 for "not in experiment", 0 for control, 1 for 1st variation, etc.
-    # @return [Integer]
-    attr_reader :variation
-
-    # The data tied to the chosen variation
-    # @return [Hash]
-    attr_reader :data
-
-    @forced = false
-
-    def forced?
-      @forced
-    end
-
-    def shouldTrack?
-      !@forced && @variation >= 0
-    end
-
-    def initialize(user = nil, experiment = nil, variation = -1, forced = false)
-      @experiment = experiment
-      @variation = variation
-      @forced = forced
-
-      @data = {}
-      if experiment && experiment.data
-        var = variation < 0 ? 0 : variation
-        experiment.data.each do |k, v|
-          @data[k] = v[var]
-        end
-      end
-    end
-  end
-end

data/lib/growthbook/lookup_result.rb

@@ -1,44 +0,0 @@
-module Growthbook
-  class LookupResult
-    # The first matching experiment
-    # @return [Growthbook::Experiment]
-    attr_reader :experiment
-
-    # The chosen variation. -1 for "not in experiment", 0 for control, 1 for 1st variation, etc.
-    # @return [Integer]
-    attr_reader :variation
-
-    # The data tied to the chosen variation
-    # @return [Hash]
-    attr_reader :data
-
-    # The value of the data key that was used to lookup the experiment
-    attr_reader :value
-
-    @forced
-
-    def forced?
-      @forced
-    end
-
-    def shouldTrack?
-      !@forced && @variation >= 0
-    end
-
-    def initialize(result, key)
-      @experiment = result.experiment
-      @variation = result.variation
-      @forced = result.forced?
-
-      @data = {}
-      if @experiment && @experiment.data
-        var = @variation <0 ? 0 : @variation
-        @experiment.data.each do |k, v|
-          @data[k] = v[var]
-        end
-      end
-
-      @value = @data[key] || nil
-    end
-  end
-end

data/lib/growthbook/user.rb

@@ -1,165 +0,0 @@
-require 'set'
-
-module Growthbook
-  class User
-    # @returns [String, nil]
-    attr_accessor :id
-
-    # @returns [String, nil]
-    attr_accessor :anonId
-
-    # @returns [Hash, nil]
-    attr_reader :attributes
-
-    # @returns [Array<Growthbook::ExperimentResult>]
-    attr_reader :resultsToTrack
-    
-    @client
-    @attributeMap = {}
-    @experimentsTracked
-
-    def initialize(anonId, id, attributes, client)
-      @anonId = anonId
-      @id = id
-      @attributes = attributes
-      @client = client
-      updateAttributeMap
-
-      @resultsToTrack = []
-      @experimentsTracked = Set[]
-    end
-
-    # Set the user attributes
-    # 
-    # @params attributes [Hash, nil] Any user attributes you want to use for experiment targeting
-    #    Values can be any type, even nested arrays and hashes
-    def attributes=(attributes)
-      @attributes = attributes
-      updateAttributeMap
-    end
-
-    # Run an experiment on this user
-    # @param experiment [Growthbook::Experiment, String] If string, will lookup the experiment by id in the client
-    # @return [Growthbook::ExperimentResult]
-    def experiment(experiment)
-      # If experiments are disabled globally
-      return getExperimentResult unless @client.enabled
-
-      # Make sure experiment is always an object (or nil)
-      id = ""
-      if experiment.is_a? String
-        id = experiment
-        experiment = @client.getExperiment(id)
-      else
-        id = experiment.id
-        override = @client.getExperiment(id)
-        experiment = override if override
-      end
-
-      # No experiment found
-      return getExperimentResult unless experiment
-
-      # User missing required user id type
-      userId = experiment.anon ? @anonId : @id
-      if !userId
-        return getExperimentResult(experiment)
-      end
-
-      # Experiment has targeting rules, check if user passes
-      if experiment.targeting
-        return getExperimentResult(experiment) unless isTargeted(experiment.targeting)
-      end
-
-      # Experiment has a specific variation forced
-      if experiment.force != nil
-        return getExperimentResult(experiment, experiment.force, true)
-      end
-
-      # Choose a variation for the user
-      variation = Growthbook::Util.chooseVariation(userId, experiment)
-      result = getExperimentResult(experiment, variation)
-
-      # Add to the list of experiments that should be tracked in analytics
-      if result.shouldTrack? && !@experimentsTracked.include?(experiment.id)
-        @experimentsTracked << experiment.id
-        @resultsToTrack << result
-      end
-
-      return result
-    end
-
-    # Run the first matching experiment that defines variation data for the requested key
-    # @param key [String, Symbol] The key to look up
-    # @return [Growthbook::LookupResult, nil] If nil, no matching experiments found
-    def lookupByDataKey(key)
-      @client.experiments.each do |exp|
-        if exp.data && exp.data.key?(key)
-          ret = experiment(exp)
-          if ret.variation >= 0
-            return Growthbook::LookupResult.new(ret, key)
-          end
-        end
-      end
-
-      return nil
-    end
-
-    private
-
-    def getExperimentResult(experiment = nil, variation = -1, forced = false)
-      Growthbook::ExperimentResult.new(self, experiment, variation, forced)
-    end
-
-    def flattenUserValues(prefix, val)
-      if val.nil? 
-        return []
-      end
-      
-      if val.is_a? Hash
-        ret = []
-        val.each do |k, v|
-          ret.concat(flattenUserValues(prefix.length>0 ? prefix.to_s + "." + k.to_s : k.to_s, v))
-        end
-        return ret
-      end
-
-      if val.is_a? Array
-        val = val.join ","
-      elsif !!val == val
-        val = val ? "true" : "false"
-      end
-
-      return [
-        {
-          "k" => prefix.to_s,
-          "v" => val.to_s
-        }
-      ]
-    end
-
-    def updateAttributeMap
-      @attributeMap = {}
-      flat = flattenUserValues("", @attributes)
-      flat.each do |item|
-        @attributeMap[item["k"]] = item["v"]
-      end
-    end
-
-    def isTargeted(rules)
-      pass = true
-      rules.each do |rule|
-        parts = rule.split(" ", 3)
-        if parts.length == 3
-          key = parts[0].strip
-          actual = @attributeMap[key] || ""
-          if !Growthbook::Util.checkRule(actual, parts[1].strip, parts[2].strip)
-            pass = false
-            break
-          end
-        end
-      end
-
-      return pass
-    end
-  end
-end