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, VanitySchema

Instance Method Summary (collapse)

Constructor Details

- (ActiveRecordAdapter) initialize(options)

A new instance of ActiveRecordAdapter 



79
80
81
82
83
84
85
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 79

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

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

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



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

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

- (Object) ab_add_participant(experiment, alternative, identity)

Records a participant in this experiment for the given alternative. 



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

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

- (Object) ab_counts(experiment, alternative)

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



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 178

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

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

- (Object) ab_get_outcome(experiment)

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



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

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

- (Object) ab_not_showing(experiment, identity)

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



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

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

- (Object) ab_set_outcome(experiment, alternative = 0)

Sets the outcome of this experiment to a particular alternative. 



231
232
233
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 231

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

- (Object) ab_show(experiment, identity, alternative)

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



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

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

- (Object) ab_showing(experiment, identity)

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



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

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

- (Boolean) active?

Returns:

  • (Boolean) 


87
88
89
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 87

def active?
  VanityRecord.connected?
end

- (Object) destroy_experiment(experiment)

Deletes all information about this experiment. 



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

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

- (Object) destroy_metric(metric) 



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

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

- (Object) disconnect! 



91
92
93
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 91

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

- (Object) flushdb 



99
100
101
102
103
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 99

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

- (Object) get_experiment_completed_at(experiment) 



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

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

- (Object) get_experiment_created_at(experiment)

Return when experiment was created. 



157
158
159
160
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 157

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

- (Object) get_metric_last_update_at(metric) 



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

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

- (Boolean) is_experiment_completed?(experiment)

Returns true if experiment completed.

Returns:

  • (Boolean) 


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

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

- (Object) metric_track(metric, timestamp, identity, values) 



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 110

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.updated_at = Time.now
  record.save
end

- (Object) metric_values(metric, from, to) 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 121

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') + ' IN (?)', dates]
  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.all(
          :select => select,
          :conditions => conditions,
          :order => order,
          :group => group_by
  )

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

- (Object) reconnect! 



95
96
97
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 95

def reconnect!
  VanityRecord.connection.reconnect!
end

- (Object) set_experiment_completed_at(experiment, time) 



162
163
164
 
# File 'lib/vanity/adapters/active_record_adapter.rb', line 162

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

- (Object) set_experiment_created_at(experiment, time)

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



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

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

- (Object) to_s 



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

def to_s
  @options.to_s
end