Class: Pandarus::Lti

Inherits:
APIBase
  • Object
show all
Defined in:
lib/pandarus/lti_api.rb

Instance Attribute Summary

Attributes inherited from APIBase

#response

Instance Method Summary collapse

Methods inherited from APIBase

#initialize, #mixed_request, #page_params_load, #page_params_store, #parse_page_params!, #remember_key, #underscored_merge_opts, #was_last_page?

Constructor Details

This class inherits a constructor from Pandarus::APIBase

Instance Method Details

#create_originality_report(assignment_id, submission_id, originality_report__file_id__, originality_report__originality_score__, opts = {}) ⇒ Object

Create an Originality Report



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
 
# File 'lib/pandarus/lti_api.rb', line 13

def create_originality_report(assignment_id,submission_id,originality_report__file_id__,originality_report__originality_score__,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    :originality_report__file_id__,
    :originality_report__originality_score__,
    :originality_report__originality_report_url__,
    :originality_report__originality_report_file_id__,
    :originality_report__tool_setting____resource_type_code__,
    :originality_report__tool_setting____resource_url__,
    :originality_report__workflow_state__,
    

  ]

  # verify existence of params
  raise "assignment_id is required" if assignment_id.nil?
  raise "submission_id is required" if submission_id.nil?
  raise "originality_report__file_id__ is required" if originality_report__file_id__.nil?
  raise "originality_report__originality_score__ is required" if originality_report__originality_score__.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :assignment_id => assignment_id,
    :submission_id => submission_id,
    :originality_report__file_id__ => originality_report__file_id__,
    :originality_report__originality_score__ => originality_report__originality_score__

  )

  # resource path
  path = path_replace("/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report",
    :assignment_id => assignment_id,
    :submission_id => submission_id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:post, path, query_params, form_params, headers)
  OriginalityReport.new(response)
  

end

#create_webhook_subscription(submission___context_id__, subscription___context_type__, subscription___event_types__, subscription___format__, subscription___transport_metadata__, subscription___transport_type__, opts = {}) ⇒ Object

Create a Webhook Subscription



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
 
# File 'lib/pandarus/lti_api.rb', line 295

def create_webhook_subscription(submission___context_id__,subscription___context_type__,subscription___event_types__,subscription___format__,subscription___transport_metadata__,subscription___transport_type__,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    :submission___context_id__,
    :subscription___context_type__,
    :subscription___event_types__,
    :subscription___format__,
    :subscription___transport_metadata__,
    :subscription___transport_type__,
    

  ]

  # verify existence of params
  raise "submission___context_id__ is required" if submission___context_id__.nil?
  raise "subscription___context_type__ is required" if subscription___context_type__.nil?
  raise "subscription___event_types__ is required" if subscription___event_types__.nil?
  raise "subscription___format__ is required" if subscription___format__.nil?
  raise "subscription___transport_metadata__ is required" if subscription___transport_metadata__.nil?
  raise "subscription___transport_type__ is required" if subscription___transport_type__.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :submission___context_id__ => submission___context_id__,
    :subscription___context_type__ => subscription___context_type__,
    :subscription___event_types__ => subscription___event_types__,
    :subscription___format__ => subscription___format__,
    :subscription___transport_metadata__ => subscription___transport_metadata__,
    :subscription___transport_type__ => subscription___transport_type__

  )

  # resource path
  path = path_replace("/lti/subscriptions",
    )
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:post, path, query_params, form_params, headers)
  response
  

end

#delete_webhook_subscription(id, opts = {}) ⇒ Object

Delete a Webhook Subscription



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
 
# File 'lib/pandarus/lti_api.rb', line 345

def delete_webhook_subscription(id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    

  ]

  # verify existence of params
  raise "id is required" if id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :id => id

  )

  # resource path
  path = path_replace("/lti/subscriptions/{id}",
    :id => id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:delete, path, query_params, form_params, headers)
  response
  

end

#edit_originality_report_files(assignment_id, file_id, opts = {}) ⇒ Object

Edit an Originality Report



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
 
# File 'lib/pandarus/lti_api.rb', line 107

def edit_originality_report_files(assignment_id,file_id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    :originality_report__originality_score__,
    :originality_report__originality_report_url__,
    :originality_report__originality_report_file_id__,
    :originality_report__tool_setting____resource_type_code__,
    :originality_report__tool_setting____resource_url__,
    :originality_report__workflow_state__,
    

  ]

  # verify existence of params
  raise "assignment_id is required" if assignment_id.nil?
  raise "file_id is required" if file_id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :assignment_id => assignment_id,
    :file_id => file_id

  )

  # resource path
  path = path_replace("/lti/assignments/{assignment_id}/files/{file_id}/originality_report",
    :assignment_id => assignment_id,
    :file_id => file_id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:put, path, query_params, form_params, headers)
  OriginalityReport.new(response)
  

end

#edit_originality_report_submissions(assignment_id, submission_id, id, opts = {}) ⇒ Object

Edit an Originality Report



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
 
# File 'lib/pandarus/lti_api.rb', line 61

def edit_originality_report_submissions(assignment_id,submission_id,id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    :originality_report__originality_score__,
    :originality_report__originality_report_url__,
    :originality_report__originality_report_file_id__,
    :originality_report__tool_setting____resource_type_code__,
    :originality_report__tool_setting____resource_url__,
    :originality_report__workflow_state__,
    

  ]

  # verify existence of params
  raise "assignment_id is required" if assignment_id.nil?
  raise "submission_id is required" if submission_id.nil?
  raise "id is required" if id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :assignment_id => assignment_id,
    :submission_id => submission_id,
    :id => id

  )

  # resource path
  path = path_replace("/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}",
    :assignment_id => assignment_id,
    :submission_id => submission_id,
    :id => id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:put, path, query_params, form_params, headers)
  OriginalityReport.new(response)
  

end

#get_single_assignment_lti(assignment_id, opts = {}) ⇒ Object

Get a single assignment (lti)



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
 
# File 'lib/pandarus/lti_api.rb', line 227

def get_single_assignment_lti(assignment_id,opts={})
  query_param_keys = [
    :user_id

  ]

  form_param_keys = [
    

  ]

  # verify existence of params
  raise "assignment_id is required" if assignment_id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :assignment_id => assignment_id

  )

  # resource path
  path = path_replace("/lti/assignments/{assignment_id}",
    :assignment_id => assignment_id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:get, path, query_params, form_params, headers)
  LtiAssignment.new(response)
  

end

#get_single_user_lti(id, opts = {}) ⇒ Object

Get a single user (lti)



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
 
# File 'lib/pandarus/lti_api.rb', line 261

def get_single_user_lti(id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    

  ]

  # verify existence of params
  raise "id is required" if id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :id => id

  )

  # resource path
  path = path_replace("/lti/users/{id}",
    :id => id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:get, path, query_params, form_params, headers)
  User.new(response)
  

end

#list_all_webhook_subscription_for_tool_proxy(opts = {}) ⇒ Object

List all Webhook Subscription for a tool proxy



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
 
# File 'lib/pandarus/lti_api.rb', line 447

def list_all_webhook_subscription_for_tool_proxy(opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    

  ]

  # set default values and merge with input
  options = underscored_merge_opts(opts,
    {}
  

  )

  # resource path
  path = path_replace("/lti/subscriptions",
    )
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:get, path, query_params, form_params, headers)
  response
  

end

#show_originality_report_files(assignment_id, file_id, opts = {}) ⇒ Object

Show an Originality Report



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
 
# File 'lib/pandarus/lti_api.rb', line 190

def show_originality_report_files(assignment_id,file_id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    

  ]

  # verify existence of params
  raise "assignment_id is required" if assignment_id.nil?
  raise "file_id is required" if file_id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :assignment_id => assignment_id,
    :file_id => file_id

  )

  # resource path
  path = path_replace("/lti/assignments/{assignment_id}/files/{file_id}/originality_report",
    :assignment_id => assignment_id,
    :file_id => file_id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:get, path, query_params, form_params, headers)
  OriginalityReport.new(response)
  

end

#show_originality_report_submissions(assignment_id, submission_id, id, opts = {}) ⇒ Object

Show an Originality Report



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
 
# File 'lib/pandarus/lti_api.rb', line 150

def show_originality_report_submissions(assignment_id,submission_id,id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    

  ]

  # verify existence of params
  raise "assignment_id is required" if assignment_id.nil?
  raise "submission_id is required" if submission_id.nil?
  raise "id is required" if id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :assignment_id => assignment_id,
    :submission_id => submission_id,
    :id => id

  )

  # resource path
  path = path_replace("/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}",
    :assignment_id => assignment_id,
    :submission_id => submission_id,
    :id => id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:get, path, query_params, form_params, headers)
  OriginalityReport.new(response)
  

end

#show_single_webhook_subscription(id, opts = {}) ⇒ Object

Show a single Webhook Subscription



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
 
# File 'lib/pandarus/lti_api.rb', line 379

def show_single_webhook_subscription(id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    

  ]

  # verify existence of params
  raise "id is required" if id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :id => id

  )

  # resource path
  path = path_replace("/lti/subscriptions/{id}",
    :id => id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:get, path, query_params, form_params, headers)
  response
  

end

#update_webhook_subscription(id, opts = {}) ⇒ Object

Update a Webhook Subscription



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
 
# File 'lib/pandarus/lti_api.rb', line 413

def update_webhook_subscription(id,opts={})
  query_param_keys = [
    

  ]

  form_param_keys = [
    

  ]

  # verify existence of params
  raise "id is required" if id.nil?
  # set default values and merge with input
  options = underscored_merge_opts(opts,
    :id => id

  )

  # resource path
  path = path_replace("/lti/subscriptions/{id}",
    :id => id)
  headers = nil
  form_params = select_params(options, form_param_keys)
  query_params = select_query_params(options, query_param_keys)

  response = mixed_request(:put, path, query_params, form_params, headers)
  response
  

end