vwo-fme-ruby-sdk 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8935c2c79e2fc5cd17d450d4a21fdf48fda27343455ad939bb2a7b66820ae2ec
-  data.tar.gz: 3e0297e44ac33c862aad76b8e04ba7b944acc4c38b476582e931a53c14ffd483
+  metadata.gz: 6d45fa0809a1e1abfab41886fb30f9987d6e7910dc146d3f9c389d833870480c
+  data.tar.gz: af6be7b298827b5cfb5facac2b4227bdc74afc21d55da7d30b4652d57a708b4e
 SHA512:
-  metadata.gz: d05fef9ef3277e071c8cbf3f7582dc7845e1e99c63247b6db440975c46bbb685f8b5723bc67850fd2666bfd1d69e7fe17fafbdf1f711aa562bff013d7c65f48d
-  data.tar.gz: e39b7eaf87dc0bb3540519649a96b85e4178775948d88f7a60aedf6e430aa977c7ff1f27b5f53860f86e37233544da21975a66e767683be3566fec3ec2f261ed
+  metadata.gz: e92a90c764fbdb5cba7417172079bc08480b71246028add35c098ef8700754b33bd736e3384444f7b3be2f36c0b2b2f93073a69b4622cbbd571b8d6530e6d237
+  data.tar.gz: 820f2d137b7506d3bdc4eb629c0d383d9d3e04ecb99cd99f47a473977ef0f4ca92bb23df3b0f23aceefee98964d97dc57a3244a32bc996f190f3e5abc4eee596

data/lib/resources/info_messages.json

@@ -38,5 +38,6 @@
     "IMPRESSION_BATCH_FAILED": "Batch events couldn\"t be received by VWO. Calling Flush Callback with error and data",
     "EVENT_BATCH_MAX_LIMIT": "{parameter} passed in SDK configuration is greater than the maximum limit of {maxLimit}. Setting it to the maximum limit",
     "GATEWAY_AND_BATCH_EVENTS_CONFIG_MISMATCH": "Batch Events config passed in SDK configuration will not work as the gatewayService is already configured. Please check the documentation for more details",
-    "NETWORK_CALL_SUCCESS_WITH_RETRIES": "Network call for {extraData} succeeded after {attempts} retry attempt(s). Previous attempts failed with error: {err}"
+    "NETWORK_CALL_SUCCESS_WITH_RETRIES": "Network call for {extraData} succeeded after {attempts} retry attempt(s). Previous attempts failed with error: {err}",
+    "PROXY_AND_GATEWAY_SERVICE_PROVIDED": "Both proxy URL and gateway service are provided. Gateway service will be used and proxy URL will be ignored"
   }

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

data/lib/vwo/models/vwo_options_model.rb

@@ -16,7 +16,7 @@ class VWOOptionsModel
   attr_accessor :account_id, :sdk_key, :is_development_mode, :storage, :gateway_service,
                 :poll_interval, :logger, :segmentation, :integrations, :network,
                 :should_wait_for_tracking_calls, :settings, :vwo_builder, :is_usage_stats_disabled, :_vwo_meta,
-                :retry_config
+                :retry_config, :proxy_url
 
   def initialize(options = {})
     @account_id = options[:account_id]
@@ -35,6 +35,7 @@ class VWOOptionsModel
     @is_usage_stats_disabled = options[:is_usage_stats_disabled]
     @_vwo_meta = options[:_vwo_meta]
     @retry_config = options[:retry_config]
+    @proxy_url = options[:proxy_url]
   end
 
   # Creates a model instance from a hash (dictionary)
@@ -54,7 +55,7 @@ class VWOOptionsModel
     @network = options[:network] if options.key?(:network)
     @settings = options[:settings] if options.key?(:settings)
     @retry_config = options[:retry_config] if options.key?(:retry_config)
-
+    @proxy_url = options[:proxy_url] if options.key?(:proxy_url)
     self
   end
 
@@ -121,5 +122,8 @@ class VWOOptionsModel
   def get_retry_config
     @retry_config
   end
-  
+
+  def get_proxy_url
+    @proxy_url
+  end
 end

data/lib/vwo/services/settings_service.rb

@@ -25,7 +25,7 @@ require_relative '../enums/api_enum'
 require_relative '../utils/debugger_service_util'
 
 class SettingsService
-  attr_accessor :sdk_key, :account_id, :expiry, :network_timeout, :hostname, :port, :protocol, :is_gateway_service_provided, :is_settings_valid, :settings_fetch_time
+  attr_accessor :sdk_key, :account_id, :expiry, :network_timeout, :hostname, :port, :protocol, :is_gateway_service_provided, :is_settings_valid, :settings_fetch_time, :proxy_url, :is_proxy_url_provided, :collection_prefix
 
   class << self
     attr_accessor :instance
@@ -55,6 +55,15 @@ class SettingsService
       @protocol = parsed_url.scheme
       @port = parsed_url.port || options.dig(:gateway_service, :port)
       @is_gateway_service_provided = true
+      if options[:proxy_url] && !options[:proxy_url].nil? && !options[:proxy_url].empty?
+        LoggerService.log(LogLevelEnum::INFO, "PROXY_AND_GATEWAY_SERVICE_PROVIDED")
+      end
+    elsif options[:proxy_url] && !options[:proxy_url].nil? && !options[:proxy_url].empty?
+      parsed_url = URI.parse(options[:proxy_url])
+      @hostname = parsed_url.hostname
+      @protocol = parsed_url.scheme
+      @port = parsed_url.port
+      @is_proxy_url_provided = true
     else
       @hostname = Constants::HOST_NAME
       @protocol = Constants::HTTPS_PROTOCOL
@@ -64,6 +73,13 @@ class SettingsService
     SettingsService.instance = self
   end
 
+  def get_updated_endpoint_with_collection_prefix(endpoint)
+    if @collection_prefix && !@collection_prefix.empty?
+      return "/#{@collection_prefix}#{endpoint}"
+    end
+    return endpoint
+  end
+
   # Fetch settings and cache them in storage.
   # @return [SettingsModel] The fetched settings
   def fetch_settings_and_cache_in_storage
@@ -124,7 +140,7 @@ class SettingsService
       end
       # Deep duplicate the settings to avoid modifying the original object
       normalized_settings = SettingsService.normalize_settings(settings)
-
+      @collection_prefix = normalized_settings['collectionPrefix'] if normalized_settings['collectionPrefix'] && !normalized_settings['collectionPrefix'].empty?
       normalized_settings
     rescue => e
       LoggerService.log(LogLevelEnum::ERROR, "ERROR_FETCHING_SETTINGS", { err: e.message, an: ApiEnum::INIT})

data/lib/vwo/utils/batch_event_dispatcher_util.rb

@@ -44,9 +44,9 @@ class BatchEventDispatcherUtil
       headers['Authorization'] = "#{SettingsService.instance.sdk_key}"
 
       request = RequestModel.new(
-        UrlUtil.get_base_url,
+        SettingsService.instance.hostname,
         HttpMethodEnum::POST,
-        UrlEnum::BATCH_EVENTS,
+        SettingsService.instance.get_updated_endpoint_with_collection_prefix(UrlEnum::BATCH_EVENTS),
         properties,
         payload,
         headers,

data/lib/vwo/utils/event_util.rb

@@ -44,6 +44,12 @@ def send_sdk_usage_stats_event(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)
+  # check if batching is enabled
+  if BatchEventsQueue.instance
+    # add the payload to the batch events queue
+    BatchEventsQueue.instance.enqueue(payload)
+  else
+    # send event
+    NetworkUtil.send_event(properties, payload)
+  end
 end

data/lib/vwo/utils/gateway_service_util.rb

@@ -17,7 +17,6 @@ require_relative '../packages/network_layer/manager/network_manager'
 require_relative '../packages/network_layer/models/request_model'
 require_relative '../enums/http_method_enum'
 require_relative '../services/settings_service'
-require_relative 'url_util'
 require_relative '../enums/campaign_type_enum'
 require_relative '../services/logger_service'
 require_relative '../enums/log_level_enum'
@@ -37,9 +36,9 @@ def get_from_gateway_service(query_params, endpoint)
 
   begin
     request = RequestModel.new(
-      UrlUtil.get_base_url,
+      SettingsService.instance.hostname,
       HttpMethodEnum::GET,
-      endpoint,
+      SettingsService.instance.get_updated_endpoint_with_collection_prefix(endpoint),
       query_params,
       nil,
       nil,

data/lib/vwo/utils/network_util.rb

@@ -21,7 +21,6 @@ require_relative '../constants/constants'
 require_relative '../packages/network_layer/manager/network_manager'
 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'
 require_relative '../models/user/context_model'
@@ -92,8 +91,7 @@ class NetworkUtil
             random: get_random_number,
             p: 'FS',
             visitor_ua: visitor_user_agent || '',
-            visitor_ip: ip_address || '',
-            url: "#{UrlUtil.get_base_url}#{UrlEnum::EVENTS}"
+            visitor_ip: ip_address || ''
         }
 
         if !is_usage_stats_event
@@ -270,9 +268,9 @@ class NetworkUtil
         headers[HeadersEnum::IP] = payload[:d][:visitor_ip] if payload[:d][:visitor_ip]
 
         request = RequestModel.new(
-        UrlUtil.get_base_url,
+        SettingsService.instance.hostname,
         HttpMethodEnum::POST,
-        UrlEnum::EVENTS,
+        SettingsService.instance.get_updated_endpoint_with_collection_prefix(UrlEnum::EVENTS),
         properties,
         payload,
         headers,
@@ -347,20 +345,15 @@ 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(
-            url,
+            SettingsService.instance.hostname,
             HttpMethodEnum::POST,
-            UrlEnum::EVENTS,
+            SettingsService.instance.get_updated_endpoint_with_collection_prefix(UrlEnum::EVENTS),
             properties,
             payload,
             headers,
-            Constants::HTTPS_PROTOCOL,
-            nil
+            SettingsService.instance.protocol,
+            SettingsService.instance.port,
         )
 
         begin

data/lib/vwo/vwo_client.rb

@@ -17,7 +17,6 @@ require_relative 'models/user/context_model'
 require_relative 'api/get_flag'
 require_relative 'api/set_attribute'
 require_relative 'api/track_event'
-require_relative 'utils/url_util'
 require_relative 'utils/settings_util'
 require_relative 'services/logger_service'
 require_relative 'enums/log_level_enum'
@@ -37,7 +36,6 @@ class VWOClient
     
     begin
       set_settings_and_add_campaigns_to_rules(settings, self)
-      UrlUtil.init(collection_prefix: @settings.get_collection_prefix)
     rescue StandardError => e
       LoggerService.log(LogLevelEnum::ERROR, "ERROR_ADDING_CAMPAIGNS_TO_RULES", { err: e.message, an: ApiEnum::INIT})
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-01-13 00:00:00.000000000 Z
+date: 2026-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -222,7 +222,6 @@ files:
 - lib/vwo/utils/network_util.rb
 - 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

data/lib/vwo/utils/url_util.rb

@@ -1,53 +0,0 @@
-# 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 '../services/settings_service'
-
-class UrlUtil
-  @collection_prefix = nil
-
-  class << self
-    attr_accessor :collection_prefix
-
-    # Initializes the UrlUtil with an optional collection prefix.
-    #
-    # @param collection_prefix [String] Optional prefix for URL collections.
-    # @return [UrlUtil] The singleton instance of UrlUtil with updated properties.
-    def init(collection_prefix: nil)
-      @collection_prefix = collection_prefix if collection_prefix.is_a?(String)
-      self
-    end
-
-    # Retrieves the base URL.
-    #
-    # @return [String] The base URL.
-    def get_base_url
-      base_url = SettingsService.instance.hostname
-
-      return base_url if SettingsService.instance.is_gateway_service_provided
-
-      # Construct URL with collection_prefix if it exists
-      return "#{base_url}/#{@collection_prefix}" if @collection_prefix
-
-      base_url
-    end
-
-    # Retrieves the collection prefix.
-    #
-    # @return [String] The collection prefix.
-    def get_collection_prefix
-      @collection_prefix
-    end
-  end
-end