vwo-fme-ruby-sdk 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21c0e79e4c0cca26188c44b647de95c940bf919e4f88f584ef41836068f1cff2
-  data.tar.gz: 4ef7bda68a051cb7365d9607ba8d48e0dc82924a11cabaedbbb947db73b15999
+  metadata.gz: a93237647aaaac411d5ecd0d6eed52c33778282ab781ffc236ea2b46ed88a3e5
+  data.tar.gz: 52eecf7bf9d7f96c194715e510e0190346aa1f1f63f941fbbf311e9786364097
 SHA512:
-  metadata.gz: 0450c78a51f8a3fa8352c9b6fe66b6ec48b448187e7fcad33e501f6810d53d919b6d0ec9492a314d9885cb9a28568c0ffe1248e3742f99da8415f735622c2d60
-  data.tar.gz: d4aa3eca37dfbff8f035af7392d92851bbf239234f1bd933e7c7143ca0ebec5778d9e5e6159a11f9601c986ea6533331bc55013351a3a81ecc5f2b957587e674
+  metadata.gz: e6eb2497b2968e79662cd6161ee4b4fa849510bb1fa6edefd3b4becaec0b10be48c01bb7aec48f84f4b139048bec79cdf4dd97366a2a124519491c940a6c82fe
+  data.tar.gz: 8db5b2ee18a59597d9ef3072e847defaf7aaab30d93426cf1c15229a451591903c91e8c2f0627a6b48b1c5d85a59beff749e017d222f2a494cae7869915dac5d

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

data/lib/vwo/enums/log_level_to_number.rb

@@ -0,0 +1,27 @@
+# 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.
+
+module LogLevelToNumber
+    LEVELS = {
+      'TRACE' => 0,
+      'DEBUG' => 1,
+      'INFO'  => 2,
+      'WARN'  => 3,
+      'ERROR' => 4
+    }.freeze
+  
+    def self.to_number(level)
+      LEVELS[level.to_s.upcase] || 0
+    end
+  end

data/lib/vwo/models/vwo_options_model.rb

@@ -15,7 +15,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
+                :should_wait_for_tracking_calls, :settings, :vwo_builder, :is_usage_stats_disabled, :_vwo_meta
 
   def initialize(options = {})
     @account_id = options[:account_id]
@@ -31,6 +31,8 @@ class VWOOptionsModel
     @should_wait_for_tracking_calls = options[:should_wait_for_tracking_calls]
     @settings = options[:settings]
     @vwo_builder = options[:vwo_builder]
+    @is_usage_stats_disabled = options[:is_usage_stats_disabled]
+    @_vwo_meta = options[:_vwo_meta]
   end
 
   # Creates a model instance from a hash (dictionary)
@@ -104,4 +106,13 @@ class VWOOptionsModel
   def get_vwo_builder
     @vwo_builder
   end
+
+  def get_is_usage_stats_disabled
+    @is_usage_stats_disabled
+  end
+
+  def get_vwo_meta
+    @_vwo_meta
+  end
+  
 end

data/lib/vwo/packages/logger/core/transport_manager.rb

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require_relative '../log_message_builder'
+require_relative '../../../enums/log_level_to_number'
 
 class LogTransportManager
     def initialize(config)
@@ -25,8 +26,8 @@ class LogTransportManager
     end
   
     def should_log?(transport_level, config_level)
-      target_level = log_level_to_number(transport_level)
-      desired_level = log_level_to_number(config_level || @config[:level])
+      target_level = LogLevelToNumber.to_number(transport_level)
+      desired_level = LogLevelToNumber.to_number(config_level || @config[:level])
       target_level >= desired_level
     end
   
@@ -70,18 +71,6 @@ class LogTransportManager
         end
       end
     end
-  
-    private
-  
-    def log_level_to_number(level)
-      {
-        'TRACE' => 0,
-        'DEBUG' => 1,
-        'INFO' => 2,
-        'WARN' => 3,
-        'ERROR' => 4
-      }[level.upcase] || 0
-    end
   end
   
   

data/lib/vwo/utils/network_util.rb

@@ -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
@@ -132,6 +133,12 @@ class NetworkUtil
         # 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,
@@ -203,10 +210,17 @@ class NetworkUtil
             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", {
@@ -241,4 +255,4 @@ class NetworkUtil
         end
     end
   end
-end
+end

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/vwo_builder.rb

@@ -25,6 +25,7 @@ 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, :is_valid_poll_interval_passed_from_init
@@ -244,4 +245,13 @@ class VWOBuilder
       }
     )
   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.rb

@@ -36,6 +36,7 @@ class VWO
                    .set_network_manager
                    .set_segmentation
                    .init_polling
+                   .init_usage_stats
                    .init_batch
 
     if options[:settings]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - VWO
@@ -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
@@ -219,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