Class: PlatformSdk::CanvasApiWrapper::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_sdk/canvas_api/client.rb

Overview

DataPipeline::Client

Constant Summary collapse

PAGE_SIZE = 
10

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain:, token:) ⇒ Client

Returns a new instance of Client.

Parameters:

  • domain (String)
  • token (String) 


15
16
17
18
19
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 15

def initialize(domain:, token:)
  @host = "https://#{domain}"
  @token = token
  @connection = Faraday.new(url: host, headers: { 'Authorization' => "Bearer #{token}" })
end

Instance Attribute Details

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



9
10
11
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 9

def connection
  @connection
end

#host ⇒ Object (readonly)

Returns the value of attribute host.



9
10
11
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 9

def host
  @host
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



9
10
11
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 9

def token
  @token
end

Instance Method Details

#assignment(course_id:, assignment_id:) ⇒ Object

Parameters:

  • course_id (Integer) 


96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 96

def assignment(course_id:, assignment_id:)
  uri = "api/v1/courses/#{course_id}/assignments/#{assignment_id}"
  response = @connection.get(uri)
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting quiz submissions#{error_messages}"
  end
end

#assignments(course_id:, module_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • module_id (Integer) 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 79

def assignments(course_id:, module_id:)
  response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items?per_page=#{PAGE_SIZE}")
  handle_rate_limiting response
  if success?(response.status)
    assignments = paginated_items headers: response.headers, initial_response: response.body
    assignments.select { |item| item[:type] == 'Assignment' }
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting assignments: #{error_messages}"
  end
end

#course_modules(course_id:) ⇒ Object

Parameters:

  • course_id (Integer) 


23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 23

def course_modules(course_id:)
  response = @connection.get("/api/v1/courses/#{course_id}/modules")
  handle_rate_limiting response
  if success?(response.status)
    paginated_items headers: response.headers, initial_response: response.body
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting course modules: #{error_messages}"
  end
end

#course_students(course_id:) ⇒ Object

Parameters:

  • course_id (Integer) 


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 211

def course_students(course_id:)
  uri = "/api/v1/courses/#{course_id}/users?per_page=#{PAGE_SIZE}"
  params = { 'enrollment_type[]' => 'student' }
  response = @connection.get(uri, params)
  handle_rate_limiting response
  if success?(response.status)
    paginated_items headers: response.headers, initial_response: response.body
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting course students: #{error_messages}"
  end
end

#course_test_student(course_id:) ⇒ Object

Parameters:

  • course_id (Integer) 


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 229

def course_test_student(course_id:)
  uri = "/api/v1/courses/#{course_id}/users"
  params = { 'enrollment_type[]' => 'student_view' }
  response = @connection.get(uri, params)
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting test students: #{error_messages}"
  end
end

#course_users(course_id:) ⇒ Object

Parameters:

  • course_id (Integer) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 247

def course_users(course_id:)
  uri = "/api/v1/courses/#{course_id}/users?per_page=#{PAGE_SIZE}"
  response = @connection.get(uri)
  handle_rate_limiting response
  if success?(response.status)
    paginated_items headers: response.headers, initial_response: response.body
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting course users: #{error_messages}"
  end
end

#delete_module_item(course_id:, module_id:, module_item_id:) ⇒ Object 



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 474

def delete_module_item(course_id:, module_id:, module_item_id:)
  uri = "/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}"
  response = @connection.delete(uri) do |req|
    req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
  end
  handle_rate_limiting response
  result = MultiJson.load response.body, symbolize_keys: true
  if success?(response.status)
    result
  else
    error_messages = String.new
    result[:errors]&.each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error destroying module item: #{error_messages}"
  end
end

#module_item(course_id:, module_id:, module_item_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • module_id (Integer)
  • module_item_id (Integer) 


115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 115

def module_item(course_id:, module_id:, module_item_id:)
  response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}")
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting module item: #{error_messages}"
  end
end

#module_items(course_id:, module_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • module_id (Integer) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 41

def module_items(course_id:, module_id:)
  response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items?per_page=#{PAGE_SIZE}")
  handle_rate_limiting response
  if success?(response.status)
    paginated_items headers: response.headers, initial_response: response.body
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting module items: #{error_messages}"
  end
end

#post_complete_quiz_submission(course_id:, quiz_id:, submission_id:, attempt:, validation_token:) ⇒ Hash

Parameters:

  • course_id (Integer)
  • quiz_id (Integer)
  • submission_id (Integer)
  • attempt (Integer)
  • validation_token (String)

Returns:

  • (Hash) 


321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 321

def post_complete_quiz_submission(course_id:, quiz_id:, submission_id:, attempt:, validation_token:)
  uri = "api/v1/courses/#{course_id}/quizzes/#{quiz_id}/submissions/#{submission_id}/complete"
  response = @connection.post(uri) do |req|
    req.headers['Content-Type'] = 'application/json'
    req.body = { attempt:, validation_token: }.to_json
  end
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    handle_post_response_errors(response, 'Error completing quiz submission')
  end
end

#post_create_quiz_submission(course_id:, quiz_id:, user_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • quiz_id (Integer)
  • user_id (Integer) 


304
305
306
307
308
309
310
311
312
313
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 304

def post_create_quiz_submission(course_id:, quiz_id:, user_id:)
  uri = "api/v1/courses/#{course_id}/quizzes/#{quiz_id}/submissions?as_user_id=#{user_id}"
  response = @connection.post(uri)
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    handle_post_response_errors(response, 'Error creating quiz submission')
  end
end

#post_discussion_topic_entry(course_id:, topic_id:, user_id:, message:) ⇒ Object 



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 367

def post_discussion_topic_entry(course_id:, topic_id:, user_id:, message:)
  uri = "api/v1/courses/#{course_id}/discussion_topics/#{topic_id}/entries?as_user_id=#{user_id}"
  response = @connection.post(uri) do |req|
    req.headers['Content-Type'] = 'application/json'
    req.body = { 'message': message.to_s }.to_json
  end
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors]&.each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error posting a reply: #{error_messages}"
  end
end

#post_mark_module_item_done(course_id:, module_id:, module_item_id:, user_id:) ⇒ Object

Returns nil.

Parameters:

  • course_id (Integer)
  • module_id (Integer)
  • module_item_id (Integer)
  • user_id (Integer)

Returns:

  • nil



356
357
358
359
360
361
362
363
364
365
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 356

def post_mark_module_item_done(course_id:, module_id:, module_item_id:, user_id:)
  uri = "api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}/done?as_user_id=#{user_id}"
  response = @connection.post(uri)
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    handle_post_response_errors(response, 'Error marking module item done')
  end
end

#post_mark_module_item_read(course_id:, module_id:, module_item_id:, user_id:) ⇒ Object

Returns nil.

Parameters:

  • course_id (Integer)
  • module_id (Integer)
  • module_item_id (Integer)
  • user_id (Integer)

Returns:

  • nil



340
341
342
343
344
345
346
347
348
349
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 340

def post_mark_module_item_read(course_id:, module_id:, module_item_id:, user_id:)
  uri = "api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}/mark_read?as_user_id=#{user_id}"
  response = @connection.post(uri)
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    handle_post_response_errors(response, 'Error marking module items read')
  end
end

#post_module_item(course_id:, module_id:, body:) ⇒ Object

Parameters:

  • course_id (Integer)
  • module_id (Integer)
  • body (Hash)

Options Hash (body:):

  • 'module_item[title]' (String) —

    The name of the module_item and associated content

  • 'module_item[type]' (String) —

    Allowed: ExternalUrl, ExternalTool

  • 'module_item[content_id]' (Integer) —

    The id of the content to link to the module_item. Required

  • 'module_item[position]' (Integer) —

    The position of this item in the module (1-based). Default 0

  • 'module_item[external_url]' (String) —

    External url that the item points to. Required for: ExternalUrl, ExternalTool.

  • 'module_item[completion_requirement][type]' (String) —

    Allowed: must_view, must_contribute, must_submit, must_mark_done.



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 433

def post_module_item(course_id:, module_id:, body:)
  uri = "/api/v1/courses/#{course_id}/modules/#{module_id}/items"
  response = @connection.post(uri) do |req|
    req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
    req.body = body
  end
  handle_rate_limiting response
  result = MultiJson.load response.body, symbolize_keys: true
  if success?(response.status)
    result
  else
    error_messages = String.new
    result[:errors]&.each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error creating module item: #{error_messages}"
  end
end

#put_module_prerequesites(course_id:, module_id:, prerequisite_ids:) ⇒ Object

Note:

prerequisite_ids should be a valid module_id, sending and empty array removes all prerequisites.

Parameters:

  • course_id (Integer)
  • module_id (Integer)
  • prerequisite_ids (Array<Integer>) 


405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 405

def put_module_prerequesites(course_id:, module_id:, prerequisite_ids:)
  uri = "/api/v1/courses/#{course_id}/modules/#{module_id}"
  response = @connection.put(uri) do |req|
    req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
    req.body = { 'module[prerequisite_module_ids]' => prerequisite_ids }
  end
  handle_rate_limiting response
  result = MultiJson.load response.body, symbolize_keys: true
  if success?(response.status)
    result
  else
    error_messages = String.new
    result[:errors]&.each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error updating module prerequisite: #{error_messages}"
  end
end

#put_publish_module_item(course_id:, module_id:, module_item_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • module_id (Integer)
  • module_item_id (Integer) 


455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 455

def put_publish_module_item(course_id:, module_id:, module_item_id:)
  uri = "/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}"
  response = @connection.put(uri) do |req|
    req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
    req.body = { 'module_item[published]' => true }
  end
  handle_rate_limiting response
  result = MultiJson.load response.body, symbolize_keys: true
  if success?(response.status)
    result
  else
    error_messages = String.new
    result[:errors]&.each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error publishing module item: #{error_messages}"
  end
end

#put_relock_module(course_id:, module_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • module_id (Integer) 


388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 388

def put_relock_module(course_id:, module_id:)
  uri = "api/v1/courses/#{course_id}/modules/#{module_id}/relock"
  response = @connection.put(uri)
  result = MultiJson.load response.body, symbolize_keys: true
  handle_rate_limiting response
  if success?(response.status)
    result
  else
    error_message = parse_response_errors(result:, message: 'Error re-locking module')
    raise CanvasClientError, error_message
  end
end

#quiz(course_id:, quiz_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • quiz_id (Integer) 


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 265

def quiz(course_id:, quiz_id:)
  uri = "/api/v1/courses/#{course_id}/quizzes/#{quiz_id}"
  response = @connection.get(uri)
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting quiz: #{error_messages}"
  end
end

#quiz_submissions(course_id:, quiz_id:, user_id:) ⇒ Array

Parameters:

  • course_id (Integer)
  • quiz_id (Integer)
  • user_id (Integer)

Returns:

  • (Array) 


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 285

def quiz_submissions(course_id:, quiz_id:, user_id:)
  uri = "api/v1/courses/#{course_id}/quizzes/#{quiz_id}/submissions?user=#{user_id}&per_page=#{PAGE_SIZE}"
  response = @connection.get(uri)
  handle_rate_limiting response
  if success?(response.status)
    paginated_items headers: response.headers, initial_response: response.body
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting quiz submissions#{error_messages}"
  end
end

#retrieve_discussion_topic(course_id:, topic_id:) ⇒ Object 



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 492

def retrieve_discussion_topic(course_id:, topic_id:)
  uri = "/api/v1/courses/#{course_id}/discussion_topics/#{topic_id}"
  response = @connection.get(uri) do |req|
    req.headers['Content-Type'] = 'application/json'
  end
  handle_rate_limiting response
  result = MultiJson.load response.body, symbolize_keys: true
  if success?(response.status)
    result
  else
    error_messages = String.new
    result[:errors]&.each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error retrieving discussion topic: #{error_messages}"
  end
end

#submissions(course_id:, assignment_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • assignment_id (Integer) 


147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 147

def submissions(course_id:, assignment_id:)
  response = @connection.get("/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/")
  handle_rate_limiting response
  if success?(response.status)
    paginated_items headers: response.headers, initial_response: response.body
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting submissions: #{error_messages}"
  end
end

#update_submission_excused(course_id:, assignment_id:, user_id:) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 162

def update_submission_excused(course_id:, assignment_id:, user_id:)
  uri = "/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}"
  response = @connection.put(uri) do |req|
    req.headers["Content-Type"] = "application/json"
    req.body = {
      submission: {
        excuse: true
      }
    }.to_json
  end
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error update submissions to excused: #{error_messages}"
  end
end

#update_submission_excused_with_comment(course_id:, assignment_id:, user_id:, comment:) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 185

def update_submission_excused_with_comment(course_id:, assignment_id:, user_id:, comment:)
  uri = "/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}"
  response = @connection.put(uri) do |req|
    req.headers['Content-Type'] = 'application/json'
    req.body = {
      'comment': {
        'text_comment': comment
      },
      'submission': {
        'excuse': true
      }
    }.to_json
  end
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error update submissions to excused: #{error_messages}"
  end
end

#user_module_item(course_id:, module_id:, module_item_id:, user_id:) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 130

def user_module_item(course_id:, module_id:, module_item_id:, user_id:)
  response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}?as_user_id=#{user_id}")
  handle_rate_limiting response
  if success?(response.status)
    MultiJson.load response.body, symbolize_keys: true
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting module item: #{error_messages}"
  end
end

#user_module_items(course_id:, module_id:, user_id:) ⇒ Object

Parameters:

  • course_id (Integer)
  • module_id (Integer)
  • user_id (Integer) 


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/platform_sdk/canvas_api/client.rb', line 60

def user_module_items(course_id:, module_id:, user_id:)
  uri = "/api/v1/courses/#{course_id}/modules/#{module_id}/items?as_user_id=#{user_id}&per_page=#{PAGE_SIZE}"
  response = @connection.get(uri)
  handle_rate_limiting response
  if success?(response.status)
    paginated_items headers: response.headers, initial_response: response.body
  else
    result = MultiJson.load response.body, symbolize_keys: true
    error_messages = String.new
    result[:errors].each do |error|
      error_messages << "#{error[:message]} "
    end
    raise "Error getting module items: #{error_messages}"
  end
end