vwo-fme-ruby-sdk 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d45fa0809a1e1abfab41886fb30f9987d6e7910dc146d3f9c389d833870480c
-  data.tar.gz: af6be7b298827b5cfb5facac2b4227bdc74afc21d55da7d30b4652d57a708b4e
+  metadata.gz: f6cd54e4729aaae54bea625e05ebba1990f2a4295b3b04352cda862d06b92603
+  data.tar.gz: c1664141b090c9f2fea0c456a562daadc13ca66ab971fd2cb86c3af0e1c08574
 SHA512:
-  metadata.gz: e92a90c764fbdb5cba7417172079bc08480b71246028add35c098ef8700754b33bd736e3384444f7b3be2f36c0b2b2f93073a69b4622cbbd571b8d6530e6d237
-  data.tar.gz: 820f2d137b7506d3bdc4eb629c0d383d9d3e04ecb99cd99f47a473977ef0f4ca92bb23df3b0f23aceefee98964d97dc57a3244a32bc996f190f3e5abc4eee596
+  metadata.gz: 196e6e75933ee4670db874874a43428eb7b0abddeb5b8b013c513b410d1e539dc395a884a84ffcfe2d018127acb28933d26edf1305df9f8462991b7a52935853
+  data.tar.gz: 47bb55030326b0eac4694f2cffa50ab85063e08c88f27462b027e0d4327221b3dfb0b6f30f15d283484a1b11a4d0a2924e24a6ddde8b11b73b7fbb0b9390ef21

data/lib/resources/debug_messages.json

@@ -16,5 +16,6 @@
 
     "EVENT_BATCH_BEFORE_FLUSHING": "Flushing event queue {manually} having {length} events for Account ID:{accountId}. {timer}",
     "EVENT_BATCH_FLUSH": "Manually flushing batch events for Account ID:{accountId} having {queueLength} events",
-    "BATCH_QUEUE_EMPTY": "Batch queue is empty. Nothing to flush."
+    "BATCH_QUEUE_EMPTY": "Batch queue is empty. Nothing to flush.",
+    "WEB_UUID_FOUND": "VWO Web Testing identified UUID {uuid} as the Context ID for API {apiName}"
   }

data/lib/vwo/api/get_flag.rb

@@ -65,7 +65,7 @@ class FlagApi
     
             if variation
               LoggerService.log(LogLevelEnum::INFO, "STORED_VARIATION_FOUND", {variationKey: variation.get_key, userId: context.get_id, experimentKey: stored_data[:experiment_key], experimentType: "experiment"})
-              return GetFlagResponse.new(true, variation.get_variables)
+              return GetFlagResponse.new(true, variation.get_variables, context.get_uuid, context.get_session_id)
             end
           end
         elsif stored_data && stored_data[:rollout_key] && stored_data[:rollout_id]
@@ -91,7 +91,7 @@ class FlagApi
   
       if feature.nil?
         LoggerService.log(LogLevelEnum::ERROR, "FEATURE_NOT_FOUND", {featureKey: feature_key, an: ApiEnum::GET_FLAG, sId: context.get_session_id, uuid: context.get_uuid})
-        return GetFlagResponse.new(false, [])
+        return GetFlagResponse.new(false, [], context.get_uuid, context.get_session_id)
       end
   
       # Segmentation evaluation
@@ -219,7 +219,7 @@ class FlagApi
       end
   
       # Return final evaluated feature flag
-      return GetFlagResponse.new(is_enabled, experiment_variation_to_return&.get_variables || rollout_variation_to_return&.get_variables || [])
+      return GetFlagResponse.new(is_enabled, experiment_variation_to_return&.get_variables || rollout_variation_to_return&.get_variables || [], context.get_uuid, context.get_session_id)
     end
   
     private

data/lib/vwo/api/set_attribute.rb

@@ -40,11 +40,9 @@ class SetAttributeApi
 
     # Construct payload data for multiple attributes
     payload = NetworkUtil.get_attribute_payload_data(
-      context.id,
       EventEnum::VWO_SYNC_VISITOR_PROP,
       attributes,
-      context.user_agent,
-      context.ip_address
+      context
     )
 
     # check if batching is enabled

data/lib/vwo/api/track_event.rb

@@ -63,11 +63,9 @@ class TrackApi
 
     # Prepare the payload for the track goal
     payload = NetworkUtil.get_track_goal_payload_data(
-      context.id,
       event_name,
       event_properties,
-      context.user_agent,
-      context.ip_address
+      context
     )
 
     # check if batching is enabled

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.8.0'.freeze
+  SDK_VERSION = '1.9.0'.freeze
 
   MAX_TRAFFIC_PERCENT = 100
   MAX_TRAFFIC_VALUE = 10_000
@@ -31,6 +31,7 @@ module Constants
   MIN_EVENTS_PER_REQUEST = 1
 
   SEED_URL = 'https://vwo.com'.freeze  # Define SEED_URL
+  WEB_UUID_REGEX = /\A[DJ][0-9A-Fa-f]{32}\z/.freeze
   HTTP_PROTOCOL = 'http'.freeze
   HTTPS_PROTOCOL = 'https'.freeze
 

data/lib/vwo/models/settings/settings_model.rb

@@ -18,7 +18,7 @@ require_relative '../../constants/constants'
 
 class SettingsModel
   attr_reader :sdk_key, :account_id, :usage_stats_account_id, :version, :collection_prefix,
-              :features, :campaigns, :campaign_groups, :groups, :poll_interval
+              :features, :campaigns, :campaign_groups, :groups, :poll_interval, :is_web_connectivity_enabled
 
   def initialize(settings)
     @sdk_key = settings["sdkKey"]
@@ -31,6 +31,7 @@ class SettingsModel
     @campaigns = []
     @campaign_groups = settings["campaignGroups"] || {}
     @groups = settings["groups"] || {}
+    @is_web_connectivity_enabled = settings.fetch("isWebConnectivityEnabled", true)
 
     process_features(settings)
     process_campaigns(settings)
@@ -93,4 +94,8 @@ class SettingsModel
       @campaigns << CampaignModel.new.model_from_dictionary(campaign)
     end
   end
+
+  def get_is_web_connectivity_enabled
+    @is_web_connectivity_enabled
+  end
 end

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

@@ -53,9 +53,9 @@ class ContextModel
     @post_segmentation_variables = context[:postSegmentationVariables] if context.key?(:postSegmentationVariables)
     @vwo = ContextVWOModel.new.model_from_dictionary(context[:_vwo]) if context.key?(:_vwo)
   
-    # check if sessionId is present in context and should be non null and non empty string
-    if context.key?(:sessionId) && context[:sessionId].is_a?(String) && !context[:sessionId].empty?
-      @session_id = context[:sessionId]
+    # 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
     else
       @session_id = Time.now.to_i
     end

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

@@ -13,26 +13,38 @@
 # limitations under the License.
 
 class GetFlagResponse
-    attr_reader :is_enabled, :get_variables, :get_variable
+  attr_reader :is_enabled, :get_variables, :get_variable, :get_uuid, :get_session_id
   
-    def initialize(is_enabled, variables = [])
-      @is_enabled = is_enabled
-      @variables = variables
-    end
+  def initialize(is_enabled, variables = [], uuid = nil, session_id = nil)
+    @is_enabled = is_enabled
+    @variables = variables
+    @uuid = uuid
+    @session_id = session_id
+  end
   
-    # Define method for is_enabled
-    def is_enabled
-      @is_enabled
-    end
-  
-    # Define method for get_variables
-    def get_variables
-      @variables
-    end
-  
-    # Define method for get_variable
-    def get_variable(key, default_value = nil)
-        variable = @variables.find { |var| var.key == key }
-        variable ? variable.value : default_value
-    end
-  end
+  # Define method for is_enabled
+  def is_enabled
+    @is_enabled
+  end
+
+  # Define method for get_variables
+  def get_variables
+    @variables
+  end
+
+  # Define method for get_variable
+  def get_variable(key, default_value = nil)
+      variable = @variables.find { |var| var.key == key }
+      variable ? variable.value : default_value
+  end
+
+  # Define method for get_uuid
+  def get_uuid
+    @uuid
+  end
+
+  # Define method for get_session_id
+  def get_session_id
+    @session_id
+  end
+end

data/lib/vwo/utils/network_util.rb

@@ -157,6 +157,17 @@ class NetworkUtil
 
         properties = _get_event_base_payload(user_id, event_name, visitor_user_agent, ip_address)
 
+        # use sessionId from context if present
+        if context.get_session_id
+            properties[:d][:sessionId] = context.get_session_id
+        end
+
+        # use uuid from context if present
+        if context.get_uuid && !context.get_uuid.empty?
+            properties[:d][:visId] = context.get_uuid
+            properties[:d][:msgId] = "#{context.get_uuid}-#{get_current_unix_timestamp_in_millis}"
+        end
+
         properties[:d][:event][:props][:id] = campaign_id
         properties[:d][:event][:props][:variation] = variation_id
         properties[:d][:event][:props][:isFirst] = 1
@@ -191,10 +202,21 @@ class NetworkUtil
     end
 
     # Constructs payload for tracking goals with custom event properties
-    def get_track_goal_payload_data(user_id, event_name, event_properties, visitor_user_agent = '', ip_address = '')
-        properties = _get_event_base_payload(user_id, event_name, visitor_user_agent, ip_address)
+    def get_track_goal_payload_data(event_name, event_properties, context)
+        properties = _get_event_base_payload(context.id, event_name, context.user_agent, context.ip_address)
         properties[:d][:event][:props][:isCustomEvent] = true
 
+        # use sessionId from context if present
+        if context.get_session_id
+            properties[:d][:sessionId] = context.get_session_id
+        end
+
+        # use uuid from context if present
+        if context.get_uuid && !context.get_uuid.empty?
+            properties[:d][:visId] = context.get_uuid
+            properties[:d][:msgId] = "#{context.get_uuid}-#{get_current_unix_timestamp_in_millis}"
+        end
+
         if SettingsService.instance.is_gateway_service_provided
             properties[:d][:event][:props][:variation] = 1
             properties[:d][:event][:props][:id] = 1  # Temporary value for ID
@@ -207,16 +229,27 @@ class NetworkUtil
         LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_TRACK_GOAL", {
             eventName: event_name,
             accountId: SettingsService.instance.account_id,
-            userId: user_id
+            userId: context.id
         })
 
         properties
     end
 
-    def get_attribute_payload_data(user_id, event_name, event_properties, visitor_user_agent = '', ip_address = '')
-        properties = _get_event_base_payload(user_id, event_name, visitor_user_agent, ip_address)
+    def get_attribute_payload_data(event_name, event_properties, context)
+        properties = _get_event_base_payload(context.id, event_name, context.user_agent, context.ip_address)
         properties[:d][:event][:props][:isCustomEvent] = true
 
+        # use sessionId from context if present
+        if context.get_session_id
+            properties[:d][:sessionId] = context.get_session_id
+        end
+
+        # use uuid from context if present
+        if context.get_uuid && !context.get_uuid.empty?
+            properties[:d][:visId] = context.get_uuid
+            properties[:d][:msgId] = "#{context.get_uuid}-#{get_current_unix_timestamp_in_millis}"
+        end
+
         if event_properties.is_a?(Hash) && !event_properties.empty?
             event_properties.each { |key, value| properties[:d][:visitor][:props][key] = value }
         end
@@ -224,7 +257,7 @@ class NetworkUtil
         LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_SYNC_VISITOR_PROP", {
             eventName: event_name,
             accountId: SettingsService.instance.account_id,
-            userId: user_id
+            userId: context.id
         })
         properties
     end

data/lib/vwo/utils/uuid_util.rb

@@ -14,8 +14,7 @@
 
 require 'uuidtools'
 require 'securerandom'
-
-SEED_URL = 'https://vwo.com' # Replace with actual SEED_URL
+require_relative '../constants/constants'
 
 class UUIDUtil
   # Generates a random UUID based on an API key.
@@ -34,7 +33,7 @@ class UUIDUtil
   # @param account_id [String] The account ID associated with the user.
   # @return [String] A UUID string formatted without dashes and in uppercase.
   def self.get_uuid(user_id, account_id)
-    vwo_namespace = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, SEED_URL)
+    vwo_namespace = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, Constants::SEED_URL)
     user_id_namespace = generate_uuid(account_id, vwo_namespace)
     uuid_for_user_id_account_id = generate_uuid(user_id, user_id_namespace)
 
@@ -52,4 +51,46 @@ class UUIDUtil
     name_str = name.to_s
     UUIDTools::UUID.sha1_create(namespace, name_str)
   end
+
+  # Checks if the given ID is a valid Web UUID.
+  #
+  # @param id [String] The ID to check.
+  # @return [Boolean] True if the ID is a valid Web UUID, false otherwise.
+  def self.web_uuid?(id)
+    return false unless id.is_a?(String)
+
+    !!(id =~ Constants::WEB_UUID_REGEX)
+  end
+
+  # Generates a UUID for a user based on their user_id and account_id.
+  #
+  # @param settings [SettingsModel] The settings of the VWO client.
+  # @param context [Hash] The context of the user.
+  # @param api_name [String] The name of the API called.
+  # @return [String] A UUID string formatted without dashes and in uppercase.
+  def self.get_uuid_from_context(settings, context, api_name)
+    if settings.get_is_web_connectivity_enabled != false
+      # if web connectivity is enabled, check if context[:id] is a valid web UUID
+      if context && web_uuid?(context[:id])
+        # if context[:id] is a valid web UUID, set it as uuid
+        LoggerService.log(LogLevelEnum::DEBUG, "WEB_UUID_FOUND", {apiName: api_name, uuid: context[:id]})
+        return context[:id]
+      else
+        # if context[:useIdForWeb] is true and context[:id] is not a valid web UUID, throw error
+        if context && context[:useIdForWeb] == true
+          raise StandardError, 'UUID passed in context.id is not a valid UUID'
+        end
+        return get_uuid(
+          context[:id].to_s,
+          SettingsService.instance.account_id.to_s
+        )
+      end
+    else
+      # if web connectivity is disabled, fallback to server-side UUID derivation
+      return get_uuid(
+        context[:id].to_s,
+        SettingsService.instance.account_id.to_s
+      )
+    end
+  end
 end

data/lib/vwo/vwo_client.rb

@@ -24,6 +24,7 @@ require_relative 'utils/network_util'
 require_relative 'models/schemas/settings_schema_validation'
 require_relative 'services/batch_event_queue'
 require_relative 'enums/api_enum'
+require_relative 'utils/uuid_util'
 
 class VWOClient
   attr_accessor :settings, :original_settings
@@ -49,11 +50,30 @@ class VWOClient
   # @return [GetFlagResponse] The flag for the given feature key and context
   def get_flag(feature_key, context)
     api_name = 'get_flag'
-    error_response = GetFlagResponse.new(false, [])
+    uuid = nil
+    session_id = nil
+
+    # check if sessionId is present in context and should be non null and non empty
+    if context.is_a?(Hash) && context.key?(:sessionId) && !context[:sessionId].nil? && !context[:sessionId].to_s.empty?
+      session_id = context[:sessionId].to_i
+    else
+      session_id = Time.now.to_i
+    end
   
     begin
       hooks_service = HooksService.new(@options)
       LoggerService.log(LogLevelEnum::DEBUG, "API_CALLED", {apiName: api_name})
+      unless context.is_a?(Hash)
+        raise TypeError, 'Invalid context'
+      end
+      unless context[:id].is_a?(String) && !context[:id].empty?
+        raise TypeError, 'Invalid context, id should be a non-empty string'
+      end
+      # make a copy of the context to avoid modifying the original context
+      context_copy = context.dup
+      uuid = UUIDUtil.get_uuid_from_context(@settings, context_copy, api_name)
+      # add the uuid to the context copy
+      context_copy[:uuid] = uuid
 
       unless feature_key.is_a?(String) && !feature_key.empty?
         raise TypeError, 'feature_key should be a non-empty string'
@@ -61,18 +81,12 @@ class VWOClient
       unless SettingsService.instance.is_settings_valid
         raise TypeError, 'Invalid Settings'
       end
-      unless context.is_a?(Hash)
-        raise TypeError, 'Invalid context'
-      end
-      unless context[:id].is_a?(String) && !context[:id].empty?
-        raise TypeError, 'Invalid context, id should be a non-empty string'
-      end
       
-      context_model = ContextModel.new.model_from_dictionary(context)
+      context_model = ContextModel.new.model_from_dictionary(context_copy)
       FlagApi.new.get(feature_key, @settings, context_model, hooks_service)
     rescue StandardError => e
       LoggerService.log(LogLevelEnum::ERROR, "EXECUTION_FAILED", {apiName: api_name, err: e.message, an: ApiEnum::GET_FLAG})
-      error_response
+      GetFlagResponse.new(false, [], uuid, session_id)
     end
   end
 
@@ -87,7 +101,14 @@ class VWOClient
     begin
       hooks_service = HooksService.new(@options)
       LoggerService.log(LogLevelEnum::DEBUG, "API_CALLED", {apiName: api_name})
-      
+
+      unless context.is_a?(Hash) && context[:id].is_a?(String) && !context[:id].empty?
+        raise TypeError, 'Invalid context, id should be a non-empty string'
+      end
+      # make a copy of the context to avoid modifying the original context
+      context_copy = context.dup
+      context_copy[:uuid] = UUIDUtil.get_uuid_from_context(@settings, context_copy, api_name)
+
       unless event_name.is_a?(String) && !event_name.empty?
         raise TypeError, 'event_name should be a non-empty string'
       end
@@ -97,11 +118,8 @@ class VWOClient
       unless SettingsService.instance.is_settings_valid
         raise TypeError, 'Invalid Settings'
       end
-      unless context[:id].is_a?(String) && !context[:id].empty?
-        raise TypeError, 'Invalid context, id should be a non-empty string'
-      end
       
-      context_model = ContextModel.new.model_from_dictionary(context)
+      context_model = ContextModel.new.model_from_dictionary(context_copy)
       TrackApi.new.track(@settings, event_name, context_model, event_properties, hooks_service)
     rescue StandardError => e
       LoggerService.log(LogLevelEnum::ERROR, "EXECUTION_FAILED", {apiName: api_name, err: e.message, an: ApiEnum::TRACK_EVENT})
@@ -118,21 +136,24 @@ class VWOClient
     
     begin
       LoggerService.log(LogLevelEnum::DEBUG, "API_CALLED", {apiName: api_name})
-
-      unless attributes.is_a?(Hash) && !attributes.empty?
-        raise TypeError, 'Attributes should be a hash with key-value pairs and non-empty'
-      end
       unless context.is_a?(Hash)
         raise TypeError, 'Invalid context'
       end
       unless context[:id].is_a?(String) && !context[:id].empty?
         raise TypeError, 'Invalid context, id should be a non-empty string'
       end
+      # make a copy of the context to avoid modifying the original context
+      context_copy = context.dup
+      context_copy[:uuid] = UUIDUtil.get_uuid_from_context(@settings, context_copy, api_name)
+
+      unless attributes.is_a?(Hash) && !attributes.empty?
+        raise TypeError, 'Attributes should be a hash with key-value pairs and non-empty'
+      end
       unless SettingsService.instance.is_settings_valid
         raise TypeError, 'Invalid Settings'
       end
       
-      context_model = ContextModel.new.model_from_dictionary(context)
+      context_model = ContextModel.new.model_from_dictionary(context_copy)
       SetAttributeApi.new.set_attribute(attributes, context_model)
     rescue StandardError => e
       LoggerService.log(LogLevelEnum::ERROR, "EXECUTION_FAILED", {apiName: api_name, err: e.message, an: ApiEnum::SET_ATTRIBUTE})

data/lib/vwo.rb

@@ -106,4 +106,20 @@ class VWO
       puts "[ERROR]: VWO-SDK: Got error while initializing VWO: #{e.message}"
     end
   end
+
+  # Generates a UUID for a user based on their user_id and account_id.
+  #
+  # @param user_id [String] The user's ID.
+  # @param account_id [String] The account ID associated with the user.
+  # @return [String] A UUID string formatted without dashes and in uppercase.
+  def self.get_uuid(user_id, account_id)
+    # check if user_id and account_id are non-empty strings
+    if !user_id.is_a?(String) || user_id.empty? || !account_id.is_a?(String) || account_id.empty?
+      puts "User ID and account ID must be non-empty strings"
+      return nil
+    end
+    
+    # generate and return a new uuid based on user_id and account_id
+    return UUIDUtil.get_uuid(user_id, account_id)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-01-21 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools