vwo-fme-ruby-sdk 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a885f0996175388d1ad657e02b340d1a7adb40fba753175a26d0cdff815b6825
-  data.tar.gz: 79ab835a2f57e7c6a9b5a2a1f2f9d2d0fbd077975d9647aec9370f485bbf7c0b
+  metadata.gz: 45e767e6d560045ec2ded7455611fb246ea6a5fa5790f43fa2cff3752c7c6bac
+  data.tar.gz: 72411b218f6457da494c7e57e09864bb29eb79675953bfb63c057a8d615ae71d
 SHA512:
-  metadata.gz: 255ee85fb56815dbd0547e747c1f310c2977e403fe70c026eb44714bea40be95d31de92010c9255f65897dc87b8f931838185dfe89bc6bd6e6ad121de013c2c7
-  data.tar.gz: c05a40227ba1bf1b5b9da1f033f2892a0e2cca42f2d52478300479a3d4f0edac6b6489f024cfab2d5850357260f75970fb025e785609db257ca5f05541047cb4
+  metadata.gz: b6fc602254dfd56bef13c00f70c0a12dfb6735b33f3303aa4138c9dce24ca14255d665257f7c0673ff53e1cd0fb3553ebf984f9395b02bd018ec63372e696b2d
+  data.tar.gz: 5d9d10c85f9c06cf8ffca33251939f3bf29c9c0023c8902a5a943877643af013b96d1eaa2e285016d9a2af83c5953e98c70d870ae08e9c32bd36b030cb4137bf

data/lib/resources/error_messages.json

@@ -16,6 +16,7 @@
   
     "INVALID_PARAM": "Key:{key} passed to API:{apiName} is not of valid type. Got type:{type}, should be:{correctType}",
     "INVALID_CONTEXT": "Context should be an object and must contain a mandatory key - id, which is User ID",
+    "INVALID_BUCKETING_SEED": "bucketingSeed passed to API:{apiName} is invalid (got type:{type}). It must be a non-empty string. Falling back to userId for bucketing.",
   
     "FEATURE_NOT_FOUND": "Feature not found for the key:{featureKey}",
     "EVENT_NOT_FOUND": "Event:{eventName} not found in any of the features' metrics",

data/lib/vwo/api/get_flag.rb

@@ -122,7 +122,7 @@ class FlagApi
   
         if rollout_rules_to_evaluate.any?
           passed_rollout_campaign = CampaignModel.new.model_from_dictionary(rollout_rules_to_evaluate.first)
-          variation = DecisionUtil.evaluate_traffic_and_get_variation(settings, passed_rollout_campaign, context.get_id)
+          variation = DecisionUtil.evaluate_traffic_and_get_variation(settings, passed_rollout_campaign, context)
   
           if variation
             is_enabled = true
@@ -168,7 +168,7 @@ class FlagApi
   
         if experiment_rules_to_evaluate.any?
           campaign = CampaignModel.new.model_from_dictionary(experiment_rules_to_evaluate.first)
-          variation = DecisionUtil.evaluate_traffic_and_get_variation(settings, campaign, context.get_id)
+          variation = DecisionUtil.evaluate_traffic_and_get_variation(settings, campaign, context)
   
           if variation
             is_enabled = true

data/lib/vwo/constants/constants.rb

@@ -17,7 +17,7 @@
 # Define the Constants module
 module Constants
   SDK_NAME = 'vwo-fme-ruby-sdk'.freeze
-  SDK_VERSION = '1.10.0'.freeze
+  SDK_VERSION = '1.11.0'.freeze
 
   MAX_TRAFFIC_PERCENT = 100
   MAX_TRAFFIC_VALUE = 10_000

data/lib/vwo/models/user/context_model.rb

@@ -17,9 +17,9 @@ require_relative '../../utils/uuid_util'
 require_relative '../../services/settings_service'
 
 class ContextModel
-  attr_accessor :id, :user_agent, :ip_address, :custom_variables, :variation_targeting_variables, :post_segmentation_variables, :vwo, :session_id, :uuid
+  attr_accessor :id, :user_agent, :ip_address, :custom_variables, :variation_targeting_variables, :post_segmentation_variables, :vwo, :session_id, :uuid, :bucketing_seed
 
-  def initialize(id = nil, user_agent = nil, ip_address = nil, custom_variables = {}, variation_targeting_variables = {}, post_segmentation_variables = {}, vwo = nil, session_id = nil, uuid = nil)
+  def initialize(id = nil, user_agent = nil, ip_address = nil, custom_variables = {}, variation_targeting_variables = {}, post_segmentation_variables = {}, vwo = nil, session_id = nil, uuid = nil, bucketing_seed = nil)
     @id = id
     @user_agent = user_agent
     @ip_address = ip_address
@@ -29,6 +29,7 @@ class ContextModel
     @vwo = vwo
     @session_id = session_id
     @uuid = uuid
+    @bucketing_seed = bucketing_seed
   end
 
   # Creates a model instance from a hash (dictionary)
@@ -52,7 +53,8 @@ class ContextModel
     @variation_targeting_variables = context[:variationTargetingVariables] if context.key?(:variationTargetingVariables)
     @post_segmentation_variables = context[:postSegmentationVariables] if context.key?(:postSegmentationVariables)
     @vwo = ContextVWOModel.new.model_from_dictionary(context[:_vwo]) if context.key?(:_vwo)
-  
+    @bucketing_seed = context[:bucketingSeed].to_s if context.key?(:bucketingSeed)
+
     # check if sessionId is present in context and should be non null and non empty
     if context.key?(:sessionId) && !context[:sessionId].nil? && !context[:sessionId].to_s.empty?
       @session_id = context[:sessionId].to_i
@@ -141,4 +143,12 @@ class ContextModel
   def set_uuid(uuid)
     @uuid = uuid
   end
+
+  def get_bucketing_seed
+    @bucketing_seed
+  end
+
+  def set_bucketing_seed(bucketing_seed)
+    @bucketing_seed = bucketing_seed
+  end
 end

data/lib/vwo/services/campaign_decision_service.rb

@@ -30,20 +30,24 @@ class CampaignDecisionService
   # @param user_id [String] The ID of the user
   # @param campaign [CampaignModel] The campaign to check
   # @return [Boolean] True if the user is part of the campaign, false otherwise
-  def is_user_part_of_campaign(user_id, campaign)
-    return false if campaign.nil? || user_id.nil?
+  def is_user_part_of_campaign(context, campaign)
+    return false if campaign.nil? || context.nil?
+
+    user_id = context.get_id
+    bucketing_seed = context.get_bucketing_seed
+    bucketing_id = bucketing_seed || user_id
 
     is_rollout_or_personalize = [CampaignTypeEnum::ROLLOUT, CampaignTypeEnum::PERSONALIZE].include?(campaign.get_type)
     salt = is_rollout_or_personalize ? campaign.get_variations.first.get_salt : campaign.get_salt
     traffic_allocation = is_rollout_or_personalize ? campaign.get_variations.first.get_weight : campaign.get_traffic
 
-    bucket_key = salt ? "#{salt}_#{user_id}" : "#{campaign.get_id}_#{user_id}"
+    bucket_key = salt ? "#{salt}_#{bucketing_id}" : "#{campaign.get_id}_#{bucketing_id}"
     value_assigned_to_user = DecisionMaker.new.get_bucket_value_for_user(bucket_key)
 
     is_user_part = value_assigned_to_user != 0 && value_assigned_to_user <= traffic_allocation
 
     LoggerService.log(LogLevelEnum::INFO, "USER_PART_OF_CAMPAIGN", {
-      userId: user_id,
+      userId: bucketing_id != user_id ? "#{user_id} (Seed: #{bucketing_id})" : user_id,
       notPart: is_user_part ? '' : 'not',
       campaignKey: campaign.get_type == CampaignTypeEnum::AB ? campaign.get_key : "#{campaign.get_name}_#{campaign.get_rule_key}"
     })
@@ -72,19 +76,23 @@ class CampaignDecisionService
   # @param account_id [String] The ID of the account
   # @param campaign [CampaignModel] The campaign to bucket the user into
   # @return [VariationModel] The variation assigned to the user
-  def bucket_user_to_variation(user_id, account_id, campaign)
-    return nil if campaign.nil? || user_id.nil?
+  def bucket_user_to_variation(context, account_id, campaign)
+    return nil if campaign.nil? || context.nil?
+
+    user_id = context.get_id
+    bucketing_seed = context.get_bucketing_seed
+    bucketing_id = bucketing_seed || user_id
 
     multiplier = campaign.get_traffic ? 1 : nil
     percent_traffic = campaign.get_traffic
     salt = campaign.get_salt
-    bucket_key = salt ? "#{salt}_#{account_id}_#{user_id}" : "#{campaign.get_id}_#{account_id}_#{user_id}"
-    
+    bucket_key = salt ? "#{salt}_#{account_id}_#{bucketing_id}" : "#{campaign.get_id}_#{account_id}_#{bucketing_id}"
+
     hash_value = DecisionMaker.new.generate_hash_value(bucket_key)
     bucket_value = DecisionMaker.new.generate_bucket_value(hash_value, Constants::MAX_TRAFFIC_VALUE, multiplier)
 
     LoggerService.log(LogLevelEnum::DEBUG, "USER_BUCKET_TO_VARIATION", {
-      userId: user_id,
+      userId: bucketing_id != user_id ? "#{user_id} (Seed: #{bucketing_id})" : user_id,
       campaignKey: campaign.get_key,
       percentTraffic: percent_traffic,
       bucketValue: bucket_value,
@@ -139,13 +147,13 @@ class CampaignDecisionService
   # @param account_id [String] The ID of the account
   # @param campaign [CampaignModel] The campaign to evaluate
   # @return [VariationModel] The variation assigned to the user
-  def get_variation_alloted(user_id, account_id, campaign)
-    is_user_part = is_user_part_of_campaign(user_id, campaign)
+  def get_variation_alloted(context, account_id, campaign)
+    is_user_part = is_user_part_of_campaign(context, campaign)
 
     if [CampaignTypeEnum::ROLLOUT, CampaignTypeEnum::PERSONALIZE].include?(campaign.get_type)
       return campaign.get_variations.first if is_user_part
     else
-      return bucket_user_to_variation(user_id, account_id, campaign) if is_user_part
+      return bucket_user_to_variation(context, account_id, campaign) if is_user_part
     end
 
     nil

data/lib/vwo/utils/decision_util.rb

@@ -168,19 +168,25 @@ class DecisionUtil
   # @param settings [SettingsModel] The settings for the VWO instance
   # @param campaign [CampaignModel] The campaign to evaluate
   # @param user_id [String] The ID of the user
-  def self.evaluate_traffic_and_get_variation(settings, campaign, user_id)
-    variation = CampaignDecisionService.new.get_variation_alloted(user_id, settings.get_account_id, campaign)
+  def self.evaluate_traffic_and_get_variation(settings, campaign, context)
+    variation = CampaignDecisionService.new.get_variation_alloted(context, settings.get_account_id, campaign)
+
+    user_id = context.get_id
+    bucketing_seed = context.get_bucketing_seed
+    bucketing_id = bucketing_seed || user_id
+    display_user_id = bucketing_id != user_id ? "#{user_id} (Seed: #{bucketing_id})" : user_id
+
     if variation.nil?
       LoggerService.log(LogLevelEnum::INFO, "USER_CAMPAIGN_BUCKET_INFO", {
         campaignKey: campaign.get_type == CampaignTypeEnum::AB ? campaign.get_key : "#{campaign.get_name}_#{campaign.get_rule_key}",
-        userId: user_id,
+        userId: display_user_id,
         status: 'did not get any variation'
       })
       return nil
     end
     LoggerService.log(LogLevelEnum::INFO, "USER_CAMPAIGN_BUCKET_INFO", {
       campaignKey: campaign.get_type == CampaignTypeEnum::AB ? campaign.get_key : "#{campaign.get_name}_#{campaign.get_rule_key}",
-      userId: user_id,
+      userId: display_user_id,
       status: "got variation: #{variation.get_key}"
     })
     variation
@@ -236,7 +242,7 @@ class DecisionUtil
 
       whitelisted_variation = CampaignDecisionService.new.get_variation(
         targeted_variations,
-        DecisionMaker.new.calculate_bucket_value(CampaignUtil.get_bucketing_seed(context.get_id, campaign, nil))
+        DecisionMaker.new.calculate_bucket_value(CampaignUtil.get_bucketing_seed(context.get_bucketing_seed || context.get_id, campaign, nil))
       )
     else
       whitelisted_variation = targeted_variations.first

data/lib/vwo/utils/meg_util.rb

@@ -110,7 +110,7 @@ def is_rollout_rule_for_feature_passed(settings, feature, evaluated_feature_map,
 
     if rule_to_test_for_traffic
       campaign = CampaignModel.new.model_from_dictionary(rule_to_test_for_traffic)
-      variation = evaluate_traffic_and_get_variation(settings, campaign, context.id)
+      variation = evaluate_traffic_and_get_variation(settings, campaign, context)
       if variation.is_a?(VariationModel) && !variation.nil? && variation.id.is_a?(Integer)
         evaluated_feature_map[feature.key] = {
           rollout_id: rule_to_test_for_traffic.id,
@@ -160,7 +160,7 @@ def get_eligible_campaigns(settings, campaign_map, context, storage_service)
       end
 
       # Check if user is eligible for the campaign
-      if CampaignDecisionService.new.get_pre_segmentation_decision(campaign, context) && CampaignDecisionService.new.is_user_part_of_campaign(context.id, campaign)
+      if CampaignDecisionService.new.get_pre_segmentation_decision(campaign, context) && CampaignDecisionService.new.is_user_part_of_campaign(context, campaign)
         LoggerService.log(LogLevelEnum::INFO, "MEG_CAMPAIGN_ELIGIBLE", { campaignKey: campaign.key, userId: context.id })
 
         eligible_campaigns.push(campaign)
@@ -231,7 +231,7 @@ def normalize_weights_and_find_winning_campaign(shortlisted_campaigns, context,
 
   winner_campaign = CampaignDecisionService.new.get_variation(
     shortlisted_variations,
-    DecisionMaker.new.calculate_bucket_value(CampaignUtil.get_bucketing_seed(context.id, nil, group_id))
+    DecisionMaker.new.calculate_bucket_value(CampaignUtil.get_bucketing_seed(context.get_bucketing_seed || context.get_id, nil, group_id))
   )
 
   if winner_campaign
@@ -315,7 +315,7 @@ def get_campaign_using_advanced_algo(settings, shortlisted_campaigns, context, c
     CampaignUtil.set_campaign_allocation(participating_campaign_list)
     winner_campaign = CampaignDecisionService.new.get_variation(
       participating_campaign_list,
-      DecisionMaker.new.calculate_bucket_value(CampaignUtil.get_bucketing_seed(context.id, nil, group_id))
+      DecisionMaker.new.calculate_bucket_value(CampaignUtil.get_bucketing_seed(context.get_bucketing_seed || context.get_id, nil, group_id))
     )
   end
 

data/lib/vwo/vwo_client.rb

@@ -75,6 +75,15 @@ class VWOClient
       # add the uuid to the context copy
       context_copy[:uuid] = uuid
 
+      # Validate bucketingSeed: must be a non-empty, non-whitespace-only string
+      if context_copy.key?(:bucketingSeed)
+        seed = context_copy[:bucketingSeed]
+        if seed.nil? || seed.is_a?(Numeric) || seed.is_a?(Hash) || seed.is_a?(Array) || (seed.is_a?(String) && seed.strip.empty?)
+          LoggerService.log(LogLevelEnum::ERROR, "INVALID_BUCKETING_SEED", { apiName: api_name, type: seed.class.name })
+          context_copy.delete(:bucketingSeed)
+        end
+      end
+
       unless feature_key.is_a?(String) && !feature_key.empty?
         raise TypeError, 'feature_key should be a non-empty string'
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-03-06 00:00:00.000000000 Z
+date: 2026-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools