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.



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

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.



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

def data
  @data
end

#is_unique_identifier ⇒ Object (readonly)

Returns the value of attribute is_unique_identifier.



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

def is_unique_identifier
  @is_unique_identifier
end

Instance Method Details

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



212
213
214
215
216
217
218
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
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 212

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



257
258
259
260
261
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 257

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

#browser ⇒ Object 



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

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

#clone ⇒ Object 



263
264
265
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 263

def clone
  Visitor.new(self)
end

#conversions ⇒ Object 



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

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

#cookie ⇒ Object 



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

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

#count_sendable_data ⇒ Object 



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

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 



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

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 



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

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

#enumerate_sendable_data(&blk) ⇒ Object 



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

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

#geolocation ⇒ Object 



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

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

#get_forced_experiment_variation(experiment_id) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 178

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 



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

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 



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

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 



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

def last_activity_time
  @data.last_activity_time
end

#legal_consent ⇒ Object 



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

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 



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

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

#mapping_identifier ⇒ Object 



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

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 



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

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 



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

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 



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

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 



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

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 



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

def to_s
  'Visitor{}'
end

#update_last_activity_time ⇒ Object 



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

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

#update_simulated_variations(variations) ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/kameleoon/data/manager/visitor.rb', line 200

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 



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

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 



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

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

#visitor_visits ⇒ Object 



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

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