vwo-fme-ruby-sdk 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ef28eb680c91f4a2009e0fdff9053a4c2f82cfacbe2b09c5a3359b469a104a
-  data.tar.gz: a5aeb2e3856e53a62f8c52ff1da83c7396260f50087441f2537b94319459013f
+  metadata.gz: 070ef4b08bf92bddf7d91a7a520a570651ed5c79c2d792a73021889803589f46
+  data.tar.gz: 5a6bb42880b3d4e73da654d33c78e05566bd487c15205918bef6020447793454
 SHA512:
-  metadata.gz: 216b54b6567c982b2c6392c1bb52a940cb0eb083604f7bcc8040e1017acf06a8da1438a665706b9e0f618e57ccbc7146f8a59cda2bce8eba6c8fb7fbcb05af96
-  data.tar.gz: 5ed4c55969fe455f57b946b67314382a2f50534fdc4e62948a54b88ed0a81bb9c94b5c0abe01b24c255bb2f15c449893545865a3a4ad8e8b7467ffd5d43e24bc
+  metadata.gz: 5f48860c62dd6c81743ee2647fe7144ba503bff54fc68f4ddb8619bde4ff698b13ba46db401f1ea40abffd30b4909b8ca0a42af628b9b2b71670eef15f54b215
+  data.tar.gz: dd3eaf38a66d744dd3e9f0b553e707610ae1b130980b1359eca5b9ae9ee70f063cfe4dd3a1c43a397676d52a2289e3770638ab1b076cdfc769b5bc72f5bb3f63

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.4.0'.freeze
+  SDK_VERSION = '1.5.0'.freeze
 
   MAX_TRAFFIC_PERCENT = 100
   MAX_TRAFFIC_VALUE = 10_000

data/lib/vwo/enums/event_enum.rb

@@ -15,6 +15,7 @@
 # Event types
 module EventEnum
     VWO_VARIATION_SHOWN = 'vwo_variationShown'
-    VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp',
+    VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp'
     VWO_INIT_CALLED = 'vwo_fmeSdkInit'
-  end
+    VWO_USAGE_STATS = 'vwo_sdkUsageStats'
+end

data/lib/vwo/models/schemas/settings_schema_validation.rb

@@ -84,6 +84,7 @@ class SettingsSchema
       optional(:sdkKey).maybe(:string)
       required(:version).filled(:integer)
       required(:accountId).filled(:integer)
+      optional(:usageStatsAccountId).maybe(:integer)
       optional(:features).array(:hash)
       required(:campaigns).array(:hash)
       optional(:groups).maybe(:hash)

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

@@ -17,12 +17,13 @@ require_relative '../campaign/feature_model'
 require_relative '../../constants/constants'
 
 class SettingsModel
-  attr_reader :sdk_key, :account_id, :version, :collection_prefix,
+  attr_reader :sdk_key, :account_id, :usage_stats_account_id, :version, :collection_prefix,
               :features, :campaigns, :campaign_groups, :groups, :poll_interval
 
   def initialize(settings)
     @sdk_key = settings["sdkKey"]
     @account_id = settings["accountId"]
+    @usage_stats_account_id = settings["usageStatsAccountId"]
     @version = settings["version"]
     @collection_prefix = settings["collectionPrefix"]
     @poll_interval = settings["pollInterval"] || Constants::POLLING_INTERVAL
@@ -59,6 +60,10 @@ class SettingsModel
     @account_id
   end
 
+  def get_usage_stats_account_id
+    @usage_stats_account_id
+  end
+
   def get_version
     @version
   end

data/lib/vwo/utils/event_util.rb

@@ -33,4 +33,17 @@ def send_sdk_init_event(settings_fetch_time, sdk_init_time)
     # Send the constructed payload via POST request
     NetworkUtil.send_event(properties, payload)
   end
+end
+
+# Sends a usage stats event to VWO.
+# @param usage_stats_account_id - The account id for usage stats.
+def send_sdk_usage_stats_event(usage_stats_account_id)
+  # create query parameters
+  properties = NetworkUtil.get_events_base_properties(EventEnum::VWO_USAGE_STATS, nil, nil, true, usage_stats_account_id)
+
+  # create payload
+  payload = NetworkUtil.get_sdk_usage_stats_payload_data(EventEnum::VWO_USAGE_STATS, usage_stats_account_id)
+
+  # send event
+  NetworkUtil.send_event(properties, payload)
 end

data/lib/vwo/utils/network_util.rb

@@ -32,7 +32,7 @@ class NetworkUtil
     # @return [String] URL-encoded query string
     def convert_params_to_string(params)
       return '' if params.nil? || params.empty?
-      
+
       '?' + params.map do |key, value|
         "#{URI.encode_www_form_component(key.to_s)}=#{URI.encode_www_form_component(value.to_s)}"
       end.join('&')
@@ -80,47 +80,69 @@ class NetworkUtil
     end
 
     # Builds generic properties for different tracking calls
-    def get_events_base_properties(event_name, visitor_user_agent = '', ip_address = '')
-        sdk_key = SettingsService.instance.sdk_key || ''
-        {
-        en: event_name,
-        a: SettingsService.instance.account_id,
-        env: sdk_key,
-        eTime: get_current_unix_timestamp_in_millis,
-        random: get_random_number,
-        p: 'FS',
-        visitor_ua: visitor_user_agent || '',
-        visitor_ip: ip_address || '',
-        url: "#{UrlUtil.get_base_url}#{UrlEnum::EVENTS}"
+    def get_events_base_properties(event_name, visitor_user_agent = '', ip_address = '', is_usage_stats_event = false, usage_stat_account_id = '')
+        properties = {
+            en: event_name,
+            a: SettingsService.instance.account_id,
+            eTime: get_current_unix_timestamp_in_millis,
+            random: get_random_number,
+            p: 'FS',
+            visitor_ua: visitor_user_agent || '',
+            visitor_ip: ip_address || '',
+            url: "#{UrlUtil.get_base_url}#{UrlEnum::EVENTS}"
         }
+
+        if !is_usage_stats_event
+            # set env key for standard sdk events
+            properties[:env] = SettingsService.instance.sdk_key
+        else
+            # set env key for usage stats events
+            properties[:a] = usage_stat_account_id
+        end
+
+        properties
     end
 
     # Builds base payload for tracking events
-    def _get_event_base_payload(user_id, event_name, visitor_user_agent = '', ip_address = '')
-        uuid = UUIDUtil.get_uuid(user_id.to_s, SettingsService.instance.account_id)
+    def _get_event_base_payload(user_id, event_name, visitor_user_agent = '', ip_address = '', is_usage_stats_event = false, usage_stat_account_id = '')
+        account_id = SettingsService.instance.account_id
+
+        if is_usage_stats_event
+            account_id = usage_stat_account_id
+        end
+
+        uuid = UUIDUtil.get_uuid(user_id.to_s, account_id.to_s)
         sdk_key = SettingsService.instance.sdk_key
 
-        {
-        d: {
-            msgId: "#{uuid}-#{get_current_unix_timestamp_in_millis}",
-            visId: uuid,
-            sessionId: get_current_unix_timestamp,
-            event: {
-            props: {
-                vwo_sdkName: Constants::SDK_NAME,
-                vwo_sdkVersion: Constants::SDK_VERSION,
-                vwo_envKey: sdk_key
-            },
-            name: event_name,
-            time: get_current_unix_timestamp_in_millis
-            },
-            visitor: {
-            props: {
-                vwo_fs_environment: sdk_key
-            }
+        payload = {
+            d: {
+                msgId: "#{uuid}-#{get_current_unix_timestamp_in_millis}",
+                visId: uuid,
+                sessionId: get_current_unix_timestamp,
+                event: {
+                    props: {
+                        vwo_sdkName: Constants::SDK_NAME,
+                        vwo_sdkVersion: Constants::SDK_VERSION,
+                    },
+                    name: event_name,
+                    time: get_current_unix_timestamp_in_millis
+                }
             }
         }
-        }
+
+        if !is_usage_stats_event
+            # set env key for standard sdk events
+            payload[:d][:event][:props][:vwo_envKey] = sdk_key
+
+            # set visitor props for standard sdk events
+            payload[:d][:visitor] = {
+                props: {
+                    vwo_fs_environment: sdk_key
+                }
+            }
+        end
+
+        payload
     end
 
     # Builds track-user payload data
@@ -134,18 +156,12 @@ class NetworkUtil
         properties[:d][:visitor_ua] = visitor_user_agent if visitor_user_agent && !visitor_user_agent.empty?
         properties[:d][:visitor_ip] = ip_address if ip_address && !ip_address.empty?
 
-        # check if usage stats size is greater than 0
-        usage_stats = UsageStatsUtil.get_usage_stats
-        if usage_stats.size > 0
-            properties[:d][:event][:props][:vwoMeta] = usage_stats
-        end
-        
         LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_TRACK_USER", {
             accountId: SettingsService.instance.account_id,
             userId: user_id,
             campaignId: campaign_id
         })
-        
+
         properties
     end
 
@@ -158,17 +174,17 @@ class NetworkUtil
             properties[:d][:event][:props][:variation] = 1
             properties[:d][:event][:props][:id] = 1  # Temporary value for ID
         end
-        
+
         if event_properties.is_a?(Hash) && !event_properties.empty?
         event_properties.each { |key, value| properties[:d][:event][:props][key] = value }
         end
-        
+
         LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_TRACK_GOAL", {
             eventName: event_name,
             accountId: SettingsService.instance.account_id,
             userId: user_id
         })
-        
+
         properties
     end
 
@@ -194,7 +210,7 @@ class NetworkUtil
     # @param sdk_init_time - Time taken to initialize the SDK in milliseconds.
     # @returns The constructed payload with required fields.
     def get_sdk_init_event_payload(event_name, settings_fetch_time, sdk_init_time)
-        user_id = SettingsService.instance.account_id + "_" + SettingsService.instance.sdk_key
+        user_id = SettingsService.instance.account_id.to_s + "_" + SettingsService.instance.sdk_key
         properties = _get_event_base_payload(user_id, event_name, nil, nil)
         properties[:d][:event][:props][:vwo_fs_environment] = SettingsService.instance.sdk_key
         properties[:d][:event][:props][:product] = Constants::PRODUCT_NAME
@@ -207,6 +223,18 @@ class NetworkUtil
         properties
     end
 
+    # Constructs the payload for usage stats called event.
+    # @param event_name - The name of the event.
+    # @param usage_stats_account_id - The account id for usage stats.
+    # @returns The constructed payload with required fields.
+    def get_sdk_usage_stats_payload_data(event_name, usage_stats_account_id)
+        user_id = SettingsService.instance.account_id.to_s + "_" + SettingsService.instance.sdk_key
+        properties = _get_event_base_payload(user_id, event_name, nil, nil, true, usage_stats_account_id)
+        properties[:d][:event][:props][:product] = Constants::PRODUCT_NAME
+        properties[:d][:event][:props][:vwoMeta] = UsageStatsUtil.get_usage_stats
+        properties
+    end
+
     # Sends a POST API request with given properties and payload
     def send_post_api_request(properties, payload)
         network_instance = NetworkManager.instance
@@ -225,20 +253,14 @@ class NetworkUtil
         SettingsService.instance.port
         )
 
-        begin 
+        begin
             if network_instance.get_client.get_should_use_threading
                 network_instance.get_client.get_thread_pool.post {
                     response = network_instance.post(request)
-                    if response.get_status_code == 200
-                        UsageStatsUtil.clear_usage_stats
-                    end
                     response
                 }
             else
                 response = network_instance.post(request)
-                if response.get_status_code == 200
-                    UsageStatsUtil.clear_usage_stats
-                end
                 response
             end
         rescue ResponseModel => err
@@ -259,18 +281,23 @@ class NetworkUtil
         headers[HeadersEnum::USER_AGENT] = payload[:d][:visitor_ua] if payload[:d][:visitor_ua]
         headers[HeadersEnum::IP] = payload[:d][:visitor_ip] if payload[:d][:visitor_ip]
 
+        url = Constants::HOST_NAME
+        if UrlUtil.get_collection_prefix && !UrlUtil.get_collection_prefix.empty?
+            url = "#{url}/#{UrlUtil.get_collection_prefix}"
+        end
+
         request = RequestModel.new(
-            UrlUtil.get_base_url,
+            url,
             HttpMethodEnum::POST,
             UrlEnum::EVENTS,
             properties,
             payload,
             headers,
-            SettingsService.instance.protocol,
-            SettingsService.instance.port
+            Constants::HTTPS_PROTOCOL,
+            nil
         )
 
-        begin 
+        begin
             if network_instance.get_client.get_should_use_threading
                 network_instance.get_client.get_thread_pool.post {
                     response = network_instance.post(request)
@@ -287,7 +314,7 @@ class NetworkUtil
     # Sends a GET API request to the specified endpoint with given properties
     def send_get_api_request(properties, endpoint)
         network_instance = NetworkManager.instance
-        
+
         request = RequestModel.new(
         UrlUtil.get_base_url,
         HttpMethodEnum::GET,
@@ -298,7 +325,7 @@ class NetworkUtil
         SettingsService.Instance.protocol,
         SettingsService.Instance.port
         )
-        
+
         begin
             network_instance.get(request)
         rescue StandardError => err
@@ -309,4 +336,4 @@ class NetworkUtil
         end
     end
   end
-end
+end

data/lib/vwo/utils/url_util.rb

@@ -42,5 +42,12 @@ class UrlUtil
 
       base_url
     end
+
+    # Retrieves the collection prefix.
+    #
+    # @return [String] The collection prefix.
+    def get_collection_prefix
+      @collection_prefix
+    end
   end
 end

data/lib/vwo/utils/usage_stats_util.rb

@@ -69,6 +69,8 @@ class UsageStatsUtil
 
     data = {}
 
+    data[:a] = SettingsService.instance.account_id
+    data[:env] = SettingsService.instance.sdk_key
     data[:ig] = 1 if integrations
     data[:eb] = 1 if event_batching
     data[:gs] = 1 if gateway_service
@@ -84,7 +86,7 @@ class UsageStatsUtil
       data[:ll] = LogLevelToNumber.to_number(logger[:level]) || -1
     end
 
-    data[:pi] = 1 if poll_interval
+    data[:pi] = poll_interval if poll_interval
 
     if vwo_meta && vwo_meta.key?(:ea)
       data[:_ea] = 1

data/lib/vwo.rb

@@ -93,6 +93,14 @@ class VWO
         # send the sdk init info to vwo server
         send_sdk_init_event(SettingsService.instance.settings_fetch_time, time_taken_for_init.to_s)
       end
+
+      # send the usage stats event to vwo server
+      # get usage stats account id from settings
+      usage_stats_account_id = @@instance.original_settings["usageStatsAccountId"]
+      if usage_stats_account_id
+        send_sdk_usage_stats_event(usage_stats_account_id)
+      end
+
       @@instance
     rescue StandardError => e
       puts "[ERROR]: VWO-SDK: Got error while initializing VWO: #{e.message}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-08-07 00:00:00.000000000 Z
+date: 2025-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools