optimizely-sdk 2.0.0.beta → 2.0.0.beta1

data/lib/optimizely/error_handler.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -18,15 +20,13 @@ module Optimizely
     # Class encapsulating exception handling functionality.
     # Override with your own exception handler providing a handle_error method.
 
-    def handle_error(_error)
-    end
+    def handle_error(_error); end
   end
 
   class NoOpErrorHandler < BaseErrorHandler
     # Class providing handle_error method that suppresses errors.
 
-    def handle_error(_error)
-    end
+    def handle_error(_error); end
   end
 
   class RaiseErrorHandler < BaseErrorHandler

data/lib/optimizely/event_builder.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-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.
@@ -17,8 +19,11 @@ require_relative './audience'
 require_relative './params'
 require_relative './version'
 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.
 
@@ -35,204 +40,210 @@ module Optimizely
     end
 
     # Override equality operator to make two events with the same contents equal for testing purposes
-    def ==(event)
-      @http_verb == event.http_verb && @url == event.url && @params == event.params && @headers == event.headers
+    def ==(other)
+      @http_verb == other.http_verb && @url == other.url && @params == other.params && @headers == other.headers
     end
   end
 
   class BaseEventBuilder
+    CUSTOM_ATTRIBUTE_FEATURE_TYPE = 'custom'
+
     attr_reader :config
-    attr_reader :params
+    attr_reader :logger
 
-    def initialize(config)
+    def initialize(config, logger)
       @config = config
-      @params = {}
+      @logger = logger
     end
 
     private
 
-    def add_common_params(user_id, attributes)
-      # Add params which are used in both conversion and impression events.
+    def get_common_params(user_id, attributes)
+      # Get params which are used in both conversion and impression events.
+      #
+      # user_id -    +String+ ID for user
+      # attributes - +Hash+ representing user attributes and values which need to be recorded.
       #
-      # user_id - ID for user.
-      # attributes - Hash representing user attributes and values which need to be recorded.
-
-      add_project_id
-      add_account_id
-      add_user_id(user_id)
-      add_attributes(attributes)
-      add_source
-      add_time
+      # Returns +Hash+ Common event params
+
+      visitor_attributes = []
+
+      attributes&.keys&.each do |attribute_key|
+        # Omit null attribute value
+        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
+          }
+
+        end
+        visitor_attributes.push(feature)
+      end
+
+      common_params = {
+        account_id: @config.account_id,
+        project_id: @config.project_id,
+        visitors: [
+          {
+            attributes: visitor_attributes,
+            snapshots: [],
+            visitor_id: user_id
+          }
+        ],
+        anonymize_ip: @config.anonymize_ip,
+        revision: @config.revision,
+        client_name: CLIENT_ENGINE,
+        client_version: VERSION
+      }
+
+      common_params
     end
   end
 
   class EventBuilder < BaseEventBuilder
-    CONVERSION_EVENT_ENDPOINT = 'https://logx.optimizely.com/log/event'
-    IMPRESSION_EVENT_ENDPOINT = 'https://logx.optimizely.com/log/decision'
-    POST_HEADERS = { 'Content-Type' => 'application/json' }
+    ENDPOINT = 'https://logx.optimizely.com/v1/events'
+    POST_HEADERS = {'Content-Type' => 'application/json'}.freeze
+    ACTIVATE_EVENT_KEY = 'campaign_activated'
 
     def create_impression_event(experiment, variation_id, user_id, attributes)
-      # Create conversion Event to be sent to the logging endpoint.
+      # Create impression Event to be sent to the logging endpoint.
       #
-      # experiment - Experiment for which impression needs to be recorded.
-      # variation_id - ID for variation which would be presented to user.
-      # user_id - ID for user.
-      # attributes - Hash representing user attributes and values which need to be recorded.
+      # experiment -   +Object+ Experiment for which impression needs to be recorded.
+      # variation_id - +String+ ID for variation which would be presented to user.
+      # user_id -      +String+ ID for user.
+      # attributes -   +Hash+ representing user attributes and values which need to be recorded.
       #
-      # Returns event hash encapsulating the impression event.
+      # Returns +Event+ encapsulating the impression event.
+
+      event_params = get_common_params(user_id, attributes)
+      impression_params = get_impression_params(experiment, variation_id)
+      event_params[:visitors][0][:snapshots].push(impression_params)
 
-      @params = {}
-      add_common_params(user_id, attributes)
-      add_decision(experiment, variation_id)
-      add_attributes(attributes)
-      Event.new(:post, IMPRESSION_EVENT_ENDPOINT, @params, POST_HEADERS)
+      Event.new(:post, ENDPOINT, event_params, POST_HEADERS)
     end
 
     def create_conversion_event(event_key, user_id, attributes, event_tags, experiment_variation_map)
       # Create conversion Event to be sent to the logging endpoint.
       #
-      # event_key - Event key representing the event which needs to be recorded.
-      # user_id - ID for user.
-      # attributes - Hash representing user attributes and values which need to be recorded.
-      # event_tags - Hash representing metadata associated with the event.
-      # experiment_variation_map - Map of experiment ID to the ID of the variation that the user is bucketed into.
+      # event_key -                +String+ Event key representing the event which needs to be recorded.
+      # user_id -                  +String+ ID for user.
+      # attributes -               +Hash+ representing user attributes and values which need to be recorded.
+      # event_tags -               +Hash+ representing metadata associated with the event.
+      # experiment_variation_map - +Map+ of experiment ID to the ID of the variation that the user is bucketed into.
       #
-      # Returns event hash encapsulating the conversion event.
-
-      @params = {}
-      add_common_params(user_id, attributes)
-      add_conversion_event(event_key)
-      add_event_tags(event_tags)
-      add_layer_states(experiment_variation_map)
-      Event.new(:post, CONVERSION_EVENT_ENDPOINT, @params, POST_HEADERS)
-    end
-
-    private
-
-    def add_common_params(user_id, attributes)
-      super
-      @params['isGlobalHoldback'] = false
-    end
-
-    def add_project_id
-      @params['projectId'] = @config.project_id
-    end
+      # Returns +Event+ encapsulating the conversion event.
 
-    def add_account_id
-      @params['accountId'] = @config.account_id
-    end
+      event_params = get_common_params(user_id, attributes)
+      conversion_params = get_conversion_params(event_key, event_tags, experiment_variation_map)
+      event_params[:visitors][0][:snapshots] = conversion_params
 
-    def add_user_id(user_id)
-      @params['visitorId'] = user_id
+      Event.new(:post, ENDPOINT, event_params, POST_HEADERS)
     end
 
-    def add_attributes(attributes)
-      @params['userFeatures'] = []
-
-      return if attributes.nil?
+    private
 
-      attributes.keys.each do |attribute_key|
-        # Omit falsy attribute values
-        attribute_value = attributes[attribute_key]
-        next unless attribute_value
-
-        # Skip attributes not in the datafile
-        attribute_id = @config.get_attribute_id(attribute_key)
-        next unless attribute_id
-
-        feature = {
-          'id' => attribute_id,
-          'name' => attribute_key,
-          'type' => 'custom',
-          'value' => attribute_value,
-          'shouldIndex' => true,
-        }
-        @params['userFeatures'].push(feature)
-      end
-    end
+    def get_impression_params(experiment, variation_id)
+      # Creates object of params specific to impression events
+      #
+      # experiment -   +Hash+ experiment for which impression needs to be recorded
+      # variation_id - +string+ ID for variation which would be presented to user
+      #
+      # Returns +Hash+ Impression event params
 
-    def add_decision(experiment, variation_id)
       experiment_key = experiment['key']
       experiment_id = experiment['id']
-      @params['layerId'] = @config.experiment_key_map[experiment_key]['layerId']
-      @params['decision'] = {
-        'variationId' => variation_id,
-        'experimentId' => experiment_id,
-        'isLayerHoldback' => false,
+
+      impression_event_params = {
+        decisions: [{
+          campaign_id: @config.experiment_key_map[experiment_key]['layerId'],
+          experiment_id: experiment_id,
+          variation_id: variation_id
+        }],
+        events: [{
+          entity_id: @config.experiment_key_map[experiment_key]['layerId'],
+          timestamp: create_timestamp,
+          key: ACTIVATE_EVENT_KEY,
+          uuid: create_uuid
+        }]
       }
+
+      impression_event_params
     end
 
-    def add_event_tags(event_tags)
-      @params['eventFeatures'] ||= []
-      @params['eventMetrics'] ||= []
+    def get_conversion_params(event_key, event_tags, experiment_variation_map)
+      # Creates object of params specific to conversion events
+      #
+      # event_key -                +String+ Key representing the event which needs to be recorded
+      # event_tags -               +Hash+ Values associated with the event.
+      # experiment_variation_map - +Hash+ Map of experiment IDs to bucketed variation IDs
+      #
+      # Returns +Hash+ Impression event params
+
+      conversion_event_params = []
+
+      experiment_variation_map.each do |experiment_id, variation_id|
+        single_snapshot = {
+          decisions: [{
+            campaign_id: @config.experiment_id_map[experiment_id]['layerId'],
+            experiment_id: experiment_id,
+            variation_id: variation_id
+          }],
+          events: []
+        }
 
-      return if event_tags.nil?
+        event_object = {
+          entity_id: @config.event_key_map[event_key]['id'],
+          timestamp: create_timestamp,
+          uuid: create_uuid,
+          key: event_key
+        }
 
-      event_tags.each_pair do |event_tag_key, event_tag_value|
-        next if event_tag_value.nil?
+        if event_tags
+          revenue_value = Helpers::EventTagUtils.get_revenue_value(event_tags, @logger)
+          event_object[:revenue] = revenue_value if revenue_value
 
-        event_feature = {
-          'name' => event_tag_key,
-          'type' => 'custom',
-          'value' => event_tag_value,
-          'shouldIndex' => false,
-        }
-        @params['eventFeatures'].push(event_feature)
+          numeric_value = Helpers::EventTagUtils.get_numeric_value(event_tags, @logger)
+          event_object[:value] = numeric_value if numeric_value
 
-      end
+          event_object[:tags] = event_tags
+        end
 
-      event_value = Helpers::EventTagUtils.get_revenue_value(event_tags)
+        single_snapshot[:events] = [event_object]
 
-      if event_value
-        event_metric = {
-          'name' => 'revenue',
-          'value' => event_value
-        }
-        @params['eventMetrics'].push(event_metric)
+        conversion_event_params.push(single_snapshot)
       end
 
+      conversion_event_params
     end
 
-    def add_conversion_event(event_key)
-      # Add conversion event information to the event.
-      #
-      # event_key - Event key representing the event which needs to be recorded.
-
-      event_id = @config.event_key_map[event_key]['id']
-      event_name = @config.event_key_map[event_key]['key']
+    def create_timestamp
+      # Returns +Integer+ Current timestamp
 
-      @params['eventEntityId'] = event_id
-      @params['eventName'] = event_name
+      (Time.now.to_f * 1000).to_i
     end
 
-    def add_layer_states(experiments_map)
-      # Add layer states information to the event.
-      #
-      # experiments_map - Hash with experiment ID as a key and variation ID as a value.
-
-      @params['layerStates'] = []
-
-      experiments_map.each do |experiment_id, variation_id|
-        layer_state = {
-          'layerId' => @config.experiment_id_map[experiment_id]['layerId'],
-          'decision' => {
-            'variationId' => variation_id,
-            'experimentId' => experiment_id,
-            'isLayerHoldback' => false,
-          },
-          'actionTriggered' => true,
-        }
-        @params['layerStates'].push(layer_state)
-      end
-    end
-
-    def add_source
-      @params['clientEngine'] = 'ruby-sdk'
-      @params['clientVersion'] = VERSION
-    end
+    def create_uuid
+      # Returns +String+ Random UUID
 
-    def add_time
-      @params['timestamp'] = (Time.now.to_f * 1000).to_i
+      SecureRandom.uuid
     end
   end
 end

data/lib/optimizely/event_dispatcher.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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,8 +21,7 @@ module Optimizely
   class NoOpEventDispatcher
     # Class providing dispatch_event method which does nothing.
 
-    def dispatch_event(event)
-    end
+    def dispatch_event(event); end
   end
 
   class EventDispatcher
@@ -40,9 +41,9 @@ module Optimizely
       elsif event.http_verb == :post
         begin
           HTTParty.post(event.url,
-                   body: event.params.to_json,
-                   headers: event.headers,
-                   timeout: REQUEST_TIMEOUT)
+                        body: event.params.to_json,
+                        headers: event.headers,
+                        timeout: REQUEST_TIMEOUT)
         rescue Timeout::Error => e
           return e
         end

data/lib/optimizely/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 #    Copyright 2016-2017, Optimizely and contributors
 #
@@ -83,7 +85,8 @@ module Optimizely
   class InvalidDatafileVersionError < Error
     # Raised when a datafile with an unsupported version is provided
 
-    def initialize(msg = 'Provided datafile is an unsupported version. Please use SDK version 1.1.2 or earlier for datafile version 1.')
+    def initialize(msg = 'Provided datafile is an unsupported version. Please use SDK version 1.1.2 or earlier '\
+                  'for datafile version 1.')
       super
     end
   end
@@ -95,4 +98,12 @@ module Optimizely
       super("Provided #{type} is in an invalid format.")
     end
   end
+
+  class InvalidNotificationType < Error
+    # Raised when an invalid notification type is provided
+
+    def initialize(msg = 'Provided notification type is invalid.')
+      super
+    end
+  end
 end