Class: LosantRest::Data

Inherits:
Object
  • Object
show all
Defined in:
lib/losant_rest/data.rb

Overview

Class containing all the actions for the Data Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Data

Returns a new instance of Data.



6
7
8
 
# File 'lib/losant_rest/data.rb', line 6

def initialize(client)
  @client = client
end

Instance Method Details

#last_value_query(params = {}) ⇒ Object

Returns the last known data for the given attribute

Parameters:

  • string applicationId - ID associated with the application

  • hash query - The query parameters (api.losant.com/#/definitions/lastValueQuery)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/losant_rest/data.rb', line 26

def last_value_query(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("query is required") unless params.has_key?(:query)

  body = params[:query] if params.has_key?(:query)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/data/last-value-query"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#time_series_query(params = {}) ⇒ Object

Returns the data for the given query

Parameters:

  • string applicationId - ID associated with the application

  • hash query - The query parameters (api.losant.com/#/definitions/timeSeriesQuery)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/losant_rest/data.rb', line 67

def time_series_query(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("query is required") unless params.has_key?(:query)

  body = params[:query] if params.has_key?(:query)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/data/time-series-query"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end