Class: Kameleoon::DataManager::Visitor

Inherits:
Object
  • Object
show all
Defined in:
lib/kameleoon/data/manager/visitor.rb

Overview

Visitor is a container of all data assigned to a visitor. It is thread-safe

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source = nil) ⇒ Visitor

Returns a new instance of Visitor.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 33

def initialize(source = nil)
  if source.nil?
    @data = VisitorData.new
    @is_unique_identifier = false
  else
    @data = source.data
    @is_unique_identifier = source.is_unique_identifier
  end
  update_last_activity_time
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



27
28
29
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 27

def data
  @data
end

#is_unique_identifier ⇒ Object (readonly)

Returns the value of attribute is_unique_identifier.



27
28
29
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 27

def is_unique_identifier
  @is_unique_identifier
end

Instance Method Details

#add_data(*args, overwrite: true) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 219

def add_data(*args, overwrite: true)
  Logging::KameleoonLogger.debug('CALL: Visitor.add_data(args: %s, overwrite: %s)', args, overwrite)
  @data.mutex.with_write_lock do
    args.each do |data|
      case data
      when UserAgent
        @data.user_agent = data.value
      when AssignedVariation
        @data.add_variation(data, overwrite)
      when ForcedFeatureVariation
        @data.add_forced_feature_variation(data)
      when ForcedExperimentVariation
        @data.add_forced_experiment_variation(data)
      when Device
        @data.set_device(data, overwrite)
      when Browser
        @data.set_browser(data, overwrite)
      when CustomData
        @data.add_custom_data(data, overwrite)
      when PageView
        @data.add_page_view(data)
      when PageViewVisit
        @data.add_page_view_visit(data)
      when Conversion
        @data.add_conversion(data)
      when Cookie
        @data.cookie = data
      when OperatingSystem
        @data.set_operating_system(data, overwrite)
      when Geolocation
        @data.set_geolocation(data, overwrite)
      when KcsHeat
        @data.kcs_heat = data
      when CBScores
        @data.set_cbscores(data, overwrite)
      when VisitorVisits
        @data.visitor_visits = data
      when UniqueIdentifier
        @is_unique_identifier = data.value
      else
        Logging::KameleoonLogger.warning("Data has unsupported type '%s'", data.class)
      end
    end
  end
  Logging::KameleoonLogger.debug('RETURN: Visitor.add_data(args: %s, overwrite: %s)', args, overwrite)
end

#assign_variation(variation) ⇒ Object 



266
267
268
269
270
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 266

def assign_variation(variation)
  @data.mutex.with_write_lock do
    @data.add_variation(variation, true)
  end
end

#browser ⇒ Object 



77
78
79
80
81
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 77

def browser
  browser = @data.browser
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.browser -> (browser: %s)', browser)
  browser
end

#cbscores ⇒ Object 



110
111
112
113
114
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 110

def cbscores
  cbs = @data.cbscores
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.cbscores -> (cbs: %s)', cbs)
  cbs
end

#clone ⇒ Object 



272
273
274
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 272

def clone
  Visitor.new(self)
end

#conversions ⇒ Object 



163
164
165
166
167
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 163

def conversions
  conversions = @data.conversions
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.conversions -> (conversions: %s)', conversions)
  conversions
end

#cookie ⇒ Object 



98
99
100
101
102
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 98

def cookie
  cookie = @data.cookie
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.cookie -> (cookie: %s)', cookie)
  cookie
end

#count_sendable_data ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 56

def count_sendable_data
  count_sendable_data = @data.count_sendable_data
  Logging::KameleoonLogger.debug(
    'CALL/RETURN: Visitor.count_sendable_data -> (count_sendable_data: %s)',
    count_sendable_data
  )
  count_sendable_data
end

#custom_data ⇒ Object 



150
151
152
153
154
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 150

def custom_data
  custom_data = @data.custom_data
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.custom_data -> (custom_data: %s)', custom_data)
  custom_data
end

#device ⇒ Object 



71
72
73
74
75
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 71

def device
  device = @data.device
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.device -> (device: %s)', device)
  device
end

#enumerate_sendable_data(&blk) ⇒ Object 



52
53
54
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 52

def enumerate_sendable_data(&blk)
  @data.enumerate_sendable_data(&blk)
end

#geolocation ⇒ Object 



83
84
85
86
87
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 83

def geolocation
  geolocation = @data.geolocation
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.geolocation -> (geolocation: %s)', geolocation)
  geolocation
end

#get_forced_experiment_variation(experiment_id) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 185

def get_forced_experiment_variation(experiment_id)
  Logging::KameleoonLogger.debug(
    'CALL: Visitor.get_forced_experiment_variation(experiment_id: %d)', experiment_id
  )
  variation = @data.get_from_map(@data.forced_variations, experiment_id)
  Logging::KameleoonLogger.debug(
    'RETURN: Visitor.get_forced_experiment_variation(experiment_id: %d) -> (variation: %s)',
    experiment_id, variation
  )
  variation
end

#get_forced_feature_variation(feature_key) ⇒ Object 



175
176
177
178
179
180
181
182
183
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 175

def get_forced_feature_variation(feature_key)
  Logging::KameleoonLogger.debug("CALL: Visitor.get_forced_feature_variation(feature_key: '%s')", feature_key)
  variation = @data.get_from_map(@data.simulated_variations, feature_key)
  Logging::KameleoonLogger.debug(
    "RETURN: Visitor.get_forced_feature_variation(feature_key: '%s') -> (variation: %s)",
    feature_key, variation
  )
  variation
end

#kcs_heat ⇒ Object 



104
105
106
107
108
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 104

def kcs_heat
  kcs_heat = @data.kcs_heat
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.kcs_heat -> (kcs_heat: %s)', kcs_heat)
  kcs_heat
end

#last_activity_time ⇒ Object 



44
45
46
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 44

def last_activity_time
  @data.last_activity_time
end

#legal_consent ⇒ Object 



122
123
124
125
126
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 122

def legal_consent
  legal_consent = @data.legal_consent
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.legal_consent -> (legal_consent: %s)', legal_consent)
  legal_consent
end

#legal_consent=(value) ⇒ Object 



128
129
130
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 128

def legal_consent=(value)
  @data.legal_consent = value
end

#mapping_identifier ⇒ Object 



132
133
134
135
136
137
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 132

def mapping_identifier
  mapping_identifier = @data.mapping_identifier
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.mapping_identifier -> (mapping_identifier: %s)',
                                 mapping_identifier)
  mapping_identifier
end

#mapping_identifier=(value) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 139

def mapping_identifier=(value)
  return unless @data.mapping_identifier.nil?

  @data.mutex.with_write_lock do
    if @data.mapping_identifier.nil?
      @data.mapping_identifier = value
      Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.mapping_identifier = %s', value)
    end
  end
end

#operating_system ⇒ Object 



89
90
91
92
93
94
95
96
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 89

def operating_system
  operating_system = @data.operating_system
  Logging::KameleoonLogger.debug(
    'CALL/RETURN: Visitor.operating_system -> (operating_system: %s)',
    operating_system
  )
  operating_system
end

#page_view_visits ⇒ Object 



156
157
158
159
160
161
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 156

def page_view_visits
  page_view_visits = @data.page_view_visits
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.page_view_visits -> (page_view_visits: %s)',
                                 page_view_visits)
  page_view_visits
end

#reset_forced_experiment_variation(experiment_id) ⇒ Object 



197
198
199
200
201
202
203
204
205
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 197

def reset_forced_experiment_variation(experiment_id)
  Logging::KameleoonLogger.debug(
    'CALL: Visitor.reset_forced_experiment_variation(experiment_id: %d)', experiment_id
  )
  @data.remove_from_map(@data.forced_variations, experiment_id)
  Logging::KameleoonLogger.debug(
    'RETURN: Visitor.reset_forced_experiment_variation(experiment_id: %d)', experiment_id
  )
end

#to_s ⇒ Object 



29
30
31
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 29

def to_s
  'Visitor{}'
end

#update_last_activity_time ⇒ Object 



48
49
50
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 48

def update_last_activity_time
  @data.last_activity_time = Time.new.to_i
end

#update_simulated_variations(variations) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 207

def update_simulated_variations(variations)
  return if (@data.simulated_variations.nil? || @data.simulated_variations.empty?) && variations.empty?

  Logging::KameleoonLogger.debug('CALL: Visitor.update_simulated_variations(variations: %s)', variations)
  new_simulated_variations = {}
  variations.each { |sv| new_simulated_variations[sv.feature_key] = sv }
  @data.mutex.with_write_lock do
    @data.simulated_variations = new_simulated_variations
  end
  Logging::KameleoonLogger.debug('RETURN: Visitor.update_simulated_variations(variations: %s)', variations)
end

#user_agent ⇒ Object 



65
66
67
68
69
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 65

def user_agent
  user_agent = @data.user_agent
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.user_agent -> (user_agent: %s)', user_agent)
  user_agent
end

#variations ⇒ Object 



169
170
171
172
173
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 169

def variations
  variations = @data.variations
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.variations -> (variations: %s)', variations)
  variations
end

#visitor_visits ⇒ Object 



116
117
118
119
120
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 116

def visitor_visits
  visitor_visits = @data.visitor_visits
  Logging::KameleoonLogger.debug('CALL/RETURN: Visitor.visitor_visits -> (visitor_visits: %s)', visitor_visits)
  visitor_visits
end