kameleoon-client-ruby 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '019ae7a1fe145f50f68beea1eb05bcae993d4061a2b1bdb2fe4324fc4215aa39'
-  data.tar.gz: fe9637047ba81b006c1b19a4c85e82fa5641a4d3f666fe14cb28ee243076b6ac
+  metadata.gz: 283250365ae9bf4087ebffeb7a4de0e31cca91f06a865cdd4ad2cae1f88c692c
+  data.tar.gz: 31ab8ddbd1ef7524b41019a0afe442a47ee5b5e9e1d50649ed04aab625d7c3a3
 SHA512:
-  metadata.gz: 5455718dd4a68c584c280e4004ff1c96e28b35d7bfcd9bd8299c68b9d0f3930bd064e16057ce71bbfc386911f106839f54a6398165e6966cad5ce5a4388ccbe9
-  data.tar.gz: 7a2e231a4625c642a56354615999543c26d7e882d8fc7a2c743f7f4f045d01bc88d5dafd227757fd88f308053610f22f21bfa6cbadd79eafe2b7f2bc3a5e03b7
+  metadata.gz: 23f61dd193ad1bb7477ee44e0e2eb5c16bec625748b9ebdde37a9a6b9e71a4610a98c218a4e76addb66a5a55ecf2bcae1764f2aac8d9f9f8ebb6bbc3be86e318
+  data.tar.gz: d27d91e39fb5bc968ba414016642de07baef8ef7888f1d93969ae5fb67f07b903ba60b981de9387fa5c6eb20e99bd647d965fea0123841348f67a8aa66840f99

data/lib/kameleoon/configuration/custom_data_info.rb

@@ -1,25 +1,28 @@
 # frozen_string_literal: true
 
+require 'kameleoon/logging/kameleoon_logger'
+
 module Kameleoon
   # Module which contains all internal data of SDK
   module Configuration
-
     class CustomDataInfo
       attr_reader :local_only, :visitor_scope, :mapping_identifier_index
+
       SCOPE_VISITOR = 'VISITOR'
 
-      def initialize(hashes, log_func = nil)
+      def initialize(hashes)
         @local_only = Set[]
         @visitor_scope = Set[]
-        @log_func = log_func
         unless hashes.nil?
           for hash in hashes
             index = hash['index']
             @local_only.add(index) if hash['localOnly']
             @visitor_scope.add(index) if hash['scope'] == SCOPE_VISITOR
             if hash['isMappingIdentifier']
-              if @mapping_identifier_index != nil
-                @log_func&.call('More than one mapping identifier is set. Undefined behavior may occur on cross-device reconciliation.')
+              unless @mapping_identifier_index.nil?
+                Logging::KameleoonLogger.warning('More than one mapping identifier is set. Undefined behavior ' \
+                                          'may occur on cross-device reconciliation.')
+
               end
               @mapping_identifier_index = index
             end
@@ -27,17 +30,22 @@ module Kameleoon
         end
       end
 
-      def local_only? (index)
+      def local_only?(index)
         @local_only.include?(index)
       end
 
-      def mapping_identifier? (index)
+      def mapping_identifier?(index)
         index == @mapping_identifier_index
       end
 
-      def visitor_scope? (index)
+      def visitor_scope?(index)
         @visitor_scope.include?(index)
       end
+
+      def self.mapping_identifier?(custom_data_info, custom_data)
+        !custom_data_info.nil? && (custom_data.id == custom_data_info.mapping_identifier_index) && \
+          !(custom_data.values.empty? || custom_data.values[0].empty?)
+      end
     end
   end
 end

data/lib/kameleoon/configuration/data_file.rb

@@ -3,32 +3,32 @@
 require 'kameleoon/configuration/settings'
 require 'kameleoon/configuration/feature_flag'
 require 'kameleoon/configuration/custom_data_info'
+require 'kameleoon/logging/kameleoon_logger'
 
 module Kameleoon
   module Configuration
     class DataFile
       attr_reader :settings, :feature_flags, :has_any_targeted_delivery_rule, :feature_flag_by_id, :rule_by_segment_id,
-                  :variation_by_id, :custom_data_info
+                  :variation_by_id, :custom_data_info, :experiment_ids_with_js_css_variable
 
-      def initialize(environment, log_func = nil)
-        @settings = Settings.new
-        @feature_flags = {}
-        @environment = environment
-        @log_func = log_func
-        collect_indices
-        @custom_data_info = Kameleoon::Configuration::CustomDataInfo.new(nil, @log_func)
+      def to_s
+        'DataFile{' \
+          "environment:#{@environment}," \
+          "feature_flags:#{@feature_flags.size}," \
+          "settings:#{@settings}" \
+          '}'
       end
 
-      def init(configuration)
-        @settings.update(configuration['configuration'])
-        configuration['featureFlags'].each do |raw|
-          ff = FeatureFlag.new(raw)
-          @feature_flags[ff.feature_key] = ff
+      def initialize(environment, configuration = nil)
+        Logging::KameleoonLogger.debug('CALL: DataFile.new(environment: %s)', environment)
+        @environment = environment
+        if configuration.nil?
+          init_default
+        else
+          init(configuration)
         end
-        @has_any_targeted_delivery_rule = any_targeted_delivery_rule?
         collect_indices
-        @custom_data_info = CustomDataInfo.new(configuration['customData'], @log_func)
-        self
+        Logging::KameleoonLogger.debug('RETURN: DataFile.new(environment: %s)', environment)
       end
 
       def get_feature_flag(feature_key)
@@ -39,8 +39,34 @@ module Kameleoon
         ff
       end
 
+      def experiment_js_css_variable?(experiment_id)
+        @experiment_ids_with_js_css_variable.include?(experiment_id)
+      end
+
       private
 
+      def init_default
+        Logging::KameleoonLogger.debug('CALL: DataFile.init_default')
+        @settings = Settings.new
+        @feature_flags = {}
+        @has_any_targeted_delivery_rule = false
+        @custom_data_info = Kameleoon::Configuration::CustomDataInfo.new(nil)
+        Logging::KameleoonLogger.debug('RETURN: DataFile.init_default')
+      end
+
+      def init(configuration)
+        Logging::KameleoonLogger.debug('CALL: DataFile.init(configuration: %s)', configuration)
+        @settings = Settings.new(configuration['configuration'])
+        @feature_flags = {}
+        configuration['featureFlags'].each do |raw|
+          ff = FeatureFlag.new(raw)
+          @feature_flags[ff.feature_key] = ff
+        end
+        @has_any_targeted_delivery_rule = any_targeted_delivery_rule?
+        @custom_data_info = CustomDataInfo.new(configuration['customData'])
+        Logging::KameleoonLogger.debug('RETURN: DataFile.init(configuration: %s)', configuration)
+      end
+
       def any_targeted_delivery_rule?
         @feature_flags.any? { |_, ff| ff.environment_enabled && ff.rules.any?(&:targeted_delivery_type?) }
       end
@@ -49,21 +75,31 @@ module Kameleoon
         @feature_flag_by_id = {}
         @rule_by_segment_id = {}
         @variation_by_id = {}
+        @experiment_ids_with_js_css_variable = Set.new
 
         @feature_flags.each_value do |feature_flag|
           @feature_flag_by_id[feature_flag.id] = feature_flag
           next if feature_flag.rules.nil?
 
+          has_feature_flag_variable_js_css = feature_flag_variable_js_css?(feature_flag)
           feature_flag.rules.each do |rule|
             @rule_by_segment_id[rule.segment_id] = rule
             rule.variation_by_exposition.each do |variation|
               @variation_by_id[variation.variation_id] = variation
             end
+            @experiment_ids_with_js_css_variable.add(rule.experiment_id) if has_feature_flag_variable_js_css
           end
         end
         @feature_flag_by_id.freeze
         @rule_by_segment_id.freeze
         @variation_by_id.freeze
+        @experiment_ids_with_js_css_variable.freeze
+      end
+
+      def feature_flag_variable_js_css?(feature_flag)
+        feature_flag.variations.first&.variables&.any? do |variable|
+          %w[JS CSS].include?(variable.type)
+        end
       end
     end
   end

data/lib/kameleoon/configuration/feature_flag.rb

@@ -14,6 +14,16 @@ module Kameleoon
         array&.map { |it| FeatureFlag.new(it) }
       end
 
+      def to_s
+        'FeatureFlag{' \
+          "id:#{@id}, " \
+          "feature_key:#{@feature_key}, " \
+          "environment_enabled:#{@environment_enabled}, " \
+          "default_variation_key:#{@default_variation_key}, " \
+          "rules:#{@rules.size}" \
+          '}'
+      end
+
       def initialize(hash)
         @id = hash['id']
         @feature_key = hash['featureKey']
@@ -23,7 +33,7 @@ module Kameleoon
         @rules = Rule.create_from_array(hash['rules'])
       end
 
-      def get_variation_key(key)
+      def get_variation_by_key(key)
         variations.select { |v| v.key == key }.first
       end
     end

data/lib/kameleoon/configuration/rule.rb

@@ -36,6 +36,10 @@ module Kameleoon
         array&.map { |it| Rule.new(it) }
       end
 
+      def to_s
+        "Rule{id:#{@id}}"
+      end
+
       def initialize(hash)
         @id = hash['id']
         @order = hash['order']

data/lib/kameleoon/configuration/settings.rb

@@ -9,16 +9,21 @@ module Kameleoon
       attr_accessor :real_time_update
       attr_reader :is_consent_required, :data_api_domain
 
-      def initialize
-        @real_time_update = false
-        @is_consent_required = false
-        @data_api_domain = nil
+      def to_s
+        "Settings{real_time_update:#{@real_time_update},is_consent_required:#{@is_consent_required}," \
+          "data_api_domain:#{@data_api_domain}}"
       end
 
-      def update(configuration)
-        @real_time_update = configuration['realTimeUpdate'] || false
-        @is_consent_required = configuration['consentType'] == 'REQUIRED'
-        @data_api_domain = configuration['dataApiDomain']
+      def initialize(configuration = nil)
+        if configuration.nil?
+          @real_time_update = false
+          @is_consent_required = false
+          @data_api_domain = nil
+        else
+          @real_time_update = configuration['realTimeUpdate'] || false
+          @is_consent_required = configuration['consentType'] == 'REQUIRED'
+          @data_api_domain = configuration['dataApiDomain']
+        end
       end
     end
   end

data/lib/kameleoon/configuration/variation_exposition.rb

@@ -11,6 +11,10 @@ module Kameleoon
         array&.map { |it| VariationByExposition.new(it) }
       end
 
+      def to_s
+        "VariationByExposition{exposition:#{@exposition},variation_key:#{@variation_key},variation_id:#{@variation_id}}"
+      end
+
       def initialize(hash)
         @variation_key = hash['variationKey']
         @variation_id = hash['variationId']

data/lib/kameleoon/data/browser.rb

@@ -37,6 +37,10 @@ module Kameleoon
   class Browser < DuplicationUnsafeData
     attr_reader :type, :version
 
+    def to_s
+      "Browser{type:#{@type},version:#{@version}}"
+    end
+
     # @param [BrowserType] browser_type Browser type, can be: CHROME, INTERNET_EXPLORER, FIREFOX, SAFARI, OPERA, OTHER
     # @param [float] version Version of browser
     def initialize(browser_type, version = Float::NAN)

data/lib/kameleoon/data/conversion.rb

@@ -9,6 +9,10 @@ module Kameleoon
   class Conversion < DuplicationSafeData
     attr_reader :goal_id, :revenue, :negative
 
+    def to_s
+      "Conversion{goal_id:#{@goal_id},revenue:#{@revenue},negative:#{@negative}}"
+    end
+
     # @param [Integer] goal_id Id of the goal associated to the conversion
     # @param [Float] revenue Optional field - Revenue associated to the conversion.
     # @param [Boolean] negative Optional field - If the revenue is negative. By default it's positive.

data/lib/kameleoon/data/cookie.rb

@@ -9,6 +9,10 @@ module Kameleoon
     def initialize(cookies)
       @cookies = cookies
     end
+
+    def to_s
+      "Cookie{cookies:#{@cookies}}"
+    end
   end
 end
 

data/lib/kameleoon/data/custom_data.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'kameleoon/logging/kameleoon_logger'
 require 'kameleoon/network/uri_helper'
 require_relative 'data'
 
@@ -8,7 +9,10 @@ module Kameleoon
   # Represents any custom data for targeting conditions
   class CustomData < DuplicationUnsafeData
     attr_reader :id, :values
-    attr_accessor :is_mapping_identifier
+
+    def to_s
+      "CustomData{id:#{@id},values:#{@values}}"
+    end
 
     # @param [Integer] id Id of the custom data
     # @param [String] value Value of the custom data
@@ -33,9 +37,14 @@ module Kameleoon
         @id = arg0
         @values = args
       end
+
+      if @values.empty?
+        Logging::KameleoonLogger.error('Created a custom data %s with no values. It will not be tracked.', @id)
+      end
+
       return if @id.is_a?(Integer)
 
-      warn "CustomData field 'id' must be of 'Integer' type"
+      Logging::KameleoonLogger.warning("CustomData field 'id' must be of 'Integer' type")
       @id = @id.is_a?(String) ? @id.to_i : -1
     end
     # rubocop:enable Metrics/MethodLength
@@ -51,7 +60,6 @@ module Kameleoon
         overwrite: 'true',
         nonce: nonce
       }
-      params[:mappingIdentifier] = is_mapping_identifier if is_mapping_identifier
       Kameleoon::Network::UriHelper.encode_query(params)
     end
   end

data/lib/kameleoon/data/data.rb

@@ -18,21 +18,47 @@ module Kameleoon
     GEOLOCATION = 'GEOLOCATION'
   end
 
+  module DataState
+    UNSENT = 0
+    TRANSMITTING = 1
+    SENT = 2
+  end
+
   # Represents base class for any Kameleoon data
   class Data
-    attr_reader :instance, :sent
+    attr_reader :instance
 
     def initialize(data_type)
       @instance = data_type
-      @sent = false
+      @state = DataState::UNSENT
     end
 
     def obtain_full_post_text_line
       raise KameleoonError.new('ToDo: implement this method.'), 'ToDo: implement this method.'
     end
 
+    def unsent
+      @state == DataState::UNSENT
+    end
+
+    def transmitting
+      @state == DataState::TRANSMITTING
+    end
+
+    def sent
+      @state == DataState::SENT
+    end
+
+    def mark_as_unsent
+      @state = DataState::UNSENT if transmitting
+    end
+
+    def mark_as_transmitting
+      @state = DataState::TRANSMITTING if unsent
+    end
+
     def mark_as_sent
-      @sent = true
+      @state = DataState::SENT
       @nonce = nil
     end
   end
@@ -52,7 +78,7 @@ module Kameleoon
     private
 
     def nonce
-      @nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH) if !@sent && @nonce.nil?
+      @nonce = Kameleoon::Utils.generate_random_string(NONCE_LENGTH) if !sent && @nonce.nil?
       @nonce
     end
   end

data/lib/kameleoon/data/device.rb

@@ -15,6 +15,10 @@ module Kameleoon
   class Device < DuplicationUnsafeData
     attr_reader :device_type
 
+    def to_s
+      "Device{device_type:#{@device_type}}"
+    end
+
     def initialize(device_type)
       super(DataType::DEVICE)
       @device_type = device_type

data/lib/kameleoon/data/geolocation.rb

@@ -5,6 +5,11 @@ module Kameleoon
   class Geolocation < DuplicationUnsafeData
     attr_reader :country, :region, :city, :postal_code, :latitude, :longitude
 
+    def to_s
+      "Geolocation{country:'#{@country}',region:'#{@region}',city:'#{@city}',postal_code:'#{@postal_code}'," \
+        "latitude:#{@latitude},longitude:#{@longitude}}"
+    end
+
     # @param [String] country Country of visitor's geolocation. Required
     # @param [String] region Region of visitor's geolocation. Optional
     # @param [String] city City of visitor's geolocation. Optional

data/lib/kameleoon/data/kcs_heat.rb

@@ -9,4 +9,8 @@ module Kameleoon
       @values.freeze
     end
   end
+
+  def to_s
+    "KcsHeat{values:#{@values}}"
+  end
 end

data/lib/kameleoon/data/manager/assigned_variation.rb

@@ -13,7 +13,14 @@ module Kameleoon
 
       attr_reader :experiment_id, :variation_id, :rule_type, :assignment_time
 
-      def initialize(experiment_id, variation_id, rule_type = Kameleoon::Configuration::RuleType::UNKNOWN, assignment_time: nil)
+      def to_s
+        "AssignedVariation{experiment_id:#{@experiment_id},variation_id:#{@variation_id}," \
+          "assignment_time:#{@assignment_time},rule_type:#{@rule_type}}"
+      end
+
+      def initialize(
+        experiment_id, variation_id, rule_type = Kameleoon::Configuration::RuleType::UNKNOWN, assignment_time: nil
+      )
         super(DataType::ASSIGNED_VARIATION)
         @experiment_id = experiment_id
         @variation_id = variation_id

data/lib/kameleoon/data/manager/data_array_storage.rb

@@ -6,6 +6,13 @@ module Kameleoon
     # DataArrayStorage is a readonly accessor to a sequntial storage of specific visitor data.
     # It is thread-safe
     class DataArrayStorage
+
+      def to_s
+        values = []
+        enumerate { |v| values << v }
+        "DataArrayStorage{values:#{values.join(',')}}"
+      end
+
       def initialize(mutex, array)
         @mutex = mutex
         @array = array

data/lib/kameleoon/data/manager/data_map_storage.rb

@@ -6,6 +6,13 @@ module Kameleoon
     # DataMapStorage is a readonly accessor to a key-value based storage of specific visitor data.
     # It is thread-safe
     class DataMapStorage
+
+      def to_s
+        values = []
+        enumerate { |v| values << v }
+        "DataMapStorage{values:#{values.join(',')}}"
+      end
+
       def initialize(mutex, map)
         @mutex = mutex
         @map = map

data/lib/kameleoon/data/manager/page_view_visit.rb

@@ -5,6 +5,10 @@ module Kameleoon
     class PageViewVisit
       attr_reader :page_view, :count, :last_timestamp
 
+      def to_s
+        "PageViewVisit{last_timestamp:#{@last_timestamp},count:#{@count},page_view:#{@page_view}}"
+      end
+
       def initialize(page_view, count = 1, timestamp = nil)
         @page_view = page_view
         @count = count