kameleoon-client-ruby 3.15.0 → 3.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07240065fc16f98169c01fd4367321b2f633d79373f293b0bcf110f68d920d46
-  data.tar.gz: 52b83806f28aa0035eb8df2db89f84b98b774e2a53b0fd8a7c5abd71b0a59ac4
+  metadata.gz: 3df9ec4718c2a87cff0c2ad6344d43ca3ad095531badca20a6ac1bc0c1db9126
+  data.tar.gz: ba946333858defdeedccfdd3468aab44eeae80a8e9f4f407b68db4b4701a47bb
 SHA512:
-  metadata.gz: 88e8da4ec50eca784dd49b5861f373d84e60eaa521894d095104c10d6d469cb8e20d4fbf98416a473790fe77842411e4021beed153a4a4bb784603b90360abd0
-  data.tar.gz: 9068a2d4b8dfaff1020933c9e38e133965486ef0ddc722db19dd7eeee28a0327926d4d3beb1b17460615da176620699a2f7dcc5ada1dc63db4e6696aaa080131
+  metadata.gz: d01c49dabf864637880c54117b74580d8b9f08567fe3755dbdaf3483e8da91e44c46041bfc537de1efb9bbcc969fdf106a273a235e4b933ccf85da74cafa00f2
+  data.tar.gz: 287fc1558d2f377db0cbe20b31069fa216bdffa5cc640286897895bb7a18903f2b1f706c1697c37ac1f1af0fe1e9b88a7beded87aaa056ec810ef571f77793d9

data/lib/kameleoon/configuration/custom_data_info.rb

@@ -14,13 +14,18 @@ module Kameleoon
         @local_only = Set[]
         @visitor_scope = Set[]
         @custom_data_index_by_id = {}
+        @custom_data_index_by_name = {}
         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
-            id = hash['id']
-            @custom_data_index_by_id[id] = index if id && index
+            if index
+              id = hash['id']
+              name = hash['name']
+              @custom_data_index_by_id[id] = index if id
+              @custom_data_index_by_name[name] = index if name
+            end
             if hash['isMappingIdentifier']
               unless @mapping_identifier_index.nil?
                 Logging::KameleoonLogger.warning('More than one mapping identifier is set. Undefined behavior ' \
@@ -48,8 +53,12 @@ module Kameleoon
         @custom_data_index_by_id[custom_data_id]
       end
 
+      def get_custom_data_index_by_name(custom_data_name)
+        @custom_data_index_by_name[custom_data_name]
+      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_info.nil? && (custom_data.index == custom_data_info.mapping_identifier_index) && \
           !(custom_data.values.empty? || custom_data.values[0].empty?)
       end
     end

data/lib/kameleoon/data/custom_data.rb

@@ -8,50 +8,88 @@ require_relative 'data'
 module Kameleoon
   # Represents any custom data for targeting conditions
   class CustomData < DuplicationUnsafeData
-    attr_reader :id, :values
+    attr_reader :index, :name, :values, :overwrite
 
     def to_s
-      "CustomData{id:#{@id},values:#{@values}}"
+      "CustomData{index:#{@index},name:'#{@name}',values:#{@values},overwrite:#{@overwrite}}"
     end
 
-    # @param [Integer] id Id of the custom data
+    # @param [Integer] index Index of the custom data
     # @param [String] value Value of the custom data
     # @param [Array] values Array of values of the custom data
+    # @param [Boolean] overwrite Flag to explicitly control how the values are stored and how they appear in reports
+    #
+    # @overload
+    # @param [String] name Custom Data name, can be used instead of Custom Data index
+    # @param [String] value Value of the custom data
+    # @param [Array] values Array of values of the custom data
+    # @param [Boolean] overwrite Flag to explicitly control how the values are stored and how they appear in reports
     #
     # @overload
     # @param [Hash] hash Json value encoded in a hash.
     # rubocop:disable Metrics/MethodLength
-    def initialize(arg0, *args)
+    def initialize(arg0, *args, overwrite: true)
       super(DataType::CUSTOM)
       if arg0.is_a?(Hash)
         hash = arg0
-        id = hash['id']
-        raise Kameleoon::Exception::NotFound.new('id'), '"id" is mandatory' if id.nil?
+        index = hash['index'] || hash['id']
+        name = hash['name']
+        if index.nil? && name.nil?
+          raise Kameleoon::Exception::NotFound.new('index/id/name'), '"index/id/name" is mandatory'
+        end
 
-        @id = id
+        @index = index || -1
+        @name = name
         values = hash['values']
         raise Kameleoon::Exception::NotFound.new('values'), '"values" is mandatory' if values.nil?
 
         @values = values.is_a?(Array) ? values.dup : [values]
+        @overwrite = hash.fetch('overwrite', true)
       else
-        @id = arg0
+        case arg0
+        when Integer
+          @index = arg0
+        when String
+          @index = -1
+          @name = arg0
+        else
+          raise Kameleoon::Exception.new('Unexpected arg0 type'), 'Unexpected arg0 type'
+        end
         @values = args
+        @overwrite = overwrite
       end
 
-      return if @id.is_a?(Integer)
+      return if @index.is_a?(Integer)
 
-      Logging::KameleoonLogger.warning("CustomData field 'id' must be of 'Integer' type")
-      @id = @id.is_a?(String) ? @id.to_i : -1
+      Logging::KameleoonLogger.warning("CustomData field 'index' must be of 'Integer' type")
+      @index = @index.is_a?(String) ? @index.to_i : -1
     end
     # rubocop:enable Metrics/MethodLength
 
+    def named_to_indexed(index)
+      CustomData.new(
+        {
+          'index' => index,
+          'name' => @name,
+          'values' => @values,
+          'overwrite' => @overwrite
+        }
+      )
+    end
+
+    ##
+    # DEPRECATED. Please use `index` instead.
+    def id
+      @index
+    end
+
     def obtain_full_post_text_line
       str_values = JSON.generate(Hash[@values.collect { |k| [k, 1] }])
       params = {
         eventType: 'customData',
-        index: @id,
+        index: @index,
         valuesCountMap: str_values,
-        overwrite: 'true',
+        overwrite: @overwrite,
         nonce: nonce
       }
       Kameleoon::Network::UriHelper.encode_query(params)

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

@@ -243,6 +243,8 @@ module Kameleoon
         Logging::KameleoonLogger.debug('CALL: Visitor.add_data(args: %s, overwrite: %s)', args, overwrite)
         @data.mutex.with_write_lock do
           args.each do |data|
+            next if data.nil?
+
             case data
             when UserAgent
               @data.user_agent = data.value
@@ -417,8 +419,8 @@ module Kameleoon
 
       def add_custom_data(custom_data, overwrite)
         @custom_data_map ||= {}
-        if overwrite || !@custom_data_map.include?(custom_data.id)
-          @custom_data_map[custom_data.id] = custom_data
+        if overwrite || !@custom_data_map.include?(custom_data.index)
+          @custom_data_map[custom_data.index] = custom_data
         end
       end
 

data/lib/kameleoon/data/manager/visitor_manager.rb

@@ -77,21 +77,8 @@ module Kameleoon
         cdi = @data_manager.data_file.custom_data_info
         args.size.times do |i|
           custom_data = args[i]
-          next unless custom_data.is_a?(Kameleoon::CustomData)
-
-          # We shouldn't send custom data with local only type
-          custom_data.mark_as_sent if cdi.local_only?(custom_data.id)
-          # If mappingIdentifier is passed, we should link anonymous visitor with real unique userId.
-          # After authorization, customer must be able to continue work with userId, but hash for variation
-          # should be calculated based on anonymous visitor code, that's why set MappingIdentifier to visitor.
-          if Configuration::CustomDataInfo.mapping_identifier?(cdi, custom_data)
-            visitor.mapping_identifier = visitor_code
-            user_id = custom_data.values[0]
-            args[i] = MappingIdentifier.new(custom_data)
-            if visitor_code != user_id
-              @visitors[user_id] = visitor.clone
-              Logging::KameleoonLogger.info(-> { "Linked anonymous visitor '#{visitor_code}' with user '#{user_id}'" })
-            end
+          if custom_data.is_a?(Kameleoon::CustomData)
+            args[i] = process_custom_data(cdi, visitor_code, visitor, custom_data)
           end
         end
         visitor.add_data(*args, overwrite: overwrite)
@@ -104,6 +91,30 @@ module Kameleoon
 
       private
 
+      def process_custom_data(cdi, visitor_code, visitor, custom_data)
+        unless custom_data.name.nil?
+          cd_index = cdi.get_custom_data_index_by_name(custom_data.name)
+          return nil if cd_index.nil?
+
+          custom_data = custom_data.named_to_indexed(cd_index)
+        end
+        # We shouldn't send custom data with local only type
+        custom_data.mark_as_sent if cdi.local_only?(custom_data.index)
+        # If mappingIdentifier is passed, we should link anonymous visitor with real unique userId.
+        # After authorization, customer must be able to continue work with userId, but hash for variation
+        # should be calculated based on anonymous visitor code, that's why set MappingIdentifier to visitor.
+        if Configuration::CustomDataInfo.mapping_identifier?(cdi, custom_data)
+          visitor.mapping_identifier = visitor_code
+          user_id = custom_data.values[0]
+          custom_data = MappingIdentifier.new(custom_data)
+          if visitor_code != user_id
+            @visitors[user_id] = visitor.clone
+            Logging::KameleoonLogger.info(-> { "Linked anonymous visitor '#{visitor_code}' with user '#{user_id}'" })
+          end
+        end
+        custom_data
+      end
+
       def purge
         Logging::KameleoonLogger.debug('CALL: VisitorManager.purge')
         expired_time = Time.new.to_i - @expiration_period

data/lib/kameleoon/data/mapping_identifier.rb

@@ -6,7 +6,14 @@ require 'kameleoon/network/uri_helper'
 module Kameleoon
   class MappingIdentifier < CustomData
     def initialize(custom_data)
-      super(custom_data.id, *custom_data.values)
+      super(
+        {
+          'index' => custom_data.index,
+          'name' => custom_data.name,
+          'values' => custom_data.values,
+          'overwrite' => custom_data.overwrite
+        }
+      )
     end
 
     def unsent
@@ -27,7 +34,7 @@ module Kameleoon
     end
 
     def to_s
-      "MappingIdentifier{id:#{@id},values:#{@values}}"
+      "MappingIdentifier{index:#{@index},name:'#{@name}',values:#{@values},overwrite:#{@overwrite}}"
     end
   end
 end

data/lib/kameleoon/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  SDK_VERSION = '3.15.0'
+  SDK_VERSION = '3.16.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.15.0
+  version: 3.16.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
+date: 2025-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request