losant_rest 1.0.0

data/schemas/webhookPost.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "responseCode": {
+      "type": "integer",
+      "minimum": 100,
+      "maximum": 599
+    },
+    "verificationType": {
+      "type": "string",
+      "enum": [
+        "facebook",
+        "fitbit",
+        "none"
+      ]
+    },
+    "verificationCode": {
+      "type": "string",
+      "maxLength": 32767
+    }
+  },
+  "required": [
+    "name"
+  ],
+  "additionalProperties": false
+}

data/schemas/webhooks.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "Webhook",
+        "description": "Schema for a single Webhook",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "webhookId": {
+            "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": 255
+          },
+          "token": {
+            "type": "string",
+            "minLength": 1
+          },
+          "responseCode": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "verificationType": {
+            "type": "string",
+            "enum": [
+              "facebook",
+              "fitbit",
+              "none"
+            ]
+          },
+          "verificationCode": {
+            "type": "string",
+            "maxLength": 32767
+          }
+        }
+      }
+    },
+    "count": {
+      "type": "integer"
+    },
+    "totalCount": {
+      "type": "integer"
+    },
+    "perPage": {
+      "type": "integer"
+    },
+    "page": {
+      "type": "integer"
+    },
+    "filter": {
+      "type": "string"
+    },
+    "filterField": {
+      "type": "string"
+    },
+    "sortField": {
+      "type": "string"
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": [
+        "asc",
+        "desc"
+      ]
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  }
+}

data/test/basic_test.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class BasicTest < MiniTest::Test
+  describe "test basic functionality" do
+
+    it "should correctly make an auth call" do
+      stub_request(:post,
+        "https://api.losant.com/auth/user?_actions=false&_embedded=true&_links=true")
+        .with(body: '{"email":"myemail@myemail.com","password":"mypassword"}',
+        headers: { "Accept" => "application/json" }).
+        to_return(body: '{ "userId": "theUserId", "token": "an auth token string"}',
+          status: 200, headers: { "Content-Type" => "application/json" });
+
+      client = LosantRest::Client.new
+
+      response = client.auth.authenticate_user(credentials: {
+        email: "myemail@myemail.com",
+        password: "mypassword"
+      })
+      assert_equal response, { "userId" => "theUserId", "token" => "an auth token string" }
+    end
+
+    it "should correctly make a call with a token" do
+      stub_request(:get,
+        "https://api.losant.com/applications?_actions=false&_embedded=true&_links=true")
+        .with(headers: { "Accept" => "application/json", "Authorization" => "Bearer my token" }).
+        to_return(body: '{ "count": 0, "items": [] }',
+          status: 200, headers: { "Content-Type" => "application/json" });
+
+      client = LosantRest::Client.new(auth_token: "my token")
+
+      response = client.applications.get
+      assert_equal response, { "count" => 0, "items" => [] }
+    end
+
+    it "should correctly make calls with nested query params" do
+      stub_request(:get,
+        "https://api.losant.com/applications/appId/devices?_actions=false&_links=true&_embedded=true&tagFilter[0][key]=key2&tagFilter[1][key]=key1&tagFilter[1][value]=value1&tagFilter[2][value]=value2")
+        .with(headers: { "Accept" => "application/json", "Authorization" => "Bearer my token" }).
+        to_return(body: '{ "count": 0, "items": [] }',
+          status: 200, headers: { "Content-Type" => "application/json" });
+
+      client = LosantRest::Client.new(auth_token: "my token")
+
+      response = client.devices.get(applicationId: "appId", tagFilter: [
+        { key: "key2" },
+        { key: "key1", value: "value1" },
+        { value: "value2" },
+      ])
+      assert_equal response, { "count" => 0, "items" => [] }
+    end
+
+    it "should correctly make a call with the singleton" do
+      stub_request(:get,
+        "https://api.losant.com/applications?_actions=false&_embedded=true&_links=true")
+        .with(headers: { "Accept" => "application/json", "Authorization" => "Bearer my token" }).
+        to_return(body: '{ "count": 0, "items": [] }',
+          status: 200, headers: { "Content-Type" => "application/json" });
+
+      LosantRest.client.auth_token = "my token"
+
+      response = LosantRest.applications.get
+      assert_equal response, { "count" => 0, "items" => [] }
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+
+gem "minitest"
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/mock"
+require "webmock/minitest"
+require "losant_rest"
+
+class MiniTest::Test
+  def setup
+    WebMock.disable_net_connect!
+  end
+end

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification
+name: losant_rest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Kuehl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Easily use the Losant IoT Platform through its REST API with Ruby
+email:
+- hello@losant.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docs/_schemas.md
+- docs/accessToken.md
+- docs/accessTokens.md
+- docs/application.md
+- docs/applicationKey.md
+- docs/applicationKeys.md
+- docs/applications.md
+- docs/auth.md
+- docs/dashboard.md
+- docs/dashboards.md
+- docs/data.md
+- docs/device.md
+- docs/deviceRecipe.md
+- docs/deviceRecipes.md
+- docs/devices.md
+- docs/event.md
+- docs/events.md
+- docs/flow.md
+- docs/flows.md
+- docs/me.md
+- docs/org.md
+- docs/orgs.md
+- docs/webhook.md
+- docs/webhooks.md
+- examples/auth.rb
+- examples/list_devices.rb
+- lib/losant_rest.rb
+- lib/losant_rest/access_token.rb
+- lib/losant_rest/access_tokens.rb
+- lib/losant_rest/application.rb
+- lib/losant_rest/application_key.rb
+- lib/losant_rest/application_keys.rb
+- lib/losant_rest/applications.rb
+- lib/losant_rest/auth.rb
+- lib/losant_rest/client.rb
+- lib/losant_rest/dashboard.rb
+- lib/losant_rest/dashboards.rb
+- lib/losant_rest/data.rb
+- lib/losant_rest/device.rb
+- lib/losant_rest/device_recipe.rb
+- lib/losant_rest/device_recipes.rb
+- lib/losant_rest/devices.rb
+- lib/losant_rest/error.rb
+- lib/losant_rest/event.rb
+- lib/losant_rest/events.rb
+- lib/losant_rest/flow.rb
+- lib/losant_rest/flows.rb
+- lib/losant_rest/me.rb
+- lib/losant_rest/org.rb
+- lib/losant_rest/orgs.rb
+- lib/losant_rest/utils.rb
+- lib/losant_rest/version.rb
+- lib/losant_rest/webhook.rb
+- lib/losant_rest/webhooks.rb
+- losant_rest.gemspec
+- schemas/accessToken.json
+- schemas/accessTokenPatch.json
+- schemas/accessTokenPost.json
+- schemas/accessTokens.json
+- schemas/application.json
+- schemas/applicationKey.json
+- schemas/applicationKeyPatch.json
+- schemas/applicationKeyPost.json
+- schemas/applicationKeys.json
+- schemas/applicationPatch.json
+- schemas/applicationPost.json
+- schemas/applications.json
+- schemas/authedDevice.json
+- schemas/authedUser.json
+- schemas/dashboard.json
+- schemas/dashboardPatch.json
+- schemas/dashboardPost.json
+- schemas/dashboards.json
+- schemas/device.json
+- schemas/deviceCommand.json
+- schemas/deviceCommands.json
+- schemas/deviceCredentials.json
+- schemas/deviceLog.json
+- schemas/devicePatch.json
+- schemas/devicePost.json
+- schemas/deviceRecipe.json
+- schemas/deviceRecipeBulkCreate.json
+- schemas/deviceRecipeBulkCreatePost.json
+- schemas/deviceRecipePatch.json
+- schemas/deviceRecipePost.json
+- schemas/deviceRecipes.json
+- schemas/deviceState.json
+- schemas/deviceStates.json
+- schemas/deviceTagFilter.json
+- schemas/devices.json
+- schemas/disableTwoFactorAuth.json
+- schemas/enableTwoFactorAuth.json
+- schemas/error.json
+- schemas/event.json
+- schemas/eventPatch.json
+- schemas/eventPost.json
+- schemas/events.json
+- schemas/flow.json
+- schemas/flowLog.json
+- schemas/flowPatch.json
+- schemas/flowPost.json
+- schemas/flowStorageEntries.json
+- schemas/flowStorageEntry.json
+- schemas/flows.json
+- schemas/githubLogin.json
+- schemas/lastValueData.json
+- schemas/lastValueQuery.json
+- schemas/me.json
+- schemas/mePatch.json
+- schemas/multiDeviceCommand.json
+- schemas/org.json
+- schemas/orgInvitePost.json
+- schemas/orgInvites.json
+- schemas/orgMemberPatch.json
+- schemas/orgPatch.json
+- schemas/orgPost.json
+- schemas/orgs.json
+- schemas/recentItem.json
+- schemas/recentItemList.json
+- schemas/success.json
+- schemas/timeSeriesData.json
+- schemas/timeSeriesQuery.json
+- schemas/userCredentials.json
+- schemas/virtualButtonPress.json
+- schemas/webhook.json
+- schemas/webhookPatch.json
+- schemas/webhookPost.json
+- schemas/webhooks.json
+- test/basic_test.rb
+- test/test_helper.rb
+homepage: https://github.com/Losant/losant-rest-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Provides a simple ruby wrapper around the Losant REST API
+test_files:
+- test/basic_test.rb
+- test/test_helper.rb