optimizely-sdk 3.4.0 → 3.8.0

data/lib/optimizely/event/entity/decision.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -17,19 +17,21 @@
 #
 module Optimizely
   class Decision
-    attr_reader :campaign_id, :experiment_id, :variation_id
+    attr_reader :campaign_id, :experiment_id, :variation_id, :metadata
 
-    def initialize(campaign_id:, experiment_id:, variation_id:)
+    def initialize(campaign_id:, experiment_id:, variation_id:, metadata:)
       @campaign_id = campaign_id
       @experiment_id = experiment_id
       @variation_id = variation_id
+      @metadata = metadata
     end
 
     def as_json
       {
         campaign_id: @campaign_id,
         experiment_id: @experiment_id,
-        variation_id: @variation_id
+        variation_id: @variation_id,
+        metadata: @metadata
       }
     end
   end

data/lib/optimizely/event/entity/impression_event.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -19,7 +19,7 @@ require_relative 'user_event'
 require 'optimizely/helpers/date_time_utils'
 module Optimizely
   class ImpressionEvent < UserEvent
-    attr_reader :user_id, :experiment_layer_id, :experiment_id, :variation_id,
+    attr_reader :user_id, :experiment_layer_id, :experiment_id, :variation_id, :metadata,
                 :visitor_attributes, :bot_filtering
 
     def initialize(
@@ -28,6 +28,7 @@ module Optimizely
       experiment_layer_id:,
       experiment_id:,
       variation_id:,
+      metadata:,
       visitor_attributes:,
       bot_filtering:
     )
@@ -38,6 +39,7 @@ module Optimizely
       @experiment_layer_id = experiment_layer_id
       @experiment_id = experiment_id
       @variation_id = variation_id
+      @metadata = metadata
       @visitor_attributes = visitor_attributes
       @bot_filtering = bot_filtering
     end

data/lib/optimizely/event/event_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -101,10 +101,11 @@ module Optimizely
       private
 
       def create_impression_event_visitor(impression_event)
-        decision = Optimizely::Decision.new(
+        decision = Decision.new(
           campaign_id: impression_event.experiment_layer_id,
           experiment_id: impression_event.experiment_id,
-          variation_id: impression_event.variation_id
+          variation_id: impression_event.variation_id,
+          metadata: impression_event.metadata
         )
 
         snapshot_event = Optimizely::SnapshotEvent.new(

data/lib/optimizely/event/user_event_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -22,7 +22,7 @@ require_relative 'event_factory'
 module Optimizely
   class UserEventFactory
     # UserEventFactory builds ImpressionEvent and ConversionEvent objects from a given user_event.
-    def self.create_impression_event(project_config, experiment, variation_id, user_id, user_attributes)
+    def self.create_impression_event(project_config, experiment, variation_id, metadata, user_id, user_attributes)
       # Create impression Event to be sent to the logging endpoint.
       #
       # project_config - Instance of ProjectConfig
@@ -42,13 +42,14 @@ module Optimizely
       ).as_json
 
       visitor_attributes = Optimizely::EventFactory.build_attribute_list(user_attributes, project_config)
-      experiment_layer_id = project_config.experiment_key_map[experiment['key']]['layerId']
+      experiment_layer_id = experiment['layerId']
       Optimizely::ImpressionEvent.new(
         event_context: event_context,
         user_id: user_id,
         experiment_layer_id: experiment_layer_id,
         experiment_id: experiment['id'],
         variation_id: variation_id,
+        metadata: metadata,
         visitor_attributes: visitor_attributes,
         bot_filtering: project_config.bot_filtering
       )

data/lib/optimizely/event_dispatcher.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, 2019, Optimizely and contributors
+#    Copyright 2016-2017, 2019-2020 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.
@@ -16,8 +16,7 @@
 #    limitations under the License.
 #
 require_relative 'exceptions'
-
-require 'httparty'
+require_relative 'helpers/http_utils'
 
 module Optimizely
   class NoOpEventDispatcher
@@ -30,28 +29,23 @@ module Optimizely
     # @api constants
     REQUEST_TIMEOUT = 10
 
-    def initialize(logger: nil, error_handler: nil)
+    def initialize(logger: nil, error_handler: nil, proxy_config: nil)
       @logger = logger || NoOpLogger.new
       @error_handler = error_handler || NoOpErrorHandler.new
+      @proxy_config = proxy_config
     end
 
     # Dispatch the event being represented by the Event object.
     #
     # @param event - Event object
     def dispatch_event(event)
-      if event.http_verb == :get
-        response = HTTParty.get(event.url, headers: event.headers, query: event.params, timeout: REQUEST_TIMEOUT)
-
-      elsif event.http_verb == :post
-        response = HTTParty.post(event.url,
-                                 body: event.params.to_json,
-                                 headers: event.headers,
-                                 timeout: REQUEST_TIMEOUT)
-      end
+      response = Helpers::HttpUtils.make_request(
+        event.url, event.http_verb, event.params.to_json, event.headers, REQUEST_TIMEOUT, @proxy_config
+      )
 
       error_msg = "Event failed to dispatch with response code: #{response.code}"
 
-      case response.code
+      case response.code.to_i
       when 400...500
         @logger.log(Logger::ERROR, error_msg)
         @error_handler.handle_error(HTTPCallError.new("HTTP Client Error: #{response.code}"))

data/lib/optimizely/exceptions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2019, Optimizely and contributors
+#    Copyright 2016-2020, 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.
@@ -81,14 +81,6 @@ module Optimizely
     end
   end
 
-  class InvalidDatafileError < Error
-    # Raised when a public method fails due to an invalid datafile
-
-    def initialize(aborted_method)
-      super("Provided datafile is in an invalid format. Aborting #{aborted_method}.")
-    end
-  end
-
   class InvalidDatafileVersionError < Error
     # Raised when a datafile with an unsupported version is provided
 
@@ -128,4 +120,20 @@ module Optimizely
       super("Optimizely instance is not valid. Failing '#{aborted_method}'.")
     end
   end
+
+  class InvalidAttributeType < Error
+    # Raised when an attribute is not provided in expected type.
+
+    def initialize(msg = 'Provided attribute value is not in the expected data type.')
+      super
+    end
+  end
+
+  class InvalidSemanticVersion < Error
+    # Raised when an invalid value is provided as semantic version.
+
+    def initialize(msg = 'Provided semantic version is invalid.')
+      super
+    end
+  end
 end

data/lib/optimizely/helpers/constants.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2019, Optimizely and contributors
+#    Copyright 2016-2020, 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.
@@ -304,7 +304,8 @@ module Optimizely
         'BOOLEAN' => 'boolean',
         'DOUBLE' => 'double',
         'INTEGER' => 'integer',
-        'STRING' => 'string'
+        'STRING' => 'string',
+        'JSON' => 'json'
       }.freeze
 
       INPUT_VARIABLES = {
@@ -334,11 +335,11 @@ module Optimizely
 
       AUDIENCE_EVALUATION_LOGS = {
         'AUDIENCE_EVALUATION_RESULT' => "Audience '%s' evaluated to %s.",
-        'AUDIENCE_EVALUATION_RESULT_COMBINED' => "Audiences for experiment '%s' collectively evaluated to %s.",
         'EVALUATING_AUDIENCE' => "Starting to evaluate audience '%s' with conditions: %s.",
-        'EVALUATING_AUDIENCES_COMBINED' => "Evaluating audiences for experiment '%s': %s.",
         'INFINITE_ATTRIBUTE_VALUE' => 'Audience condition %s evaluated to UNKNOWN because the number value ' \
         "for user attribute '%s' is not in the range [-2^53, +2^53].",
+        'INVALID_SEMANTIC_VERSION' => 'Audience condition %s evaluated as UNKNOWN because an invalid semantic version ' \
+        "was passed for user attribute '%s'.",
         'MISSING_ATTRIBUTE_VALUE' => 'Audience condition %s evaluated as UNKNOWN because no value ' \
         "was passed for user attribute '%s'.",
         'NULL_ATTRIBUTE_VALUE' => 'Audience condition %s evaluated to UNKNOWN because a nil value was passed ' \
@@ -353,15 +354,28 @@ module Optimizely
         'to upgrade to a newer release of the Optimizely SDK.'
       }.freeze
 
+      EXPERIMENT_AUDIENCE_EVALUATION_LOGS = {
+        'AUDIENCE_EVALUATION_RESULT_COMBINED' => "Audiences for experiment '%s' collectively evaluated to %s.",
+        'EVALUATING_AUDIENCES_COMBINED' => "Evaluating audiences for experiment '%s': %s."
+      }.merge(AUDIENCE_EVALUATION_LOGS).freeze
+
+      ROLLOUT_AUDIENCE_EVALUATION_LOGS = {
+        'AUDIENCE_EVALUATION_RESULT_COMBINED' => "Audiences for rule '%s' collectively evaluated to %s.",
+        'EVALUATING_AUDIENCES_COMBINED' => "Evaluating audiences for rule '%s': %s."
+      }.merge(AUDIENCE_EVALUATION_LOGS).freeze
+
       DECISION_NOTIFICATION_TYPES = {
         'AB_TEST' => 'ab-test',
         'FEATURE' => 'feature',
         'FEATURE_TEST' => 'feature-test',
-        'FEATURE_VARIABLE' => 'feature-variable'
+        'FEATURE_VARIABLE' => 'feature-variable',
+        'FLAG' => 'flag',
+        'ALL_FEATURE_VARIABLES' => 'all-feature-variables'
       }.freeze
 
       CONFIG_MANAGER = {
         'DATAFILE_URL_TEMPLATE' => 'https://cdn.optimizely.com/datafiles/%s.json',
+        'AUTHENTICATED_DATAFILE_URL_TEMPLATE' => 'https://config.optimizely.com/datafiles/auth/%s.json',
         # Default time in seconds to block the 'config' method call until 'config' instance has been initialized.
         'DEFAULT_BLOCKING_TIMEOUT' => 15,
         # Default config update interval of 5 minutes

data/lib/optimizely/helpers/http_utils.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2020, 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.
+#    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 'net/http'
+
+module Optimizely
+  module Helpers
+    module HttpUtils
+      module_function
+
+      def make_request(url, http_method, request_body = nil, headers = {}, read_timeout = nil, proxy_config = nil)
+        # makes http/https GET/POST request and returns response
+        #
+        uri = URI.parse(url)
+
+        if http_method == :get
+          request = Net::HTTP::Get.new(uri.request_uri)
+        elsif http_method == :post
+          request = Net::HTTP::Post.new(uri.request_uri)
+          request.body = request_body if request_body
+        else
+          return nil
+        end
+
+        # set headers
+        headers&.each do |key, val|
+          request[key] = val
+        end
+
+        # do not try to make request with proxy unless we have at least a host
+        http_class = if proxy_config&.host
+                       Net::HTTP::Proxy(
+                         proxy_config.host,
+                         proxy_config.port,
+                         proxy_config.username,
+                         proxy_config.password
+                       )
+                     else
+                       Net::HTTP
+                     end
+
+        http = http_class.new(uri.host, uri.port)
+        http.read_timeout = read_timeout if read_timeout
+        http.use_ssl = uri.scheme == 'https'
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/optimizely/helpers/variable_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2017, Optimizely and contributors
+#    Copyright 2017, 2020, 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.
@@ -48,6 +48,13 @@ module Optimizely
             logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
                                       "'#{variable_type}': #{e.message}.")
           end
+        when 'json'
+          begin
+            return_value = JSON.parse(value)
+          rescue => e
+            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
+                                      "'#{variable_type}': #{e.message}.")
+          end
         else
           # default case is string
           return_value = value

data/lib/optimizely/optimizely_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -25,6 +25,7 @@ module Optimizely
       experiments_map_object = experiments_map
       features_map = get_features_map(experiments_map_object)
       {
+        'datafile' => @project_config.datafile,
         'experimentsMap' => experiments_map_object,
         'featuresMap' => features_map,
         'revision' => @project_config.revision

data/lib/optimizely/optimizely_factory.rb

@@ -17,16 +17,18 @@
 #
 
 require 'optimizely'
+require 'optimizely/error_handler'
 require 'optimizely/event_dispatcher'
 require 'optimizely/event/batch_event_processor'
+require 'optimizely/logger'
+require 'optimizely/notification_center'
+
 module Optimizely
   class OptimizelyFactory
-    attr_reader :max_event_batch_size, :max_event_flush_interval
-
     # Convenience method for setting the maximum number of events contained within a batch.
     # @param batch_size Integer - Sets size of EventQueue.
     # @param logger - Optional LoggerInterface Provides a log method to log messages.
-    def self.max_event_batch_size(batch_size, logger)
+    def self.max_event_batch_size(batch_size, logger = NoOpLogger.new)
       unless batch_size.is_a? Integer
         logger.log(
           Logger::ERROR,
@@ -48,7 +50,7 @@ module Optimizely
     # Convenience method for setting the maximum time interval in milliseconds between event dispatches.
     # @param flush_interval Numeric - Time interval between event dispatches.
     # @param logger - Optional LoggerInterface Provides a log method to log messages.
-    def self.max_event_flush_interval(flush_interval, logger)
+    def self.max_event_flush_interval(flush_interval, logger = NoOpLogger.new)
       unless flush_interval.is_a? Numeric
         logger.log(
           Logger::ERROR,
@@ -67,12 +69,42 @@ module Optimizely
       @max_event_flush_interval = flush_interval
     end
 
+    # Convenience method for setting frequency at which datafile has to be polled and ProjectConfig updated.
+    #
+    # @param polling_interval Numeric - Time in seconds after which to update datafile.
+    def self.polling_interval(polling_interval)
+      @polling_interval = polling_interval
+    end
+
+    # Convenience method for setting timeout to block the config call until config has been initialized.
+    #
+    # @param blocking_timeout Numeric - Time in seconds.
+    def self.blocking_timeout(blocking_timeout)
+      @blocking_timeout = blocking_timeout
+    end
+
     # Returns a new optimizely instance.
     #
     # @params sdk_key - Required String uniquely identifying the fallback datafile corresponding to project.
     # @param fallback datafile - Optional JSON string datafile.
     def self.default_instance(sdk_key, datafile = nil)
-      Optimizely::Project.new(datafile, nil, nil, nil, nil, nil, sdk_key)
+      error_handler = NoOpErrorHandler.new
+      logger = NoOpLogger.new
+      notification_center = NotificationCenter.new(logger, error_handler)
+
+      config_manager = Optimizely::HTTPProjectConfigManager.new(
+        sdk_key: sdk_key,
+        polling_interval: @polling_interval,
+        blocking_timeout: @blocking_timeout,
+        datafile: datafile,
+        logger: logger,
+        error_handler: error_handler,
+        notification_center: notification_center
+      )
+
+      Optimizely::Project.new(
+        datafile, nil, logger, error_handler, nil, nil, sdk_key, config_manager, notification_center
+      )
     end
 
     # Returns a new optimizely instance.
@@ -108,10 +140,27 @@ module Optimizely
       config_manager = nil,
       notification_center = nil
     )
+
+      error_handler ||= NoOpErrorHandler.new
+      logger ||= NoOpLogger.new
+      notification_center = notification_center.is_a?(Optimizely::NotificationCenter) ? notification_center : NotificationCenter.new(logger, error_handler)
+
       event_processor = BatchEventProcessor.new(
         event_dispatcher: event_dispatcher || EventDispatcher.new,
         batch_size: @max_event_batch_size,
         flush_interval: @max_event_flush_interval,
+        logger: logger,
+        notification_center: notification_center
+      )
+
+      config_manager ||= Optimizely::HTTPProjectConfigManager.new(
+        sdk_key: sdk_key,
+        polling_interval: @polling_interval,
+        blocking_timeout: @blocking_timeout,
+        datafile: datafile,
+        logger: logger,
+        error_handler: error_handler,
+        skip_json_validation: skip_json_validation,
         notification_center: notification_center
       )