vwo-sdk 1.36.0 → 1.37.1

data/lib/vwo/utils/campaign.rb

@@ -45,7 +45,7 @@ class VWO
             LogLevelEnum::DEBUG,
             'VARIATION_RANGE_ALLOCATION',
             {
-              '{file}' => FileNameEnum::CampaignUtil,
+              '{file}' => FileNameEnum::CAMPAIGN_UTIL,
               '{campaignKey}' => campaign['key'],
               '{variationName}' => variation['name'],
               '{variationWeight}' => variation['weight'],
@@ -177,21 +177,19 @@ class VWO
           campaigns = get_campaigns_from_campaign_keys(campaign_key, settings_file, goal_identifier, goal_type_to_track)
         elsif campaign_key.is_a?(String)
           campaign = get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
-          if campaign
-            campaigns = [campaign]
-          end
+          campaigns = [campaign] if campaign
         end
-        if campaigns.length() == 0
+        if campaigns.length == 0
           Utils::Logger.log(
             LogLevelEnum::ERROR,
             'CAMPAIGN_NOT_FOUND_FOR_GOAL',
             {
-              '{file}' => FileNameEnum::CampaignUtil,
+              '{file}' => FileNameEnum::CAMPAIGN_UTIL,
               '{goalIdentifier}' => goal_identifier
             }
           )
         end
-        return campaigns
+        campaigns
       end
 
       # fetch all running campaigns (having goal identifier goal_type_to_track and goal type CUSTOM|REVENUE|ALL) from settings
@@ -204,38 +202,31 @@ class VWO
         campaigns = []
         if settings_file
           settings_file['campaigns'].each do |campaign|
-            if campaign.key?(:status) && campaign[:status] != 'RUNNING'
-              next
-            end
+            next if campaign.key?(:status) && campaign[:status] != 'RUNNING'
+
             goal = get_campaign_goal(campaign, goal_identifier)
-            if validate_goal(goal, goal_type_to_track)
-              campaigns.push(campaign)
-            end
+            campaigns.push(campaign) if validate_goal(goal, goal_type_to_track)
           end
         end
         campaigns
       end
 
       def validate_goal(goal, goal_type_to_track)
-        result = goal && (
+        goal && (
           goal_type_to_track == 'ALL' ||
             (
-              GOAL_TYPES.has_value?(goal['type']) &&
+              GOAL_TYPES.value?(goal['type']) &&
                 (GOAL_TYPES.key? goal_type_to_track) &&
                 goal['type'] == GOAL_TYPES[goal_type_to_track]
             )
         )
-        return result
       end
 
       def get_campaigns_from_campaign_keys(campaign_keys, settings_file, goal_identifier, goal_type_to_track = 'ALL')
         campaigns = []
         campaign_keys.each do |campaign_key|
-
           campaign = get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
-          if campaign
-            campaigns.push(campaign)
-          end
+          campaigns.push(campaign) if campaign
         end
         campaigns
       end
@@ -244,9 +235,7 @@ class VWO
         campaign = get_running_campaign(campaign_key, settings_file)
         if campaign
           goal = get_campaign_goal(campaign, goal_identifier)
-          if validate_goal(goal, goal_type_to_track)
-            return campaign
-          end
+          return campaign if validate_goal(goal, goal_type_to_track)
         end
         nil
       end
@@ -265,7 +254,7 @@ class VWO
           )
           nil
         end
-        return campaign
+        campaign
       end
 
       # Checks whether a campaign is part of a group.
@@ -273,10 +262,9 @@ class VWO
       #  @param[Hash]       :settings_file          Settings file for the project
       #  @param[Integer]     :campaign_id            Id of campaign which is to be checked
       #  @return[Boolean]
-      def is_part_of_group(settings_file, campaign_id)
-        if settings_file["campaignGroups"] && (settings_file["campaignGroups"].has_key?(campaign_id.to_s))
-          return true
-        end
+      def part_of_group?(settings_file, campaign_id)
+        return true if settings_file['campaignGroups']&.key?(campaign_id.to_s)
+
         false
       end
 
@@ -288,24 +276,34 @@ class VWO
       def get_group_campaigns(settings_file, group_id)
         group_campaign_ids = []
         group_campaigns = []
-        groups = settings_file["groups"]
+        groups = settings_file['groups']
 
-        if groups && groups.has_key?(group_id.to_s)
-          group_campaign_ids = groups[group_id.to_s]["campaigns"]
-        end
+        group_campaign_ids = groups[group_id.to_s]['campaigns'] if groups&.key?(group_id.to_s)
 
-        if group_campaign_ids
-          group_campaign_ids.each do |campaign_id|
-            settings_file["campaigns"].each do |campaign|
-              if campaign["id"] == campaign_id && campaign["status"] == STATUS_RUNNING
-                group_campaigns.push(campaign)
-              end
-            end
+        group_campaign_ids&.each do |campaign_id|
+          settings_file['campaigns'].each do |campaign|
+            group_campaigns.push(campaign) if campaign['id'] == campaign_id && campaign['status'] == STATUS_RUNNING
           end
         end
         group_campaigns
       end
 
+      def campaign_goal_already_tracked?(user_id, campaign, identifiers, goal_identifier)
+        if identifiers.include? goal_identifier
+          @logger.log(
+            LogLevelEnum::INFO,
+            'CAMPAIGN_GOAL_ALREADY_TRACKED',
+            {
+              '{file}' => FILE,
+              '{userId}' => user_id,
+              '{campaignKey}' => campaign['key'],
+              '{goalIdentifier}' => goal_identifier
+            }
+          )
+          return true
+        end
+        false
+      end
     end
   end
 end

data/lib/vwo/utils/custom_dimensions.rb

@@ -40,7 +40,7 @@ class VWO
           LogLevelEnum::DEBUG,
           'IMPRESSION_FOR_PUSH',
           {
-            '{file}' => FileNameEnum::CustomDimensionsUtil,
+            '{file}' => FileNameEnum::CUSTOM_DIMENSTIONS_UTIL,
             '{properties}' => JSON.generate(params)
           }
         )
@@ -63,7 +63,7 @@ class VWO
           LogLevelEnum::DEBUG,
           'IMPRESSION_FOR_PUSH',
           {
-            '{file}' => FileNameEnum::CustomDimensionsUtil,
+            '{file}' => FileNameEnum::CUSTOM_DIMENSTIONS_UTIL,
             '{properties}' => JSON.generate(params)
           }
         )

data/lib/vwo/utils/data_location_manager.rb

@@ -12,29 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 require_relative '../constants'
 
 # Utility module for generating uuid
 class VWO
   module Utils
     class DataLocationManager
-
       @@instance = nil
 
       def self.get_instance
-        if @@instance.nil?
-            @@instance = self.new
-        end
+        @@instance = new if @@instance.nil?
         @@instance
       end
 
-
       def get_data_location
         url = VWO::CONSTANTS::ENDPOINTS::BASE_URL
-        if @settings.key?("collectionPrefix")
-            url = url  + '/' + @settings["collectionPrefix"]
-        end
+        url = "#{url}/#{@settings['collectionPrefix']}" if @settings.key?('collectionPrefix')
         url
       end
 

data/lib/vwo/utils/feature.rb

@@ -40,10 +40,10 @@ class VWO
         return !value || value == 0 ? false : true if variable_type == VariableTypes.BOOLEAN
 
         return value if variable_type == VariableTypes::JSON
-      rescue StandardError => _e
+      rescue StandardError => e
         Logger.log(
           LogLevelEnum::ERROR,
-          'unable to type cast variable value: ' + _e.message,
+          "unable to type cast variable value: #{e.message}",
           {
             '{file}' => FILE
           }

data/lib/vwo/utils/impression.rb

@@ -67,8 +67,6 @@ class VWO
 
         impression = usage_stats.merge(impression)
 
-        logger = VWO::Logger.get_instance
-
         if is_track_user_api
           impression['ed'] = JSON.generate(p: 'server')
           impression['url'] = HTTPS_PROTOCOL + get_url(ENDPOINTS::TRACK_USER)
@@ -76,7 +74,7 @@ class VWO
             LogLevelEnum::DEBUG,
             'IMPRESSION_FOR_TRACK_USER',
             {
-              '{file}' => FileNameEnum::ImpressionUtil,
+              '{file}' => FileNameEnum::IMPRESSION_UTIL,
               '{properties}' => remove_sensitive_properties(impression)
             }
           )
@@ -88,7 +86,7 @@ class VWO
             LogLevelEnum::DEBUG,
             'IMPRESSION_FOR_TRACK_GOAL',
             {
-              '{file}' => FileNameEnum::ImpressionUtil,
+              '{file}' => FileNameEnum::IMPRESSION_UTIL,
               '{properties}' => JSON.generate(impression)
             }
           )
@@ -129,6 +127,7 @@ class VWO
       #                                                             Else Properties(dict)
       def create_bulk_event_impression(settings_file, campaign_id, variation_id, user_id, goal_id = nil, revenue = nil)
         return unless valid_number?(campaign_id) && valid_string?(user_id)
+
         is_track_user_api = true
         is_track_user_api = false unless goal_id.nil?
         account_id = settings_file['accountId']
@@ -139,13 +138,13 @@ class VWO
           u: generator_for(user_id, account_id, true),
           sId: get_current_unix_timestamp
         }
-        logger = VWO::Logger.get_instance
+
         if is_track_user_api
           Logger.log(
             LogLevelEnum::DEBUG,
             'IMPRESSION_FOR_TRACK_USER',
             {
-              '{file}' => FileNameEnum::ImpressionUtil,
+              '{file}' => FileNameEnum::IMPRESSION_UTIL,
               '{properties}' => remove_sensitive_properties(impression)
             }
           )
@@ -156,7 +155,7 @@ class VWO
             LogLevelEnum::DEBUG,
             'IMPRESSION_FOR_TRACK_GOAL',
             {
-              '{file}' => FileNameEnum::ImpressionUtil,
+              '{file}' => FileNameEnum::IMPRESSION_UTIL,
               '{properties}' => JSON.generate(impression)
             }
           )
@@ -179,12 +178,10 @@ class VWO
           env: settings_file['sdkKey'],
           eTime: get_current_unix_timestamp_in_millis,
           random: get_random_number,
-          p: "FS"
+          p: 'FS'
         }
 
-        if event_name == EventEnum::VWO_VARIATION_SHOWN
-          properties = properties.merge(usage_stats)
-        end
+        properties = properties.merge(usage_stats) if event_name == EventEnum::VWO_VARIATION_SHOWN
         properties
       end
 
@@ -193,10 +190,10 @@ class VWO
       # @param[Hash]                   :settings_file
       # @param[String]                 :user_id
       # @param[String]                 :event_name
-      # @param[Hash]                   :usage_stats
+      # @param[Hash]                   :_usage_stats
       # @return[Hash]                  :properties
       #
-      def get_event_base_payload(settings_file, user_id, event_name, usage_stats = {})
+      def get_event_base_payload(settings_file, user_id, event_name, _usage_stats = {})
         uuid = generator_for(user_id, (settings_file['accountId']), true)
         sdk_key = settings_file['sdkKey']
 
@@ -211,12 +208,12 @@ class VWO
         }
 
         # if usage_stats
-        #   props = props.merge(usage_stats)
+        #   props = props.merge(_usage_stats)
         # end
 
-        properties = {
+        {
           d: {
-            msgId: uuid + '_' + Time.now.to_i.to_s,
+            msgId: "#{uuid} + '_' + #{Time.now.to_i}",
             visId: uuid,
             sessionId: Time.now.to_i,
             event: {
@@ -231,8 +228,6 @@ class VWO
             }
           }
         }
-
-        properties
       end
 
       # Builds payload to track the visitor.
@@ -242,27 +237,26 @@ class VWO
       # @param[String]                 :event_name
       # @param[Integer]                :campaign_id
       # @param[Integer]                :variation_id
-      # @param[Hash]                   :usage_stats
+      # @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 = {})
+      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
+        # 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,
-            'IMPRESSION_FOR_EVENT_ARCH_TRACK_USER',
-            {
-              '{file}' => FileNameEnum::ImpressionUtil,
-              '{accountId}' => settings_file['accountId'],
-              '{userId}' => user_id,
-              '{campaignId}' => campaign_id.to_s
-            }
+          LogLevelEnum::DEBUG,
+          'IMPRESSION_FOR_EVENT_ARCH_TRACK_USER',
+          {
+            '{file}' => FileNameEnum::IMPRESSION_UTIL,
+            '{accountId}' => settings_file['accountId'],
+            '{userId}' => user_id,
+            '{campaignId}' => campaign_id.to_s
+          }
         )
         properties
       end
@@ -281,15 +275,14 @@ class VWO
       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]
+          metric["id_#{campaign_id}".to_sym] = ["g_#{goal_id}"]
           Logger.log(
             LogLevelEnum::DEBUG,
             'IMPRESSION_FOR_EVENT_ARCH_TRACK_GOAL',
             {
-              '{file}' => FileNameEnum::ImpressionUtil,
+              '{file}' => FileNameEnum::IMPRESSION_UTIL,
               '{accountId}' => settings_file['accountId'],
               '{goalName}' => event_name,
               '{userId}' => user_id,
@@ -302,7 +295,7 @@ class VWO
           metric: metric
         }
 
-        if revenue_props.length() != 0 && revenue_value
+        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
@@ -330,12 +323,11 @@ class VWO
           properties[:d][:visitor][:props][tag_key] = tag_value
         end
 
-        logger = VWO::Logger.get_instance
         Logger.log(
           LogLevelEnum::DEBUG,
           'IMPRESSION_FOR_EVENT_ARCH_PUSH',
           {
-            '{file}' => FileNameEnum::ImpressionUtil,
+            '{file}' => FileNameEnum::IMPRESSION_UTIL,
             '{accountId}' => settings_file['accountId'],
             '{userId}' => user_id,
             '{property}' => JSON.generate(custom_dimension_map)
@@ -345,7 +337,7 @@ class VWO
       end
 
       def get_batch_event_query_params(account_id, sdk_key, usage_stats = {})
-        return {
+        {
           a: account_id,
           sd: SDK_NAME,
           sv: SDK_VERSION,

data/lib/vwo/utils/log_message.rb

@@ -19,7 +19,6 @@ require_relative '../logger'
 class VWO
   module Utils
     class Logger
-
       DEBUG = ::Logger::DEBUG
       INFO = ::Logger::INFO
       ERROR = ::Logger::ERROR
@@ -32,43 +31,37 @@ class VWO
         @@api_name = api_name
       end
 
-      def self.get_log_message(logsType, message_type)
-        if @@logs.nil?
-          @@logs = VwoLogMessages.getMessage
-        end
+      def self.get_log_message(logs_type, message_type)
+        @@logs = VwoLogMessages.getMessage if @@logs.nil?
 
-        if !@@logs[logsType].key?(message_type)
-          return message_type
-        end
-        return @@logs[logsType][message_type]
+        return message_type unless @@logs[logs_type].key?(message_type)
+
+        @@logs[logs_type][message_type]
       end
 
       def self.log(level, message_type, params, disable_logs = false)
-        if disable_logs
-          return
-        end
-        if level == DEBUG
-          message = get_log_message('debug_logs', message_type)
-        elsif level == INFO
-          message = get_log_message('info_logs', message_type)
-        elsif level == ERROR
-          message = get_log_message('error_logs', message_type)
-        elsif level == WARN
-          message = get_log_message('warning_logs', message_type)
-        else
-          message = ""
-        end
+        return if disable_logs
+
+        message = case level
+                  when DEBUG
+                    get_log_message('debug_logs', message_type)
+                  when INFO
+                    get_log_message('info_logs', message_type)
+                  when ERROR
+                    get_log_message('error_logs', message_type)
+                  when WARN
+                    get_log_message('warning_logs', message_type)
+                  else
+                    ''
+                  end
         message = message.dup
 
         if message && !message.empty?
-          params.each {
-            |key, value|
-            if message.include? key
-              message[key.to_s]= value.to_s
-            end
-          }
+          params.each do |key, value|
+            message[key.to_s] = value.to_s if message.include? key
+          end
         end
-        message = '[' + @@api_name + '] ' + message
+        message = "[#{@@api_name}] #{message}"
         VWO::Logger.get_instance.log(level, message)
       end
     end

data/lib/vwo/utils/request.rb

@@ -31,12 +31,11 @@ class VWO
         http.use_ssl = true
         uri.query = URI.encode_www_form(params)
         headers = {
-          'Authorization'=>params[:env],
-          'Content-Type' =>'application/json',
-          'Accept'=>'application/json'
+          'Authorization' => params[:env],
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
         }
-        response = http.post(uri, post_data.to_json, headers)
-        response
+        http.post(uri, post_data.to_json, headers)
       end
 
       def self.event_post(url, params, post_data, user_agent_value)
@@ -46,11 +45,10 @@ class VWO
         uri.query = URI.encode_www_form(params)
         headers = {
           'User-Agent' => user_agent_value,
-          'Content-Type' =>'application/json',
-          'Accept'=>'application/json'
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
         }
-        response = http.post(uri, post_data.to_json, headers)
-        response
+        http.post(uri, post_data.to_json, headers)
       end
     end
   end

data/lib/vwo/utils/utility.rb

@@ -19,44 +19,54 @@ require_relative '../constants'
 
 # Generic utility module
 class VWO
-    module Utils
-        module Utility
-            include Validations
-            include VWO::Utils
-            include VWO::CONSTANTS
+  module Utils
+    module Utility
+      include Validations
+      include VWO::Utils
+      include VWO::CONSTANTS
 
-            # converting hash with keys as strings into hash with keys as strings
-            # @param[Hash]
-            # @return[Hash]
-            def convert_to_symbol_hash(hashObject)
-                hashObject ||= {}
-                convertedHash = {}
-                hashObject.each do |key, value|
-                    if valid_hash?(value)
-                        convertedHash[key.to_sym] = convert_to_symbol_hash(value)
-                    else
-                        convertedHash[key.to_sym] = value
-                    end
-                end
-                convertedHash
-            end
+      # converting hash with keys as strings into hash with keys as strings
+      # @param[Hash]
+      # @return[Hash]
+      def convert_to_symbol_hash(hash_object)
+        hash_object ||= {}
+        converted_hash = {}
+        hash_object.each do |key, value|
+          converted_hash[key.to_sym] = if valid_hash?(value)
+                                         convert_to_symbol_hash(value)
+                                       else
+                                         value
+                                       end
+        end
+        converted_hash
+      end
+
+      def remove_sensitive_properties(properties)
+        properties.delete('env')
+        properties.delete('env'.to_sym)
+        JSON.generate(properties)
+      end
 
-            def remove_sensitive_properties(properties)
-                properties.delete("env")
-                properties.delete("env".to_sym)
-                JSON.generate(properties)
-            end
+      def get_url(endpoint)
+        DataLocationManager.get_instance.get_data_location + endpoint
+      end
 
-            def get_url(endpoint)
-                return DataLocationManager.get_instance().get_data_location + endpoint
-            end
+      def prepare_push_response(custom_dimension_map, resp, result)
+        custom_dimension_map.each do |tag_key, _tag_value|
+          result[tag_key] = resp
+        end
+        result
+      end
 
-            def prepare_push_response(custom_dimension_map, resp, result)
-                custom_dimension_map.each do |tag_key, tag_value|
-                    result[tag_key] = resp
-                end
-                result
-            end
+      def get_variation_identifiers(variation)
+        if variation['goal_identifier']
+          identifiers = variation['goal_identifier'].split(VWO_DELIMITER)
+        else
+          variation['goal_identifier'] = ''
+          identifiers = []
         end
+        identifiers
+      end
     end
+  end
 end