vwo-fme-ruby-sdk 1.2.0 → 1.3.1

data/lib/vwo/utils/impression_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@ require_relative '../models/settings/settings_model'
 require_relative './network_util'
 require_relative '../models/user/context_model'
 require_relative '../enums/event_enum'
-
+require_relative '../services/batch_event_queue'
 # Creates and sends an impression for a variation shown event.
 # This function constructs the necessary properties and payload for the event
 # and uses the NetworkUtil to send a POST API request.
@@ -45,5 +45,12 @@ def create_and_send_impression_for_variation_shown(settings, campaign_id, variat
     context.get_ip_address
   )
 
-  NetworkUtil.send_post_api_request(properties, payload)
+  # check if batching is enabled
+  if BatchEventsQueue.instance
+    # add the payload to the batch events queue
+    BatchEventsQueue.instance.enqueue(payload)
+  else
+    # Send the constructed payload via POST request
+    NetworkUtil.send_post_api_request(properties, payload)
+  end
 end

data/lib/vwo/utils/log_message_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/vwo/utils/meg_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/vwo/utils/network_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@ require_relative '../packages/network_layer/models/request_model'
 require_relative '../packages/network_layer/models/response_model'
 require_relative '../utils/url_util'
 require_relative '../utils/uuid_util'
+require_relative '../utils/usage_stats_util'
 
 class NetworkUtil
   class << self
@@ -104,8 +105,6 @@ class NetworkUtil
             msgId: "#{uuid}-#{get_current_unix_timestamp_in_millis}",
             visId: uuid,
             sessionId: get_current_unix_timestamp,
-            visitor_ua: visitor_user_agent,
-            visitor_ip: ip_address,
             event: {
             props: {
                 vwo_sdkName: Constants::SDK_NAME,
@@ -130,6 +129,16 @@ class NetworkUtil
         properties[:d][:event][:props][:id] = campaign_id
         properties[:d][:event][:props][:variation] = variation_id
         properties[:d][:event][:props][:isFirst] = 1
+
+        # Only add visitor_ua and visitor_ip if they are non-null
+        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: settings.account_id,
@@ -196,9 +205,23 @@ class NetworkUtil
         SettingsService.instance.protocol,
         SettingsService.instance.port
         )
-        
-        begin
-            network_instance.post(request)
+
+        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
             LoggerService.log(LogLevelEnum::ERROR, "NETWORK_CALL_FAILED", {
                 method: HttpMethodEnum::POST,
@@ -224,7 +247,7 @@ class NetworkUtil
         
         begin
             network_instance.get(request)
-        rescue ResponseModel => err
+        rescue StandardError => err
             LoggerService.log(LogLevelEnum::ERROR, "NETWORK_CALL_FAILED", {
                 method: HttpMethodEnum::GET,
                 err: err.is_a?(Hash) ? err.to_json : err
@@ -232,4 +255,4 @@ class NetworkUtil
         end
     end
   end
-end
+end

data/lib/vwo/utils/rule_evaluation_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/vwo/utils/settings_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/vwo/utils/url_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/vwo/utils/usage_stats_util.rb

@@ -0,0 +1,117 @@
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require_relative '../constants/constants'
+require_relative '../enums/log_level_to_number'
+
+# Manages usage statistics for the SDK.
+# Tracks various features and configurations being used by the client.
+# Implements Singleton pattern to ensure a single instance.
+class UsageStatsUtil
+  @instance = nil
+  @usage_stats_data = {}
+
+  class << self
+    # Provides access to the singleton instance of UsageStatsUtil.
+    #
+    # @return [UsageStatsUtil] The single instance of UsageStatsUtil
+    def instance
+      @instance ||= new
+    end
+
+    # Sets usage statistics based on provided options.
+    # Maps various SDK features and configurations to boolean flags.
+    #
+    # @param options [Hash] Configuration options for the SDK
+    def set_usage_stats(options)
+      instance.set_usage_stats(options)
+    end
+
+    # Retrieves the current usage statistics.
+    #
+    # @return [Hash] Record containing boolean flags for various SDK features in use
+    def get_usage_stats
+      instance.get_usage_stats
+    end
+
+    def clear_usage_stats
+      instance.clear_usage_stats
+    end
+  end
+
+  private_class_method :new
+
+  def initialize
+    @usage_stats_data = {}
+  end
+
+  def set_usage_stats(options)
+    storage = options[:storage]
+    logger = options[:logger]
+    event_batching = options[:batch_event_data]
+    integrations = options[:integrations]
+    poll_interval = options[:poll_interval]
+    vwo_meta = options[:_vwo_meta]
+    gateway_service = options[:gateway_service]
+    threading = options[:threading]
+
+    data = {}
+
+    data[:ig] = 1 if integrations
+    data[:eb] = 1 if event_batching
+    data[:gs] = 1 if gateway_service
+
+    # if logger has transport or transports, then it is custom logger
+    if logger && (logger.key?(:transport) || logger.key?(:transports))
+      data[:cl] = 1
+    end
+
+    data[:ss] = 1 if storage
+
+    if logger && logger.key?(:level)
+      data[:ll] = LogLevelToNumber.to_number(logger[:level]) || -1
+    end
+
+    data[:pi] = 1 if poll_interval
+
+    if vwo_meta && vwo_meta.key?(:ea)
+      data[:_ea] = 1
+    end
+
+    # check if threading is not passed or is if passed then enabled should be true
+    if !threading || (threading && threading[:enabled] == true)
+      data[:th] = 1
+      # check if max_pool_size is passed
+      if threading && threading[:max_pool_size]
+        data[:th_mps] = threading[:max_pool_size]
+      end
+    end
+
+    if defined?(RUBY_VERSION)
+      data[:lv] = RUBY_VERSION
+    end
+
+    @usage_stats_data = data
+  end
+
+  def get_usage_stats
+    @usage_stats_data
+  end
+
+  def clear_usage_stats
+    @usage_stats_data = {}
+  end
+end
+

data/lib/vwo/utils/uuid_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/vwo/vwo_builder.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,9 +21,14 @@ require_relative './packages/storage/storage'
 require_relative './packages/network_layer/manager/network_manager'
 require_relative './packages/segmentation_evaluator/core/segmentation_manager'
 require_relative './services/logger_service'
+require_relative './services/batch_event_queue'
+require_relative './utils/function_util'
+require_relative './utils/batch_event_dispatcher'
+require_relative './constants/constants'
+require_relative './utils/usage_stats_util'
 
 class VWOBuilder
-  attr_reader :settings, :storage, :log_manager, :is_settings_fetch_in_progress, :vwo_instance
+  attr_reader :settings, :storage, :log_manager, :is_settings_fetch_in_progress, :vwo_instance, :is_valid_poll_interval_passed_from_init
 
   # Initialize the VWOBuilder with the given options
   # @param options [Hash] The options for the VWOBuilder
@@ -33,9 +38,50 @@ class VWOBuilder
     @storage = nil
     @log_manager = nil
     @is_settings_fetch_in_progress = false
+    @is_valid_poll_interval_passed_from_init = false
     @vwo_instance = nil
   end
 
+  # Initializes the batch event processing system
+  # Validates batch event settings and configures the BatchEventsQueue
+  # Sets up event dispatcher and flushes any existing events
+  # @raise [StandardError] If batch event configuration is invalid
+  def init_batch
+    # if gateway service is configured, then do not initialize batch event queue
+    if SettingsService.instance.is_gateway_service_provided
+      LoggerService.log(LogLevelEnum::INFO, "GATEWAY_AND_BATCH_EVENTS_CONFIG_MISMATCH")
+      return self
+    end
+    begin
+      if @options.key?(:batch_event_data)
+        if @options[:batch_event_data].is_a?(Hash)
+          # Validate batch event parameters
+          events_per_request = @options[:batch_event_data][:events_per_request]
+          request_time_interval = @options[:batch_event_data][:request_time_interval]
+          
+          if (!events_per_request.is_a?(Numeric) || events_per_request <= 0) &&
+             (!request_time_interval.is_a?(Numeric) || request_time_interval <= 0)
+            LoggerService.log(LogLevelEnum::ERROR, "INVALID_BATCH_EVENTS_CONFIG")
+          end
+          
+          BatchEventsQueue.configure(
+            @options[:batch_event_data].merge(
+              {
+                account_id: @options[:account_id],
+                dispatcher: method(:dispatcher)
+              }
+            )
+          )
+          @batch_event_data = @options[:batch_event_data]
+        else
+          LoggerService.log(LogLevelEnum::ERROR, "Invalid batch events config, should be a hash.", nil)
+        end
+      end
+    rescue StandardError => e
+      LoggerService.log(LogLevelEnum::ERROR, "Failed to initialize batch event queue: #{e.message}", nil)
+    end
+  end
+
   # Set the network manager
   # @return [VWOBuilder] The VWOBuilder instance
   def set_network_manager
@@ -89,7 +135,12 @@ class VWOBuilder
   # Set the storage
   # @return [VWOBuilder] The VWOBuilder instance
   def set_storage
-    @storage = @options[:storage] ? Storage.instance.attach_connector(@options[:storage]) : nil
+    if @options[:storage]
+      @storage = Storage.instance.attach_connector(@options[:storage])
+      Storage.instance.is_storage_enabled = true
+    else
+      @storage = nil
+    end
     LoggerService.log(LogLevelEnum::DEBUG, "SERVICE_INITIALIZED", {service: "Storage"})
     self
   end
@@ -116,26 +167,19 @@ class VWOBuilder
   # Initialize the polling
   # @return [VWOBuilder] The VWOBuilder instance
   def init_polling
-    return self unless @options[:poll_interval]
-
-    unless @options[:poll_interval].is_a?(Numeric)
-      LoggerService.log(LogLevelEnum::ERROR, "INIT_OPTIONS_INVALID", {
-        key: 'poll_interval',
-        correctType: 'number'
-      })
-      return self
-    end
-
-    # Check if the polling interval is greater than or equal to 1000
-    unless @options[:poll_interval] >= 1000
+    poll_interval = @options[:poll_interval]
+    
+    if poll_interval && poll_interval.is_a?(Numeric) && poll_interval >= 1000
+      # this is to check if the poll_interval passed in options is valid
+      @is_valid_poll_interval_passed_from_init = true
+      check_and_poll
+    elsif poll_interval
+      # only log error if poll_interval is present in options
       LoggerService.log(LogLevelEnum::ERROR, "INIT_OPTIONS_INVALID", {
         key: 'poll_interval',
-        correctType: 'number'
+        correctType: 'number >= 1000'
       })
-      return self
     end
-
-    check_and_poll
     self
   end
 
@@ -144,25 +188,42 @@ class VWOBuilder
   # @return [VWOClient] The VWO instance
   def build(settings)
     @vwo_instance = VWOClient.new(settings, @options)
+    # if poll_interval is not present in options, set it to the pollInterval from settings
+    update_poll_interval_and_check_and_poll(settings)
     @vwo_instance
   end
 
+  def update_poll_interval_and_check_and_poll(settings, should_check_and_poll = true)
+    # only update the poll_interval if it poll_interval is not valid or not present in options
+    if !@is_valid_poll_interval_passed_from_init
+      @options[:poll_interval] = settings["pollInterval"] || Constants::POLLING_INTERVAL
+      LoggerService.log(LogLevelEnum::DEBUG, "USING_POLL_INTERVAL_FROM_SETTINGS", {
+        source: settings["pollInterval"] ? 'settings' : 'default',
+        pollInterval: @options[:poll_interval]
+      })
+    end
+    # should_check_and_poll will be true only when we are updating the poll_interval first time from self.build method
+    # if we are updating the poll_interval already running polling, we don't need to check and poll again
+    if should_check_and_poll && !@is_valid_poll_interval_passed_from_init
+      check_and_poll
+    end
+  end
+
   # This method is used to check and poll the settings from the server
   # @return [VWOBuilder] The VWOBuilder instance
   def check_and_poll
-    polling_interval = @options[:poll_interval]
-
     @thread_pool = NetworkManager.instance.get_client.get_thread_pool
     @thread_pool.post do
       loop do
-        sleep(polling_interval / 1000.0)
+        sleep(@options[:poll_interval]/ 1000.0)
         begin
           latest_settings = fetch_settings(true)
-          if latest_settings.to_json != @settings.to_json
+          if latest_settings && latest_settings.to_json != @settings.to_json
             @settings = latest_settings
             LoggerService.log(LogLevelEnum::INFO, "POLLING_SET_SETTINGS")
             @vwo_instance.update_settings(latest_settings.clone, false) if @vwo_instance
-          else
+            update_poll_interval_and_check_and_poll(latest_settings, false)
+          elsif latest_settings
             LoggerService.log(LogLevelEnum::INFO, "POLLING_NO_CHANGE_IN_SETTINGS")
           end
         rescue StandardError => e
@@ -171,4 +232,26 @@ class VWOBuilder
       end
     end
   end
+
+  def dispatcher(events, callback)
+    BatchEventDispatcher.dispatch(
+      {
+        ev: events
+      },
+      callback,
+      {
+        a: @options[:account_id],
+        env: @options[:sdk_key]
+      }
+    )
+  end
+
+  # Initialize the usage stats
+  # @return [VWOBuilder] The VWOBuilder instance
+  def init_usage_stats
+    return self if @options[:is_usage_stats_disabled]
+
+    UsageStatsUtil.set_usage_stats(@options)
+    self
+  end
 end

data/lib/vwo/vwo_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@ require_relative 'services/logger_service'
 require_relative 'enums/log_level_enum'
 require_relative 'utils/network_util'
 require_relative 'models/schemas/settings_schema_validation'
+require_relative 'services/batch_event_queue'
 
 class VWOClient
   attr_accessor :settings, :original_settings
@@ -59,7 +60,7 @@ class VWOClient
         LoggerService.log(LogLevelEnum::ERROR, "API_INVALID_PARAM", {apiName: api_name, key: 'feature_key', type: feature_key.class.name , correctType: 'String'})
         raise TypeError, 'feature_key should be a non-empty string'
       end
-      unless SettingsSchema.new.is_settings_valid(@original_settings)
+      unless SettingsService.instance.is_settings_valid
         LoggerService.log(LogLevelEnum::ERROR, "API_SETTING_INVALID")
         raise TypeError, 'Invalid Settings'
       end
@@ -100,7 +101,7 @@ class VWOClient
         LoggerService.log(LogLevelEnum::ERROR, "API_INVALID_PARAM", {apiName: api_name, key: 'event_properties', type: event_properties.class.name, correctType: 'Hash'})
         raise TypeError, 'event_properties should be a hash'
       end
-      unless SettingsSchema.new.is_settings_valid(@original_settings)
+      unless SettingsService.instance.is_settings_valid
         LoggerService.log(LogLevelEnum::ERROR, "API_SETTING_INVALID")
         raise TypeError, 'Invalid Settings'
       end
@@ -139,7 +140,7 @@ class VWOClient
         LoggerService.log(LogLevelEnum::ERROR, "API_INVALID_PARAM", {apiName: api_name, key: 'context.id', type: context[:id].class.name, correctType: 'String'})
         raise TypeError, 'Invalid context, id should be a non-empty string'
       end
-      unless SettingsSchema.new.is_settings_valid(@original_settings)
+      unless SettingsService.instance.is_settings_valid
         LoggerService.log(LogLevelEnum::ERROR, "API_SETTING_INVALID")
         raise TypeError, 'Invalid Settings'
       end
@@ -189,4 +190,22 @@ class VWOClient
       )
     end
   end
+
+  # Flushes the batch events queue
+  # @return [void]
+  def flush_events
+    api_name = 'flush_events'
+    begin
+      LoggerService.log(LogLevelEnum::DEBUG, "API_CALLED", {apiName: api_name})
+      if BatchEventsQueue.instance.nil?
+        LoggerService.log(LogLevelEnum::ERROR, "Batching is not enabled. Pass batch_event_data in the SDK configuration while invoking init API.", nil)
+        raise StandardError, "Batch events queue is not initialized"
+      end
+      # flush the batch events queue
+      @response = BatchEventsQueue.instance.flush(true)
+      @response
+    rescue StandardError => e
+      LoggerService.log(LogLevelEnum::ERROR, "API_THROW_ERROR", {apiName: api_name, err: e.message})
+    end
+  end
 end

data/lib/vwo.rb

@@ -1,4 +1,4 @@
-# Copyright 2025 Wingify Software Pvt. Ltd.
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -36,6 +36,8 @@ class VWO
                    .set_network_manager
                    .set_segmentation
                    .init_polling
+                   .init_usage_stats
+                   .init_batch
 
     if options[:settings]
       return @@vwo_builder.build(options[:settings])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-07 00:00:00.000000000 Z
+date: 2025-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -161,6 +161,7 @@ files:
 - lib/vwo/enums/hooks_enum.rb
 - lib/vwo/enums/http_method_enum.rb
 - lib/vwo/enums/log_level_enum.rb
+- lib/vwo/enums/log_level_to_number.rb
 - lib/vwo/enums/status_enum.rb
 - lib/vwo/enums/storage_enum.rb
 - lib/vwo/enums/url_enum.rb
@@ -200,11 +201,13 @@ files:
 - lib/vwo/packages/segmentation_evaluator/utils/segment_util.rb
 - lib/vwo/packages/storage/connector.rb
 - lib/vwo/packages/storage/storage.rb
+- lib/vwo/services/batch_event_queue.rb
 - lib/vwo/services/campaign_decision_service.rb
 - lib/vwo/services/hooks_service.rb
 - lib/vwo/services/logger_service.rb
 - lib/vwo/services/settings_service.rb
 - lib/vwo/services/storage_service.rb
+- lib/vwo/utils/batch_event_dispatcher.rb
 - lib/vwo/utils/campaign_util.rb
 - lib/vwo/utils/data_type_util.rb
 - lib/vwo/utils/decision_util.rb
@@ -217,6 +220,7 @@ files:
 - lib/vwo/utils/rule_evaluation_util.rb
 - lib/vwo/utils/settings_util.rb
 - lib/vwo/utils/url_util.rb
+- lib/vwo/utils/usage_stats_util.rb
 - lib/vwo/utils/uuid_util.rb
 - lib/vwo/vwo_builder.rb
 - lib/vwo/vwo_client.rb