growthbook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91514b6437d92dc4d5ff6464f6ae4088dd2f57974fe60ac24d001eeca58ca498
+  data.tar.gz: 5ecb57a051072fd053838e8dfb0733bf879a44eddb68687583f1c7245496aae6
+SHA512:
+  metadata.gz: 77a2244bec748a0d55666716b0e532430fc84c3f0d268bf44a54e60fd19ea92329af4cb2cdd19e9af90606845ae8d6a7db6d7ca066d1e1ee2af8a2b126593280
+  data.tar.gz: af03f9ed8278aaf28705b3eed68e81e9fe0f58e482e476ecfc8bc00c073663db68dcd7f70e2902be56a2debf2eb0e465ac29c6730d2b6377f71c862ee924b8b7

data/lib/growthbook.rb

@@ -0,0 +1,9 @@
+module Growthbook
+end
+
+require 'growthbook/client'
+require 'growthbook/experiment_result'
+require 'growthbook/lookup_result'
+require 'growthbook/experiment'
+require 'growthbook/util'
+require 'growthbook/user'

data/lib/growthbook/client.rb

@@ -0,0 +1,67 @@
+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

@@ -0,0 +1,72 @@
+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

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,165 @@
+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

data/lib/growthbook/util.rb

@@ -0,0 +1,51 @@
+require "fnv"
+
+module Growthbook
+  class Util
+    def self.checkRule(actual, op, desired)
+      # Check if both strings are numeric so we can do natural ordering
+      # for greater than / less than operators
+      numeric = (Float(actual) != nil && Float(desired) != nil) rescue false
+
+      case op
+      when "="
+        numeric ? Float(actual) == Float(desired) : actual == desired
+      when "!="
+        numeric ? Float(actual) != Float(desired) : actual != desired
+      when ">"
+        numeric ? Float(actual) > Float(desired) : actual > desired
+      when "<"
+        numeric ? Float(actual) < Float(desired) : actual < desired
+      when "~"
+        !!(actual =~ Regexp.new(desired)) rescue false
+      when "!~"
+        !(actual =~ Regexp.new(desired)) rescue false
+      else
+        true
+      end
+    end
+
+    def self.chooseVariation(userId, experiment)
+      testId = experiment.id
+      weights = experiment.getScaledWeights()
+
+      # Hash the user id and testName to a number from 0 to 1
+      n = (FNV.new.fnv1a_32(userId + testId)%1000)/1000.0
+
+      cumulativeWeight = 0
+
+      match = -1
+      i = 0
+      weights.each do |weight|
+        cumulativeWeight += weight
+        if n < cumulativeWeight
+          match = i
+          break
+        end
+        i+=1
+      end
+
+      return match
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: growthbook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- GrowthBook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: fnv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Official GrowthBook SDK for Ruby
+email: jeremy@growthbook.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/growthbook.rb
+- lib/growthbook/client.rb
+- lib/growthbook/experiment.rb
+- lib/growthbook/experiment_result.rb
+- lib/growthbook/lookup_result.rb
+- lib/growthbook/user.rb
+- lib/growthbook/util.rb
+homepage: https://github.com/growthbook/growthbook-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: GrowthBook SDK for Ruby
+test_files: []