Class: Rudder::Analytics::Client
- Inherits:
-
Object
- Object
- Rudder::Analytics::Client
- Defined in:
- lib/rudder/analytics/client.rb
Constant Summary
Constants included from Utils
Utils::UTC_OFFSET_WITHOUT_COLON, Utils::UTC_OFFSET_WITH_COLON
Instance Method Summary collapse
-
#alias(attrs) ⇒ Object
Aliases a user from one id to another.
-
#flush ⇒ Object
Synchronously waits until the worker has flushed the queue.
-
#group(attrs) ⇒ Object
Associates a user identity with a group.
-
#identify(attrs) ⇒ Object
Identifies a user.
-
#initialize(opts = {}) ⇒ Client
constructor
A new instance of Client.
-
#page(attrs) ⇒ Object
Records a page view.
-
#queued_messages ⇒ Fixnum
Number of messages in the queue.
-
#screen(attrs) ⇒ Object
Records a screen view (for a mobile app).
- #test_queue ⇒ Object
-
#track(attrs) ⇒ Object
Tracks an event.
Methods included from Logging
Methods included from Utils
#check_string, #date_in_iso8601, #datetime_in_iso8601, #formatted_offset, #isoify_dates, #isoify_dates!, #seconds_to_utc_offset, #stringify_keys, #symbolize_keys, #symbolize_keys!, #time_in_iso8601, #uid
Constructor Details
#initialize(opts = {}) ⇒ Client
Returns a new instance of Client.
27 28 29 30 31 32 33 34 |
# File 'lib/rudder/analytics/client.rb', line 27 def initialize(opts = {}) @config = Configuration.new(opts) @queue = Queue.new @worker_mutex = Mutex.new @worker = Worker.new(@queue, @config) @worker_thread = nil at_exit { @worker_thread && @worker_thread[:should_exit] = true } end |
Instance Method Details
#alias(attrs) ⇒ Object
Aliases a user from one id to another
97 98 99 100 |
# File 'lib/rudder/analytics/client.rb', line 97 def alias(attrs) symbolize_keys! attrs enqueue(FieldParser.parse_for_alias(attrs)) end |
#flush ⇒ Object
Synchronously waits until the worker has flushed the queue.
Use only for scripts which are not long-running, and will specifically exit
40 41 42 43 44 45 |
# File 'lib/rudder/analytics/client.rb', line 40 def flush while !@queue.empty? || @worker.is_requesting? ensure_worker_running sleep(0.1) end end |
#group(attrs) ⇒ Object
Associates a user identity with a group.
111 112 113 114 |
# File 'lib/rudder/analytics/client.rb', line 111 def group(attrs) symbolize_keys! attrs enqueue(FieldParser.parse_for_group(attrs)) end |
#identify(attrs) ⇒ Object
Identifies a user
83 84 85 86 87 |
# File 'lib/rudder/analytics/client.rb', line 83 def identify(attrs) # printf("\nInside Identify \n") symbolize_keys! attrs enqueue(FieldParser.parse_for_identify(attrs)) end |
#page(attrs) ⇒ Object
Records a page view
125 126 127 128 |
# File 'lib/rudder/analytics/client.rb', line 125 def page(attrs) symbolize_keys! attrs enqueue(FieldParser.parse_for_page(attrs)) end |
#queued_messages ⇒ Fixnum
Returns number of messages in the queue.
144 145 146 |
# File 'lib/rudder/analytics/client.rb', line 144 def @queue.length end |
#screen(attrs) ⇒ Object
Records a screen view (for a mobile app)
138 139 140 141 |
# File 'lib/rudder/analytics/client.rb', line 138 def screen(attrs) symbolize_keys! attrs enqueue(FieldParser.parse_for_screen(attrs)) end |
#test_queue ⇒ Object
148 149 150 151 152 |
# File 'lib/rudder/analytics/client.rb', line 148 def test_queue raise 'Test queue only available when setting :test to true.' unless @config.test @test_queue ||= TestQueue.new end |
#track(attrs) ⇒ Object
Tracks an event
70 71 72 73 |
# File 'lib/rudder/analytics/client.rb', line 70 def track(attrs) symbolize_keys! attrs enqueue(FieldParser.parse_for_track(attrs)) end |