[DOC] Include examples for sessions templates

README.md

@@ -62,9 +62,11 @@ say, the `items` API, you just need to instantiate the
 require "learnosity/sdk/request/init"
 
 security_packet = {
-        'consumer_key'   => 'yis0TYCu7U9V4o7M',
-        'domain'         => 'localhost',
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
+	'consumer_key'   => 'yis0TYCu7U9V4o7M',
+	'domain'         => 'localhost'
 }
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
 consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
 items_request = { 'limit' => 50 }
 
@@ -111,9 +113,11 @@ require "learnosity/sdk/request/init"
 
 
 security_packet = {
-        'consumer_key'   => 'yis0TYCu7U9V4o7M',
-        'domain'         => 'localhost',
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
+	'consumer_key'   => 'yis0TYCu7U9V4o7M',
+	'domain'         => 'localhost'
 }
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
 consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
 data_request = { 'limit' => 50 }
 
@@ -198,6 +202,7 @@ require 'learnosity/sdk/request/init'
 
 class IndexController < ApplicationController
   @@security_packet = {
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
     'consumer_key'   => 'yis0TYCu7U9V4o7M',
     'domain'         => 'localhost'
   }

examples/advanced/discard_sessions_by_activity.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+require 'net/http'
+require 'json'
+
+require 'learnosity/sdk/request/init'
+
+activityId = 'demoActivity'
+maxCount = 100
+
+class SessionDiscarder
+	def initialize
+		@sessionsStatusesUri = URI('https://data.learnosity.com/v1/sessions/statuses')
+
+		@security_packet = {
+			# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
+			'consumer_key'   => 'yis0TYCu7U9V4o7M',
+			'domain'         => 'localhost'
+		}
+		# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
+		@consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+	end
+
+	def get_sessions_statuses(sessionIds)
+		request = { "session_id": sessionIds }
+		return do_get_sessions_statuses(request)
+	end
+
+	def get_sessions_statuses_by_activity(activityId)
+		request = { "activity_id": [ activityId ] }
+		return do_get_sessions_statuses(request)
+	end
+
+	def do_get_sessions_statuses(request)
+
+		reqno = 0
+		continue = true
+		sessions = []
+		while continue do
+			reqno += 1
+
+			init = Learnosity::Sdk::Request::Init.new(
+				'data',
+				@security_packet,
+				@consumer_secret,
+				request
+			)
+			signedRequest = init.generate
+
+			puts ">>> [#{@sessionsStatusesUri} (#{reqno})] #{JSON::generate(signedRequest)}"
+
+			res = Net::HTTP.post_form(@sessionsStatusesUri, signedRequest)
+			response = JSON.parse(res.body)
+
+			puts "<<< [#{res.code}] #{response['meta']['records']} records, next: #{response['meta']['next']}"
+
+			if ( !response['meta']['next'].nil? \
+					and !response['meta']['records'].nil? and response['meta']['records'] > 0)
+				request['next'] = response['meta']['next']
+			else
+				continue = false
+			end
+
+			response['data'].each { |session|
+				sessions += [ session ]
+			}
+		end
+		return sessions
+	end
+
+	def update_statuses(statuses)
+		sessionsDiscardRequest = { "statuses": statuses }
+
+		init = Learnosity::Sdk::Request::Init.new(
+			'data',
+			@security_packet,
+			@consumer_secret,
+			sessionsDiscardRequest,
+			'update'
+		)
+		request = init.generate
+
+		puts ">>> [#{@sessionsStatusesUri}] #{JSON::generate(sessionsDiscardRequest)}"
+
+		res = Net::HTTP.post_form(@sessionsStatusesUri, request)
+		response = JSON.parse(res.body)
+
+		puts "<<< [#{res.code}] job_reference: #{response['data']['job_reference']}"
+	end
+end
+
+sd = SessionDiscarder.new
+
+sessions = sd.get_sessions_for_activity(activityId)
+
+statuses = []
+sessions.each { |session|
+	if session['status'] != 'Discarded'
+		session['status'] = 'Discarded'
+		statuses += [ session ]
+		if statuses.count == maxCount
+			sd.update_statuses(statuses)
+			statuses = []
+		end
+	end
+}
+if statuses.count > 0
+	sd.update_statuses(statuses)
+end

examples/advanced/session_templates_get.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'net/http'
+require 'json'
+
+require 'learnosity/sdk/request/init'
+
+security_packet = {
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
+	'consumer_key'   => 'yis0TYCu7U9V4o7M',
+	'domain'         => 'localhost'
+}
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
+consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+
+sessionsTemplatesUri = URI('https://data.learnosity.com/v1/sessions/templates')
+sessionsTemplatesRequest = { 'items' => [ 'dataapiMCQ10' ] }
+
+init = Learnosity::Sdk::Request::Init.new(
+	'data',
+	security_packet,
+	consumer_secret,
+	sessionsTemplatesRequest
+)
+
+request = init.generate
+
+puts ">>> [#{sessionsTemplatesUri}] #{JSON.generate(request)}"
+
+res = Net::HTTP.post_form(sessionsTemplatesUri, request)
+
+puts "<<< [#{res.code}] #{res.body}"

examples/lrn-sdk-rails/app/controllers/index_controller.rb

@@ -3,6 +3,7 @@
 
 class IndexController < ApplicationController
   @@security_packet = {
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
     'consumer_key'   => 'yis0TYCu7U9V4o7M',
     'domain'         => 'localhost'
   }

examples/simple/init_data.rb

@@ -5,25 +5,27 @@
 require 'learnosity/sdk/request/init'
 
 security_packet = {
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
 	'consumer_key'   => 'yis0TYCu7U9V4o7M',
 	'domain'         => 'localhost'
 }
 # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
 consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
-data_request = { 'limit' => 1 }
+
+itembankUri = URI('https://data.learnosity.com/v1/itembank/items')
+itembankRequest = { 'limit' => 1 }
 
 # Do 5 subsequent requests using the `next` pointer
 [1,2,3,4,5].each  do |reqno|
 	init = Learnosity::Sdk::Request::Init.new(
 		'data',
 		security_packet,
 		consumer_secret,
-		data_request
+		itembankRequest
 	)
 
 	request = init.generate
 
-	itembankUri = URI('https://data.learnosity.com/v1/itembank/items')
 	puts ">>> [#{itembankUri} (#{reqno})] #{JSON.generate(request)}"
 
 	res = Net::HTTP.post_form(itembankUri, request)
@@ -33,6 +35,6 @@
 	response = JSON.parse(res.body)
 	if ( !response['meta']['next'].nil? \
 			and !response['meta']['records'].nil? and response['meta']['records'] > 0)
-		data_request['next'] = response['meta']['next']
+		itembankRequest['next'] = response['meta']['next']
 	end
 end

examples/simple/init_items.rb

@@ -2,6 +2,7 @@
 require 'learnosity/sdk/request/init'
 
 security_packet = {
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
 	'consumer_key'   => 'yis0TYCu7U9V4o7M',
 	'domain'         => 'localhost'
 }

spec/learnosity/sdk/request/init_spec.rb

@@ -2,10 +2,12 @@
 
 RSpec.describe Learnosity::Sdk::Request::Init do
   security_packet = {
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
     'consumer_key'   => 'yis0TYCu7U9V4o7M',
     'domain'         => 'localhost',
     'timestamp'      => '20140626-0528',
   }
+  # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
   consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
 
   items_request = { 'limit' => 50 }