Class: Optimizely::ProjectConfig
- Inherits:
-
Object
- Object
- Optimizely::ProjectConfig
- Defined in:
- lib/optimizely/project_config.rb
Constant Summary collapse
- PROJECT_CONFIG_LINK_TEMPLATE =
Representation of the Optimizely project config.
'https://cdn.optimizely.com/json/%{project_id}.json'
- REVENUE_GOAL_KEY =
'Total Revenue'
- REQUEST_TIMEOUT =
10
- RUNNING_EXPERIMENT_STATUS =
['Running']
Instance Attribute Summary collapse
-
#account_id ⇒ Object
readonly
Returns the value of attribute account_id.
-
#attribute_key_map ⇒ Object
readonly
Returns the value of attribute attribute_key_map.
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#audience_id_map ⇒ Object
readonly
Returns the value of attribute audience_id_map.
-
#audiences ⇒ Object
readonly
Returns the value of attribute audiences.
-
#error_handler ⇒ Object
readonly
Gets project config attributes.
-
#event_key_map ⇒ Object
readonly
Returns the value of attribute event_key_map.
-
#events ⇒ Object
readonly
Returns the value of attribute events.
-
#experiment_id_map ⇒ Object
readonly
Returns the value of attribute experiment_id_map.
-
#experiment_key_map ⇒ Object
readonly
Returns the value of attribute experiment_key_map.
-
#experiments ⇒ Object
readonly
Returns the value of attribute experiments.
-
#group_key_map ⇒ Object
readonly
Returns the value of attribute group_key_map.
-
#groups ⇒ Object
readonly
Returns the value of attribute groups.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#project_id ⇒ Object
readonly
Returns the value of attribute project_id.
-
#revision ⇒ Object
readonly
Returns the value of attribute revision.
-
#variation_id_map ⇒ Object
readonly
Returns the value of attribute variation_id_map.
-
#variation_key_map ⇒ Object
readonly
Returns the value of attribute variation_key_map.
Instance Method Summary collapse
- #experiment_running?(experiment_key) ⇒ Boolean
- #get_audience_conditions_from_id(audience_id) ⇒ Object
- #get_audience_ids_for_experiment(experiment_key) ⇒ Object
- #get_experiment_group_id(experiment_key) ⇒ Object
- #get_experiment_id(experiment_key) ⇒ Object
- #get_experiment_ids_for_goal(goal_key) ⇒ Object
- #get_forced_variations(experiment_key) ⇒ Object
- #get_goal_keys ⇒ Object
- #get_revenue_goal_id ⇒ Object
- #get_traffic_allocation(experiment_key) ⇒ Object
- #get_variation_id_from_key(experiment_key, variation_key) ⇒ Object
- #get_variation_key_from_id(experiment_key, variation_id) ⇒ Object
-
#initialize(datafile, logger, error_handler) ⇒ ProjectConfig
constructor
A new instance of ProjectConfig.
Constructor Details
#initialize(datafile, logger, error_handler) ⇒ ProjectConfig
Returns a new instance of ProjectConfig.
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 72 73 |
# File 'lib/optimizely/project_config.rb', line 35 def initialize(datafile, logger, error_handler) # ProjectConfig init method to fetch and set project config data # # datafile - JSON string representing the project config = JSON.load(datafile) @error_handler = error_handler @logger = logger @account_id = config['accountId'] @project_id = config['projectId'] @attributes = config['dimensions'] @events = config['events'] @experiments = config['experiments'] @revision = config['revision'] @audiences = config['audiences'] @groups = config.fetch('groups', []) # Utility maps for quick lookup @attribute_key_map = generate_key_map(@attributes, 'key') @event_key_map = generate_key_map(@events, 'key') @group_key_map = generate_key_map(@groups, 'id') @group_key_map.each do |key, group| exps = group.fetch('experiments') exps.each do |exp| @experiments.push(exp.merge('groupId' => key)) end end @experiment_key_map = generate_key_map(@experiments, 'key') @experiment_id_map = generate_key_map(@experiments, 'id') @audience_id_map = generate_key_map(@audiences, 'id') @variation_id_map = {} @variation_key_map = {} @experiment_key_map.each do |key, exp| variations = exp.fetch('variations') @variation_id_map[key] = generate_key_map(variations, 'id') @variation_key_map[key] = generate_key_map(variations, 'key') end end |
Instance Attribute Details
#account_id ⇒ Object (readonly)
Returns the value of attribute account_id.
16 17 18 |
# File 'lib/optimizely/project_config.rb', line 16 def account_id @account_id end |
#attribute_key_map ⇒ Object (readonly)
Returns the value of attribute attribute_key_map.
25 26 27 |
# File 'lib/optimizely/project_config.rb', line 25 def attribute_key_map @attribute_key_map end |
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
18 19 20 |
# File 'lib/optimizely/project_config.rb', line 18 def attributes @attributes end |
#audience_id_map ⇒ Object (readonly)
Returns the value of attribute audience_id_map.
26 27 28 |
# File 'lib/optimizely/project_config.rb', line 26 def audience_id_map @audience_id_map end |
#audiences ⇒ Object (readonly)
Returns the value of attribute audiences.
23 24 25 |
# File 'lib/optimizely/project_config.rb', line 23 def audiences @audiences end |
#error_handler ⇒ Object (readonly)
Gets project config attributes.
13 14 15 |
# File 'lib/optimizely/project_config.rb', line 13 def error_handler @error_handler end |
#event_key_map ⇒ Object (readonly)
Returns the value of attribute event_key_map.
27 28 29 |
# File 'lib/optimizely/project_config.rb', line 27 def event_key_map @event_key_map end |
#events ⇒ Object (readonly)
Returns the value of attribute events.
19 20 21 |
# File 'lib/optimizely/project_config.rb', line 19 def events @events end |
#experiment_id_map ⇒ Object (readonly)
Returns the value of attribute experiment_id_map.
28 29 30 |
# File 'lib/optimizely/project_config.rb', line 28 def experiment_id_map @experiment_id_map end |
#experiment_key_map ⇒ Object (readonly)
Returns the value of attribute experiment_key_map.
29 30 31 |
# File 'lib/optimizely/project_config.rb', line 29 def experiment_key_map @experiment_key_map end |
#experiments ⇒ Object (readonly)
Returns the value of attribute experiments.
20 21 22 |
# File 'lib/optimizely/project_config.rb', line 20 def experiments @experiments end |
#group_key_map ⇒ Object (readonly)
Returns the value of attribute group_key_map.
30 31 32 |
# File 'lib/optimizely/project_config.rb', line 30 def group_key_map @group_key_map end |
#groups ⇒ Object (readonly)
Returns the value of attribute groups.
21 22 23 |
# File 'lib/optimizely/project_config.rb', line 21 def groups @groups end |
#logger ⇒ Object
Returns the value of attribute logger.
14 15 16 |
# File 'lib/optimizely/project_config.rb', line 14 def logger @logger end |
#project_id ⇒ Object (readonly)
Returns the value of attribute project_id.
17 18 19 |
# File 'lib/optimizely/project_config.rb', line 17 def project_id @project_id end |
#revision ⇒ Object (readonly)
Returns the value of attribute revision.
22 23 24 |
# File 'lib/optimizely/project_config.rb', line 22 def revision @revision end |
#variation_id_map ⇒ Object (readonly)
Returns the value of attribute variation_id_map.
32 33 34 |
# File 'lib/optimizely/project_config.rb', line 32 def variation_id_map @variation_id_map end |
#variation_key_map ⇒ Object (readonly)
Returns the value of attribute variation_key_map.
33 34 35 |
# File 'lib/optimizely/project_config.rb', line 33 def variation_key_map @variation_key_map end |
Instance Method Details
#experiment_running?(experiment_key) ⇒ Boolean
75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/optimizely/project_config.rb', line 75 def experiment_running?(experiment_key) # Determine if experiment coresponding to given key is running # # experiment_key - String key representing the experiment # # Returns true if experiment is running experiment = @experiment_key_map[experiment_key] return RUNNING_EXPERIMENT_STATUS.include?(experiment['status']) if experiment @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError nil end |
#get_audience_conditions_from_id(audience_id) ⇒ Object
164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/optimizely/project_config.rb', line 164 def get_audience_conditions_from_id(audience_id) # Get audience conditions for the provided audience ID # # audience_id - ID of the audience # # Returns conditions for the audience audience = @audience_id_map[audience_id] return audience['conditions'] if audience @logger.log Logger::ERROR, "Audience '#{audience_id}' is not in datafile." @error_handler.handle_error InvalidAudienceError nil end |
#get_audience_ids_for_experiment(experiment_key) ⇒ Object
150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/optimizely/project_config.rb', line 150 def get_audience_ids_for_experiment(experiment_key) # Get audience IDs for the experiment # # experiment_key - Experiment key for which audience IDs are to be determined # # Returns audience IDs corresponding to the experiment. experiment = @experiment_key_map[experiment_key] return experiment['audienceIds'] if experiment @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError nil end |
#get_experiment_group_id(experiment_key) ⇒ Object
235 236 237 238 239 240 |
# File 'lib/optimizely/project_config.rb', line 235 def get_experiment_group_id(experiment_key) experiment = @experiment_key_map[experiment_key] return experiment['groupId'] if experiment @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError end |
#get_experiment_id(experiment_key) ⇒ Object
88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/optimizely/project_config.rb', line 88 def get_experiment_id(experiment_key) # Retrieves experiment ID for a given key # # experiment_key - String key representing the experiment # # Returns String ID experiment = @experiment_key_map[experiment_key] return experiment['id'] if experiment @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError nil end |
#get_experiment_ids_for_goal(goal_key) ⇒ Object
122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/optimizely/project_config.rb', line 122 def get_experiment_ids_for_goal(goal_key) # Get experiment IDs for the provided goal key. # # goal_key - Goal key for which experiment IDs are to be retrieved. # # Returns array of all experiment IDs for the goal. goal = @event_key_map[goal_key] return goal['experimentIds'] if goal @logger.log Logger::ERROR, "Event '#{goal_key}' is not in datafile." @error_handler.handle_error InvalidGoalError [] end |
#get_forced_variations(experiment_key) ⇒ Object
222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/optimizely/project_config.rb', line 222 def get_forced_variations(experiment_key) # Retrieves forced variations for a given experiment Key # # experiment_key - String Key representing the experiment # # Returns forced variations for the experiment or nil experiment = @experiment_key_map[experiment_key] return experiment['forcedVariations'] if experiment @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError end |
#get_goal_keys ⇒ Object
102 103 104 105 106 107 108 109 110 |
# File 'lib/optimizely/project_config.rb', line 102 def get_goal_keys # Retrieves all goals in the project except 'Total Revenue' # # Returns array of all goal keys except 'Total Revenue' goal_keys = @event_key_map.keys goal_keys.delete(REVENUE_GOAL_KEY) if goal_keys.include?(REVENUE_GOAL_KEY) goal_keys end |
#get_revenue_goal_id ⇒ Object
112 113 114 115 116 117 118 119 120 |
# File 'lib/optimizely/project_config.rb', line 112 def get_revenue_goal_id # Get ID of the revenue goal for the project # # Returns revenue goal ID revenue_goal = @event_key_map[REVENUE_GOAL_KEY] return revenue_goal['id'] if revenue_goal nil end |
#get_traffic_allocation(experiment_key) ⇒ Object
136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/optimizely/project_config.rb', line 136 def get_traffic_allocation(experiment_key) # Retrieves traffic allocation for a given experiment Key # # experiment_key - String Key representing the experiment # # Returns traffic allocation for the experiment or nil experiment = @experiment_key_map[experiment_key] return experiment['trafficAllocation'] if experiment @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError nil end |
#get_variation_id_from_key(experiment_key, variation_key) ⇒ Object
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/optimizely/project_config.rb', line 200 def get_variation_id_from_key(experiment_key, variation_key) # Get variation ID given experiment key and variation key # # experiment_key - Key representing parent experiment of variation # variation_key - Key of the variation # # Returns ID of the variation variation_key_map = @variation_key_map[experiment_key] if variation_key_map variation = variation_key_map[variation_key] return variation['id'] if variation @logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile." @error_handler.handle_error InvalidVariationError return nil end @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError nil end |
#get_variation_key_from_id(experiment_key, variation_id) ⇒ Object
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/optimizely/project_config.rb', line 178 def get_variation_key_from_id(experiment_key, variation_id) # Get variation key given experiment key and variation ID # # experiment_key - Key representing parent experiment of variation # variation_id - ID of the variation # # Returns key of the variation variation_id_map = @variation_id_map[experiment_key] if variation_id_map variation = variation_id_map[variation_id] return variation['key'] if variation @logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile." @error_handler.handle_error InvalidVariationError return nil end @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile." @error_handler.handle_error InvalidExperimentError nil end |