vwo-sdk 1.14.1 → 1.23.0

data/lib/vwo.rb

@@ -23,6 +23,7 @@ require_relative 'vwo/utils/campaign'
 require_relative 'vwo/utils/impression'
 require_relative 'vwo/utils/feature'
 require_relative 'vwo/utils/custom_dimensions'
+require_relative 'vwo/utils/utility'
 require_relative 'vwo/constants'
 require_relative 'vwo/core/variation_decider'
 require_relative 'vwo/services/batch_events_dispatcher'
@@ -39,6 +40,7 @@ class VWO
   include Utils::CustomDimensions
   include Utils::Campaign
   include Utils::Impression
+  include Utils::Utility
   include CONSTANTS
 
   FILE = FileNameEnum::VWO
@@ -62,6 +64,7 @@ class VWO
     settings_file = nil,
     options = {}
   )
+    options = convert_to_symbol_hash(options)
     @account_id = account_id
     @sdk_key = sdk_key
     @user_storage = user_storage
@@ -295,9 +298,10 @@ class VWO
       return
     end
 
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    custom_variables = options[:custom_variables]
+    variation_targeting_variables = options[:variation_targeting_variables]
 
     should_track_returning_user = get_should_track_returning_user(options)
     # Validate input parameters
@@ -413,7 +417,6 @@ class VWO
           )
         end
       end
-      variation['name']
     else
       @logger.log(
         LogLevelEnum::INFO,
@@ -425,8 +428,8 @@ class VWO
           api_name: ApiMethods::ACTIVATE
         )
       )
-      nil
     end
+    variation['name']
   rescue StandardError => e
     @logger.log(
       LogLevelEnum::ERROR,
@@ -437,7 +440,7 @@ class VWO
         exception: e
       )
     )
-    nil
+    e
   end
 
   # This API method: Gets the variation name assigned for the
@@ -469,9 +472,10 @@ class VWO
       )
       return
     end
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    custom_variables = options[:custom_variables]
+    variation_targeting_variables = options[:variation_targeting_variables]
 
     # Validate input parameters
     unless valid_string?(campaign_key) && valid_string?(user_id) && (custom_variables.nil? || valid_hash?(custom_variables)) &&
@@ -580,9 +584,10 @@ class VWO
       return false
     end
 
-    revenue_value = options['revenue_value'] || options[:revenue_value]
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    options = convert_to_symbol_hash(options)
+    revenue_value = options[:revenue_value]
+    custom_variables = options[:custom_variables]
+    variation_targeting_variables = options[:variation_targeting_variables]
     should_track_returning_user = get_should_track_returning_user(options)
     goal_type_to_track = get_goal_type_to_track(options)
 
@@ -611,147 +616,149 @@ class VWO
 
     result = {}
     campaigns.each do |campaign|
-      campaign_type = campaign['type']
+      begin
+        campaign_type = campaign['type']
 
-      if campaign_type == CampaignTypes::FEATURE_ROLLOUT
-        @logger.log(
-          LogLevelEnum::ERROR,
-          format(
-            LogMessageEnum::ErrorMessages::INVALID_API,
-            file: FILE,
-            api_name: ApiMethods::TRACK,
-            user_id: user_id,
-            campaign_key: campaign['key'],
-            campaign_type: campaign_type
-          )
-        )
-        result[campaign['key']] = false
-        next
-      end
-
-      variation = @variation_decider.get_variation(user_id, campaign, ApiMethods::TRACK, campaign['key'], custom_variables, variation_targeting_variables, goal_identifier)
-
-      if variation
-        goal = get_campaign_goal(campaign, goal_identifier)
-        if goal.nil? || !goal["id"]
+        if campaign_type == CampaignTypes::FEATURE_ROLLOUT
           @logger.log(
             LogLevelEnum::ERROR,
             format(
-              LogMessageEnum::ErrorMessages::TRACK_API_GOAL_NOT_FOUND,
+              LogMessageEnum::ErrorMessages::INVALID_API,
               file: FILE,
-              goal_identifier: goal_identifier,
+              api_name: ApiMethods::TRACK,
               user_id: user_id,
               campaign_key: campaign['key'],
-              api_name: ApiMethods::TRACK
+              campaign_type: campaign_type
             )
           )
           result[campaign['key']] = false
           next
-        elsif goal['type'] == GoalTypes::REVENUE && !valid_value?(revenue_value)
-          @logger.log(
-            LogLevelEnum::ERROR,
-            format(
-              LogMessageEnum::ErrorMessages::TRACK_API_REVENUE_NOT_PASSED_FOR_REVENUE_GOAL,
-              file: FILE,
-              user_id: user_id,
-              goal_identifier: goal_identifier,
-              campaign_key: campaign['key'],
-              api_name: ApiMethods::TRACK
-            )
-          )
-          result[campaign['key']] = false
-          next
-        elsif goal['type'] == GoalTypes::CUSTOM
-          revenue_value = nil
         end
 
-        if variation['goal_identifier']
-          identifiers = variation['goal_identifier'].split(VWO_DELIMITER)
-        else
-          variation['goal_identifier'] = ''
-          identifiers = []
-        end
+        variation = @variation_decider.get_variation(user_id, campaign, ApiMethods::TRACK, campaign['key'], custom_variables, variation_targeting_variables, goal_identifier)
 
-        if !identifiers.include? goal_identifier
-          updated_goal_identifier = variation['goal_identifier']
-          updated_goal_identifier += VWO_DELIMITER + goal_identifier
-          @variation_decider.save_user_storage(user_id, campaign['key'], variation['name'], updated_goal_identifier) if variation['name']
-          # set variation at user storage
-        elsif !should_track_returning_user
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::GOAL_ALREADY_TRACKED,
-              file: FILE,
-              user_id: user_id,
-              campaign_key: campaign['key'],
-              goal_identifier: goal_identifier,
-              api_name: ApiMethods::TRACK
+        if variation
+          goal = get_campaign_goal(campaign, goal_identifier)
+          if goal.nil? || !goal["id"]
+            @logger.log(
+              LogLevelEnum::ERROR,
+              format(
+                LogMessageEnum::ErrorMessages::TRACK_API_GOAL_NOT_FOUND,
+                file: FILE,
+                goal_identifier: goal_identifier,
+                user_id: user_id,
+                campaign_key: campaign['key'],
+                api_name: ApiMethods::TRACK
+              )
             )
-          )
-          result[campaign['key']] = false
-          next
-        end
-
-        if defined?(@batch_events)
-          impression = create_bulk_event_impression(
-            @settings_file,
-            campaign['id'],
-            variation['id'],
-            user_id,
-            goal['id'],
-            revenue_value
-          )
-          @batch_events_queue.enqueue(impression)
-        else
-          impression = create_impression(
-            @settings_file,
-            campaign['id'],
-            variation['id'],
-            user_id,
-            @sdk_key,
-            goal['id'],
-            revenue_value
-          )
-          if @event_dispatcher.dispatch(impression)
+            result[campaign['key']] = false
+            next
+          elsif goal['type'] == GoalTypes::REVENUE && !valid_value?(revenue_value)
             @logger.log(
-              LogLevelEnum::INFO,
+              LogLevelEnum::ERROR,
               format(
-                LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS,
+                LogMessageEnum::ErrorMessages::TRACK_API_REVENUE_NOT_PASSED_FOR_REVENUE_GOAL,
                 file: FILE,
-                sdk_key: @sdk_key,
-                account_id: @account_id,
-                campaign_id: campaign['id'],
-                variation_id: variation['id'],
-                end_point: EVENTS::TRACK_GOAL
+                user_id: user_id,
+                goal_identifier: goal_identifier,
+                campaign_key: campaign['key'],
+                api_name: ApiMethods::TRACK
               )
             )
+            result[campaign['key']] = false
+            next
+          elsif goal['type'] == GoalTypes::CUSTOM
+            revenue_value = nil
+          end
+
+          if variation['goal_identifier']
+            identifiers = variation['goal_identifier'].split(VWO_DELIMITER)
+          else
+            variation['goal_identifier'] = ''
+            identifiers = []
+          end
+
+          if !identifiers.include? goal_identifier
+            updated_goal_identifier = variation['goal_identifier']
+            updated_goal_identifier += VWO_DELIMITER + goal_identifier
+            @variation_decider.save_user_storage(user_id, campaign['key'], campaign['name'], variation['name'], updated_goal_identifier) if variation['name']
+            # set variation at user storage
+          elsif !should_track_returning_user
             @logger.log(
               LogLevelEnum::INFO,
               format(
-                LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_IMPRESSION,
+                LogMessageEnum::InfoMessages::GOAL_ALREADY_TRACKED,
                 file: FILE,
-                sdk_key: @sdk_key,
-                campaign_id: impression[:experiment_id],
-                account_id: impression[:account_id],
-                variation_id: impression[:combination]
+                user_id: user_id,
+                campaign_key: campaign['key'],
+                goal_identifier: goal_identifier,
+                api_name: ApiMethods::TRACK
               )
             )
+            result[campaign['key']] = false
+            next
           end
+
+          if defined?(@batch_events)
+            impression = create_bulk_event_impression(
+              @settings_file,
+              campaign['id'],
+              variation['id'],
+              user_id,
+              goal['id'],
+              revenue_value
+            )
+            @batch_events_queue.enqueue(impression)
+          else
+            impression = create_impression(
+              @settings_file,
+              campaign['id'],
+              variation['id'],
+              user_id,
+              @sdk_key,
+              goal['id'],
+              revenue_value
+            )
+            if @event_dispatcher.dispatch(impression)
+              @logger.log(
+                LogLevelEnum::INFO,
+                format(
+                  LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS,
+                  file: FILE,
+                  sdk_key: @sdk_key,
+                  account_id: @account_id,
+                  campaign_id: campaign['id'],
+                  variation_id: variation['id'],
+                  end_point: EVENTS::TRACK_GOAL
+                )
+              )
+              @logger.log(
+                LogLevelEnum::INFO,
+                format(
+                  LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_IMPRESSION,
+                  file: FILE,
+                  sdk_key: @sdk_key,
+                  campaign_id: impression[:experiment_id],
+                  account_id: impression[:account_id],
+                  variation_id: impression[:combination]
+                )
+              )
+            end
+          end
+          result[campaign['key']] = true
+          next
         end
-        result[campaign['key']] = true
-        next
-      end
-      result[campaign['key']] = false
-    rescue StandardError => e
-      @logger.log(
-        LogLevelEnum::ERROR,
-        format(
-          e.message,
-          file: FILE,
-          exception: e
+        result[campaign['key']] = false
+      rescue StandardError => e
+        @logger.log(
+          LogLevelEnum::ERROR,
+          format(
+            e.message,
+            file: FILE,
+            exception: e
+          )
         )
-      )
+      end
     end
 
     if result.length() == 0
@@ -798,9 +805,10 @@ class VWO
       return false
     end
 
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    custom_variables = options[:custom_variables]
+    variation_targeting_variables = options[:variation_targeting_variables]
     should_track_returning_user = get_should_track_returning_user(options)
     @logger.log(
       LogLevelEnum::INFO,
@@ -868,80 +876,85 @@ class VWO
     return false unless variation
 
     # if campaign type is feature_test Send track call to server
-    if campaign_type == CampaignTypes::FEATURE_TEST
-      if is_eligible_to_send_impression(should_track_returning_user)
-        if defined?(@batch_events)
-          impression = create_bulk_event_impression(
-            @settings_file,
-            campaign['id'],
-            variation['id'],
-            user_id
-          )
-          @batch_events_queue.enqueue(impression)
-        else
-          impression = create_impression(
-            @settings_file,
-            campaign['id'],
-            variation['id'],
-            user_id,
-            @sdk_key,
-            goal_id: nil,
-            revenue: nil,
-            usage_stats: @usage_stats.usage_stats
-          )
 
-          @event_dispatcher.dispatch(impression)
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_IMPRESSION,
-              file: FILE,
-              campaign_id: impression[:experiment_id],
-              sdk_key: @sdk_key,
-              account_id: impression[:account_id],
-              variation_id: impression[:combination]
-            )
-          )
-        end
-        result = variation['isFeatureEnabled']
-        if result
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::FEATURE_ENABLED_FOR_USER,
-              file: FILE,
-              user_id: user_id,
-              feature_key: campaign_key,
-              api_name: ApiMethods::IS_FEATURE_ENABLED
-            )
-          )
-        else
-          @logger.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::FEATURE_NOT_ENABLED_FOR_USER,
-              file: FILE,
-              user_id: user_id,
-              feature_key: campaign_key,
-              api_name: ApiMethods::IS_FEATURE_ENABLED
-            )
-          )
-        end
-        return result
+    if is_eligible_to_send_impression(should_track_returning_user)
+      if defined?(@batch_events)
+        impression = create_bulk_event_impression(
+          @settings_file,
+          campaign['id'],
+          variation['id'],
+          user_id
+        )
+        @batch_events_queue.enqueue(impression)
       else
+        impression = create_impression(
+          @settings_file,
+          campaign['id'],
+          variation['id'],
+          user_id,
+          @sdk_key,
+          nil,
+          nil,
+          usage_stats: @usage_stats.usage_stats
+        )
+
+        @event_dispatcher.dispatch(impression)
         @logger.log(
           LogLevelEnum::INFO,
           format(
-            LogMessageEnum::InfoMessages::USER_ALREADY_TRACKED,
+            LogMessageEnum::InfoMessages::MAIN_KEYS_FOR_IMPRESSION,
             file: FILE,
-            user_id: user_id,
-            campaign_key: campaign_key,
-            api_name: ApiMethods::IS_FEATURE_ENABLED
+            campaign_id: impression[:experiment_id],
+            sdk_key: @sdk_key,
+            account_id: impression[:account_id],
+            variation_id: impression[:combination]
           )
         )
       end
+
+    else
+      @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::USER_ALREADY_TRACKED,
+          file: FILE,
+          user_id: user_id,
+          campaign_key: campaign_key,
+          api_name: ApiMethods::IS_FEATURE_ENABLED
+        )
+      )
     end
-    true
+    if campaign_type == CampaignTypes::FEATURE_ROLLOUT
+      result = true
+    else
+      result = variation['isFeatureEnabled']
+    end
+
+    if result
+      @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::FEATURE_ENABLED_FOR_USER,
+          file: FILE,
+          user_id: user_id,
+          feature_key: campaign_key,
+          api_name: ApiMethods::IS_FEATURE_ENABLED
+        )
+      )
+    else
+      @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::FEATURE_NOT_ENABLED_FOR_USER,
+          file: FILE,
+          user_id: user_id,
+          feature_key: campaign_key,
+          api_name: ApiMethods::IS_FEATURE_ENABLED
+        )
+      )
+    end
+
+    result
   rescue StandardError => e
     @logger.log(
       LogLevelEnum::ERROR,
@@ -987,9 +1000,10 @@ class VWO
       return
     end
 
+    options = convert_to_symbol_hash(options)
     # Retrieve custom variables
-    custom_variables = options['custom_variables'] || options[:custom_variables]
-    variation_targeting_variables = options['variation_targeting_variables'] || options[:variation_targeting_variables]
+    custom_variables = options[:custom_variables]
+    variation_targeting_variables = options[:variation_targeting_variables]
 
     unless valid_string?(campaign_key) && valid_string?(variable_key) && valid_string?(user_id) &&
       (custom_variables.nil? || valid_hash?(custom_variables)) && (variation_targeting_variables.nil? || valid_hash?(variation_targeting_variables))

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vwo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.23.0
 platform: ruby
 authors:
 - VWO
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 0.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: A Ruby SDK for VWO full-stack testing.
+description: Ruby SDK for VWO FullStack testing.
 email:
 - dev@wingify.com
 executables: []
@@ -111,12 +111,18 @@ files:
 - lib/vwo/utils/impression.rb
 - lib/vwo/utils/request.rb
 - lib/vwo/utils/segment.rb
+- lib/vwo/utils/utility.rb
 - lib/vwo/utils/uuid.rb
 - lib/vwo/utils/validations.rb
 homepage: https://vwo.com/fullstack/server-side-testing/
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/wingify/vwo-ruby-sdk/issues
+  changelog_uri: https://github.com/wingify/vwo-ruby-sdk/blob/master/CHANGELOG.md
+  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:
 rdoc_options: []
 require_paths:
@@ -125,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.10
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -135,5 +141,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
-summary: Ruby SDK for VWO full-stack testing
+summary: Ruby SDK for VWO FullStack testing
 test_files: []