-
Notifications
You must be signed in to change notification settings - Fork 1
/
edsby.py
1045 lines (933 loc) · 51.1 KB
/
edsby.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
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
import requests, json
from past.builtins import basestring
from copy import deepcopy
"""
Edsby.py: An API wrapper/library for Python - v0.7.1
https://github.com/ctrezevant/PyEdsby/
(c) 2017 Charlton Trezevant - www.ctis.me
MIT License
This code is well documented. You can find supplementary
documentation, as well as the documentation included here
in the PyEdsby wiki: https://github.com/ctrezevant/PyEdsby/wiki
The Edsby trademark and brand are property of CoreFour, Inc.
This software is unofficial and not supported by CoreFour in any way.
"""
class Edsby(object):
def __init__(self, **kwargs):
self.edsbyHost = kwargs['host']
if 'headers' in kwargs:
self.globalHeaders = kwargs['headers']
else:
self.globalHeaders = {
'user-agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0 Safari/601.1',
'referer': 'https://'+self.edsbyHost+'/',
'accept': '*/*',
'accept-language':'en-US,en',
'dnt': '1',
'x-requested-with':'XMLHttpRequest'
}
# You can also pass instance metadata, if you want to create PyEdsby instances a little faster.
# All the class really needs is a dict with the nid property set, so you can pass something like
# {'nid': 'your nid'} and not break anything.
if 'meta' in kwargs:
self.instanceMeta = kwargs['meta']
else:
self.instanceMeta = self.parseInstanceMetadata()
# You can pass a Session instance you've already made to PyEdsby, if you don't want it to create its own.
# Note that we only use sessions to keep track of cookies, so if you also want to use custom headers make sure
# that you pass those in.
if 'session' in kwargs:
self.session = kwargs['session']
else:
self.session = self.getSession()
# You can also pass the constructor your credentials, if you'd rather not call the login method.
if 'username' in kwargs and 'password' in kwargs:
self.login(username=kwargs['username'], password=kwargs['password'])
"""
Authenticates the session and retrieves instance and student metadata
"""
def login(self, **kwargs):
self.authData = self.getauthData((kwargs['username'], kwargs['password']))
self.studentData = self.sendAuthenticationData()
return True
"""
Overwrites the session and clears all authentication keys/student metadata,
which deauthenticates your session (effectively logging you out).
"""
def logout(self):
self.endSession()
self.clearStudentData()
return True
"""
Allows headers to be changed after instantiation (for imitating a mobile device, for example)
"""
def setHeaders(self, headers):
self.globalHeaders = headers
"""
Returns the HTTP headers currently in use for all API calls
"""
def getHeaders(self):
return self.globalHeaders
"""
Allows cookies to be manually set or modified (initially set automatically by
the getSession method)
You can either pass a dict or a cookiejar. If you pass a dict, then the method will automatically
convert it into the cookiejar format.
"""
def setCookies(self, cookies):
if isinstance(cookies, dict):
cookies = requests.utils.cookiejar_from_dict(cookies)
self.session.cookies = cookies
"""
Allows retrieval of cookies currently in use for all API calls
"""
def getCookies(self):
return self.session.cookies.get_dict()
"""
May be used to retrieve student metadata (nid, unid, name, and so on)
"""
def getStudentData(self):
return self.studentData
"""
This method overwrites all internally held student data.
"""
def clearStudentData(self):
self.authData = None
self.studentData = None
return True
"""
Can be used to modify the internally held student metadata
"""
def setStudentData(self, studentData):
self.studentData = studentData
"""
This begins a session, retrieving cookies that we'll use later. Don't call this if you've already called
login, as it will overwrite the cookies.
"""
def getSession(self):
return requests.Session().get('https://'+self.edsbyHost+"/core/login/"+str(self.instanceMeta['nid'])+"?xds=loginform&editable=true",headers=self.getHeaders())
"""
This method overwrites the current session, which effectively logs the user out.
"""
def endSession(self):
self.session = self.getSession()
"""
Scrapes the InstanceMeta dict from your Edsby instance.
"""
def parseInstanceMetadata(self):
rawPage = requests.get('https://'+self.edsbyHost,headers=self.getHeaders()).text
meta = rawPage[rawPage.find('openSesame(')+12:] # Cut out all parts of webpage before openSesame call.
meta = meta[:meta.find('}')].split(',') # cut out everything after the openSesame call that isn't a part of the metadata we want
# Metadata's now a string, but we aren't ready to return it just yet. We need to convert it from an array of
# conjoined key:value pairs (e.g. "base:'BasePublic'") into a format we can use.
metaTuples = list()
for prop in meta: # for every entry in our array of conjoined k:vs:
key = prop[0:prop.find(":")].strip() # Cut only the property out ([base]:'BasePublic')
value = prop[len(key)+1:-1].replace("'", "") # Cut out the value (base:['BasePublic']), remove leftover 's
metaTuples.append((key, value)) # Build our array of (key, value) tuples
# Convert the tuple array into a dict, and return it.
# For more on the theory behind this, have a look at https://docs.python.org/2/tutorial/datastructures.html#tut-listcomps
return dict(metaTuples)
"""
Returns a dict of useful metadata about your Edsby instance.
This is required, as we'll need the instance NID to authenticate the user.
{
nid: instance NID,
uid: instance NID,
version: 17431,
base: 'BasePublic',
compiled: 1492092324,
app: 'us2',
system: 'us2'
}
"""
def getInstanceMetadata(self):
return self.instanceMeta
"""
Retrieves a variety of authentication data from Edsby (server nonces, keys, etc)
Which are then used by sendAuthenticationData to complete user authentication.
"""
def getauthData(self, loginData):
self.authData = requests.get('https://'+self.edsbyHost+"/core/node.json/"+str(self.instanceMeta['nid'])+"?xds=fetchcryptdata&type=Plaintext-LeapLDAP",cookies=self.getCookies(),headers=self.getHeaders()).json()["slices"][0]
return {
'_formkey': self.authData["_formkey"],
'sauthdata': self.authData['data']["sauthdata"],
'crypttype': 'LeapLDAP',
'login-userid': loginData[0],
'login-password': loginData[1],
'login-host': self.edsbyHost,
'remember': 1
}
"""
This is the final step in the authentication process, which completes user login and returns
student metadata returned by Edsby
"""
def sendAuthenticationData(self):
studentData = requests.post('https://'+self.edsbyHost+'/core/login/'+str(self.instanceMeta['nid'])+'?xds=loginform&editable=true',data=self.authData,cookies=self.getCookies(),headers=self.getHeaders()).json()
if 'error' in studentData:
raise LoginError(studentData['errorstr'])
return {
'unid': studentData['unid'],
'compiled': studentData['compiled'],
'nid': studentData['slices'][0]['nid'],
'name': studentData['slices'][0]['data']['name'],
'guid' : studentData['slices'][0]['data']['guid'],
'formkey' : studentData['slices'][0]['data']['formkey']
}
"""
In a browser, this API call would bootstrap the web app. Here, however, we need only
call it update our session state from Edsby's point of view. This has a lot of UI related metadata,
though I haven't explored it in detail.
"""
def getBootstrapData(self):
return requests.get('https://'+self.edsbyHost+'/core/node.json/?xds=bootstrap',cookies=self.getCookies(),headers=self.getHeaders()).json()
"""
This returns a wealth of metadata about the student as a whole,
including classes. This is yet another thing I haven't explored in great detail.
"""
def getBaseStudentData(self):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['unid'])+'?xds=BaseStudent',cookies=self.getCookies(),headers=self.getHeaders()).json()
"""
Returns personal information about the student, including their full name,
phone number, address, and registered parents.
"""
def getStudentPersonalInfo(self):
personalInfo = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['unid'])+'?xds=editPersonalInformation',cookies=self.getCookies(),headers=self.getHeaders()).json()["slices"][0]
return personalInfo['data'] if 'data' in personalInfo else ''
"""
Returns the currently active account settings for the user.
"""
def getAccountSettings(self):
userSettings = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['unid'])+'?xds=editSettings',cookies=self.getCookies(),headers=self.getHeaders()).json()["slices"][0]
return userSettings['data'] if 'data' in userSettings else ''
"""
Returns raw class data for only the current set of enrolled classes, which looks like:
"r<class RID>": {
"nodetype": 3,
"reltype": 4,
"parentsAllowed": 3,
"nid": <class NID>,
"nodesubtype": 2,
"teacherNid": <teacher NID>,
"fraction": "3/8",
"rid": <class RID>,
"class": {
"data": {
"ShowAverage": "0"
},
"details": {
"info": {
"code": "<school course code>",
"teachernid": <teacher NID>,
"param": "<teacher Name>"
},
"course": "<human readable course name>",
"new": {
"messages": 0,
"results": 0
}
},
"ShowAverage": "0"
},
"studentLock": 2
},
"""
def getRawCurrentClassData(self):
return self.getBaseStudentData()['slices'][0]['data']['col1']['classes']['classesContainer']['classes']
"""
Returns a parsed list of only the classes you're currently enrolled in.
The dict returned appears like so:
"<class NID>": {
"human_name": "<human readable class name>",
"rid": <class RID>,
"course_code": <course code>,
"teacher": {
"name": "<teacher name>",
"nid": '<teacher NID>'
}
"""
def getCurrentClasses(self):
rawCurrentClasses = self.getRawCurrentClassData()
currentClasses = dict()
for className in rawCurrentClasses:
NID = rawCurrentClasses[className]['nid']
humanName = rawCurrentClasses[className]['class']['details']['course']
RID = rawCurrentClasses[className]['rid']
courseCode = rawCurrentClasses[className]['class']['details']['info']['teachernid']
currentClasses[NID] = dict()
currentClasses[NID]['human_name'] = humanName
currentClasses[NID]['rid'] = RID
currentClasses[NID]['course_code'] = courseCode
teacherName = rawCurrentClasses[className]['class']['details']['info']['param']
teacherNID = rawCurrentClasses[className]['class']['details']['info']['teachernid']
currentClasses[NID]['teacher'] = dict()
currentClasses[NID]['teacher']['name'] = teacherName
currentClasses[NID]['teacher']['nid'] = teacherNID
return currentClasses
"""
Returns a list of NIDs for the classes you are currently enrolled in.
"""
def getCurrentClassNIDList(self):
classNIDs = list()
for NID in self.getCurrentClasses():
classNIDs.append(NID)
return classNIDs
"""
Returns raw class data for the current and historical set of classes you're enrolled in, which looks like:
"r<course RID>": {
"nodetype": 3,
"Title": "<human readable name>",
"reltype": 12,
"value": someValue,
"nodesubtype": 2,
"course": {
"class": {
"text": {
"line2": {
"code": "<course code>",
"name": "<teacher name>"
},
"line1": "<human readable name>"
}
},
"basic": {
"text": {
"line1": "<course code>"
}
}
},
"nid": <course NID>,
"rid": <course RID>
}
"""
def getRawClassData(self):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['nid'])+'?xds=ClassPicker&match=multi',cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['class']
"""
Returns a parsed list of all available classes, both current and previous.
The dict returned appears like so:
"<class NID>": {
"human_name": "<human readable class name>",
"rid": <class RID>,
"course_code": <course code>,
"teacher": {
"name": "<teacher name>",
"nid": '<will always be None when using this method (see below)>'
}
"""
def getAllClasses(self):
rawClassData = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['nid'])+'?xds=ClassPicker&match=multi',cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['class']
classDict = dict()
for className in rawClassData:
NID = rawClassData[className]['nid']
humanName = rawClassData[className]['course']['class']['text']['line1']
RID = rawClassData[className]['rid']
courseCode = rawClassData[className]['course']['class']['text']['line2']['code']
classDict[NID] = dict()
classDict[NID]['human_name'] = humanName
classDict[NID]['rid'] = RID
classDict[NID]['course_code'] = courseCode
classDict[NID]['teacher'] = dict()
classDict[NID]['teacher']['name'] = rawClassData[className]['course']['class']['text']['line2']['name']
# This endpoint does not return NID information for teachers, so we'll set this to None (e.g. null). If you need to
# Retrieve this data, try using the lookUpMessageRecipient method, or alternatively call getCurrentClasses.
classDict[NID]['teacher']['nid'] = None
return classDict
"""
getClassIDList has been renamed to getAllClasses. This shim provides backwards compatibility
for an otherwise breaking change.
"""
def getClassIDList(self):
return self.getAllClasses()
"""
Returns a list of NIDs for all available classes, both current and previous.
"""
def getAllClassNIDList(self):
classNIDs = list()
for NID in self.getAllClasses():
classNIDs.append(NID)
return classNIDs
"""
Retrieves the list of all classes you've historically been enrolled in, and
removes all the classes that you're currently enrolled in.
"""
def getPastClasses(self):
currentClasses = self.getCurrentClassNIDList()
allClasses = self.getAllClasses()
for classNID in allClasses:
if classNID in currentClasses:
del allClasses[classNID]
return allClasses
"""
Returns a list of NIDs for the classes you were previously enrolled in.
"""
def getPastClassNIDList(self):
classNIDs = list()
for NID in self.getPastClasses():
classNIDs.append(NID)
return classNIDs
"""
Returns your current average for the given class NID (e.g. 97.4)
"""
def getClassAverage(self, classNID):
classData = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'?xds=MyWork&student='+str(self.studentData['unid']),cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']
if 'loaddata' in classData and 'average' in classData['loaddata']:
return classData['loaddata']['average']
else:
return ''
"""
Retrieves all available averages for the classes you're currently enrolled in.
Adds a new property, 'average', to the class dicts returned by the getCurrentClasses() method.
"""
def getCurrentClassAverages(self):
classes = self.getCurrentClasses()
for key in classes:
classes[key]['average'] = self.getClassAverage(key)
return classes
"""
Retrieves all available averages for the classes you're currently enrolled in.
Adds a new property, 'average', to the class dicts returned by the getAllClasses() method.
"""
def getAllClassAverages(self):
classes = self.getAllClasses()
for key in classes:
classes[key]['average'] = self.getClassAverage(key)
return classes
"""
Returns an object containing all assignment metadata for a specified course, ordered by RID
This includes the NID, RID, and weighting (points possible) of the assignments, but not your score.
"""
def getClassAssignmentMetadata(self, classNID):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'?xds=MyWork&student='+str(self.studentData['unid']),cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['loaddata']['gradebook']['terms']
"""
Returns an object containing all assignment scores for a specified course, ordered by NID
This includes the NID and points earned on the assignment, but nothing else.
"""
def getClassAssignmentScores(self, classNID, classRID):
assignments = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'/?xds=MyWork&unit=all&student='+str(self.studentData['unid']),cookies=self.getCookies(),headers=self.getHeaders()).json()["slices"][0]["data"]["loaddata"]["grades"]
return assignments
"""
Returns an object containing all assignment scores for a specified course, ordered by NID
This includes the NID and points earned on the assignment, but nothing else.
This is different from getClassAssignmentScores in that it does not return all scores, and does so in a mixed
format where score might be a letter grade, or it could be a JSON string that we have to parse into a string
before reading. getClassAssignmentList can handle and process data returned from both of these endpoints
"""
def getMixedFormatClassAssignmentScores(self, classNID, classRID):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'/'+str(classRID)+'/'+str(classNID)+'?xds=MyWorkChart&student='+str(self.studentData['unid']),cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['loaddata']['grades']
"""
Returns an array of NIDs for assignments that have been published (e.g. are visible) for a
given course
"""
def getClassPublishedAssignments(self, classNID, classRID):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'/'+str(classRID)+'/'+str(classNID)+'?xds=MyWorkChart&student='+str(self.studentData['unid']),cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['bubbles']['publishedAssessments'].split(',')
"""
Gathers all available, published assignment data from a specified class, and computes scores for each. Returns an object
with all available data about the assignments (including a computed percentage), ordered by NID.
"<NID>": {
"sdate": "<guess: share date(?)>",
"graded": <1 or 0, whether assignment was graded>,
"weighting": <maximum possible points for assignment or something that makes no sense>,
"rid": <assignment RID>,
"state": "0", <- dunno what this is for
"score": <number of points earned on an assignment>,
"noavg": false, <whether or not the score was averaged?>
"scheme": "gs_outof", <maybe if assignments are points possible/max score?>
"type": "0", <- dunno what this is for
"columns": <maximum possible points for assignment float or dict for multi-part assignment>
"fraction": "number/1", <- dunno what this is for. number looks like an NID(?)
"summative": "1", <- dunno what this is for
"nid": <assignment NID>,
"cdate": "<guess: created date(?)>",
"date": "<guess: date grade was entered(?)>",
"esubmit": <0 or 1, guess: whether assignment was electronically submitted(?)>,
"nodetype": 6, <- dunno what this is for
"name": "<human name>",
"thread": <same as NID>,
"nodesubtype": 3, <- dunno what this is for
"scorePercentage": <computed score percentage>,
"published": "<1 or 0: true or false if assignment was published>"
}
"""
def getClassAssignmentList(self, classNID, classRID):
scores = self.getClassAssignmentScores(classNID, classRID) # Fetch assignment scores
metadata = self.getClassAssignmentMetadata(classNID) # Fetch assignment metadata
assignmentData = {
'assignments': dict(), # Assignments that have all applicable metadata present
'no_scores_found': dict(), # Assignments that we haven't found scores for
'no_weights_found': list(), # Assignments we haven't found weights for
'no_columns_found': list(), # Assignments we haven't found columns for
'invalid_weighting': list(), # Assignments that have invalid weighting
'invalid_columns': list() # Assignments that have invalid columns
}
for nid in scores: # Populates assignmentData with NIDs and available assignment scores
if 'cols' in scores[nid]:
assignmentData['assignments'][nid] = {'score': scores[nid]['cols']['0']} if '0' in scores[nid]['cols'] else {'score': scores[nid]['cols']}
# Copy all available assignment metadata to assignmentData dict
for assg in metadata:
assignmentNID = str(metadata[assg]['nid'])
# Copy other keys from metadata obj to compiled assignment data obj
for key in metadata['r'+str(metadata[assg]['rid'])]:
if assignmentNID in assignmentData['assignments']: # If we've found metadata for an asssignment that we've also found scores for
assignmentData['assignments'][assignmentNID][key] = metadata[assg][key] # Copy metadata to that entry
else:
assignmentData['no_scores_found'][assignmentNID] = dict() # Otherwise, place this metadata in the no_scores_found dict
for meta in metadata[assg]:
assignmentData['no_scores_found'][assignmentNID][meta] = metadata[assg][meta]
# Copy weighting data, sort assignments without it, calculate percentage scores if possible
deepcopy_assignmentData = deepcopy(assignmentData)
for assg in deepcopy_assignmentData['assignments']:
assignmentNID = str(assg)
if 'scheme' not in assignmentData['assignments'][assg]:
del assignmentData['assignments'][assg]
continue
if 'weighting' in assignmentData['assignments'][assg]: # If weighting data is present in the metadata we retrieved
# API sometimes returns a dict, other times returns a JSON string. Figure out which one it is and parse appropriately.
if isinstance(assignmentData['assignments'][assg]['weighting'], dict): # If dict access weighting prop as a dict
if '0' in assignmentData['assignments'][assg]['weighting'] and not isinstance(assignmentData['assignments'][assg]['score'], dict):
assignmentData['assignments'][assignmentNID]['weighting'] = assignmentData['assignments'][assg]['weighting']['0']
elif len(assignmentData['assignments'][assg]['weighting']) is not len(assignmentData['assignments'][assg]['score']):
assignmentData['invalid_weighting'].append(assignmentNID)
else:
assignmentData['assignments'][assignmentNID]['weighting'] = assignmentData['assignments'][assg]['weighting']
elif isinstance(assignmentData['assignments'][assg]['weighting'], basestring): # If string access weighting prop as a dict after running through a JSON parser
weighting_dict = json.loads(assignmentData['assignments'][assg]['weighting'])
if '0' in weighting_dict and not isinstance(assignmentData['assignments'][assg]['score'], dict):
assignmentData['assignments'][assignmentNID]['weighting'] = json.loads(assignmentData['assignments'][assg]['weighting'])['0']
elif len(weighting_dict) is not len(assignmentData['assignments'][assg]['score']):
assignmentData['invalid_weighting'].append(assignmentNID)
else:
assignmentData['assignments'][assignmentNID]['weighting'] = weighting_dict
else:
assignmentData['no_weights_found'].append(assignmentNID) # No weighting data available for this entry, file it away
if 'columns' in assignmentData['assignments'][assg]: # If columns data is present in the metadata we retrieved
# API sometimes returns a dict, other times returns a JSON string. Figure out which one it is and parse appropriately.
if isinstance(assignmentData['assignments'][assg]['columns'], dict): # If dict access columns prop as a dict
if '0' in assignmentData['assignments'][assg]['columns'] and not isinstance(assignmentData['assignments'][assg]['score'], dict):
assignmentData['assignments'][assignmentNID]['columns'] = assignmentData['assignments'][assg]['columns']['0']
elif len(assignmentData['assignments'][assg]['columns']) is not len(assignmentData['assignments'][assg]['score']):
assignmentData['invalid_columns'].append(assignmentNID)
else:
assignmentData['assignments'][assignmentNID]['columns'] = assignmentData['assignments'][assg]['columns']
elif not isinstance(assignmentData['assignments'][assg]['columns'], dict) and assignmentData['assignments'][assg]['scheme'] != 'gs_4levelplusminus': # If string access columns prop as a dict after running through a JSON parser
columns_dict = json.loads(assignmentData['assignments'][assg]['columns'])
if '0' in columns_dict and not isinstance(assignmentData['assignments'][assg]['score'], dict):
assignmentData['assignments'][assignmentNID]['columns'] = json.loads(assignmentData['assignments'][assg]['columns'])['0']
elif len(columns_dict) is not len(assignmentData['assignments'][assg]['score']):
assignmentData['invalid_columns'].append(assignmentNID)
else:
assignmentData['assignments'][assignmentNID]['columns'] = columns_dict
else:
assignmentData['no_columns_found'].append(assignmentNID) # No columns data available for this entry, file it away
# Calculate score percentage for assignment
if 'columns' in assignmentData['assignments'][assg]: # If valid weighting data is present
if isinstance(assignmentData['assignments'][assg]['score'], (basestring, dict)) is False and 'columns' in assignmentData['assignments'][assg]: # If the score is NOT a letter grade or a multi-part grade (e.g. is numeric), calculate percentage score.
assignmentData['assignments'][assg]['scorePercentage'] = (float(assignmentData['assignments'][assg]['score'])/float(assignmentData['assignments'][assg]['columns'])) * 100
elif isinstance(assignmentData['assignments'][assg]['score'], dict):
if isinstance(assignmentData['assignments'][assg]['columns'], dict):
assignmentData['assignments'][assg]['scorePercentage'] = {}
for scoreType in assignmentData['assignments'][assg]['score'].keys():
if scoreType in assignmentData['assignments'][assg]['columns']:
assignmentData['assignments'][assg]['scorePercentage'][scoreType] = (float(assignmentData['assignments'][assg]['score'][scoreType])/float(assignmentData['assignments'][assg]['columns'][scoreType])) * 100
return assignmentData
"""
Returns a dict with a basic summary of assignments and their grades for a
given course (e.g "human name": "percentage")
"""
def getHumanReadableAssignmentSummary(self, classNID, classRID):
assignments = self.getClassAssignmentList(classNID, classRID)
humanList = dict()
for key in assignments['assignments']:
if 'scorePercentage' in assignments['assignments'][key]:
humanList[assignments['assignments'][key]['name']] = assignments['assignments'][key]['scorePercentage']
else:
humanList[assignments['assignments'][key]['name']] = assignments['assignments'][key]['score'].upper()
return humanList
"""
Retrieves raw, unformatted attendance records from the specified class. I haven't tried to
parse these yet.
"""
def getRawClassAttendenceRecords(self, classID):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classID)+'?xds=MyWorkChart&student='+str(self.studentData['unid']),cookies=self.getCookies(),headers=self.getHeaders()).json()['data']['chartContainer']['chart']['attendanceRecords']['data']['right']['records']['incident']
"""
Returns a list of all member students of a class
Say hi to your classmates!
"""
def getClassmates(self, classNID):
classMates = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'?xds=ClassStudentList',cookies=self.getCookies(),headers=self.getHeaders()).json()
if 'slices' in classMates: # Make sure we got a valid response from the API.
if 'places' in classMates['slices'][0]['data'] and 'item' in classMates['slices'][0]['data']['places']:
return classMates['slices'][0]['data']['places']['item']
else:
return ''
"""
This function calls getCurrentClasses and adds all available roster information
from each class to it.
This is useful if you want roster information for only the current classes you're enrolled in.
"""
def getCurrentClassRosters(self):
rosterData = self.getCurrentClasses()
for NID in rosterData:
rosterData[NID]['classmates'] = self.getClassmates(NID)
return rosterData
"""
This function calls getAllClasses and adds all available roster information
from each class to it.
This is useful if you want historical roster information for ALL classes you've been enrolled in this year.
"""
def getAllClassRosters(self):
rosterData = self.getAllClasses()
for NID in rosterData:
rosterData[NID]['classmates'] = self.getClassmates(NID)
return rosterData
"""
Retrieves the feed of all assignments and messages posted in the feed of a given class NID.
"""
def getClassFeed(self, classNID):
feed = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'?xds=CourseFeed',cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']
return feed if 'item' in feed else ''
"""
Course calendar- returns calendar entries for the specified course
"""
def getClassCalendar(self, classNID):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'?xds=CalendarPanel_Class',cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']
"""
Course assignment outline, shows upcoming and historical assignments for the course
"""
def getClassPlan(self, classNID):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(classNID)+'?xds=Course&_context=1',cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['col1']['outline']['plan']['tree']
"""
Retrieves all current/pending notifications for the student
"""
def getStudentNotifications(self):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['unid'])+'?xds=notifications',cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']
"""
Returns all available calendar data (due/overdue assignments, events, schedules)
"""
def getCalendarData(self):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['unid'])+'?xds=Calendar',cookies=self.getCookies(),headers=self.getHeaders()).json()["slices"][0]["data"]["caldata"]
"""
Get calendar entries for all upcoming due assignments
"""
def getCalendarDueAssignments(self):
return self.getCalendarData()['due']
"""
Get calendar entries for currently overdue assignments
"""
def getCalendarOverdueAssignments(self):
return self.getCalendarData()['overdue']
"""
Get all available calendar events
"""
def getCalendarEvents(self):
calendar = self.getCalendarData()
for key in calendar['common'].keys:
calendar['common'][str(key)] = calendar['events'][str(key)]
return calendar['common']
"""
Returns calendar entries containing school scheduling information
"""
def getCalendarSchedules(self):
return self.getCalendarData()['schedules']
"""
Returns ALL direct Edsby messages from your inbox
"""
def getDirectMessages(self):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['unid'])+'?xds=Messages&_context=1',cookies=self.getCookies(),headers=self.getHeaders()).json()["slices"][0]["data"]["body"]["left"]["items"]["item"]
"""
Sends a direct message to a specified user
the message dict passed to this method should be structured like so:
{
'nodetype': 4.0,
'to': NID of user,
'body': message text,
'media-fill-include-integrations-integrationfiledata': file data(?),
'media-fill-include-integrations-integrationfiles': more file data?
}
"""
def sendDirectMessage(self, message):
payload = {
'_formkey':self.studentData['formkey'],
'nodetype': message['nodetype'],
'body': message['text'],
'media-fill-include-integrations-integrationfiledata': message['filedata'],
'media-fill-include-integrations-integrationfiles': message['files']
}
return requests.post('https://'+self.edsbyHost+'/core/create/'+str(message['to'])+'?xds=MessagesCompose&permaLinkKey=false&_processed=true',data=payload,cookies=self.getCookies(),headers=self.getHeaders()).json()
"""
Allows you to search for any higher level user (teacher, administrator)
whose name matches or contains a particular string
"""
def lookUpMessageRecipient(self, query):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['unid'])+'?xds=msgUserPicker&pattern='+query+'&noForm=true',cookies=self.getCookies(),headers=self.getHeaders()).json()["slices"][0]["data"]["item"]
"""
Edsby has a built-in website metadata scraper, which it uses to retrieve
various information about links before they're sent off.
{
"type": "link",
"code": 200,
"embedstatus": "complete",
"href": "<website URL>",
"thumbnail": "<website thumbnail>",
"title": "<website title>",
"description": "<meta description of website>"
}
"""
def scrapeURLMetadata(self, classNID, url):
return requests.get('https://'+self.edsbyHost+'/load/embed.json/'+str(classNID)+'?xds=bookMarkPreview&scrape='+requests.utils.quote(url),cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']
"""
Formats the website metadata from the site scraper, preparing it to be included in a message dict.
This dict should become the value of the url property for your message dict (which maps to the
social-shmart-url prop in the Edsby API call)
"""
def formatURLMetadata(self, metadata):
return {
"url": metadata['href'],
"type": metadata['type'],
"code": metadata['code'],
"embedstatus": metadata['embedstatus'],
"href": metadata['href'],
"thumbnail": metadata['thumbnail'] if 'thumbnail' in metadata else '',
"title": metadata['title'] if 'title' in metadata else '',
"description": metadata['description'] if 'description' in metadata else '',
"uuid": 6,
"left": {
"thumbnail": metadata['thumbnail'] if 'thumbnail' in metadata else ''
},
"right": {
"title": metadata['title'] if 'title' in metadata else '',
"description": metadata['description'] if 'description' in metadata else ''
}
}
"""
Edsby expects the URL metadata passed in the message dict to be a string, so this method
retrieves the correct metadata, converts the dict to the proper format, and then returns
the formatted dict as a string.
"""
def getFormattedURLMetadataString(self, classNID, url):
metadata = self.scrapeURLMetadata(classNID, url)
return json.dumps(self.formatURLMetadata(metadata))
"""
Posts a message in the class feed. This takes a dict called message, which looks like this:
{
'text': '<the message text>',
'url': '<an optional URL, shows up as a hyperlink in Edsby>',
'pin': 8,
'nodetype': 4,
'node_subtype': 0,
'filedata': '',
'files': '',
}
"""
def postMessageInClassFeed(self, classNID, message):
messageSubmission = {
'_formkey': self.studentData['formkey'],
'social-pin': message['pin'], # 8
'social-shmart-nodetype': message['nodetype'], # 4
'social-shmart-nodesubtype': message['node_subtype'], # 0
'social-shmart-body': message['text'],
'social-shmart-url': message['url'],
'social-shmart-file-integrations-integrationfiledata': message['filedata'],
'social-shmart-file-integrations-integrationfiles': message['files']
}
return requests.post('https://'+self.edsbyHost+'/core/create/'+str(classNID)+'?xds=CourseFeedMsg&xdsr=CourseFeed&rxdstype=ref&merge=merge',data=messageSubmission,cookies=self.getCookies(),headers=self.getHeaders()).json()['slice']['slices'][0]['data']['item']
"""
Posts a message in the class feed. This takes a dict called message, which looks like this:
{
'text': '<the message text>',
'url': '<an optional URL, shows up as a hyperlink in Edsby>',
'pin': 8,
'filedata': '',
'files': '',
}
"""
def editMessageInClassFeed(self, classNID, feedItemRID, feedItemNID, message):
messageSubmission = {
'_formkey': self.studentData['formkey'],
'social-pin': message['pin'], # 8
'social-shmart-body': message['text'],
'social-shmart-url': message['url'],
'social-shmart-file-integrations-integrationfiledata': message['filedata'],
'social-shmart-file-integrations-integrationfiles': message['files']
}
return requests.post('https://'+self.edsbyHost+'/core/node/'+str(classNID)+'/'+str(feedItemRID)+'/'+str(feedItemNID)+'?xds=feedItemEdit&_i=2',data=messageSubmission,cookies=self.getCookies(),headers=self.getHeaders()).json()
"""
Posts a reply to a message in the class feed. This takes a dict called message, which looks like this:
{
'text': '<the message text>',
'url': '<an optional URL, shows up as a hyperlink in Edsby>',
'pin': 8,
'nodetype': 4,
'node_subtype': 23,
'filedata': '',
'files': '',
'parent_nid': <parent feed item NID>,
'parent_rid': <parent feed item RID>
}
"""
def postReplyInClassFeed(self, classNID, message):
messageSubmission = {
'_formkey': self.studentData['formkey'],
'body-pin': message['pin'], # 8
'body-shmart-nodetype': message['nodetype'], # 4
'body-shmart-nodesubtype': message['node_subtype'], # 23
'body-shmart-body': message['text'],
'body-shmart-url': message['url'],
'body-shmart-file-integrations-integrationfiledata': message['filedata'],
'body-shmart-file-integrations-integrationfiles': message['files'],
'replyTo': '',
'thread': message['parent_nid']
}
return requests.post('https://'+self.edsbyHost+'/core/create/'+str(classNID)+'/'+str(message['parent_rid'])+'/'+str(classNID)+'?xds=feedreply&xdsr=CourseFeed&__delegated=CourseFeed',data=messageSubmission,cookies=self.getCookies(),headers=self.getHeaders()).json()['slice']['slices'][0]['data']['item']
"""
Posts a message with an accompanying file in the class feed. This takes a dict called message,
which looks like this:
{
'text': '<the message text>',
'url': '<an optional URL, shows up as a hyperlink in Edsby>',
'pin': 8,
'nodetype': 4,
'node_subtype': 0,
'filedata': '',
'files': '',
}
TODO - Edsby complains of an invalid key when attempting to upload. Suspect form data formatting in POST.
"""
def postFileInClassFeed(self, classNID, message, fileName, filePath):
messageSubmission = {
'_formkey': self.studentData['formkey'],
'social-pin': message['pin'], # 10
'social-shmart-nodetype': message['nodetype'], # 4
'social-shmart-nodesubtype': message['node_subtype'], # 0
'social-shmart-body': message['text'],
'social-shmart-url': message['url'],
'social-shmart-file-integrations-integrationfiledata': message['filedata'],
'social-shmart-file-integrations-integrationfiles': message['files']
}
postMetadata = requests.post('https://'+self.edsbyHost+'/core/create/'+str(classNID)+'?xds=CourseFeedMsg&xdsr=CourseFeed&rxdstype=ref&merge=merge',data=messageSubmission,cookies=self.getCookies(),headers=self.getHeaders()).json()['slice']['slices'][0]['data']['item']
parentRID = next(iter(postMetadata))
cookies = self.session.cookies.get_dict()
uploadData = {
'name': fileName,
'nodetype': '5.0',
'pin': '2',
'_formkey': self.studentData['formkey'],
}
for key in cookies:
uploadData[key] = cookies[key]
uploadData['files'] = (fileName, open(filePath, 'rb'))
return requests.post('https://'+self.edsbyHost+'/core/create/'+str(classNID)+'/'+str(postMetadata[parentRID]['rid'])+'/'+str(postMetadata[parentRID]['nid'])+'?xds=MultiFileUploader',files=uploadData,cookies=self.getCookies(),headers=self.getHeaders()).json()
"""
Likes an item in the feed for a class
"""
def likeItemInFeed(self, classNID, feedItemNID, feedItemRID):
likeData = {
'likes': 1,
'_formkey': self.studentData['formkey']
}
return requests.post('https://'+self.edsbyHost+'/core/node/'+str(classNID)+'/'+str(feedItemRID)+'/'+str(feedItemNID)+'?xds=doLike',data=likeData,cookies=self.getCookies(),headers=self.getHeaders()).json()
"""
Unlikes an item in the feed for a class
"""
def unlikeItemInFeed(self, classNID, feedItemNID, feedItemRID):
likeData = {
'likes': None,
'_formkey': self.studentData['formkey']
}
return requests.post('https://'+self.edsbyHost+'/core/node/'+str(classNID)+'/'+str(feedItemRID)+'/'+str(feedItemNID)+'?xds=doLike',data=likeData,cookies=self.getCookies(),headers=self.getHeaders()).json()
"""
Retrieves metadata about files attached to feed items, should they be present
If Edsby complains, call getClassFeed before using this function
"""
def getAttachmentMetadata(self, feedItemNID, attachmentNID):
return requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(feedItemNID)+'/'+str(attachmentNID)+'?xds=AlbumFileView',cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['item']
"""
Generates the URL to download a particular file from Edsby, as such URLs are long and verbose.
Helper function to downloadAttachment. Useful if you want to handle file downloading in another
application (If you do, make sure you also take the session cookies with you).
"""
def getAttachmentDownloadURL(self, classNID, feedItemNID, feedItemRID, attachmentNID):
return 'https://'+self.edsbyHost+'/core/nodedl/classNID/'+str(feedItemRID)+'/'+str(feedItemNID)+'/'+str(feedItemRID)+'/'+str(attachmentNID)+'?field=file&attach=1&xds=fileThumbnail'
"""
Downloads an attachment from Edsby to the specified local path.
You could, for example, check a courses' feed at a regular interval, and then download
any new files attached to new posts.
"""
def downloadAttachment(self, classNID, feedItemNID, feedItemRID, attachmentNID, filePath):
self.getClassFeed(classNID) # Must call these before attempting to download, otherwise API denies access
self.getAttachmentMetadata(feedItemNID, feedItemRID) # Another prerequisite call
attachment = requests.get(self.getAttachmentDownloadURL(classNID, feedItemNID, feedItemRID, attachmentNID),cookies=self.getCookies(),headers=self.getHeaders(),stream=True)
with open(filePath, 'wb') as localFile:
for attachmentPart in attachment.iter_content(chunk_size=1024):
if attachmentPart:
localFile.write(attachmentPart)
return filePath
"""
Retrieves the 'Edsby River' of school news available to the current user.
"""
def getScrollingNews(self):
news = requests.get('https://'+self.edsbyHost+'/core/node.json/'+str(self.studentData['nid'])+'?xds=scrollingNews',cookies=self.getCookies(),headers=self.getHeaders()).json()
return news if 'item' in news['slices'][0]['data']['boxLayout']['newsbox'] else ''
"""
Retrieves the 'Recent Activity' section of the main Edsby page.
"""
def getBaseActivity(self, spage=0):
nids = [self.studentData['nid']]
nids.extend(self.getCurrentClassNIDList())
nids = '.'.join(str(e) for e in nids)
activity = requests.get('https://'+self.edsbyHost+'/core/multinode.json/'+nids+'?xds=BaseActivity&combine=true&spage='+str(spage),cookies=self.getCookies(),headers=self.getHeaders()).json()['slices'][0]['data']['messages']
return activity if 'item' in activity else ''
"""
Returns a dict of dicts containing groups the user is a part of in this format:
'r<group RID>': {
'summary': {
'about': {
'type': 1,
'name': "<group name>"
},
'name': "<group name>",
'info': {
'nposts': <number of posts>',
'nmembers': <number of members>
}
},
'nid': <group NID>,
'rid': <group RID>,