vwo-sdk 1.25.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4871df5d5a50f01ed13a11692aa6b114f03242f4c9257eccb48bce2a65beaa7c
-  data.tar.gz: fdd46869b068d589e4a85402d10d8852c4bfc48084e75a18fe8631f3a99b07a9
+  metadata.gz: 83480c79432c0c6199e03e365b71fcf8b2e0ffaf89b976c94234b3bcfc54e931
+  data.tar.gz: a695f06bf66c0186c193b05b9d4a6a931c75b9398f260f7d733b57275a3bfedd
 SHA512:
-  metadata.gz: 0c23fe3a4fbcb4c85ef1af73a7ef9bb37a0a79eb4f628bad726f66394291cd93d24cecc066a662799670d10b703265eb3afe72a689ce060a2756eb84d0bfce69
-  data.tar.gz: f60e3e5a8b96e2ab878929c857d4c8d5c3071e6439e811ac59e7bfa00b488f6c79583ebbfa4a8995a3adac5faf80b7c9293ebea3fa0da231224c684ed39adbb4
+  metadata.gz: 63572509c60e9e96c39775bab1fe0bea00dd0ca27f436c46055563886a66bca0d78b3259fe70c2d58e13c8ed0c8e036245760923fcf2187b964628cea2f7741b
+  data.tar.gz: f96d84a9c2ae09e474ede155e1187cce8cd9a0dc38f56646531519aae27c07d5883c5373a60fae9fe92eef9fe0da7f23b1af7e3a71ce1a4283fda9ee6533551a

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.25.0'
+    SDK_VERSION = '1.28.0'
     SDK_NAME = 'ruby'
     VWO_DELIMITER = '_vwo_'
     MAX_EVENTS_PER_REQUEST = 5000
@@ -102,6 +102,7 @@ class VWO
       PUSH = 'push'
       GET_AND_UPDATE_SETTINGS_FILE = 'get_and_update_settings_file'
       FLUSH_EVENTS = 'flush_events'
+      OPT_OUT = 'opt_out'
     end
 
     module PushApi

data/lib/vwo/enums.rb

@@ -164,6 +164,8 @@ class VWO
         GOT_ELIGIBLE_CAMPAIGNS = "(%<file>s): Got %<no_of_eligible_campaigns>s eligible winners out of %<no_of_group_campaigns>s from the Group:%<group_name>s and for User ID:%<user_id>s"
         CALLED_CAMPAIGN_NOT_WINNER = "(%<file>s): Campaign:%<campaign_key>s does not qualify from the mutually exclusive group:%<group_name>s for User ID:%<user_id>s"
         OTHER_CAMPAIGN_SATISFIES_WHITELISTING_OR_STORAGE = "(%<file>s): Campaign:%<campaign_key>s of Group:%<group_name>s satisfies %<type>s for User ID:%<user_id>s"
+        OPT_OUT_API_CALLED = "(%<file>s): You have opted out for not tracking i.e. all API calls will stop functioning and will simply early return"
+        API_NOT_ENABLED = "(%<file>s): %<api>s API is disabled as you opted out for tracking. Reinitialize the SDK to enable the normal functioning of all APIs."
       end
 
       # Warning Messages

data/lib/vwo.rb

@@ -65,6 +65,7 @@ class VWO
     options = {}
   )
     options = convert_to_symbol_hash(options)
+    @is_opted_out = false
     @account_id = account_id
     @sdk_key = sdk_key
     @user_storage = user_storage
@@ -208,6 +209,10 @@ class VWO
   # VWO get_settings method to get settings for a particular account_id
   def get_and_update_settings_file
 
+    if is_opted_out(ApiMethods::GET_AND_UPDATE_SETTINGS_FILE)
+      return false
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
@@ -217,7 +222,7 @@ class VWO
           api_name: ApiMethods.GET_AND_UPDATE_SETTINGS_FILE
         )
       )
-      return
+      return false
     end
 
     latest_settings = @settings_file_manager.get_settings_file(true)
@@ -267,6 +272,10 @@ class VWO
   #                                               otherwise null in case of user not becoming part
 
   def activate(campaign_key, user_id, options = {})
+    if is_opted_out(ApiMethods::ACTIVATE)
+      return nil
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
@@ -444,6 +453,10 @@ class VWO
   #                                                       Otherwise null in case of user not becoming part
   #
   def get_variation_name(campaign_key, user_id, options = {})
+    if is_opted_out(ApiMethods::GET_VARIATION_NAME)
+      return nil
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
@@ -555,6 +568,10 @@ class VWO
   #
 
   def track(campaign_key, user_id, goal_identifier, options = {})
+    if is_opted_out(ApiMethods::TRACK)
+      return false
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
@@ -786,6 +803,10 @@ class VWO
   # @return[Boolean]  true if user becomes part of feature test/rollout, otherwise false.
 
   def feature_enabled?(campaign_key, user_id, options = {})
+    if is_opted_out(ApiMethods::IS_FEATURE_ENABLED)
+      return false
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
@@ -983,13 +1004,17 @@ class VWO
   #
 
   def get_feature_variable_value(campaign_key, variable_key, user_id, options = {})
+    if is_opted_out(ApiMethods::GET_FEATURE_VARIABLE_VALUE)
+      return nil
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
         format(
           LogMessageEnum::ErrorMessages::API_CONFIG_CORRUPTED,
           file: FILE,
-          api_name: ApiMethods.GET_FEATURE_VARIABLE_VALUE
+          api_name: ApiMethods::GET_FEATURE_VARIABLE_VALUE
         )
       )
       return
@@ -1137,16 +1162,20 @@ class VWO
   # @return                                       true if call is made successfully, else false
 
   def push(tag_key, tag_value, user_id = nil)
+    if is_opted_out(ApiMethods::PUSH)
+      return false
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
         format(
           LogMessageEnum::ErrorMessages::API_CONFIG_CORRUPTED,
           file: FILE,
-          api_name: ApiMethods.PUSH
+          api_name: ApiMethods::PUSH
         )
       )
-      return
+      return false
     end
 
     # Argument reshuffling.
@@ -1245,6 +1274,10 @@ class VWO
   end
 
   def flush_events
+    if is_opted_out(ApiMethods::FLUSH_EVENTS)
+      return false
+    end
+
     unless @is_instance_valid
       @logger.log(
         LogLevelEnum::ERROR,
@@ -1254,10 +1287,13 @@ class VWO
           api_name: ApiMethods::FLUSH_EVENTS
         )
       )
-      return
+      return false
+    end
+    result = false
+    if defined?(@batch_events) && !@batch_events_queue.nil?
+      result = @batch_events_queue.flush(manual: true)
+      @batch_events_queue.kill_thread
     end
-    result = @batch_events_queue.flush(manual: true)
-    @batch_events_queue.kill_thread
     result
   rescue StandardError => e
     @logger.log(
@@ -1294,6 +1330,55 @@ class VWO
     goal_type_to_track
   end
 
+  # Manually opting out of VWO SDK, No tracking will happen
+  #
+  # return[bool]
+  #
+  def set_opt_out
+    @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::OPT_OUT_API_CALLED,
+          file: FILE
+        )
+      )
+      if defined?(@batch_events) && !@batch_events_queue.nil?
+        @batch_events_queue.flush(manual: true)
+        @batch_events_queue.kill_thread
+      end
+
+      @is_opted_out = true
+      @settings_file = nil
+      @user_storage = nil
+      @event_dispatcher = nil
+      @variation_decider = nil
+      @config = nil
+      @usage_stats = nil
+      @batch_event_dispatcher = nil
+      @batch_events_queue = nil
+      @batch_events = nil
+
+      return @is_opted_out
+  end
+
+
+  # Check if VWO SDK is manually opted out
+  # @param[String]          :api_name              api_name is used in logging
+  # @return[bool]
+  def is_opted_out(api_name)
+    if @is_opted_out
+      @logger.log(
+        LogLevelEnum::INFO,
+        format(
+          LogMessageEnum::InfoMessages::API_NOT_ENABLED,
+          file: FILE,
+          api: api_name
+        )
+      )
+    end
+    return @is_opted_out
+  end
+
   def is_event_arch_enabled
     return @settings_file.key?('isEventArchEnabled') && @settings_file['isEventArchEnabled']
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vwo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.28.0
 platform: ruby
 authors:
 - VWO