vwo-sdk 1.30.0 → 1.37.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8bf50eeb65a850a9a49fb00628208670c6bd7a167c591d8d649573fa0a67bc7
-  data.tar.gz: cfc520d123444c23f36683a1d89bef145e466ea21a9044543641226614e076df
+  metadata.gz: ea72e150de33227c3e911fd61478a8815fb8f42f788df4a65a6751a1da7c25fb
+  data.tar.gz: c88b275817a6ef0ca80efc03287e57fd1488be9390e7a028a4dc812cca93abc0
 SHA512:
-  metadata.gz: 1e79a2e33a718e0379724b39d115f59e4ef0925f9dcc682f6c553166af90d444f7a74c5551a9474051fcee1213104a8b6fe8c9842a51da1be90f76020c38a3da
-  data.tar.gz: 553e1b3553f5c3b49d3d1dae6fdd176706129d892439b04517d5e670f1945b91246c69ec0a2ceb95b14ad7334fb4b9b580cbbc26be1cbfd10495f77fae13673c
+  metadata.gz: 294fab2cbb559b6869e547dd0f55b9bb5ac54910ba61d497f9d205fd37c405bc206b6264912bc0600306dd0986d875c034be0e4342260f3d0aa8a647ad0a67e3
+  data.tar.gz: d25b2e2642a1e178eeeba2b0f7f7e82188040df6116a6a14bb13abfba7cf8e0b2ee28c5161936cc9773663f55cdca9d371b72deea94393ac1c9d6a20cf9f383b

data/lib/vwo/constants.rb

@@ -19,7 +19,7 @@ class VWO
     SEED_VALUE = 1
     MAX_TRAFFIC_PERCENT = 100
     MAX_TRAFFIC_VALUE = 10_000
-    MAX_RANGE = 10000
+    MAX_RANGE = 10_000
     STATUS_RUNNING = 'RUNNING'
     # rubocop:disable Style/ExpandPathArguments
     LIBRARY_PATH =  File.expand_path('../..', __FILE__)
@@ -27,7 +27,7 @@ class VWO
     HTTP_PROTOCOL = 'http://'
     HTTPS_PROTOCOL = 'https://'
     URL_NAMESPACE = '6ba7b811-9dad-11d1-80b4-00c04fd430c8'
-    SDK_VERSION = '1.30.0'
+    SDK_VERSION = '1.37.1'
     SDK_NAME = 'ruby'
     VWO_DELIMITER = '_vwo_'
     MAX_EVENTS_PER_REQUEST = 5000
@@ -94,6 +94,7 @@ class VWO
     }
 
     module ApiMethods
+      LAUNCH = 'launch'
       ACTIVATE = 'activate'
       GET_VARIATION_NAME = 'get_variation_name'
       TRACK = 'track'

data/lib/vwo/core/bucketer.rb

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 require 'murmurhash3'
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../utils/validations'
+require_relative '../utils/log_message'
 require_relative '../constants'
 
 class VWO
@@ -31,40 +31,46 @@ class VWO
       # Source - https://stackoverflow.com/a/20766900/2494535
       U_MAX_32_BIT = 0xFFFFFFFF
       MAX_HASH_VALUE = 2**32
-      FILE = FileNameEnum::Bucketer
+      FILE = FileNameEnum::BUCKETER
 
       def initialize
-        @logger = VWO::Logger.get_instance
+        @logger = VWO::Utils::Logger
       end
 
       # Calculate if this user should become part of the campaign or not
       # @param[String]         :user_id     The unique ID assigned to a user
       # @param[Dict]           :campaign    For getting traffic allotted to the campaign
+      # @param[Boolean]        :disable_logs  if true, do not log log-message
       # @return[Boolean]                    If User is a part of Campaign or not
 
-      def user_part_of_campaign?(user_id, campaign)
+      def user_part_of_campaign?(user_id, campaign, disable_logs = false)
         unless valid_value?(user_id)
           @logger.log(
             LogLevelEnum::ERROR,
-            format(LogMessageEnum::ErrorMessages::INVALID_USER_ID, file: FILE, user_id: user_id, method: 'is_user_part_of_campaign')
+            'USER_ID_INVALID',
+            {
+              '{file}' => FILE,
+              '{userId}' => user_id
+            }
           )
           return false
         end
 
-        if campaign.nil?
-          @logger.log(
-            LogLevelEnum::ERROR,
-            format(LogMessageEnum::ErrorMessages::INVALID_CAMPAIGN, file: FILE, method: 'is_user_part_of_campaign')
-          )
-          return false
-        end
+        return false if campaign.nil?
 
         traffic_allocation = campaign['percentTraffic']
-        value_assigned_to_user = get_bucket_value_for_user(user_id, campaign)
+        value_assigned_to_user = get_bucket_value_for_user(user_id, campaign, nil, disable_logs)
         is_user_part = (value_assigned_to_user != 0) && value_assigned_to_user <= traffic_allocation
         @logger.log(
           LogLevelEnum::INFO,
-          format(LogMessageEnum::InfoMessages::USER_ELIGIBILITY_FOR_CAMPAIGN, file: FILE, user_id: user_id, is_user_part: is_user_part)
+          'USER_CAMPAIGN_ELIGIBILITY',
+          {
+            '{file}' => FILE,
+            '{userId}' => user_id,
+            '{status}' => is_user_part ? 'eligible' : 'not eligible',
+            '{campaignKey}' => campaign['key']
+          },
+          disable_logs
         )
         is_user_part
       end
@@ -74,30 +80,27 @@ class VWO
       #
       # @param[String]            :user_id          The unique ID assigned to User
       # @param[Hash]              :campaign         The Campaign of which User is a part of
+      # @param[Boolean]             :disable_logs   if true, do not log log-message
       #
       # @return[Hash|nil}                           Variation data into which user is bucketed to
       #                                             or nil if not
-      def bucket_user_to_variation(user_id, campaign)
+      def bucket_user_to_variation(user_id, campaign, disable_logs = false)
         unless valid_value?(user_id)
           @logger.log(
             LogLevelEnum::ERROR,
-            format(LogMessageEnum::ErrorMessages::INVALID_USER_ID, file: FILE, user_id: user_id, method: 'bucket_user_to_variation')
+            'USER_ID_INVALID',
+            {
+              '{file}' => FILE,
+              '{userId}' => user_id
+            }
           )
           return
         end
 
-        unless campaign
-          @logger.log(
-            LogLevelEnum::ERROR,
-            format(LogMessageEnum::ErrorMessages::INVALID_CAMPAIGN, file: FILE, method: 'is_user_part_of_campaign')
-          )
-          return
-        end
+        return unless campaign
 
         user_id_for_hash_value = user_id
-        if campaign['isBucketingSeedEnabled']
-          user_id_for_hash_value = campaign['id'].to_s + "_" + user_id
-        end
+        user_id_for_hash_value = "#{campaign['id']}_#{user_id}" if campaign['isBucketingSeedEnabled']
         hash_value = MurmurHash3::V32.str_hash(user_id_for_hash_value, SEED_VALUE) & U_MAX_32_BIT
         normalize = MAX_TRAFFIC_VALUE.to_f / campaign['percentTraffic']
         multiplier = normalize / 100
@@ -109,15 +112,16 @@ class VWO
 
         @logger.log(
           LogLevelEnum::DEBUG,
-          format(
-            LogMessageEnum::DebugMessages::VARIATION_HASH_BUCKET_VALUE,
-            file: FILE,
-            user_id: user_id,
-            campaign_key: campaign['key'],
-            percent_traffic: campaign['percentTraffic'],
-            bucket_value: bucket_value,
-            hash_value: hash_value
-          )
+          'USER_CAMPAIGN_BUCKET_VALUES',
+          {
+            '{file}' => FILE,
+            '{campaignKey}' => campaign['key'],
+            '{userId}' => user_id,
+            '{percentTraffic}' => campaign['percentTraffic'],
+            '{hashValue}' => hash_value,
+            '{bucketValue}' => bucket_value
+          },
+          disable_logs
         )
 
         get_variation(campaign['variations'], bucket_value)
@@ -146,22 +150,22 @@ class VWO
       def get_bucket_value_for_user(user_id, campaign = {}, group_id = nil, disable_logs = false)
         user_id_for_hash_value = user_id
         if group_id
-          user_id_for_hash_value = group_id.to_s + "_" + user_id
+          user_id_for_hash_value = "#{group_id}_#{user_id}"
         elsif campaign['isBucketingSeedEnabled']
-          user_id_for_hash_value = campaign['id'].to_s + "_" + user_id
+          user_id_for_hash_value = "#{campaign['id']}_#{user_id}"
         end
         hash_value = MurmurHash3::V32.str_hash(user_id_for_hash_value, SEED_VALUE) & U_MAX_32_BIT
         bucket_value = get_bucket_value(hash_value, MAX_TRAFFIC_PERCENT)
 
         @logger.log(
           LogLevelEnum::DEBUG,
-          format(
-            LogMessageEnum::DebugMessages::USER_HASH_BUCKET_VALUE,
-            file: FILE,
-            hash_value: hash_value,
-            bucket_value: bucket_value,
-            user_id: user_id
-          ),
+          'USER_HASH_BUCKET_VALUE',
+          {
+            '{file}' => FILE,
+            '{hashValue}' => hash_value,
+            '{userId}' => user_id,
+            '{bucketValue}' => bucket_value
+          },
           disable_logs
         )
         bucket_value
@@ -188,11 +192,9 @@ class VWO
       # @return[Hash|nil]
       #
       def get_campaign_using_range(range_for_campaigns, campaigns)
-        range_for_campaigns = range_for_campaigns * 100
+        range_for_campaigns *= 100
         campaigns.each do |campaign|
-          if campaign["max_range"] && campaign["max_range"] >= range_for_campaigns && campaign["min_range"] <= range_for_campaigns
-            return campaign
-          end
+          return campaign if campaign['max_range'] && campaign['max_range'] >= range_for_campaigns && campaign['min_range'] <= range_for_campaigns
         end
         nil
       end