kameleoon-client-ruby 3.14.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5566ec9ff02ebb63ff3ee337f4c26fc0c229f2de8df0893fe85dc3f83fbc0ce
-  data.tar.gz: fcd11bacbaead7a0c357a0fd4828fb6c4b7347ebf1fab728f4e00882b0224dc7
+  metadata.gz: 07240065fc16f98169c01fd4367321b2f633d79373f293b0bcf110f68d920d46
+  data.tar.gz: 52b83806f28aa0035eb8df2db89f84b98b774e2a53b0fd8a7c5abd71b0a59ac4
 SHA512:
-  metadata.gz: 78418ebd561b9d1fe2639751d0dae68a875a4a76f4782ac079fe2f3f3c6e2b7466c41cb762e978b4895973a97ddf4940b10171d36c2695a565ed2e1b66445f53
-  data.tar.gz: b91b577c23c13547d78c09c98a2c39bb788a314b280b50c57bf1cc25891dd74747127aec2bc14b0a5a4908a2cde2d0e2089ec13c6f5200087b7c52bd80b7a68f
+  metadata.gz: 88e8da4ec50eca784dd49b5861f373d84e60eaa521894d095104c10d6d469cb8e20d4fbf98416a473790fe77842411e4021beed153a4a4bb784603b90360abd0
+  data.tar.gz: 9068a2d4b8dfaff1020933c9e38e133965486ef0ddc722db19dd7eeee28a0327926d4d3beb1b17460615da176620699a2f7dcc5ada1dc63db4e6696aaa080131

data/lib/kameleoon/configuration/data_file.rb

@@ -11,9 +11,9 @@ require 'kameleoon/targeting/models'
 module Kameleoon
   module Configuration
     class DataFile
-      attr_reader :last_modified, :settings, :feature_flags, :me_groups, :has_any_targeted_delivery_rule,
-                  :feature_flag_by_id, :rule_by_segment_id, :rule_info_by_exp_id, :variation_by_id, :custom_data_info,
-                  :experiment_ids_with_js_css_variable, :holdout
+      attr_reader :last_modified, :settings, :segments, :audience_tracking_segments, :feature_flags, :me_groups,
+                  :has_any_targeted_delivery_rule, :feature_flag_by_id, :rule_info_by_exp_id, :variation_by_id,
+                  :custom_data_info, :experiment_ids_with_js_css_variable, :holdout
 
       def to_s
         'DataFile{' \
@@ -70,9 +70,9 @@ module Kameleoon
       def init(configuration)
         Logging::KameleoonLogger.debug('CALL: DataFile.init(configuration: %s)', configuration)
         @settings = Settings.new(configuration['configuration'])
-        segments = parse_segments(configuration)
+        @segments, @audience_tracking_segments = parse_segments(configuration)
         @custom_data_info = CustomDataInfo.new(configuration['customData'])
-        @feature_flags = parse_feature_flags(configuration, segments, @custom_data_info)
+        @feature_flags = parse_feature_flags(configuration, @custom_data_info)
         @me_groups = make_me_groups(@feature_flags)
         @has_any_targeted_delivery_rule = any_targeted_delivery_rule?
         @holdout = Experiment.from_json(configuration['holdout']) if configuration.include?('holdout')
@@ -80,15 +80,20 @@ module Kameleoon
       end
 
       def parse_segments(configuration)
-        configuration['segments'].to_h do |raw_seg|
+        audience_tracking_segments = []
+        segments = configuration['segments'].to_h do |raw_seg|
           seg = Targeting::Segment.new(raw_seg)
+          audience_tracking_segments.push(seg) if seg.audience_tracking
           [seg.id, seg]
         end
+        segments.freeze
+        audience_tracking_segments.freeze
+        [segments, audience_tracking_segments]
       end
 
-      def parse_feature_flags(configuration, segments, cdi)
+      def parse_feature_flags(configuration, cdi)
         configuration['featureFlags'].to_h do |raw_ff|
-          ff = FeatureFlag.new(raw_ff, segments, cdi)
+          ff = FeatureFlag.new(raw_ff, @segments, cdi)
           [ff.feature_key, ff]
         end
       end
@@ -99,7 +104,6 @@ module Kameleoon
 
       def collect_indices
         @feature_flag_by_id = {}
-        @rule_by_segment_id = {}
         @rule_info_by_exp_id = {}
         @variation_by_id = {}
         @experiment_ids_with_js_css_variable = Set.new
@@ -110,7 +114,6 @@ module Kameleoon
 
           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_info_by_exp_id[rule.experiment.id] = RuleInfo.new(feature_flag, rule)
             rule.experiment.variations_by_exposition.each do |variation|
               @variation_by_id[variation.variation_id] = variation
@@ -119,7 +122,6 @@ module Kameleoon
           end
         end
         @feature_flag_by_id.freeze
-        @rule_by_segment_id.freeze
         @variation_by_id.freeze
         @experiment_ids_with_js_css_variable.freeze
       end

data/lib/kameleoon/data/data.rb

@@ -19,6 +19,7 @@ module Kameleoon
     OPERATING_SYSTEM = 'OPERATING_SYSTEM'
     GEOLOCATION = 'GEOLOCATION'
     VISITOR_VISITS = 'VISITOR_VISITS'
+    TARGETED_SEGMENT = 'TARGETED_SEGMENT'
   end
 
   module DataState

data/lib/kameleoon/data/manager/visitor.rb

@@ -10,6 +10,7 @@ require 'kameleoon/data/device'
 require 'kameleoon/data/kcs_heat'
 require 'kameleoon/data/page_view'
 require 'kameleoon/data/personalization'
+require 'kameleoon/data/targeted_segment'
 require 'kameleoon/data/unique_identifier'
 require 'kameleoon/data/user_agent'
 require 'kameleoon/data/manager/assigned_variation'
@@ -186,6 +187,14 @@ module Kameleoon
         personalizations
       end
 
+      def targeted_segments
+        targeted_segments = @data.targeted_segments
+        Logging::KameleoonLogger.debug(
+          'CALL/RETURN: Visitor.targeted_segments -> (targeted_segments: %s)', targeted_segments
+        )
+        targeted_segments
+      end
+
       def get_forced_feature_variation(feature_key)
         Logging::KameleoonLogger.debug("CALL: Visitor.get_forced_feature_variation(feature_key: '%s')", feature_key)
         variation = @data.get_from_map(@data.simulated_variations, feature_key)
@@ -241,6 +250,8 @@ module Kameleoon
               @data.add_variation(data, overwrite)
             when Personalization
               @data.add_personalization(data, overwrite)
+            when TargetedSegment
+              @data.add_targeted_segment(data)
             when ForcedFeatureVariation
               @data.add_forced_feature_variation(data)
             when ForcedExperimentVariation
@@ -329,6 +340,7 @@ module Kameleoon
           @custom_data_map&.each { |_, cd| blk.call(cd) }
           @page_view_visits&.each { |_, pvv| blk.call(pvv.page_view) }
           @variations&.each { |_, av| blk.call(av) }
+          @targeted_segments&.each { |_, ts| blk.call(ts) }
           @conversions&.each { |c| blk.call(c) }
         end
       end
@@ -344,8 +356,9 @@ module Kameleoon
           count += 1 unless @visitor_visits.nil?
           count += @custom_data_map.size unless @custom_data_map.nil?
           count += @page_view_visits.size unless @page_view_visits.nil?
-          count += @conversions.size unless @conversions.nil?
           count += @variations.size unless @variations.nil?
+          count += @targeted_segments.size unless @targeted_segments.nil?
+          count += @conversions.size unless @conversions.nil?
         end
         Logging::KameleoonLogger.debug('RETURN: VisitorData.count_sendable_data -> (count: %s)', count)
         count
@@ -371,6 +384,10 @@ module Kameleoon
         DataMapStorage.new(@mutex, @personalizations)
       end
 
+      def targeted_segments
+        DataMapStorage.new(@mutex, @targeted_segments)
+      end
+
       def set_device(device, overwrite)
         @device = device if overwrite || @device.nil?
       end
@@ -389,6 +406,11 @@ module Kameleoon
         end
       end
 
+      def add_targeted_segment(targeted_segment)
+        @targeted_segments ||= {}
+        @targeted_segments[targeted_segment.id] = targeted_segment
+      end
+
       def set_browser(browser, overwrite)
         @browser = browser if overwrite || @browser.nil?
       end

data/lib/kameleoon/data/targeted_segment.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'kameleoon/data/data'
+require 'kameleoon/network/uri_helper'
+
+module Kameleoon
+  class TargetedSegment < DuplicationUnsafeData
+    EVENT_TYPE = 'targetingSegment'
+
+    attr_reader :id
+
+    def initialize(id)
+      super(DataType::TARGETED_SEGMENT)
+      @id = id
+    end
+
+    def obtain_full_post_text_line
+      params = {
+        eventType: EVENT_TYPE,
+        id: @id,
+        nonce: nonce
+      }
+      Network::UriHelper.encode_query(params)
+    end
+
+    def to_s
+      "TargetedSegment{id:#{@id}}"
+    end
+  end
+end

data/lib/kameleoon/kameleoon_client.rb

@@ -758,6 +758,27 @@ module Kameleoon
       )
     end
 
+    ##
+    # Evaluates the visitor against all available Audiences Explorer segments and tracks those that match.
+    # A detailed analysis of segment performance can then be performed directly in Audiences Explorer.
+    #
+    # @param [String] visitor_code The unique visitor code identifying the visitor.
+    #
+    # @raise [Kameleoon::Exception::VisitorCodeInvalid] The provided **visitor code** is invalid.
+    def evaluate_audiences(visitor_code)
+      Logging::KameleoonLogger.info("CALL: KameleoonClient.evaluate_audiences(visitor_code: '%s')", visitor_code)
+      Utils::VisitorCode.validate(visitor_code)
+      segments = @data_manager.data_file.audience_tracking_segments.select do |seg|
+        check_targeting(visitor_code, nil, seg)
+      end
+      unless segments.empty?
+        segments.map! { |seg| TargetedSegment.new(seg.id) }
+        @visitor_manager.add_data(visitor_code, *segments)
+      end
+      @tracking_manager.add_visitor_code(visitor_code)
+      Logging::KameleoonLogger.info("RETURN: KameleoonClient.evaluate_audiences(visitor_code: '%s')", visitor_code)
+    end
+
     private
 
     HYBRID_EXPIRATION_TIME = 5
@@ -904,8 +925,8 @@ module Kameleoon
     #   nil
     # end
 
-    def check_targeting(visitor_code, campaign_id, exp_ff_rule)
-      @targeting_manager.check_targeting(visitor_code, campaign_id, exp_ff_rule)
+    def check_targeting(visitor_code, campaign_id, segment)
+      @targeting_manager.check_targeting(visitor_code, campaign_id, segment)
     end
 
     def get_variation_info(visitor_code, feature_flag, track)
@@ -1106,7 +1127,7 @@ module Kameleoon
           break
         end
         # check if visitor is targeted for rule, else next rule
-        next unless check_targeting(visitor_code, rule.experiment.id, rule)
+        next unless check_targeting(visitor_code, rule.experiment.id, rule.targeting_segment)
 
         unless forced_variation.nil?
           # Forcing experiment variation in targeting-only mode

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

@@ -19,10 +19,10 @@ module Kameleoon
       private
 
       def check_targeting(segment_info)
-        rule = segment_info.data_file.rule_by_segment_id[@segment_id]
-        return false unless rule.is_a?(Kameleoon::Configuration::Rule)
+        segment = segment_info.data_file.segments[@segment_id]
+        return false if segment.nil?
 
-        rule.targeting_segment.check_tree(->(type) { segment_info.condition_data(type) })
+        segment.check_tree(->(type) { segment_info.condition_data(type) })
       end
     end
 

data/lib/kameleoon/targeting/models.rb

@@ -8,10 +8,10 @@ module Kameleoon
   module Targeting
     class Segment
       include TreeBuilder
-      attr_accessor :id, :tree
+      attr_accessor :id, :tree, :audience_tracking
 
       def to_s
-        @tree.to_s
+        "Segment{id:#{@id},audience_tracking:#{@audience_tracking}}"
       end
 
       def initialize(*args)
@@ -28,6 +28,7 @@ module Kameleoon
             if hash['conditionsData'].nil?
               raise Kameleoon::Exception::NotFound.new(hash['conditionsData']), 'hash[\'conditionsData\']'
             end
+            @audience_tracking = hash['audienceTracking'] || false
             @tree = create_tree(hash['conditionsData'])
           elsif args.length == 2
             @id = args[0]

data/lib/kameleoon/targeting/targeting_manager.rb

@@ -19,25 +19,19 @@ module Kameleoon
         @visitor_manager = visitor_manager
       end
 
-      def check_targeting(visitor_code, campaign_id, exp_ff_rule)
+      def check_targeting(visitor_code, campaign_id, segment)
         Logging::KameleoonLogger.debug(
-          "CALL: TargetingManager.check_targeting(visitor_code: '%s', campaign_id: %s, exp_ff_rule: %s)",
-          visitor_code, campaign_id, exp_ff_rule
+          "CALL: TargetingManager.check_targeting(visitor_code: '%s', campaign_id: %s, segment: %s)",
+          visitor_code, campaign_id, segment
         )
-        segment = exp_ff_rule.targeting_segment
-        if segment.nil?
-          Logging::KameleoonLogger.debug(
-            "RETURN: TargetingManager.check_targeting(visitor_code: '%s', campaign_id: %s, exp_ff_rule: %s) -> " \
-              '(targeting: true)', visitor_code, campaign_id, exp_ff_rule
-          )
-          return true
+        targeting = true
+        unless segment.nil?
+          visitor = @visitor_manager.get_visitor(visitor_code)
+          targeting = segment.check_tree(->(type) { get_condition_data(type, visitor, visitor_code, campaign_id) })
         end
-
-        visitor = @visitor_manager.get_visitor(visitor_code)
-        targeting = segment.check_tree(->(type) { get_condition_data(type, visitor, visitor_code, campaign_id) })
         Logging::KameleoonLogger.debug(
-          "RETURN: TargetingManager.check_targeting(visitor_code: '%s', campaign_id: %s, exp_ff_rule: %s) -> " \
-            '(targeting: %s)', visitor_code, campaign_id, exp_ff_rule, targeting
+          "RETURN: TargetingManager.check_targeting(visitor_code: '%s', campaign_id: %s, segment: %s) -> " \
+            '(targeting: %s)', visitor_code, campaign_id, segment, targeting
         )
         targeting
       end
@@ -86,7 +80,9 @@ module Kameleoon
         when ConditionType::TARGET_PERSONALIZATION
           condition_data = TargetPersonalizationInfo.new(visitor&.personalizations)
         when ConditionType::EXCLUSIVE_EXPERIMENT
-          condition_data = ExclusiveExperimentInfo.new(campaign_id, visitor&.variations, visitor&.personalizations)
+          unless campaign_id.nil?
+            condition_data = ExclusiveExperimentInfo.new(campaign_id, visitor&.variations, visitor&.personalizations)
+          end
         when ConditionType::FIRST_VISIT,
           ConditionType::LAST_VISIT,
           ConditionType::VISITS,

data/lib/kameleoon/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  SDK_VERSION = '3.14.0'
+  SDK_VERSION = '3.15.0'
   SDK_NAME = 'RUBY'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 3.14.0
+  version: 3.15.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-27 00:00:00.000000000 Z
+date: 2025-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -108,6 +108,7 @@ files:
 - lib/kameleoon/data/operating_system.rb
 - lib/kameleoon/data/page_view.rb
 - lib/kameleoon/data/personalization.rb
+- lib/kameleoon/data/targeted_segment.rb
 - lib/kameleoon/data/unique_identifier.rb
 - lib/kameleoon/data/user_agent.rb
 - lib/kameleoon/data/visitor_visits.rb