vwo-sdk 1.38.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0e08961757aa3ab300766b7c2fd27429d0c3edb97c8e2609d3b41fb8e9b3362
-  data.tar.gz: dda836f16065c27aed8102c2e7f666b47645c20fe38c9830c02f0c9c1a32b959
+  metadata.gz: 3ad81c9f35c3bc9861b2b50ada2572381fcbf28d154087332cfcd161c50245e8
+  data.tar.gz: e1b4c2b51b2b483134d99f13189d01065b9dc8bbbd21c8fd419bd49f2b88dcae
 SHA512:
-  metadata.gz: cd96894eaf16020bddfc7246ee287ae7dbaaa9df40e9dc17ec09b0af31379a05a6d1b682665599f4f45d495ceecd5c66409cb753c7f4e59dd72d25e9037e3ef2
-  data.tar.gz: 56a9930a525ed16aab574920cffe787da6b2ecf8225d0a8bf03edea1ab67b331e433537da35af6b70715787c61abc132e9b04b032da1950a0bc39af085c9fce2
+  metadata.gz: 3be9f5a83e3f47cc67085ca4ae55414b4c6ab667d5d4e2e3089bffa1858258b11cc6c619687c82a29ec05e22aafa6e9e01cc5446fa7433d75a68c7ee46b39abf
+  data.tar.gz: a2f569868697c7b07215c300e2cfe304b80469ade7b38ba2853492359652e6f465c26428bce8faf6744659c5eaaf6eb2adf57af5c6ade7ff50f481466e7f8ddd

data/lib/vwo/constants.rb

@@ -27,7 +27,7 @@ class VWO
     HTTP_PROTOCOL = 'http://'
     HTTPS_PROTOCOL = 'https://'
     URL_NAMESPACE = '6ba7b811-9dad-11d1-80b4-00c04fd430c8'
-    SDK_VERSION = '1.38.0'
+    SDK_VERSION = '1.40.0'
     SDK_NAME = 'ruby'
     VWO_DELIMITER = '_vwo_'
     MAX_EVENTS_PER_REQUEST = 5000

data/lib/vwo/services/event_dispatcher.rb

@@ -88,11 +88,11 @@ class VWO
         false
       end
 
-      def dispatch_event_arch_post(params, post_data)
+      def dispatch_event_arch_post(params, post_data, options = {})
         return true if @is_development_mode
 
         url = HTTPS_PROTOCOL + get_url(ENDPOINTS::EVENTS)
-        resp = VWO::Utils::Request.event_post(url, params, post_data, SDK_NAME)
+        resp = VWO::Utils::Request.event_post(url, params, post_data, SDK_NAME, options)
         if resp.code == '200'
           @logger.log(
             LogLevelEnum::INFO,

data/lib/vwo/utils/impression.rb

@@ -125,7 +125,7 @@ class VWO
       #
       # @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)
+      def create_bulk_event_impression(settings_file, campaign_id, variation_id, user_id, goal_id = nil, revenue = nil, event_properties = {} ,options = {})
         return unless valid_number?(campaign_id) && valid_string?(user_id)
 
         is_track_user_api = true
@@ -139,6 +139,15 @@ class VWO
           sId: get_current_unix_timestamp
         }
 
+        # Check if user_agent is provided
+        if options[:user_agent]
+          impression['visitor_ua'] = options[:user_agent]
+        end
+        # Check if user_ip_address is provided
+        if options[:user_ip_address]
+          impression['visitor_ip'] = options[:user_ip_address]
+        end
+
         if is_track_user_api
           Logger.log(
             LogLevelEnum::DEBUG,
@@ -151,6 +160,11 @@ class VWO
         else
           impression['g'] = goal_id
           impression['r'] = revenue if revenue
+
+          if settings_file.key?('isEventArchEnabled') && settings_file['isEventArchEnabled']
+            impression['eventProps'] = event_properties
+          end
+
           Logger.log(
             LogLevelEnum::DEBUG,
             'IMPRESSION_FOR_TRACK_GOAL',
@@ -198,13 +212,9 @@ class VWO
         sdk_key = settings_file['sdkKey']
 
         props = {
-          sdkName: SDK_NAME,
-          sdkVersion: SDK_VERSION,
-          '$visitor': {
-            props: {
-              vwo_fs_environment: sdk_key
-            }
-          }
+          vwo_sdkName: SDK_NAME,
+          vwo_sdkVersion: SDK_VERSION,
+
         }
 
         # if usage_stats
@@ -213,7 +223,7 @@ class VWO
 
         {
           d: {
-            msgId: "#{uuid} + '_' + #{Time.now.to_i}",
+            msgId: "#{uuid}-#{get_current_unix_timestamp_in_millis}",
             visId: uuid,
             sessionId: Time.now.to_i,
             event: {
@@ -269,10 +279,11 @@ class VWO
       # @param[Integer]                :revenue_value
       # @param[Hash]                   :metric_map
       # @param[Array]                  :revenue_props
+      # @param[Hash] :properties associated with the event.
       #
       # @return[Hash]                  :properties
       #
-      def get_track_goal_payload_data(settings_file, user_id, event_name, revenue_value, metric_map, revenue_props = [])
+      def get_track_goal_payload_data(settings_file, user_id, event_name, revenue_value, metric_map, revenue_props = [], event_properties)
         properties = get_event_base_payload(settings_file, user_id, event_name)
 
         metric = {}
@@ -302,6 +313,13 @@ class VWO
         end
 
         properties[:d][:event][:props][:isCustomEvent] = true
+
+        if event_properties && event_properties.any?
+          event_properties.each do |prop, value|
+            properties[:d][:event][:props][prop] = value
+          end
+        end
+
         properties
       end
 
@@ -319,7 +337,7 @@ class VWO
         properties[:d][:event][:props][:isCustomEvent] = true
 
         custom_dimension_map.each do |tag_key, tag_value|
-          properties[:d][:event][:props][('$visitor'.to_sym)][:props][tag_key] = tag_value
+          properties[:d][:event][:props][tag_key] = tag_value
           properties[:d][:visitor][:props][tag_key] = tag_value
         end
 

data/lib/vwo/utils/request.rb

@@ -25,7 +25,7 @@ class VWO
         Net::HTTP.get_response(uri)
       end
 
-      def self.post(url, params, post_data)
+      def self.post(url, params, post_data, options = {})
         uri = URI.parse(url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
@@ -35,10 +35,18 @@ class VWO
           'Content-Type' => 'application/json',
           'Accept' => 'application/json'
         }
+        # Check if user_agent is provided
+        if options[:user_agent]
+          headers['X-Device-User-Agent'] = options[:user_agent]
+        end
+        # Check if user_ip_address is provided
+        if options[:user_ip_address]
+          headers['VWO-X-Forwarded-For'] = options[:user_ip_address]
+        end
         http.post(uri, post_data.to_json, headers)
       end
 
-      def self.event_post(url, params, post_data, user_agent_value)
+      def self.event_post(url, params, post_data, user_agent_value, options = {})
         uri = URI.parse(url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
@@ -48,6 +56,14 @@ class VWO
           'Content-Type' => 'application/json',
           'Accept' => 'application/json'
         }
+        # Check if user_agent is provided
+        if options[:user_agent]
+          headers['X-Device-User-Agent'] = options[:user_agent]
+        end
+        # Check if user_ip_address is provided
+        if options[:user_ip_address]
+          headers['VWO-X-Forwarded-For'] = options[:user_ip_address]
+        end
         http.post(uri, post_data.to_json, headers)
       end
     end

data/lib/vwo/utils/validations.rb

@@ -153,7 +153,7 @@ class VWO
         )
       end
 
-      def valid_goal?(goal, campaign, user_id, goal_identifier, revenue_value)
+      def valid_goal?(goal, campaign, user_id, goal_identifier, revenue_value, is_event_arch_enabled)
         if goal.nil? || !goal['id']
           Logger.log(
             LogLevelEnum::ERROR,
@@ -166,7 +166,7 @@ class VWO
             }
           )
           return false
-        elsif goal['type'] == GoalTypes::REVENUE && !valid_value?(revenue_value)
+        elsif goal['type'] == GoalTypes::REVENUE && !valid_value?(revenue_value) && !is_event_arch_enabled
           Logger.log(
             LogLevelEnum::ERROR,
             'TRACK_API_REVENUE_NOT_PASSED_FOR_REVENUE_GOAL',

data/lib/vwo.rb

@@ -365,13 +365,14 @@ class VWO
           @settings_file,
           campaign['id'],
           variation['id'],
-          user_id
+          user_id, nil, nil, nil,
+          options
         )
         @batch_events_queue.enqueue(impression)
       elsif event_arch_enabled?
         properties = get_events_base_properties(@settings_file, EventEnum::VWO_VARIATION_SHOWN, @usage_stats.usage_stats)
         payload = get_track_user_payload_data(@settings_file, user_id, EventEnum::VWO_VARIATION_SHOWN, campaign['id'], variation['id'])
-        @event_dispatcher.dispatch_event_arch_post(properties, payload)
+        @event_dispatcher.dispatch_event_arch_post(properties, payload, options)
       else
         # Variation found, dispatch it to server
         impression = create_impression(
@@ -565,6 +566,7 @@ class VWO
     revenue_value = options[:revenue_value]
     custom_variables = options[:custom_variables]
     variation_targeting_variables = options[:variation_targeting_variables]
+    event_properties = options[:event_properties]
     goal_type_to_track = get_goal_type_to_track(options)
 
     # Check for valid args
@@ -591,7 +593,7 @@ class VWO
 
         if variation
           goal = get_campaign_goal(campaign, goal_identifier)
-          next unless valid_goal?(goal, campaign, user_id, goal_identifier, revenue_value)
+          next unless valid_goal?(goal, campaign, user_id, goal_identifier, revenue_value, event_arch_enabled?)
 
           revenue_value = nil if goal['type'] == GoalTypes::CUSTOM
           identifiers = get_variation_identifiers(variation)
@@ -601,8 +603,55 @@ class VWO
           @variation_decider.update_goal_identifier(user_id, campaign, variation, goal_identifier)
           # set variation at user storage
 
+          if goal['type'] == GoalTypes::REVENUE && revenue_value.nil?
+            # mca implementation
+            if event_arch_enabled?
+              if goal['mca'] != -1
+                # Check if eventProperties contain revenueProp for mca != -1
+                if event_properties.nil?
+                # Log error if revenueProp is not found in eventProperties
+                  @logger.log(
+                    LogLevelEnum::ERROR,
+                    'Revenue property not found in event properties for revenue goal',
+                    {
+                      '{file}' => FILE,
+                      '{api}' => ApiMethods::TRACK,
+                      '{userId}' => user_id,
+                      '{goalIdentifier}' => goal_identifier,
+                      '{campaignKey}' => campaign['key']
+                    }
+                  )
+                  result[campaign['key']] = false
+                  next
+                end
+              elsif goal['type'] == GoalTypes::REVENUE && goal['mca'] == -1
+                # Check if revenueProp is defined but not found in eventProperties
+                if goal['revenueProp'] && event_properties.nil?
+                  # Log error if revenueProp is defined but not found in eventProperties
+                  @logger.log(
+                    LogLevelEnum::ERROR,
+                    'Revenue property defined but not found in event properties for revenue goal',
+                    {
+                      '{file}' => FILE,
+                      '{api}' => ApiMethods::TRACK,
+                      '{userId}' => user_id,
+                      '{goalIdentifier}' => goal_identifier,
+                      '{campaignKey}' => campaign['key']
+                    }
+                  )
+                  result[campaign['key']] = false
+                  next
+                end
+              end
+            end
+          end
           if defined?(@batch_events)
-            impression = create_bulk_event_impression(@settings_file, campaign['id'], variation['id'], user_id, goal['id'], revenue_value)
+            if event_arch_enabled?
+              if goal['type'] == GoalTypes::REVENUE && goal['revenueProp'] && event_properties && event_properties.key?(goal['revenueProp'])
+                revenue_value = event_properties[goal['revenueProp']]
+              end
+            end
+            impression = create_bulk_event_impression(@settings_file, campaign['id'], variation['id'], user_id, goal['id'], revenue_value, event_properties, options)
             @batch_events_queue.enqueue(impression)
           elsif event_arch_enabled?
             metric_map[campaign['id']] = goal['id']
@@ -612,7 +661,7 @@ class VWO
             main_keys = { 'campaignId' => campaign['id'], 'variationId' => variation['id'], 'goalId' => goal['id'] }
             @event_dispatcher.dispatch(impression, main_keys, EVENTS::TRACK_GOAL)
           else
-            batch_event_data['ev'] << create_bulk_event_impression(@settings_file, campaign['id'], variation['id'], user_id, goal['id'], revenue_value)
+            batch_event_data['ev'] << create_bulk_event_impression(@settings_file, campaign['id'], variation['id'], user_id, goal['id'], revenue_value, nil, options)
           end
           result[campaign['key']] = true
           next
@@ -631,8 +680,8 @@ class VWO
 
     if event_arch_enabled?
       properties = get_events_base_properties(@settings_file, goal_identifier)
-      payload = get_track_goal_payload_data(@settings_file, user_id, goal_identifier, revenue_value, metric_map, revenue_props)
-      @event_dispatcher.dispatch_event_arch_post(properties, payload)
+      payload = get_track_goal_payload_data(@settings_file, user_id, goal_identifier, revenue_value, metric_map, revenue_props, event_properties)
+      @event_dispatcher.dispatch_event_arch_post(properties, payload, options)
     elsif batch_event_data['ev'].count != 0
       paramters = get_batch_event_query_params(@settings_file['accountId'], @sdk_key, @usage_stats.usage_stats)
       batch_events_dispatcher = VWO::Services::BatchEventsDispatcher.new(@is_development_mode)
@@ -751,13 +800,14 @@ class VWO
           @settings_file,
           campaign['id'],
           variation['id'],
-          user_id
+          user_id, nil, nil, nil,
+          options
         )
         @batch_events_queue.enqueue(impression)
       elsif event_arch_enabled?
         properties = get_events_base_properties(@settings_file, EventEnum::VWO_VARIATION_SHOWN, @usage_stats.usage_stats)
         payload = get_track_user_payload_data(@settings_file, user_id, EventEnum::VWO_VARIATION_SHOWN, campaign['id'], variation['id'])
-        @event_dispatcher.dispatch_event_arch_post(properties, payload)
+        @event_dispatcher.dispatch_event_arch_post(properties, payload, options)
       else
         impression = create_impression(
           @settings_file,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.38.0
+  version: 1.40.0
 platform: ruby
 authors:
 - VWO
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -139,7 +139,7 @@ metadata:
   documentation_uri: https://developers.vwo.com/docs/ruby-sdk-reference
   homepage_uri: https://github.com/wingify/vwo-ruby-sdk
   source_code_uri: https://github.com/wingify/vwo-ruby-sdk
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby SDK for VWO FullStack testing
 test_files: []