kameleoon-client-ruby 1.1.2 → 2.1.0

data/lib/kameleoon/configuration/experiment.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'kameleoon/targeting/models'
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # Class for manage all experiments and old feature flags
+    class Experiment
+      attr_accessor :id, :status, :site_enabled, :deviations, :respool_time, :variations, :targeting_segment
+
+      def self.create_from_array(array)
+        array&.map { |it| Experiment.new(it) }
+      end
+
+      def initialize(experiment_hash)
+        @id = experiment_hash['id']
+        @status = experiment_hash['status']
+        @site_enabled = experiment_hash['siteEnabled']
+        unless experiment_hash['deviations'].nil?
+          @deviations =
+            Hash[*experiment_hash['deviations'].map do |it|
+              [it['variationId'] == 'origin' ? '0' : it['variationId'], it['value']]
+            end.flatten]
+        end
+        unless experiment_hash['respoolTime'].nil?
+          @respool_time =
+            Hash[*experiment_hash['respoolTime'].map do |it|
+              [it['variationId'] == 'origin' ? '0' : it['variationId'], it['value']]
+            end.flatten]
+        end
+        unless experiment_hash['variations'].nil?
+          @variations =
+          experiment_hash['variations'].map do |it|
+              { 'id' => it['id'].to_i, 'customJson' => it['customJson'] }
+            end
+        end
+        @targeting_segment = Kameleoon::Targeting::Segment.new((experiment_hash['segment'])) if experiment_hash['segment']
+      end
+    end
+  end
+end

data/lib/kameleoon/configuration/feature_flag.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'rule'
+require_relative 'variation'
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # Class for manage all feature flags with rules
+    class FeatureFlag
+      attr_accessor :id, :feature_key, :variations, :default_variation_key, :rules
+
+      def self.create_from_array(array)
+        array&.map { |it| FeatureFlag.new(it) }
+      end
+
+      def initialize(hash)
+        @id = hash['id']
+        @feature_key = hash['featureKey']
+        @default_variation_key = hash['defaultVariationKey']
+        @variations = Variation.create_from_array(hash['variations'])
+        @rules = Rule.create_from_array(hash['rules'])
+      end
+
+      def get_variation_key(key)
+        variations.select { |v| v.key == key }.first
+      end
+    end
+  end
+end

data/lib/kameleoon/configuration/rule.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'variation_exposition'
+require 'kameleoon/targeting/models'
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # RuleType has a possible rule types
+    module RuleType
+      EXPERIMENTATION = 'EXPERIMENTATION'
+      TARGETED_DELIVERY = 'TARGETED_DELIVERY'
+    end
+
+    # Rule is a class for new rules of feature flags
+    class Rule
+      attr_reader :id, :order, :type, :exposition, :experiment_id, :variation_by_exposition, :respool_time
+      attr_accessor :targeting_segment
+
+      def self.create_from_array(array)
+        array&.map { |it| Rule.new(it) }
+      end
+
+      def initialize(hash)
+        @id = hash['id']
+        @order = hash['order']
+        @type = hash['type']
+        @exposition = hash['exposition']
+        @experiment_id = hash['experimentId']
+        @respool_time = hash['respoolTime']
+        @variation_by_exposition = VariationByExposition.create_from_array(hash['variationByExposition'])
+        @targeting_segment = Kameleoon::Targeting::Segment.new((hash['segment'])) if hash['segment']
+      end
+
+      def get_variation(hash_double)
+        total = 0.0
+        variation_by_exposition.each do |var_by_exp|
+          total += var_by_exp.exposition
+          return var_by_exp if total >= hash_double
+        end
+        nil
+      end
+
+      def get_variation_id_by_key(key)
+        variation_by_exposition.select { |v| v.variation_key == key }.first&.variation_id
+      end
+
+      def experiment_type?
+        @type == RuleType::EXPERIMENTATION
+      end
+
+      def targeted_delivery_type?
+        @type == RuleType::TARGETED_DELIVERY
+      end
+    end
+  end
+end

data/lib/kameleoon/configuration/settings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # KameleoonConfigurationSettings is used for saving setting's parameters, e.g
+    # state of real time update for site code and etc
+    class Settings
+      attr_accessor :real_time_update
+
+      def initialize
+        @real_time_update = false
+      end
+
+      def update(configuration)
+        @real_time_update = configuration['realTimeUpdate'] || false
+      end
+    end
+  end
+end

data/lib/kameleoon/configuration/variable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'experiment'
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # Variable class contains key / type / value of variable
+    class Variable
+      attr_accessor :key, :type, :value
+
+      def self.create_from_array(array)
+        array&.map { |it| Variable.new(it) }
+      end
+
+      def initialize(hash)
+        @key = hash['key']
+        @type = hash['type']
+        @value = hash['value']
+      end
+    end
+  end
+end

data/lib/kameleoon/configuration/variation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'variable'
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # Constant values of types of variations
+    module VariationType
+      VARIATION_OFF = 'off'
+    end
+
+    # Variation of feature flag
+    class Variation
+      attr_accessor :key, :variables
+
+      def self.create_from_array(array)
+        array&.map { |it| Variation.new(it) }
+      end
+
+      def initialize(hash)
+        @key = hash['key']
+        @variables = Variable.create_from_array(hash['variables'])
+      end
+
+      def get_variable_by_key(key)
+        variables.select { |var| var.key == key }.first
+      end
+    end
+  end
+end

data/lib/kameleoon/configuration/variation_exposition.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'experiment'
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Configuration
+    # VariationByExposition represents a variation with exposition rate for rule
+    class VariationByExposition
+      attr_accessor :variation_key, :variation_id, :exposition
+
+      def self.create_from_array(array)
+        array&.map { |it| VariationByExposition.new(it) }
+      end
+
+      def initialize(hash)
+        @variation_key = hash['variationKey']
+        @variation_id = hash['variationId']
+        @exposition = hash['exposition']
+      end
+    end
+  end
+end

data/lib/kameleoon/cookie.rb

@@ -23,15 +23,22 @@ module Kameleoon
     end
 
     def obtain_hash_double(visitor_code, respool_times = {}, container_id = '')
+      obtain_hash_double_helper(visitor_code, respool_times, container_id, '')
+    end
+
+    def obtain_hash_double_rule(visitor_code, container_id = '', suffix = '')
+      obtain_hash_double_helper(visitor_code, {}, container_id, suffix)
+    end
+
+    def obtain_hash_double_helper(visitor_code, respool_times, container_id, suffix)
       identifier = visitor_code.to_s
       identifier += container_id.to_s
-      if !respool_times.nil? && !respool_times.empty?
-        identifier += respool_times.sort.to_h.values.join.to_s
-      end
-      (Digest::SHA256.hexdigest(identifier.encode('UTF-8')).to_i(16) / (BigDecimal("2") ** BigDecimal("256"))).round(16)
+      identifier += suffix.to_s
+      identifier += respool_times.sort.to_h.values.join.to_s if !respool_times.nil? && !respool_times.empty?
+      (Digest::SHA256.hexdigest(identifier.encode('UTF-8')).to_i(16) / (BigDecimal('2')**BigDecimal('256'))).round(16)
     end
-    
-    def check_visitor_code(visitor_code) 
+
+    def check_visitor_code(visitor_code)
       if visitor_code.nil?
         check_default_visitor_code('')
       elsif

data/lib/kameleoon/data.rb

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
+require 'kameleoon/exceptions'
+
 module Kameleoon
   NONCE_LENGTH = 16
 
   module DataType
-    CUSTOM = "CUSTOM"
-    BROWSER = "BROWSER"
-    CONVERSION = "CONVERSION"
-    INTEREST = "INTEREST"
-    PAGE_VIEW = "PAGE_VIEW"
+    CUSTOM = 'CUSTOM'
+    BROWSER = 'BROWSER'
+    CONVERSION = 'CONVERSION'
+    DEVICE = 'DEVICE'
+    PAGE_VIEW = 'PAGE_VIEW'
   end
 
   module BrowserType
@@ -18,6 +22,12 @@ module Kameleoon
     OTHER = 5
   end
 
+  module DeviceType
+    PHONE = 'PHONE'
+    TABLET = 'TABLET'
+    DESKTOP = 'DESKTOP'
+  end
+
   class Data
     attr_accessor :instance, :sent
 
@@ -42,38 +52,42 @@ module Kameleoon
   end
 
   class CustomData < Data
-    attr_accessor :id, :value
+    attr_reader :id, :values
 
     # @param [Integer] id Id of the custom data
     # @param [String] value Value of the custom data
     #
     # @overload
     # @param [Hash] hash Json value encoded in a hash.
-    def initialize(*args)
+    def initialize(arg0, *args)
       @instance = DataType::CUSTOM
       @sent = false
-      unless args.empty?
-        if args.length == 1
-          hash = args.first
-          if hash["id"].nil?
-            raise NotFoundError.new("id")
-          end
-          @id = hash["id"].to_s
-          if hash["value"].nil?
-            raise NotFoundError.new(hash["value"])
-          end
-          @value = hash["value"]
-        elsif args.length == 2
-          @id = args[0].to_s
-          @value = args[1]
+      if arg0.is_a?(Hash)
+        hash = arg0
+        id = hash['id']
+        raise Kameleoon::Exception::NotFound.new('id') if id.nil?
+        @id = id.to_s
+        value = hash['value']
+        values = hash['values']
+        raise Kameleoon::Exception::NotFound.new('values') if values.nil? && value.nil?
+        if values.nil?
+          @values = [value]
+        else
+          @values = values.dup
+          @values.append(value) unless value.nil?
         end
+      else
+        @id = arg0.to_s
+        @values = args
       end
     end
 
     def obtain_full_post_text_line
-      to_encode = "[[\"" + @value.to_s.gsub("\"", "\\\"") + "\",1]]"
+      return '' if @values.empty?
+      
+      str_values = "[[\"#{@values.join('",1],["')}\",1]]"
       nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=customData&index=" + @id.to_s + "&valueToCount=" + encode(to_encode) + "&overwrite=true&nonce=" + nonce
+      "eventType=customData&index=#{@id}&valueToCount=#{encode(str_values)}&overwrite=true&nonce=#{nonce}"
     end
   end
 
@@ -89,7 +103,7 @@ module Kameleoon
 
     def obtain_full_post_text_line
       nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=staticData&browser=" + @browser.to_s + "&nonce=" + nonce
+      "eventType=staticData&browserIndex=" + @browser.to_s + "&nonce=" + nonce
     end
   end
 
@@ -98,22 +112,22 @@ module Kameleoon
 
     # @param [String] url Url of the page
     # @param [String] title Title of the page
-    # @param [Integer] referrer Optional field - Referrer id
-    def initialize(url, title, referrer = nil)
+    # @param [Array] referrers Optional field - Referrer ids
+    def initialize(url, title, referrers = nil)
       @instance = DataType::PAGE_VIEW
       @sent = false
       @url = url
       @title = title
-      @referrer = referrer
+      @referrers = referrers
     end
 
     def obtain_full_post_text_line
       nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      referrer_text = ""
-      unless @referrer.nil?
-        referrer_text = "&referrers=[" + @referrer.to_s + "]"
+      referrer_text = ''
+      unless @referrers.nil?
+        referrer_text = "&referrersIndices=" + @referrers.to_s
       end
-      "eventType=page&href=" + encode(@url) + "&title=" + @title + "&keyPages=[]" + referrer_text + "&nonce=" + nonce
+      "eventType=page&href=" + encode(@url) + "&title=" + @title + referrer_text + "&nonce=" + nonce
     end
   end
 
@@ -137,19 +151,25 @@ module Kameleoon
     end
   end
 
-  class Interest < Data
-    attr_accessor :index
-
-    # @param [Integer] index Index of the interest
-    def initialize(index)
-      @instance = DataType::INTEREST
+  # Device uses for sending deviceType parameter for tracking calls
+  class Device < Data
+    def initialize(device_type)
+      @instance = DataType::DEVICE
       @sent = false
-      @index = index
+      @device_type = device_type
     end
 
     def obtain_full_post_text_line
       nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH)
-      "eventType=interests&indexes=[" + @index.to_s + "]&fresh=true&nonce=" + nonce
+      "eventType=staticData&deviceType=#{@device_type}&nonce=#{nonce}"
+    end
+  end
+
+  # UserAgent uses for changing User-Agent header for tracking calls
+  class UserAgent
+    attr_accessor :value
+    def initialize(value)
+      @value = value
     end
   end
-end
+end

data/lib/kameleoon/exceptions.rb

@@ -1,59 +1,82 @@
+# frozen_string_literal: true
+
 module Kameleoon
   module Exception
+    # Base Error
     class KameleoonError < ::StandardError
       def initialize(message = nil)
-        super("Kameleoon error: " + message)
+        super("Kameleoon error: #{message}")
       end
     end
+
+    # Base Not Found Error
     class NotFound < KameleoonError
-      def initialize(value = "")
-        super(value.to_s + " not found.")
+      def initialize(value = '')
+        super("#{value} not found.")
       end
     end
+
+    # Variation Not Found
     class VariationConfigurationNotFound < NotFound
-      def initialize(id = "")
-        super("Variation " + id.to_s)
+      def initialize(id = '')
+        super("Variation #{id}")
       end
     end
-    class ExperimentConfigurationNotFound	 < NotFound
-      def initialize(id = "")
-        super("Experiment " + id.to_s)
+
+    # Experiment Configuration Not Found
+    class ExperimentConfigurationNotFound	< NotFound
+      def initialize(id = '')
+        super("Experiment #{id}")
       end
     end
+
+    # Feature Flag Configuration Not Found
     class FeatureConfigurationNotFound < NotFound
-      def initialize(id = "")
-        super("Feature flag " + id.to_s)
+      def initialize(id = '')
+        super("Feature flag #{id}")
       end
     end
+
+    # Feature Variable Not Found
     class FeatureVariableNotFound < NotFound
-      def initialize(key = "")
-        super("Feature variable " + key.to_s)
+      def initialize(key = '')
+        super("Feature variable #{key}")
       end
     end
+
+    # Credentials Not Found
     class CredentialsNotFound < NotFound
       def initialize
-        super("Credentials")
+        super('Credentials')
       end
     end
+
+    # Not Targeted (when visitor is not targeted for experiment or feature flag)
     class NotTargeted < KameleoonError
-      def initialize(visitor_code = "")
-        super("Visitor " + visitor_code + " is not targeted.")
+      def initialize(visitor_code = '')
+        super("Visitor #{visitor_code} is not targeted.")
       end
     end
-    class NotActivated < KameleoonError
-      def initialize(visitor_code = "")
-        super("Visitor " + visitor_code + " is not activated.")
+
+    # Not Allocated (when visitor is not allocated for experiment)
+    class NotAllocated < KameleoonError
+      def initialize(visitor_code = '')
+        super("Visitor #{visitor_code} is not targeted.")
       end
     end
+
+    # Visitor Code Not Valod (empty or length > 255)
     class VisitorCodeNotValid < KameleoonError
-      def initialize(message = "")
-        super("Visitor code not valid: " + message)
+      def initialize(message = '')
+        super("Visitor code not valid: #{message}")
       end
     end
+
+    # SiteCode Disabled
     class SiteCodeDisabled < KameleoonError
-      def initialize(message = "")
-        super("Site with siteCode '" + message + "' is disabled")
+      def initialize(message = '')
+        super("Site with siteCode '#{message}' is disabled")
       end
     end
   end
-end
+end

data/lib/kameleoon/factory.rb

@@ -1,26 +1,29 @@
+# frozen_string_literal: true
+
 require 'kameleoon/client'
 
 module Kameleoon
+  # A Factory class for creating kameleoon clients
   module ClientFactory
     CONFIGURATION_UPDATE_INTERVAL = '60m'
-    CONFIG_PATH = "/etc/kameleoon/client-ruby.yaml"
-    DEFAULT_TIMEOUT = 2000 #milli-seconds
+    CONFIG_PATH = '/etc/kameleoon/client-ruby.yaml'
+    DEFAULT_TIMEOUT = 2000 # milli-seconds
+
+    @clients = {}
+
+    def self.create(site_code, config_path = CONFIG_PATH, client_id = nil, client_secret = nil)
+      if @clients[site_code].nil?
+        client = Client.new(site_code, config_path, CONFIGURATION_UPDATE_INTERVAL,
+                            DEFAULT_TIMEOUT, client_id, client_secret)
+        client.send(:log, "Client created with site code: #{site_code}")
+        client.send(:fetch_configuration)
+        @clients.store(site_code, client)
+      end
+      @clients[site_code]
+    end
 
-    ##
-    # Create a kameleoon client object, each call create a new client.
-    # The starting point for using the SDK is the initialization step. All interaction with the SDK is done through an object of the Kameleoon::Client class, therefore you need to create this object via Kameleoon::ClientFactory create static method.
-    #
-    # @param [String] site_code Site code
-    # @param [Boolean] blocking - optional, default is false
-    #
-    # @return [Kameleoon::Client]
-    #
-    def self.create(site_code, blocking = false, config_path = CONFIG_PATH, client_id = nil, client_secret = nil)
-      client = Client.new(site_code, config_path, blocking, CONFIGURATION_UPDATE_INTERVAL, DEFAULT_TIMEOUT, client_id, client_secret)
-      client.send(:log, "Warning: you are using the blocking mode") if blocking
-      client.send(:log, "Client created with site code: " + site_code.to_s)
-      client.send(:fetch_configuration)
-      client
+    def self.forget(site_code)
+      @clients.delete(site_code)
     end
   end
-end
+end

data/lib/kameleoon/hybrid/manager.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module Hybrid
+    TC_INIT = 'window.kameleoonQueue=window.kameleoonQueue||[];'
+    TC_ASSIGN_VARIATION_FORMAT = "window.kameleoonQueue.push(['Experiments.assignVariation',%d,%d]);"
+    TC_TRIGGER_FORMAT = "window.kameleoonQueue.push(['Experiments.trigger',%d,true]);"
+    TC_ASSIGN_VARIATION_TRIGGER_FORMAT = TC_ASSIGN_VARIATION_FORMAT + TC_TRIGGER_FORMAT
+
+    # Will be useful for Ruby 3.0
+    # Abstract Manager class (interface)
+    class Manager
+      def add_variation(_visitor, _experiment_id, _variation_id)
+        raise 'Abstract method `add` called'
+      end
+
+      def get_engine_tracking_code(_visitor)
+        raise 'Abstract method `get_engine_tracking_code` called'
+      end
+    end
+
+    # Implementation of Cache with auto cleaning feature
+    class ManagerImpl < Manager
+      def initialize(expiration_time, cleaning_interval, cache_factory, log_func)
+        super()
+        # synchronization is necessary for adding same visitor_code from different threads
+        @mutex = Mutex.new
+        @expiration_time = expiration_time
+        @cache_factory = cache_factory
+        @log = log_func
+        # it's recommend to use cleaning_interval 3-4 times more than experiation_time for more performance
+        # in this case on every cleaning iteration storage will be cleaned 2/3 - 3/4 of volume
+        @cache = cache_factory.create(expiration_time, cleaning_interval)
+        @log.call('Hybrid Manager was successfully initialized')
+      end
+
+      def add_variation(visitor_code, experiment_id, variation_id)
+        @mutex.synchronize do
+          visitor_cache = @cache.get(visitor_code)
+          visitor_cache = @cache_factory.create(@expiration_time, 0) if visitor_cache.nil?
+          visitor_cache.set(experiment_id, variation_id)
+          @cache.set(visitor_code, visitor_cache)
+        end
+        @log.call("Hybrid Manager successfully added variation for visitor_code: #{visitor_code}, " \
+          "experiment: #{experiment_id}, variation: #{variation_id}")
+      end
+
+      def get_engine_tracking_code(visitor_code)
+        tracking_code = TC_INIT
+        visitor_cache = @cache.get(visitor_code)
+        return tracking_code if visitor_cache.nil?
+
+        visitor_cache.active_items.each_pair do |key, value|
+          tracking_code += format(TC_ASSIGN_VARIATION_TRIGGER_FORMAT, key, value, key)
+        end
+        tracking_code
+      end
+    end
+  end
+end