vwo-sdk 1.3.0 → 1.14.1

data/lib/vwo/enums.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Wingify Software Pvt. Ltd.
+# Copyright 2019-2021 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.
@@ -12,14 +12,54 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# frozen_string_literal: true
-
 # rubocop:disable Metrics/LineLength
 
 require 'logger'
 
 class VWO
   module Enums
+    module OperandValueTypesName
+      REGEX = 'regex'
+      WILDCARD = 'wildcard'
+      LOWER = 'lower'
+      EQUALS = 'equals'
+    end
+
+    module OperandValueTypes
+      LOWER = 'lower'
+      CONTAINS = 'contains'
+      STARTS_WITH = 'starts_with'
+      ENDS_WITH = 'ends_with'
+      REGEX = 'regex'
+      EQUALS = 'equals'
+    end
+
+    module OperatorTypes
+      AND = 'and'
+      OR = 'or'
+      NOT = 'not'
+    end
+
+    module OperandTypes
+      CUSTOM_VARIABLE = 'custom_variable'
+      USER = 'user'
+    end
+
+    module OperandValuesBooleanTypes
+      TRUE = 'true'
+      FALSE = 'false'
+    end
+
+    module StatusEnum
+      PASSED = 'passed'
+      FAILED = 'failed'
+    end
+
+    module SegmentationTypeEnum
+      WHITELISTING = 'whitelisting'
+      PRE_SEGMENTATION = 'pre-segmentation'
+    end
+
     module FileNameEnum
       VWO_PATH = 'vwo'
       UTIL_PATH = 'vwo/utils'
@@ -28,14 +68,19 @@ class 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'
 
       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'
     end
 
     # Logging Enums
@@ -61,12 +106,19 @@ class VWO
         IMPRESSION_FOR_TRACK_USER = '(%<file>s): Impression built for track-user - %<properties>s'
         IMPRESSION_FOR_TRACK_GOAL = '(%<file>s): Impression built for track-goal - %<properties>s'
         GOT_VARIATION_FOR_USER = '(%<file>s): userId:%<user_id>s for campaign:%<campaign_key>s got variationName:%<variation_name>s'
+        SEGMENTATION_STATUS = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s of campaign:%<campaign_key>s  with variables:%<custom_variables>s %<status>s %<segmentation_type>s for %<variation_name>s'
+        PARAMS_FOR_PUSH_CALL = '(%<file>s): Params for push call - %<properties>s'
+        CAMPAIGN_NOT_ACTIVATED = '(%<file>s): Campaign:%<campaign_key>s for User ID:%<user_id>s is not yet activated for API:%<api_name>s. Use activate API to activate A/B test or isFeatureEnabled API to activate Feature Test.'
+        BATCH_EVENT_LIMIT_EXCEEDED = '(%<file>s): Impression event - %<end_point>s failed due to exceeding payload size. Parameter eventsPerRequest in batchEvents config in launch API has value:%<eventsPerRequest>s for accountId:%<accountId>s. Please read the official documentation for knowing the size limits.'
+        BULK_NOT_PROCESSED = "(%<file>s): Batch events couldn't be received by VWO. Calling Flush Callback with error and data."
+        BEFORE_FLUSHING = '(%<file>s): Flushing events queue %<manually>s having %<length>s events %<timer>s queue summary: %<queue_metadata>s'
+        EVENT_BATCHING_INSUFFICIENT = '(%<file>s): %<key>s not provided, assigning default value'
       end
 
       # Info Messages
       module InfoMessages
         VARIATION_RANGE_ALLOCATION = '(%<file>s): Campaign:%<campaign_key>s having variations:%<variation_name>s with weight:%<variation_weight>s got range as: ( %<start>s - %<end>s ))'
-        VARIATION_ALLOCATED = '(%<file>s): UserId:%<user_id>s of Campaign:%<campaign_key>s got variation: %<variation_name>s'
+        VARIATION_ALLOCATED = '(%<file>s): UserId:%<user_id>s of Campaign:%<campaign_key>s type: %<campaign_type>s got variation: %<variation_name>s'
         LOOKING_UP_USER_STORAGE_SERVICE = '(%<file>s): Looked into UserStorageService for userId:%<user_id>s %<status>s'
         SAVING_DATA_USER_STORAGE_SERVICE = '(%<file>s): Saving into UserStorageService for userId:%<user_id>s successful'
         GOT_STORED_VARIATION = '(%<file>s): Got stored variation:%<variation_name>s of campaign:%<campaign_key>s for userId:%<user_id>s from UserStorageService'
@@ -75,8 +127,34 @@ class VWO
         AUDIENCE_CONDITION_NOT_MET = '(%<file>s): userId:%<user_id>s does not become part of campaign because of not meeting audience conditions'
         GOT_VARIATION_FOR_USER = '(%<file>s): userId:%<user_id>s for campaign:%<campaign_key>s got variationName:%<variation_name>s'
         USER_GOT_NO_VARIATION = '(%<file>s): userId:%<user_id>s for campaign:%<campaign_key>s did not allot any variation'
-        IMPRESSION_SUCCESS = '(%<file>s): Impression event - %<end_point>s was successfully received by VWO having main keys: accountId:%<account_id>s userId:%<user_id>s campaignId:%<campaign_id>s and variationId:%<variation_id>s'
+        IMPRESSION_SUCCESS = '(%<file>s): Impression event - %<end_point>s was successfully received by VWO having main keys: sdkKey:%<sdk_key>s accountId:%<account_id>s campaignId:%<campaign_id>s and variationId:%<variation_id>s'
+        MAIN_KEYS_FOR_IMPRESSION = '(%<file>s): Having main keys: {sdkKey:%<sdk_key>s accountId:%<account_id>s campaignId:%<campaign_id>s and variationId:%<variation_id>s}'
+        MAIN_KEYS_FOR_PUSH_API = '(%<file>s): Having main keys: {sdkKey:%<sdk_key>s accountId:%<account_id>s u:%<u>s and tags:%<tags>s}'
         INVALID_VARIATION_KEY = '(%<file>s): Variation was not assigned to userId:%<user_id>s for campaign:%<campaign_key>s'
+
+        USER_IN_FEATURE_ROLLOUT = '(%<file>s): User ID:%<user_id>s is in feature rollout:%<campaign_key>s'
+        USER_NOT_IN_FEATURE_ROLLOUT = '(%<file>s): User ID:%<user_id>s is NOT in feature rollout:%<campaign_key>s'
+        FEATURE_ENABLED_FOR_USER = '(%<file>s): In API: %<api_name>s Feature having feature-key:%<feature_key>s for user ID:%<user_id>s is enabled'
+        FEATURE_NOT_ENABLED_FOR_USER = '(%<file>s): In API: %<api_name>s Feature having feature-key:%<feature_key>s for user ID:%<user_id>s is not enabled'
+
+        VARIABLE_FOUND = '(%<file>s): In API: %<api_name>s Value for variable:%<variable_key>s of campaign:%<campaign_key>s and campaign type: %<campaign_type>s is:%<variable_value>s for user:%<user_id>s'
+
+        USER_PASSED_SEGMENTATION = '(%<file>s): UserId:%<user_id>s of campaign:%<campaign_key>s with custom_variables:%<custom_variables>s passed segmentation'
+        USER_FAILED_SEGMENTATION = '(%<file>s): UserId:%<user_id>s of campaign:%<campaign_key>s with custom_variables:%<custom_variables>s failed segmentation'
+
+        NO_CUSTOM_VARIABLES = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s preSegments/customVariables are not passed for campaign:%<campaign_key>s and campaign has pre-segmentation'
+        SKIPPING_SEGMENTATION = '(%<file>s): In API: %<api_name>s, Skipping segmentation:%<variation>s for UserId:%<user_id>s as no valid segments found in campaign:%<campaign_key>s'
+
+        SEGMENTATION_STATUS = '(%<file>s): In API: %<api_name>s, for UserId:%<user_id>s of campaign:%<campaign_key>s  with variables:%<custom_variables>s %<status>s %<segmentation_type>s %<variation_name>s'
+        WHITELISTING_SKIPPED = '(%<file>s): In API: %<api_name>s, Skipping whitelisting for UserId:%<user_id>s of campaign:%<campaign_key>s'
+        SETTINGS_NOT_UPDATED = '(%<file>s): Settings-file fetched are same as earlier fetched settings'
+        SETTINGS_FILE_UPDATED = '(%<file>s): %<api_name>s vwo_sdk_instance is updated with the latest settings_file'
+        CAMPAIGN_NOT_ACTIVATED = '(%<file>s): Activate the campaign:%<campaign_key>s for User ID:%<user_id>s to %<reason>s.'
+        GOAL_ALREADY_TRACKED = '(%<file>s): Goal:%<goal_identifier>s of Campaign:%<campaign_key>s for User ID:%<user_id>s has already been tracked earlier. Skipping now'
+        USER_ALREADY_TRACKED = '(%<file>s): User ID:%<user_id>s for Campaign:%<campaign_key>s has already been tracked earlier for "%<api_name>s" API. Skipping now'
+        API_CALLED = '(%<file>s): API: {api_name} called for UserId:%<user_id>s'
+        BULK_IMPRESSION_SUCCESS = '(%<file>s): Impression event - %<end_point>s was successfully received by VWO having accountId:%<a>s'
+        AFTER_FLUSHING = '(%<file>s): Events queue having %<length>s events has been flushed %<manually>s queue summary: %<queue_metadata>s'
       end
 
       # Warning Messages
@@ -85,22 +163,47 @@ class VWO
       # Error Messages
       module ErrorMessages
         SETTINGS_FILE_CORRUPTED = '(%<file>s): Settings file is corrupted. Please contact VWO Support for help.'
-        ACTIVATE_API_MISSING_PARAMS = '(%<file>s): "activate" API got bad parameters. It expects campaignTestKey(String) as first and userId(String) as second argument'
-        ACTIVATE_API_CONFIG_CORRUPTED = '(%<file>s): "activate" API has corrupted configuration'
-        GET_VARIATION_NAME_API_MISSING_PARAMS = '(%<file>s): "getVariation" API got bad parameters. It expects campaignTestKey(String) as first and userId(String) as second argument'
+        ACTIVATE_API_MISSING_PARAMS = '(%<file>s): %<api_name>s API got bad parameters. It expects campaignTestKey(String) as first and userId(String) as second argument, customVariables(Hash) can be passed via options for pre-segmentation'
+        API_CONFIG_CORRUPTED = '(%<file>s): %<api_name>s API has corrupted configuration'
+        GET_VARIATION_NAME_API_INVALID_PARAMS = '(%<file>s): %<api_name>s API got bad parameters. It expects campaignTestKey(String) as first and userId(String) as second argument, customVariables(Hash) can be passed via options for pre-segmentation'
         GET_VARIATION_API_CONFIG_CORRUPTED = '(%<file>s): "getVariation" API has corrupted configuration'
-        TRACK_API_MISSING_PARAMS = '(%<file>s): "track" API got bad parameters. It expects campaignTestKey(String) as first userId(String) as second and goalIdentifier(String/Number) as third argument. Fourth is revenueValue(Float/Number/String) and is required for revenue goal only.'
+        TRACK_API_INVALID_PARAMS = '(%<file>s): %<api_name>s API got bad parameters. It expects campaignTestKey(Nil/String/Array) as first userId(String) as second and goalIdentifier(String/Number) as third argument. Fourth is revenueValue(Float/Number/String) and is required for revenue goal only. customVariables(Hash) can be passed via options for pre-segmentation'
         TRACK_API_CONFIG_CORRUPTED = '(%<file>s): "track" API has corrupted configuration'
         TRACK_API_GOAL_NOT_FOUND = '(%<file>s): Goal:%<goal_identifier>s not found for campaign:%<campaign_key>s and userId:%<user_id>s'
         TRACK_API_REVENUE_NOT_PASSED_FOR_REVENUE_GOAL = '(%<file>s): Revenue value should be passed for revenue goal:%<goal_identifier>s for campaign:%<campaign_key>s and userId:%<user_id>s'
         TRACK_API_VARIATION_NOT_FOUND = '(%<file>s): Variation not found for campaign:%<campaign_key>s and userId:%<user_id>s'
-        CAMPAIGN_NOT_RUNNING = '(%<file>s): API used:%<api>s - Campaign:%<campaign_key>s is not RUNNING. Please verify from VWO App'
+        CAMPAIGN_NOT_RUNNING = '(%<file>s): API used:%<api_name>s - Campaign:%<campaign_key>s is not RUNNING. Please verify from VWO App'
         LOOK_UP_USER_STORAGE_SERVICE_FAILED = '(%<file>s): Looking data from UserStorageService failed for userId:%<user_id>s'
         SAVE_USER_STORAGE_SERVICE_FAILED = '(%<file>s): Saving data into UserStorageService failed for userId:%<user_id>s'
         INVALID_CAMPAIGN = '(%<file>s): Invalid campaign passed to %<method>s of this file'
         INVALID_USER_ID = '(%<file>s): Invalid userId:%<user_id>s passed to %<method>s of this file'
         IMPRESSION_FAILED = '(%<file>s): Impression event could not be sent to VWO - %<end_point>s'
         CUSTOM_LOGGER_MISCONFIGURED = '(%<file>s): Custom logger is provided but seems to have mis-configured. %<extra_info>s Please check the API Docs. Using default logger.'
+        INVALID_API = '(%<file>s): %<api_name>s API is not valid for user ID: %<user_id>s in campaign ID: %<campaign_key>s having campaign type: %<campaign_type>s.'
+        IS_FEATURE_ENABLED_API_INVALID_PARAMS = '(%<file>s): %<api_name>s API got bad parameters. It expects campaign_key(String) as first and user_id(String) as second argument, customVariables(dict) can be passed via options for pre-segmentation'
+        GET_FEATURE_VARIABLE_VALUE_API_INVALID_PARAMS = '(%<file>s): "get_feature_variable" API got bad parameters. It expects campaign_key(String) as first, variable_key(string) as second and user_id(String) as third argument, customVariables(dict) can be passed via options for pre-segmentation'
+
+        VARIABLE_NOT_FOUND = '(%<file>s): In API: %<api_name>s Variable %<variable_key>s not found for campaign %<campaign_key>s and type %<campaign_type>s for user ID %<user_id>s'
+        UNABLE_TO_TYPE_CAST = '(%<file>s): Unable to typecast value: %<value>s of type: %<of_type>s to type: %<variable_type>s.'
+
+        USER_NOT_IN_CAMPAIGN = '(%<file>s): userId:%<user_id>s did not become part of campaign:%<campaign_key>s and campaign type:%<campaign_type>s'
+        API_NOT_WORKING = '(%<file>s): API: %<api_name>s not working, exception caught: %<exception>s. Please contact VWO Support for help.'
+
+        SEGMENTATION_ERROR = '(%<file>s): Error while segmenting the UserId:%<user_id>s of campaign:%<campaign_key>s with custom_variables:%<custom_variables>s. Error message: %<error_message>s'
+
+        PUSH_API_INVALID_PARAMS = '(%<file>s): %<api_name>s API got bad parameters. It expects tag_key(String) as first and tag_value(String) as second argument and user_id(String) as third argument'
+        TAG_VALUE_LENGTH_EXCEEDED = '(%<file>s): In API: %<api_name>s, the length of tag_value:%<tag_value>s and userID: %<user_id>s can not be greater than 255'
+        TAG_KEY_LENGTH_EXCEEDED = '(%<file>s): In API: %<api_name>s, the length of tag_key:%<tag_key>s and userID: %<user_id>s can not be greater than 255'
+        TRACK_API_MISSING_PARAMS = '(%<file>s): "track" API got bad parameters. It expects campaignKey(null/String/array) as first, userId(String/Number) as second and goalIdentifier (string) as third argument. options is revenueValue(Float/Number/String) and is required for revenue goal only.'
+        NO_CAMPAIGN_FOUND = '(%<file>s): No campaign found for goal_identifier:%<goal_identifier>s. Please verify from VWO app.'
+        INVALID_TRACK_RETURNING_USER_VALUE  = '(%<file>s): should_track_returning_user should be boolean'
+        INVALID_GOAL_TYPE = '(%<file>s): goal_type_to_track should be certain strings'
+        EVENT_BATCHING_NOT_OBJECT = '(%<file>s): Batch events settings are not of type object.'
+        EVENTS_PER_REQUEST_INVALID = '(%<file>s): events_per_request should be an integer'
+        REQUEST_TIME_INTERVAL_INVALID = '(%<file>s): request_time_interval should be a number'
+        EVENTS_PER_REQUEST_OUT_OF_BOUNDS = '(%<file>s): events_per_request should be >= %<min_value>s and <= %<max_value>s'
+        REQUEST_TIME_INTERVAL_OUT_OF_BOUNDS = '(%<file>s): request_time_interval should be >= %<min_value>s'
+        FLUSH_CALLBACK_INVALID = '(%<file>s): flush_callback is not callable'
       end
     end
 

data/lib/vwo/logger.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Wingify Software Pvt. Ltd.
+# Copyright 2019-2021 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.
@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# frozen_string_literal: true
-
 require 'logger'
 
 class VWO
@@ -33,5 +31,13 @@ class VWO
     def log(level, message)
       @@logger_instance.log(level, message)
     end
+
+    def instance
+      @@logger_instance
+    end
+
+    def level
+      @@logger_instance.level
+    end
   end
 end

data/lib/vwo/schemas/settings_file.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Wingify Software Pvt. Ltd.
+# Copyright 2019-2021 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.
@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# frozen_string_literal: true
-
 require 'json'
 
 class VWO

data/lib/vwo/services/batch_events_dispatcher.rb

@@ -0,0 +1,110 @@
+# Copyright 2019-2021 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 '../logger'
+require_relative '../enums'
+require_relative '../utils/request'
+class VWO
+  module Services
+    class BatchEventsDispatcher
+      include VWO::Enums
+      # Initialize the BatchEventDispatcher with logger and development mode
+      #
+      # @param [Boolean] :  To specify whether the request
+      #                     to our server should be made or not.
+      #
+      def initialize
+        @logger = VWO::Logger.get_instance
+        @queue = []
+      end
+
+      # Dispatch the impression event having properties object only if dev-mode is OFF
+      #
+      # @param[Hash]        :properties       hash having impression properties
+      #                                       the request to be dispatched to the VWO server
+      # @return[Boolean]
+      #
+      def dispatch(impression, callback, query_params)
+        url = CONSTANTS::HTTPS_PROTOCOL + CONSTANTS::ENDPOINTS::BASE_URL + CONSTANTS::ENDPOINTS::BATCH_EVENTS
+        account_id = query_params[:a]
+        resp = VWO::Utils::Request.post(url, query_params, impression)
+        if resp.code == '200'
+          @logger.log(
+            LogLevelEnum::INFO,
+            format(
+              LogMessageEnum::InfoMessages::BULK_IMPRESSION_SUCCESS,
+              file: FileNameEnum::BatchEventsDispatcher,
+              end_point: url,
+              a: account_id
+            )
+          )
+          message = nil
+        elsif resp.code == '413'
+          @logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::BATCH_EVENT_LIMIT_EXCEEDED,
+              file: FileNameEnum::BatchEventsDispatcher,
+              end_point: url,
+              accountId: impression[:a],
+              eventsPerRequest: impression.length()
+            )
+          )
+
+          @logger.log(
+            LogLevelEnum::ERROR,
+            format(
+              LogMessageEnum::ErrorMessages::IMPRESSION_FAILED,
+              file: FileNameEnum::BatchEventsDispatcher,
+              end_point: url
+            )
+          )
+          message = resp.message
+        else
+          @logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::BULK_NOT_PROCESSED,
+              file: FileNameEnum::BatchEventsDispatcher
+              )
+          )
+
+          @logger.log(
+            LogLevelEnum::ERROR,
+            format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::BatchEventsDispatcher, end_point: url)
+          )
+          message = resp.message
+        end
+        if callback
+          callback.call(message, impression)
+        end
+      rescue StandardError => e
+        @logger.log(
+          LogLevelEnum::DEBUG,
+          format(
+            LogMessageEnum::DebugMessages::BULK_NOT_PROCESSED,
+            file: FileNameEnum::BatchEventsDispatcher
+          )
+        )
+
+        @logger.log(
+          LogLevelEnum::ERROR,
+          format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::BatchEventsDispatcher, end_point: url)
+        )
+        false
+      end
+
+    end
+  end
+end

data/lib/vwo/services/batch_events_queue.rb

@@ -0,0 +1,175 @@
+# Copyright 2019-2021 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 '../logger'
+require_relative '../enums'
+require_relative '../utils/request'
+
+class VWO
+  module Services
+    class BatchEventsQueue
+      include VWO::Enums
+
+      def initialize(batch_config, is_development_mode = false)
+        @is_development_mode = is_development_mode
+        @logger = VWO::Logger.get_instance
+        @queue = []
+        @queue_metadata = {}
+        @batch_config = batch_config
+
+        if batch_config[:request_time_interval]
+          @request_time_interval = batch_config[:request_time_interval]
+        else
+          @request_time_interval = CONSTANTS::DEFAULT_REQUEST_TIME_INTERVAL
+          @logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::EVENT_BATCHING_INSUFFICIENT,
+              file: FileNameEnum::BatchEventsQueue,
+              key: 'request_time_interval'
+            )
+          )
+        end
+
+        if batch_config[:events_per_request]
+          @events_per_request = batch_config[:events_per_request]
+        else
+          @events_per_request = CONSTANTS::DEFAULT_EVENTS_PER_REQUEST
+          @logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::EVENT_BATCHING_INSUFFICIENT,
+              file: FileNameEnum::BatchEventsQueue,
+              key: 'events_per_request'
+            )
+          )
+        end
+
+        @flush_callback = nil
+        if batch_config.key?(:flushCallback) && batch_config[:flushCallback].is_a?(Method)
+          @flush_callback = batch_config[:flushCallback]
+        end
+
+        @dispatcher = batch_config[:dispatcher]
+      end
+
+      def create_new_batch_timer
+        @timer = Time.now + @request_time_interval
+      end
+
+      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
+        end
+      end
+
+      def flush_when_request_times_up
+        while @timer > Time.now
+          sleep(1)
+        end
+        flush
+        kill_old_thread
+      end
+
+      def flush(manual = false)
+        if @queue.length() > 0
+          @logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::BEFORE_FLUSHING,
+              file: FileNameEnum::BatchEventsQueue,
+              manually: manual ? 'manually' : '',
+              length: @queue.length(),
+              timer: manual ? 'Timer will be cleared and registered again,' : '',
+              queue_metadata: @queue_metadata
+            )
+          )
+
+          @dispatcher.call(@queue, @flush_callback)
+          @logger.log(
+            LogLevelEnum::INFO,
+            format(
+              LogMessageEnum::InfoMessages::AFTER_FLUSHING,
+              file: FILE,
+              manually: manual ? 'manually,' : '',
+              length: @queue.length(),
+              queue_metadata: @queue_metadata
+            )
+          )
+          @queue_metadata = {}
+          @queue = []
+        else
+          @logger.log(
+            LogLevelEnum::INFO,
+            format(
+              'Batch queue is empty. Nothing to flush.',
+              file: FILE
+            )
+          )
+        end
+
+        clear_request_timer
+        unless manual
+          if @thread
+            @old_thread = @thread
+          end
+        end
+        true
+      end
+
+      def clear_request_timer
+        @timer = nil
+      end
+
+      def kill_thread
+        if @thread
+          @thread.kill
+        end
+      end
+
+      def kill_old_thread
+        if @old_thread
+          @old_thread.kill
+        end
+      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
+          @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
+          @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
+          @queue_metadata[VWO::EVENTS::PUSH] = @queue_metadata[VWO::EVENTS::PUSH] + 1
+        end
+      end
+    end
+  end
+end