-
Notifications
You must be signed in to change notification settings - Fork 8
/
star_logo_nova.py
500 lines (450 loc) · 18.3 KB
/
star_logo_nova.py
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
import re
from datetime import datetime
from operator import attrgetter
import pytz
import requests
import settings
class SLNProject:
""" Convenience wrapper around our AssessmentTaken
objects that maps to StarLogoNova projects """
def __init__(self, object_map, results=None):
self.my_map = object_map
self.section = None
self.time_format = '%Y-%m-%dT%H:%M:%S.%fZ'
# for performance, try to get the section / result
# on __init__ -- that means we can call
# ``get_results()`` on the ProjectsList once,
# and get all the data for each Project?
# Don't want to make individual results calls
# for each project -- that will get expensive as
# the number of projects grows.
if results is None:
results = self.get_all_results()
self.all_results = results
self.section = self.find_my_section(results)
def find_my_section(self, results):
""" find the taken with matching takingAgentId and
return the section """
my_sections = [r
for r in results
if r['takingAgentId'] == self.my_map['takingAgentId']]
if not my_sections:
raise KeyError('No result found??')
return my_sections[0]['sections'][0]
@staticmethod
def get_agent_id(taking_agent_id):
""" Parse out only the identifier """
identifier = re.compile('%3A(.*)%40')
return identifier.search(taking_agent_id).group(1)
def get_all_results(self):
""" Get all the results / AssessmentTakens for the
same AssessmentOffered. Used in the provenance
methods. """
req = requests.get(self.results_url, verify=False)
takens = req.json()
return takens
def get_section(self):
""" Get the AssessmentOffered results for this
user, and save the section """
url = '{0}?agentId={1}'.format(
self.results_url,
self.get_agent_id(self.my_map['takingAgentId'])
)
req = requests.get(url, verify=False)
data = req.json()
# Should only have one match on the takingAgentId
self.section = data[0]
return self.section
@property
def results_url(self):
""" helper method to return the results URL """
return '{0}/{1}/assessmentsoffered/{2}/results'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
self.my_map['assignedBankIds'][0],
self.my_map['assessmentOfferedId']
)
@property
def id(self):
return self.my_map['id']
@property
def title(self):
return self.my_map['displayName']['text']
@property
def description(self):
return self.my_map['description']['text']
@property
def project_str(self):
""" Have to get the AssessmentSection with responses
for this... """
if self.section is None:
self.get_section()
# First question (1 of 1)
# Last response
# Extended text interaction response
question = self.section['questions'][0]
if question['responded']:
latest_response = question['response']
return latest_response['text']['text']
return None
@property
def created_at(self):
""" This should be an ISO String, like
2018-03-22T15:40:14.533736Z """
start_time_with_tz = self.my_map['actualStartTime']
start_time_with_tz['tzinfo'] = pytz.utc
created_at = datetime(**start_time_with_tz)
return created_at.strftime(self.time_format)
@property
def saved_at(self):
""" Have to get the AssessmentSection with responses
for this... should be an ISO String, like
2018-03-22T15:40:14.533736Z """
if self.section is None:
self.get_section()
# First question (1 of 1)
# Last response
# Submission time, if present
question = self.section['questions'][0]
if question['responded']:
latest_response = question['response']
submission_time_with_tz = latest_response['submissionTime']
submission_time_with_tz['tzinfo'] = pytz.utc
submission_time = datetime(**submission_time_with_tz)
return submission_time.strftime(self.time_format)
return self.created_at
@property
def parent_project(self):
""" Just return the provenanceId here """
if 'provenanceId' in self.my_map:
return self.my_map['provenanceId']
return None
def get_parent_project(self):
""" Have to run another query based on provenanceId """
# Note that we run this query against ``/results``
# otherwise we have to make 2 requests (one for AssessmentTaken
# and another for the responses). Assuming the cost of
# 2 HTTP requests is worse.
takens = self.get_all_results()
parent_takens = [taken
for taken in takens
if taken['id'] == self.my_map['provenanceId']]
if not parent_takens:
raise KeyError('parent taken not found ...')
parent_taken = parent_takens[0]
return SLNProject(parent_taken)
@property
def remixes(self):
""" returns all children projects """
# Note that we run this query against ``/results``
# otherwise we have to make 2 requests (one for AssessmentTaken
# and another for the responses). Assuming the cost of
# 2 HTTP requests is worse.
takens = self.get_all_results()
remixes = [taken
for taken in takens
if taken['provenanceId'] == self.my_map['id']]
return SLNProjects(remixes)
@property
def is_locked(self):
""" Returns a boolean if the taken is read-only or not,
based on its genusTypeId. read-only === is_locked """
if 'genusTypeId' not in self.my_map:
return False # should only ever happen during testing
return self.my_map['genusTypeId'] == \
settings.READ_ONLY_TAKEN_GENUS_TYPE
@property
def serialize(self):
""" turn into the JSON blob that SLN expects """
return {
'id': self.id,
'title': self.title,
'description': self.description,
'created_at': self.created_at,
'saved_at': self.saved_at,
'parent_project': self.parent_project,
'project_str': self.project_str,
'is_locked': self.is_locked
}
class SLNProjects:
""" List of SLNProject objects """
def __init__(self, object_maps):
# For performance, get results here once and then pass
# that in to each SLNProject object.
self.projects = []
if object_maps:
first_project = SLNProject(object_maps[0])
self.projects = [SLNProject(object_map,
results=first_project.all_results)
for object_map in object_maps]
self.index = 0
def __len__(self):
return len(self.projects)
def next(self):
if self.index == len(self.projects):
raise StopIteration
next_project = self.projects[self.index]
self.index += 1
return next_project
def serialize(self, order_by=None):
if order_by is not None and isinstance(order_by, list):
# Sort by the fields given in the order_by list, i.e.
# ['is_locked', 'saved_at']
# May want to make reverse also configurable...
return [p.serialize for p in sorted(self.projects,
key=attrgetter(*order_by),
reverse=True)]
return [project.serialize for project in self.projects]
class sln_shared:
""" Contains shared helper methods for StarLogoNova endpoints """
def get_or_create_bank(self):
url = '{0}?genusTypeId={1}'.format(settings.QBANK_ASSESSMENT_ENDPOINT,
settings.DEFAULT_BANK_GENUS_TYPE)
req = requests.get(url, verify=False)
banks = req.json()
default_bank = None
if banks:
default_bank = banks[0]
else:
payload = {
'name': 'Default StarLogoNova Assessment Bank',
'description': 'For storing student projects',
'genusTypeId': settings.DEFAULT_BANK_GENUS_TYPE
}
req = requests.post(settings.QBANK_ASSESSMENT_ENDPOINT,
json=payload,
verify=False)
default_bank = req.json()
return default_bank
def get_or_create_item(self, bank_id):
""" In the given bank, find or create a SLN item (extended
text interaction). """
base_url = '{0}/{1}/items'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id)
url = '{0}?genusTypeId={1}'.format(
base_url,
settings.DEFAULT_ITEM_GENUS_TYPE)
req = requests.get(url, verify=False)
items = req.json()
default_item = None
if items:
default_item = items[0]
else:
payload = {
'name': 'Default StarLogoNova Item',
'description': (
'To accept student projects as Taken submissions'
),
'genusTypeId': (
'item-genus-type%3A'
'qti-extended-text-interaction%40ODL.MIT.EDU'
),
'question': {
'genusTypeId': (
'question-type%3A'
'qti-extended-text-interaction%40ODL.MIT.EDU'
),
'questionString': 'Please submit your SLN project'
}
}
req = requests.post(base_url,
json=payload,
verify=False)
default_item = req.json()
return default_item
def get_or_create_assessment(self, bank_id, item_id):
""" In the given bank, find or create a SLN assessment,
and make sure the given item is part of it """
base_url = '{0}/{1}/assessments'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id)
url = '{0}?genusTypeId={1}'.format(
base_url,
settings.DEFAULT_ASSESSMENT_GENUS_TYPE)
req = requests.get(url, verify=False)
assessments = req.json()
default_assessment = None
if assessments:
default_assessment = assessments[0]
# check if the item is part of this assessment
url = '{0}/items'.format(base_url)
req = requests.get(url)
assessment_items = req.json()
current_item_ids = [i['id'] for i in assessment_items]
if current_item_ids or item_id not in current_item_ids:
payload = {
'itemIds': [item_id]
}
requests.post(base_url,
json=payload,
verify=False)
else:
payload = {
'name': 'Default StarLogoNova Assessment',
'description': (
'To accept student projects as Taken submissions'
),
'genusTypeId': settings.DEFAULT_ASSESSMENT_GENUS_TYPE,
'itemIds': [item_id]
}
req = requests.post(base_url,
json=payload,
verify=False)
default_assessment = req.json()
return default_assessment
def get_or_create_assessment_offered(self, bank_id):
""" In the given bank, find or create a SLN item (extended
text interaction), assessment, and assessment offered.
For performance reasons, we'll assume if the offered exists,
we do **NOT** need to create the item / assessment. If the
offered does not exist, we will need to create the item and
assessment. """
base_url = '{0}/{1}/assessmentsoffered'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id)
url = '{0}?genusTypeId={1}'.format(
base_url,
settings.DEFAULT_OFFERED_GENUS_TYPE)
req = requests.get(url, verify=False)
offereds = req.json()
default_offered = None
if offereds:
default_offered = offereds[0]
else:
item = self.get_or_create_item(bank_id)
assessment = self.get_or_create_assessment(bank_id, item['id'])
url = '{0}/{1}/assessments/{2}/assessmentsoffered'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id,
assessment['id']
)
payload = {
'name': 'Default StarLogoNova AssessmentOffered',
'description': (
'To accept student projects as Taken submissions'
),
'genusTypeId': settings.DEFAULT_OFFERED_GENUS_TYPE
}
req = requests.post(url,
json=payload,
verify=False)
default_offered = req.json()
return default_offered
def get_assessment_taken(self, bank_id, taken_id):
""" get the specific taken """
url = '{0}/{1}/assessmentstaken/{2}'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id,
taken_id)
req = requests.get(url, verify=False)
return req.json()
def create_assessment_taken(self, bank_id, offered_id, data):
""" data should be all the editable things for a project:
* title (displayName)
* description (description)
* project_str (the text response)
* user_id (some randomly generated agentId ... probably
sessionId + timestamp)
Note: given how dlkit works, the ``user_id`` is only
set in the AssessmentTaken on create ...
don't expect to be able to track who made
every single save / update to a project.
"""
if 'user_id' not in data:
raise KeyError('user_id required in data')
url = '{0}/{1}/assessmentsoffered/{2}/assessmentstaken'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id,
offered_id)
# ``title``, ``description``, and ``project_str``
# are not sent for new projects
# They might be sent already with remixes?
title = 'StarLogoNova project'
if 'title' in data:
title = data['title']
description = 'Student submitted project'
if 'description' in data:
description = data['description']
if 'project_str' not in data:
data['project_str'] = ''
payload = {
'displayName': title,
'description': description
}
if 'provenanceId' in data:
payload['provenanceId'] = data['provenanceId']
if 'genusTypeId' in data:
payload['genusTypeId'] = data['genusTypeId']
req = requests.post(url,
json=payload,
verify=False,
headers={'x-api-proxy': data['user_id']})
# Now submit the text response
taken = req.json()
self.save_project(bank_id, taken['id'], data)
# Now we need to get the updated taken (with timestamp)
taken = self.get_assessment_taken(bank_id, taken['id'])
return taken
def update_assessment_taken(self, bank_id, taken_id, data):
""" data should be all the editable things for a project:
* title (displayName)
* description (description)
* project_str (the text response)
* user_id (some randomly generated agentId ... probably
sessionId + timestamp)
"""
if 'project_str' not in data:
raise KeyError('project_str required in data')
# reject anything that changes a read-only taken
taken = self.get_assessment_taken(bank_id, taken_id)
if SLNProject(taken).is_locked:
raise AttributeError('Cannot edit this project')
url = '{0}/{1}/assessmentstaken/{2}'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id,
taken_id)
payload = {}
if 'title' in data:
payload['displayName'] = data['title']
if 'description' in data:
payload['description'] = data['description']
if 'title' in data or 'description' in data:
req = requests.put(url,
json=payload,
verify=False)
taken = req.json()
# Re-submit the project_str
self.save_project(bank_id, taken_id, data)
taken = self.get_assessment_taken(bank_id, taken_id)
return taken
def save_project(self, bank_id, taken_id, data):
""" Submits a text string to an existing AssessmentTaken.
Can be used for project creation and also updating.
``data`` is required to have one field:
* project_str
"""
if 'project_str' not in data:
raise KeyError('project_str required in data')
# First, get the question ID
url = '{0}/{1}/assessmentstaken/{2}/questions'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id,
taken_id)
req = requests.get(url,
verify=False)
questions = req.json()
url = '{0}/{1}/submit'.format(url,
questions['data'][0]['id'])
payload = {
'text': data['project_str']
}
req = requests.post(url,
json=payload,
verify=False)
def results_url(self, bank_id, offered_id):
""" helper method to return the results URL """
return '{0}/{1}/assessmentsoffered/{2}/results'.format(
settings.QBANK_ASSESSMENT_ENDPOINT,
bank_id,
offered_id
)