Class: Vanity::Adapters::ActiveRecordAdapter

Inherits:
AbstractAdapter show all
Defined in:
lib/vanity/adapters/active_record_adapter.rb

Overview

ActiveRecord adapter

Defined Under Namespace

Classes: VanityConversion, VanityExperiment, VanityMetric, VanityMetricValue, VanityParticipant, VanityRecord

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ActiveRecordAdapter

Returns a new instance of ActiveRecordAdapter



114
115
116
117
118
119
120
# File 'lib/vanity/adapters/active_record_adapter.rb', line 114

def initialize(options)
  @options = options.inject({}) { |h,kv| h[kv.first.to_s] = kv.last ; h }
  if @options["active_record_adapter"] && (@options["active_record_adapter"] != "default")
    @options["adapter"] = @options["active_record_adapter"]
    VanityRecord.establish_connection(@options)
  end
end

Instance Method Details

#ab_add_conversion(experiment, alternative, identity, count = 1, implicit = false) ⇒ Object

Records a conversion in this experiment for the given alternative. Associates a value with the conversion (default to 1). If implicit is true, add participant if not already recorded for this experiment. If implicit is false (default), only add conversion if participant previously recorded as participating in this experiment.



286
287
288
289
290
# File 'lib/vanity/adapters/active_record_adapter.rb', line 286

def ab_add_conversion(experiment, alternative, identity, count = 1, implicit = false)
  participant = VanityParticipant.retrieve(experiment, identity, false)
  VanityParticipant.retrieve(experiment, identity, implicit, :converted => alternative, :seen => alternative)
  VanityExperiment.retrieve(experiment).increment_conversion(alternative, count)
end

#ab_add_participant(experiment, alternative, identity) ⇒ Object

Records a participant in this experiment for the given alternative.



263
264
265
# File 'lib/vanity/adapters/active_record_adapter.rb', line 263

def ab_add_participant(experiment, alternative, identity)
  VanityParticipant.retrieve(experiment, identity, true, :seen => alternative)
end

#ab_assigned(experiment, identity) ⇒ Object

Returns the participant's seen alternative in this experiment, if it exists



276
277
278
279
# File 'lib/vanity/adapters/active_record_adapter.rb', line 276

def ab_assigned(experiment, identity)
  participant = VanityParticipant.retrieve(experiment, identity, false)
  participant && participant.seen
end

#ab_counts(experiment, alternative) ⇒ Object

Returns counts for given A/B experiment and alternative (by index). Returns hash with values for the keys :participants, :converted and :conversions.



231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/vanity/adapters/active_record_adapter.rb', line 231

def ab_counts(experiment, alternative)
  record = VanityExperiment.retrieve(experiment)
  participants = VanityParticipant.where(:experiment_id => experiment.to_s, :seen => alternative).count
  converted = VanityParticipant.where(:experiment_id => experiment.to_s, :converted => alternative).count
  conversions = record.vanity_conversions.where(:alternative => alternative).sum(:conversions)

  {
    :participants => participants,
    :converted => converted,
    :conversions => conversions
  }
end

#ab_get_outcome(experiment) ⇒ Object

Returns the outcome of this experiment (if set), the index of a particular alternative.



294
295
296
# File 'lib/vanity/adapters/active_record_adapter.rb', line 294

def ab_get_outcome(experiment)
  VanityExperiment.retrieve(experiment).outcome
end

#ab_not_showing(experiment, identity) ⇒ Object

Cancels previously set association between identity and alternative. See #ab_show.



258
259
260
# File 'lib/vanity/adapters/active_record_adapter.rb', line 258

def ab_not_showing(experiment, identity)
  VanityParticipant.retrieve(experiment, identity, true, :shown => nil)
end

#ab_seen(experiment, identity, alternative_or_id) ⇒ Object

Determines if a participant already has seen this alternative in this experiment.



268
269
270
271
272
273
# File 'lib/vanity/adapters/active_record_adapter.rb', line 268

def ab_seen(experiment, identity, alternative_or_id)
  with_ab_seen_deprecation(experiment, identity, alternative_or_id) do |expt, ident, alt_id|
    participant = VanityParticipant.retrieve(expt, ident, false)
    participant && participant.seen == alt_id
  end
end

#ab_set_outcome(experiment, alternative = 0) ⇒ Object

Sets the outcome of this experiment to a particular alternative.



299
300
301
# File 'lib/vanity/adapters/active_record_adapter.rb', line 299

def ab_set_outcome(experiment, alternative = 0)
  VanityExperiment.retrieve(experiment).update_attribute(:outcome, alternative)
end

#ab_show(experiment, identity, alternative) ⇒ Object

Pick particular alternative (by index) to show to this particular participant (by identity).



246
247
248
# File 'lib/vanity/adapters/active_record_adapter.rb', line 246

def ab_show(experiment, identity, alternative)
  VanityParticipant.retrieve(experiment, identity, true, :shown => alternative)
end

#ab_showing(experiment, identity) ⇒ Object

Indicates which alternative to show to this participant. See #ab_show.



251
252
253
254
# File 'lib/vanity/adapters/active_record_adapter.rb', line 251

def ab_showing(experiment, identity)
  participant = VanityParticipant.retrieve(experiment, identity, false)
  participant && participant.shown
end

#active?Boolean

Returns:

  • (Boolean)


122
123
124
# File 'lib/vanity/adapters/active_record_adapter.rb', line 122

def active?
  VanityRecord.connected? && VanityRecord.connection.active?
end

#destroy_experiment(experiment) ⇒ Object

Deletes all information about this experiment.



304
305
306
307
308
# File 'lib/vanity/adapters/active_record_adapter.rb', line 304

def destroy_experiment(experiment)
  VanityParticipant.where(:experiment_id => experiment.to_s).delete_all
  record = VanityExperiment.find_by_experiment_id(experiment.to_s)
  record && record.destroy
end

#destroy_metric(metric) ⇒ Object



176
177
178
179
# File 'lib/vanity/adapters/active_record_adapter.rb', line 176

def destroy_metric(metric)
  record = VanityMetric.find_by_metric_id(metric.to_s)
  record && record.destroy
end

#disconnect!Object



126
127
128
# File 'lib/vanity/adapters/active_record_adapter.rb', line 126

def disconnect!
  VanityRecord.connection.disconnect! if active?
end

#experiment_persisted?(experiment) ⇒ Boolean

– Experiments –

Returns:

  • (Boolean)


184
185
186
# File 'lib/vanity/adapters/active_record_adapter.rb', line 184

def experiment_persisted?(experiment)
  VanityExperiment.find_by_experiment_id(experiment.to_s).present?
end

#flushdbObject



134
135
136
137
138
# File 'lib/vanity/adapters/active_record_adapter.rb', line 134

def flushdb
  [VanityExperiment, VanityMetric, VanityParticipant, VanityMetricValue, VanityConversion].each do |klass|
    klass.delete_all
  end
end

#get_experiment_completed_at(experiment) ⇒ Object



206
207
208
# File 'lib/vanity/adapters/active_record_adapter.rb', line 206

def get_experiment_completed_at(experiment)
  VanityExperiment.retrieve(experiment).completed_at
end

#get_experiment_created_at(experiment) ⇒ Object

Return when experiment was created.



197
198
199
200
# File 'lib/vanity/adapters/active_record_adapter.rb', line 197

def get_experiment_created_at(experiment)
  record = VanityExperiment.retrieve(experiment)
  record && record.created_at
end

#get_metric_last_update_at(metric) ⇒ Object

– Metrics –



143
144
145
146
# File 'lib/vanity/adapters/active_record_adapter.rb', line 143

def get_metric_last_update_at(metric)
  record = VanityMetric.find_by_metric_id(metric.to_s)
  record && record.updated_at
end

#is_experiment_completed?(experiment) ⇒ Boolean

Returns true if experiment completed.

Returns:

  • (Boolean)


211
212
213
# File 'lib/vanity/adapters/active_record_adapter.rb', line 211

def is_experiment_completed?(experiment)
  !!VanityExperiment.retrieve(experiment).completed_at
end

#is_experiment_enabled?(experiment) ⇒ Boolean

Returns:

  • (Boolean)


219
220
221
222
223
224
225
226
# File 'lib/vanity/adapters/active_record_adapter.rb', line 219

def is_experiment_enabled?(experiment)
  record = VanityExperiment.retrieve(experiment)
  if Vanity.configuration.experiments_start_enabled
    record.enabled != false
  else
    record.enabled == true
  end
end

#metric_track(metric, timestamp, identity, values) ⇒ Object



148
149
150
151
152
153
154
155
156
157
# File 'lib/vanity/adapters/active_record_adapter.rb', line 148

def metric_track(metric, timestamp, identity, values)
  record = VanityMetric.retrieve(metric)

  values.each_with_index do |value, index|
    record.vanity_metric_values.create(:date => timestamp.to_date.to_s, :index => index, :value => value)
  end

  record.touch_with_grace_period
  record.save
end

#metric_values(metric, from, to) ⇒ Object



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/vanity/adapters/active_record_adapter.rb', line 159

def metric_values(metric, from, to)
  connection = VanityMetric.connection
  record = VanityMetric.retrieve(metric)
  dates = (from.to_date..to.to_date).map(&:to_s)
  conditions = [connection.quote_column_name('date') + ' BETWEEN ? AND ?', from.to_date, to.to_date]
  order = "#{connection.quote_column_name('date')}"
  select = "sum(#{connection.quote_column_name('value')}) AS value, #{connection.quote_column_name('date')}"
  group_by = "#{connection.quote_column_name('date')}"

  values = record.vanity_metric_values.select(select).where(conditions).group(group_by)

  dates.map do |date|
    value = values.detect{|v| v.date == date }
    [(value && value.value) || 0]
  end
end

#reconnect!Object



130
131
132
# File 'lib/vanity/adapters/active_record_adapter.rb', line 130

def reconnect!
  VanityRecord.connection.reconnect!
end

#set_experiment_completed_at(experiment, time) ⇒ Object



202
203
204
# File 'lib/vanity/adapters/active_record_adapter.rb', line 202

def set_experiment_completed_at(experiment, time)
  VanityExperiment.retrieve(experiment).update_attribute(:completed_at, time)
end

#set_experiment_created_at(experiment, time) ⇒ Object

Store when experiment was created (do not write over existing value).



189
190
191
192
193
194
# File 'lib/vanity/adapters/active_record_adapter.rb', line 189

def set_experiment_created_at(experiment, time)
  record = VanityExperiment.find_by_experiment_id(experiment.to_s) ||
          VanityExperiment.new(:experiment_id => experiment.to_s)
  record.created_at ||= time
  record.save
end

#set_experiment_enabled(experiment, enabled) ⇒ Object



215
216
217
# File 'lib/vanity/adapters/active_record_adapter.rb', line 215

def set_experiment_enabled(experiment, enabled)
  VanityExperiment.retrieve(experiment).update_attribute(:enabled, enabled)
end

#to_sObject



310
311
312
# File 'lib/vanity/adapters/active_record_adapter.rb', line 310

def to_s
  @options.to_s
end