vwo-sdk 1.6.0 → 1.16.0

data/lib/vwo/logger.rb

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 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.

data/lib/vwo/schemas/settings_file.rb

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 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.
@@ -54,7 +54,13 @@ class VWO
             },
             weight: {
               type: %w[number string]
-            }
+            },
+           variables: {
+             type: 'array',
+             items: {
+               '$ref' => '#/definitions/variables_schema'
+             }
+           }
           },
           required: %w[id name weight]
         },
@@ -79,9 +85,33 @@ class VWO
                 '$ref' => '#/definitions/campaign_variation_schema'
               }
             },
+            variables: {
+              type: 'array',
+              items: {
+                '$ref' => '#/definitions/variables_schema'
+              }
+            },
             minItems: 2
           }
         },
+        variables_schema: {
+          type: 'object',
+          properties: {
+            id: {
+              type: %w[number string]
+            },
+            key: {
+              type: ['string']
+            },
+            type: {
+              type: ['string']
+            },
+            value: {
+              type: %w[number string boolean double object]
+            }
+          },
+          required: %w[id key type value]
+        },
         required: %w[
           id
           key

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

data/lib/vwo/services/event_dispatcher.rb

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 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.
@@ -48,18 +48,6 @@ class VWO
 
         resp = VWO::Utils::Request.get(impression['url'], modified_event)
         if resp.code == '200'
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS,
-              file: FileNameEnum::EventDispatcher,
-              end_point: impression[:url],
-              campaign_id: impression[:experiment_id],
-              user_id: impression[:uId],
-              account_id: impression[:account_id],
-              variation_id: impression[:combination]
-            )
-          )
           true
         else
           @logger.log(

data/lib/vwo/services/hooks_manager.rb

@@ -0,0 +1,36 @@
+# 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.
+
+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.
+      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
+      end
+
+     # Executes the callback
+     # @param[Hash] properties Properties from the callback
+     def execute(properties)
+       if @callback
+         @callback.call(properties)
+       end
+     end
+    end
+  end
+end

data/lib/vwo/services/operand_evaluator.rb

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 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.

data/lib/vwo/services/segment_evaluator.rb

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 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.

data/lib/vwo/services/settings_file_manager.rb

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 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.
@@ -25,7 +25,6 @@ class VWO
 
       PROTOCOL = 'https'
       HOSTNAME = ::VWO::CONSTANTS::ENDPOINTS::BASE_URL
-      PATH = ::VWO::CONSTANTS::ENDPOINTS::ACCOUNT_SETTINGS
 
       def initialize(account_id, sdk_key)
         @account_id = account_id
@@ -40,7 +39,7 @@ class VWO
       #                       as received from the server,
       #                       nil if no settings_file is found or sdk_key is incorrect
 
-      def get_settings_file
+      def get_settings_file(is_via_webhook = false)
         is_valid_key = valid_number?(@account_id) || valid_string?(@account_id)
 
         unless is_valid_key && valid_string?(@sdk_key)
@@ -48,7 +47,12 @@ class VWO
           return '{}'
         end
 
-        vwo_server_url = "#{PROTOCOL}://#{HOSTNAME}#{PATH}"
+        if is_via_webhook
+          path = ::VWO::CONSTANTS::ENDPOINTS::WEBHOOK_SETTINGS_URL
+        else
+          path = ::VWO::CONSTANTS::ENDPOINTS::SETTINGS_URL
+        end
+        vwo_server_url = "#{PROTOCOL}://#{HOSTNAME}#{path}"
 
         settings_file_response = ::VWO::Utils::Request.get(vwo_server_url, params)