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



102
103
104
105
106
107
108
# File 'lib/vanity/adapters/active_record_adapter.rb', line 102

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.



259
260
261
262
263
# File 'lib/vanity/adapters/active_record_adapter.rb', line 259

def ab_add_conversion(experiment, alternative, identity, count = 1, implicit = false)
  participant = VanityParticipant.retrieve(experiment, identity, false)
  VanityParticipant.retrieve(experiment, identity, implicit, :converted => 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.



238
239
240
# File 'lib/vanity/adapters/active_record_adapter.rb', line 238

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



249
250
251
252
# File 'lib/vanity/adapters/active_record_adapter.rb', line 249

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.



206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/vanity/adapters/active_record_adapter.rb', line 206

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.



267
268
269
# File 'lib/vanity/adapters/active_record_adapter.rb', line 267

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.



233
234
235
# File 'lib/vanity/adapters/active_record_adapter.rb', line 233

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

#ab_seen(experiment, identity, alternative) ⇒ Object

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



243
244
245
246
# File 'lib/vanity/adapters/active_record_adapter.rb', line 243

def ab_seen(experiment, identity, alternative)
  participant = VanityParticipant.retrieve(experiment, identity, false)
  participant && participant.seen == alternative.id
end

#ab_set_outcome(experiment, alternative = 0) ⇒ Object

Sets the outcome of this experiment to a particular alternative.



272
273
274
# File 'lib/vanity/adapters/active_record_adapter.rb', line 272

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).



221
222
223
# File 'lib/vanity/adapters/active_record_adapter.rb', line 221

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.



226
227
228
229
# File 'lib/vanity/adapters/active_record_adapter.rb', line 226

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

#active?Boolean



110
111
112
# File 'lib/vanity/adapters/active_record_adapter.rb', line 110

def active?
  VanityRecord.connected?
end

#destroy_experiment(experiment) ⇒ Object

Deletes all information about this experiment.



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

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

#destroy_metric(metric) ⇒ Object



164
165
166
167
# File 'lib/vanity/adapters/active_record_adapter.rb', line 164

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

#disconnect!Object



114
115
116
# File 'lib/vanity/adapters/active_record_adapter.rb', line 114

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

#experiment_persisted?(experiment) ⇒ Boolean

– Experiments –



172
173
174
# File 'lib/vanity/adapters/active_record_adapter.rb', line 172

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

#flushdbObject



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

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

#get_experiment_completed_at(experiment) ⇒ Object



194
195
196
# File 'lib/vanity/adapters/active_record_adapter.rb', line 194

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

#get_experiment_created_at(experiment) ⇒ Object

Return when experiment was created.



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

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

#get_metric_last_update_at(metric) ⇒ Object

– Metrics –



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

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.



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

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

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



136
137
138
139
140
141
142
143
144
145
# File 'lib/vanity/adapters/active_record_adapter.rb', line 136

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/vanity/adapters/active_record_adapter.rb', line 147

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



118
119
120
# File 'lib/vanity/adapters/active_record_adapter.rb', line 118

def reconnect!
  VanityRecord.connection.reconnect!
end

#set_experiment_completed_at(experiment, time) ⇒ Object



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

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).



177
178
179
180
181
182
# File 'lib/vanity/adapters/active_record_adapter.rb', line 177

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

#to_sObject



283
284
285
# File 'lib/vanity/adapters/active_record_adapter.rb', line 283

def to_s
  @options.to_s
end