telemetry 1.1.16 → 1.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61ce494e39c20a91da002a825fca096cb0f91169
-  data.tar.gz: e7929168331c150d1e12a91d6b84329b0892bc17
+  metadata.gz: 8b4bd391de1c6290032e814a39da14bac76dc4c1
+  data.tar.gz: d5899c6456d2b8c889a67c0b15671d174c57428e
 SHA512:
-  metadata.gz: 82e7cfeb4ab001bac20043cd9c864f766a23dbf7163149d6bc9b2bc756290823cc196c3a3d85f3f0ca65778a57ea3b7b44a46464aec252d4bdbc962dc83086d3
-  data.tar.gz: f78f373ed23e021cf272d591cc192ed456dd6b8e656a1e1c6299db6849efbecd80ecf664a35a0ad269ee87f5681f2c2d50ced45580ffaffd3cfbbc9507bc862f
+  metadata.gz: d7ad1123a4359b0b9b895cd64c3293c028d66e63c4098901edc9b1cb6e625b435b76bef8daf32385934ee7d46ca7c3a18b58f3494acfc26e1a799d32589c894b
+  data.tar.gz: 217c442e59bbdd23d5e1bfbfae91f830c71343c5026b0df3e86bb1793182fba3df89cdb0962814ef9cf705c808ff3946b633d7a6ebff455ca8bb07125ecdb37a

data/README.md

@@ -26,6 +26,32 @@ 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
+
+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.  
+
+	require 'telemetry'
+
+	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
+
+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. 
+
+In order to view encrypted data in your browser you will need to append the key to the end of the URL by adding it like the following: 
+
+	https://boards.telemetryapp.com/board.html?channel_id=467177c0126e4d8d4809c2414b995e01#encryption_key=ENCRYPTIONKEY
+
+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. 
+
+
 ## 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.
@@ -81,6 +107,7 @@ Custom update intervals are supported on a per flow basis.  To configure the upd
 		set value: 50
 	end
 
+Deamon mode does not currently support encrypting values.
 
 ## Contributing
 

data/lib/telemetry/flows.rb

@@ -1,11 +1,24 @@
 #/usr/bin/env ruby
 
 require 'hashie'
+require 'gibberish'
+require 'multi_json'
+require 'oj'
 
 module TelemetryFlows
 	def emit
 		Telemetry::Api.flow_update(self)
 	end
+	def encrypt(encrytion_key)
+		cipher = Gibberish::AES.new(encrytion_key)
+		skipped_keys = ["tag", "expires_at", "priority", "icon"]
+		self.keys.each do |key|
+			unless skipped_keys.include?(key)
+				self[key] = {enc_json: cipher.enc(MultiJson.dump(self[key]))}
+			end
+		end
+		puts self.to_hash
+	end
 end
 
 module Telemetry
@@ -77,7 +90,7 @@ module Telemetry
 		property :x_labels
 	end
 
-	# Icons
+	# Icon
 	class Icon < Hashie::Dash
 		include TelemetryFlows
 		property :title

data/lib/telemetry/version.rb

@@ -1,3 +1,3 @@
 module Telemetry
-  TELEMETRY_VERSION = "1.1.16"
+  TELEMETRY_VERSION = "1.1.17"
 end

data/spec/flows_spec.rb

@@ -46,12 +46,12 @@ describe "Flows" do
   	Telemetry::Graph.new(properties).emit
   end
 
-  it "should update a Icons" do
+  it "should update a Icon" do
   	properties = {
-  		tag: "test-flow-icons",
+  		tag: "test-flow-icon",
   		icons: [{type: "icon-dashboard", label: "Alert", color: "red"}]
   	}
-  	Telemetry::Icons.new(properties).emit
+  	Telemetry::Icon.new(properties).emit
   end
 
   it "should update a Iframe" do

data/telemetry.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
   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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telemetry
 version: !ruby/object:Gem::Version
-  version: 1.1.16
+  version: 1.1.17
 platform: ruby
 authors:
 - W. Gersham Meharg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gibberish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement