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.



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

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.



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

def data
  @data
end

#is_unique_identifier ⇒ Object (readonly)

Returns the value of attribute is_unique_identifier.



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

def is_unique_identifier
  @is_unique_identifier
end

Instance Method Details

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



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
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 228

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 Personalization
        @data.add_personalization(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 



277
278
279
280
281
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 277

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

#browser ⇒ Object 



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

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

#cbscores ⇒ Object 



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

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

#clone ⇒ Object 



283
284
285
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 283

def clone
  Visitor.new(self)
end

#conversions ⇒ Object 



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

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

#cookie ⇒ Object 



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

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

#count_sendable_data ⇒ Object 



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

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 



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

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 



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

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

#enumerate_sendable_data(&blk) ⇒ Object 



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

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

#geolocation ⇒ Object 



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

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

#get_forced_experiment_variation(experiment_id) ⇒ Object 



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

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 



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

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 



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

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 



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

def last_activity_time
  @data.last_activity_time
end

#legal_consent ⇒ Object 



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

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 



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

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

#mapping_identifier ⇒ Object 



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

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 



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

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 



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

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 



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

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 



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

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

#reset_forced_experiment_variation(experiment_id) ⇒ Object 



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

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 



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

def to_s
  'Visitor{}'
end

#update_last_activity_time ⇒ Object 



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

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

#update_simulated_variations(variations) ⇒ Object 



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

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 



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

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 



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

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

#visitor_visits ⇒ Object 



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

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