kameleoon-client-ruby 3.2.0 → 3.4.0

data/lib/kameleoon/targeting/conditions/visit_number_total_condition.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
+require 'kameleoon/data/visitor_visits'
 require 'kameleoon/targeting/conditions/number_condition'
 
 module Kameleoon
   # @api private
   module Targeting
-
     class VisitNumberTotalCondition < NumberCondition
       def initialize(json_condition)
         visit_count = json_condition['visitCount']
@@ -13,8 +13,10 @@ module Kameleoon
       end
 
       def check(data)
-        return false unless data.is_a?(Kameleoon::VisitorVisits) && @condition_value != nil
-        check_targeting(data.previous_visit_timestamps.size + 1) # +1 for current visit
+        return false unless VisitorVisits.visitor_visits?(data) && !@condition_value.nil?
+
+        previous_visit_timestamps = VisitorVisits.get_previous_visit_timestamps(data)
+        check_targeting(previous_visit_timestamps.size + 1) # +1 for current visit
       end
     end
   end

data/lib/kameleoon/targeting/conditions/visitor_new_return_condition.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'kameleoon/data/cookie'
-require 'kameleoon/version'
+require 'kameleoon/data/visitor_visits'
 
 module Kameleoon
   # @api private
@@ -18,14 +17,16 @@ module Kameleoon
       end
 
       def check(data)
-        return false unless data.is_a?(Kameleoon::VisitorVisits)
+        return false unless VisitorVisits.visitor_visits?(data)
+
+        previous_visit_timestamps = VisitorVisits.get_previous_visit_timestamps(data)
         case @visitor_type
         when VisitorType::NEW
-          return data.previous_visit_timestamps.size == 0
+          previous_visit_timestamps.empty?
         when VisitorType::RETURNING
-          return data.previous_visit_timestamps.size > 0
+          !previous_visit_timestamps.empty?
         else
-          return false
+          false
         end
       end
     end

data/lib/kameleoon/targeting/models.rb

@@ -10,7 +10,6 @@ module Kameleoon
       include TreeBuilder
       attr_accessor :id, :tree
       def to_s
-        print("\nSegment id: #{@id}\n")
         @tree.to_s
       end
 
@@ -49,19 +48,6 @@ module Kameleoon
     class Tree
       attr_accessor :or_operator, :left_child, :right_child, :condition
 
-      def to_s
-        print("or_operator: #{@or_operator}\n")
-        print("condition: #{@condition}")
-        unless @left_child.nil?
-          print('\nLeft child:\n    ')
-          @left_child.to_s
-        end
-        unless @right_child.nil?
-          print('\nright child:\n    ')
-          @right_child.to_s
-        end
-      end
-
       def initialize(or_operator = nil, left_child = nil, right_child = nil, condition = nil)
         @or_operator = Marshal.load(Marshal.dump(or_operator))
         @left_child = left_child

data/lib/kameleoon/targeting/targeting_manager.rb

@@ -1,25 +1,45 @@
 # frozen_string_literal: true
 
+require 'kameleoon/logging/kameleoon_logger'
 require 'kameleoon/targeting/conditions/segment_condition'
 
 module Kameleoon
   # @api private
   module Targeting
     class TargetingManager
-      def initialize(visitor_manager, data_file)
+      def initialize(data_manager, visitor_manager)
+        @data_manager = data_manager
         @visitor_manager = visitor_manager
-        @data_file = data_file
       end
 
       def check_targeting(visitor_code, campaign_id, exp_ff_rule)
+        Logging::KameleoonLogger.debug(
+          "CALL: TargetingManager.check_targeting(visitorCode: '%s', campaignId: %s, exp_ff_rule: %s)",
+          visitor_code, campaign_id, exp_ff_rule
+        )
         segment = exp_ff_rule.targeting_segment
-        return true if segment.nil?
+        if segment.nil?
+          Logging::KameleoonLogger.debug(
+            "RETURN: TargetingManager.check_targeting(visitorCode: '%s', campaignId: %s, exp_ff_rule: %s) -> " \
+              '(targeting: true)', visitor_code, campaign_id, exp_ff_rule
+          )
+          return true
+        end
 
         visitor = @visitor_manager.get_visitor(visitor_code)
-        segment.check_tree(->(type) { get_condition_data(type, visitor, visitor_code, campaign_id) })
+        targeting = segment.check_tree(->(type) { get_condition_data(type, visitor, visitor_code, campaign_id) })
+        Logging::KameleoonLogger.debug(
+          "RETURN: TargetingManager.check_targeting(visitorCode: '%s', campaignId: %s, exp_ff_rule: %s) -> " \
+            '(targeting: %s)', visitor_code, campaign_id, exp_ff_rule, targeting
+        )
+        targeting
       end
 
       def get_condition_data(type, visitor, visitor_code, campaign_id)
+        Logging::KameleoonLogger.debug(
+          "CALL: TargetingManager.get_condition_data(type: %s, visitor, visitorCode: '%s', campaignId: %s)",
+          type, visitor_code, campaign_id
+        )
         condition_data = nil
         case type
         when Kameleoon::Targeting::ConditionType::CUSTOM_DATUM
@@ -41,7 +61,7 @@ module Kameleoon
           condition_data = visitor.operating_system unless visitor.nil?
         when Kameleoon::Targeting::ConditionType::SEGMENT
           condition_data = SegmentInfo.new(
-            @data_file,
+            @data_manager.data_file,
             lambda { |type|
               get_condition_data(type, visitor, visitor_code, campaign_id)
             }
@@ -53,12 +73,22 @@ module Kameleoon
         when Kameleoon::Targeting::ConditionType::VISITOR_CODE
           condition_data = visitor_code
         when Kameleoon::Targeting::ConditionType::TARGET_FEATURE_FLAG
-          condition_data = TargetFeatureFlagInfo.new(@data_file, visitor.variations) unless visitor.nil?
+          condition_data = TargetFeatureFlagInfo.new(@data_manager.data_file, visitor.variations) unless visitor.nil?
         when Kameleoon::Targeting::ConditionType::EXCLUSIVE_FEATURE_FLAG
           condition_data = ExclusiveFeatureFlagInfo.new(campaign_id, visitor&.variations)
-        when ConditionType::FIRST_VISIT, ConditionType::LAST_VISIT, ConditionType::VISITS, ConditionType::SAME_DAY_VISITS, ConditionType::NEW_VISITORS
+        when ConditionType::FIRST_VISIT,
+          ConditionType::LAST_VISIT,
+          ConditionType::VISITS,
+          ConditionType::SAME_DAY_VISITS,
+          ConditionType::NEW_VISITORS
           condition_data = visitor.visitor_visits unless visitor.nil?
+        when Kameleoon::Targeting::ConditionType::HEAT_SLICE
+          condition_data = visitor&.kcs_heat
         end
+        Logging::KameleoonLogger.debug(
+          "RETURN: TargetingManager.get_condition_data(type: %s, visitor, visitor_code: '%s', campaign_id: %s) -> " \
+            '(condition_data: %s)', type, visitor_code, campaign_id, condition_data
+        )
         condition_data
       end
     end

data/lib/kameleoon/targeting/tree_builder.rb

@@ -1,4 +1,5 @@
 require 'kameleoon/targeting/condition_factory'
+require 'kameleoon/logging/kameleoon_logger'
 
 module Kameleoon
   #@api private
@@ -6,13 +7,17 @@ module Kameleoon
     module TreeBuilder
 
       def create_tree(conditions_data_json)
-        if conditions_data_json.nil?
-          return nil
-        end
+        return nil if conditions_data_json.nil?
+
+        Logging::KameleoonLogger.debug('CALL: TreeBuilder.create_tree(conditions_data_json: %s)',
+                                       conditions_data_json)
         if conditions_data_json['firstLevel'].empty?
           conditions_data_json['firstLevelOrOperators'] = []
         end
-        create_first_level(conditions_data_json)
+        tree = create_first_level(conditions_data_json)
+        Logging::KameleoonLogger.debug('RETURN: TreeBuilder.create_tree(conditions_data_json: %s) -> (tree)',
+                                       conditions_data_json)
+        tree
       end
 
       private
@@ -69,4 +74,4 @@ module Kameleoon
       end
     end
   end
-end
+end

data/lib/kameleoon/types/remote_visitor_data_filter.rb

@@ -3,11 +3,28 @@
 module Kameleoon
   # Module which contains all internal data of SDK
   module Types
-
     class RemoteVisitorDataFilter
-      attr_reader :previous_visit_amount, :current_visit, :custom_data, :page_views, :geolocation, :device, :browser, :operating_system, :conversions, :experiments
+      attr_reader :previous_visit_amount, :current_visit, :custom_data, :page_views, :geolocation, :device, :browser,
+                  :operating_system, :conversions, :experiments, :kcs
+
+      def to_s
+        "RemoteVisitorDataFilter{previous_visit_amount:#{@previous_visit_amount}," \
+          "current_visit:#{@current_visit}," \
+          "custom_data:#{@custom_data}," \
+          "page_views:#{@page_views}," \
+          "geolocation:#{@geolocation}," \
+          "device:#{@device}," \
+          "browser:#{@browser}," \
+          "operating_system:#{@operating_system}," \
+          "conversions:#{@conversions}," \
+          "experiments:#{@experiments},kcs:#{@kcs}}"
+      end
 
-      def initialize(previous_visit_amount: 1, current_visit: true, custom_data: true, page_views: false, geolocation: false, device: false, browser: false, operating_system: false, conversions: false, experiments: false)
+      def initialize(
+        previous_visit_amount: 1, current_visit: true, custom_data: true, page_views: false,
+        geolocation: false, device: false, browser: false, operating_system: false, conversions: false,
+        experiments: false, kcs: false
+      )
         @previous_visit_amount = previous_visit_amount
         @current_visit = current_visit
         @custom_data = custom_data
@@ -18,6 +35,7 @@ module Kameleoon
         @operating_system = operating_system
         @conversions = conversions
         @experiments = experiments
+        @kcs = kcs
       end
     end
   end

data/lib/kameleoon/types/variable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Types
+    # Variable
+    class Variable
+      attr_reader :key, :type, :value
+
+      def to_s
+        "Variable{key:'#{@key}',type:'#{@type}',value:#{@value}}"
+      end
+
+      def initialize(key, type, value)
+        @key = key
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/kameleoon/types/variation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Module which contains all internal data of SDK
+  module Types
+    # Variation
+    class Variation
+      attr_reader :key, :id, :experiment_id, :variables
+
+      def to_s
+        "Variation{key:'#{@key}',id:#{@id},experiment_id:#{@experiment_id},variables:#{@variables}}"
+      end
+
+      def initialize(key, id, experiment_id, variables)
+        @key = key
+        @id = id
+        @experiment_id = experiment_id
+        @variables = variables
+      end
+    end
+  end
+end

data/lib/kameleoon/utils.rb

@@ -50,5 +50,23 @@ module Kameleoon
         (Digest::SHA256.hexdigest(identifier.encode('UTF-8')).to_i(16) / (BigDecimal('2')**BigDecimal('256'))).round(16)
       end
     end
+
+    module Strval
+
+      def self.secret(secret)
+        hid_ch = '*'
+        vis_count = 4
+
+        return 'nil' if secret.nil?
+
+        length = secret.length
+
+        return hid_ch * length if length <= vis_count
+
+        hidden_length = [length - vis_count, vis_count].max
+
+        secret[0, length - hidden_length] + hid_ch * hidden_length
+      end
+    end
   end
 end

data/lib/kameleoon/version.rb

@@ -1,32 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
+  SDK_VERSION = '3.4.0'
   SDK_NAME = 'RUBY'
-  SDK_VERSION = '3.2.0'
-
-  # SdkManager is a helper method for fetching / obtaining version of SDK from string
-  class SdkVersion
-    def self.get_version_components(version_string)
-      versions = [0, 0, 0]
-
-      version_parts = version_string.split('.')
-      version_parts.each_with_index do |part, i|
-        versions[i] = Integer(part)
-      rescue ArgumentError
-        puts "Invalid version component, index: #{i}, value: #{part}"
-        return nil
-      end
-      versions
-    end
-
-    def self.get_float_version(version_string)
-      version_components = get_version_components(version_string)
-
-      return Float::NAN if version_components.nil?
-
-      major = version_components[0]
-      minor = version_components[1]
-      "#{major}.#{minor}".to_f
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -91,14 +91,17 @@ files:
 - lib/kameleoon/data/data.rb
 - lib/kameleoon/data/device.rb
 - lib/kameleoon/data/geolocation.rb
+- lib/kameleoon/data/kcs_heat.rb
 - lib/kameleoon/data/manager/assigned_variation.rb
 - lib/kameleoon/data/manager/data_array_storage.rb
 - lib/kameleoon/data/manager/data_map_storage.rb
 - lib/kameleoon/data/manager/page_view_visit.rb
 - lib/kameleoon/data/manager/visitor.rb
 - lib/kameleoon/data/manager/visitor_manager.rb
+- lib/kameleoon/data/mapping_identifier.rb
 - lib/kameleoon/data/operating_system.rb
 - lib/kameleoon/data/page_view.rb
+- lib/kameleoon/data/unique_identifier.rb
 - lib/kameleoon/data/user_agent.rb
 - lib/kameleoon/data/visitor_visits.rb
 - lib/kameleoon/exceptions.rb
@@ -106,8 +109,15 @@ files:
 - lib/kameleoon/kameleoon_client.rb
 - lib/kameleoon/kameleoon_client_config.rb
 - lib/kameleoon/kameleoon_client_factory.rb
+- lib/kameleoon/logging/default_logger.rb
+- lib/kameleoon/logging/kameleoon_logger.rb
+- lib/kameleoon/logging/logger.rb
+- lib/kameleoon/managers/data/data_manager.rb
 - lib/kameleoon/managers/remote_data/remote_data_manager.rb
 - lib/kameleoon/managers/remote_data/remote_visitor_data.rb
+- lib/kameleoon/managers/tracking/tracking_builder.rb
+- lib/kameleoon/managers/tracking/tracking_manager.rb
+- lib/kameleoon/managers/tracking/visitor_tracking_registry.rb
 - lib/kameleoon/managers/warehouse/warehouse_manager.rb
 - lib/kameleoon/network/access_token_source.rb
 - lib/kameleoon/network/activity_event.rb
@@ -125,6 +135,7 @@ files:
 - lib/kameleoon/real_time/sse_client.rb
 - lib/kameleoon/real_time/sse_message.rb
 - lib/kameleoon/real_time/sse_request.rb
+- lib/kameleoon/sdk_version.rb
 - lib/kameleoon/storage/cache.rb
 - lib/kameleoon/storage/cache_factory.rb
 - lib/kameleoon/targeting/condition.rb
@@ -136,6 +147,7 @@ files:
 - lib/kameleoon/targeting/conditions/device_condition.rb
 - lib/kameleoon/targeting/conditions/exclusive_feature_flag_condition.rb
 - lib/kameleoon/targeting/conditions/geolocation_condition.rb
+- lib/kameleoon/targeting/conditions/kcs_heat_range_condition.rb
 - lib/kameleoon/targeting/conditions/number_condition.rb
 - lib/kameleoon/targeting/conditions/operating_system_condition.rb
 - lib/kameleoon/targeting/conditions/page_title_condition.rb
@@ -156,6 +168,8 @@ files:
 - lib/kameleoon/targeting/targeting_manager.rb
 - lib/kameleoon/targeting/tree_builder.rb
 - lib/kameleoon/types/remote_visitor_data_filter.rb
+- lib/kameleoon/types/variable.rb
+- lib/kameleoon/types/variation.rb
 - lib/kameleoon/utils.rb
 - lib/kameleoon/version.rb
 homepage: https://developers.kameleoon.com/ruby-sdk.html