vwo-sdk 1.3.0 → 1.14.1

data/lib/vwo/services/event_dispatcher.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_relative '../logger'
 require_relative '../enums'
 require_relative '../utils/request'
@@ -50,25 +48,13 @@ 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]
-            )
-          )
-          return true
+          true
         else
           @logger.log(
             LogLevelEnum::ERROR,
             format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: impression['url'])
           )
-          return false
+          false
         end
       rescue StandardError
         @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

@@ -0,0 +1,122 @@
+# 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 '../utils/function'
+require_relative '../utils/segment'
+
+class VWO
+  module Services
+    class OperandEvaluator
+      include VWO::Utils::Function
+      include VWO::Utils::Segment
+
+      # Checks if both values are same after 'down-casing'
+      # i.e. case insensitive check
+      #
+      # @param [String] :operand_value            Leaf value from the segments
+      # @param [String] :custom_variables_value   Value from the custom_variables
+      #
+      # @return [Boolean]
+      def lower?(operand_value, custom_variables_value)
+        operand_value.downcase == custom_variables_value.downcase
+      end
+
+      # Checks if custom_variables_value contains operand_value
+      #
+      # @param [String] :operand_value            Leaf value from the segments
+      # @param [String] :custom_variables_value   Value from the custom_variables
+      #
+      # @return [Boolean]
+      def contains?(operand_value, custom_variables_value)
+        custom_variables_value.include?(operand_value)
+      end
+
+      # Checks if custom_variables_value ends with operand_value
+      #
+      # @param [String] :operand_value            Leaf value from the segments
+      # @param [String] :custom_variables_value   Value from the custom_variables
+      #
+      # @return [Boolean]
+      def starts_with?(operand_value, custom_variables_value)
+        custom_variables_value.end_with?(operand_value)
+      end
+
+      # Checks if custom_variables_value starts with operand_value
+      #
+      # @param [String] :operand_value            Leaf value from the segments
+      # @param [String] :custom_variables_value   Value from the custom_variables
+      #
+      # @return [Boolean]
+      def ends_with?(operand_value, custom_variables_value)
+        custom_variables_value.start_with?(operand_value)
+      end
+
+      # Checks if custom_variables_value matches the regex specified by operand_value
+      #
+      # @param [String] :operand_value            Leaf value from the segments
+      # @param [String] :custom_variables_value   Value from the custom_variables
+      #
+      # @return [Boolean]
+      def regex?(operand_value, custom_variables_value)
+        pattern = Regexp.new operand_value
+        custom_variables_value =~ pattern
+      end
+
+      # Checks if both values are exactly same
+      #
+      # @param [String] :operand_value            Leaf value from the segments
+      # @param [String] :custom_variables_value   Value from the custom_variables
+      #
+      # @return [Boolean]
+      def equals?(operand_value, custom_variables_value)
+        custom_variables_value == operand_value
+      end
+
+      # Identifies the condition stated in the leaf node and evaluates the result
+      #
+      # @param [String] :operand_value            Leaf value from the segments
+      # @param [String] :custom_variables_value   Value from the custom_variables
+      #
+      # @return [Boolean]
+      def evaluate_custom_variable?(operand, custom_variables)
+        # Extract custom_variable_key and custom_variables_value from operand
+
+        operand_key, operand = get_key_value(operand)
+
+        # Retrieve corresponding custom_variable value from custom_variables
+        custom_variables_value = custom_variables[operand_key]
+
+        # Pre process custom_variable value
+        custom_variables_value = process_custom_variables_value(custom_variables_value)
+
+        # Pre process operand value
+        operand_type, operand_value = process_operand_value(operand)
+
+        # Process the custom_variables_value and operand_value to make them of same type
+        operand_value, custom_variables_value = convert_to_true_types(operand_value, custom_variables_value)
+
+        # Call the self method corresponding to operand_type to evaluate the result
+        public_send("#{operand_type}?", operand_value, custom_variables_value)
+      end
+
+      def evaluate_user?(operand, custom_variables)
+        users = operand.split(',')
+        users.each do |user|
+          return true if user.strip == custom_variables['_vwo_user_id']
+        end
+        false
+      end
+    end
+  end
+end

data/lib/vwo/services/segment_evaluator.rb

@@ -0,0 +1,88 @@
+# 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 './operand_evaluator'
+require_relative '../utils/function'
+require_relative '../utils/segment'
+require_relative '../utils/validations'
+
+class VWO
+  module Services
+    class SegmentEvaluator
+      include VWO::Enums
+      include VWO::Utils::Function
+      include VWO::Utils::Segment
+      include VWO::Utils::Validations
+
+      # Initializes this class with VWOLogger and OperandEvaluator
+      def initialize
+        @logger = VWO::Logger.get_instance
+        @operand_evaluator = OperandEvaluator.new
+      end
+
+      # A parser which recursively evaluates the expression tree represented by dsl,
+      # and returns the result
+      #
+      # @param[Hash]      :dsl                      The segments defined in the campaign
+      # @param[Hash]      :custom_variables         Key/value pair of custom_attributes properties
+      #
+      # @return[Boolean]
+      #
+      def evaluate_util(dsl, custom_variables)
+        operator, sub_dsl = get_key_value(dsl)
+        if operator == OperatorTypes::NOT
+          !evaluate_util(sub_dsl, custom_variables)
+        elsif operator == OperatorTypes::AND
+          sub_dsl.all? { |y| evaluate_util(y, custom_variables) }
+        elsif operator == OperatorTypes::OR
+          sub_dsl.any? { |y| evaluate_util(y, custom_variables) }
+        elsif operator == OperandTypes::CUSTOM_VARIABLE
+          @operand_evaluator.evaluate_custom_variable?(sub_dsl, custom_variables)
+        elsif operator == OperandTypes::USER
+          @operand_evaluator.evaluate_user?(sub_dsl, custom_variables)
+        end
+      end
+
+      # Evaluates the custom_variables passed against the pre-segmentation condition defined
+      # in the corresponding campaign.
+      #
+      # @param[String]                  :campaign_key         Running_campaign's key
+      # @param[String]                  :user_id              Unique user identifier
+      # @param[Hash]                    :dsl                  Segments provided in the settings_file
+      # @param[Hash]                    :custom_variables     Custom variables provided in the apis
+      #
+      # @return[Boolean]                true if user passed pre-segmentation, else false
+      #
+      def evaluate(campaign_key, user_id, dsl, custom_variables)
+        result = evaluate_util(dsl, custom_variables) if valid_value?(dsl)
+        result
+      rescue StandardError => e
+        @logger.log(
+          LogLevelEnum::ERROR,
+          format(
+            LogMessageEnum::ErrorMessages::SEGMENTATION_ERROR,
+            file: FileNameEnum::SegmentEvaluator,
+            user_id: user_id,
+            campaign_key: campaign_key,
+            custom_variables: custom_variables,
+            error_message: e
+          )
+        )
+        false
+      end
+    end
+  end
+end

data/lib/vwo/services/settings_file_manager.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_relative '../utils/function'
 require_relative '../utils/request'
 require_relative '../utils/validations'
@@ -27,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
@@ -42,15 +39,20 @@ 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)
-          STDERR.puts 'account_id and sdk_key are required for fetching account settings. Aborting!'
+          puts 'account_id and sdk_key are required for fetching account settings. Aborting!'
           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)
 
@@ -60,12 +62,12 @@ class VWO
             Got Status Code: #{settings_file_response.code}
             and message: #{settings_file_response.body}.
           DOC
-          STDERR.puts message
+          puts message
           return
         end
         settings_file_response.body
       rescue StandardError => e
-        STDERR.puts "Error fetching Settings File #{e}"
+        puts "Error fetching Settings File #{e}"
       end
 
       private

data/lib/vwo/services/settings_file_processor.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_relative '../logger'
 require_relative '../enums'
 require_relative '../utils/campaign'
@@ -46,6 +44,11 @@ class VWO
         )
       end
 
+      def update_settings_file(settings_file)
+        @settings_file = settings_file
+        process_settings_file
+      end
+
       def get_settings_file
         @settings_file
       end

data/lib/vwo/services/usage_stats.rb

@@ -0,0 +1,29 @@
+# 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 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
+      end
+    end
+  end
+end

data/lib/vwo/user_storage.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
-
 class VWO
   # UserStorage Class is used to store user-variation mapping.
   # Override this class to implement your own functionality.

data/lib/vwo/utils/campaign.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_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
@@ -25,18 +23,6 @@ class VWO
       include VWO::Enums
       include VWO::CONSTANTS
 
-      # Finds and Returns campaign from given campaign_key.
-      #
-      # @param[Hash]      :settings_file      Settings file
-      # @param[String]    :campaign_key      Campaign identifier key
-      # @return[Hash]     :campaign object
-
-      def get_campaign(settings_file, campaign_key)
-        (settings_file['campaigns'] || []).find do |campaign|
-          campaign['key'] == campaign_key
-        end
-      end
-
       # Sets variation allocation range in the provided campaign
       #
       # @param [Hash]: Campaign object
@@ -72,23 +58,48 @@ class VWO
       end
 
       # Returns goal from given campaign_key and gaol_identifier.
-      # @param[Hash]              :settings_file        Settings file
-      # @param[String]            :campaign_key        Campaign identifier key
+      # @param[String]            :campaign             Campaign object
       # @param[String]            :goal_identifier      Goal identifier
       #
       # @return[Hash]                                  Goal corresponding to Goal_identifier in respective campaign
 
-      def get_campaign_goal(settings_file, campaign_key, goal_identifier)
-        return unless settings_file && campaign_key && goal_identifier
-
-        campaign = get_campaign(settings_file, campaign_key)
-        return unless campaign
+      def get_campaign_goal(campaign, goal_identifier)
+        return unless campaign && goal_identifier
 
         campaign['goals'].find do |goal|
           goal['identifier'] == goal_identifier
         end
       end
 
+      # Returns segments from the campaign
+      # @param[Hash]          campaign      Running campaign
+      # @return[Hash]         A dsl of segments
+      #
+      def get_segments(campaign)
+        campaign['segments']
+      end
+
+      # Returns control variation from a given campaign
+      # @param[Hash]          campaign      Running campaign
+      # @return[Hash]         variation     Control variation from the campaign, ie having id = 1
+
+      def get_control_variation(campaign)
+        campaign['variations'].find do |variation|
+          variation['id'] == 1
+        end
+      end
+
+      # Returns variable from given variables list.
+      # @params[Array]          variables           List of variables, whether in campaigns or inside variation
+      # @param[String]          variable_key        Variable identifier
+      # @return[Hash]                               Variable corresponding to variable_key in given variable list
+
+      def get_variable(variables, variable_key)
+        variables.find do |variable|
+          variable['key'] == variable_key
+        end
+      end
+
       private
 
       # Returns the bucket size of variation.
@@ -120,6 +131,124 @@ class VWO
           variation['name'] == variation_name
         end
       end
+
+      # Finds and Returns campaign from given campaign_key.
+      # [Hash]                :settings_file          Settings file for the project
+      # [String]              :campaign_key           Campaign identifier key
+      # @return[Hash]                                 Campaign object
+
+      def get_campaign(settings_file, campaign_key)
+        settings_file['campaigns'].find do |campaign|
+          campaign['key'] == campaign_key
+        end
+      end
+
+      #  fetch campaigns from settings
+      #
+      #  [string|array|nil] :campaign_key
+      #  [Hash]             :settings_file
+      #  [string]           :goal_identifier
+      #  [string]           :goal_type_to_track
+      #  @return[Hash]
+      def get_campaigns(settings_file, campaign_key, goal_identifier, goal_type_to_track = 'ALL')
+        campaigns = []
+        if campaign_key.nil?
+          campaigns = get_campaigns_for_goal(settings_file, goal_identifier, goal_type_to_track)
+        elsif campaign_key.is_a?(Array)
+          campaigns = get_campaigns_from_campaign_keys(campaign_key, settings_file, goal_identifier, goal_type_to_track)
+        elsif campaign_key.is_a?(String)
+          campaign = get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
+          if campaign
+            campaigns = [campaign]
+          end
+        end
+        if campaigns.length() == 0
+          VWO::Logger.get_instance.log(
+            LogLevelEnum::ERROR,
+            format(
+              LogMessageEnum::ErrorMessages::NO_CAMPAIGN_FOUND,
+              file: FileNameEnum::CampaignUtil,
+              goal_identifier: goal_identifier
+            )
+          )
+        end
+        return campaigns
+      end
+
+      # fetch all running campaigns (having goal identifier goal_type_to_track and goal type CUSTOM|REVENUE|ALL) from settings
+      #
+      #  [Hash]             :settings_file
+      #  [string]           :goal_identifier
+      #  [string]           :goal_type_to_track
+      #  @return[Hash]
+      def get_campaigns_for_goal(settings_file, goal_identifier, goal_type_to_track = 'ALL')
+        campaigns = []
+        if settings_file
+          settings_file['campaigns'].each do |campaign|
+            if campaign.key?(:status) && campaign[:status] != 'RUNNING'
+              next
+            end
+            goal = get_campaign_goal(campaign, goal_identifier)
+            if validate_goal(goal, goal_type_to_track)
+              campaigns.append(campaign)
+            end
+          end
+        end
+        campaigns
+      end
+
+      def validate_goal(goal, goal_type_to_track)
+        result = goal && (
+          goal_type_to_track == 'ALL' ||
+            (
+              GOAL_TYPES.has_value?(goal['type']) &&
+                (GOAL_TYPES.key? goal_type_to_track) &&
+                goal['type'] == GOAL_TYPES[goal_type_to_track]
+            )
+        )
+        return result
+      end
+
+      def get_campaigns_from_campaign_keys(campaign_keys, settings_file, goal_identifier, goal_type_to_track = 'ALL')
+        campaigns = []
+        campaign_keys.each do |campaign_key|
+
+          campaign = get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
+          if campaign
+            campaigns.append(campaign)
+          end
+        end
+        campaigns
+      end
+
+      def get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
+        campaign = get_running_campaign(campaign_key, settings_file)
+        if campaign
+          goal = get_campaign_goal(campaign, goal_identifier)
+          if validate_goal(goal, goal_type_to_track)
+            return campaign
+          end
+        end
+        nil
+      end
+
+      def get_running_campaign(campaign_key, settings_file)
+        campaign = get_campaign(settings_file, campaign_key)
+        if campaign.nil? || (campaign['status'] != 'RUNNING')
+          @logger.log(
+            LogLevelEnum::ERROR,
+            format(
+              LogMessageEnum::ErrorMessages::CAMPAIGN_NOT_RUNNING,
+              file: FILE,
+              campaign_key: campaign_key,
+              api_name: ApiMethods::TRACK
+            )
+          )
+          nil
+        end
+        return campaign
+      end
+
     end
   end
 end