vwo-sdk 1.23.0 → 1.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a74040a37074e3fb8ffc75990383654fec552c7007414409ad6563de6173fe9
-  data.tar.gz: bac8b215309d14868f7cc8022f9d8afe1924d0ad22df3ed0919e136d8025c8cb
+  metadata.gz: 68dad84f9b03958ca980c9f9ef2dc91faabdf57bfc33a55baaf5316123eb010b
+  data.tar.gz: de01033026fe5f493d7a6a1419c65a60f41a43ac85526a4f16f90448ff31a3bb
 SHA512:
-  metadata.gz: 985e03d85f42c33db7c65580abce890127707b11e479a001a372d75ed779aad2d8010edcf2cc2e3dccb8fef39d02be3a165300465beef0e82851ce221985ef5f
-  data.tar.gz: d90e9528ba974d9e9a29bb7ee4f2d3b3fcb56e14edb15f62b0aaa45e2c2353c94723084c667785de871a8b43bb5d105747d4413683e097c44dd9f7e68e4d6a55
+  metadata.gz: 81bfc307f0aa0482c3426edd657ac960fde1d95843401e1f583dc96b6785ef3c6e59f10b1d577424da40d956cd792618275a4451c1f4dc4dff3458454d15f238
+  data.tar.gz: 1f8dadef134e4064962bf606b43de36f9b4e4d4ed00c932948b56ab45960e430e42b20edb9e2eae65709091067dce162959165028698d0010ff767657887f1fd

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.0'
+    SDK_VERSION = '1.24.1'
     SDK_NAME = 'ruby'
     VWO_DELIMITER = '_vwo_'
     MAX_EVENTS_PER_REQUEST = 5000

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 = []
 
@@ -485,7 +498,7 @@ class VWO
                 user_id: user_id,
                 status: status,
                 custom_variables: variation_targeting_variables,
-                variation_name: variation['name'],
+                variation_name: status == StatusEnum::PASSED ? (campaign['type'] == CampaignTypes::FEATURE_ROLLOUT ? 'and hence becomes part of the rollout' : "for " + variation['name']) : '',
                 segmentation_type: SegmentationTypeEnum::WHITELISTING,
                 api_name: api_name
               ),
@@ -865,8 +878,8 @@ class VWO
               campaign_key: campaign_key,
               user_id: user_id,
               status: status,
-              custom_variables: variation_targeting_variables,
-              variation_name: status == StatusEnum::PASSED ? "and #{variation['name']} is Assigned" : ' ',
+              custom_variables: variation_targeting_variables ? variation_targeting_variables : {},
+              variation_name: (status == StatusEnum::PASSED && campaign['type'] != CampaignTypes::FEATURE_ROLLOUT) ? "and #{variation['name']} is Assigned" : ' ',
               segmentation_type: SegmentationTypeEnum::WHITELISTING,
               api_name: api_name
             ),
@@ -879,10 +892,9 @@ class VWO
               decision[:variation_id] = variation['id']
               if campaign['type'] == CampaignTypes::FEATURE_TEST
                 decision[:is_feature_enabled] = variation['isFeatureEnabled']
-              elsif campaign['type'] == CampaignTypes::VISUAL_AB
-                decision[:is_user_whitelisted] = !!variation['name']
               end
             end
+            decision[:is_user_whitelisted] = true
             @hooks_manager.execute(decision)
           end
 

data/lib/vwo/enums.rb

@@ -106,7 +106,7 @@ 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.'
@@ -128,9 +128,9 @@ 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 = '(%<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'
@@ -143,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'
@@ -201,7 +201,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

@@ -73,6 +73,9 @@ class VWO
             key: {
               type: ['string']
             },
+            name: {
+              type: ['string']
+            },
             status: {
               type: ['string']
             },
@@ -92,6 +95,7 @@ class VWO
               }
             },
             isBucketingSeedEnabled: ['boolean'],
+            isUserListEnabled: ['boolean'],
             minItems: 2
           }
         },

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/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

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,
@@ -408,7 +388,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 +567,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,
@@ -683,7 +661,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(
@@ -725,7 +703,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 +714,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]
@@ -809,7 +785,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 +796,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 +852,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,
@@ -905,7 +880,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]
           )
@@ -1206,7 +1180,6 @@ class VWO
         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']
@@ -1227,23 +1200,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

metadata

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