Losant Ruby REST API Client

The Losant REST API client provides a simple way to use the comprehensive Losant API. You can authenticate either as a Losant device or with your user account, and have access to all the functionality of the Losant platform.

This client works with Ruby 2.3 and higher. It uses HTTParty under the covers for the actual HTTP communication.

Installation

The latest stable version is available in RubyGems and can be installed using

gem install losant_rest

Example

Below is a high-level example of using the Losant Ruby REST API client to authenticate against the Losant Platform and report state for a device.

require "platform_rest"

response = PlatformRest.auth.authenticate_device(credentials: {
  deviceId: "my-device-id",
  key: "my-app-access-key",
  secret: "my-app-access-secret"
})

PlatformRest.auth_token = response["token"]
app_id = response["applicationId"]

state = { data: { temperature: AnalogSensor.read } }
response = PlatformRest.device.send_state(deviceId: "my-device-id",
  applicationId: app_id, deviceState: state)

puts response
# { "success" => true }

API Documentation

PlatformRest

PlatformRest is the wrapping module, but it also acts as a singleton Client instance. So if you only need a single client instance, you do not need to instantiate one yourself - the PlatformRest module will act exactly like an instance of PlatformRest::Client.

PlatformRest::Client

A client is a single api instance. By default, it is unauthenticated, but can be given an access token to perform authenticated requests.

Initializer

PlatformRest::Client.new(auth_token: nil, url: "https://api.losant.com")

The Client() initializer takes the following arguments:

auth_token
The access token to be used for authentication - by default there is no access token. An access token can be acquired through any of the Auth methods, or can be created for a particular application through application_api_tokens.
url
The url of the Losant API - by default https://api.losant.com.

Client Accessors

auth_token
The access token can be accessed or changed after Client creation through this accessor.
url
The api base url can be accessed or changed after Client creation through this accessor.

Resources

Each of the following is a method on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.

application
Contains all of the actions that can be performed against a single Application, which include things like getting info on an application or modifying an application.
application_api_token
Contains all the actions that can be performed against a single Api Token belonging to an application - for instance, getting info on a single token or revoking a token.
application_api_tokens
Contains all of the actions that can be performed against the collection of Api Tokens belonging to an Application - such as listing all tokens or creating a new token.
application_certificate
Contains all the actions that can be performed against a single Application Certificate belonging to an application - for instance, getting info on a single certificate or disabling a certificate.
application_certificate_authorities
Contains all the actions that can be performed against a single Application Certificate Authority belonging to an application - for instance, getting info on an authority or disabling an authority.
application_certificate_authority
Contains all of the actions that can be performed against the collection of Application Certificate Authorities belonging to an Application - such as listing all authorities or creating a new authority.
application_certificates
Contains all of the actions that can be performed against the collection of Application Certificates belonging to an Application - such as listing all certificates or creating a new certificate.
application_cashboard
Contains all the actions that can be performed against a single Application Dashboard - for instance, things like getting info on a dashboard or modifying a dashboard.
application_dashboards
Contains all of the actions that can be performed against the collection of Application Dashboards belonging to an Application - such as listing all dashboards or creating a new dashboard.
application_key
Contains all the actions that can be performed against a single Application Key - for instance, getting info on a single key or revoking a key.
application_keys
Contains all of the actions that can be performed against the collection of Application Keys belonging to an Application - such as listing all keys or creating a new key.
applications
Contains all of the actions that can be performed against the set of Applications that the currently authenticated user has access to - such as listing the applications or creating a new application.
application_template
Contains all the actions that can be performed against a single Application Template - for instance, getting info on a single template.
application_templates
Contains all of the actions that can be performed against the collection of Application Templates - such as listing all templates or categories.
audit_log
Contains all of the actions that can be performed against a single Audit Log that belongs to an organization - such as viewing a log.
audit_logs
Contains all of the actions that can be performed against the set of Audit Logs that belong to an organization - such as listing the logs.
auth
Contains the actions used for authenticating against the api, either as a user or as a device. The result of authentication calls contain the auth_token needed for authenticated calls - see the examples for more details.
credential
Contains all the actions that can be performed against a single Service Credential, such as updating a credential or removing a credential.
credentials
Contains all of the actions that can be performed against the set of Service Credentials that the currently authenticated user has access to - such as listing the credentials or creating a new credential.
dashboard
Contains all of the actions that can be performed against a single Dashboard, which include things like getting info on a dashboard or modifying a dashboard.
dashboards
Contains all of the actions that can be performed against the set of Dashboards that the currently authenticated user has access to - such as listing the dashboards or creating a new dashboard.
data
Contains the actions for querying against historical Device data across an Application.
data_table
Contains all the actions that can be performed against a single Data Table - for instance, getting info on a single data table or modifying the columns of a data table.
data_table_row
Contains all the actions that can be performed against a single row inside of a Data Table - for instance, getting the contents of a row, or modifying a row.
data_table_rows
Contains all of the actions that can be performed against the collection of rows that make up a Data Table - such as querying for rows in that table, or adding a new row to the table.
data_tables
Contains all of the actions that can be performed against the collection of Data Tables belonging to an Application - such as listing all data tables or creating a new data table.
device
Contains all the actions that can be performed against a single Device - for instance, getting info on a single device or reporting the current state of a device.
device_recipe
Contains all the actions that can be performed against a single Device Recipe, which include things like removing a device recipe or creating a device from a device recipe.
device_recipes
Contains all the actions that can be performed against the collection of Device Recipes belonging to an Application - such as listing recipes or creating a new recipe.
devices
Contains all of the actions that can be performed against the collection of Devices belonging to an Application - such as listing all devices or sending a command to a set of devices.
edge_deployment
Contains all the actions that can be performed against a single Edge Deployment belonging to an Application - such as retrieving information on a single deployment.
edge_deployments
Contains all the actions that can be performed against the collection of Edge Deployments belonging to an Application - such as listing deployments or creating a new deployment.
embedded_deployment
Contains all the actions that can be performed against a single Embedded Deployment belonging to an Application - such as retrieving information on a single deployment.
embedded_deployments
Contains all the actions that can be performed against the collection of Embedded Deployments belonging to an Application - such as listing deployments or creating a new deployment.
event
Contains all the actions that can be performed against a single Event, such as commenting on or changing the state of an event.
events
Contains all the actions that can be performed against the collection of Events belonging to an Application - such as listing open events or creating a new event.
experience
Contains all the actions that can be performed against an application Experience, such as bootstrapping or clearing resources.
experience_domain
Contains all the actions that can be performed against a single Experience Domain, such as updating SSL certificate information.
experience_domains
Contains all the actions that can be performed against the collection of Experience Domains belonging to an Application - such as listing domains or creating a new domain.
experience_endpoint
Contains all the actions that can be performed against a single Experience Endpoint, such as updating route information.
experience_endpoints
Contains all the actions that can be performed against the collection of Experience Endpoints belonging to an Application - such as listing endpoints or creating a new endpoint.
experience_group
Contains all the actions that can be performed against a single Experience Group, such as updating member information.
experience_groups
Contains all the actions that can be performed against the collection of Experience Groups belonging to an Application - such as listing groups or creating a new group.
experience_slug
Contains all the actions that can be performed against a single Experience Slug, such as changing the associated version.
experience_slugs
Contains all the actions that can be performed against the collection of Experience Slugs belonging to an Application - such as listing slugs or creating a new slug.
experience_user
Contains all the actions that can be performed against a single Experience User, such as changing their email or password.
experience_users
Contains all the actions that can be performed against the collection of Experience Users belonging to an Application - such as listing users or creating a new user.
experience_version
Contains all the actions that can be performed against a single Experience Version, such as modifying the description.
experience_versions
Contains all the actions that can be performed against the collection of Experience Versions belonging to an Application - such as listing versions or creating a new versions.
experience_view
Contains all the actions that can be performed against a single Experience View, such as modifying the body template.
experience_views
Contains all the actions that can be performed against the collection of Experience Views belonging to an Application - such as listing views or creating a new view.
file
Contains all the actions that can be performed against a single File, such as moving, renaming, or deleting.
files
Contains all the actions that can be performed against the collection of Files belonging to an Application - such as listing files or uploading a new file.
flow
Contains all the actions that can be performed against a single Workflow, such as enabling or disabling a workflow, or triggering a virtual button in the workflow.
flows
Contains all the actions that can be performed against the collection of Workflows belonging to an Application - such as listing the workflows or creating a new workflow.
flow_version
Contains all the actions that can be performed against a single Workflow Version, such as enabling or disabling a workflow version, or updating the version notes.
flow_versions
Contains all the actions that can be performed against the collection of Workflow Versions belonging to a Workflow - such as listing the versions or creating a new version.
instance
Contains all the actions that can be performed against a single Instance, which include things such as updating report configuration or defaults.
instance_api_token
Contains all the actions that can be performed against a single Instance API Token - for instance, getting info on a single token or revoking a token.
instance_api_tokens
Contains all the actions that can be performed against the collection of Instance API Tokens belonging to an Instance - such as listing tokens or creating a new token.
instance_audit_log
Contains all of the actions that can be performed against a single Audit Log belonging to an Instance - such as viewing a log.
instance_audit_logs
Contains all of the actions that can be performed against the set of Audit Logs belonging to an Instance - such as listing the logs.
instance_custom_node
Contains all the actions that can be performed against a single Instance Custom Node - for instance, getting info on a single custom node or modifying a custom node.
instance_custom_nodes
Contains all the actions that can be performed against the collection of Instance Custom Nodes belonging to an Instance - such as listing custom nodes or creating a new custom node.
instance_member
Contains all the actions that can be performed against a single Instance Member, which include things such as updating the role or removing the member.
instance_members
Contains all the actions that can be performed against the collection of Instance Members belonging to an Instance - such as listing members or adding a new member.
instance_notification_rule
Contains all the actions that can be performed against a single Instance Notification Rule, which include things such as updating the threshold or the targets.
instance_notification_rules
Contains all the actions that can be performed against the collection of Instance Notification Rules belonging to an Instance - such as listing rules or adding a new rule.
instance_org_invite
Contains all the actions that can be performed against a single Instance Organization Invite, which include things such as revoking the invite.
instance_org_invites
Contains all the actions that can be performed against the collection of Instance Organization Invites belonging to an Organization in an Instance - such as listing invites or sending a new invitation.
instance_org_member
Contains all the actions that can be performed against a single Instance Organization Member, which include things such as changing the role or removing the membership.
instance_org_members
Contains all the actions that can be performed against the collection of Instance Organization Members belonging to an Organization in an Instance - such as listing members or adding new members.
instance_org
Contains all the actions that can be performed against a single Instance Organization, which include things such as modifying limits.
instance_orgs
Contains all the actions that can be performed against the collection of Instance Organizations belonging to an Instance - such as listing organizations or adding a new organization.
instance_sandbox
Contains all the actions that can be performed against a single Instance Sandbox - for instance, getting info on a single sandbox or deleting the sandbox.
instance_sandboxes
Contains all the actions that can be performed against the collection of Instance Sandboxes belonging to an Instance - such as listing sandboxes.
instances
Contains all the actions that can be performed against the collection of Instances that the currently authenticated user has access to - such as listing instances.
integration
Contains all the actions that can be performed against a single Integration, which include things like removing an integration or updating integration configuration.
integrations
Contains all the actions that can be performed against the collection of Integrations belonging to an Application - such as listing integrations or creating a new integration.
me
Contains the actions for operating against the currently authenticated User such as changing the password or linking against external services.
notebook
Contains all the actions that can be performed against a single Notebook, which include things like removing a notebook or executing a notebook.
notebooks
Contains all the actions that can be performed against the collection of Notebooks belonging to an Application - such as listing notebooks or creating a new notebook.
org_invites
Contains all of the actions that can be performed against a invitation to an organization, such as accepting the invitation.
org
Contains all the actions that can be performed against a single Organization, things like inviting a user to the organization, or modifying the organization.
orgs
Contains all of the actions that can be performed against the set of Organizations that the currently authenticated user has access to - such as listing the organizations or creating a new organization.
resource_job
Contains all the actions that can be performed against a single Resource Job, such as executing the job.
resource_jobs
Contains all the actions that can be performed against the collection of Resource Jobs belonging to an Application - such as listing resource jobs or creating a new resource job.
user_api_token
Contains all the actions that can be performed against a single User API Token, such as revoking the token.
user_api_tokens
Contains all the actions that can be performed against the collection of User API Tokens belonging to the currently authenticated user - such as listing tokens or creating a new token.
webhook
Contains all the actions that can be performed against a single Webhook, for instance modifying the verification settings or removing the webhook.
webhooks
Contains all the actions that can be performed against the collection of Webhooks belonging to an Application - such as listing the webhooks or creating a new webhook.

PlatformRest::ResponseError

When the Losant API returns a unsuccessful response, an instance of ResponseError is thrown.

ResponseError Accessors

code
The status code returned from the Losant API.
type
The type of error that occurred, such as "Validation" or "Authorization".
message
A more detailed message about the particulars of the error.

Copyright (c) 2024 Losant IoT, Inc

https://www.losant.com

License

Losant/losant-rest-ruby

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 3

Uh oh!

Languages

Packages