losant_rest 1.2.0 → 1.2.1

data/lib/losant_rest/integrations.rb

@@ -0,0 +1,136 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 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.
+
+module LosantRest
+
+  # Class containing all the actions for the Integrations Resource
+  class Integrations
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the integrations for an application
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action. The token
+    # must include at least one of the following scopes:
+    # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, integrations.*, or integrations.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, integrationType
+    # *  {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, integrationType
+    # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {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:
+    # *  200 - Collection of integrations (https://api.losant.com/#/definitions/integrations)
+    #
+    # 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 get(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)
+
+      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)
+      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]}/integrations"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Create a new integration for an application
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action. The token
+    # must include at least one of the following scopes:
+    # all.Application, all.Organization, all.User, integrations.*, or integrations.post.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} integration - New integration information (https://api.losant.com/#/definitions/integrationPost)
+    # *  {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:
+    # *  201 - Successfully created integration (https://api.losant.com/#/definitions/integration)
+    #
+    # 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 post(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("integration is required") unless params.has_key?(:integration)
+
+      body = params[:integration] if params.has_key?(:integration)
+      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]}/integrations"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/schemas/application.json

@@ -81,6 +81,9 @@
         "flowCount": {
           "type": "number"
         },
+        "integrationCount": {
+          "type": "number"
+        },
         "webhookCount": {
           "type": "number"
         }

data/schemas/applicationApiTokenPost.json

@@ -42,6 +42,8 @@
           "experienceGroups.*",
           "experienceUser.*",
           "experienceUsers.*",
+          "integration.*",
+          "integrations.*",
           "flow.*",
           "flows.*",
           "webhook.*",
@@ -113,8 +115,13 @@
           "flow.patch",
           "flow.pressVirtualButton",
           "flow.setStorageEntry",
-          "flows.create",
           "flows.get",
+          "flows.post",
+          "integration.delete",
+          "integration.get",
+          "integration.patch",
+          "integrations.get",
+          "integrations.post",
           "webhook.delete",
           "webhook.get",
           "webhook.patch",

data/schemas/applications.json

@@ -88,6 +88,9 @@
               "flowCount": {
                 "type": "number"
               },
+              "integrationCount": {
+                "type": "number"
+              },
               "webhookCount": {
                 "type": "number"
               }

data/schemas/auditLog.json

@@ -52,6 +52,7 @@
         "ExperienceUser",
         "Flow",
         "SolutionUser",
+        "Integration",
         "Webhook"
       ]
     },

data/schemas/auditLogFilter.json

@@ -50,6 +50,7 @@
               "ExperienceUser",
               "Flow",
               "SolutionUser",
+              "Integration",
               "Webhook"
             ]
           },

data/schemas/auditLogs.json

@@ -59,6 +59,7 @@
               "ExperienceUser",
               "Flow",
               "SolutionUser",
+              "Integration",
               "Webhook"
             ]
           },

data/schemas/flow.json

@@ -47,17 +47,18 @@
             "type": "string",
             "enum": [
               "deviceId",
+              "deviceIdConnect",
+              "deviceIdDisconnect",
               "deviceTag",
+              "deviceTagConnect",
+              "deviceTagDisconnect",
+              "endpoint",
+              "event",
               "mqttTopic",
-              "webhook",
+              "integration",
               "timer",
-              "event",
               "virtualButton",
-              "endpoint",
-              "deviceIdConnect",
-              "deviceIdDisconnect",
-              "deviceTagConnect",
-              "deviceTagDisconnect"
+              "webhook"
             ]
           },
           "config": {

data/schemas/flowPatch.json

@@ -27,17 +27,18 @@
             "type": "string",
             "enum": [
               "deviceId",
+              "deviceIdConnect",
+              "deviceIdDisconnect",
               "deviceTag",
+              "deviceTagConnect",
+              "deviceTagDisconnect",
+              "endpoint",
+              "event",
               "mqttTopic",
-              "webhook",
+              "integration",
               "timer",
-              "event",
               "virtualButton",
-              "endpoint",
-              "deviceIdConnect",
-              "deviceIdDisconnect",
-              "deviceTagConnect",
-              "deviceTagDisconnect"
+              "webhook"
             ]
           },
           "config": {

data/schemas/flowPost.json

@@ -27,17 +27,18 @@
             "type": "string",
             "enum": [
               "deviceId",
+              "deviceIdConnect",
+              "deviceIdDisconnect",
               "deviceTag",
+              "deviceTagConnect",
+              "deviceTagDisconnect",
+              "endpoint",
+              "event",
               "mqttTopic",
-              "webhook",
+              "integration",
               "timer",
-              "event",
               "virtualButton",
-              "endpoint",
-              "deviceIdConnect",
-              "deviceIdDisconnect",
-              "deviceTagConnect",
-              "deviceTagDisconnect"
+              "webhook"
             ]
           },
           "config": {

data/schemas/flows.json

@@ -54,17 +54,18 @@
                   "type": "string",
                   "enum": [
                     "deviceId",
+                    "deviceIdConnect",
+                    "deviceIdDisconnect",
                     "deviceTag",
+                    "deviceTagConnect",
+                    "deviceTagDisconnect",
+                    "endpoint",
+                    "event",
                     "mqttTopic",
-                    "webhook",
+                    "integration",
                     "timer",
-                    "event",
                     "virtualButton",
-                    "endpoint",
-                    "deviceIdConnect",
-                    "deviceIdDisconnect",
-                    "deviceTagConnect",
-                    "deviceTagDisconnect"
+                    "webhook"
                   ]
                 },
                 "config": {

data/schemas/integration.json

@@ -0,0 +1,169 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "integrationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "integrationType": {
+      "type": "string",
+      "enum": [
+        "mqtt",
+        "googlePubSub"
+      ]
+    },
+    "enabled": {
+      "type": "boolean"
+    },
+    "topics": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 1024
+      }
+    },
+    "googlePubSubConfig": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024
+        },
+        "keyJson": {
+          "type": "string",
+          "maxLength": 32767,
+          "minLength": 50
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "projectId",
+        "keyJson"
+      ]
+    },
+    "mqttConfig": {
+      "type": "object",
+      "properties": {
+        "clientId": {
+          "type": "string",
+          "maxLength": 1024,
+          "minLength": 1
+        },
+        "username": {
+          "type": "string",
+          "maxLength": 1024,
+          "minLength": 1
+        },
+        "password": {
+          "type": "string",
+          "maxLength": 1024,
+          "minLength": 1
+        },
+        "clean": {
+          "type": "boolean"
+        },
+        "port": {
+          "type": "number",
+          "minimum": 1,
+          "maximum": 65535
+        },
+        "protocol": {
+          "type": "string",
+          "enum": [
+            "mqtt",
+            "mqtts",
+            "ws",
+            "wss"
+          ]
+        },
+        "host": {
+          "type": "string",
+          "maxLength": 1024,
+          "minLength": 1
+        },
+        "privateKey": {
+          "type": "string",
+          "maxLength": 32767,
+          "minLength": 50
+        },
+        "certificate": {
+          "type": "string",
+          "maxLength": 32767,
+          "minLength": 50
+        },
+        "caCertificate": {
+          "type": "string",
+          "maxLength": 32767,
+          "minLength": 50
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "port",
+        "protocol",
+        "host"
+      ]
+    },
+    "status": {
+      "lastKeepAlive": {
+        "type": [
+          "number"
+        ]
+      },
+      "nextAttempt": {
+        "type": [
+          "number"
+        ]
+      },
+      "connectInfo": {
+        "type": "object",
+        "properties": {
+          "ts": {
+            "type": [
+              "number",
+              "null"
+            ]
+          }
+        }
+      },
+      "disconnectInfo": {
+        "type": "object",
+        "properties": {
+          "ts": {
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "error": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}