TACore 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f75c89cea08134c5a2b93e4843887f67ff504a8
-  data.tar.gz: 9cd0c5e3dbdee6002dab82fa2540c3b096840b1e
+  metadata.gz: 91e89416ab0144902af68c5423f39de783374dc4
+  data.tar.gz: 0e30500d825dc444bd35dfaff52337ad2c79e05c
 SHA512:
-  metadata.gz: 5b2792d03d8bb65a9db9258de9a01e4b6cb7b4857b13347c4b919ebf201abef2b7dcd870e7a8567d623964d83b62cf2a6549430c1f5a6bb5ea769289d17102c0
-  data.tar.gz: 45b5a453814e9033bc8532ea300e44767b6c89abc22f58e90f620f23d0501b524411789ff6a6a6cae97c44a8b6045442125a6a4348e74f840b6a55027e7b02f6
+  metadata.gz: 829846ec0f378344e9c539b6848b52ebbd109d7d029221735b279fc7efd1ff5426579f6d48c162c9bf19c5053eafab11bfdb224295b6d6b035c4c7c8a630cf8a
+  data.tar.gz: c11d9ebcf6fd4b76dd9672058ec3fecf3d564e03fe2d334ca88a1a38421ec93a9276acb31e0f61f35bf6aecdaf109fae09c44491fde459d1b388822ad6073ab9

data/lib/tacore.rb

@@ -131,6 +131,7 @@ module TACore
   require 'tacore/venue'
   require 'tacore/device'
   require 'tacore/gateway'
+  require 'tacore/webhook'
   require 'tacore/app'
 
 

data/lib/tacore/app.rb

@@ -19,14 +19,14 @@ module TACore
     # @param token [String] Application Token after Authentication
     # @return [Object] in JSON format
     def self.devices(token)
-      request(:get, '/application/iris', {}, {"token": token})
+      request(:get, '/application/devices', {}, {"token": token})
     end
 
     # Get all Cirrus gateways assigned to your application
     # @param token [String] Application Token after Authentication
     # @return [Object] in JSON format
     def self.gateways(token)
-      request(:get, '/application/cirrus', {}, {"token": token})
+      request(:get, '/application/gateways', {}, {"token": token})
     end
 
   end

data/lib/tacore/client.rb

@@ -24,7 +24,7 @@ module TACore
     # @param client_id [String] used from {Client.create}
     # @return [Object] in JSON format
     def self.find(token, client_id)
-      request(:get, '/client/',{}, {"token": token, "client-id" => client_id})
+      request(:get, '/client/' + client_id.to_s, {}, {"token": token})
     end
 
     # Update a client details via api_key
@@ -34,14 +34,14 @@ module TACore
     # @return [Object] in JSON format
     # @note The `client` object currently only supports `name`
     def self.update(token, client_id, client = {})
-      request(:put, '/client/', client, {"token": token, "client-id" => client_id})
+      request(:put, '/client/' + client_id.to_s, {"token": token})
     end
 
     # Delete a client by id
     # @param token [String] Client Token after Authentication
     # @param client_id [String] used from {Client.create}
     def self.destroy(token, client_id)
-      request(:delete, '/client/', {"token": token, "client-id" => client_id})
+      request(:delete, '/client/' + client_id.to_s, {"token": token})
     end
 
     # Get all devices assigned to this client-id
@@ -49,7 +49,7 @@ module TACore
     # @param client_id [String] used from {Client.create}
     # @return [Object] in JSON format
     def self.devices(token, client_id)
-      request(:get, '/client/devices',{}, {"token": token, "client-id" => client_id})
+      request(:get, '/client/' + client_id.to_s + '/devices',{}, {"token": token})
     end
 
     # Get all gateways assigned to this client-id
@@ -57,7 +57,7 @@ module TACore
     # @param client_id [String] used from {Client.create}
     # @return [Object] in JSON format
     def self.gateways(token, client_id)
-      request(:get, '/client/gateways',{}, {"token": token, "client-id" => client_id})
+      request(:get, '/client/' + client_id.to_s + '/gateways',{}, {"token": token})
     end
 
     # Get all Venues created by this client-id
@@ -65,7 +65,7 @@ module TACore
     # @param client_id [String] used from {Client.create}
     # @return [Object] in JSON format
     def self.venues(token, client_id)
-      request(:get, '/client/venues',{}, {"token": token, "client-id" => client_id})
+      request(:get, '/client/' + client_id.to_s + '/venues',{}, {"token": token})
     end
 
   end

data/lib/tacore/device.rb

@@ -9,7 +9,7 @@ module TACore
     # @param device [Object] Venue ID as a value
     # @return [Object] in JSON format
     def self.update(token, client_id, device_id, device = {})
-      request(:put, '/device/' + device_id.to_s, device, {"client-id" => client_id, "token": token})
+      request(:put, '/device/' + device_id.to_s, device, {"token": token})
     end
 
     # Find device by device_id
@@ -18,15 +18,7 @@ module TACore
     # @param device_id [Integer] Device ID
     # @return [Object] in JSON format
     def self.find(token, client_id, device_id)
-      request(:get, '/device/' + device_id.to_s,{}, {"client-id" => client_id, "token": token})
-    end
-
-    # Display all devices that belong to this Client
-    # @param token [String] Client Token after Authentication
-    # @param client_id [String] used from {Client.create}
-    # @return [Array<Object, Object>] in JSON format
-    def self.all(token, client_id)
-      request(:get, '/client/devices/', {}, {"token": token, "client-id" => client_id})
+      request(:get, '/device/' + device_id.to_s,{}, {"token": token})
     end
 
     # Display all iris devices that belong to this application

data/lib/tacore/gateway.rb

@@ -1,15 +1,6 @@
 module TACore
   # => Gateway class methods
   class Gateway < Auth
-
-    # Get all gateways that belong to a client
-    # @param token [String] Client Token after Authentication
-    # @param client_id [String] used from {Client.create}
-    # @return [Array<Object, Object>] in JSON format
-    def self.all(token, client_id)
-      request(:get, '/client/gateways/', {}, {token: token, "client-id" => client_id})
-    end
-
     # Shows the devices that are seen by the gateway id
     # @param token [String] Client Token after Authentication
     # @param client_id [String] used from {Client.create}

data/lib/tacore/venue.rb

@@ -2,32 +2,39 @@ module TACore
   # => Venue is used to group devices for Clients, Venue could be a location or an area within a location.
   # It is important to note that all Venue methods require the use a client_id see {Client.create}.
   class Venue < Auth
-    # Create a new Venue under a Client.
+    # Create a new Venue
+    # @param token [String] Client Token after Authentication
+    # @param venue [Object] Venue params
+    # @note Venue currently only accepts 'name'
+    # @return [Object] in JSON format
+    def self.create(token, venue = {})
+      request(:post, '/venue', venue, {"token": token})
+    end
+
+    # Update a Venue.
     # @param token [String] Client Token after Authentication
-    # @param client_id [String] used from {Client.create}
     # @param venue [Object] Venue params
     # @note Venue currently only accepts 'name'
     # @return [Object] in JSON format
-    def self.create(token, client_id, venue = {})
-      request(:post, '/venue', venue, {"client-id" => client_id, "token": token})
+    def self.update(token, venue = {})
+      request(:put, '/venue', venue, {"token": token})
     end
 
     # Get back Venue information
     # @param token [String] Client Token after Authentication
-    # @param client_id [String] used from {Client.create}
     # @param venue_id [String] used from {Venue.create}
     # @return [Object] in JSON format
-    def self.find(token, client_id, venue_id)
-      request(:get, '/venue/' + venue_id.to_s,{}, {"client-id" => client_id, "token": token})
+    def self.find(token, venue_id)
+      request(:get, '/venue/' + venue_id.to_s,{}, {"token": token})
     end
 
     # Display all Venues for the client
     # @param token [String] Client Token after Authentication
     # @param client_id [String] used from {Client.create}
     # @return [Array<Object, Object>] in JSON format
-    def self.all(token, client_id)
+    def self.all(token)
       # returns all venues that belong to this client
-      request(:get, '/client/venues', {}, {"token": token, "client-id" => client_id})
+      request(:get, '/venues', {}, {"token": token})
     end
 
     # This method will permanently remove the venue from the API.
@@ -35,17 +42,24 @@ module TACore
     # @param client_id [String] used from {Client.create}
     # @param venue_id [String] the Key of the Venue from {Venue.create}
     # @return [Hash, status: 410] in JSON format
-    def self.destroy(token, client_id, venue_id)
-      request(:delete, '/venue/' + venue_id.to_s,{}, {"client-id" => client_id, "token": token})
+    def self.destroy(token, venue_id)
+      request(:delete, '/venue/' + venue_id.to_s,{}, {"token": token})
     end
 
     # Get all devices belonging to the given venue
     # @param token [String] Client Token after Authentication
-    # @param client_id [String] used from {Client.create}
     # @param venue_id [String] the Key of the Venue from {Venue.create}
-    # @return [Hash, status: 410] in JSON format
-    def self.devices(token, client_id, venue_id)
-      request(:get, '/venue/' + venue_id.to_s + '/devices',{}, {"client-id" => client_id, "token": token})
+    # @return [Hash, status: 200] in JSON format
+    def self.devices(token, venue_id)
+      request(:get, '/venue/' + venue_id.to_s + '/devices',{}, {"token": token})
+    end
+
+    # Get all gateways belonging to the given venue
+    # @param token [String] Client Token after Authentication
+    # @param venue_id [String] the Key of the Venue from {Venue.create}
+    # @return [Hash, status: 200] in JSON format
+    def self.devices(token, venue_id)
+      request(:get, '/venue/' + venue_id.to_s + '/gateways',{}, {"token": token})
     end
   end
 end

data/lib/tacore/webhook.rb

@@ -0,0 +1,40 @@
+module TACore
+  # => Webhooks allow the THINaer API to push updated/new data to a callback you select.
+  # => NOTE: As of 4.1.0 Webhooks are in the Alpha Stage
+  # It is important to note Webhooks will act independently of any client or venue id's. This means that when the
+  # API updates a record in it's own database regardless of the data changed it will send an update if the object belongs to your application ID
+  # Webhook API Docs (https://documenter.getpostman.com/view/150459/thinaer/2PMs5i#webhook)
+  class Webhook < Auth
+    # Create a new Webhook under your Application.
+    # @param token [String] Client Token after Authentication
+    # @param webhook [Object] Webhook params
+    # @note Webhook currently only accepts 'callback, encryption, dataType' (https://documenter.getpostman.com/view/150459/thinaer/2PMs5i#webhook)
+    # @return [Object] in JSON format
+    def self.create(token, webhook = {})
+      request(:post, '/webhook', webhook, { "token": token })
+    end
+
+    # Find an already created Webhook by ID
+    # @param token [String] Client Token after Authentication
+    # @param webhook_id [Integer] The webhook ID returned from {Webhook.create}
+    # @return [Object] in JSON format
+    def self.find(token, webhook_id)
+      request(:get, '/webhook/' + webhook_id.to_s, {}, { "token": token })
+    end
+
+    # Update an existing webhook by ID
+    # @param webhook_id [Integer] The webhook ID returned from {Webhook.create} or {Webhook.find}
+    # @param webhook [Object] Webhook params
+    # @return [Object] in JSON format
+    def self.update(token, webhook_id, webhook ={})
+      request(:put, '/webhook/' + webhook_id.to_s, webhook, { "token": token })
+    end
+
+    # Delete a webhook by ID
+    # @param webhook_id [Integer] The webhook ID returned from {Webhook.create} or {Webhook.find}
+    # @return [Object] in JSON format (Object of the full Application)
+    def self.delete(token, webhook_id)
+      request(:delete, '/webhook/' + webhook_id.to_s, {}, { "token": token })
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: TACore
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Greg Winn
@@ -53,6 +53,7 @@ files:
 - lib/tacore/device.rb
 - lib/tacore/gateway.rb
 - lib/tacore/venue.rb
+- lib/tacore/webhook.rb
 homepage: http://thinaer.io
 licenses:
 - MIT