vwo-sdk 1.23.1 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36297d491673769eab11fc07c0c33388da361b564fc1888a078f251a53a695e
-  data.tar.gz: e1ef625b6ed40c6223d90a019f35e276fc6c5252e91b004f68d1ffab5fd72d41
+  metadata.gz: 4871df5d5a50f01ed13a11692aa6b114f03242f4c9257eccb48bce2a65beaa7c
+  data.tar.gz: fdd46869b068d589e4a85402d10d8852c4bfc48084e75a18fe8631f3a99b07a9
 SHA512:
-  metadata.gz: ec99893b52fad4cdfb156d8d46b69c3b2f526fb25f0bfda2c27205f938fe3918853edb969534256edb47d16100fc54cd1061924a5bd24097aea256b649c80431
-  data.tar.gz: 73572a0f681bde9fd8f03b426097a4ee1bda9d8acda8048260f839559b3a20497f52f4c94dc6b28f41abde5a0fd91e4f31f2dc62031a423f7409970f1cfe8048
+  metadata.gz: 0c23fe3a4fbcb4c85ef1af73a7ef9bb37a0a79eb4f628bad726f66394291cd93d24cecc066a662799670d10b703265eb3afe72a689ce060a2756eb84d0bfce69
+  data.tar.gz: f60e3e5a8b96e2ab878929c857d4c8d5c3071e6439e811ac59e7bfa00b488f6c79583ebbfa4a8995a3adac5faf80b7c9293ebea3fa0da231224c684ed39adbb4

data/lib/vwo/constants.rb

@@ -27,7 +27,7 @@ class VWO
     HTTP_PROTOCOL = 'http://'
     HTTPS_PROTOCOL = 'https://'
     URL_NAMESPACE = '6ba7b811-9dad-11d1-80b4-00c04fd430c8'
-    SDK_VERSION = '1.23.1'
+    SDK_VERSION = '1.25.0'
     SDK_NAME = 'ruby'
     VWO_DELIMITER = '_vwo_'
     MAX_EVENTS_PER_REQUEST = 5000
@@ -44,6 +44,7 @@ class VWO
       TRACK_GOAL = '/server-side/track-goal'
       PUSH = '/server-side/push'
       BATCH_EVENTS = '/server-side/batch-events'
+      EVENTS = '/events/t'
     end
 
     module EVENTS
@@ -113,5 +114,10 @@ class VWO
       FEATURE_TEST = 'FEATURE_TEST'
       FEATURE_ROLLOUT = 'FEATURE_ROLLOUT'
     end
+
+    module EventEnum
+      VWO_VARIATION_SHOWN = 'vwo_variationShown'
+      VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp'
+    end
   end
 end

data/lib/vwo/core/variation_decider.rb

@@ -95,6 +95,10 @@ class VWO
           :vwo_user_id => generator_for(user_id, @settings_file['accountId'])
         }
 
+        if campaign.has_key?("name")
+          decision[:campaign_name] = campaign['name']
+        end
+
         if is_campaign_part_of_group
           group_id = @settings_file["campaignGroups"][campaign["id"].to_s]
           decision[:group_id] = group_id
@@ -459,10 +463,19 @@ class VWO
       # @return[Hash]
 
       def evaluate_whitelisting(user_id, campaign, api_name, campaign_key, variation_targeting_variables = {}, disable_logs = false)
-        if variation_targeting_variables.nil?
-          variation_targeting_variables = { _vwo_user_id: user_id }
+        if campaign.key?('isUserListEnabled') && campaign["isUserListEnabled"]
+          vwo_user_id = generator_for(user_id, @settings_file['accountId'])
+          if variation_targeting_variables.nil?
+            variation_targeting_variables = { _vwo_user_id: vwo_user_id }
+          else
+            variation_targeting_variables[:_vwo_user_id] = vwo_user_id
+          end
         else
-          variation_targeting_variables[:_vwo_user_id] = user_id
+          if variation_targeting_variables.nil?
+            variation_targeting_variables = { _vwo_user_id: user_id }
+          else
+            variation_targeting_variables[:_vwo_user_id] = user_id
+          end
         end
         targeted_variations = []
 

data/lib/vwo/enums.rb

@@ -114,6 +114,9 @@ class VWO
         BEFORE_FLUSHING = '(%<file>s): Flushing events queue %<manually>s having %<length>s events %<timer>s queue summary: %<queue_metadata>s'
         EVENT_BATCHING_INSUFFICIENT = '(%<file>s): %<key>s not provided, assigning default value'
         GOT_ELIGIBLE_CAMPAIGNS = "(%<file>s): Campaigns:%<eligible_campaigns_key>s are eligible, %<ineligible_campaigns_log_text>s are ineligible from the Group:%<group_name>s for the User ID:%<user_id>s"
+        IMPRESSION_FOR_EVENT_ARCH_TRACK_USER = "(%<file>s): impression built for vwo_variationShown event for account ID:%<a>s, user ID:%<u>s, and campaign ID:%<c>s"
+        IMPRESSION_FOR_EVENT_ARCH_TRACK_GOAL = "(%<file>s): impression built for %<goal_identifier>s event for account ID:%<a>s, user ID:%<u>s, and campaign ID:%<c>s"
+        IMPRESSION_FOR_EVENT_ARCH_PUSH = "(%<file>s): impression built for visitor property:%<property>s for account ID:%<a>s and user ID:%<u>s"
       end
 
       # Info Messages
@@ -128,9 +131,10 @@ class VWO
         AUDIENCE_CONDITION_NOT_MET = '(%<file>s): userId:%<user_id>s does not become part of campaign because of not meeting audience conditions'
         GOT_VARIATION_FOR_USER = '(%<file>s): userId:%<user_id>s for campaign:%<campaign_key>s got variationName:%<variation_name>s'
         USER_GOT_NO_VARIATION = '(%<file>s): userId:%<user_id>s for campaign:%<campaign_key>s did not allot any variation'
-        IMPRESSION_SUCCESS = '(%<file>s): Impression event - %<end_point>s was successfully received by VWO having main keys: sdkKey:%<sdk_key>s accountId:%<account_id>s campaignId:%<campaign_id>s and variationId:%<variation_id>s'
-        MAIN_KEYS_FOR_IMPRESSION = '(%<file>s): Having main keys: {sdkKey:%<sdk_key>s accountId:%<account_id>s campaignId:%<campaign_id>s and variationId:%<variation_id>s}'
-        MAIN_KEYS_FOR_PUSH_API = '(%<file>s): Having main keys: {sdkKey:%<sdk_key>s accountId:%<account_id>s u:%<u>s and tags:%<tags>s}'
+        IMPRESSION_SUCCESS_FOR_EVENT_ARCH = '(%<file>s): Impression for %<event>s - %<url>s was successfully received by VWO for account ID:%<a>s'
+        IMPRESSION_SUCCESS = '(%<file>s): Impression event - %<end_point>s was successfully received by VWO having main keys: accountId:%<account_id>s campaignId:%<campaign_id>s and variationId:%<variation_id>s'
+        MAIN_KEYS_FOR_IMPRESSION = '(%<file>s): Having main keys: accountId:%<account_id>s campaignId:%<campaign_id>s and variationId:%<variation_id>s}'
+        MAIN_KEYS_FOR_PUSH_API = '(%<file>s): Having main keys: accountId:%<account_id>s u:%<u>s and tags:%<tags>s}'
         INVALID_VARIATION_KEY = '(%<file>s): Variation was not assigned to userId:%<user_id>s for campaign:%<campaign_key>s'
 
         USER_IN_FEATURE_ROLLOUT = '(%<file>s): User ID:%<user_id>s is in feature rollout:%<campaign_key>s'
@@ -201,7 +205,6 @@ class VWO
         TAG_KEY_LENGTH_EXCEEDED = '(%<file>s): In API: %<api_name>s, the length of tag_key:%<tag_key>s and userID: %<user_id>s can not be greater than 255'
         TRACK_API_MISSING_PARAMS = '(%<file>s): "track" API got bad parameters. It expects campaignKey(null/String/array) as first, userId(String/Number) as second and goalIdentifier (string) as third argument. options is revenueValue(Float/Number/String) and is required for revenue goal only.'
         NO_CAMPAIGN_FOUND = '(%<file>s): No campaign found for goal_identifier:%<goal_identifier>s. Please verify from VWO app.'
-        INVALID_TRACK_RETURNING_USER_VALUE  = '(%<file>s): should_track_returning_user should be boolean'
         INVALID_GOAL_TYPE = '(%<file>s): goal_type_to_track should be certain strings'
         EVENT_BATCHING_NOT_OBJECT = '(%<file>s): Batch events settings are not of type object.'
         EVENTS_PER_REQUEST_INVALID = '(%<file>s): events_per_request should be an integer'

data/lib/vwo/schemas/settings_file.rb

@@ -26,6 +26,9 @@ class VWO
         accountId: {
           type: %w[number string]
         },
+        isEventArchEnabled: {
+          type: ['boolean']
+        },
         campaigns: {
           if: {
             type: 'array'
@@ -73,6 +76,9 @@ class VWO
             key: {
               type: ['string']
             },
+            name: {
+              type: ['string']
+            },
             status: {
               type: ['string']
             },
@@ -92,6 +98,7 @@ class VWO
               }
             },
             isBucketingSeedEnabled: ['boolean'],
+            isUserListEnabled: ['boolean'],
             minItems: 2
           }
         },

data/lib/vwo/services/event_dispatcher.rb

@@ -15,11 +15,13 @@
 require_relative '../logger'
 require_relative '../enums'
 require_relative '../utils/request'
+require_relative '../constants'
 
 class VWO
   module Services
     class EventDispatcher
       include VWO::Enums
+      include VWO::CONSTANTS
 
       EXCLUDE_KEYS = ['url'].freeze
 
@@ -63,6 +65,38 @@ class VWO
         )
         false
       end
+
+      def dispatch_event_arch_post(params, post_data)
+        return true if @is_development_mode
+
+        url = HTTPS_PROTOCOL + ENDPOINTS::BASE_URL + ENDPOINTS::EVENTS
+        resp = VWO::Utils::Request.event_post(url, params, post_data, SDK_NAME)
+        if resp.code == '200'
+          @logger.log(
+            LogLevelEnum::INFO,
+            format(
+              LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS_FOR_EVENT_ARCH, 
+              file: FileNameEnum::EventDispatcher, 
+              event: 'visitor property:' + JSON.generate(post_data[:d][:visitor][:props]), 
+              url: url,
+              a: params[:a]
+            )
+          )
+          true
+        else
+          @logger.log(
+            LogLevelEnum::ERROR,
+            format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: url)
+          )
+          false
+        end
+      rescue StandardError
+        @logger.log(
+          LogLevelEnum::ERROR,
+          format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: url)
+        )
+        false
+      end
     end
   end
 end

data/lib/vwo/services/settings_file_manager.rb

@@ -78,7 +78,9 @@ class VWO
           i: @sdk_key,
           r: get_random_number,
           platform: 'server',
-          'api-version' => 1
+          'api-version' => 1,
+          'sdk-v' => VWO::CONSTANTS::SDK_VERSION,
+          'sdk' => VWO::CONSTANTS::SDK_NAME
         }
       end
     end

data/lib/vwo/utils/custom_dimensions.rb

@@ -17,6 +17,7 @@ require_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
 require_relative './impression'
+require_relative './utility'
 
 # Utility module for helper math and random functions
 class VWO
@@ -25,6 +26,7 @@ class VWO
       include VWO::CONSTANTS
       include VWO::Enums
       include VWO::Utils::Impression
+      include VWO::Utils::Utility
 
       def get_url_params(settings_file, tag_key, tag_value, user_id, sdk_key)
         url = HTTPS_PROTOCOL + ENDPOINTS::BASE_URL + ENDPOINTS::PUSH
@@ -39,7 +41,7 @@ class VWO
           format(
             LogMessageEnum::DebugMessages::PARAMS_FOR_PUSH_CALL,
             file: FileNameEnum::CustomDimensionsUtil,
-            properties: JSON.generate(params)
+            properties: remove_sensitive_properties(params)
           )
         )
         params

data/lib/vwo/utils/function.rb

@@ -33,6 +33,11 @@ class VWO
         Time.now.to_i
       end
 
+      # @return[Integer]
+      def get_current_unix_timestamp_in_millis
+        (Time.now.to_f * 1000).to_i
+      end
+
       # @return[any, any]
       def get_key_value(obj)
         [obj.keys[0], obj.values[0]]

data/lib/vwo/utils/impression.rb

@@ -19,6 +19,7 @@ require_relative '../enums'
 require_relative '../constants'
 require_relative 'function'
 require_relative 'uuid'
+require_relative 'utility'
 
 # Creates the impression from the arguments passed
 class VWO
@@ -28,6 +29,7 @@ class VWO
       include VWO::CONSTANTS
       include VWO::Utils::Function
       include UUID
+      include VWO::Utils::Utility
 
       # Creates the impression from the arguments passed
       #
@@ -76,7 +78,7 @@ class VWO
             format(
               LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_USER,
               file: FileNameEnum::ImpressionUtil,
-              properties: JSON.generate(impression)
+              properties: remove_sensitive_properties(impression)
             )
           )
         else
@@ -88,7 +90,7 @@ class VWO
             format(
               LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_GOAL,
               file: FileNameEnum::ImpressionUtil,
-              properties: JSON.generate(impression)
+              properties: remove_sensitive_properties(impression)
             )
           )
         end
@@ -162,6 +164,186 @@ class VWO
         end
         impression
       end
+
+      # Builds generic properties for different tracking calls required by VWO servers.
+      #
+      # @param[Hash]                      :settings_file
+      # @param[String]                    :sdk_key
+      # @param[String]                    :event_name
+      # @param[Hash]                      :usage_stats
+      # @return[Hash]                     :properties
+      # 
+      def get_events_base_properties(settings_file, event_name, usage_stats = {})
+        properties = {
+          en: event_name,
+          a: settings_file['accountId'],
+          env: settings_file['sdkKey'],
+          eTime: get_current_unix_timestamp_in_millis,
+          random: get_random_number,
+          p: "FS"
+        }
+
+        if event_name == EventEnum::VWO_VARIATION_SHOWN
+          properties = properties.merge(usage_stats)
+        end
+        properties
+      end
+
+      # Builds generic payload required by all the different tracking calls.
+      #
+      # @param[Hash]                   :settings_file
+      # @param[String]                 :user_id
+      # @param[String]                 :event_name
+      # @param[Hash]                   :usage_stats
+      # @return[Hash]                  :properties
+      # 
+      def get_event_base_payload(settings_file, user_id, event_name, usage_stats = {})
+        uuid = generator_for(user_id, (settings_file['accountId']))
+        sdk_key = settings_file['sdkKey']
+
+        props = {
+          sdkName: SDK_NAME,
+          sdkVersion: SDK_VERSION,
+          '$visitor': {
+            props: {
+              vwo_fs_environment: sdk_key
+            }
+          }
+        }
+
+        # if usage_stats
+        #   props = props.merge(usage_stats)
+        # end
+
+        properties = {
+          d: {
+            msgId: uuid + '_' + Time.now.to_i.to_s,
+            visId: uuid,
+            sessionId: Time.now.to_i,
+            event: {
+              props: props,
+              name: event_name,
+              time: get_current_unix_timestamp_in_millis
+            },
+            visitor: {
+              props: {
+                vwo_fs_environment: sdk_key
+              }
+            }
+          }
+        }
+
+        properties
+      end
+
+      # Builds payload to track the visitor.
+      #
+      # @param[Hash]                   :settings_file
+      # @param[String]                 :user_id
+      # @param[String]                 :event_name
+      # @param[Integer]                :campaign_id
+      # @param[Integer]                :variation_id
+      # @param[Hash]                   :usage_stats
+      # @return[Hash]                  :properties
+      #
+      def get_track_user_payload_data(settings_file, user_id, event_name, campaign_id, variation_id, usage_stats = {})
+        properties = get_event_base_payload(settings_file, user_id, event_name)
+        properties[:d][:event][:props][:id] = campaign_id
+        properties[:d][:event][:props][:variation] = variation_id
+
+        #this is currently required by data-layer team, we can make changes on DACDN and remove it from here
+        properties[:d][:event][:props][:isFirst] = 1
+
+        logger = VWO::Logger.get_instance
+        logger.log(
+            LogLevelEnum::DEBUG,
+          format(
+            LogMessageEnum::DebugMessages::IMPRESSION_FOR_EVENT_ARCH_TRACK_USER,
+            file: FileNameEnum::ImpressionUtil,
+            a: settings_file['accountId'],
+            u: user_id,
+            c: campaign_id.to_s
+          )
+        )
+        properties
+      end
+
+      # Builds payload to track the Goal.
+      #
+      # @param[Hash]                   :settings_file
+      # @param[String]                 :user_id
+      # @param[String]                 :event_name
+      # @param[Integer]                :revenue_value
+      # @param[Hash]                   :metric_map
+      # @param[Array]                  :revenue_props
+      #
+      # @return[Hash]                  :properties
+      #
+      def get_track_goal_payload_data(settings_file, user_id, event_name, revenue_value, metric_map, revenue_props = [])
+        properties = get_event_base_payload(settings_file, user_id, event_name)
+
+        logger = VWO::Logger.get_instance
+        metric = {}
+        metric_map.each do |campaign_id, goal_id|
+          metric[('id_' + campaign_id.to_s).to_sym] = ['g_' + goal_id.to_s]
+          logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::IMPRESSION_FOR_EVENT_ARCH_TRACK_GOAL,
+              file: FileNameEnum::ImpressionUtil,
+              goal_identifier: event_name,
+              a: settings_file['accountId'],
+              u: user_id,
+              c: campaign_id
+            )
+          )
+        end
+
+        properties[:d][:event][:props][:vwoMeta] = {
+          metric: metric
+        }
+
+        if revenue_props.length() != 0 && revenue_value
+          revenue_props.each do |revenue_prop|
+            properties[:d][:event][:props][:vwoMeta][revenue_prop.to_sym] = revenue_value
+          end
+        end
+
+        properties[:d][:event][:props][:isCustomEvent] = true
+        properties
+      end
+
+      # Builds payload to appply post segmentation on VWO campaign reports.
+      #
+      # @param[Hash]                   :settings_file
+      # @param[String]                 :user_id
+      # @param[String]                 :event_name
+      # @param[Hash]                   :custom_dimension_map
+      #
+      # @return[Hash]                  :properties
+      #
+      def get_push_payload_data(settings_file, user_id, event_name, custom_dimension_map = {})
+        properties = get_event_base_payload(settings_file, user_id, event_name)
+        properties[:d][:event][:props][:isCustomEvent] = true
+
+        custom_dimension_map.each do |tag_key, tag_value|
+          properties[:d][:event][:props][('$visitor'.to_sym)][:props][tag_key] = tag_value
+          properties[:d][:visitor][:props][tag_key] = tag_value
+        end
+
+        logger = VWO::Logger.get_instance
+        logger.log(
+          LogLevelEnum::DEBUG,
+          format(
+            LogMessageEnum::DebugMessages::IMPRESSION_FOR_EVENT_ARCH_PUSH,
+            file: FileNameEnum::ImpressionUtil,
+            a: settings_file['accountId'],
+            u: user_id,
+            property: JSON.generate(custom_dimension_map)
+          )
+        )
+        properties
+      end
     end
   end
 end

data/lib/vwo/utils/request.rb

@@ -38,6 +38,20 @@ class VWO
         response = http.post(uri, post_data.to_json, headers)
         response
       end
+
+      def self.event_post(url, params, post_data, user_agent_value)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        uri.query = URI.encode_www_form(params)
+        headers = {
+          'User-Agent' => user_agent_value,
+          'Content-Type' =>'application/json',
+          'Accept'=>'application/json'
+        }
+        response = http.post(uri, post_data.to_json, headers)
+        response
+      end
     end
   end
 end

data/lib/vwo/utils/utility.rb

@@ -35,6 +35,12 @@ class VWO
                 end
                 convertedHash
             end
+
+            def remove_sensitive_properties(properties)
+                properties.delete("env")
+                properties.delete("env".to_sym)
+                JSON.generate(properties)
+            end
         end
     end
 end

data/lib/vwo.rb

@@ -89,25 +89,6 @@ class VWO
       return
     end
 
-    if options.key?(:should_track_returning_user)
-      if [true, false].include? options[:should_track_returning_user]
-        @should_track_returning_user = options[:should_track_returning_user]
-        usage_stats[:tr] = 1 if @should_track_returning_user
-      else
-        @logger.log(
-          LogLevelEnum::ERROR,
-          format(
-            LogMessageEnum::ErrorMessages::INVALID_TRACK_RETURNING_USER_VALUE,
-            file: FILE
-          )
-        )
-        @is_instance_valid = false
-        return
-      end
-    else
-      @should_track_returning_user = false
-    end
-
     if options.key?(:goal_type_to_track)
       if GOAL_TYPES.key? options[:goal_type_to_track]
         @goal_type_to_track = options[:goal_type_to_track]
@@ -303,10 +284,9 @@ class VWO
     custom_variables = options[:custom_variables]
     variation_targeting_variables = options[:variation_targeting_variables]
 
-    should_track_returning_user = get_should_track_returning_user(options)
     # Validate input parameters
     unless valid_string?(campaign_key) && valid_string?(user_id) && (custom_variables.nil? || valid_hash?(custom_variables)) &&
-      (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables)) && [true, false].include?(should_track_returning_user)
+      (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables))
       @logger.log(
         LogLevelEnum::ERROR,
         format(
@@ -381,7 +361,7 @@ class VWO
       return
     end
 
-    if is_eligible_to_send_impression(should_track_returning_user)
+    if is_eligible_to_send_impression()
       if defined?(@batch_events)
         impression = create_bulk_event_impression(
           @settings_file,
@@ -390,6 +370,10 @@ class VWO
           user_id
         )
         @batch_events_queue.enqueue(impression)
+      elsif is_event_arch_enabled
+        properties = get_events_base_properties(@settings_file, EventEnum::VWO_VARIATION_SHOWN, @usage_stats.usage_stats)
+        payload = get_track_user_payload_data(@settings_file, user_id, EventEnum::VWO_VARIATION_SHOWN, campaign['id'], variation['id'])
+        @event_dispatcher.dispatch_event_arch_post(properties, payload)
       else
         # Variation found, dispatch it to server
         impression = create_impression(
@@ -408,7 +392,6 @@ class VWO
             format(
               LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS,
               file: FILE,
-              sdk_key: @sdk_key,
               account_id: @account_id,
               campaign_id: campaign['id'],
               variation_id: variation['id'],
@@ -588,12 +571,11 @@ class VWO
     revenue_value = options[:revenue_value]
     custom_variables = options[:custom_variables]
     variation_targeting_variables = options[:variation_targeting_variables]
-    should_track_returning_user = get_should_track_returning_user(options)
     goal_type_to_track = get_goal_type_to_track(options)
 
     # Check for valid args
     unless (valid_string?(campaign_key) || campaign_key.is_a?(Array) || campaign_key.nil?) && valid_string?(user_id) && valid_string?(goal_identifier) && (custom_variables.nil? || valid_hash?(custom_variables)) &&
-      (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables)) && [true, false].include?(should_track_returning_user) && (GOAL_TYPES.key? (goal_type_to_track))
+      (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables)) && (GOAL_TYPES.key? (goal_type_to_track))
       # log invalid params
       @logger.log(
         LogLevelEnum::ERROR,
@@ -614,6 +596,8 @@ class VWO
       return nil
     end
 
+    metric_map = {}
+    revenue_props = []
     result = {}
     campaigns.each do |campaign|
       begin
@@ -683,7 +667,7 @@ class VWO
             updated_goal_identifier += VWO_DELIMITER + goal_identifier
             @variation_decider.save_user_storage(user_id, campaign['key'], campaign['name'], variation['name'], updated_goal_identifier) if variation['name']
             # set variation at user storage
-          elsif !should_track_returning_user
+          else
             @logger.log(
               LogLevelEnum::INFO,
               format(
@@ -709,6 +693,11 @@ class VWO
               revenue_value
             )
             @batch_events_queue.enqueue(impression)
+          elsif  is_event_arch_enabled
+            metric_map[campaign['id']] = goal['id']
+            if goal['type'] == GoalTypes::REVENUE && !(revenue_props.include? goal['revenueProp'])
+              revenue_props << goal['revenueProp']
+            end
           else
             impression = create_impression(
               @settings_file,
@@ -725,7 +714,6 @@ class VWO
                 format(
                   LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS,
                   file: FILE,
-                  sdk_key: @sdk_key,
                   account_id: @account_id,
                   campaign_id: campaign['id'],
                   variation_id: variation['id'],
@@ -737,7 +725,6 @@ class VWO
                 format(
                   LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_IMPRESSION,
                   file: FILE,
-                  sdk_key: @sdk_key,
                   campaign_id: impression[:experiment_id],
                   account_id: impression[:account_id],
                   variation_id: impression[:combination]
@@ -761,6 +748,12 @@ class VWO
       end
     end
 
+    if is_event_arch_enabled
+      properties = get_events_base_properties(@settings_file, goal_identifier)
+      payload = get_track_goal_payload_data(@settings_file, user_id, goal_identifier, revenue_value, metric_map, revenue_props)
+      @event_dispatcher.dispatch_event_arch_post(properties, payload)
+    end
+
     if result.length() == 0
       return nil
     end
@@ -809,7 +802,6 @@ class VWO
     # Retrieve custom variables
     custom_variables = options[:custom_variables]
     variation_targeting_variables = options[:variation_targeting_variables]
-    should_track_returning_user = get_should_track_returning_user(options)
     @logger.log(
       LogLevelEnum::INFO,
       format(
@@ -821,7 +813,7 @@ class VWO
     )
     # Validate input parameters
     unless valid_string?(campaign_key) && valid_string?(user_id) && (custom_variables.nil? || valid_hash?(custom_variables)) &&
-      (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables)) && [true, false].include?(should_track_returning_user)
+      (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables))
       @logger.log(
         LogLevelEnum::ERROR,
         format(
@@ -877,7 +869,7 @@ class VWO
 
     # if campaign type is feature_test Send track call to server
 
-    if is_eligible_to_send_impression(should_track_returning_user)
+    if is_eligible_to_send_impression()
       if defined?(@batch_events)
         impression = create_bulk_event_impression(
           @settings_file,
@@ -886,6 +878,10 @@ class VWO
           user_id
         )
         @batch_events_queue.enqueue(impression)
+      elsif is_event_arch_enabled
+        properties = get_events_base_properties(@settings_file, EventEnum::VWO_VARIATION_SHOWN, @usage_stats.usage_stats)
+        payload = get_track_user_payload_data(@settings_file, user_id, EventEnum::VWO_VARIATION_SHOWN, campaign['id'], variation['id'])
+        @event_dispatcher.dispatch_event_arch_post(properties, payload)
       else
         impression = create_impression(
           @settings_file,
@@ -905,7 +901,6 @@ class VWO
             LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_IMPRESSION,
             file: FILE,
             campaign_id: impression[:experiment_id],
-            sdk_key: @sdk_key,
             account_id: impression[:account_id],
             variation_id: impression[:combination]
           )
@@ -1136,12 +1131,12 @@ class VWO
   # This API method: Makes a call to our server to store the tag_values
   # 1. Validates the arguments being passed
   # 2. Send a call to our server
-  # @param[String]          :tag_key              key name of the tag
-  # @param[String]          :tag_value            Value of the tag
+  # @param[String|Hash]     :tag_key              key name of the tag OR tagKey/tagValue pair(custom dimension map)
+  # @param[String]          :tag_value            Value of the tag OR userId if TagKey is hash
   # @param[String]          :user_id              ID of the user for which value should be stored
   # @return                                       true if call is made successfully, else false
 
-  def push(tag_key, tag_value, user_id)
+  def push(tag_key, tag_value, user_id = nil)
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
@@ -1154,7 +1149,16 @@ class VWO
       return
     end
 
-    unless valid_string?(tag_key) && valid_string?(tag_value) && valid_string?(user_id)
+    # Argument reshuffling.
+    custom_dimension_map = {}
+    if user_id.nil? || tag_key.is_a?(Hash)
+      custom_dimension_map = convert_to_symbol_hash(tag_key)
+      user_id = tag_value
+    else
+      custom_dimension_map[tag_key.to_sym] = tag_value
+    end
+
+    unless (valid_string?(tag_key) || valid_hash?(tag_key)) && valid_string?(tag_value) && valid_string?(user_id)
       @logger.log(
         LogLevelEnum::ERROR,
         format(
@@ -1166,52 +1170,61 @@ class VWO
       return false
     end
 
-    if tag_key.length > PushApi::TAG_KEY_LENGTH
-      @logger.log(
-        LogLevelEnum::ERROR,
-        format(
-          LogMessageEnum::ErrorMessages::TAG_KEY_LENGTH_EXCEEDED,
-          file: FILE,
-          user_id: user_id,
-          tag_key: tag_key,
-          api_name: ApiMethods::PUSH
+    custom_dimension_map.each do |tag_key, tag_value|
+      if tag_key.length > PushApi::TAG_KEY_LENGTH
+        @logger.log(
+          LogLevelEnum::ERROR,
+          format(
+            LogMessageEnum::ErrorMessages::TAG_KEY_LENGTH_EXCEEDED,
+            file: FILE,
+            user_id: user_id,
+            tag_key: tag_key,
+            api_name: ApiMethods::PUSH
+          )
         )
-      )
-      return false
-    end
+        return false
+      end
 
-    if tag_value.length > PushApi::TAG_VALUE_LENGTH
-      @logger.log(
-        LogLevelEnum::ERROR,
-        format(
-          LogMessageEnum::ErrorMessages::TAG_VALUE_LENGTH_EXCEEDED,
-          file: FILE,
-          user_id: user_id,
-          tag_value: tag_value,
-          api_name: ApiMethods::PUSH
+      if tag_value.length > PushApi::TAG_VALUE_LENGTH
+        @logger.log(
+          LogLevelEnum::ERROR,
+          format(
+            LogMessageEnum::ErrorMessages::TAG_VALUE_LENGTH_EXCEEDED,
+            file: FILE,
+            user_id: user_id,
+            tag_value: tag_value,
+            api_name: ApiMethods::PUSH
+          )
         )
-      )
-      return false
+        return false
+      end
     end
 
     if defined?(@batch_events)
-      impression = get_batch_event_url_params(@settings_file, tag_key, tag_value, user_id)
-      @batch_events_queue.enqueue(impression)
+      custom_dimension_map.each do |tag_key, tag_value|
+        impression = get_batch_event_url_params(@settings_file, tag_key, tag_value, user_id)
+        @batch_events_queue.enqueue(impression)
+      end
+    elsif is_event_arch_enabled
+      properties = get_events_base_properties(@settings_file, EventEnum::VWO_SYNC_VISITOR_PROP)
+      payload = get_push_payload_data(@settings_file, user_id, EventEnum::VWO_SYNC_VISITOR_PROP, custom_dimension_map)
+      @event_dispatcher.dispatch_event_arch_post(properties, payload)
     else
-      impression = get_url_params(@settings_file, tag_key, tag_value, user_id, @sdk_key)
-      @event_dispatcher.dispatch(impression)
+      custom_dimension_map.each do |tag_key, tag_value|
+        impression = get_url_params(@settings_file, tag_key, tag_value, user_id, @sdk_key)
+        @event_dispatcher.dispatch(impression)
 
-      @logger.log(
-        LogLevelEnum::INFO,
-        format(
-          LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_PUSH_API,
-          file: FILE,
-          sdk_key: @sdk_key,
-          u: impression['u'],
-          account_id: impression['account_id'],
-          tags: impression['tags']
+        @logger.log(
+          LogLevelEnum::INFO,
+          format(
+            LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_PUSH_API,
+            file: FILE,
+            u: impression['u'],
+            account_id: impression['account_id'],
+            tags: impression['tags']
+          )
         )
-      )
+      end
     end
     true
   rescue StandardError => e
@@ -1227,23 +1240,8 @@ class VWO
     false
   end
 
-  def get_should_track_returning_user(options)
-    if !options.key?(:should_track_returning_user)
-      options[:should_track_returning_user] = @should_track_returning_user
-    elsif ![true, false].include?(options[:should_track_returning_user])
-      @logger.log(
-        LogLevelEnum::ERROR,
-        format(
-          LogMessageEnum::ErrorMessages::INVALID_TRACK_RETURNING_USER_VALUE,
-          file: FILE
-        )
-      )
-    end
-    options[:should_track_returning_user]
-  end
-
-  def is_eligible_to_send_impression(should_track_returning_user = false)
-    !@user_storage || !@variation_decider.has_stored_variation || should_track_returning_user
+  def is_eligible_to_send_impression()
+    !@user_storage || !@variation_decider.has_stored_variation
   end
 
   def flush_events
@@ -1295,4 +1293,8 @@ class VWO
     end
     goal_type_to_track
   end
+
+  def is_event_arch_enabled
+    return @settings_file.key?('isEventArchEnabled') && @settings_file['isEventArchEnabled']
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.23.1
+  version: 1.25.0
 platform: ruby
 authors:
 - VWO
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov