losant_rest 1.0.0

data/lib/losant_rest/auth.rb

@@ -0,0 +1,122 @@
+module LosantRest
+
+  # Class containing all the actions for the Auth Resource
+  class Auth
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Authenticates a device using the provided credentials
+    #
+    # Parameters:
+    # *  {hash} credentials - Device authentication credentials (https://api.losant.com/#/definitions/deviceCredentials)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Successful authentication (https://api.losant.com/#/definitions/authedDevice)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  401 - Unauthorized error if authentication fails (https://api.losant.com/#/definitions/error)
+    def authenticate_device(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("credentials is required") unless params.has_key?(:credentials)
+
+      body = params[:credentials] if params.has_key?(:credentials)
+      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 = "/auth/device"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Authenticates a user using the provided credentials
+    #
+    # Parameters:
+    # *  {hash} credentials - User authentication credentials (https://api.losant.com/#/definitions/userCredentials)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Successful authentication (https://api.losant.com/#/definitions/authedUser)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  401 - Unauthorized error if authentication fails (https://api.losant.com/#/definitions/error)
+    def authenticate_user(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("credentials is required") unless params.has_key?(:credentials)
+
+      body = params[:credentials] if params.has_key?(:credentials)
+      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 = "/auth/user"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Authenticates a user via GitHub OAuth
+    #
+    # Parameters:
+    # *  {hash} oauth - User authentication credentials (access token) (https://api.losant.com/#/definitions/githubLogin)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Successful authentication (https://api.losant.com/#/definitions/authedUser)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  401 - Unauthorized error if authentication fails (https://api.losant.com/#/definitions/error)
+    def authenticate_user_github(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("oauth is required") unless params.has_key?(:oauth)
+
+      body = params[:oauth] if params.has_key?(:oauth)
+      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 = "/auth/user/github"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/client.rb

@@ -0,0 +1,132 @@
+require "httparty"
+
+module LosantRest
+  # Losant API
+  #
+  # User API for accessing Losant data
+  #
+  # Built For Version 1.3.9
+  class Client
+    attr_accessor :auth_token, :url
+
+    def initialize(options = {})
+      self.auth_token = options.fetch(:auth_token, nil)
+      self.url        = options.fetch(:url, "https://api.losant.com")
+    end
+
+    def access_token
+      @access_token ||= AccessToken.new(self)
+    end
+
+    def access_tokens
+      @access_tokens ||= AccessTokens.new(self)
+    end
+
+    def application
+      @application ||= Application.new(self)
+    end
+
+    def application_key
+      @application_key ||= ApplicationKey.new(self)
+    end
+
+    def application_keys
+      @application_keys ||= ApplicationKeys.new(self)
+    end
+
+    def applications
+      @applications ||= Applications.new(self)
+    end
+
+    def auth
+      @auth ||= Auth.new(self)
+    end
+
+    def dashboard
+      @dashboard ||= Dashboard.new(self)
+    end
+
+    def dashboards
+      @dashboards ||= Dashboards.new(self)
+    end
+
+    def data
+      @data ||= Data.new(self)
+    end
+
+    def device
+      @device ||= Device.new(self)
+    end
+
+    def device_recipe
+      @device_recipe ||= DeviceRecipe.new(self)
+    end
+
+    def device_recipes
+      @device_recipes ||= DeviceRecipes.new(self)
+    end
+
+    def devices
+      @devices ||= Devices.new(self)
+    end
+
+    def event
+      @event ||= Event.new(self)
+    end
+
+    def events
+      @events ||= Events.new(self)
+    end
+
+    def flow
+      @flow ||= Flow.new(self)
+    end
+
+    def flows
+      @flows ||= Flows.new(self)
+    end
+
+    def me
+      @me ||= Me.new(self)
+    end
+
+    def org
+      @org ||= Org.new(self)
+    end
+
+    def orgs
+      @orgs ||= Orgs.new(self)
+    end
+
+    def webhook
+      @webhook ||= Webhook.new(self)
+    end
+
+    def webhooks
+      @webhooks ||= Webhooks.new(self)
+    end
+
+    def request(options = {})
+      headers = options.fetch(:headers, {})
+      method  = options.fetch(:method, :get)
+
+      headers["Accept"]         = "application/json"
+      headers["Content-Type"]   = "application/json"
+      headers["Accept-Version"] = "^1.3.9"
+      headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
+      path = self.url + options.fetch(:path, "")
+
+      response = HTTParty.send(method, path,
+        query: Utils.fix_query_arrays(options[:query]),
+        body: options[:body] && options[:body].to_json(),
+        headers: headers)
+
+      result = response.parsed_response
+      if response.code >= 400
+        raise ResponseError.new(response.code, result)
+      end
+
+      result
+    end
+  end
+end

data/lib/losant_rest/dashboard.rb

@@ -0,0 +1,122 @@
+module LosantRest
+
+  # Class containing all the actions for the Dashboard Resource
+  class Dashboard
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Deletes a dashboard
+    #
+    # Parameters:
+    # *  {string} dashboardId - ID of the associated dashboard
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - If dashboard was successfully deleted (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if dashboard was not found (https://api.losant.com/#/definitions/error)
+    def delete(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)
+
+      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 = "/dashboards/#{params[:dashboardId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves information on a dashboard
+    #
+    # Parameters:
+    # *  {string} dashboardId - ID of the associated dashboard
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Dashboard information (https://api.losant.com/#/definitions/dashboard)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if dashboard was not found (https://api.losant.com/#/definitions/error)
+    def get(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)
+
+      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 = "/dashboards/#{params[:dashboardId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Updates information about a dashboard
+    #
+    # Parameters:
+    # *  {string} dashboardId - ID of the associated dashboard
+    # *  {hash} dashboard - Object containing new dashboard properties (https://api.losant.com/#/definitions/dashboardPatch)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Update dashboard information (https://api.losant.com/#/definitions/dashboard)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if dashboard was not found (https://api.losant.com/#/definitions/error)
+    def patch(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)
+      raise ArgumentError.new("dashboard is required") unless params.has_key?(:dashboard)
+
+      body = params[:dashboard] if params.has_key?(:dashboard)
+      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 = "/dashboards/#{params[:dashboardId]}"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/dashboards.rb

@@ -0,0 +1,94 @@
+module LosantRest
+
+  # Class containing all the actions for the Dashboards Resource
+  class Dashboards
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the dashboards the current user has permission to see
+    #
+    # Parameters:
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId
+    # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
+    # *  {string} page - Which page of results to return
+    # *  {string} perPage - How many items to return per page
+    # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
+    # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {string} orgId - If not provided, return all dashboards. If provided but blank, only return dashboards belonging to the current user.  If provided and an id, only return dashboards belonging to the given organization id.
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Collection of dashboards (https://api.losant.com/#/definitions/dashboards)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def get(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+
+      query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
+      query_params[:page] = params[:page] if params.has_key?(:page)
+      query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
+      query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
+      query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      query_params[:orgId] = params[:orgId] if params.has_key?(:orgId)
+      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 = "/dashboards"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Create a new dasboard
+    #
+    # Parameters:
+    # *  {hash} dashboard - New dashboard information (https://api.losant.com/#/definitions/dashboardPost)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  201 - Successfully created dashboard (https://api.losant.com/#/definitions/dashboard)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def post(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("dashboard is required") unless params.has_key?(:dashboard)
+
+      body = params[:dashboard] if params.has_key?(:dashboard)
+      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 = "/dashboards"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/data.rb

@@ -0,0 +1,89 @@
+module LosantRest
+
+  # Class containing all the actions for the Data Resource
+  class Data
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the last known data for the given attribute
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} query - The query parameters (https://api.losant.com/#/definitions/lastValueQuery)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Last known data for the requested attribute (https://api.losant.com/#/definitions/lastValueData)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    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)
+      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
+
+    # Returns the data for the given query
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} query - The query parameters (https://api.losant.com/#/definitions/timeSeriesQuery)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Data for requested time range (https://api.losant.com/#/definitions/timeSeriesData)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    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)
+      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
+
+  end
+end