kameleoon-client-ruby 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1831531ee6a40f0fbd32f110f9a9c9c1a33f71569c8b8de842bc01c06250d6d5
-  data.tar.gz: 6e6f8f9d0ee511c2a27fc63ff040e6155b90df66925989d1d08bd473f86c071b
+  metadata.gz: d70f414ac8fb37aa97f11f9a01008c602e828efe9305399964910914eff43050
+  data.tar.gz: 52ece8845cf02e17198268fd9b5b8e3275c86a11bbf01acc7e68362a80a64e46
 SHA512:
-  metadata.gz: 6f575eb2b6e12302ffa5cdb067582d994ab890edcab12f174732d396adc4248fc96a9e27935c008db52f59a93b5e0c713530356acab47711727651d2a4d48e3a
-  data.tar.gz: '058e6a5284550663cf20223eca099728a9ca0985aacfcfa829e585070228a83b38b4facda77d38a7f3ae17ae8fad37cc7898e47e2519826364a46b3205b33452'
+  metadata.gz: d62ef28c65650b491fd47beebb8dbdcee803cf78faacec4c998a6e02681cbf0f0aeb032db78637e94703eeb88de7821eb1fe84b4fd943ee65328cd87942332c9
+  data.tar.gz: 7e980fbb43d05dcdefceb257d003f7846e2bb131f0814216dcec56ef3273b35fe65ffac0cabe4cff1cbb0da1cb6095f41ca63c05241d42d972a844094e0d83d5

data/lib/kameleoon/data/conversion.rb

@@ -1,26 +1,31 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'kameleoon/data/custom_data'
 require 'kameleoon/network/uri_helper'
+require 'kameleoon/utils'
 require_relative 'data'
 
 module Kameleoon
   # Conversion class uses for tracking conversion
   class Conversion < DuplicationSafeData
-    attr_reader :goal_id, :revenue, :negative
+    attr_reader :goal_id, :revenue, :negative, :metadata
 
     def to_s
-      "Conversion{goal_id:#{@goal_id},revenue:#{@revenue},negative:#{@negative}}"
+      "Conversion{goal_id:#{@goal_id},revenue:#{@revenue},negative:#{@negative}," \
+      "metadata:#{Utils::Strval.obj_to_s(@metadata)}}"
     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.
-    def initialize(goal_id, revenue = 0.0, negative = false)
+    # @param [Array] metadata Optional field - Metadata of the conversion. Array of CustomData objects.
+    def initialize(goal_id, revenue = 0.0, negative = false, metadata: nil)
       super(DataType::CONVERSION)
       @goal_id = goal_id
       @revenue = revenue || 0.0
       @negative = negative || false
+      @metadata = metadata
     end
 
     def obtain_full_post_text_line
@@ -31,7 +36,22 @@ module Kameleoon
         negative: @negative,
         nonce: nonce
       }
+      params[:metadata] = encode_metadata if @metadata&.length&.positive?
       Kameleoon::Network::UriHelper.encode_query(params)
     end
+
+    private
+
+    def encode_metadata
+      metadata = {}
+      added_indices = Set[]
+      @metadata&.each do |mcd|
+        next if !mcd.is_a?(CustomData) || added_indices.include?(mcd.id)
+
+        metadata[mcd.id] = mcd.values
+        added_indices.add(mcd.id)
+      end
+      JSON.generate(metadata)
+    end
   end
 end

data/lib/kameleoon/data/custom_data.rb

@@ -38,10 +38,6 @@ module Kameleoon
         @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)
 
       Logging::KameleoonLogger.warning("CustomData field 'id' must be of 'Integer' type")
@@ -50,8 +46,6 @@ module Kameleoon
     # rubocop:enable Metrics/MethodLength
 
     def obtain_full_post_text_line
-      return '' if @values.empty?
-
       str_values = JSON.generate(Hash[@values.collect { |k| [k, 1] }])
       params = {
         eventType: 'customData',

data/lib/kameleoon/kameleoon_client.rb

@@ -186,21 +186,29 @@ module Kameleoon
     # @param [Float] revenue Optional - Revenue of the conversion.
     # @param [Bool] is_unique_identifier(DEPRECATED) Parameter that specifies whether the visitorCode is a unique
     # identifier. This field is optional.
+    # @param [Bool] negative Defines if the revenue is positive or negative.
+    # This field is optional (`false` by default).
+    # @param [Array] metadata Metadata of the conversion. This field is optional.
     #
     # @raise [Kameleoon::Exception::VisitorCodeInvalid] If the visitor code is empty or longer than 255 chars
     #
-    def track_conversion(visitor_code, goal_id, revenue = 0.0, is_unique_identifier: nil)
+    def track_conversion(
+      visitor_code, goal_id, revenue = 0.0,
+      is_unique_identifier: nil, negative: false, metadata: nil
+    )
       Logging::KameleoonLogger.info(
-        "CALL: KameleoonClient.track_conversion(visitor_code: '%s', goal_id: %s, revenue: %s, is_unique_identifier: %s)",
-        visitor_code, goal_id, revenue, is_unique_identifier
+        "CALL: KameleoonClient.track_conversion(visitor_code: '%s', goal_id: %s, revenue: %s, " \
+        'is_unique_identifier: %s, negative: %s, metadata: %s)',
+        visitor_code, goal_id, revenue, is_unique_identifier, negative, metadata
       )
       Utils::VisitorCode.validate(visitor_code)
       set_unique_identifier(visitor_code, is_unique_identifier) unless is_unique_identifier.nil?
-      add_data(visitor_code, Conversion.new(goal_id, revenue))
+      add_data(visitor_code, Conversion.new(goal_id, revenue, negative, metadata: metadata))
       @tracking_manager.add_visitor_code(visitor_code)
       Logging::KameleoonLogger.info(
-        "RETURN: KameleoonClient.track_conversion(visitor_code: '%s', goal_id: %s, revenue: %s, is_unique_identifier: %s)",
-        visitor_code, goal_id, revenue, is_unique_identifier
+        "RETURN: KameleoonClient.track_conversion(visitor_code: '%s', goal_id: %s, revenue: %s, " \
+        'is_unique_identifier: %s, negative: %s, metadata: %s)',
+        visitor_code, goal_id, revenue, is_unique_identifier, negative, metadata
       )
     end
 

data/lib/kameleoon/utils.rb

@@ -50,6 +50,22 @@ module Kameleoon
     end
 
     module Strval
+      def self.obj_to_s(obj)
+        case obj
+        when nil
+          'nil'
+        when String
+          "'#{obj}'"
+        when Array
+          "[#{obj.map { |v| obj_to_s(v) }.join(',')}]"
+        when Hash
+          sb = []
+          obj.each { |k, v| sb.push("#{obj_to_s(k)}:#{obj_to_s(v)}") }
+          "{#{sb.join(',')}}"
+        else
+          obj.to_s
+        end
+      end
 
       def self.secret(secret)
         hid_ch = '*'

data/lib/kameleoon/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  SDK_VERSION = '3.10.0'
+  SDK_VERSION = '3.11.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.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-18 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request