TACore 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ec21334daa177ad0be7d4b05f11c57f5f3a91a2
+  data.tar.gz: b2c0e09008db885a7c5c468cc4c3638be6e73eaa
+SHA512:
+  metadata.gz: 9b26c61ba13a59bf68aa2cffb50e5930dd015b58e5d3ba9adaa974608c352dfd73725c8efb39b590978c1cdac6e568a8fbcf42c801c4ae590d3506c96a1910f1
+  data.tar.gz: 694abc8c10680189bf8485b2dffa26f9508cdd1c6d75a202641cdeda676c3e126b395c1d20481d2b163ba7c115f6290db46c24e9151ab2d770b349103aeb2906

data/lib/exceptions.rb

@@ -0,0 +1,9 @@
+module TACore
+  class AuthenticationError < StandardError; end
+
+  # => TokenError is presented when the access token is no longer valid or there was a communication issue.
+  # Error, Token expired or external API is not responding.
+  class TokenError < AuthenticationError; end
+
+  class NotThereError < StandardError; end
+end

data/lib/tacore.rb

@@ -0,0 +1,142 @@
+# THINAER Core API GEM
+#
+# Author::    Greg Winn (greg.winn@thinaer.io)
+# Copyright:: Copyright (c) 2016 Advantix ThinAer, LLC
+# License::   NONE
+
+require 'rest-client'
+require 'exceptions'
+require 'net/http'
+require 'uri'
+require 'json'
+
+# This module holds every public class and method need to
+# to authenticate and configure the TACore GEM
+module TACore
+
+  # Configuration of the config params set in an init file.
+  class Configuration
+	    attr_accessor :api_url
+      attr_accessor :client_id
+      attr_accessor :client_secret
+      attr_accessor :api_key
+
+	    def initialize
+	      self.api_url 		= nil
+        self.client_id       = nil
+        self.client_secret   = nil
+        self.api_key   = nil
+	    end
+	end
+
+	def self.configuration
+	  @configuration ||=  Configuration.new
+	end
+
+	def self.configure
+	  yield(configuration) if block_given?
+	end
+
+	class << self
+		attr_accessor :api_url
+    attr_accessor :client_id
+    attr_accessor :client_secret
+    attr_accessor :api_key
+    def api_key
+      raise "api_key is needed to connect" unless @api_key
+      @api_key
+    end
+
+		def api_url
+	    	raise "api_url is needed to connect" unless @api_url
+	    	@api_url
+	  end
+
+    def client_id
+	    	raise "client_id is needed to connect" unless @client_id
+	    	@client_id
+	  end
+
+    def client_secret
+	    	raise "client_secret is needed to connect" unless @client_secret
+	    	@client_secret
+	  end
+	end
+
+  # Authorization class that will create the client token and authenticate with the API
+  class Auth < Configuration
+    attr_accessor :token
+    attr_accessor :client
+
+    # Used to retrieve the TOKEN and Authenticate the application
+    def self.login
+
+      # use rest-client for auth post to get token
+      @@token = RestClient::Request.execute(method: :post, url: TACore.configuration.api_url + "/application/token",
+        headers: {
+            "uid": TACore.configuration.client_id,
+            "secret": TACore.configuration.client_secret,
+            "x-api-key": TACore.configuration.api_key
+        }
+      )
+
+      if JSON.parse(@@token).include? "error"
+        # The responce included an error, stop and show it!
+        raise JSON.parse(@@token)["error"]
+      end
+
+      if @@token.nil?
+        raise "Authentication Failed"
+      end
+      JSON.parse(@@token)
+    end
+
+    # Internal request only.
+    # Request method
+    # @param method [Symbol<:get, :post, :put, :delete>]
+    # @param uri [String]
+    # @param payload [Hash] Changes to document object (optional)
+    # @param headers [Hash] token, client_id,...
+    def self.request(method, uri, payload, headers)
+
+      # Add static API-KEY to headers from config
+      headers["x-api-key"] = TACore.configuration.api_key
+
+      begin
+        response = RestClient::Request.execute(method: method, url: TACore.configuration.api_url + uri, payload: payload, headers: headers)
+        case response.code
+        when 200
+          JSON.parse(response.body)
+        else
+          return { "error": { "code": response.code, "body": JSON.parse(response.body) }}
+        end
+
+      # Rest Client exceptions
+      rescue RestClient::ExceptionWithResponse => e
+        # Raise TokenError on all other exceptions
+        raise TACore::TokenError.new "#{e.message}"
+
+      # Rescue for unauthorized/token expired
+      rescue AuthenticationError
+        self.login
+      # Rescue from rest-client exception due to 410 status from deleted objects
+      rescue NotThereError
+        {deleted: true}
+      end
+    end
+
+  end
+
+  require 'tacore/client'
+  require 'tacore/venue'
+  require 'tacore/device'
+  require 'tacore/gateway'
+  require 'tacore/app'
+
+
+  class Test < Auth
+    def initialize
+      puts "This is a test of the TACore GEM"
+    end
+  end
+end

data/lib/tacore/app.rb

@@ -0,0 +1,19 @@
+module TACore
+  # => Application class methods
+  class App < Auth
+    # Get details on a specific application by token
+    # @param token [String] Application Token after Authentication
+    # @return [Object] in JSON format
+    def self.find(token)
+      request(:get, '/application/',{}, {"token": token})
+    end
+
+    # Get Details on all Applications
+    # @param token [String] Application Token after Authentication
+    # @return [Object] in JSON format
+    def self.all(token)
+      request(:get, '/application/all', {}, {"token": token})
+    end
+
+  end
+end

data/lib/tacore/client.rb

@@ -0,0 +1,47 @@
+module TACore
+  # =>  Client Class methods.
+  # Clients are companies, or groups of users that have access to the same data. When making requests it is important to keep the client api_key
+  class Client < Auth
+    # Get all Clients that belong to this application
+    # @param token [String] Client Token after Authentication
+    # @return [Array] in JSON format
+    def self.all(token)
+      response = request(:get, '/application',{}, {"token": token})
+      return response["clients"]
+    end
+
+    # Allows an application to add a Client
+    # @param token [String] Client Token after Authentication
+    # @param client [Object]
+    # @return [Object] in JSON format - the new client
+    # @note The new Client will be owned by the application creating it.
+    def self.create(token, client = {})
+      request(:post, '/client', client, {"token": token})
+    end
+
+    # Get details on a specific client by client_id
+    # @param token [String] Client Token after Authentication
+    # @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})
+    end
+
+    # Update a client details via api_key
+    # @param token [String] Client Token after Authentication
+    # @param client_id [String] used from {Client.create}
+    # @param client [Object] Client params
+    # @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})
+    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})
+    end
+  end
+end

data/lib/tacore/device.rb

@@ -0,0 +1,47 @@
+module TACore
+  # => Device class methods
+  class Device < Auth
+
+    # Update a device's venue_id
+    # @param token [String] Client Token after Authentication
+    # @param client_id [String] used from {Client.create}
+    # @param id [Integer] Device ID
+    # @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})
+    end
+
+    # Find device by device_id
+    # @param token [String] Client Token after Authentication
+    # @param client_id [String] used from {Client.create}
+    # @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})
+    end
+
+    # Display all iris devices that belong to this application
+    # @param token [String] Client Token after Authentication
+    # @return [Array<Object, Object>] in JSON format
+    def self.iris(token)
+      request(:get, '/application/iris', {}, {"token": token})
+    end
+
+    # Display all cirrus devices that belong to this application
+    # @param token [String] Client Token after Authentication
+    # @return [Array<Object, Object>] in JSON format
+    def self.cirrus(token)
+      request(:get, '/application/cirrus', {}, {"token": token})
+    end
+
+  end
+end

data/lib/tacore/gateway.rb

@@ -0,0 +1,42 @@
+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}
+    # @param gateway_id [String] Gateway ID
+    # @return [Array<Object, Object>] in JSON format
+    def self.sees(token, client_id, gateway_id)
+      request(:get, '/gateway/' + gateway_id.to_s + '/sees', {}, {token: token, "client-id" => client_id})
+    end
+
+    # Gets the Gateway by ID
+    # @param token [String] Client Token after Authentication
+    # @param client_id [String] used from {Client.create}
+    # @param gateway_id [String] Gateway ID
+    # @return [Array<Object, Object>] in JSON format
+    def self.find(token, client_id, gateway_id)
+      request(:get, '/gateway/' + gateway_id.to_s, {}, {token: token, "client-id" => client_id})
+    end
+
+    # Updates Gateway venue_id
+    # @param token [String] Client Token after Authentication
+    # @param client_id [String] used from {Client.create}
+    # @param gateway_id [String] Gateway ID
+    # @param gateway [Object]
+    # @return [Array<Object, Object>] in JSON format
+    def self.update(token, client_id, gateway_id, gateway = {})
+      request(:put, '/gateway/' + gateway_id.to_s, {}, {token: token, "client-id" => client_id})
+    end
+
+  end
+end

data/lib/tacore/venue.rb

@@ -0,0 +1,51 @@
+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.
+    # @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})
+    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})
+    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)
+      # returns all venues that belong to this client
+      request(:get, '/client/venues', {}, {"token": token, "client-id" => client_id})
+    end
+
+    # This method will permanently remove the venue from the API.
+    # @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.destroy(token, client_id, venue_id)
+      request(:delete, '/venue/' + venue_id.to_s,{}, {"client-id" => client_id, "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})
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: TACore
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Greg Winn
+- Brandon Criss
+- Shelby Solomon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This allows access to the TA Core API
+email: greg.winn@thinaer.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/exceptions.rb
+- lib/tacore.rb
+- lib/tacore/app.rb
+- lib/tacore/client.rb
+- lib/tacore/device.rb
+- lib/tacore/gateway.rb
+- lib/tacore/venue.rb
+homepage: http://thinaer.io
+licenses:
+- None
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: ThinAer Core API for the THINaer Platform
+test_files: []