optimizely-sdk 0.0.12

data/lib/optimizely/error_handler.rb

@@ -0,0 +1,24 @@
+module Optimizely
+  class BaseErrorHandler
+    # Class encapsulating exception handling functionality.
+    # Override with your own exception handler providing a handle_error method.
+
+    def handle_error(_error)
+    end
+  end
+
+  class NoOpErrorHandler < BaseErrorHandler
+    # Class providing handle_error method that suppresses errors.
+
+    def handle_error(_error)
+    end
+  end
+
+  class RaiseErrorHandler < BaseErrorHandler
+    # Class providing a handle_error method that raises exceptions.
+
+    def handle_error(error)
+      raise error
+    end
+  end
+end

data/lib/optimizely/event_builder.rb

@@ -0,0 +1,200 @@
+require_relative './audience'
+require_relative './params'
+require_relative './version'
+
+module Optimizely
+  class Event
+    # Representation of an event which can be sent to the Optimizely logging endpoint.
+
+    # Event API format
+    OFFLINE_API_PATH = 'https://%{project_id}.log.optimizely.com/event'
+
+    # Gets/Sets event params.
+    attr_accessor :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def url
+      # URL for sending impression/conversion event.
+      #
+      # project_id - ID for the project.
+      #
+      # Returns URL for event API.
+
+      sprintf(OFFLINE_API_PATH, project_id: @params[Params::PROJECT_ID])
+    end
+  end
+
+  class EventBuilder
+    # Class which encapsulates methods to build events for tracking impressions and conversions.
+
+    # Attribute mapping format
+    ATTRIBUTE_PARAM_FORMAT = '%{segment_prefix}%{segment_id}'
+
+    # Experiment mapping format
+    EXPERIMENT_PARAM_FORMAT = '%{experiment_prefix}%{experiment_id}'
+
+    attr_accessor :config
+    attr_accessor :bucketer
+    attr_accessor :params
+
+    def initialize(config, bucketer)
+      @config = config
+      @bucketer = bucketer
+      @params = {}
+    end
+
+    def create_impression_event(experiment_key, variation_id, user_id, attributes)
+      # Create conversion Event to be sent to the logging endpoint.
+      #
+      # experiment_key - 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.
+      #
+      # Returns event hash encapsulating the impression event.
+
+      @params = {}
+      add_common_params(user_id, attributes)
+      add_impression_goal(experiment_key)
+      add_experiment(experiment_key, variation_id)
+      Event.new(@params)
+    end
+
+    def create_conversion_event(event_key, user_id, attributes, event_value, experiment_keys)
+      # Create conversion Event to be sent to the logging endpoint.
+      #
+      # event_key - Goal 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_value - Value associated with the event. Can be used to represent revenue in cents.
+      # experiment_keys - Array of valid experiment keys for the goal
+
+      @params = {}
+      add_common_params(user_id, attributes)
+      add_conversion_goal(event_key, event_value)
+      add_experiment_variation_params(user_id, experiment_keys)
+      Event.new(@params)
+    end
+
+    private
+
+    def add_project_id
+      # Add project ID to the event.
+
+      @params[Params::PROJECT_ID] = @config.project_id
+    end
+
+    def add_account_id
+      # Add account ID to the event.
+
+      @params[Params::ACCOUNT_ID] = @config.account_id
+    end
+
+    def add_user_id(user_id)
+      # Add user ID to the event.
+
+      @params[Params::END_USER_ID] = user_id
+    end
+
+    def add_attributes(attributes)
+      # Add attribute(s) information to the event.
+      #
+      # attributes - Hash representing user attributes and values which need to be recorded.
+
+      return if attributes.nil?
+
+      attributes.keys.each do |attribute_key|
+        attribute_value = attributes[attribute_key]
+        next unless attribute_value
+        segment_id = @config.attribute_key_map[attribute_key]['segmentId']
+        segment_param = sprintf(ATTRIBUTE_PARAM_FORMAT,
+                                segment_prefix: Params::SEGMENT_PREFIX, segment_id: segment_id)
+        params[segment_param] = attribute_value
+      end
+    end
+
+    def add_source
+      # Add source information to the event.
+
+      @params[Params::SOURCE] = sprintf('ruby-sdk-%{version}', version: VERSION)
+    end
+
+    def add_time
+      # Add time information to the event.
+
+      @params[Params::TIME] = Time.now.strftime('%s').to_i
+    end
+
+    def add_common_params(user_id, attributes)
+      # Add params which are used same in both conversion and impression events.
+      #
+      # 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
+    end
+
+    def add_impression_goal(experiment_key)
+      # Add impression goal information to the event.
+      #
+      # experiment_key - Experiment which is being activated.
+
+      # For tracking impressions, goal ID is set equal to experiment ID of experiment being activated.
+      @params[Params::GOAL_ID] = @config.get_experiment_id(experiment_key)
+      @params[Params::GOAL_NAME] = 'visitor-event'
+    end
+
+    def add_experiment(experiment_key, variation_id)
+      # Add experiment to variation mapping to the impression event.
+      #
+      # experiment_key - Experiment which is being activated.
+      # variation_id - ID for variation which would be presented to user.
+
+      experiment_id = @config.get_experiment_id(experiment_key)
+      experiment_param = sprintf(EXPERIMENT_PARAM_FORMAT,
+                                 experiment_prefix: Params::EXPERIMENT_PREFIX, experiment_id: experiment_id)
+      @params[experiment_param] = variation_id
+    end
+
+    def add_experiment_variation_params(user_id, experiment_keys)
+      # Maps experiment and corresponding variation as parameters to be used in the event tracking call.
+      #
+      # user_id - ID for user.
+      # experiment_keys - Array of valid experiment keys for the goal
+
+      experiment_keys.each do |experiment_key|
+        variation_id = @bucketer.bucket(experiment_key, user_id)
+        experiment_id = @config.experiment_key_map[experiment_key]['id']
+        experiment_param = sprintf(EXPERIMENT_PARAM_FORMAT,
+                                   experiment_prefix: Params::EXPERIMENT_PREFIX, experiment_id: experiment_id)
+        @params[experiment_param] = variation_id
+      end
+    end
+
+    def add_conversion_goal(event_key, event_value)
+      # Add conversion goal information to the event.
+      #
+      # event_key - Goal key representing the event which needs to be recorded.
+      # event_value - Value associated with the event. Can be used to represent revenue in cents.
+
+      goal_id = @config.event_key_map[event_key]['id']
+      event_ids = goal_id
+
+      if event_value
+        event_ids = sprintf('%{goal_id},%{revenue_id}', goal_id: goal_id, revenue_id: @config.get_revenue_goal_id)
+        @params[Params::EVENT_VALUE] = event_value
+      end
+
+      @params[Params::GOAL_ID] = event_ids
+      @params[Params::GOAL_NAME] = event_key
+    end
+  end
+end

data/lib/optimizely/event_dispatcher.rb

@@ -0,0 +1,18 @@
+require 'httparty'
+
+module Optimizely
+  class EventDispatcher
+    REQUEST_TIMEOUT = 10
+
+    def dispatch_event(url, params)
+      # Dispatch the event being represented by the Event object.
+      #
+      # url - URL to send impression/conversion event to.
+      # params - Params to be sent to the impression/conversion event.
+
+      HTTParty.get(url, query: params, timeout: REQUEST_TIMEOUT)
+      rescue Timeout::Error => e
+        return e
+    end
+  end
+end

data/lib/optimizely/exceptions.rb

@@ -0,0 +1,83 @@
+module Optimizely
+  class Error < StandardError; end
+
+  class InvalidAudienceError < Error
+    # Raised when an invalid audience is provided
+
+    def initialize(msg = 'Provided audience is not in datafile.')
+      super
+    end
+  end
+
+  class InvalidAttributeError < Error
+    # Raised when an invalid attribute is provided
+
+    def initialize(msg = 'Provided attribute is not in datafile.')
+      super
+    end
+  end
+
+  class InvalidAttributeFormatError < Error
+    # Raised when attributes are provided in an invalid format (e.g. not a Hash)
+
+    def initialize(msg = 'Attributes provided are in an invalid format.')
+      super
+    end
+  end
+
+  class InvalidDatafileError < Error
+    # Raised when an invalid datafile is provided
+
+    def initialize(msg = 'Provided datafile is in an invalid format.')
+      super
+    end
+  end
+
+  class InvalidErrorHandlerError < Error
+    # Raised when an invalid error handler is provided
+
+    def initialize(msg = 'Provided error_handler is in an invalid format.')
+      super
+    end
+  end
+
+  class InvalidEventDispatcherError < Error
+    # Raised when an invalid event dispatcher is provided
+
+    def initialize(msg = 'Provided event_dispatcher is in an invalid format.')
+      super
+    end
+  end
+
+  class InvalidExperimentError < Error
+    # Raised when an invalid experiment key is provided
+
+    def initialize(msg = 'Provided experiment is not in datafile.')
+      super
+    end
+  end
+
+  class InvalidGoalError < Error
+    # Raised when an invalid event key is provided
+
+    def initialize(msg = 'Provided event is not in datafile.')
+      super
+    end
+  end
+
+  class InvalidLoggerError < Error
+    # Raised when an invalid logger is provided
+
+    def initialize(msg = 'Provided logger is in an invalid format.')
+      super
+    end
+  end
+
+  class InvalidVariationError < Error
+    # Raised when an invalid variation key or ID is provided
+
+    def initialize(msg = 'Provided variation is not in datafile.')
+      super
+    end
+  end
+end

data/lib/optimizely/helpers/constants.rb

@@ -0,0 +1,173 @@
+module Optimizely
+  module Helpers
+    module Constants
+      JSON_SCHEMA = {
+        'type' => 'object',
+        'properties' => {
+          'projectId' => {
+            'type' => 'string'
+          },
+          'accountId' => {
+            'type' => 'string'
+          },
+          'experiments' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'object',
+              'properties' => {
+                'id' => {
+                  'type' => 'string'
+                },
+                'key' => {
+                  'type' => 'string'
+                },
+                'variations' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'object',
+                    'properties' => {
+                      'id' => {
+                        'type' => 'string'
+                      },
+                      'key' => {
+                        'type' => 'string'
+                      }
+                    },
+                    'required' => [
+                      'id',
+                      'key'
+                    ]
+                  }
+                },
+                'trafficAllocation' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'object',
+                    'properties' => {
+                      'entityId' => {
+                        'type' => 'string'
+                      },
+                      'endOfRange' => {
+                        'type' => 'integer'
+                      }
+                    },
+                    'required' => [
+                      'entityId',
+                      'endOfRange'
+                    ]
+                  }
+                },
+                'percentageIncluded' => {
+                  'type' => 'integer'
+                },
+                'audienceIds' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'string'
+                  }
+                },
+                'forcedVariations' => {
+                  'type' => 'object'
+                }
+              },
+              'required' => [
+                'id',
+                'key',
+                'variations',
+                'trafficAllocation',
+                'percentageIncluded',
+                'audienceIds',
+                'forcedVariations'
+              ]
+            }
+          },
+          'events' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'object',
+              'properties' => {
+                'key' => {
+                  'type' => 'string'
+                },
+                'experimentIds' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'string'
+                  }
+                },
+                'id' => {
+                  'type' => 'string'
+                }
+              },
+              'required' => [
+                'key',
+                'experimentIds',
+                'id'
+              ]
+            }
+          },
+          'audiences' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'object',
+              'properties' => {
+                'id' => {
+                  'type' => 'string'
+                },
+                'name' => {
+                  'type' => 'string'
+                },
+                'conditions' => {
+                  'type' => 'string'
+                }
+              },
+              'required' => [
+                'id',
+                'name',
+                'conditions'
+              ]
+            }
+          },
+          'dimensions' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'object',
+              'properties' => {
+                'id' => {
+                  'type' => 'string'
+                },
+                'key' => {
+                  'type' => 'string'
+                },
+                'segmentId' => {
+                  'type' => 'string'
+                }
+              },
+              'required' => [
+                'id',
+                'key',
+                'segmentId'
+              ]
+            }
+          },
+          'version' => {
+            'type' => 'string'
+          },
+          'revision' => {
+            'type' => 'string'
+          }
+        },
+        'required' => [
+          'projectId',
+          'accountId',
+          'experiments',
+          'events',
+          'audiences',
+          'dimensions',
+          'version',
+          'revision'
+        ]
+      }
+    end
+  end
+end