telemetry 1.2.9 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0adfb853a8c5a7ee7168775d61da216bc604efc
-  data.tar.gz: 6921fbedf6141e840f2f4a7e169c2d78f1d5d70c
+  metadata.gz: 6c98e75fc39aa3ebcae9ed124b8b2b3366e4adea
+  data.tar.gz: 53c03dc0d606009ccb7fe941fdf611360ffec775
 SHA512:
-  metadata.gz: 9ecd01f584da3a07349fc8bdd816b2a920348b93a739c785654302c6ca75ff8cda44de3c4b704e366dfd06699a3b1a55b6fa4cc3bac453167bffba24b27aacd3
-  data.tar.gz: ec2ae564ba372158673a2cc233db3f25af521c3e992163c1c8449477d759987b493d1802bb1848064da21bf49f8c6037353e85fdc9bad92f0975a094f9a46c10
+  metadata.gz: 36d91f5cf6c7237ee8852760c47cbba36b01368cb90d54053dfebb55d79dee9134369e41853f6104bc9a4a12cb7a8ef75fdb426b8a593b9a92cc3565cf6e22b4
+  data.tar.gz: 1e3babe9a3570158646e3687deafe68ffab9825af11c9b07efa54d62ae5220e9f5562412c0893483b18f3589f26e109f0ab4884761186e763da70bdc6cfefd79

data/README.md

@@ -24,27 +24,59 @@ Where __path__ is the path for the resource (for instance "/boards/:board_id") a
 	require 'telemetry'
 
 	Telemetry.token = $YOUR_API_TOKEN
-
 	@board = Telemetry::Api.get("/boards/#{@board_id}")
 
-
-## Sending Data To Flows
+## Sending Data To a Flow
 
 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.  
+Create a new flow object of the variant that you want to use. Use its emit method to send the data to Telemetry.  
 
 	require 'telemetry'
 
 	Telemetry.token = "test-api-token"
+	gauge = Telemetry::Gauge.new(tag: "test-flow-gauge", value: 3434)
+	gauge.emit
+
+Supported flow object variants are as follows:
+
+- Telemetry::Barchart
+- Telemetry::Bulletchart
+- Telemetry::Countdown
+- Telemetry::Gauge
+- Telemetry::Graph
+- Telemetry::Grid
+- Telemetry::Icon
+- Telemetry::Image
+- Telemetry::Log
+- Telemetry::Multigauge
+- Telemetry::Multivalue
+- Telemetry::Piechart
+- Telemetry::Scatterplot
+- Telemetry::Servers
+- Telemetry::Status
+- Telemetry::Table
+- Telemetry::Text
+- Telemetry::Tickertape
+- Telemetry::Timechart
+- Telemetry::Timeline
+- Telemetry::Upstatus
+- Telemetry::Value
+- Telemetry::Waterfall
+
+For documentation on the different properties for the various data elements please see the [data documentation](https://www.telemetryapp.com/user/documentation/data) pages.
+
+## Batch Updating Multiple Flows at Once
+
+You may send data to more than one flow in a single API call.  To do this construct an array of flows and use the Telemetry::Api.flow_update_batch(flows) method. A code example follows:
 
-	properties = {
-		tag: "test-flow-value",
-		value: 3434
-	}
-	Telemetry::Value.new(properties).emit
+	require 'telemetry'
 
-For documentation on flows and the properties they support please see the [flow documentation](https://www.telemetryapp.com/documentation/flows) pages.
+	Telemetry.token = "test-api-token"
+	flows = []
+	flows << Telemetry::Value.new({tag: "test-flow-value", value: 3432})
+	flows << Telemetry::Gauge.new({tag: "test-flow-gauge", value: 33})
+	Telemetry::Api.flow_update_batch(flows)
 
 ## Data Encryption
 
@@ -54,14 +86,9 @@ While Telemetry is SSL based and we protect our customers data with utmost cauti
 
 	Telemetry.token = "test-api-token"
 	ENCRYPTIONKEY = "Unique Random Password"
-
-	properties = {
-		tag: "test-flow-value",
-		value: 3434
-	}
-	value = Telemetry::Value.new(properties)
-	value.encrypt(ENCRYPTIONKEY)  
-	value.emit
+	flow = Telemetry::Value.new(tag: "test-flow-value", value: 3434)
+	flow.encrypt(ENCRYPTIONKEY)  
+	flow.emit
 
 Please be careful that your data isn't able to be validated by the Telemetry API since it cannot see it.  Therefore we suggest testing with dummy uncrypted data first.  Additionally there will be performance implications for large amounts of changing data for some browsers. 
 
@@ -71,26 +98,39 @@ In order to view encrypted data in your browser you will need to append the key
 
 Note that the # part will not be sent to the server, it's a local argument only visible to the local javascript running in the browser.  Certain attributes like tags and priority will not be encrypted as they're needed by the system. 
 
+## Virtual Channels
 
-## Affiliates
+This gem supports virtual channel sending.  You must have a pro or higher account to use virtual channels.  In order to use this you must call:
 
-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.
+-	Telemetry::Api.channel_send(unique-identifier, flow)
+-	Telemetry::Api.channel_send_batch(unique-identifier, flows) 
+
+An example of code to do this would be:
 
 	require 'telemetry'
 
 	Telemetry.token = "test-api-token"
+	flow = Telemetry::Value.new(tag: "test-flow-value", value: 3434)
+	Telemetry::Api.channel_send("channel-tag", flow)
 
-	# Construct a hash with the flow tags as keys and the values as the hash to use to update the data
-	flows = {
-		value_tag: {
-			value: 435
-		}
-	}
+For more information see the [virtual channel documentation](https://www.telemetryapp.com/user/documentation/virtual_channels).
 
-	# Send to the unique identifier for the affiliate as created by you on the affiliate page
-	Telemetry::Api.affiliate_send("unique-identifier", flows)
+## Affiliates
+
+This gem supports affiliate data sending. You must have an enterprise account and get support to enable your account for affiliates first. In order to use this capability call either:
+
+-	Telemetry::Api.affiliate_send(affiliate-identifier, flow)
+-	Telemetry::Api.affiliate_send_batch(affiliate-identifier, flows) 
+
+An example of code to do this would be:
+
+	require 'telemetry'
+
+	Telemetry.token = "test-api-token"
+	flow = Telemetry::Value.new(tag: "test-flow-value", value: 3434)
+	Telemetry::Api.affiliate_send("affiliate-identifier", flow)
 
-For more information see the [affiliate documentation](https://admin.telemetryapp.com/documentation/affiliate).
+For more information see the [affiliate documentation](https://admin.telemetryapp.com/documentation/affiliates).
 
 ## Daemon
 

data/lib/telemetry/api.rb

@@ -85,10 +85,47 @@ module Telemetry
 			Telemetry::Api.send(:delete, "/flows/#{id}/data")
 		end
 
-		def self.affiliate_send(affiliate_identifier, data)
+		def self.channel_send_batch(channel_tag, flows)
 			raise Telemetry::AuthenticationFailed, "Please set your Telemetry.token" unless Telemetry.token
-			raise RuntimeError, "Must supply data to send" unless data
+			raise RuntimeError, "Must supply flows to send" unless flows
+			raise RuntimeError, "Must supply a channel_tag" unless channel_tag
+			data = {}
+			flows.each do |flow|
+				values = flow.to_hash
+				tag = values.delete('tag')
+				data[tag] = values
+			end
+			return Telemetry::Api.send(:post, "/channels/#{channel_tag}/data", {:data => data})
+		end
+
+		def self.channel_send(channel_tag, flow)
+			raise Telemetry::AuthenticationFailed, "Please set your Telemetry.token" unless Telemetry.token
+			raise RuntimeError, "Must supply flow to send" unless flow
+			raise RuntimeError, "Must supply a channel_tag" unless channel_tag
+			values = flow.to_hash
+			tag = values.delete('tag')
+			return Telemetry::Api.send(:put, "/channels/#{channel_tag}/flows/#{tag}/data", values)
+		end
+
+		def self.affiliate_send(affiliate_identifier, flow)
+			raise Telemetry::AuthenticationFailed, "Please set your Telemetry.token" unless Telemetry.token
+			raise RuntimeError, "Must supply flow to send" unless flow
+			raise RuntimeError, "Must supply a unique affiliate identifier" unless affiliate_identifier
+			values = flow.to_hash
+			tag = values.delete('tag')
+			return Telemetry::Api.send(:post, "/affiliates/#{affiliate_identifier}/flows/#{tag}/data", values)
+		end
+
+		def self.affiliate_send_batch(affiliate_identifier, flows)
+			raise Telemetry::AuthenticationFailed, "Please set your Telemetry.token" unless Telemetry.token
+			raise RuntimeError, "Must supply flows to send" unless flows
 			raise RuntimeError, "Must supply a unique affiliate identifier" unless affiliate_identifier
+			data = {}
+			flows.each do |flow|
+				values = flow.to_hash
+				tag = values.delete('tag')
+				data[tag] = values
+			end
 			return Telemetry::Api.send(:post, "/affiliates/#{affiliate_identifier}/data", {:data => data})
 		end
 

data/lib/telemetry/flows.rb

@@ -114,7 +114,6 @@ module Telemetry
 		property :icon
 		property :link
 		property :renderer
-		property :baseline
 		property :series, :default => []
 		property :min_scale
 		property :unstack
@@ -311,6 +310,7 @@ module Telemetry
 		property :icon
 		property :link
 		property :table, :default => []
+		property :values, :default => []
 		property :headers, :default => []
 		property :colors, :default => []
 	end

data/lib/telemetry/version.rb

@@ -1,3 +1,3 @@
 module Telemetry
-  TELEMETRY_VERSION = "1.2.9"
+  TELEMETRY_VERSION = "1.3.0"
 end

data/spec/flows_spec.rb

@@ -54,14 +54,6 @@ describe "Flows" do
   	Telemetry::Icon.new(properties).emit
   end
 
-  it "should update a Iframe" do
-  	properties = {
-  		tag: "test-flow-iframe",
-  		url: "http://www.telemetryapp.com"
-  	}
-  	Telemetry::Iframe.new(properties).emit
-  end
-
   it "should update a Log" do
   	properties = {
   		tag: "test-flow-log",
@@ -70,14 +62,6 @@ describe "Flows" do
   	Telemetry::Log.new(properties).emit
   end
 
-  it "should update a Map" do
-  	properties = {
-  		tag: "test-flow-map",
-  		map_type: "asia",
-  		points: [[34.344,129.344],[55.233,121.233]]
-  	}
-  	Telemetry::Map.new(properties).emit
-  end
 
   it "should update a Multigauge" do
   	properties = {
@@ -98,7 +82,7 @@ describe "Flows" do
   it "should update a Servers" do
   	properties = {
   		tag: "test-flow-servers",
-  		servers: [{values: [33,22,55], title: "Alpha"}]
+  		servers: [{values: [33,22,55], name: "Alpha"}]
   	}
   	Telemetry::Servers.new(properties).emit
   end
@@ -135,15 +119,6 @@ describe "Flows" do
   	Telemetry::Tickertape.new(properties).emit
   end
 
-  it "should update a Timechart" do
-  	properties = {
-  		tag: "test-flow-timechart",
-  		type: "week",
-  		values: [34,123,76,43,45,16,48]
-  	}
-  	Telemetry::Timechart.new(properties).emit
-  end
-
   it "should update a Timeline" do
   	properties = {
   		tag: "test-flow-timeline",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telemetry
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.3.0
 platform: ruby
 authors:
 - W. Gersham Meharg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -143,8 +143,6 @@ files:
 - lib/telemetry/daemon_config_parser.rb
 - lib/telemetry/flows.rb
 - lib/telemetry/version.rb
-- spec/batch_spec.rb
-- spec/daemon_spec.rb
 - spec/flows_spec.rb
 - spec/spec_helper.rb
 - telemetry.gemspec
@@ -173,8 +171,6 @@ signing_key:
 specification_version: 4
 summary: Telemetry Data Submission API Gem
 test_files:
-- spec/batch_spec.rb
-- spec/daemon_spec.rb
 - spec/flows_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/batch_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-
-describe "Batch" do
-	before(:all) do
-		Telemetry.token = "test-api-token"
-	end
-
-	it "should perform a batch update" do
-
-		flows = []
-
-		barchart_properties = {
-			tag: "test-flow-barchart",
-			bars: [{value:1000, label:'test', color:'red'}]
-		}
-		flows << Telemetry::Barchart.new(barchart_properties)
-
-		gauge_properties = {
-			tag: "test-flow-gauge",
-			value: 3434
-		}
-		flows << Telemetry::Gauge.new(gauge_properties)
-
-		value_properties = {
-			tag: "test-flow-value",
-			value: 3434
-		}
-		flows << Telemetry::Value.new(value_properties)
-
-		result = Telemetry::Api.flow_update_batch(flows)
-
-		result["skipped"].should eql([])
-		result["errors"].should eql([])
-	end
-end

data/spec/daemon_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-require_relative "../lib/telemetry/daemon_config_parser"
-
-describe "Daemon" do
-	before(:all) do
-		Telemetry.token = "test-api-token"
-	end
-
-    it "should run the daemon" do
-    	`bin/telemetryd -c telemetryd_config.rb -o`
-	end
-end