Class: Kameleoon::DataManager::VisitorData

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeVisitorData

Returns a new instance of VisitorData.



298
299
300
301
302
303
304
# File 'lib/kameleoon/data/manager/visitor.rb', line 298

def initialize
  Logging::KameleoonLogger.debug('CALL: VisitorData.new')
  @time_started = (Time.now.to_f * 1000).to_i
  @mutex = Concurrent::ReadWriteLock.new
  @legal_consent = false
  Logging::KameleoonLogger.debug('RETURN: VisitorData.new')
end

Instance Attribute Details

#browserObject (readonly)

Returns the value of attribute browser.



294
295
296
# File 'lib/kameleoon/data/manager/visitor.rb', line 294

def browser
  @browser
end

#cbscoresObject

Returns the value of attribute cbscores.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def cbscores
  @cbscores
end

Returns the value of attribute cookie.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def cookie
  @cookie
end

#deviceObject (readonly)

Returns the value of attribute device.



294
295
296
# File 'lib/kameleoon/data/manager/visitor.rb', line 294

def device
  @device
end

#forced_variationsObject

Returns the value of attribute forced_variations.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def forced_variations
  @forced_variations
end

#geolocationObject (readonly)

Returns the value of attribute geolocation.



294
295
296
# File 'lib/kameleoon/data/manager/visitor.rb', line 294

def geolocation
  @geolocation
end

#kcs_heatObject

Returns the value of attribute kcs_heat.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def kcs_heat
  @kcs_heat
end

#last_activity_timeObject

Returns the value of attribute last_activity_time.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def last_activity_time
  @last_activity_time
end

Returns the value of attribute legal_consent.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def legal_consent
  @legal_consent
end

#mapping_identifierObject

Returns the value of attribute mapping_identifier.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def mapping_identifier
  @mapping_identifier
end

#mutexObject (readonly)

Returns the value of attribute mutex.



294
295
296
# File 'lib/kameleoon/data/manager/visitor.rb', line 294

def mutex
  @mutex
end

#operating_systemObject (readonly)

Returns the value of attribute operating_system.



294
295
296
# File 'lib/kameleoon/data/manager/visitor.rb', line 294

def operating_system
  @operating_system
end

#simulated_variationsObject

Returns the value of attribute simulated_variations.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def simulated_variations
  @simulated_variations
end

#time_startedObject (readonly)

Returns the value of attribute time_started.



294
295
296
# File 'lib/kameleoon/data/manager/visitor.rb', line 294

def time_started
  @time_started
end

#user_agentObject

Returns the value of attribute user_agent.



295
296
297
# File 'lib/kameleoon/data/manager/visitor.rb', line 295

def user_agent
  @user_agent
end

#visitor_visitsObject (readonly)

Returns the value of attribute visitor_visits.



294
295
296
# File 'lib/kameleoon/data/manager/visitor.rb', line 294

def visitor_visits
  @visitor_visits
end

Instance Method Details

#add_conversion(conversion) ⇒ Object



427
428
429
430
# File 'lib/kameleoon/data/manager/visitor.rb', line 427

def add_conversion(conversion)
  @conversions ||= []
  @conversions.push(conversion)
end

#add_custom_data(custom_data, overwrite) ⇒ Object



396
397
398
399
400
401
# File 'lib/kameleoon/data/manager/visitor.rb', line 396

def add_custom_data(custom_data, overwrite)
  @custom_data_map ||= {}
  if overwrite || !@custom_data_map.include?(custom_data.id)
    @custom_data_map[custom_data.id] = custom_data
  end
end

#add_forced_experiment_variation(forced_variation) ⇒ Object



453
454
455
456
# File 'lib/kameleoon/data/manager/visitor.rb', line 453

def add_forced_experiment_variation(forced_variation)
  @forced_variations ||= {}
  @forced_variations[forced_variation.rule.experiment.id] = forced_variation
end

#add_forced_feature_variation(forced_variation) ⇒ Object



448
449
450
451
# File 'lib/kameleoon/data/manager/visitor.rb', line 448

def add_forced_feature_variation(forced_variation)
  @simulated_variations ||= {}
  @simulated_variations[forced_variation.feature_key] = forced_variation
end

#add_page_view(page_view) ⇒ Object



403
404
405
406
407
408
409
410
411
412
413
414
# File 'lib/kameleoon/data/manager/visitor.rb', line 403

def add_page_view(page_view)
  return if page_view.url.nil? || page_view.url.empty?

  @page_view_visits ||= {}
  visit = @page_view_visits[page_view.url]
  if visit.nil?
    visit = PageViewVisit.new(page_view)
  else
    visit.overwrite(page_view)
  end
  @page_view_visits[page_view.url] = visit
end

#add_page_view_visit(page_view_visit) ⇒ Object



416
417
418
419
420
421
422
423
424
425
# File 'lib/kameleoon/data/manager/visitor.rb', line 416

def add_page_view_visit(page_view_visit)
  @page_view_visits ||= {}
  visit = @page_view_visits[page_view_visit.page_view.url]
  if visit.nil?
    visit = page_view_visit
    @page_view_visits[page_view_visit.page_view.url] = visit
  else
    visit.merge(page_view_visit)
  end
end

#add_personalization(personalization, overwrite) ⇒ Object



385
386
387
388
389
390
# File 'lib/kameleoon/data/manager/visitor.rb', line 385

def add_personalization(personalization, overwrite)
  @personalizations ||= {}
  if overwrite || !@personalizations.include?(personalization.id)
    @personalizations[personalization.id] = personalization
  end
end

#add_variation(variation, overwrite) ⇒ Object



378
379
380
381
382
383
# File 'lib/kameleoon/data/manager/visitor.rb', line 378

def add_variation(variation, overwrite)
  @variations ||= {}
  if overwrite || !@variations.include?(variation.experiment_id)
    @variations[variation.experiment_id] = variation
  end
end

#conversionsObject



362
363
364
# File 'lib/kameleoon/data/manager/visitor.rb', line 362

def conversions
  DataArrayStorage.new(@mutex, @conversions)
end

#count_sendable_dataObject



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/kameleoon/data/manager/visitor.rb', line 336

def count_sendable_data
  Logging::KameleoonLogger.debug('CALL: Visitor.count_sendable_data')
  count = 0
  @mutex.with_read_lock do
    count += 1 unless @device.nil?
    count += 1 unless @browser.nil?
    count += 1 unless @operating_system.nil?
    count += 1 unless @geolocation.nil?
    count += 1 unless @visitor_visits.nil?
    count += @custom_data_map.size unless @custom_data_map.nil?
    count += @page_view_visits.size unless @page_view_visits.nil?
    count += @conversions.size unless @conversions.nil?
    count += @variations.size unless @variations.nil?
  end
  Logging::KameleoonLogger.debug('RETURN: VisitorData.count_sendable_data -> (count: %s)', count)
  count
end

#custom_dataObject



354
355
356
# File 'lib/kameleoon/data/manager/visitor.rb', line 354

def custom_data
  DataMapStorage.new(@mutex, @custom_data_map)
end

#enumerate_sendable_data(&blk) ⇒ Object



322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/kameleoon/data/manager/visitor.rb', line 322

def enumerate_sendable_data(&blk)
  blk.call(@device) unless @device.nil?
  blk.call(@browser) unless @browser.nil?
  blk.call(@operating_system) unless @operating_system.nil?
  blk.call(@geolocation) unless @geolocation.nil?
  blk.call(@visitor_visits) unless @visitor_visits.nil?
  @mutex.with_read_lock do
    @custom_data_map&.each { |_, cd| blk.call(cd) }
    @page_view_visits&.each { |_, pvv| blk.call(pvv.page_view) }
    @variations&.each { |_, av| blk.call(av) }
    @conversions&.each { |c| blk.call(c) }
  end
end

#get_from_map(map, key) ⇒ Object



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

def get_from_map(map, key)
  return nil if map.nil?

  @mutex.with_read_lock do
    return map[key]
  end
end

#page_view_visitsObject



358
359
360
# File 'lib/kameleoon/data/manager/visitor.rb', line 358

def page_view_visits
  DataMapStorage.new(@mutex, @page_view_visits)
end

#personalizationsObject



370
371
372
# File 'lib/kameleoon/data/manager/visitor.rb', line 370

def personalizations
  DataMapStorage.new(@mutex, @personalizations)
end

#remove_from_map(map, key) ⇒ Object



314
315
316
317
318
319
320
# File 'lib/kameleoon/data/manager/visitor.rb', line 314

def remove_from_map(map, key)
  return false if map.nil?

  @mutex.with_write_lock do
    return map.delete(key).nil?
  end
end

#set_browser(browser, overwrite) ⇒ Object



392
393
394
# File 'lib/kameleoon/data/manager/visitor.rb', line 392

def set_browser(browser, overwrite)
  @browser = browser if overwrite || @browser.nil?
end

#set_cbscores(cbs, overwrite) ⇒ Object



440
441
442
# File 'lib/kameleoon/data/manager/visitor.rb', line 440

def set_cbscores(cbs, overwrite)
  @cbscores = cbs if overwrite || @cbscores.nil?
end

#set_device(device, overwrite) ⇒ Object



374
375
376
# File 'lib/kameleoon/data/manager/visitor.rb', line 374

def set_device(device, overwrite)
  @device = device if overwrite || @device.nil?
end

#set_geolocation(geolocation, overwrite) ⇒ Object



432
433
434
# File 'lib/kameleoon/data/manager/visitor.rb', line 432

def set_geolocation(geolocation, overwrite)
  @geolocation = geolocation if overwrite || @geolocation.nil?
end

#set_operating_system(operating_system, overwrite) ⇒ Object



436
437
438
# File 'lib/kameleoon/data/manager/visitor.rb', line 436

def set_operating_system(operating_system, overwrite)
  @operating_system = operating_system if overwrite || @operating_system.nil?
end

#set_visitor_visits(visitor_visits, overwrite) ⇒ Object



444
445
446
# File 'lib/kameleoon/data/manager/visitor.rb', line 444

def set_visitor_visits(visitor_visits, overwrite)
  @visitor_visits = visitor_visits.localize(@time_started) if overwrite || @visitor_visits.nil?
end

#variationsObject



366
367
368
# File 'lib/kameleoon/data/manager/visitor.rb', line 366

def variations
  DataMapStorage.new(@mutex, @variations)
end