Class: Optimizely::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/optimizely.rb

Constant Summary collapse

EVENT_BUILDERS_BY_VERSION = 
{
  Optimizely::V1_CONFIG_VERSION => EventBuilderV1,
  Optimizely::V2_CONFIG_VERSION => EventBuilderV2
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = nil, skip_json_validation = false) ⇒ Project

Returns a new instance of Project.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/optimizely.rb', line 30

def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = nil, skip_json_validation = false)
  # Constructor for Projects.
  #
  # datafile - JSON string representing the project.
  # event_dispatcher - Provides a dispatch_event method which if given a URL and params sends a request to it.
  # logger - Optional param which provides a log method to log messages. By default nothing would be logged.
  # error_handler - Optional param which provides a handle_error method to handle exceptions.
  #                 By default all exceptions will be suppressed.
  # skip_json_validation - Optional boolean param to skip JSON schema validation of the provided datafile.

  @is_valid = true
  @logger = logger || NoOpLogger.new
  @error_handler = error_handler || NoOpErrorHandler.new
  @event_dispatcher = event_dispatcher || EventDispatcher.new

  begin
    validate_inputs(datafile, skip_json_validation)
  rescue InvalidInputError => e
    @is_valid = false
    logger = SimpleLogger.new
    logger.log(Logger::ERROR, e.message)
    return
  end

  begin
    @config = ProjectConfig.new(datafile, @logger, @error_handler)
  rescue
    @is_valid = false
    logger = SimpleLogger.new
    logger.log(Logger::ERROR, InvalidInputError.new('datafile').message)
    return
  end

  begin
    @bucketer = Bucketer.new(@config)
    @event_builder = EVENT_BUILDERS_BY_VERSION[@config.version].new(@config, @bucketer)
  rescue
    @is_valid = false
    logger = SimpleLogger.new
    logger.log(Logger::ERROR, InvalidDatafileVersionError.new)
  end
end

Instance Attribute Details

#bucketer ⇒ Object

Returns the value of attribute bucketer.



19
20
21
 
# File 'lib/optimizely.rb', line 19

def bucketer
  @bucketer
end

#config ⇒ Object

Returns the value of attribute config.



18
19
20
 
# File 'lib/optimizely.rb', line 18

def config
  @config
end

#error_handler ⇒ Object

Returns the value of attribute error_handler.



23
24
25
 
# File 'lib/optimizely.rb', line 23

def error_handler
  @error_handler
end

#event_builder ⇒ Object

Returns the value of attribute event_builder.



20
21
22
 
# File 'lib/optimizely.rb', line 20

def event_builder
  @event_builder
end

#event_dispatcher ⇒ Object

Returns the value of attribute event_dispatcher.



21
22
23
 
# File 'lib/optimizely.rb', line 21

def event_dispatcher
  @event_dispatcher
end

#is_valid ⇒ Object (readonly)

Boolean representing if the instance represents a usable Optimizely Project



16
17
18
 
# File 'lib/optimizely.rb', line 16

def is_valid
  @is_valid
end

#logger ⇒ Object

Returns the value of attribute logger.



22
23
24
 
# File 'lib/optimizely.rb', line 22

def logger
  @logger
end

Instance Method Details

#activate(experiment_key, user_id, attributes = nil) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/optimizely.rb', line 73

def activate(experiment_key, user_id, attributes = nil)
  # Buckets visitor and sends impression event to Optimizely.
  #
  # experiment_key - Experiment which needs to be activated.
  # user_id - String ID for user.
  # attributes - Hash representing user attributes and values to be recorded.
  #
  # Returns variation key representing the variation the user will be bucketed in.
  # Returns nil if experiment is not Running, if user is not in experiment, or if datafile is invalid.

  unless @is_valid
    logger = SimpleLogger.new
    logger.log(Logger::ERROR, InvalidDatafileError.new('activate').message)
    return nil
  end

  if attributes && !attributes_valid?(attributes)
    @logger.log(Logger::INFO, "Not activating user '#{user_id}'.")
    return nil
  end

  unless preconditions_valid?(experiment_key, user_id, attributes)
    @logger.log(Logger::INFO, "Not activating user '#{user_id}'.")
    return nil
  end

  variation_id = @bucketer.bucket(experiment_key, user_id)

  if not variation_id
    @logger.log(Logger::INFO, "Not activating user '#{user_id}'.")
    return nil
  end

  # Create and dispatch impression event
  impression_event = @event_builder.create_impression_event(experiment_key, variation_id, user_id, attributes)
  @logger.log(Logger::INFO,
              'Dispatching impression event to URL %s with params %s.' % [impression_event.url,
                                                                          impression_event.params])
  begin
    @event_dispatcher.dispatch_event(impression_event)
  rescue => e
    @logger.log(Logger::ERROR, "Unable to dispatch impression event. Error: #{e}")
  end

  @config.get_variation_key_from_id(experiment_key, variation_id)
end

#get_variation(experiment_key, user_id, attributes = nil) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/optimizely.rb', line 120

def get_variation(experiment_key, user_id, attributes = nil)
  # Gets variation where visitor will be bucketed.
  #
  # experiment_key - Experiment for which visitor variation needs to be determined.
  # user_id - String ID for user.
  # attributes - Hash representing user attributes.
  #
  # Returns variation key where visitor will be bucketed.
  # Returns nil if experiment is not Running, if user is not in experiment, or if datafile is invalid.

  unless @is_valid
    logger = SimpleLogger.new
    logger.log(Logger::ERROR, InvalidDatafileError.new('get_variation').message)
    return nil
  end

  if attributes && !attributes_valid?(attributes)
    @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
    return nil
  end

  unless preconditions_valid?(experiment_key, user_id, attributes)
    @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
    return nil
  end

  variation_id = @bucketer.bucket(experiment_key, user_id)
  @config.get_variation_key_from_id(experiment_key, variation_id)
end

#track(event_key, user_id, attributes = nil, event_value = nil) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/optimizely.rb', line 150

def track(event_key, user_id, attributes = nil, event_value = nil)
  # Send conversion event to Optimizely.
  #
  # event_key - Goal key representing the event which needs to be recorded.
  # user_id - String ID for user.
  # attributes - Hash representing visitor attributes and values which need to be recorded.
  # event_value - Value associated with the event. Can be used to represent revenue in cents.

  unless @is_valid
    logger = SimpleLogger.new
    logger.log(Logger::ERROR, InvalidDatafileError.new('track').message)
    return nil
  end

  return nil if attributes && !attributes_valid?(attributes)

  experiment_ids = @config.get_experiment_ids_for_goal(event_key)
  if experiment_ids.empty?
    @config.logger.log(Logger::INFO, "Not tracking user '#{user_id}'.")
    return nil
  end

  # Filter out experiments that are not running or that do not include the user in audience conditions
  valid_experiment_keys = []
  experiment_ids.each do |experiment_id|
    experiment_key = @config.experiment_id_map[experiment_id]['key']
    unless preconditions_valid?(experiment_key, user_id, attributes)
      @config.logger.log(Logger::INFO, "Not tracking user '#{user_id}' for experiment '#{experiment_key}'.")
      next
    end
    valid_experiment_keys.push(experiment_key)
  end

  # Don't track events without valid experiments attached
  if valid_experiment_keys.empty?
    @logger.log(Logger::INFO, "There are no valid experiments for event '#{event_key}' to track.")
    return nil
  end

  conversion_event = @event_builder.create_conversion_event(event_key, user_id, attributes,
                                                            event_value, valid_experiment_keys)
  @logger.log(Logger::INFO,
              'Dispatching conversion event to URL %s with params %s.' % [conversion_event.url,
                                                                          conversion_event.params])
  begin
    @event_dispatcher.dispatch_event(conversion_event)
  rescue => e
    @logger.log(Logger::ERROR, "Unable to dispatch conversion event. Error: #{e}")
  end
end