forked from omnimike/learnosity-sdk-nodejs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
186 lines (167 loc) · 5.03 KB
/
index.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
'use strict';
/**
*--------------------------------------------------------------------------
* Learnosity SDK - Init
*--------------------------------------------------------------------------
*
* Used to generate the necessary security and request data (in the
* correct format) to integrate with any of the Learnosity API services.
*
*/
var _ = require('underscore');
var sha256 = require('crypto-js/sha256');
var moment = require('moment');
/**
*
*
* @param requestPacket
* @returns string
*/
function convertRequestPacketToString(requestPacket) {
if (requestPacket && typeof requestPacket !== 'string') {
return JSON.stringify(requestPacket);
} else {
return requestPacket;
}
}
/**
* Insert security information into assess request object
*
* @param requestPacket requestPacket is mutated as a result.
* @param securityPacket
* @param secret
*/
function insertSecurityInformationToAssessObject(requestPacket, securityPacket, secret) {
if (requestPacket.questionsApiActivity) {
var questionsApi = requestPacket.questionsApiActivity;
var domain = 'assess.learnosity.com';
if (securityPacket.domain) {
domain = securityPacket.domain;
} else if (questionsApi.domain) {
domain = questionsApi.domain;
}
requestPacket.questionsApiActivity.consumer_key = securityPacket.consumer_key;
requestPacket.questionsApiActivity.timestamp = securityPacket.timestamp;
requestPacket.questionsApiActivity.user_id = securityPacket.user_id;
requestPacket.questionsApiActivity.signature = hashSignatureArray([
securityPacket.consumer_key,
domain,
securityPacket.timestamp,
securityPacket.user_id,
secret
]);
}
}
/**
* Creates the signature hash.
*
* @param service string
* @param securityPacket object
* @param secret string
* @param requestString string
* @param action object
*/
function generateSignature(
service,
securityPacket,
secret,
requestString,
action
) {
var signatureArray = [
securityPacket.consumer_key,
securityPacket.domain,
securityPacket.timestamp
];
if(securityPacket.user_id) {
signatureArray.push(securityPacket.user_id);
}
signatureArray.push(secret);
// Add the requestPacket if necessary
var signRequestData = !(service === 'assess' || service === 'questions');
if (signRequestData && requestString && requestString.length > 0) {
signatureArray.push(requestString);
}
// Add the action if necessary
if (action && action.length > 0) {
signatureArray.push(action);
}
return hashSignatureArray(signatureArray);
}
/**
* Joins an array (with '_') and hashes it.
*
* @param signatureArray array
* @returns string
*/
function hashSignatureArray(signatureArray) {
return sha256(signatureArray.join('_')).toString();
}
/**
* @constructor
*/
function LearnositySDK() {}
/**
* @see https://docs.learnosity.com/ For more information
*
* @param service string
* @param securityPacket object
* @param secret string
* @param requestPacket object
* @param action object
*
* @returns object The init options for a Learnosity API
*/
LearnositySDK.prototype.init = function (
service,
securityPacket,
secret,
requestPacket,
action
) {
// requestPacket can be passed in as an object or as an already encoded
// string.
var requestString = convertRequestPacketToString(requestPacket);
// Automatically timestamp the security packet
if (!securityPacket.timestamp) {
securityPacket.timestamp = moment().utc().format('YYYYMMDD-HHmm');
}
if (service === 'assess') {
insertSecurityInformationToAssessObject(requestPacket, securityPacket, secret);
}
// Automatically populate the user_id of the security packet.
if (_.contains(['author', 'items', 'reports'], service)) {
// The Events API requires a user_id, so we make sure it's a part
// of the security packet as we share the signature in some cases
if (!securityPacket.user_id && requestPacket && requestPacket.user_id) {
securityPacket.user_id = requestPacket.user_id;
}
}
// Generate the signature based on the arguments provided
securityPacket.signature = generateSignature(
service,
securityPacket,
secret,
requestString,
action
);
var output;
if(service === 'data') {
output = {
'security': JSON.stringify(securityPacket),
'request': JSON.stringify(requestPacket),
'action': action
};
} else if (service === 'questions') {
output = _.extend(securityPacket, requestPacket);
} else if (service === 'assess') {
output = requestPacket;
} else {
output = {
'security': securityPacket,
'request': requestPacket
};
}
return output;
};
module.exports = LearnositySDK;