vwo-sdk 1.3.0 → 1.14.1

data/lib/vwo/utils/custom_dimensions.rb

@@ -0,0 +1,72 @@
+# 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 'json'
+require_relative '../logger'
+require_relative '../enums'
+require_relative '../constants'
+require_relative './impression'
+
+# Utility module for helper math and random functions
+class VWO
+  module Utils
+    module CustomDimensions
+      include VWO::CONSTANTS
+      include VWO::Enums
+      include VWO::Utils::Impression
+
+      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), '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,
+          format(
+            LogMessageEnum::DebugMessages::PARAMS_FOR_PUSH_CALL,
+            file: FileNameEnum::CustomDimensionsUtil,
+            properties: JSON.generate(params)
+          )
+        )
+        params
+      end
+    end
+  end
+end

data/lib/vwo/utils/feature.rb

@@ -0,0 +1,56 @@
+# 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 '../constants'
+
+# Utility module for helper math and random functions
+class VWO
+  module Utils
+    module Feature
+      include VWO::CONSTANTS
+      include VWO::Enums
+
+      # Returns type casted value to given value type if possible.
+      # @param[Number|String|Boolean]       :value              Value to type cast
+      # @param[Type]                        :variable_type      Type to which value needs to be casted
+      # @return[any]                                            Type casted value if value can be type-casted
+      def get_type_casted_feature_value(value, variable_type)
+        # Check if type(value) is already equal to required variable_type
+        return value if RUBY_VARIABLE_TYPES[variable_type].include?(value.class)
+
+        return value.to_s if variable_type == VariableTypes::STRING
+
+        return value.to_i if variable_type == VariableTypes::INTEGER
+
+        return value.to_f if variable_type == VariableTypes::DOUBLE
+
+        return !value || value == 0 ? false : true if variable_type == VariableTypes.BOOLEAN
+      rescue StandardError => _e
+        VWO::Logger.get_instance.log(
+          LogLevelEnum::ERROR,
+          format(
+            LogMessageEnum::ErrorMessages::UNABLE_TO_TYPE_CAST,
+            file: FileNameEnum::FeatureUtil,
+            value: value,
+            variable_type: variable_type,
+            of_type: value.class.name
+          )
+        )
+        nil
+      end
+    end
+  end
+end

data/lib/vwo/utils/function.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'
@@ -34,6 +32,11 @@ class VWO
       def get_current_unix_timestamp
         Time.now.to_i
       end
+
+      # @return[any, any]
+      def get_key_value(obj)
+        [obj.keys[0], obj.values[0]]
+      end
     end
   end
 end

data/lib/vwo/utils/impression.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'
 require 'cgi'
 require_relative '../logger'
@@ -33,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
@@ -53,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
 
@@ -93,6 +94,74 @@ class VWO
         end
         impression
       end
+
+      # Returns commonly used params for making requests to our servers.
+      #
+      # @param[String]                :user_id                Unique identification of user
+      # @param[String]                :settings_file          Settings file containing campaign data for extracting account_id
+      # @return[Hash]                                         Commonly used params for making call to our servers
+      #
+      def get_common_properties(user_id, settings_file)
+        account_id = settings_file['accountId']
+        {
+          'random' => get_random_number,
+          'sdk' => SDK_NAME,
+          'sdk-v' => SDK_VERSION,
+          'ap' => PLATFORM,
+          'sId' => get_current_unix_timestamp,
+          'u' => generator_for(user_id, account_id),
+          '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
 end

data/lib/vwo/utils/request.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 'net/http'
 
 class VWO
@@ -26,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

@@ -0,0 +1,116 @@
+# 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 '../enums'
+
+# Utility module for helper math and random functions
+class VWO
+  module Utils
+    module Segment
+      GROUPING_PATTERN = /^(.+?)\((.*)\)/
+      WILDCARD_PATTERN = /(^\*|^)(.+?)(\*$|$)/
+      include VWO::Enums
+
+      # Extracts true values represented in the args, and returns stringified value of it
+      #
+      # @param [String]             :operator_value                 operand/dsl leaf value
+      # @param [String|Number]      :custom_variables_value         custom_variables value
+      # @return [[String, String]]  tuple of str value of operator_value, custom_variables_value converted
+      #                             into their true types
+      def convert_to_true_types(operator_value, custom_variables_value)
+        # This is atomic, either both values will be processed or none
+        begin
+          true_type_operator_value = Kernel::Float(operator_value)
+          true_type_custom_variables_value = Kernel::Float(custom_variables_value)
+        rescue StandardError => _e
+          return operator_value, custom_variables_value
+        end
+        # Now both are float, So, convert them independently to int type if they are int rather than floats
+        true_type_operator_value = true_type_operator_value.to_i if true_type_operator_value == true_type_operator_value.floor
+
+        true_type_custom_variables_value = true_type_custom_variables_value.to_i if true_type_custom_variables_value == true_type_custom_variables_value.floor
+
+        # Convert them back to string and return
+        [true_type_operator_value.to_s, true_type_custom_variables_value.to_s]
+      end
+
+      # Extract the operand_type, ie. lower, wildcard, regex or equals
+      #
+      # @param[String]        :operand    string value from leaf_node of dsl
+      # @return [[String, String]]        tuple of operand value and operand type
+      #
+      def separate_operand(operand)
+        groups = GROUPING_PATTERN.match(operand)
+        return groups[1..2] if groups
+
+        [OperandValueTypesName::EQUALS, operand]
+      end
+
+      # Processes the value from the custom_variables_variables
+      # @param[String|Number|Boolean|nil]   :custom_variables_value  the custom_variables_value provided inside custom_variables
+      #
+      # @return [String]                                             stringified value of processed custom_variables_value
+      #
+      def process_custom_variables_value(custom_variables_value)
+        return '' if custom_variables_value.nil?
+
+        if custom_variables_value.is_a?(TrueClass) || custom_variables_value.is_a?(FalseClass)
+          custom_variables_value = custom_variables_value ? OperandValuesBooleanTypes::TRUE : OperandValuesBooleanTypes::FALSE
+        end
+        custom_variables_value.to_s
+      end
+
+      # Extracts operand_type and operand_value from the leaf_node/operand
+      # @param[String]    :operand                   String value from the leaf_node
+      # @return[[String, String]]                    Tuple of defined operand_types and operand_value
+      #
+      def process_operand_value(operand)
+        # Separate the operand type and value inside the bracket
+
+        operand_type_name, operand_value = separate_operand(operand)
+
+        # Enum the operand type, here lower, regex, and equals will be identified
+        operand_type =
+          begin
+            VWO::Enums::OperandValueTypesName.const_get(operand_type_name.upcase)
+          rescue StandardError => _e
+            nil
+          end
+
+        # In case of wildcard, the operand type is further divided into contains, startswith and endswith
+        if operand_type_name == OperandValueTypesName::WILDCARD
+          starting_star, operand_value, ending_star = WILDCARD_PATTERN.match(operand_value)[1..3]
+          operand_type =
+            if starting_star.to_s.length > 0 && ending_star.to_s.length > 0
+              OperandValueTypes::CONTAINS
+            elsif starting_star.to_s.length > 0
+              OperandValueTypes::STARTS_WITH
+            elsif ending_star.to_s.length > 0
+              OperandValueTypes::ENDS_WITH
+            else
+              OperandValueTypes::EQUALS
+            end
+        end
+
+        # In case there is an abnormal patter, it would have passed all the above if cases, which means it
+        # should be equals, so set the whole operand as operand value and operand type as equals
+        if operand_type.nil?
+          operand_type = OperandValueTypes::EQUALS
+          operand_value = operand
+        end
+        [operand_type, operand_value]
+      end
+    end
+  end
+end

data/lib/vwo/utils/uuid.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 'digest'
 require_relative '../logger'
 require_relative '../enums'
@@ -44,9 +42,9 @@ class VWO
         ary = hash.digest.unpack('NnnnnN')
         ary[2] = (ary[2] & 0x0FFF) | (version << 12)
         ary[3] = (ary[3] & 0x3FFF) | 0x8000
-        # rubocop:disable Lint/FormatString
+        # rubocop:disable Lint/FormatStringToken,Style/FormatString
         '%08x-%04x-%04x-%04x-%04x%08x' % ary
-        # rubocop:enable Lint/FormatString
+        # rubocop:enable Lint/FormatStringToken,Style/FormatString
       end
 
       VWO_NAMESPACE = uuid_v5(URL_NAMESPACE, 'https://vwo.com')