Class: SamsaraSDK::Client

Inherits:

Object

• Object
• SamsaraSDK::Client

Defined in:

lib/samsara_sdk/client.rb

Overview

A client for ingesting events into Samsara. It is the main interface to communicate with Samsara API.

Instance Method Summary

• #initialize(config) ⇒ Client constructor

  initialize.

• #publish_events(events) ⇒ Boolean

  Publishes given events list to Ingestion API immediately.

• #record_event(event) ⇒ Object

  Pushes event to internal events’ queue.

Constructor Details

#initialize(config) ⇒ Client

initialize

Parameters:

• config (Hash) —

  Configuration overrides.

Raises:

• (SamsaraSDK::ConfigValidationError) —

  if any config option is incorrect.

# File 'lib/samsara_sdk/client.rb', line 15

def initialize(config)
  Config.setup! config
  @publisher = Publisher.new
  @queue = RingBuffer.new(Config.get[:max_buffer_size])
  @activity = Thread.new { publishing_activity } if Config.get[:start_publishing_thread]
end

Instance Method Details

#publish_events(events) ⇒ Boolean

Publishes given events list to Ingestion API immediately.

Parameters:

• events (Array<Hash>) —

  List of events.

Returns:

• (Boolean) —

  The result of publish operation.

Raises:

• (SamsaraSDK::EventValidationError) —

  if any option of the given event is invalid.

See Also:

• Event specification

# File 'lib/samsara_sdk/client.rb', line 28

def publish_events(events)
  events = events.map { |event| Event.validate(Event.enrich(event)) }
  @publisher.post events
end

#record_event(event) ⇒ Object

Pushes event to internal events’ queue.

Parameters:

• event (Hash) —

  Event data.

• data (Hash) —

  a customizable set of options

See Also:

• Event specification

# File 'lib/samsara_sdk/client.rb', line 40

def record_event(event)
  event = Event.validate(Event.enrich(event))
  @queue << event
end