losant_rest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c00f2713b0820ca3b059e735ecfacdbbf3587f80
+  data.tar.gz: 368a50fbd34057937155bcbfbcd0b93374dc948f
+SHA512:
+  metadata.gz: c9f795186f951323494463a3034016ceaf27431e7471f0b712bcf7f9305a673ac3cc7d61d1562a905fe81d695d64fe8287e7faf78b039c760e3916a1e1bcaad7
+  data.tar.gz: 7ccb33ee4592955cde6d094e01a2a7bba6aa50b32b36a65bd22be538d66d6491f7aaac0b48e38b13300949f208408c85b88f1983f36fdb4d0960c67cd8bcb18d

data/.gitignore

@@ -0,0 +1,23 @@
+*~
+\#*
+.\#*
+.DS_Store
+*_flymake.*
+*.LCK
+.bundle
+vendor/bundle
+bin
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+_yardoc
+coverage
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock

data/.rbenv-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 2.3.1
+ - 2.2.5
+ - 2.1.10

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Losant IoT, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,237 @@
+# Losant Ruby REST API Client
+
+[![Build Status](https://travis-ci.org/Losant/losant-rest-ruby.svg?branch=master)](https://travis-ci.org/Losant/losant-rest-ruby)
+
+The [Losant](https://www.losant.com>) 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.1 and higher. It uses
+[HTTParty](https://github.com/jnunemaker/httparty) under the
+covers for the actual HTTP communication.
+
+<br/>
+
+## Installation
+
+The latest stable version is available in RubyGems and can be installed using
+
+```bash
+gem install losant_rest
+```
+
+<br/>
+
+## 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.
+
+```ruby
+require "losant_rest"
+
+response = LosantRest.auth.authenticate_device(credentials: {
+  deviceId: "my-device-id",
+  key: "my-app-access-key",
+  secret: "my-app-access-secret"
+})
+
+LosantRest.auth_token = response["token"]
+app_id = response["applicationId"]
+
+state = { data: { temperature: AnalogSensor.read } }
+response = LosantRest.device.send_state(deviceId: "my-device-id",
+  applicationId: app_id, deviceState: state)
+
+puts response
+# { "success" => true }
+```
+
+<br/>
+
+## API Documentation
+
+### LosantRest
+
+LosantRest is the wrapping module, but it also acts as a singleton [Client](#losantrestclient)
+instance.  So if you only need a single client instance, you do not need to
+instantiate one yourself - the LosantRest module will act exactly like an
+instance of LosantRest::Client.
+
+<br/>
+
+### LosantRest::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
+
+```ruby
+LosantRest::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 either of the
+[Auth](docs/auth.md) methods.
+
+*   url  
+The url of the Losant API - by default <https://api.losant.com>.
+
+#### Accessors
+
+*   auth_token  
+The auth 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_key](docs/applicationKey.md)  
+Contains all the actions that can be performed against a single
+[Application Key](https://docs.losant.com/applications/access-keys/) -
+for instance, getting info on a single key or revoking a key.
+
+*   [application_keys](docs/applicationKeys.md)  
+Contains all of the actions that can be performed against the collection of
+[Application Keys](https://docs.losant.com/applications/access-keys/) belonging
+to an Application - such as listing all keys or creating a new key.
+
+*   [application](docs/application.md)  
+Contains all of the actions that can be performed against a single
+[Application](https://docs.losant.com/applications/overview/),
+which include things like getting info on an application or
+modifying an application.
+
+*   [applications](docs/applications.md)  
+Contains all of the actions that can be performed against the set of
+[Applications](https://docs.losant.com/applications/overview/) that the
+currently authenticated user has access to - such as
+listing the applications or creating a new application.
+
+*   [auth](docs/auth.md)  
+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.
+
+*   [dashboard](docs/dashboard.md)  
+Contains all of the actions that can be performed against a single
+[Dashboard](https://docs.losant.com/dashboards/overview/),
+which include things like getting info on a dashboard or
+modifying a dashboard.
+
+*   [dashboards](docs/dashboards.md)  
+Contains all of the actions that can be performed against the set of
+[Dashboards](https://docs.losant.com/dashboards/overview/) that the
+currently authenticated user has access to - such as
+listing the dashboards or creating a new dashboard.
+
+*   [data](docs/data.md)  
+Contains the actions for querying against historical Device
+data across an Application.
+
+*   [device](docs/device.md)  
+Contains all the actions that can be performed against a single
+[Device](https://docs.losant.com/devices/overview/) -
+for instance, getting info on a single device or reporting the current
+state of a device.
+
+*   [devices](docs/devices.md)  
+Contains all of the actions that can be performed against the collection of
+[Devices](https://docs.losant.com/devices/overview/) belonging
+to an Application - such as listing all devices or sending a command to a set
+of devices.
+
+*   [device_recipe](docs/deviceRecipe.md)  
+Contains all the actions that can be performed against a single
+[Device Recipe](https://docs.losant.com/devices/device-recipes/), which
+include things like removing a device recipe or creating a device
+from a device recipe.
+
+*   [device_recipes](docs/deviceRecipes.md)  
+Contains all the actions that can be performed against the collection of
+[Device Recipes](https://docs.losant.com/devices/device-recipes/) belonging
+to an Application - such as listing recipes or creating a new recipe.
+
+*   [event](docs/event.md)  
+Contains all the actions that can be performed against a single
+[Event](https://docs.losant.com/events/overview/), such as commenting on
+or changing the state of an event.
+
+*   [events](docs/events.md)  
+Contains all the actions that can be performed against the collection of
+[Events](https://docs.losant.com/events/overview/) belonging
+to an Application - such as listing open events or creating a new event.
+
+*   [flow](docs/flow.md)  
+Contains all the actions that can be performed against a single
+[Workflow](https://docs.losant.com/workflows/overview/), such as enabling or
+disabling a workflow, or triggering a virtual button in the workflow.
+
+*   [flows](docs/flows.md)  
+Contains all the actions that can be performed against the collection of
+[Workflows](https://docs.losant.com/workflows/overview/) belonging
+to an Application - such as listing the workflows or creating a new workflow.
+
+*   [me](docs/me.md)  
+Contains the actions for operating against the currently authenticated
+[User](https://docs.losant.com/user-accounts/overview/) such as changing
+the password or linking against external services.
+
+*   [org](docs/org.md)  
+Contains all the actions that can be performed against a single
+[Organization](https://docs.losant.com/organizations/overview/), things like
+inviting a user to the organization, or modifying the organization.
+
+*   [orgs](docs/orgs.md)  
+Contains all of the actions that can be performed against the set of
+[Organizations](https://docs.losant.com/organizations/overview/) that the
+currently authenticated user has access to - such as
+listing the organizations or creating a new organization.
+
+*   [webhook](docs/webhook.md)  
+Contains all the actions that can be performed against a single
+[Webhook](https://docs.losant.com/applications/webhooks/), for instance
+modifying the verification settings or removing the webhook.
+
+*   [webhooks](docs/webhooks.md)  
+Contains all the actions that can be performed against the collection of
+[Webhooks](https://docs.losant.com/applications/webhooks/) belonging
+to an Application - such as listing the webhooks or creating a new webhook.
+
+<br/>
+
+### LosantRest::ResponseError
+
+When the Losant API returns a unsuccessful response, an instance of
+ResponseError is thrown.
+
+#### Accessors
+
+*   code  
+The status code returned from the Losant API.
+
+*   type  
+The type of error that occured, such as "Validation" or "Authorization".
+
+*   message  
+A more detailed message about the particulars of the error.
+
+<br/>
+
+*****
+
+Copyright (c) 2016 Losant IoT, Inc
+
+<https://www.losant.com>

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Default: run unit tests."
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end