losant_rest 1.0.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa89df708bd760446b6363a5569bb4f7fcf7587a
-  data.tar.gz: 19d586e20e4175df26ba23d0c76a6e0a1c5a54f7
+  metadata.gz: 5b74c9b492d6498697feab633430ab0790eab2a7
+  data.tar.gz: fa8a9c085dbd15f77acab0e6eb412e70da18dd73
 SHA512:
-  metadata.gz: b43deaeb6692f62bb97f345435e09446b5a1066a8e542bfdacc336391a98bf4b79fc03838fd9b5231f1a07735591f232325e99427d4b3269386e3ad261a5488f
-  data.tar.gz: 9b90368c75825a670da76a65af9391bd5859c346d61ba2ad7ad12bcd8c3b8497a5b71c250d3bbf8e2f1057b5202f58995f2f77191ffb158e9306708b3a68b55f
+  metadata.gz: fd011d46ecbeaf42c01e89927b7b264e424c4cfe5f481f31e408acd266265312fc91f51b3957f240dba4b4b02903cc291d33bbe71b77a7d8c6b430cd04d60409
+  data.tar.gz: 1ed1197464f09daa830f5f33a03811ebcce34e2d9eb0e8a148c2d1d950446f61e6e1ed50bd204df34768d28d82a39009759f70e851599f06eb246cafd7474663

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
- - 2.3.1
- - 2.2.5
+ - 2.4.0
+ - 2.3.3
+ - 2.2.6
  - 2.1.10

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/Losant/losant-rest-ruby.svg?branch=master)](https://travis-ci.org/Losant/losant-rest-ruby)  [![Gem Version](https://badge.fury.io/rb/losant_rest.svg)](https://badge.fury.io/rb/losant_rest)
 
 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
+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.
 
@@ -55,7 +55,7 @@ puts response
 ### 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
+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.
 
@@ -63,7 +63,7 @@ instance of LosantRest::Client.
 
 ### LosantRest::Client
 
-A client is a single api instance.  By default, it is unauthenticated, but can
+A client is a single api instance. By default, it is unauthenticated, but can
 be given an access token to perform authenticated requests.
 
 #### Initializer
@@ -76,8 +76,9 @@ 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.
+access token. An access token can be acquired through any of the
+[Auth](docs/auth.md) methods, or can be created for a particular application
+through [application_api_tokens](docs/applicationApiTokens.md).
 
 *   url  
 The url of the Losant API - by default <https://api.losant.com>.
@@ -85,7 +86,7 @@ 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
+The access token can be accessed or changed after Client creation
 through this accessor.
 
 *   url  
@@ -95,9 +96,19 @@ 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
+for the actions against that particular resource. See each resource
 documentation file for more information.
 
+*   [application_api_token](docs/applicationApiToken.md)  
+Contains all the actions that can be performed against a single
+Api Token beloging to an application - for instance, getting info
+on a single token or revoking a token.
+
+*   [application_api_tokens](docs/applicationApiTokens.md)  
+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_key](docs/applicationKey.md)  
 Contains all the actions that can be performed against a single
 [Application Key](https://docs.losant.com/applications/access-keys/) -
@@ -122,7 +133,7 @@ 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
+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)  

data/docs/_schemas.md

@@ -1,10 +1,9 @@
 # Schemas
 
-*   [Access Token](#access-token)
-*   [Access Token Patch](#access-token-patch)
-*   [Access Token Post](#access-token-post)
-*   [Access Tokens](#access-tokens)
+*   [API Token](#api-token)
+*   [API Token Patch](#api-token-patch)
 *   [Application](#application)
+*   [Application API Token Post](#application-api-token-post)
 *   [Application Key](#application-key)
 *   [Application Key Patch](#application-key-patch)
 *   [Application Key Post](#application-key-post)
@@ -93,11 +92,11 @@
 *   [Webhook Post](#webhook-post)
 *   [Webhooks](#webhooks)
 
-## Access Token
+## API Token
 
-Schema for a single Access Token
+Schema for a single API Token
 
-### <a name="access-token-schema"></a> Schema
+### <a name="api-token-schema"></a> Schema
 
 ```json
 {
@@ -108,19 +107,45 @@ Schema for a single Access Token
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
-    "accessTokenId": {
+    "apiTokenId": {
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
-    "userId": {
+    "ownerId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "ownerType": {
+      "type": "string",
+      "enum": [
+        "application"
+      ]
+    },
+    "creatorId": {
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
+    "creatorType": {
+      "type": "string",
+      "enum": [
+        "apiToken",
+        "user",
+        "flow"
+      ]
+    },
+    "creatorName": {
+      "type": "string",
+      "maxLength": 1024
+    },
     "name": {
       "type": "string",
       "minLength": 1,
       "maxLength": 255
     },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
     "creationDate": {
       "type": "string",
       "format": "date-time"
@@ -136,7 +161,9 @@ Schema for a single Access Token
     "scope": {
       "type": "array",
       "items": {
-        "type": "string"
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 1024
       }
     },
     "status": {
@@ -153,20 +180,22 @@ Schema for a single Access Token
   }
 }
 ```
-### <a name="access-token-example"></a> Example
+### <a name="api-token-example"></a> Example
 
 ```json
 {
   "id": "575ec7417ae143cd83dc4a95",
-  "accessTokenId": "575ec7417ae143cd83dc4a95",
-  "userId": "575ed70c7ae143cd83dc4aa9",
-  "name": "My Access Token",
+  "apiTokenId": "575ec7417ae143cd83dc4a95",
+  "creatorId": "575ed70c7ae143cd83dc4aa9",
+  "creatorType": "user",
+  "ownerId": "575ec8687ae143cd83dc4a97",
+  "ownerType": "application",
+  "name": "My API Token",
   "creationDate": "2016-06-13T04:00:00.000Z",
   "lastUpdated": "2016-06-13T04:00:00.000Z",
   "expirationDate": "2017-06-13T04:00:00.000Z",
   "scope": [
-    "devices",
-    "devices.state"
+    "all.Application"
   ],
   "status": "active",
   "token": "the_actual_token_string"
@@ -175,11 +204,11 @@ Schema for a single Access Token
 
 <br/>
 
-## Access Token Patch
+## API Token Patch
 
-Schema for the body of an Access Token modification request
+Schema for the body of an API Token modification request
 
-### <a name="access-token-patch-schema"></a> Schema
+### <a name="api-token-patch-schema"></a> Schema
 
 ```json
 {
@@ -191,53 +220,9 @@ Schema for the body of an Access Token modification request
       "minLength": 1,
       "maxLength": 255
     },
-    "status": {
-      "type": "string",
-      "enum": [
-        "active",
-        "inactive"
-      ]
-    }
-  },
-  "additionalProperties": false
-}
-```
-### <a name="access-token-patch-example"></a> Example
-
-```json
-{
-  "name": "My Updated Access Token",
-  "status": "inactive"
-}
-```
-
-<br/>
-
-## Access Token Post
-
-Schema for the body of an Access Token creation request
-
-### <a name="access-token-post-schema"></a> Schema
-
-```json
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 255
-    },
-    "expirationDate": {
+    "description": {
       "type": "string",
-      "format": "date-time"
-    },
-    "scope": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
+      "maxLength": 32767
     },
     "status": {
       "type": "string",
@@ -247,123 +232,15 @@ Schema for the body of an Access Token creation request
       ]
     }
   },
-  "additionalProperties": false,
-  "required": [
-    "name"
-  ]
-}
-```
-### <a name="access-token-post-example"></a> Example
-
-```json
-{
-  "name": "My New Access Token",
-  "expirationDate": "2017-06-13T04:00:00.000Z",
-  "scope": [
-    "devices",
-    "devices.state"
-  ],
-  "status": "active"
-}
-```
-
-<br/>
-
-## Access Tokens
-
-Schema for a collection of Access Tokens
-
-### <a name="access-tokens-schema"></a> Schema
-
-```json
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "items": {
-      "type": "array",
-      "items": {
-        "title": "Access Token",
-        "description": "Schema for a single Access Token",
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "pattern": "^[A-Fa-f\\d]{24}$"
-          },
-          "accessTokenId": {
-            "type": "string",
-            "pattern": "^[A-Fa-f\\d]{24}$"
-          },
-          "userId": {
-            "type": "string",
-            "pattern": "^[A-Fa-f\\d]{24}$"
-          },
-          "name": {
-            "type": "string",
-            "minLength": 1,
-            "maxLength": 255
-          },
-          "creationDate": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "lastUpdated": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "expirationDate": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "scope": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            }
-          },
-          "status": {
-            "type": "string",
-            "enum": [
-              "active",
-              "inactive"
-            ]
-          },
-          "token": {
-            "type": "string",
-            "minLength": 1
-          }
-        }
-      }
-    },
-    "count": {
-      "type": "integer"
-    }
-  }
+  "additionalProperties": false
 }
 ```
-### <a name="access-tokens-example"></a> Example
+### <a name="api-token-patch-example"></a> Example
 
 ```json
 {
-  "items": [
-    {
-      "id": "575ec7417ae143cd83dc4a95",
-      "accessTokenId": "575ec7417ae143cd83dc4a95",
-      "userId": "575ed70c7ae143cd83dc4aa9",
-      "name": "My Access Token",
-      "creationDate": "2016-06-13T04:00:00.000Z",
-      "lastUpdated": "2016-06-13T04:00:00.000Z",
-      "expirationDate": "2017-06-13T04:00:00.000Z",
-      "scope": [
-        "devices",
-        "devices.state"
-      ],
-      "status": "active",
-      "token": "the_actual_token_string"
-    }
-  ],
-  "count": 1
+  "name": "My Updated API Token",
+  "status": "inactive"
 }
 ```
 
@@ -467,6 +344,145 @@ Schema for a single Application
 
 <br/>
 
+## Application API Token Post
+
+Schema for the body of an Application API Token creation request
+
+### <a name="application-api-token-post-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "expirationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "scope": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "all.Application",
+          "all.Application.read",
+          "all.Device",
+          "all.Device.read",
+          "application.*",
+          "applicationApiToken.*",
+          "applicationApiTokens.*",
+          "applicationKey.*",
+          "applicationKeys.*",
+          "data.*",
+          "device.*",
+          "deviceRecipe.*",
+          "deviceRecipes.*",
+          "devices.*",
+          "event.*",
+          "events.*",
+          "flow.*",
+          "flows.*",
+          "webhook.*",
+          "webhooks.*",
+          "application.delete",
+          "application.get",
+          "application.patch",
+          "application.payloadCounts",
+          "applicationApiToken.delete",
+          "applicationApiToken.get",
+          "applicationApiToken.patch",
+          "applicationApiTokens.get",
+          "applicationApiTokens.post",
+          "applicationKey.delete",
+          "applicationKey.get",
+          "applicationKey.patch",
+          "applicationKeys.get",
+          "applicationKeys.post",
+          "data.lastValueQuery",
+          "data.timeSeriesQuery",
+          "device.delete",
+          "device.export",
+          "device.get",
+          "device.getCommand",
+          "device.getCompositeState",
+          "device.getLogEntries",
+          "device.getState",
+          "device.patch",
+          "device.removeData",
+          "device.sendCommand",
+          "device.sendState",
+          "deviceRecipe.bulkCreate",
+          "deviceRecipe.delete",
+          "deviceRecipe.get",
+          "deviceRecipe.patch",
+          "deviceRecipes.get",
+          "deviceRecipes.post",
+          "devices.export",
+          "devices.get",
+          "devices.post",
+          "devices.sendCommand",
+          "event.delete",
+          "event.get",
+          "event.patch",
+          "events.get",
+          "events.mostRecentBySeverity",
+          "events.patch",
+          "events.post",
+          "flow.delete",
+          "flow.get",
+          "flow.getStorageEntries",
+          "flow.log",
+          "flow.patch",
+          "flow.pressVirtualButton",
+          "flow.setStorageEntry",
+          "flows.create",
+          "flows.get",
+          "webhook.delete",
+          "webhook.get",
+          "webhook.patch",
+          "webhooks.get",
+          "webhooks.post"
+        ]
+      }
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "inactive"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "name"
+  ]
+}
+```
+### <a name="application-api-token-post-example"></a> Example
+
+```json
+{
+  "name": "My New API Token",
+  "expirationDate": "2017-06-13T04:00:00.000Z",
+  "scope": [
+    "all.Application"
+  ],
+  "status": "active"
+}
+```
+
+<br/>
+
 ## Application Key
 
 Schema for a single Application Key
@@ -1071,6 +1087,7 @@ Schema for a single Audit Log entry
     "secondaryTargetType": {
       "type": "string",
       "enum": [
+        "ApiToken",
         "ApplicationKey",
         "Device",
         "DeviceRecipe",
@@ -1095,7 +1112,8 @@ Schema for a single Audit Log entry
         "Device",
         "Flow",
         "SolutionUser",
-        "User"
+        "User",
+        "ApiToken"
       ]
     },
     "actorName": {
@@ -1209,6 +1227,7 @@ Schema for the filter of an audit log query
           "type": {
             "type": "string",
             "enum": [
+              "ApiToken",
               "ApplicationKey",
               "Device",
               "DeviceRecipe",
@@ -1242,7 +1261,8 @@ Schema for the filter of an audit log query
               "Device",
               "Flow",
               "SolutionUser",
-              "User"
+              "User",
+              "ApiToken"
             ]
           },
           "name": {
@@ -1364,6 +1384,7 @@ Schema for a collection of Audit Logs
           "secondaryTargetType": {
             "type": "string",
             "enum": [
+              "ApiToken",
               "ApplicationKey",
               "Device",
               "DeviceRecipe",
@@ -1388,7 +1409,8 @@ Schema for a collection of Audit Logs
               "Device",
               "Flow",
               "SolutionUser",
-              "User"
+              "User",
+              "ApiToken"
             ]
           },
           "actorName": {
@@ -4104,7 +4126,8 @@ Schema for a single Event
       "enum": [
         "flow",
         "user",
-        "device"
+        "device",
+        "apiToken"
       ]
     },
     "sourceId": {
@@ -4148,7 +4171,8 @@ Schema for a single Event
             "enum": [
               "flow",
               "user",
-              "device"
+              "device",
+              "apiToken"
             ]
           },
           "sourceId": {
@@ -4354,7 +4378,8 @@ Schema for a collection of Events
             "enum": [
               "flow",
               "user",
-              "device"
+              "device",
+              "apiToken"
             ]
           },
           "sourceId": {
@@ -4398,7 +4423,8 @@ Schema for a collection of Events
                   "enum": [
                     "flow",
                     "user",
-                    "device"
+                    "device",
+                    "apiToken"
                   ]
                 },
                 "sourceId": {