vwo-sdk 1.6.0 → 1.16.0

data/lib/vwo/services/settings_file_processor.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.
@@ -44,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-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/utils/campaign.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.
@@ -142,6 +142,113 @@ class VWO
           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.push(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.push(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

data/lib/vwo/utils/custom_dimensions.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.
@@ -26,13 +26,36 @@ class VWO
       include VWO::Enums
       include VWO::Utils::Impression
 
-      def get_url_params(settings_file, tag_key, tag_value, user_id)
+      def get_url_params(settings_file, tag_key, tag_value, user_id, sdk_key)
         url = HTTPS_PROTOCOL + ENDPOINTS::BASE_URL + ENDPOINTS::PUSH
         tag = { 'u' => {} }
         tag['u'][tag_key] = tag_value
 
         params = get_common_properties(user_id, settings_file)
-        params.merge!('url' => url, 'tags' => JSON.generate(tag))
+        params.merge!('url' => url, 'tags' => JSON.generate(tag), 'env' => sdk_key)
+
+        VWO::Logger.get_instance.log(
+          LogLevelEnum::DEBUG,
+          format(
+            LogMessageEnum::DebugMessages::PARAMS_FOR_PUSH_CALL,
+            file: FileNameEnum::CustomDimensionsUtil,
+            properties: JSON.generate(params)
+          )
+        )
+        params
+      end
+
+      def get_batch_event_url_params(settings_file, tag_key, tag_value, user_id)
+        tag = { 'u' => {} }
+        tag['u'][tag_key] = tag_value
+
+        account_id = settings_file['accountId']
+        params = {
+          'eT' => 3,
+          't' => JSON.generate(tag),
+          'u' => generator_for(user_id, account_id),
+          'sId' => get_current_unix_timestamp
+        }
 
         VWO::Logger.get_instance.log(
           LogLevelEnum::DEBUG,

data/lib/vwo/utils/feature.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.
@@ -38,6 +38,8 @@ class VWO
         return value.to_f if variable_type == VariableTypes::DOUBLE
 
         return !value || value == 0 ? false : true if variable_type == VariableTypes.BOOLEAN
+
+        return value if variable_type == VariableTypes::JSON
       rescue StandardError => _e
         VWO::Logger.get_instance.log(
           LogLevelEnum::ERROR,

data/lib/vwo/utils/function.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/utils/impression.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.
@@ -31,16 +31,17 @@ class VWO
 
       # Creates the impression from the arguments passed
       #
-      # @param[Hash]                        :settings_file           Settings file object
+      # @param[Hash]                        :settings_file          Settings file object
       # @param[String]                      :campaign_id            Campaign identifier
       # @param[String]                      :variation_id           Variation identifier
       # @param[String]                      :user_id                User identifier
+      # @param[String]                      :sdk_key                SDK Key
       # @param[String]                      :goal_id                Goal identifier, if building track impression
       # @param[String|Float|Integer|nil)    :revenue                Number value, in any representation, if building track impression
       #
       # @return[nil|Hash]                                           None if campaign ID or variation ID is invalid,
       #                                                             Else Properties(dict)
-      def create_impression(settings_file, campaign_id, variation_id, user_id, goal_id = nil, revenue = nil)
+      def create_impression(settings_file, campaign_id, variation_id, user_id, sdk_key, goal_id = nil, revenue = nil, usage_stats = {})
         return unless valid_number?(campaign_id) && valid_string?(user_id)
 
         is_track_user_api = true
@@ -51,17 +52,19 @@ class VWO
           account_id: account_id,
           experiment_id: campaign_id,
           ap: PLATFORM,
-          uId: CGI.escape(user_id.encode('utf-8')),
           combination: variation_id,
           random: get_random_number,
           sId: get_current_unix_timestamp,
-          u: generator_for(user_id, account_id)
+          u: generator_for(user_id, account_id),
+          env: sdk_key
         }
         # Version and SDK constants
         sdk_version = Gem.loaded_specs['vwo_sdk'] ? Gem.loaded_specs['vwo_sdk'].version : VWO::SDK_VERSION
         impression['sdk'] = 'ruby'
         impression['sdk-v'] = sdk_version
 
+        impression = usage_stats.merge(impression)
+
         url = HTTPS_PROTOCOL + ENDPOINTS::BASE_URL
         logger = VWO::Logger.get_instance
 
@@ -107,9 +110,57 @@ class VWO
           'ap' => PLATFORM,
           'sId' => get_current_unix_timestamp,
           'u' => generator_for(user_id, account_id),
-          'account_id' => account_id,
-          'uId' => CGI.escape(user_id.encode('utf-8'))
+          'account_id' => account_id
+        }
+      end
+
+      # Creates properties for the bulk impression event
+      #
+      # @param[Hash]                        :settings_file          Settings file object
+      # @param[String]                      :campaign_id            Campaign identifier
+      # @param[String]                      :variation_id           Variation identifier
+      # @param[String]                      :user_id                User identifier
+      # @param[String]                      :sdk_key                SDK Key
+      # @param[String]                      :goal_id                Goal identifier, if building track impression
+      # @param[String|Float|Integer|nil)    :revenue                Number value, in any representation, if building track impression
+      #
+      # @return[nil|Hash]                                           None if campaign ID or variation ID is invalid,
+      #                                                             Else Properties(dict)
+      def create_bulk_event_impression(settings_file, campaign_id, variation_id, user_id, goal_id = nil, revenue = nil)
+        return unless valid_number?(campaign_id) && valid_string?(user_id)
+        is_track_user_api = true
+        is_track_user_api = false unless goal_id.nil?
+        account_id = settings_file['accountId']
+        impression = {
+          eT: is_track_user_api ? 1 : 2,
+          e: campaign_id,
+          c: variation_id,
+          u: generator_for(user_id, account_id),
+          sId: get_current_unix_timestamp
         }
+        logger = VWO::Logger.get_instance
+        if is_track_user_api
+          logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_USER,
+              file: FileNameEnum::ImpressionUtil,
+              properties: JSON.generate(impression)
+            )
+          )
+        else
+          impression['g'] = goal_id
+          impression['r'] = revenue if revenue
+          logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_GOAL,
+              file: FileNameEnum::ImpressionUtil,
+              properties: JSON.generate(impression)
+            )
+          )
+        end
+        impression
       end
     end
   end

data/lib/vwo/utils/request.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.
@@ -24,6 +24,20 @@ class VWO
         uri.query = URI.encode_www_form(params)
         Net::HTTP.get_response(uri)
       end
+
+      def self.post(url, params, post_data)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        uri.query = URI.encode_www_form(params)
+        headers = {
+          'Authorization'=>params[:env],
+          'Content-Type' =>'application/json',
+          'Accept'=>'application/json'
+        }
+        response = http.post(uri, post_data.to_json, headers)
+        response
+      end
     end
   end
 end

data/lib/vwo/utils/segment.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/utils/uuid.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/utils/validations.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.
@@ -15,6 +15,9 @@
 require 'json'
 require 'json-schema'
 require_relative '../schemas/settings_file'
+require_relative '../logger'
+require_relative '../enums'
+require_relative '../constants'
 
 class VWO
   module Utils
@@ -59,6 +62,87 @@ class VWO
       def valid_basic_data_type?(val)
         valid_number?(val) || valid_string?(val) || valid_boolean?(val)
       end
+
+      # Validates if the value passed batch_events has correct data type and values or not.
+      #
+      # Args: batch_events [Hash]: value to be tested
+      #
+      # @return: [Boolean]: True if all conditions are passed else False
+      def is_valid_batch_event_settings(batch_events)
+        logger = VWO::Logger.get_instance
+        events_per_request = batch_events[:events_per_request]
+        request_time_interval = batch_events[:request_time_interval]
+
+        unless events_per_request || request_time_interval
+          logger.log(
+            VWO::LogLevelEnum::ERROR,
+            format(
+              VWO::LogMessageEnum::ErrorMessages::EVENT_BATCHING_INSUFFICIENT,
+              file: VWO::FileNameEnum::ValidateUtil
+            )
+          )
+          return false
+        end
+
+        if (request_time_interval && !valid_number?(request_time_interval))
+          logger.log(
+            VWO::LogLevelEnum::ERROR,
+            format(
+              VWO::LogMessageEnum::ErrorMessages::REQUEST_TIME_INTERVAL_INVALID,
+              file: VWO::FileNameEnum::ValidateUtil
+            )
+          )
+          return false
+        end
+
+        if (events_per_request && !valid_number?(events_per_request))
+          logger.log(
+            VWO::LogLevelEnum::ERROR,
+            format(
+              VWO::LogMessageEnum::ErrorMessages::EVENTS_PER_REQUEST_INVALID,
+              file: VWO::FileNameEnum::ValidateUtil
+            )
+          )
+          return false
+        end
+
+        if events_per_request && (events_per_request < VWO::MIN_EVENTS_PER_REQUEST || events_per_request > VWO::MAX_EVENTS_PER_REQUEST)
+          logger.log(
+            VWO::LogLevelEnum::ERROR,
+            format(
+              VWO::LogMessageEnum::ErrorMessages::EVENTS_PER_REQUEST_OUT_OF_BOUNDS,
+              file: VWO::FileNameEnum::ValidateUtil,
+              min_value: VWO::MIN_EVENTS_PER_REQUEST,
+              max_value: VWO::MAX_EVENTS_PER_REQUEST
+            )
+          )
+          return false
+        end
+
+        if request_time_interval && request_time_interval < VWO::MIN_REQUEST_TIME_INTERVAL
+          logger.log(
+            VWO::LogLevelEnum::ERROR,
+            format(
+              VWO::LogMessageEnum::ErrorMessages::REQUEST_TIME_INTERVAL_OUT_OF_BOUNDS,
+              file: VWO::FileNameEnum::ValidateUtil,
+              min_value: VWO::MIN_REQUEST_TIME_INTERVAL
+            )
+          )
+          return false
+        end
+
+        if batch_events.key?(:flushCallback) && !batch_events[:flushCallback].is_a?(Method)
+          logger.log(
+            VWO::LogLevelEnum::ERROR,
+            format(
+              VWO::LogMessageEnum::ErrorMessages::FLUSH_CALLBACK_INVALID,
+              file: VWO::FileNameEnum::ValidateUtil
+            )
+          )
+          return false
+        end
+        true
+      end
     end
   end
 end