Merge pull request #29 from Learnosity/CAT-77/docs/clarify-user_id-examples

[DOCS] Clarify user_id examples CAT-77

Author: Tyler Nienhouse

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.

LearnositySDK/Examples/Assess.cs

@@ -18,7 +18,7 @@ public static string Simple()
 
             JsonObject security = new JsonObject();
             security.set("consumer_key", Credentials.ConsumerKey);
-            security.set("user_id", "demo_student");
+            security.set("user_id", "$ANONYMIZED_USER_ID");
             security.set("domain", Credentials.Domain);
 
             string secret = Credentials.ConsumerSecret;

LearnositySDK/Examples/Events.cs

@@ -14,7 +14,7 @@ public static string Simple()
 
             JsonObject security = new JsonObject();
             security.set("consumer_key", "yis0TYCu7U9V4o7M");
-            security.set("user_id", "demo_student");
+            security.set("user_id", "$ANONYMIZED_USER_ID");
             security.set("domain", "localhost");
 
             string secret = "74c5fd430cf1242a527f6223aebd42d30464be22";
@@ -34,7 +34,7 @@ private static JsonObject users()
 
             for (int i = 0; i <= 10; i++)
             {
-                string user_id = "userid_" + i;
+                string user_id = "$ANONYMIZED_USER_ID_" + i;
                 users.set(user_id);
             }
 

LearnositySDK/Examples/Items.cs

@@ -15,7 +15,7 @@ public static string Simple()
             JsonObject security = new JsonObject();
             security.set("consumer_key", Credentials.ConsumerKey);
             security.set("domain", Credentials.Domain);
-            security.set("user_id", "12345678");
+            security.set("user_id", "$ANONYMIZED_USER_ID");
 
             string secret = Credentials.ConsumerSecret;
 
@@ -31,7 +31,7 @@ public static string Simple()
             request.set("name", "Demo Activity");
             request.set("course_id", "demo_yis0TYCu7U9V4o7M");
             request.set("session_id", Uuid.generate());
-            request.set("user_id", "demo_student");
+            request.set("user_id", "$ANONYMIZED_USER_ID");
             request.set("config", config);
 
             // Instantiate Init class

LearnositySDK/Examples/Questions.cs

@@ -17,7 +17,7 @@ public static string Simple(out string uuid)
             JsonObject security = new JsonObject();
             security.set("consumer_key", Credentials.ConsumerKey);
             security.set("domain", Credentials.Domain);
-            security.set("user_id", "demo_student");
+            security.set("user_id", "$ANONYMIZED_USER_ID");
 
             string secret = Credentials.ConsumerSecret;
 

LearnositySDK/Examples/Reports.cs

@@ -23,7 +23,7 @@ public static string Simple()
             JsonObject report = new JsonObject();
             report.set("id", "report-1");
             report.set("type", "sessions-summary");
-            report.set("user_id", "brianmoser");
+            report.set("user_id", "$ANONYMIZED_USER_ID");
             report.set("session_ids", session_ids);
 
             JsonObject reports = new JsonObject(true);

readme.md

@@ -58,7 +58,7 @@ string service = "items";
 JsonObject security = new JsonObject();
 security.set("consumer_key", "yis0TYCu7U9V4o7M");
 security.set("domain", "localhost");
-security.set("user_id", "12345678");
+security.set("user_id", "$ANONYMIZED_USER_ID");
 
 string secret = "74c5fd430cf1242a527f6223aebd42d30464be22";
 
@@ -68,7 +68,7 @@ request.set("activity_id", "my-demo-activity");
 request.set("name", "Demo Activity");
 request.set("course_id", "demo_yis0TYCu7U9V4o7M");
 request.set("session_id", Uuid.generate());
-request.set("user_id", "demo_student");
+request.set("user_id", "$ANONYMIZED_USER_ID");
 
 // Instantiate Init class
 Init init = new Init(service, security, secret, request);
@@ -217,7 +217,7 @@ session_ids.set("AC023456-2C73-44DC-82DA28894FCBC3BF");
 JsonObject report = new JsonObject();
 report.set("id", "report-1");
 report.set("type", "sessions-summary");
-report.set("user_id", "brianmoser");
+report.set("user_id", "$ANONYMIZED_USER_ID");
 report.set("session_ids", session_ids);
 
 JsonObject reports = new JsonObject(true);
@@ -242,4 +242,14 @@ You can find the latest version of the SDK as a self-contained ZIP file in the [
 
 ## Examples
 
-Each service has it's own example - you can find them in `Examples` folder of LearnositySDK project. To run them simply invoke static `Simple` method.
+Each service has it's own example - you can find them in `Examples` folder of LearnositySDK project. To run them simply invoke static `Simple` method.
+
+## Tracking
+In version v0.9.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.