vwo-sdk 1.35.0 → 1.38.0

data/lib/vwo/enums.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Metrics/LineLength
-
 require 'logger'
 
 class VWO
@@ -64,23 +62,23 @@ class VWO
       VWO_PATH = 'vwo'
       UTIL_PATH = 'vwo/utils'
 
-      VWO = VWO_PATH + '/vwo'
-      Bucketer = VWO_PATH + '/core/bucketer'
-      VariationDecider = VWO_PATH + '/core/variation_decider'
-      EventDispatcher = VWO_PATH + '/services/event_dispatcher'
-      SegmentEvaluator = VWO_PATH + '/services/segment_evaluator'
-      Logger = VWO_PATH + '/logger'
-      SettingsFileProcessor = VWO_PATH + '/services/settings_file_processor'
-      BatchEventsQueue = VWO_PATH + '/services/batch_events_queue'
-      BatchEventsDispatcher = VWO_PATH + '/services/batch_events_dispatcher'
+      VWO = "#{VWO_PATH}/vwo"
+      BUCKETER = "#{VWO_PATH}/core/bucketer"
+      VARIATION_DECIDER = "#{VWO_PATH}/core/variation_decider"
+      EVENT_DISPATCHER = "#{VWO_PATH}/services/event_dispatcher"
+      SEGMENT_EVALUATOR = "#{VWO_PATH}/services/segment_evaluator"
+      LOGGER = "#{VWO_PATH}/logger"
+      SETTINGS_FILE_PROCESSOR = "#{VWO_PATH}/services/settings_file_processor"
+      BATCH_EVENTS_QUEUE = "#{VWO_PATH}/services/batch_events_queue"
+      BATCH_EVENTS_DISPATCHER = "#{VWO_PATH}/services/batch_events_dispatcher"
 
-      CampaignUtil = UTIL_PATH + '/campaign'
-      FunctionUtil = UTIL_PATH + '/function'
-      FeatureUtil = UTIL_PATH + '/feature'
-      ImpressionUtil = UTIL_PATH + '/impression'
-      UuidUtil = UTIL_PATH + '/uuid'
-      ValidateUtil = UTIL_PATH + '/validations'
-      CustomDimensionsUtil = UTIL_PATH + '/custom_dimensions_util'
+      CAMPAIGN_UTIL = "#{UTIL_PATH}/campaign"
+      FUNCTION_UTIL = "#{UTIL_PATH}/function"
+      FEATURE_UTIL = "#{UTIL_PATH}/feature"
+      IMPRESSION_UTIL = "#{UTIL_PATH}/impression"
+      UUID_UTIL = "#{UTIL_PATH}/uuid"
+      VALIDATE_UTIL = "#{UTIL_PATH}/validations"
+      CUSTOM_DIMENSTIONS_UTIL = "#{UTIL_PATH}/custom_dimensions_util"
     end
 
     module LogLevelEnum
@@ -91,4 +89,3 @@ class VWO
     end
   end
 end
-# rubocop:enable Metrics/LineLength

data/lib/vwo/logger.rb

@@ -16,7 +16,6 @@ require 'logger'
 
 class VWO
   class Logger
-
     DEBUG = ::Logger::DEBUG
     INFO = ::Logger::INFO
     ERROR = ::Logger::ERROR
@@ -30,12 +29,12 @@ class VWO
     end
 
     def initialize(logger_instance)
-      @@logger_instance = logger_instance || ::Logger.new(STDOUT)
+      @@logger_instance = logger_instance || ::Logger.new($stdout)
     end
 
     # Override this method to handle logs in a custom manner
     def log(level, message)
-        @@logger_instance.log(level, message)
+      @@logger_instance.log(level, message)
     end
 
     def instance

data/lib/vwo/schemas/settings_file.rb

@@ -61,12 +61,12 @@ class VWO
             weight: {
               type: %w[number string]
             },
-           variables: {
-             type: 'array',
-             items: {
-               '$ref' => '#/definitions/variables_schema'
-             }
-           }
+            variables: {
+              type: 'array',
+              items: {
+                '$ref' => '#/definitions/variables_schema'
+              }
+            }
           },
           required: %w[id name weight]
         },

data/lib/vwo/services/batch_events_dispatcher.rb

@@ -42,25 +42,26 @@ class VWO
         url = CONSTANTS::HTTPS_PROTOCOL + get_url(CONSTANTS::ENDPOINTS::BATCH_EVENTS)
         account_id = query_params[:a]
         resp = VWO::Utils::Request.post(url, query_params, impression)
-        if resp.code == '200'
+        case resp.code
+        when '200'
           @logger.log(
             LogLevelEnum::INFO,
             'IMPRESSION_BATCH_SUCCESS',
             {
               '{file}' => FILE,
               '{endPoint}' => url,
-              '{accountId}' => account_id,
+              '{accountId}' => account_id
             }
           )
           message = nil
-        elsif resp.code == '413'
+        when '413'
           @logger.log(
             LogLevelEnum::DEBUG,
             'CONFIG_BATCH_EVENT_LIMIT_EXCEEDED',
             {
-              '{file}' => FileNameEnum::BatchEventsDispatcher,
+              '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
               '{endPoint}' => url,
-              '{eventsPerRequest}' => impression.length(),
+              '{eventsPerRequest}' => impression.length,
               '{accountId}' => impression[:a]
             }
           )
@@ -69,7 +70,7 @@ class VWO
             LogLevelEnum::ERROR,
             'IMPRESSION_FAILED',
             {
-              '{file}' => FileNameEnum::BatchEventsDispatcher,
+              '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
               '{err}' => resp.message,
               '{endPoint}' => url
             }
@@ -79,43 +80,40 @@ class VWO
           @logger.log(
             LogLevelEnum::INFO,
             'IMPRESSION_BATCH_FAILED',
-            {'{file}' => FileNameEnum::BatchEventsDispatcher}
+            { '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER }
           )
 
           @logger.log(
             LogLevelEnum::ERROR,
             'IMPRESSION_FAILED',
             {
-              '{file}' => FileNameEnum::BatchEventsDispatcher,
+              '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
               '{err}' => resp.message,
               '{endPoint}' => url
             }
           )
           message = resp.message
         end
-        if callback
-          callback.call(message, impression)
-        end
+        callback&.call(message, impression)
         true
       rescue StandardError => e
         @logger.log(
           LogLevelEnum::DEBUG,
           'IMPRESSION_BATCH_FAILED',
-            {'{file}' => FileNameEnum::BatchEventsDispatcher}
+          { '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER }
         )
 
         @logger.log(
-            LogLevelEnum::ERROR,
-            'IMPRESSION_FAILED',
-            {
-              '{file}' => FileNameEnum::BatchEventsDispatcher,
-              '{err}' => e.message,
-              '{endPoint}' => url
-            }
-          )
+          LogLevelEnum::ERROR,
+          'IMPRESSION_FAILED',
+          {
+            '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
+            '{err}' => e.message,
+            '{endPoint}' => url
+          }
+        )
         false
       end
-
     end
   end
 end

data/lib/vwo/services/batch_events_queue.rb

@@ -36,9 +36,9 @@ class VWO
             LogLevelEnum::INFO,
             'EVENT_BATCH_DEFAULTS',
             {
-              '{file}' => FileNameEnum::BatchEventsQueue,
+              '{file}' => FileNameEnum::BATCH_EVENTS_QUEUE,
               '{parameter}' => 'request_time_interval',
-              '{defaultValue}' => @request_time_interval.to_s + ' ms'
+              '{defaultValue}' => "#{@request_time_interval} ms"
             }
           )
         end
@@ -51,7 +51,7 @@ class VWO
             LogLevelEnum::INFO,
             'EVENT_BATCH_DEFAULTS',
             {
-              '{file}' => FileNameEnum::BatchEventsQueue,
+              '{file}' => FileNameEnum::BATCH_EVENTS_QUEUE,
               '{parameter}' => 'events_per_request',
               '{defaultValue}' => @events_per_request.to_s
             }
@@ -59,9 +59,7 @@ class VWO
         end
 
         @flush_callback = nil
-        if batch_config.key?(:flushCallback) && batch_config[:flushCallback].is_a?(Method)
-          @flush_callback = batch_config[:flushCallback]
-        end
+        @flush_callback = batch_config[:flushCallback] if batch_config.key?(:flushCallback) && batch_config[:flushCallback].is_a?(Method)
 
         @dispatcher = batch_config[:dispatcher]
       end
@@ -72,35 +70,34 @@ class VWO
 
       def enqueue(event)
         return true if @is_development_mode
+
         @queue.push(event)
         update_queue_metadata(event)
         unless @timer
           create_new_batch_timer
-          @thread = Thread.new{flush_when_request_times_up}
-        end
-        if @events_per_request === @queue.length()
-          flush
-          kill_old_thread
+          @thread = Thread.new { flush_when_request_times_up }
         end
+        return unless @events_per_request == @queue.length
+
+        flush
+        kill_old_thread
       end
 
       def flush_when_request_times_up
-        while @timer > Time.now
-          sleep(1)
-        end
+        sleep(1) while @timer > Time.now
         flush
         kill_old_thread
       end
 
       def flush(manual = false)
-        if @queue.length() > 0
+        if @queue.length > 0
           @logger.log(
             LogLevelEnum::DEBUG,
             'EVENT_BATCH_BEFORE_FLUSHING',
             {
-              '{file}' => FileNameEnum::BatchEventsQueue,
+              '{file}' => FileNameEnum::BATCH_EVENTS_QUEUE,
               '{manually}' => manual ? 'manually' : '',
-              '{length}' => @queue.length(),
+              '{length}' => @queue.length,
               '{timer}' => manual ? 'Timer will be cleared and registered again,' : '',
               '{accountId}' => @batch_config[:account_id]
             }
@@ -112,9 +109,9 @@ class VWO
             LogLevelEnum::INFO,
             'EVENT_BATCH_After_FLUSHING',
             {
-              '{file}' => FileNameEnum::BatchEventsQueue,
+              '{file}' => FileNameEnum::BATCH_EVENTS_QUEUE,
               '{manually}' => manual ? 'manually,' : '',
-              '{length}' => @queue.length()
+              '{length}' => @queue.length
             }
           )
           @queue_metadata = {}
@@ -123,16 +120,12 @@ class VWO
           @logger.log(
             LogLevelEnum::INFO,
             'Batch queue is empty. Nothing to flush.',
-            {'{file}' => FILE}
+            { '{file}' => FILE }
           )
         end
 
         clear_request_timer
-        unless manual
-          if @thread
-            @old_thread = @thread
-          end
-        end
+        @old_thread = @thread if !manual && @thread
         true
       end
 
@@ -141,32 +134,23 @@ class VWO
       end
 
       def kill_thread
-        if @thread
-          @thread.kill
-        end
+        @thread&.kill
       end
 
       def kill_old_thread
-        if @old_thread
-          @old_thread.kill
-        end
+        @old_thread&.kill
       end
 
       def update_queue_metadata(event)
-        if event[:eT] == 1
-          unless @queue_metadata.key?(VWO::EVENTS::TRACK_USER)
-            @queue_metadata[VWO::EVENTS::TRACK_USER] = 0
-          end
+        case event[:eT]
+        when 1
+          @queue_metadata[VWO::EVENTS::TRACK_USER] = 0 unless @queue_metadata.key?(VWO::EVENTS::TRACK_USER)
           @queue_metadata[VWO::EVENTS::TRACK_USER] = @queue_metadata[VWO::EVENTS::TRACK_USER] + 1
-        elsif event[:eT] == 2
-          unless @queue_metadata.key?(VWO::EVENTS::TRACK_GOAL)
-            @queue_metadata[VWO::EVENTS::TRACK_GOAL] = 0
-          end
+        when 2
+          @queue_metadata[VWO::EVENTS::TRACK_GOAL] = 0 unless @queue_metadata.key?(VWO::EVENTS::TRACK_GOAL)
           @queue_metadata[VWO::EVENTS::TRACK_GOAL] = @queue_metadata[VWO::EVENTS::TRACK_GOAL] + 1
-        elsif event[:eT] == 3
-          unless @queue_metadata.key?(VWO::EVENTS::PUSH)
-            @queue_metadata[VWO::EVENTS::PUSH] = 0
-          end
+        when 3
+          @queue_metadata[VWO::EVENTS::PUSH] = 0 unless @queue_metadata.key?(VWO::EVENTS::PUSH)
           @queue_metadata[VWO::EVENTS::PUSH] = @queue_metadata[VWO::EVENTS::PUSH] + 1
         end
       end

data/lib/vwo/services/event_dispatcher.rb

@@ -43,7 +43,7 @@ class VWO
       #                                       the request to be dispatched to the VWO server
       # @return[Boolean]
       #
-      def dispatch(impression)
+      def dispatch(impression, main_keys, end_point)
         return true if @is_development_mode
 
         modified_event = impression.reject do |key, _value|
@@ -52,13 +52,23 @@ class VWO
 
         resp = VWO::Utils::Request.get(impression['url'], modified_event)
         if resp.code == '200'
+          @logger.log(
+            LogLevelEnum::INFO,
+            'IMPRESSION_SUCCESS',
+            {
+              '{file}' => FILE,
+              '{endPoint}' => end_point,
+              '{accountId}' => impression['account_id'] || impression[:account_id],
+              '{mainKeys}' => JSON.generate(main_keys)
+            }
+          )
           true
         else
           @logger.log(
             LogLevelEnum::ERROR,
             'IMPRESSION_FAILED',
             {
-              '{file}' => FileNameEnum::BatchEventsDispatcher,
+              '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
               '{err}' => resp.message,
               '{endPoint}' => impression['url']
             }
@@ -67,14 +77,14 @@ class VWO
         end
       rescue StandardError => e
         @logger.log(
-            LogLevelEnum::ERROR,
-            'IMPRESSION_FAILED',
-            {
-              '{file}' => FileNameEnum::BatchEventsDispatcher,
-              '{err}' => e.message,
-              '{endPoint}' => impression['url']
-            }
-          )
+          LogLevelEnum::ERROR,
+          'IMPRESSION_FAILED',
+          {
+            '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
+            '{err}' => e.message,
+            '{endPoint}' => impression['url']
+          }
+        )
         false
       end
 
@@ -88,8 +98,8 @@ class VWO
             LogLevelEnum::INFO,
             'IMPRESSION_SUCCESS_FOR_EVENT_ARCH',
             {
-              '{file}' => FileNameEnum::BatchEventsDispatcher,
-              '{event}' => 'visitor property:' + JSON.generate(post_data[:d][:visitor][:props]),
+              '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
+              '{event}' => "visitor property:#{JSON.generate(post_data[:d][:visitor][:props])}",
               '{endPoint}' => url,
               '{accountId}' => params[:a]
             }
@@ -100,7 +110,7 @@ class VWO
             LogLevelEnum::ERROR,
             'IMPRESSION_FAILED',
             {
-              '{file}' => FileNameEnum::EventDispatcher,
+              '{file}' => FileNameEnum::EVENT_DISPATCHER,
               '{err}' => resp.message,
               '{endPoint}' => url
             }
@@ -109,14 +119,14 @@ class VWO
         end
       rescue StandardError => e
         @logger.log(
-            LogLevelEnum::ERROR,
-            'IMPRESSION_FAILED',
-            {
-              '{file}' => FileNameEnum::EventDispatcher,
-              '{err}' => e.message,
-              '{endPoint}' => url
-            }
-          )
+          LogLevelEnum::ERROR,
+          'IMPRESSION_FAILED',
+          {
+            '{file}' => FileNameEnum::EVENT_DISPATCHER,
+            '{err}' => e.message,
+            '{endPoint}' => url
+          }
+        )
         false
       end
     end

data/lib/vwo/services/hooks_manager.rb

@@ -15,22 +15,18 @@
 class VWO
   module Services
     class HooksManager
-     # Hooks Manager is responsible for triggering callbacks useful to the end-user based on certain lifecycle events.
-     # Possible use with integrations when the user intends to send an event when a visitor is part of the experiment.
+      # Hooks Manager is responsible for triggering callbacks useful to the end-user based on certain lifecycle events.
+      # Possible use with integrations when the user intends to send an event when a visitor is part of the experiment.
       def initialize(config)
         @logger = VWO::Logger.get_instance
-        if config.key?(:integrations) && config[:integrations].key?(:callback) && config[:integrations][:callback].is_a?(Method)
-          @callback = config[:integrations][:callback]
-        end
+        @callback = config[:integrations][:callback] if config.key?(:integrations) && config[:integrations].key?(:callback) && config[:integrations][:callback].is_a?(Method)
       end
 
-     # Executes the callback
-     # @param[Hash] properties Properties from the callback
-     def execute(properties)
-       if @callback
-         @callback.call(properties)
-       end
-     end
+      # Executes the callback
+      # @param[Hash] properties Properties from the callback
+      def execute(properties)
+        @callback&.call(properties)
+      end
     end
   end
 end

data/lib/vwo/services/segment_evaluator.rb

@@ -43,15 +43,16 @@ class VWO
       #
       def evaluate_util(dsl, custom_variables)
         operator, sub_dsl = get_key_value(dsl)
-        if operator == OperatorTypes::NOT
+        case operator
+        when OperatorTypes::NOT
           !evaluate_util(sub_dsl, custom_variables)
-        elsif operator == OperatorTypes::AND
+        when OperatorTypes::AND
           sub_dsl.all? { |y| evaluate_util(y, custom_variables) }
-        elsif operator == OperatorTypes::OR
+        when OperatorTypes::OR
           sub_dsl.any? { |y| evaluate_util(y, custom_variables) }
-        elsif operator == OperandTypes::CUSTOM_VARIABLE
+        when OperandTypes::CUSTOM_VARIABLE
           @operand_evaluator.evaluate_custom_variable?(sub_dsl, custom_variables)
-        elsif operator == OperandTypes::USER
+        when OperandTypes::USER
           @operand_evaluator.evaluate_user?(sub_dsl, custom_variables)
         end
       end
@@ -75,7 +76,7 @@ class VWO
           LogLevelEnum::ERROR,
           'SEGMENTATION_ERROR',
           {
-            '{file}' => FileNameEnum::SegmentEvaluator,
+            '{file}' => FileNameEnum::SEGMENT_EVALUATOR,
             '{userId}' => user_id,
             '{campaignKey}' => campaign_key,
             '{variation}' => '',

data/lib/vwo/services/settings_file_manager.rb

@@ -47,11 +47,11 @@ class VWO
           return '{}'
         end
 
-        if is_via_webhook
-          path = ::VWO::CONSTANTS::ENDPOINTS::WEBHOOK_SETTINGS_URL
-        else
-          path = ::VWO::CONSTANTS::ENDPOINTS::SETTINGS_URL
-        end
+        path = if is_via_webhook
+                 ::VWO::CONSTANTS::ENDPOINTS::WEBHOOK_SETTINGS_URL
+               else
+                 ::VWO::CONSTANTS::ENDPOINTS::SETTINGS_URL
+               end
         vwo_server_url = "#{PROTOCOL}://#{HOSTNAME}#{path}"
 
         settings_file_response = ::VWO::Utils::Request.get(vwo_server_url, params)

data/lib/vwo/services/settings_file_processor.rb

@@ -41,7 +41,7 @@ class VWO
           LogLevelEnum::DEBUG,
           'SETTINGS_FILE_PROCESSED',
           {
-            '{file}' => FileNameEnum::SettingsFileProcessor,
+            '{file}' => FileNameEnum::SETTINGS_FILE_PROCESSOR,
             '{accountId}' => @settings_file['accountId']
           }
         )

data/lib/vwo/services/usage_stats.rb

@@ -16,13 +16,14 @@ class VWO
   module Services
     class UsageStats
       attr_reader :usage_stats
+
       # Initialize the UsageStats
       def initialize(stats, is_development_mode = false)
         @usage_stats = {}
-        unless is_development_mode
-          @usage_stats = stats
-          @usage_stats[:_l] = 1 if @usage_stats.length > 0
-        end
+        return if is_development_mode
+
+        @usage_stats = stats
+        @usage_stats[:_l] = 1 if @usage_stats.length > 0
       end
     end
   end