vwo-sdk 1.14.1 → 1.23.0

data/lib/vwo/enums.rb

@@ -113,6 +113,7 @@ class VWO
         BULK_NOT_PROCESSED = "(%<file>s): Batch events couldn't be received by VWO. Calling Flush Callback with error and data."
         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"
       end
 
       # Info Messages
@@ -152,9 +153,13 @@ class VWO
         CAMPAIGN_NOT_ACTIVATED = '(%<file>s): Activate the campaign:%<campaign_key>s for User ID:%<user_id>s to %<reason>s.'
         GOAL_ALREADY_TRACKED = '(%<file>s): Goal:%<goal_identifier>s of Campaign:%<campaign_key>s for User ID:%<user_id>s has already been tracked earlier. Skipping now'
         USER_ALREADY_TRACKED = '(%<file>s): User ID:%<user_id>s for Campaign:%<campaign_key>s has already been tracked earlier for "%<api_name>s" API. Skipping now'
-        API_CALLED = '(%<file>s): API: {api_name} called for UserId:%<user_id>s'
+        API_CALLED = '(%<file>s): API: %<api_name>s called for UserId:%<user_id>s'
         BULK_IMPRESSION_SUCCESS = '(%<file>s): Impression event - %<end_point>s was successfully received by VWO having accountId:%<a>s'
         AFTER_FLUSHING = '(%<file>s): Events queue having %<length>s events has been flushed %<manually>s queue summary: %<queue_metadata>s'
+        GOT_WINNER_CAMPAIGN = "(%<file>s): Campaign:%<campaign_key>s is selected from the mutually exclusive group:%<group_name>s for the User ID:%<user_id>s"
+        GOT_ELIGIBLE_CAMPAIGNS = "(%<file>s): Got %<no_of_eligible_campaigns>s eligible winners out of %<no_of_group_campaigns>s from the Group:%<group_name>s and for User ID:%<user_id>s"
+        CALLED_CAMPAIGN_NOT_WINNER = "(%<file>s): Campaign:%<campaign_key>s does not qualify from the mutually exclusive group:%<group_name>s for User ID:%<user_id>s"
+        OTHER_CAMPAIGN_SATISFIES_WHITELISTING_OR_STORAGE = "(%<file>s): Campaign:%<campaign_key>s of Group:%<group_name>s satisfies %<type>s for User ID:%<user_id>s"
       end
 
       # Warning Messages

data/lib/vwo/logger.rb

@@ -28,8 +28,10 @@ class VWO
     end
 
     # Override this method to handle logs in a custom manner
-    def log(level, message)
-      @@logger_instance.log(level, message)
+    def log(level, message, disable_logs = false)
+      unless disable_logs
+        @@logger_instance.log(level, message)
+      end
     end
 
     def instance

data/lib/vwo/schemas/settings_file.rb

@@ -54,7 +54,13 @@ class VWO
             },
             weight: {
               type: %w[number string]
-            }
+            },
+           variables: {
+             type: 'array',
+             items: {
+               '$ref' => '#/definitions/variables_schema'
+             }
+           }
           },
           required: %w[id name weight]
         },
@@ -79,9 +85,34 @@ class VWO
                 '$ref' => '#/definitions/campaign_variation_schema'
               }
             },
+            variables: {
+              type: 'array',
+              items: {
+                '$ref' => '#/definitions/variables_schema'
+              }
+            },
+            isBucketingSeedEnabled: ['boolean'],
             minItems: 2
           }
         },
+        variables_schema: {
+          type: 'object',
+          properties: {
+            id: {
+              type: %w[number string]
+            },
+            key: {
+              type: ['string']
+            },
+            type: {
+              type: ['string']
+            },
+            value: {
+              type: %w[number string boolean double object]
+            }
+          },
+          required: %w[id key type value]
+        },
         required: %w[
           id
           key

data/lib/vwo/services/operand_evaluator.rb

@@ -91,11 +91,10 @@ class VWO
       # @return [Boolean]
       def evaluate_custom_variable?(operand, custom_variables)
         # Extract custom_variable_key and custom_variables_value from operand
-
         operand_key, operand = get_key_value(operand)
 
         # Retrieve corresponding custom_variable value from custom_variables
-        custom_variables_value = custom_variables[operand_key]
+        custom_variables_value = custom_variables[operand_key.to_sym]
 
         # Pre process custom_variable value
         custom_variables_value = process_custom_variables_value(custom_variables_value)
@@ -113,7 +112,7 @@ class VWO
       def evaluate_user?(operand, custom_variables)
         users = operand.split(',')
         users.each do |user|
-          return true if user.strip == custom_variables['_vwo_user_id']
+          return true if user.strip == custom_variables[:_vwo_user_id]
         end
         false
       end

data/lib/vwo/services/segment_evaluator.rb

@@ -63,10 +63,11 @@ class VWO
       # @param[String]                  :user_id              Unique user identifier
       # @param[Hash]                    :dsl                  Segments provided in the settings_file
       # @param[Hash]                    :custom_variables     Custom variables provided in the apis
+      # @param[Boolean]                 :disable_logs         disable logs if True
       #
       # @return[Boolean]                true if user passed pre-segmentation, else false
       #
-      def evaluate(campaign_key, user_id, dsl, custom_variables)
+      def evaluate(campaign_key, user_id, dsl, custom_variables, disable_logs = false)
         result = evaluate_util(dsl, custom_variables) if valid_value?(dsl)
         result
       rescue StandardError => e
@@ -79,7 +80,8 @@ class VWO
             campaign_key: campaign_key,
             custom_variables: custom_variables,
             error_message: e
-          )
+          ),
+          disable_logs
         )
         false
       end

data/lib/vwo/utils/campaign.rb

@@ -57,6 +57,26 @@ class VWO
         end
       end
 
+      # Sets campaign allocation range in the provided campaigns list
+      #
+      # @param [Array]: Array of Campaigns
+      def set_campaign_allocation(campaigns)
+        current_allocation = 0
+        campaigns.each do |campaign|
+          step_factor = get_variation_bucketing_range(campaign['weight'])
+          if step_factor > 0
+            start_range = current_allocation + 1
+            end_range = current_allocation + step_factor
+            campaign['min_range'] = start_range
+            campaign['max_range'] = end_range
+            current_allocation += step_factor
+          else
+            campaign['min_range'] = -1
+            campaign['max_range'] = -1
+          end
+        end
+      end
+
       # Returns goal from given campaign_key and gaol_identifier.
       # @param[String]            :campaign             Campaign object
       # @param[String]            :goal_identifier      Goal identifier
@@ -190,7 +210,7 @@ class VWO
             end
             goal = get_campaign_goal(campaign, goal_identifier)
             if validate_goal(goal, goal_type_to_track)
-              campaigns.append(campaign)
+              campaigns.push(campaign)
             end
           end
         end
@@ -215,7 +235,7 @@ class VWO
 
           campaign = get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
           if campaign
-            campaigns.append(campaign)
+            campaigns.push(campaign)
           end
         end
         campaigns
@@ -249,6 +269,44 @@ class VWO
         return campaign
       end
 
+      # Checks whether a campaign is part of a group.
+      #
+      #  @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
+        false
+      end
+
+      # Returns campaigns which are part of given group using group_id.
+      #
+      #  @param[Hash]       :settings_file          Settings file for the project
+      #  @param[Integer]    :group_id               id of group whose campaigns are to be return
+      #  @return[Array]
+      def get_group_campaigns(settings_file, group_id)
+        group_campaign_ids = []
+        group_campaigns = []
+        groups = settings_file["groups"]
+
+        if groups && groups.has_key?(group_id.to_s)
+          group_campaign_ids = groups[group_id.to_s]["campaigns"]
+        end
+
+        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
+          end
+        end
+        group_campaigns
+      end
+
     end
   end
 end

data/lib/vwo/utils/feature.rb

@@ -38,6 +38,8 @@ class VWO
         return value.to_f if variable_type == VariableTypes::DOUBLE
 
         return !value || value == 0 ? false : true if variable_type == VariableTypes.BOOLEAN
+
+        return value if variable_type == VariableTypes::JSON
       rescue StandardError => _e
         VWO::Logger.get_instance.log(
           LogLevelEnum::ERROR,

data/lib/vwo/utils/utility.rb

@@ -0,0 +1,40 @@
+# Copyright 2019-2021 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+require_relative './validations'
+
+# Generic utility module
+class VWO
+    module Utils
+        module Utility
+            include Validations
+
+            # converting hash with keys as strings into hash with keys as strings
+            # @param[Hash]
+            # @return[Hash]
+            def convert_to_symbol_hash(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
+        end
+    end
+end