-
Notifications
You must be signed in to change notification settings - Fork 2
/
xAPIwrapper.js
1614 lines (1442 loc) · 59.7 KB
/
xAPIwrapper.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* ****Connection to LRS****
* You need to identify the URL for your LRS endpoint.
* Typically, it's in the same "area" in the GUI where records are displayed.
*
* You also need to identify how the LRS allows access to your space.
* Is it through a username/password? Key/secret?
*
* The content of those 3 variables need to be put in the Config function to be able to push & pull using the LRS.
*
* @return {object} config object
* @example
* var conf = {
* "endpoint" : "https://lrs.adlnet.gov/xapi/",
* "auth" : "Basic " + toBase64('tom:1234'),
* };
* ADL.XAPIWrapper.changeConfig(conf);
*/
var Config = function()
{
var key = "XXXXXXXXXXXXXXXXXXX";
var secret = "XXXXXXXXXXXXXXXXXXXX";
var conf = {
"endpoint" : "https://myLRS.io.pleasework",
"auth" : "Basic " + toBase64(key + ':' + secret),
};
// Statement defaults
// conf["actor"] = {"mbox":"default@example.com"};
// conf["registration"] = ruuid();
// conf["grouping"] = {"id":"ctxact:default/grouping"};
// conf["activity_platform"] = "default platform";
// Behavior defaults
// conf["strictCallbacks"] = false; // Strict error-first callbacks
return conf
}();
/****************************
* It's not necessary to edit anything underneath this line for typical functionality.
*
* It's all just code, so feel free to play with it. But know that as long as the LRS configured properly above, everything below should work.
*****************************/
// adds toISOString to date objects if not there
// from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
if ( !Date.prototype.toISOString ) {
( function() {
function pad(number) {
var r = String(number);
if ( r.length === 1 ) {
r = '0' + r;
}
return r;
}
Date.prototype.toISOString = function() {
return this.getUTCFullYear()
+ '-' + pad( this.getUTCMonth() + 1 )
+ '-' + pad( this.getUTCDate() )
+ 'T' + pad( this.getUTCHours() )
+ ':' + pad( this.getUTCMinutes() )
+ ':' + pad( this.getUTCSeconds() )
+ '.' + String( (this.getUTCMilliseconds()/1000).toFixed(3) ).slice( 2, 5 )
+ 'Z';
};
}() );
}
// shim for old-style Base64 lib
function toBase64(text){
if(CryptoJS && CryptoJS.enc.Base64)
return CryptoJS.enc.Base64.stringify(CryptoJS.enc.Latin1.parse(text));
else
return Base64.encode(text);
}
// shim for old-style crypto lib
function toSHA1(text){
if(CryptoJS && CryptoJS.SHA1)
return CryptoJS.SHA1(text).toString();
else
return Crypto.util.bytesToHex( Crypto.SHA1(text,{asBytes:true}) );
}
function toSHA256(text){
if(CryptoJS && CryptoJS.SHA256)
return CryptoJS.SHA256(text).toString();
}
// check if string or object is date, if it is, return date object
// feburary 31st == march 3rd in this solution
function isDate(date) {
// check if object is being passed
if ( Object.prototype.toString.call(date) === "[object Date]" )
var d = date;
else
var d = new Date(date);
// deep check on date object
if ( Object.prototype.toString.call(d) === "[object Date]" )
{
// it is a date
if ( isNaN( d.valueOf() ) )
{
ADL.XAPIWrapper.log("Invalid date String passed");
return null;
} else {
return d;
}
} else {
// not a date
ADL.XAPIWrapper.log("Invalid date object");
return null;
}
}
(function(ADL){
log.debug = false;
function getByteLen(normal_val) {
// Force string type
normal_val = String(normal_val);
var byteLen = 0;
for (var i = 0; i < normal_val.length; i++) {
var c = normal_val.charCodeAt(i);
byteLen += c < (1 << 7) ? 1 :
c < (1 << 11) ? 2 :
c < (1 << 16) ? 3 :
c < (1 << 21) ? 4 :
c < (1 << 26) ? 5 :
c < (1 << 31) ? 6 : Number.NaN;
}
return byteLen;
}
/*
* XAPIWrapper Constructor
* @param {object} config with a minimum of an endoint property
* @param {boolean} verifyxapiversion indicating whether to verify the version of the LRS is compatible with this wrapper
*/
XAPIWrapper = function(config, verifyxapiversion)
{
this.lrs = getLRSObject(config || {});
if (this.lrs.user && this.lrs.password)
updateAuth(this.lrs, this.lrs.user, this.lrs.password);
this.base = getbase(this.lrs.endpoint);
this.withCredentials = false;
this.withCredentials = config && config.withCredentials;
// Ensure that callbacks are always executed, first param is error (null if no error) followed
// by the result(s)
this.strictCallbacks = false;
this.strictCallbacks = config && config.strictCallbacks;
function getbase(url)
{
var l = document.createElement("a");
l.href = url;
if (l.protocol && l.host)
return l.protocol + "//" + l.host;
else
ADL.XAPIWrapper.log("Couldn't create base url from endpoint: " + this.lrs.endpoint);
}
function updateAuth(obj, username, password){
obj.auth = "Basic " + toBase64(username + ":" + password);
}
if (verifyxapiversion && testConfig.call(this))
{
window.ADL.XHR_request(this.lrs, this.lrs.endpoint+"about", "GET", null, null,
function(r){
if(r.status == 200)
{
try
{
var lrsabout = JSON.parse(r.response);
var versionOK = false;
for (var idx in lrsabout.version)
{
if(lrsabout.version[idx] == ADL.XAPIWrapper.xapiVersion)
{
versionOK = true;
break;
}
}
if (!versionOK)
{
ADL.XAPIWrapper.log("The lrs version [" + lrsabout.version +"]"+
" does not match this wrapper's XAPI version [" + ADL.XAPIWrapper.xapiVersion + "]");
}
}
catch(e)
{
ADL.XAPIWrapper.log("The response was not an about object")
}
}
else
{
ADL.XAPIWrapper.log("The request to get information about the LRS failed: " + r);
}
}, null, false, null, this.withCredentials, false);
}
this.searchParams = function(){
var sp = {"format" : "exact"};
return sp;
};
this.hash = function(tohash){
if (!tohash) return null;
try
{
return toSHA1(tohash);
}
catch(e)
{
ADL.XAPIWrapper.log("Error trying to hash -- " + e);
return null;
}
};
this.changeConfig = function(config){
try
{
ADL.XAPIWrapper.log("updating lrs object with new configuration");
this.lrs = mergeRecursive(this.lrs, config);
if (config.user && config.password)
this.updateAuth(this.lrs, config.user, config.password);
this.base = getbase(this.lrs.endpoint);
this.withCredentials = config.withCredentials;
this.strictCallbacks = config.strictCallbacks;
}
catch(e)
{
ADL.XAPIWrapper.log("error while changing configuration -- " + e);
}
};
this.updateAuth = updateAuth;
};
// This wrapper is based on the Experience API Spec version:
XAPIWrapper.prototype.xapiVersion = "1.0.1";
/*
* Adds info from the lrs object to the statement, if available.
* These values could be initialized from the Config object or from the url query string.
* @param {object} stmt the statement object
*/
XAPIWrapper.prototype.prepareStatement = function(stmt)
{
if(stmt.actor === undefined){
stmt.actor = JSON.parse(this.lrs.actor);
}
else if(typeof stmt.actor === "string") {
stmt.actor = JSON.parse(stmt.actor);
}
if (this.lrs.grouping ||
this.lrs.registration ||
this.lrs.activity_platform) {
if (!stmt.context) {
stmt.context = {};
}
}
if (this.lrs.grouping) {
if (!stmt.context.contextActivities) {
stmt.context.contextActivities = {};
}
stmt.context.contextActivities.grouping = [{ id : this.lrs.grouping }];
}
if (this.lrs.registration) {
stmt.context.registration = this.lrs.registration;
}
if (this.lrs.activity_platform) {
stmt.context.platform = this.lrs.activity_platform;
}
};
// tests the configuration of the lrs object
XAPIWrapper.prototype.testConfig = testConfig;
// writes to the console if available
XAPIWrapper.prototype.log = log;
/*
* Send a single statement to the LRS. Makes a Javascript object
* with the statement id as 'id' available to the callback function.
* @param {object} stmt statement object to send
* @param {function} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* and an object with an id property assigned the id
* of the statement
* @return {object} object containing xhr object and id of statement
* @example
* // Send Statement
* var stmt = {"actor" : {"mbox" : "mailto:tom@example.com"},
* "verb" : {"id" : "http://adlnet.gov/expapi/verbs/answered",
* "display" : {"en-US" : "answered"}},
* "object" : {"id" : "http://adlnet.gov/expapi/activities/question"}};
* var resp_obj = ADL.XAPIWrapper.sendStatement(stmt);
* ADL.XAPIWrapper.log("[" + resp_obj.id + "]: " + resp_obj.xhr.status + " - " + resp_obj.xhr.statusText);
* >> [3e616d1c-5394-42dc-a3aa-29414f8f0dfe]: 204 - NO CONTENT
*
* // Send Statement with Callback
* var stmt = {"actor" : {"mbox" : "mailto:tom@example.com"},
* "verb" : {"id" : "http://adlnet.gov/expapi/verbs/answered",
* "display" : {"en-US" : "answered"}},
* "object" : {"id" : "http://adlnet.gov/expapi/activities/question"}};
* ADL.XAPIWrapper.sendStatement(stmt, function(resp, obj){
* ADL.XAPIWrapper.log("[" + obj.id + "]: " + resp.status + " - " + resp.statusText);});
* >> [4edfe763-8b84-41f1-a355-78b7601a6fe8]: 204 - NO CONTENT
*/
XAPIWrapper.prototype.sendStatement = function(stmt, callback, attachments)
{
if (this.testConfig())
{
this.prepareStatement(stmt);
var id;
if (stmt['id'])
{
id = stmt['id'];
}
else
{
id = ADL.ruuid();
stmt['id'] = id;
}
var payload = JSON.stringify(stmt);
var extraHeaders = null;
if(attachments && attachments.length > 0)
{
extraHeaders = {}
payload = this.buildMultipartPost(stmt,attachments,extraHeaders)
}
var resp = ADL.XHR_request(this.lrs, this.lrs.endpoint+"statements",
"POST", payload, this.lrs.auth, callback, {"id":id}, null, extraHeaders,
this.withCredentials, this.strictCallbacks);
if (!callback)
return {"xhr":resp,
"id" :id};
}
};
/*
* Build the post body to include the multipart boundries, edit the statement to include the attachment types
* extraHeaders should be an object. It will have the multipart boundary value set
* attachments should be an array of objects of the type
* {
type:"signature" || {
usageType : URI,
display: Language-map
description: Language-map
},
value : a UTF8 string containing the binary data of the attachment. For string values, this can just be the JS string.
}
*/
XAPIWrapper.prototype.buildMultipartPost = function(statement,attachments,extraHeaders)
{
statement.attachments = [];
for(var i =0; i < attachments.length; i++)
{
//replace the term 'signature' with the hard coded definition for a signature attachment
if(attachments[i].type == "signature")
{
attachments[i].type = {
"usageType": "http://adlnet.gov/expapi/attachments/signature",
"display": {
"en-US": "A JWT signature"
},
"description": {
"en-US": "A signature proving the statement was not modified"
},
"contentType": "application/octet-stream"
}
}
//compute the length and the sha2 of the attachment
attachments[i].type.length = attachments[i].value.length;
attachments[i].type.sha2 = toSHA256(attachments[i].value);
//attach the attachment metadata to the statement
statement.attachments.push(attachments[i].type)
}
var body = "";
var CRLF = "\r\n";
var boundary = (Math.random()+' ').substring(2,10)+(Math.random()+' ').substring(2,10);
extraHeaders["Content-Type"] = "multipart/mixed; boundary=" + boundary;
body += CRLF + '--' + boundary + CRLF + 'Content-Type:application/json' + CRLF + "Content-Disposition: form-data; name=\"statement\"" + CRLF + CRLF;
body += JSON.stringify(statement);
for(var i in attachments)
{
body += CRLF + '--' + boundary + CRLF + 'X-Experience-API-Hash:' + attachments[i].type.sha2 + CRLF + "Content-Type:application/octet-stream" + CRLF + "Content-Transfer-Encoding: binary" + CRLF + CRLF
body += attachments[i].value;
}
body += CRLF + "--" + boundary + "--" + CRLF
return body;
}
/*
* Send a list of statements to the LRS.
* @param {array} stmtArray the list of statement objects to send
* @param {function} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object
* @example
* var stmt = {"actor" : {"mbox" : "mailto:tom@example.com"},
* "verb" : {"id" : "http://adlnet.gov/expapi/verbs/answered",
* "display" : {"en-US" : "answered"}},
* "object" : {"id" : "http://adlnet.gov/expapi/activities/question"}};
* var resp_obj = ADL.XAPIWrapper.sendStatement(stmt);
* ADL.XAPIWrapper.getStatements({"statementId":resp_obj.id});
* >> {"version": "1.0.0",
* "timestamp": "2013-09-09 21:36:40.185841+00:00",
* "object": {"id": "http://adlnet.gov/expapi/activities/question", "objectType": "Activity"},
* "actor": {"mbox": "mailto:tom@example.com", "name": "tom creighton", "objectType": "Agent"},
* "stored": "2013-09-09 21:36:40.186124+00:00",
* "verb": {"id": "http://adlnet.gov/expapi/verbs/answered", "display": {"en-US": "answered"}},
* "authority": {"mbox": "mailto:tom@adlnet.gov", "name": "tom", "objectType": "Agent"},
* "context": {"registration": "51a6f860-1997-11e3-8ffd-0800200c9a66"},
* "id": "ea9c1d01-0606-4ec7-8e5d-20f87b1211ed"}
*/
XAPIWrapper.prototype.sendStatements = function(stmtArray, callback)
{
if (this.testConfig())
{
for(var i in stmtArray)
{
this.prepareStatement(stmtArray[i]);
}
var resp = ADL.XHR_request(this.lrs,this.lrs.endpoint+"statements",
"POST", JSON.stringify(stmtArray), this.lrs.auth, callback, null,
false, null, this.withCredentials, this.strictCallbacks);
if (!callback)
{
return resp;
}
}
};
/*
* Get statement(s) based on the searchparams or more url.
* @param {object} searchparams an ADL.XAPIWrapper.searchParams object of
* key(search parameter)-value(parameter value) pairs.
* Example:
* var myparams = ADL.XAPIWrapper.searchParams();
* myparams['verb'] = ADL.verbs.completed.id;
* var completedStmts = ADL.XAPIWrapper.getStatements(myparams);
* @param {string} more the more url found in the StatementResults object, if there are more
* statements available based on your get statements request. Pass the
* more url as this parameter to retrieve those statements.
* @param {function} [callback] - function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object or null if 404
* @example
* var ret = ADL.XAPIWrapper.getStatements();
* if (ret)
* ADL.XAPIWrapper.log(ret.statements);
*
* >> <Array of statements>
*/
XAPIWrapper.prototype.getStatements = function(searchparams, more, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "statements";
if (more)
{
url = this.base + more;
}
else
{
var urlparams = new Array();
for (s in searchparams)
{
if (s == "until" || s == "since") {
var d = new Date(searchparams[s]);
urlparams.push(s + "=" + encodeURIComponent(d.toISOString()));
} else {
urlparams.push(s + "=" + encodeURIComponent(searchparams[s]));
}
}
if (urlparams.length > 0)
url = url + "?" + urlparams.join("&");
}
var res = ADL.XHR_request(this.lrs,url, "GET", null, this.lrs.auth,
callback, null, false, null, this.withCredentials, this.strictCallbacks);
if(res === undefined || res.status == 404)
{
return null
}
try
{
return JSON.parse(res.response);
}
catch(e)
{
return res.response;
}
}
};
/*
* Gets the Activity object from the LRS.
* @param {string} activityid the id of the Activity to get
* @param {function} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object or null if 404
* @example
* var res = ADL.XAPIWrapper.getActivities("http://adlnet.gov/expapi/activities/question");
* ADL.XAPIWrapper.log(res);
* >> <Activity object>
*/
XAPIWrapper.prototype.getActivities = function(activityid, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "activities?activityId=<activityid>";
url = url.replace('<activityid>', encodeURIComponent(activityid));
var result = ADL.XHR_request(this.lrs, url, "GET", null, this.lrs.auth,
callback, null, true, null, this.withCredentials, this.strictCallbacks);
if(result === undefined || result.status == 404)
{
return null
}
try
{
return JSON.parse(result.response);
}
catch(e)
{
return result.response;
}
}
};
/*
* Store activity state in the LRS
* @param {string} activityid the id of the Activity this state is about
* @param {object} agent the agent this Activity state is related to
* @param {string} stateid the id you want associated with this state
* @param {string} [registration] the registraton id associated with this state
* @param {string} stateval the state
* @param {string} [matchHash] the hash of the state to replace or * to replace any
* @param {string} [noneMatchHash] the hash of the current state or * to indicate no previous state
* @param {function} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {boolean} false if no activity state is included
* @example
* var stateval = {"info":"the state info"};
* ADL.XAPIWrapper.sendState("http://adlnet.gov/expapi/activities/question",
* {"mbox":"mailto:tom@example.com"},
* "questionstate", null, stateval);
*/
XAPIWrapper.prototype.sendState = function(activityid, agent, stateid, registration, stateval, matchHash, noneMatchHash, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "activities/state?activityId=<activity ID>&agent=<agent>&stateId=<stateid>";
url = url.replace('<activity ID>',encodeURIComponent(activityid));
url = url.replace('<agent>',encodeURIComponent(JSON.stringify(agent)));
url = url.replace('<stateid>',encodeURIComponent(stateid));
if (registration)
{
url += "®istration=" + encodeURIComponent(registration);
}
var headers = null;
if(matchHash && noneMatchHash)
{
log("Can't have both If-Match and If-None-Match");
}
else if (matchHash)
{
headers = {"If-Match":ADL.formatHash(matchHash)};
}
else if (noneMatchHash)
{
headers = {"If-None-Match":ADL.formatHash(noneMatchHash)};
}
var method = "PUT";
if (stateval)
{
if (stateval instanceof Array)
{
stateval = JSON.stringify(stateval);
headers = headers || {};
headers["Content-Type"] ="application/json";
}
else if (stateval instanceof Object)
{
stateval = JSON.stringify(stateval);
headers = headers || {};
headers["Content-Type"] ="application/json";
method = "POST";
}
else
{
headers = headers || {};
headers["Content-Type"] ="application/octet-stream";
}
}
else
{
this.log("No activity state was included.");
return false;
}
//(lrs, url, method, data, auth, callback, callbackargs, ignore404, extraHeaders)
ADL.XHR_request(this.lrs, url, method, stateval, this.lrs.auth, callback,
null, null, headers, this.withCredentials, this.strictCallbacks);
}
};
/*
* Get activity state from the LRS
* @param {string} activityid the id of the Activity this state is about
* @param {object} agent the agent this Activity state is related to
* @param {string} [stateid] the id of the state, if not included, the response will be a list of stateids
* associated with the activity and agent)
* @param {string} [registration] the registraton id associated with this state
* @param {object} [since] date object or date string telling the LRS to return objects newer than the date supplied
* @param {function} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object or null if 404
* @example
* ADL.XAPIWrapper.getState("http://adlnet.gov/expapi/activities/question",
* {"mbox":"mailto:tom@example.com"}, "questionstate");
* >> {info: "the state info"}
*/
XAPIWrapper.prototype.getState = function(activityid, agent, stateid, registration, since, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "activities/state?activityId=<activity ID>&agent=<agent>";
url = url.replace('<activity ID>',encodeURIComponent(activityid));
url = url.replace('<agent>',encodeURIComponent(JSON.stringify(agent)));
if (stateid)
{
url += "&stateId=" + encodeURIComponent(stateid);
}
if (registration)
{
url += "®istration=" + encodeURIComponent(registration);
}
if(since)
{
since = isDate(since);
if (since != null) {
url += '&since=' + encodeURIComponent(since.toISOString());
}
}
var result = ADL.XHR_request(this.lrs, url, "GET", null, this.lrs.auth,
callback, null, true, null, this.withCredentials, this.strictCallbacks);
if(result === undefined || result.status == 404)
{
return null
}
try
{
return JSON.parse(result.response);
}
catch(e)
{
return result.response;
}
}
};
/*
* Delete activity state in the LRS
* @param {string} activityid the id of the Activity this state is about
* @param {object} agent the agent this Activity state is related to
* @param {string} stateid the id you want associated with this state
* @param {string} [registration] the registraton id associated with this state
* @param {string} [matchHash] the hash of the state to replace or * to replace any
* @param {string} [noneMatchHash] the hash of the current state or * to indicate no previous state
* @param {string} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object or null if 404
* @example
* var stateval = {"info":"the state info"};
* ADL.XAPIWrapper.sendState("http://adlnet.gov/expapi/activities/question",
* {"mbox":"mailto:tom@example.com"},
* "questionstate", null, stateval);
* ADL.XAPIWrapper.getState("http://adlnet.gov/expapi/activities/question",
* {"mbox":"mailto:tom@example.com"}, "questionstate");
* >> {info: "the state info"}
*
* ADL.XAPIWrapper.deleteState("http://adlnet.gov/expapi/activities/question",
* {"mbox":"mailto:tom@example.com"}, "questionstate");
* >> XMLHttpRequest {statusText: "NO CONTENT", status: 204, response: "", responseType: "", responseXML: null…}
*
* ADL.XAPIWrapper.getState("http://adlnet.gov/expapi/activities/question",
* {"mbox":"mailto:tom@example.com"}, "questionstate");
* >> 404
*/
XAPIWrapper.prototype.deleteState = function(activityid, agent, stateid, registration, matchHash, noneMatchHash, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "activities/state?activityId=<activity ID>&agent=<agent>&stateId=<stateid>";
url = url.replace('<activity ID>',encodeURIComponent(activityid));
url = url.replace('<agent>',encodeURIComponent(JSON.stringify(agent)));
url = url.replace('<stateid>',encodeURIComponent(stateid));
if (registration)
{
url += "®istration=" + encodeURIComponent(registration);
}
var headers = null;
if(matchHash && noneMatchHash)
{
log("Can't have both If-Match and If-None-Match");
}
else if (matchHash)
{
headers = {"If-Match":ADL.formatHash(matchHash)};
}
else if (noneMatchHash)
{
headers = {"If-None-Match":ADL.formatHash(noneMatchHash)};
}
var result = ADL.XHR_request(this.lrs, url, "DELETE", null, this.lrs.auth,
callback, null, false, headers, this.withCredentials, this.strictCallbacks);
if(result === undefined || result.status == 404)
{
return null
}
try
{
return JSON.parse(result.response);
}
catch(e)
{
return result;
}
}
};
/*
* Store activity profile in the LRS
* @param {string} activityid the id of the Activity this profile is about
* @param {string} profileid the id you want associated with this profile
* @param {string} profileval the profile
* @param {string} [matchHash] the hash of the profile to replace or * to replace any
* @param {string} [noneMatchHash] the hash of the current profile or * to indicate no previous profile
* @param {string} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {bolean} false if no activity profile is included
* @example
* var profile = {"info":"the profile"};
* ADL.XAPIWrapper.sendActivityProfile("http://adlnet.gov/expapi/activities/question",
* "actprofile", profile, null, "*");
*/
XAPIWrapper.prototype.sendActivityProfile = function(activityid, profileid, profileval, matchHash, noneMatchHash, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "activities/profile?activityId=<activity ID>&profileId=<profileid>";
url = url.replace('<activity ID>',encodeURIComponent(activityid));
url = url.replace('<profileid>',encodeURIComponent(profileid));
var headers = null;
if(matchHash && noneMatchHash)
{
log("Can't have both If-Match and If-None-Match");
}
else if (matchHash)
{
headers = {"If-Match":ADL.formatHash(matchHash)};
}
else if (noneMatchHash)
{
headers = {"If-None-Match":ADL.formatHash(noneMatchHash)};
}
var method = "PUT";
if (profileval)
{
if (profileval instanceof Array)
{
profileval = JSON.stringify(profileval);
headers = headers || {};
headers["Content-Type"] ="application/json";
}
else if (profileval instanceof Object)
{
profileval = JSON.stringify(profileval);
headers = headers || {};
headers["Content-Type"] ="application/json";
method = "POST";
}
else
{
headers = headers || {};
headers["Content-Type"] ="application/octet-stream";
}
}
else
{
this.log("No activity profile was included.");
return false;
}
ADL.XHR_request(this.lrs, url, method, profileval, this.lrs.auth, callback,
null, false, headers, this.withCredentials, this.strictCallbacks);
}
};
/*
* Get activity profile from the LRS
* @param {string} activityid the id of the Activity this profile is about
* @param {string} [profileid] the id of the profile, if not included, the response will be a list of profileids
* associated with the activity
* @param {object} [since] date object or date string telling the LRS to return objects newer than the date supplied
* @param {function [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object or null if 404
* @example
* ADL.XAPIWrapper.getActivityProfile("http://adlnet.gov/expapi/activities/question",
* "actprofile", null,
* function(r){ADL.XAPIWrapper.log(JSON.parse(r.response));});
* >> {info: "the profile"}
*/
XAPIWrapper.prototype.getActivityProfile = function(activityid, profileid, since, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "activities/profile?activityId=<activity ID>";
url = url.replace('<activity ID>',encodeURIComponent(activityid));
if (profileid)
{
url += "&profileId=" + encodeURIComponent(profileid);
}
if(since)
{
since = isDate(since);
if (since != null) {
url += '&since=' + encodeURIComponent(since.toISOString());
}
}
var result = ADL.XHR_request(this.lrs, url, "GET", null, this.lrs.auth,
callback, null, true, null, this.withCredentials, this.strictCallbacks);
if(result === undefined || result.status == 404)
{
return null
}
try
{
return JSON.parse(result.response);
}
catch(e)
{
return result.response;
}
}
};
/*
* Delete activity profile in the LRS
* @param {string} activityid the id of the Activity this profile is about
* @param {string} profileid the id you want associated with this profile
* @param {string} [matchHash] the hash of the profile to replace or * to replace any
* @param {string} [noneMatchHash] the hash of the current profile or * to indicate no previous profile
* @param {string} [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object or null if 404
* @example
* ADL.XAPIWrapper.deleteActivityProfile("http://adlnet.gov/expapi/activities/question",
* "actprofile");
* >> XMLHttpRequest {statusText: "NO CONTENT", status: 204, response: "", responseType: "", responseXML: null…}
*/
XAPIWrapper.prototype.deleteActivityProfile = function(activityid, profileid, matchHash, noneMatchHash, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "activities/profile?activityId=<activity ID>&profileId=<profileid>";
url = url.replace('<activity ID>',encodeURIComponent(activityid));
url = url.replace('<profileid>',encodeURIComponent(profileid));
var headers = null;
if(matchHash && noneMatchHash)
{
log("Can't have both If-Match and If-None-Match");
}
else if (matchHash)
{
headers = {"If-Match":ADL.formatHash(matchHash)};
}
else if (noneMatchHash)
{
headers = {"If-None-Match":ADL.formatHash(noneMatchHash)};
}
var result = ADL.XHR_request(this.lrs, url, "DELETE", null, this.lrs.auth,
callback, null, false, headers,this.withCredentials, this.strictCallbacks);
if(result === undefined || result.status == 404)
{
return null
}
try
{
return JSON.parse(result.response);
}
catch(e)
{
return result;
}
}
};
/*
* Gets the Person object from the LRS based on an agent object.
* The Person object may contain more information about an agent.
* See the xAPI Spec for details.
* @param {object} agent the agent object to get a Person
* @param {function [callback] function to be called after the LRS responds
* to this request (makes the call asynchronous)
* the function will be passed the XMLHttpRequest object
* @return {object} xhr response object or null if 404
* @example
* var res = ADL.XAPIWrapper.getAgents({"mbox":"mailto:tom@example.com"});
* ADL.XAPIWrapper.log(res);
* >> <Person object>
*/
XAPIWrapper.prototype.getAgents = function(agent, callback)
{
if (this.testConfig())
{
var url = this.lrs.endpoint + "agents?agent=<agent>";