vwo-sdk 1.15.0 → 1.23.1

data/lib/vwo/enums.rb

@@ -106,13 +106,14 @@ class VWO
         IMPRESSION_FOR_TRACK_USER = '(%<file>s): Impression built for track-user - %<properties>s'
         IMPRESSION_FOR_TRACK_GOAL = '(%<file>s): Impression built for track-goal - %<properties>s'
         GOT_VARIATION_FOR_USER = '(%<file>s): userId:%<user_id>s for campaign:%<campaign_key>s got variationName:%<variation_name>s'
-        SEGMENTATION_STATUS = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s of campaign:%<campaign_key>s  with variables:%<custom_variables>s %<status>s %<segmentation_type>s for %<variation_name>s'
+        SEGMENTATION_STATUS = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s of campaign:%<campaign_key>s  with variables:%<custom_variables>s %<status>s %<segmentation_type>s %<variation_name>s'
         PARAMS_FOR_PUSH_CALL = '(%<file>s): Params for push call - %<properties>s'
         CAMPAIGN_NOT_ACTIVATED = '(%<file>s): Campaign:%<campaign_key>s for User ID:%<user_id>s is not yet activated for API:%<api_name>s. Use activate API to activate A/B test or isFeatureEnabled API to activate Feature Test.'
         BATCH_EVENT_LIMIT_EXCEEDED = '(%<file>s): Impression event - %<end_point>s failed due to exceeding payload size. Parameter eventsPerRequest in batchEvents config in launch API has value:%<eventsPerRequest>s for accountId:%<accountId>s. Please read the official documentation for knowing the size limits.'
         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
@@ -142,7 +143,7 @@ class VWO
         USER_PASSED_SEGMENTATION = '(%<file>s): UserId:%<user_id>s of campaign:%<campaign_key>s with custom_variables:%<custom_variables>s passed segmentation'
         USER_FAILED_SEGMENTATION = '(%<file>s): UserId:%<user_id>s of campaign:%<campaign_key>s with custom_variables:%<custom_variables>s failed segmentation'
 
-        NO_CUSTOM_VARIABLES = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s preSegments/customVariables are not passed for campaign:%<campaign_key>s and campaign has pre-segmentation'
+        NO_CUSTOM_VARIABLES = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s customVariables are not passed for campaign:%<campaign_key>s and campaign has pre-segmentation'
         SKIPPING_SEGMENTATION = '(%<file>s): In API: %<api_name>s, Skipping segmentation:%<variation>s for UserId:%<user_id>s as no valid segments found in campaign:%<campaign_key>s'
 
         SEGMENTATION_STATUS = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s of campaign:%<campaign_key>s  with variables:%<custom_variables>s %<status>s %<segmentation_type>s %<variation_name>s'
@@ -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
@@ -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

data/lib/vwo.rb

@@ -23,6 +23,7 @@ require_relative 'vwo/utils/campaign'
 require_relative 'vwo/utils/impression'
 require_relative 'vwo/utils/feature'
 require_relative 'vwo/utils/custom_dimensions'
+require_relative 'vwo/utils/utility'
 require_relative 'vwo/constants'
 require_relative 'vwo/core/variation_decider'
 require_relative 'vwo/services/batch_events_dispatcher'
@@ -39,6 +40,7 @@ class VWO
   include Utils::CustomDimensions
   include Utils::Campaign
   include Utils::Impression
+  include Utils::Utility
   include CONSTANTS
 
   FILE = FileNameEnum::VWO
@@ -62,6 +64,7 @@ class VWO
     settings_file = nil,
     options = {}
   )
+    options = convert_to_symbol_hash(options)
     @account_id = account_id
     @sdk_key = sdk_key
     @user_storage = user_storage
@@ -295,9 +298,10 @@ class VWO
       return
     end
 
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    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
@@ -413,7 +417,6 @@ class VWO
           )
         end
       end
-      variation['name']
     else
       @logger.log(
         LogLevelEnum::INFO,
@@ -425,8 +428,8 @@ class VWO
           api_name: ApiMethods::ACTIVATE
         )
       )
-      nil
     end
+    variation['name']
   rescue StandardError => e
     @logger.log(
       LogLevelEnum::ERROR,
@@ -469,9 +472,10 @@ class VWO
       )
       return
     end
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    custom_variables = options[:custom_variables]
+    variation_targeting_variables = options[:variation_targeting_variables]
 
     # Validate input parameters
     unless valid_string?(campaign_key) && valid_string?(user_id) && (custom_variables.nil? || valid_hash?(custom_variables)) &&
@@ -580,9 +584,10 @@ class VWO
       return false
     end
 
-    revenue_value = options['revenue_value'] || options[:revenue_value]
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    options = convert_to_symbol_hash(options)
+    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)
 
@@ -676,7 +681,7 @@ class VWO
           if !identifiers.include? goal_identifier
             updated_goal_identifier = variation['goal_identifier']
             updated_goal_identifier += VWO_DELIMITER + goal_identifier
-            @variation_decider.save_user_storage(user_id, campaign['key'], variation['name'], updated_goal_identifier) if variation['name']
+            @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
             @logger.log(
@@ -800,9 +805,10 @@ class VWO
       return false
     end
 
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_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,
@@ -870,80 +876,85 @@ class VWO
     return false unless variation
 
     # if campaign type is feature_test Send track call to server
-    if campaign_type == CampaignTypes::FEATURE_TEST
-      if is_eligible_to_send_impression(should_track_returning_user)
-        if defined?(@batch_events)
-          impression = create_bulk_event_impression(
-            @settings_file,
-            campaign['id'],
-            variation['id'],
-            user_id
-          )
-          @batch_events_queue.enqueue(impression)
-        else
-          impression = create_impression(
-            @settings_file,
-            campaign['id'],
-            variation['id'],
-            user_id,
-            @sdk_key,
-            goal_id: nil,
-            revenue: nil,
-            usage_stats: @usage_stats.usage_stats
-          )
 
-          @event_dispatcher.dispatch(impression)
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              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]
-            )
-          )
-        end
-        result = variation['isFeatureEnabled']
-        if result
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::FEATURE_ENABLED_FOR_USER,
-              file: FILE,
-              user_id: user_id,
-              feature_key: campaign_key,
-              api_name: ApiMethods::IS_FEATURE_ENABLED
-            )
-          )
-        else
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::FEATURE_NOT_ENABLED_FOR_USER,
-              file: FILE,
-              user_id: user_id,
-              feature_key: campaign_key,
-              api_name: ApiMethods::IS_FEATURE_ENABLED
-            )
-          )
-        end
-        return result
+    if is_eligible_to_send_impression(should_track_returning_user)
+      if defined?(@batch_events)
+        impression = create_bulk_event_impression(
+          @settings_file,
+          campaign['id'],
+          variation['id'],
+          user_id
+        )
+        @batch_events_queue.enqueue(impression)
       else
+        impression = create_impression(
+          @settings_file,
+          campaign['id'],
+          variation['id'],
+          user_id,
+          @sdk_key,
+          nil,
+          nil,
+          usage_stats: @usage_stats.usage_stats
+        )
+
+        @event_dispatcher.dispatch(impression)
         @logger.log(
           LogLevelEnum::INFO,
           format(
-            LogMessageEnum::InfoMessages::USER_ALREADY_TRACKED,
+            LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_IMPRESSION,
             file: FILE,
-            user_id: user_id,
-            campaign_key: campaign_key,
-            api_name: ApiMethods::IS_FEATURE_ENABLED
+            campaign_id: impression[:experiment_id],
+            sdk_key: @sdk_key,
+            account_id: impression[:account_id],
+            variation_id: impression[:combination]
           )
         )
       end
+
+    else
+      @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::USER_ALREADY_TRACKED,
+          file: FILE,
+          user_id: user_id,
+          campaign_key: campaign_key,
+          api_name: ApiMethods::IS_FEATURE_ENABLED
+        )
+      )
     end
-    true
+    if campaign_type == CampaignTypes::FEATURE_ROLLOUT
+      result = true
+    else
+      result = variation['isFeatureEnabled']
+    end
+
+    if result
+      @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::FEATURE_ENABLED_FOR_USER,
+          file: FILE,
+          user_id: user_id,
+          feature_key: campaign_key,
+          api_name: ApiMethods::IS_FEATURE_ENABLED
+        )
+      )
+    else
+      @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::FEATURE_NOT_ENABLED_FOR_USER,
+          file: FILE,
+          user_id: user_id,
+          feature_key: campaign_key,
+          api_name: ApiMethods::IS_FEATURE_ENABLED
+        )
+      )
+    end
+
+    result
   rescue StandardError => e
     @logger.log(
       LogLevelEnum::ERROR,
@@ -989,9 +1000,10 @@ class VWO
       return
     end
 
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    custom_variables = options[:custom_variables]
+    variation_targeting_variables = options[:variation_targeting_variables]
 
     unless valid_string?(campaign_key) && valid_string?(variable_key) && valid_string?(user_id) &&
       (custom_variables.nil? || valid_hash?(custom_variables)) && (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.23.1
 platform: ruby
 authors:
 - VWO
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -111,6 +111,7 @@ files:
 - lib/vwo/utils/impression.rb
 - lib/vwo/utils/request.rb
 - lib/vwo/utils/segment.rb
+- lib/vwo/utils/utility.rb
 - lib/vwo/utils/uuid.rb
 - lib/vwo/utils/validations.rb
 homepage: https://vwo.com/fullstack/server-side-testing/