optimizely-sdk 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 237d61dfbd7da5d8b12e1a9e2b913a684a2700bd
-  data.tar.gz: e8620f5eb74a80a2e6d0a2b584bdfe369e4ad9ca
+  metadata.gz: 50614c45e6266670a008909d27b7baf89d443500
+  data.tar.gz: 89c89c31817a26ef93d516d19f406c12be5617f2
 SHA512:
-  metadata.gz: 7ceffdff73cf4b58b609f3c40105134df1e97eee3105222749c6e72c7f54ab9aa00cf2de18b1821aba6f0d0cdd30b9f7872cc570886d7dc76f2ae00ad828baaf
-  data.tar.gz: 11bc03a8f8af4c5758778e2c59fc090f6d39d52d818c267950d1ff98db1b043068d0bcef30ed8babcc7584e02200f0fcead4310c58d727bba9d21da6fcf642a1
+  metadata.gz: 8e443c5554673b3c209d3a8d85135d843db8e417df827a14d414f954f5eb3bbd70804163d948f48beb1174e909427761fd8e19acf77e2c7d7879fbe2dfcca013
+  data.tar.gz: 52e4ec4502499c9a831590ec0557fd418e09e0b89d2c1f11b786d6685cf8533cdf9820937bfa66778f627f8612ab2a45ac1044be79827c83b49ff4efcc942fcf

data/lib/optimizely/decision_service.rb

@@ -18,8 +18,6 @@
 require_relative './bucketer'
 
 module Optimizely
-  RESERVED_ATTRIBUTE_KEY_BUCKETING_ID = "\$opt_bucketing_id"
-
   class DecisionService
     # Optimizely's decision service that determines into which variation of an experiment a user will be allocated.
     #
@@ -368,9 +366,9 @@ module Optimizely
       bucketing_id = user_id
 
       # If the bucketing ID key is defined in attributes, then use that in place of the userID
-      if attributes && attributes[RESERVED_ATTRIBUTE_KEY_BUCKETING_ID].is_a?(String)
-        unless attributes[RESERVED_ATTRIBUTE_KEY_BUCKETING_ID].empty?
-          bucketing_id = attributes[RESERVED_ATTRIBUTE_KEY_BUCKETING_ID]
+      if attributes && attributes[Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BUCKETING_ID']].is_a?(String)
+        unless attributes[Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BUCKETING_ID']].empty?
+          bucketing_id = attributes[Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BUCKETING_ID']]
           @config.logger.log(Logger::DEBUG, "Setting the bucketing ID '#{bucketing_id}'")
         end
       end

data/lib/optimizely/event_builder.rb

@@ -22,8 +22,6 @@ require_relative '../optimizely/helpers/event_tag_utils'
 require 'securerandom'
 
 module Optimizely
-  RESERVED_ATTRIBUTE_KEY_BUCKETING_ID_EVENT_PARAM_KEY = 'optimizely_bucketing_id'
-
   class Event
     # Representation of an event which can be sent to the Optimizely logging endpoint.
 
@@ -58,6 +56,13 @@ module Optimizely
 
     private
 
+    def bot_filtering
+      # Get bot filtering bool
+      #
+      # Returns 'botFiltering' value in the datafile.
+      @config.bot_filtering
+    end
+
     def get_common_params(user_id, attributes)
       # Get params which are used in both conversion and impression events.
       #
@@ -69,33 +74,28 @@ module Optimizely
       visitor_attributes = []
 
       attributes&.keys&.each do |attribute_key|
-        # Omit null attribute value
+        # Omit null attribute values
         attribute_value = attributes[attribute_key]
-        next if attribute_value.nil?
-
-        if attribute_key.eql? RESERVED_ATTRIBUTE_KEY_BUCKETING_ID
-          # TODO: (Copied from PHP-SDK) (Alda): the type for bucketing ID attribute may change so
-          # that custom attributes are not overloaded
-          feature = {
-            entity_id: RESERVED_ATTRIBUTE_KEY_BUCKETING_ID,
-            key: RESERVED_ATTRIBUTE_KEY_BUCKETING_ID_EVENT_PARAM_KEY,
-            type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
-            value: attribute_value
-          }
-        else
-          # Skip attributes not in the datafile
-          attribute_id = @config.get_attribute_id(attribute_key)
-          next unless attribute_id
-
-          feature = {
-            entity_id: attribute_id,
-            key: attribute_key,
-            type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
-            value: attribute_value
-          }
-
+        unless attribute_value.nil?
+          attribute_id = @config.get_attribute_id attribute_key
+          if attribute_id
+            visitor_attributes.push(
+              entity_id: attribute_id,
+              key: attribute_key,
+              type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
+              value: attribute_value
+            )
+          end
         end
-        visitor_attributes.push(feature)
+      end
+      # Append Bot Filtering Attribute
+      if bot_filtering == true || bot_filtering == false
+        visitor_attributes.push(
+          entity_id: Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BOT_FILTERING'],
+          key: Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BOT_FILTERING'],
+          type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
+          value: bot_filtering
+        )
       end
 
       common_params = {

data/lib/optimizely/helpers/constants.rb

@@ -315,6 +315,12 @@ module Optimizely
         'VARIABLE_KEY' => 'Variable key',
         'VARIABLE_TYPE' => 'Variable type'
       }.freeze
+
+      CONTROL_ATTRIBUTES = {
+        'BOT_FILTERING' => '$opt_bot_filtering',
+        'BUCKETING_ID' => '$opt_bucketing_id',
+        'USER_AGENT' => '$opt_user_agent'
+      }.freeze
     end
   end
 end

data/lib/optimizely/notification_center.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2017, Optimizely and contributors
+#    Copyright 2017-2018, Optimizely and contributors
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -86,20 +86,31 @@ module Optimizely
       false
     end
 
+    # @deprecated Use {#clear_notification_listeners} instead.
     def clear_notifications(notification_type)
-      # Removes notifications for a certain notification type
-      #
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
+      @logger.log Logger::WARN, "'clear_notifications' is deprecated. Call 'clear_notification_listeners' instead."
+      clear_notification_listeners(notification_type)
+    end
 
+    # Removes notifications for a certain notification type
+    #
+    # @param notification_type - one of the constants in NOTIFICATION_TYPES
+
+    def clear_notification_listeners(notification_type)
       return nil unless notification_type_valid?(notification_type)
 
       @notifications[notification_type] = []
       @logger.log Logger::INFO, "All callbacks for notification type #{notification_type} have been removed."
     end
 
+    # @deprecated Use {#clear_all_notification_listeners} instead.
     def clean_all_notifications
-      # Removes all notifications
+      @logger.log Logger::WARN, "'clean_all_notifications' is deprecated. Call 'clear_all_notification_listeners' instead."
+      clear_all_notification_listeners
+    end
+
+    # Removes all notifications
+    def clear_all_notification_listeners
       @notifications.each_key { |key| @notifications[key] = [] }
     end
 

data/lib/optimizely/project_config.rb

@@ -15,6 +15,7 @@
 #    limitations under the License.
 #
 require 'json'
+require_relative 'helpers/constants'
 require_relative 'helpers/validator'
 
 module Optimizely
@@ -25,6 +26,7 @@ module Optimizely
   class ProjectConfig
     # Representation of the Optimizely project config.
     RUNNING_EXPERIMENT_STATUS = ['Running'].freeze
+    RESERVED_ATTRIBUTE_PREFIX = '$opt_'
 
     # Gets project config attributes.
     attr_reader :error_handler
@@ -41,6 +43,7 @@ module Optimizely
     attr_reader :project_id
     # Boolean - denotes if Optimizely should remove the last block of visitors' IP address before storing event data
     attr_reader :anonymize_ip
+    attr_reader :bot_filtering
     attr_reader :revision
     attr_reader :rollouts
     attr_reader :version
@@ -87,7 +90,8 @@ module Optimizely
       @feature_flags = config.fetch('featureFlags', [])
       @groups = config.fetch('groups', [])
       @project_id = config['projectId']
-      @anonymize_ip = config.key? 'anonymizeIP' ? config['anonymizeIP'] : false
+      @anonymize_ip = config.key?('anonymizeIP') ? config['anonymizeIP'] : false
+      @bot_filtering = config['botFiltering']
       @revision = config['revision']
       @rollouts = config.fetch('rollouts', [])
 
@@ -363,8 +367,23 @@ module Optimizely
     end
 
     def get_attribute_id(attribute_key)
+      # Get attribute ID for the provided attribute key.
+      #
+      # Args:
+      #   Attribute key for which attribute is to be fetched.
+      #
+      # Returns:
+      #   Attribute ID corresponding to the provided attribute key.
       attribute = @attribute_key_map[attribute_key]
-      return attribute['id'] if attribute
+      has_reserved_prefix = attribute_key.to_s.start_with?(RESERVED_ATTRIBUTE_PREFIX)
+      unless attribute.nil?
+        if has_reserved_prefix
+          @logger.log(Logger::WARN, "Attribute '#{attribute_key}' unexpectedly has reserved prefix '#{RESERVED_ATTRIBUTE_PREFIX}'; "\
+                      'using attribute ID instead of reserved attribute name.')
+        end
+        return attribute['id']
+      end
+      return attribute_key if has_reserved_prefix
       @logger.log Logger::ERROR, "Attribute key '#{attribute_key}' is not in datafile."
       @error_handler.handle_error InvalidAttributeError
       nil

data/lib/optimizely/version.rb

@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Optimizely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler