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.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 38

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.



32
33
34
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 32

def data
  @data
end

#is_unique_identifier ⇒ Object (readonly)

Returns the value of attribute is_unique_identifier.



32
33
34
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 32

def is_unique_identifier
  @is_unique_identifier
end

Instance Method Details

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 251

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|
      next if data.nil?

      case data
      when UserAgent
        @data.user_agent = data.value
      when AssignedVariation
        @data.add_variation(data, overwrite)
      when Personalization
        @data.add_personalization(data, overwrite)
      when TargetedSegment
        @data.add_targeted_segment(data)
      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 ApplicationVersion
        @data.set_application_version(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.set_visitor_visits(data, overwrite)
      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

#application_version ⇒ Object 



107
108
109
110
111
112
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 107

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

#assign_variation(variation) ⇒ Object 



306
307
308
309
310
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 306

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

#browser ⇒ Object 



86
87
88
89
90
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 86

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

#cbscores ⇒ Object 



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

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

#clone ⇒ Object 



312
313
314
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 312

def clone
  Visitor.new(self)
end

#conversions ⇒ Object 



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

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

#cookie ⇒ Object 



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

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

#count_sendable_data ⇒ Object 



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

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 



166
167
168
169
170
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 166

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 



80
81
82
83
84
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 80

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

#enumerate_sendable_data(&blk) ⇒ Object 



61
62
63
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 61

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

#geolocation ⇒ Object 



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

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

#get_forced_experiment_variation(experiment_id) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 217

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 



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

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 



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

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 



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

def last_activity_time
  @data.last_activity_time
end

#legal_consent ⇒ Object 



138
139
140
141
142
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 138

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 



144
145
146
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 144

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

#mapping_identifier ⇒ Object 



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

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 



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

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 



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

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 



172
173
174
175
176
177
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 172

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

#personalizations ⇒ Object 



191
192
193
194
195
196
197
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 191

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

#reset_forced_experiment_variation(experiment_id) ⇒ Object 



229
230
231
232
233
234
235
236
237
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 229

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

#targeted_segments ⇒ Object 



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

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

#time_started ⇒ Object 



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

def time_started
  @data.time_started
end

#to_s ⇒ Object 



34
35
36
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 34

def to_s
  'Visitor{}'
end

#update_last_activity_time ⇒ Object 



57
58
59
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 57

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

#update_simulated_variations(variations) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 239

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 



74
75
76
77
78
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 74

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 



185
186
187
188
189
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 185

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

#visitor_visits ⇒ Object 



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

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