forked from WikiEducationFoundation/WikiEduDashboard
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.js
More file actions
737 lines (667 loc) · 20.5 KB
/
api.js
File metadata and controls
737 lines (667 loc) · 20.5 KB
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
import { capitalize } from './strings';
import logErrorMessage from './log_error_message';
import request from './request';
import { stringify } from 'query-string';
import Rails from '@rails/ujs';
import { toWikiDomain } from './wiki_utils';
import { formatCategoryName } from '../components/util/scoping_methods';
const SentryLogger = {};
/* eslint-disable */
const API = {
// /////////
// Getters /
// /////////
fetchFeedback(articleTitle, assignmentId) {
return request(`/revision_feedback.json?title=${articleTitle}&assignment_id=${assignmentId}`)
.then(res => {
if (res.ok) {
return res.json();
}
else {
return Promise.reject({ statusText: res.statusText });
}
})
.catch(error => {
logErrorMessage(error);
return Promise.reject({ error });
});
},
postFeedbackFormResponse(subject, body) {
return request(`/feedback_form_responses`, {
method: 'POST',
body: JSON.stringify({ feedback_form_response: { subject: subject, body: body } }),
})
.then(res => {
if (res.ok) {
return Promise.resolve({ statusText: res.statusText });
}
else {
return Promise.reject({ statusText: res.statusText });
}
})
.catch(error => {
logErrorMessage(error);
return Promise.reject({ error });
});
},
async createCustomFeedback(assignmentId, text, userId) {
const response = await request(`/assignments/${assignmentId}/assignment_suggestions`, {
method: 'POST',
body: JSON.stringify({ feedback: { text: text, assignment_id: assignmentId, user_id: userId } })
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async destroyCustomFeedback(assignmentId, id) {
const response = await request(`/assignments/${assignmentId}/assignment_suggestions/${id}`, {
method: 'DELETE',
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.text();
},
async fetchUserProfileStats(username) {
const response = await request(`/user_stats.json?username=${username}`);
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async updateArticleTrackedStatus(article_id, course_id, tracked) {
const params = {
article_id,course_id, tracked
}
const response = await request(`/articles/status.json?${stringify(params)}`, {
method: 'POST'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async fetchArticleDetails(articleId, courseId) {
const response = await request(`/articles/details.json?article_id=${articleId}&course_id=${courseId}`);
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async fetchRecentUploads(opts = {}) {
const response = await request(`/revision_analytics/recent_uploads.json?scoped=${opts.scoped || false}`);
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async cloneCourse(id, campaign, copyAssignments) {
const campaignQueryParam = campaign ? `?campaign_slug=${campaign}` : ''
const copyAssignmentsQueryParam = copyAssignments ? `?copy_assignments=${copyAssignments}` : '?copy_assignments=false'
const response = await request(`/clone_course/${id}${campaignQueryParam}${copyAssignmentsQueryParam}`, {
method: 'POST'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async fetchUserCourses(userId) {
const response = await request(`/courses_users.json?user_id=${userId}`);
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async deleteAssignment(assignment) {
const queryString = stringify(assignment);
const response = await request(`/assignments/${assignment.id}?${queryString}`, {
method: 'DELETE'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async createAssignment(opts) {
const queryString = stringify(opts);
const response = await request(`/assignments.json?${queryString}`, {
method: 'POST'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async createRandomPeerAssignments(opts) {
const queryString = stringify(opts);
const response = await request(`/assignments/assign_reviewers_randomly?${queryString}`, {
method: 'POST'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
fetch(courseId, endpoint) {
return request(`/courses/${courseId}/${endpoint}.json`, {
credentials: "include"
})
.then(res => {
if (res.ok) {
return res.json();
}
else {
return Promise.reject({ statusText: res.statusText });
}
})
.catch(error => {
logErrorMessage(error);
return Promise.reject({ error });
});
},
async fetchNews() {
// Determine the type of newsTitle content to fetch based on the `Features.wikiEd` flag
const newsTitle = Features.wikiEd ? 'Wiki Education News' : 'Programs & Events Dashboard News';
try {
const response = await request(`/faq/${newsTitle}/handle_special_faq_query`);
const { newsDetails } = await response.json();
return newsDetails;
} catch (error) {
logErrorMessage('Error creating news:', error)
throw error;
}
},
async fetchAllAdminCourseNotes(courseId) {
try {
const response = await request(`/admin_course_notes/${courseId}`);
const data = await response.json();
return data.AdminCourseNotes;
} catch (error) {
logErrorMessage('Error fetching course notes:', error);
throw error;
}
},
// /////////
// Setters #
// /////////
async saveTimeline(courseId, data) {
const cleanObject = object => {
if (object.is_new) {
delete object.id;
delete object.is_new;
}
};
const weeks = []
data.weeks.forEach(week => {
const cleanWeek = { ...week };
const cleanBlocks = [];
cleanWeek.blocks.forEach(block => {
const cleanBlock = { ...block }
cleanObject(cleanBlock);
cleanBlocks.push(cleanBlock);
});
cleanWeek.blocks = cleanBlocks;
cleanObject(cleanWeek);
weeks.push(cleanWeek);
});
const req_data = { weeks };
SentryLogger.type = 'POST';
const response = await request(`/courses/${courseId}/timeline.json`, {
method: 'POST',
body: JSON.stringify(req_data)
});
if (!response.ok) {
const data = await response.text();
this.obj = data;
this.status = response.statusText;
console.error('Couldn\'t save timeline!');
SentryLogger.obj = this.obj;
SentryLogger.status = this.status;
Sentry.captureMessage('saveTimeline failed', {
level: 'error',
extra: SentryLogger
});
response.responseText = data;
throw response;
}
return response.json();
},
async saveCourse(data, courseId = null) {
const append = (courseId != null) ? `/${courseId}` : '';
// append = '.json'
const type = (courseId != null) ? 'PUT' : 'POST';
SentryLogger.type = type;
let req_data = { course: data.course };
this.obj = null;
this.status = null;
const response = await request(`/courses${append}.json`, {
method: type,
body: JSON.stringify(req_data)
});
if (!response.ok) {
const data = await response.text();
this.obj = data;
this.status = response.statusText;
SentryLogger.obj = this.obj;
SentryLogger.status = this.status;
Sentry.captureMessage('saveCourse failed', {
level: 'error',
extra: SentryLogger
});
response.responseText = data;
throw response;
}
return response.json();
},
async saveUpdatedAdminCourseNote(adminCourseNoteDetails) {
try {
const response = await request(`/admin_course_notes/${adminCourseNoteDetails.id}`, {
method: 'PUT',
body: JSON.stringify(adminCourseNoteDetails)
});
const status = await response.json();
return status;
} catch (error) {
logErrorMessage('Error fetching course notes:', error);
throw error;
}
},
async createAdminCourseNote(courseId, adminCourseNoteDetails) {
const modifiedDetails = { ...adminCourseNoteDetails, courses_id: courseId };
try {
const response = await request('/admin_course_notes', {
method: 'POST',
body: JSON.stringify(modifiedDetails)
});
const { created_admin_course_note } = await response.json();
return created_admin_course_note;
} catch (error) {
logErrorMessage('Error saving course notes:', error)
throw error;
}
},
async deleteAdminCourseNote(adminCourseNoteId) {
try {
const response = await request(`/admin_course_notes/${adminCourseNoteId}`, {
method: 'DELETE',
});
const status = await response.json();
return status;
} catch (error) {
logErrorMessage('Error Deleting course notes:', error)
throw error;
}
},
async deleteCourse(courseId) {
const response = await request(`/courses/${courseId}.json`, {
method: 'DELETE'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
const result = await response.json();
window.location = '/';
return result;
},
async removeAndDeleteCourse(courseSlug, campaignTitle, campaignId, campaignSlug) {
const response = await request(`/courses/${courseSlug}.json/delete_from_campaign?campaign_title=${campaignTitle}&campaign_id=${campaignId}&campaign_slug=${campaignSlug}`, {
method: 'DELETE'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
const result = await response.json();
window.location = '/';
return result;
},
async deleteBlock(block_id) {
const response = await request(`/blocks/${block_id}.json`, {
method: 'DELETE'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return {block_id};
},
async deleteWeek(week_id) {
const response = await request(`/weeks/${week_id}.json`, {
method: 'DELETE'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return { week_id };
},
async deleteAllWeeks(course_id) {
const response = await request(`/courses/${course_id}/delete_all_weeks.json`, {
method: 'DELETE'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.text();
},
async notifyOverdue(courseSlug) {
const response = await request(`/courses/${courseSlug}/notify_untrained.json`);
if (!response.ok) {
logErrorMessage(response, 'Couldn\'t notify students! ');
const data = await response.text();
response.responseText = data;
throw response;
}
alert('Students with overdue trainings notified!');
return response.text();
},
async greetStudents(courseId) {
const response = await request(`/greeting?course_id=${courseId}`, {
method: 'PUT',
});
if (!response.ok) {
logErrorMessage(response, 'There was an error with the greetings! ');
const data = await response.text();
response.responseText = data;
throw response;
}
alert('Student greetings added to the queue.');
return response.json();
},
async modify(model, courseSlug, data, add) {
const verb = add ? 'added' : 'removed';
const response = await request(`/courses/${courseSlug}/${model}.json`, {
method: (add ? 'POST' : 'DELETE'),
body: JSON.stringify(data)
});
if (!response.ok) {
logErrorMessage(response, `${capitalize(model)} not ${verb}: `);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async dismissNotification(id) {
const response = await request('/survey_notification', {
method: 'PUT',
body: JSON.stringify( { survey_notification: { id, dismissed: true } })
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async uploadSyllabus({ courseId, file }) {
const data = new FormData();
data.append('syllabus', file);
// the request utility function assumes a header of "application/json"
// since we're sending files here, we must NOT set a content type
// see https://stackoverflow.com/a/49510941/5055190
const response = await fetch(`/courses/${courseId}/update_syllabus`, {
method: 'POST',
body: data,
headers:{
'X-CSRF-Token': Rails.csrfToken()
}
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async createNews(NewsDetails) {
NewsDetails = { ...NewsDetails, title: Features.wikiEd ? 'Wiki Education News' : 'Programs & Events Dashboard News'}
try {
const response = await request('/faq', {
method: 'POST',
body: JSON.stringify(NewsDetails)
});
const status = response.json();
return status
} catch (error) {
logErrorMessage('Error creating news:', error)
throw error;
}
},
async updateNews(NewsDetails) {
try {
const response = await request(`/faq/${NewsDetails.id}`, {
method: 'PUT',
body: JSON.stringify(NewsDetails)
});
const status = await response?.json();
return status;
} catch (error) {
logErrorMessage('Error Deleting course notes:', error)
throw error;
}
},
async deleteNews(news_id) {
try {
const response = await request(`/faq/${news_id}`, {
method: 'DELETE',
});
const status = await response.json();
return status
} catch (error) {
logErrorMessage('Error Deleting course notes:', error)
throw error;
}
},
async createAlert(opts, alert_type) {
const response = await request('/alerts', {
method: 'POST',
body: JSON.stringify( { ...opts, alert_type })
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async requestNewAccount(passcode, courseSlug, username, email, createAccountNow) {
const response = await request('/requested_accounts', {
method: 'PUT',
body: JSON.stringify(
{ passcode, course_slug: courseSlug, username, email, create_account_now: createAccountNow }
)
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async enableAccountRequests(courseSlug) {
const response = await request(`/requested_accounts/${courseSlug}/enable_account_requests`);
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.text();
},
async linkToSalesforce(courseId, salesforceId) {
const response = await request(`/salesforce/link/${courseId}.json?salesforce_id=${salesforceId}`, {
method: 'PUT'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async updateSalesforceRecord(courseId) {
const response = await request(`/salesforce/update/${courseId}.json`, {
method: 'PUT'
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
async getCategoriesWithPrefix(wiki, search_term, depth, limit=10){
return this.searchForPages(
wiki,
search_term,
14,
// replace everything until first colon, then trim
(title)=>title.replace(/^[^:]+:/,'').trim(),
depth,
limit,
);
},
async getTemplatesWithPrefix(wiki, search_term, depth, limit=10){
return this.searchForPages(
wiki,
search_term,
10,
(title)=>title.replace(/^[^:]+:/,'').trim(),
depth,
limit,
);
},
async searchForPages(wiki, search_term, namespace, map=(el)=>el, depth, limit=10){
let search_query;
if(search_term.split(' ').length > 1){
// if we have multiple words, search for the exact words
search_query = `intitle:${search_term}`;
}else{
// if we have a single word, search for the word anywhere in the title - as a substring
search_query = `intitle:/${search_term}/i`;
}
const params = {
action: 'query',
list: 'search',
srsearch: search_query,
srnamespace: namespace,
origin: '*',
format: 'json',
srlimit: limit ?? 10
};
const response = await fetch(
`https://${toWikiDomain(wiki)}/w/api.php?${stringify(params)}`
);
const json = await response.json();
return json.query.search.map((category) => {
const label = formatCategoryName({
category: map(category.title),
wiki,
});
return {
value: {
title: map(category.title),
wiki,
depth,
label: `${label} - ${depth}`,
},
label,
};
});
},
// Disallowed Users API
// Fetches list of usernames blocked from enrolling in any course
async fetchDisallowedUsers() {
const response = await request('/settings/disallowed_users');
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
// Adds a user to the disallowed list, preventing them from enrolling in courses
async addDisallowedUser(username) {
const response = await request('/settings/add_disallowed_user', {
method: 'POST',
body: JSON.stringify({ username })
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
},
// Removes a user from the disallowed list, allowing them to enroll again
async removeDisallowedUser(username) {
const response = await request('/settings/remove_disallowed_user', {
method: 'POST',
body: JSON.stringify({ username })
});
if (!response.ok) {
logErrorMessage(response);
const data = await response.text();
response.responseText = data;
throw response;
}
return response.json();
}
};
export default API;