telemetry 1.1.19 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76ab6898d99ccde224a5876020b6c256c76488ee
-  data.tar.gz: cf11b690f4345508106b08a7aefc1585681c5d04
+  metadata.gz: 9f1ce2e956552717f052ca48ca99889d82b992ad
+  data.tar.gz: 8d655c85120856567b021d5c9d3ee017e4d9f09a
 SHA512:
-  metadata.gz: 8d01637c892f3b6e88fc3e9f7115f89df3b9f4ad7b5f9d1d978d54b165ea163a9b6b5105c5a6d6a2bdd02b687e0a3c20712ee1e6811f52fb00f55887c867394e
-  data.tar.gz: 15d28fa59e728ccc2a6f4af35339c9e7641e0fc2010077e5196e695bc06db385240a3de22068734475e24e9ba8538d44bb2a8f031467adb49eb7114b270334fa
+  metadata.gz: 87c80fbcb013965aaccd715150289d50cf1e6bbe3f926ba4dff7455f25c3be494980400bf9210f923d5ab622cc0b3fbadcb376ef99505bf98573f3dacd469f7d
+  data.tar.gz: 63c75c8477a654ac34e169e5b1be1abdc99c529195a8aab432e62113a3b9f4eb569d2bd91879b333dfc4eadc1ead3d31913b48ec028271cb57eef23577e4e439

data/README.md

@@ -8,8 +8,28 @@ Install on your system:
 
     $ gem install telemetry
 
+
 ## Basic Usage
 
+This gem allows you to interact with the API using simple POST, GET, PATCH, PUT, DELETE. You should use the following methods:
+
+- Telemetry::Api.delete(path) 
+- Telemetry::Api.get(path)
+- Telemetry::Api.patch(path, body)
+- Telemetry::Api.post(path, body)
+- Telemetry::Api.put(path, body)
+
+Where __path__ is the path for the resource (for instance "/boards/:board_id") and __body__ is a hash of the body to send to the server.  You do not need to JSON encode the body, it will be converted to JSON for you.
+
+	require 'telemetry'
+
+	Telemetry.token = $YOUR_API_TOKEN
+
+	@board = Telemetry::Api.get("/boards/#{@board_id}")
+
+
+## Sending Data To Flows
+
 To use this gem you must require it in your file and specify your API Token that you can find on the [Telemetry API Token page](https://www.telemetryapp.com/account/api_token)
 
 Set a hash of values for the flow to update.  Each hash must contain the tag of the flow that you want to update.  
@@ -26,7 +46,7 @@ Set a hash of values for the flow to update.  Each hash must contain the tag of
 
 For documentation on flows and the properties they support please see the [flow documentation](https://www.telemetryapp.com/documentation/flows) pages.
 
-## Encryption
+## Data Encryption
 
 While Telemetry is SSL based and we protect our customers data with utmost caution, some corporate policies will not approve of any third party having the possibility of access to their data.  Therefore we support optional encryption of the data with AES-256-CBC before sending it to the Telemetry API.   The Telemetry Javascript application that runs in your browser to view the data can be configured with the same key in order to decrypt the data and display it for you while making it invisible to any prying eyes in the middle.  
 
@@ -54,7 +74,7 @@ Note that the # part will not be sent to the server, it's a local argument only
 
 ## Affiliates
 
-This gem supports affiliate data sending.  In order to use this capability call the Telemetry::Api.affiliate_send(flows, unique-identifier) method. You must have an enterprise account and get support to enable your account for affiliates first.
+This gem supports affiliate data sending.  In order to use this capability call the Telemetry::Api.affiliate_send(unique-identifier, flows) method. You must have an enterprise account and get support to enable your account for affiliates first.
 
 	require 'telemetry'
 
@@ -68,7 +88,7 @@ This gem supports affiliate data sending.  In order to use this capability call
 	}
 
 	# Send to the unique identifier for the affiliate as created by you on the affiliate page
-	Telemetry::Api.affiliate_send(flows, "unique-identifier")
+	Telemetry::Api.affiliate_send("unique-identifier", flows)
 
 For more information see the [affiliate documentation](https://admin.telemetryapp.com/documentation/affiliate).
 

data/lib/telemetry/api.rb

@@ -19,13 +19,13 @@ module Telemetry
 	def self.api_host
 		unless @api_host
 			if ENV["RACK_ENV"] == 'development'
-				@api_host = "https://data.telemetryapp.com"				
+				@api_host = "https://api.telemetryapp.com"				
 			elsif ENV["RACK_ENV"] == 'test'
-				@api_host = "https://data.telemetryapp.com"
+				@api_host = "https://api.telemetryapp.com"
 			elsif ENV["RACK_ENV"] == 'qa'
-				@api_host = "https://qa-data.telemetryapp.com"
+				@api_host = "https://qa-api.telemetryapp.com"
 			else
-				@api_host = "https://data.telemetryapp.com"
+				@api_host = "https://api.telemetryapp.com"
 			end
 		end
 		@api_host
@@ -56,7 +56,23 @@ module Telemetry
 	end
 
 	class Api
-		
+
+		def self.get(path)
+			Telemetry::Api.send(:get, path)
+		end
+
+		def self.post(path, body)
+			Telemetry::Api.send(:post, path, body)
+		end
+
+		def self.patch(path, body)
+			Telemetry::Api.send(:patch, path, body)
+		end
+
+		def self.delete(path)
+			Telemetry::Api.send(:delete, path)
+		end
+
 		def self.get_flow(id)
 			Telemetry::Api.send(:get, "/flows/#{id}")
 		end
@@ -73,14 +89,14 @@ module Telemetry
 			raise Telemetry::AuthenticationFailed, "Please set your Telemetry.token" unless Telemetry.token
 			raise RuntimeError, "Must supply data to send" unless data
 			raise RuntimeError, "Must supply a unique affiliate identifier" unless affiliate_identifier
-			return Telemetry::Api.send(:post, "/flows/affiliate/#{affiliate_identifier}", {:data => data})
+			return Telemetry::Api.send(:post, "/affiliates/#{affiliate_identifier}/data", {:data => data})
 		end
 
 		def self.flow_update(flow)
 			raise Telemetry::AuthenticationFailed, "Please set your Telemetry.token" unless Telemetry.token
 			values = flow.to_hash
 			tag = values.delete('tag')
-			result = Telemetry::Api.send(:put, "/flows/#{tag}", values)
+			result = Telemetry::Api.send(:put, "/flows/#{tag}/data", values)
 			raise ResponseError, "API Response: #{result['errors'].join(', ')}" unless result["updated"].include?(tag)
 			result
 		end
@@ -94,7 +110,7 @@ module Telemetry
 				tag = values.delete('tag')
 				data[tag] = values
 			end
-			return Telemetry::Api.send(:post, "/flows", {:data => data})
+			return Telemetry::Api.send(:post, "/data", {:data => data})
 		end
 
 		def self.send(method, endpoint, data = nil)
@@ -110,6 +126,9 @@ module Telemetry
 			elsif method == :put
 				request = Net::HTTP::Put.new(uri.path)
 				request.body = MultiJson.dump(data) 
+			elsif method == :patch
+				request = Net::HTTP::Patch.new(uri.path)
+				request.body = MultiJson.dump(data) 
 			elsif method == :get 
 				request = Net::HTTP::Get.new(uri.path)
 			elsif method == :delete
@@ -169,16 +188,16 @@ module Telemetry
 					Telemetry::logger.error error
 					raise Telemetry::RateLimited, error
 				when "500"
-					error = "#{Time.now} (HTTP 500): Data API server error. #{method.upcase} #{uri}"
+					error = "#{Time.now} (HTTP 500): API server error. #{method.upcase} #{uri}"
 					Telemetry::logger.error error
 					Telemetry::logger.error response.body
 					raise Telemetry::ServerException, error
 				when "502"
-					error = "#{Time.now} (HTTP 502): Data API server is down. #{method.upcase} #{uri}"
+					error = "#{Time.now} (HTTP 502): API server is down. #{method.upcase} #{uri}"
 					Telemetry::logger.error error
 					raise Telemetry::Unavailable, error
 				when "503"
-					error = "#{Time.now} (HTTP 503): Data API server is down. #{method.upcase} #{uri}"
+					error = "#{Time.now} (HTTP 503): API server is down. #{method.upcase} #{uri}"
 					Telemetry::logger.error error
 					raise Telemetry::Unavailable, error
 				else

data/lib/telemetry/daemon_config_parser.rb

@@ -2,6 +2,10 @@
 
 module TelemetryDaemon
 
+	def api_host(api_host)
+		Telemetry.api_host = api_host
+	end
+
 	def api_token(token)
 		Telemetry.token = token
 	end

data/lib/telemetry/version.rb

@@ -1,3 +1,3 @@
 module Telemetry
-  TELEMETRY_VERSION = "1.1.19"
+  TELEMETRY_VERSION = "1.2.0"
 end

data/telemetry.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.required_ruby_version = '>= 1.9.2'
-  gem.add_dependency "oj"
-  gem.add_dependency "multi_json"
-  gem.add_dependency "dante"
-  gem.add_dependency "hashie"
-  gem.add_dependency "net-http-persistent"
-  gem.add_dependency "gibberish"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "rake"
+  gem.add_dependency "oj", "~> 2.5"
+  gem.add_dependency "multi_json", "~> 1.8"
+  gem.add_dependency "dante", "~> 0.2"
+  gem.add_dependency "hashie", "~> 2.0"
+  gem.add_dependency "net-http-persistent", "~> 2.9"
+  gem.add_dependency "gibberish", "~> 1.3"
+  gem.add_development_dependency "rspec", "~> 2.14"
+  gem.add_development_dependency "rake", "~> 10.1"
 end

metadata

@@ -1,127 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: telemetry
 version: !ruby/object:Gem::Version
-  version: 1.1.19
+  version: 1.2.0
 platform: ruby
 authors:
 - W. Gersham Meharg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: dante
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: gibberish
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 description: Telemetry Data Submission API Gem.  See our website for a more detailed
   description.
 email:
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Telemetry Data Submission API Gem