Merge pull request #10 from Learnosity/CAT-68/feature/add-telemetry

[FEATURE] SDK Telemetry CAT-68

Author: rhiannon-eldridge-lrn

.gitignore

@@ -1,3 +1,5 @@
+.idea/
+.rakeTasks
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -7,5 +9,7 @@
 /spec/reports/
 /tmp/
 
+/examples/lrn-sdk-rails/Gemfile.lock
+
 # rspec failure tracking
 .rspec_status

ChangeLog.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- This ChangeLog!
+- Telemetry data (basic information about the execution environment) is now added to the to the request objects being signed which is later read and logged internally by our APIs when the request is received. This allows us to better support our various SDKs and does not send any additional network requests. More information can be found in README.md.

Gemfile.lock

@@ -2,11 +2,13 @@ PATH
   remote: .
   specs:
     learnosity-sdk (0.1.0)
+      sys-uname (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
+    ffi (1.11.1)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -21,6 +23,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    sys-uname (1.0.4)
+      ffi (>= 1.0.0)
 
 PLATFORMS
   ruby

README.md

@@ -268,7 +268,19 @@ Just run
 
     rake spec
 
-to exercise the testsuite
+to exercise the testsuite.
+
+##Tracking
+
+In version v0.2.0, we introduced code to track the following information by adding it to the request being signed:
+
+    SDK version
+    SDK language
+    SDK language version
+    Host platform (OS)
+    Platform version
+
+We use this data to enable better support and feature planning. All subsequent versions of the SDK shall include this usage tracking.
 
 
 [author-api-doc]: https://docs.learnosity.com/authoring/author

examples/lrn-sdk-rails/Gemfile

@@ -9,7 +9,7 @@ end
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.0.2'
 # Use sqlite3 as the database for Active Record
-gem 'sqlite3'
+gem 'sqlite3', '~> 1.3.6'
 # Use Puma as the app server
 gem 'puma', '~> 3.0'
 # Use SCSS for stylesheets

examples/simple/init_data.rb

@@ -4,6 +4,8 @@
 
 require 'learnosity/sdk/request/init'
 
+itembank_uri = URI('https://data.learnosity.com/v1/itembank/items')
+
 security_packet = {
 	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
 	'consumer_key'   => 'yis0TYCu7U9V4o7M',
@@ -14,7 +16,7 @@
 data_request = { 'limit' => 1 }
 
 # Do 5 subsequent requests using the `next` pointer
-[1,2,3,4,5].each  do |reqno|
+[1,2,3,4,5].each do |reqno|
 	init = Learnosity::Sdk::Request::Init.new(
 		'data',
 		security_packet,
@@ -24,16 +26,15 @@
 
 	request = init.generate
 
-	itembankUri = URI('https://data.learnosity.com/v1/itembank/items')
-	puts ">>> [#{itembankUri} (#{reqno})] #{JSON.generate(request)}"
+	puts ">>> [#{itembank_uri} (#{reqno})] #{JSON.generate(request)}"
 
-	res = Net::HTTP.post_form(itembankUri, request)
+	res = Net::HTTP.post_form(itembank_uri, request)
 
 	puts "<<< [#{res.code}] #{res.body}"
 
 	response = JSON.parse(res.body)
-	if ( !response['meta']['next'].nil? \
-			and !response['meta']['records'].nil? and response['meta']['records'] > 0)
+	if !response['meta']['next'].nil? \
+			and !response['meta']['records'].nil? and response['meta']['records'] > 0
 		data_request['next'] = response['meta']['next']
 	end
 end

learnosity-sdk.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "sys-uname", "~> 1.0"
   spec.add_development_dependency "bundler", ">= 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"