Class: CanvasInterface

Inherits:
Object
  • Object
show all
Defined in:
lib/github-to-canvas/canvas_interface.rb

Class Method Summary collapse

Class Method Details

.add_to_module(course_id, module_info, lesson_info) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 49

def self.add_to_module(course_id, module_info, lesson_info)
  # POST /api/v1/courses/:course_id/modules/:module_id/items
  url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/modules/#{module_info["id"]}/items"
  
  if lesson_info["type"] == "Page" || lesson_info["type"] == "page"
    payload = {
      'module_item[title]' => lesson_info["title"],
      'module_item[type]' => lesson_info["type"].capitalize,
      'module_item[indent]' => 0,
      'module_item[page_url]' => lesson_info["page_url"],
      'module_item[completion_requirement][type]' => 'must_view'
    }
  elsif lesson_info["type"] == "Quiz"
    puts "Quiz needs to be added manually - #{lesson_info['title']} - lesson_info["
  else
    
    payload = {
      'module_item[title]' => lesson_info["title"],
      'module_item[type]' => lesson_info["type"].capitalize,
      'module_item[indent]' => 1,
      'module_item[content_id]' =>  lesson_info["id"],
      'module_item[completion_requirement][type]' => 'must_submit'
    }
  end
  begin
    response = RestClient.post(url, payload, self.headers)
  rescue
    puts "Something went wrong while adding lesson #{lesson_info["id"]} to module #{module_info["id"]} in course #{course_id}" if lesson_info["type"] == "Assignment"
    puts "Something went wrong while adding lesson #{lesson_info["page_url"]} to module #{module_info["id"]} in course #{course_id}" if lesson_info["type"] == "Page"
    abort
  end
  response
  
end

.build_payload(options, name, html) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 372

def self.build_payload(options, name, html)
  if options[:only_update_content]
    if options[:type] == "assignment"
      payload = {
        'assignment[description]' => html
      }
    elsif options[:type] == "discussion"
      payload = {
        'message' => html
      }
    else
      payload = {
        'wiki_page[body]' => html
      }
    end
  else
    if options[:type] == "assignment"
      payload = {
        'assignment[name]' => name,
        'assignment[description]' => html,
        'assignment[submission_types][]' => "online_url",
        'assignment[grading_type]' => 'pass_fail',
        'assignment[points_possible]' => 1
      }
    elsif options[:type] == "discussion"
      payload = {
        'title' => name,
        'message' => html
      }
    else
      payload = {
        'wiki_page[title]' => name,
        'wiki_page[body]' => html,
        'wiki_page[editing_roles]' => "teachers" 
      }
    end
  end
end

.copy_lesson(options) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 340

def self.copy_lesson(options)
  types = ["page", "assignment", "quiz", "discussion"]
  url = options[:filepath]
  type = types.find {|type| url.match(type)}
  options[:type] = type
  if !url.include?(ENV['CANVAS_API_PATH'])
    url = url.sub(/^.*\/\/.*?\//,"#{ENV['CANVAS_API_PATH']}/")
  end

  response = RestClient.get(url, headers={
    "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
  })

  lesson_info = JSON.parse(response)
  lesson_info = lesson_info.slice("title",
                                  "name",
                                  "description",
                                  "body",
                                  "message",
                                  "shuffle_answers",
                                  "allowed_attempts",
                                  "question_count"
                                  )
  if options[:type] == "page"
    self.update_existing_lesson(options, lesson_info["title"], lesson_info["body"])
  else
    self.update_existing_lesson(options, lesson_info["name"], lesson_info["description"])
  end
  
  
end

.create_course(course_info) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 6

def self.create_course(course_info)
  # POST /api/v1/accounts/:account_id/courses
  url = "#{ENV['CANVAS_API_PATH']}/accounts/1/courses"
  payload = {
    'course[name]' => course_info[:name],
    'course[course_code]' => course_info[:course_code]
  }
  response = RestClient.post(url, payload, self.headers)
  JSON.parse(response)
end

.create_lesson(options, name, html) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 29

def self.create_lesson(options, name, html)
  if options[:type] == 'discussion'
    url = "#{ENV['CANVAS_API_PATH']}/courses/#{options[:course_id]}/#{options[:type]}_topics"
  else
    url = "#{ENV['CANVAS_API_PATH']}/courses/#{options[:course_id]}/#{options[:type]}s"
  end
  payload = self.build_payload(options, name, html)
  begin
    response = RestClient.post(url, payload, self.headers)
  rescue
    puts "Something went wrong while pushing lesson #{options[:id]} to course #{options[:course_id]}"
    abort
  end
  if ![200, 201].include? response.code
    puts "Canvas push failed. #{response.code} status code returned "
    abort
  end
  JSON.parse(response.body)
end

.create_lesson_from_remote(course_id, module_id, lesson_type, raw_url, yaml_file) ⇒ Object 



455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 455

def self.create_lesson_from_remote(course_id, module_id, lesson_type, raw_url, yaml_file)
  url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/modules/#{module_id}/items"
  if yaml_file
    data = YAML.load(File.read("#{Dir.pwd}/#{yaml_file}"))
    payload = {
      'module_item[type]' => data["type"],
      'module_item[title]' => data["title"]
    }
  else

  end
  

end

.create_module(course_id, module_info) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 17

def self.create_module(course_id, module_info)
  # POST /api/v1/courses/:course_id/modules
  url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/modules"
  payload = {
    'module[name]' => module_info[:name]
  }
  response = RestClient.post(url, payload, headers={
    "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
  })
  JSON.parse(response)
end

.csv(file_to_convert) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 293

def self.csv(file_to_convert)
  course_info = YAML.load(File.read("#{Dir.pwd}/#{file_to_convert}"))
  course_info[:modules] = course_info[:modules].map do |mod|
    mod[:lessons] = mod[:lessons].map do |lesson|

      url = lesson["url"]
      response = RestClient.get(url, headers={
        "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
      })
      begin
        lesson_data = JSON.parse(response)
        contents = lesson_data["body"] if lesson["type"] == "Page"
        contents = lesson_data["message"] if lesson["type"] == "Discussion"
        contents = lesson_data["description"] if lesson["type"] == "Assignment" || lesson["type"] == "Quiz"
        if contents.nil?
          repo = ""
        else
          if contents[/data-repo=\"(.*?)"/]
            repo = contents[/data-repo=\"(.*?)"/]
            repo = repo.slice(11..-2)
          elsif contents[/class=\"fis-git-link\" href=\"(.*?)"/]
            repo = contents[/class=\"fis-git-link\" href=\"(.*?)"/]
            repo = repo.slice(27..-2)
          else
            repo = ""
          end
        end
      rescue
        puts 'Error while mapping course info.'
        abort
      end
      
      if repo != nil && repo != ""
        if repo.include?('https://github.com/learn-co-curriculum/')
          lesson["repository"] = repo
        else
          lesson["repository"] = "https://github.com/learn-co-curriculum/" + repo
        end
      end
      sleep(1)
      lesson
    end
    mod
  end
  puts course_info.to_yaml
end

.get_course_info(course, id) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 171

def self.get_course_info(course, id)
  if id
    lesson_data = self.get_lesson_info(course, id)
    pp lesson_data[0]
    pp "\nLesson Type: #{lesson_data[1]}"
    return
  end

  url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}"
  response = RestClient.get(url, self.headers)
  course_data = JSON.parse(response)

  # /api/v1/courses/:course_id/modules
  course_info = {
    name: course_data['name'],
    id: course_data['id'],
    modules: []
  }

  begin
      index = 1

      while !!index
        url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/modules?page=#{index}&per_page=20"
        index += 1
        
        response = RestClient.get(url, self.headers)
        modules = JSON.parse(response.body)
        
        if ([200, 201].include? response.code) && (!modules.empty?)
          course_info[:modules] = course_info[:modules] + modules
        else
          index = nil
        end
      end
      
      course_info[:modules] = course_info[:modules].map do |mod|
        new_mod = {
          id: mod['id'],
          name: mod['name'],
          lessons: []
        }
        index = 1
        while !!index
          url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/modules/#{mod['id']}/items?page=#{index}&per_page=20"
          index += 1
          response = RestClient.get(url, self.headers)
          lessons = JSON.parse(response.body)
          lessons = lessons.map do |lesson|
            lesson = lesson.slice("id","title","name","indent","type","html_url","page_url","url","completion_requirement", "published")
            lesson["repository"] = ""
            lesson['id'] = lesson['url']&.gsub(/^(.*[\\\/])/,'')
            lesson
          end
          if ([200, 201].include? response.code) && (!lessons.empty?)
            new_mod[:lessons] = new_mod[:lessons] + lessons
          else
            index = nil
          end
          
        end
        new_mod
      end
      
      puts course_info.to_yaml
    
  rescue
    puts "Something went wrong while getting info about course #{course}"
    abort
  end
end

.get_lesson_info(course, id) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 138

def self.get_lesson_info(course, id)

  lesson_types = ["quizzes", "assignments", "pages", "discussion_topics"]
  lesson_type_urls = []
  lesson_types.each do |type|
    lesson_type_urls << "#{ENV['CANVAS_API_PATH']}/courses/#{course}/#{type}/#{id}"
  end

  type = nil
  info = ""
  lesson_type_urls.each do |url|
    begin
      
      response = RestClient.get(url, headers={
        "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
      })
      if [200, 201].include? response.code
        info = JSON.parse(response.body)
        type = lesson_types.find {|type| url.match?("#{type}")}
        type.delete_suffix!('zes')
        type.delete_suffix!('s')
        puts "\nA Canvas #{type} was found in course #{course} with the id #{id}"
        break
      end
    rescue
    end
  end
  
  
  [info, type]
end

.headers ⇒ Object 



470
471
472
473
474
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 470

def self.headers
  {
    "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
  }
end

.map_course_info(options) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 243

def self.map_course_info(options)
  course_info = YAML.load(File.read("#{Dir.pwd}/#{options[:file_to_convert]}"))
  course_info[:modules] = course_info[:modules].map do |mod|
    mod[:lessons] = mod[:lessons].map do |lesson|
      next lesson unless lesson.key?("url")

      url = lesson["url"]
      response = RestClient.get(url, headers={
        "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
      })
      begin
        lesson_data = JSON.parse(response)
        contents = lesson_data["body"] if lesson["type"] == "Page"
        contents = lesson_data["message"] if lesson["type"] == "Discussion"
        contents = lesson_data["description"] if lesson["type"] == "Assignment" || lesson["type"] == "Quiz"
        if contents.nil?
          repo = ""
        else
          if contents[/data-repo=\"(.*?)"/]
            repo = contents[/data-repo=\"(.*?)"/]
            repo = repo.slice(11..-2)
          elsif contents[/class=\"fis-git-link\" href=\"(.*?)"/]
            repo = contents[/class=\"fis-git-link\" href=\"(.*?)"/]
            repo = repo.slice(27..-2)
          else
            repo = ""
          end
        end
      rescue
        puts 'Error while mapping course info.'
        abort
      end
      
      if repo != nil && repo != ""
        if repo.include?('https://github.com/learn-co-curriculum/')
          lesson["repository"] = repo
        else
          lesson["repository"] = "https://github.com/learn-co-curriculum/" + repo
        end
        puts lesson["repository"] if options[:urls_only]
        puts "#{lesson["repository"]}, #{lesson["title"]}, #{mod[:name]}, #{lesson["type"].downcase}, , #{lesson["id"]}, #{course_info[:id]}" if options[:csv]
      end
      sleep(1)
      lesson
    end
    mod
  end
  puts course_info.to_yaml if !(options[:urls_only] || options[:csv])
end

.read_lesson(url) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 411

def self.read_lesson(url)
  types = ["page", "assignment", "quiz", "discussion"]
  type = types.find {|type| url.match(type)}
  if !url.include?(ENV['CANVAS_API_PATH'])
    url = url.sub(/^.*\/\/.*?\//,"#{ENV['CANVAS_API_PATH']}/")
  end

  response = RestClient.get(url, headers={
    "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
  })
  lesson_info = JSON.parse(response)
  lesson_info = lesson_info.slice("title",
                                  "name",
                                  "description",
                                  "body",
                                  "message",
                                  "shuffle_answers",
                                  "allowed_attempts",
                                  "question_count"
                                  )
  lesson_info["type"] = type.capitalize
  if lesson_info["type"] == "Quiz"
    url = url + "/questions"
    response = RestClient.get(url, headers={
      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
    })
    lesson_info["questions"] = JSON.parse(response)
    lesson_info["questions"] = lesson_info["questions"].map do |question|
      question.slice("id",
                    "position",
                    "question_name",
                    "question_type",
                    "question_text",
                    "points_possible",
                    "correct_comments_html",
                    "incorrect_comments_html",
                    "neutral_comments_html",
                    "answers"
                    )
    end
  end
  lesson_info.to_yaml
end

.update_all_related_lessons(options, name, html) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 110

def self.update_all_related_lessons(options, name, html)
  # Read the local .canvas file if --id <ID> is not used. Otherwise, use provided ID (--course <COURSE> also required)
  if !options[:id]
    canvas_data = CanvasDotfile.read_canvas_data
    response = nil
    canvas_data[:lessons] = canvas_data[:lessons].map { |lesson|
      response = self.update_existing_lesson(lesson, name, html)
      options[:id] = lesson[:id]
      options[:course_id] = lesson[:course_id]
      options[:type] = lesson[:type]
      
    }
    RepositoryInterface.local_repo_post_submission(options, response)
    puts "Canvas lesson updated. Lesson available at #{response['html_url']}"
  else
    # If an ID (and course) are provided, they are used instead of the .canvas file
    # Gets the current lesson's type (page or assignment)

    options[:type] = self.get_lesson_info(options[:course_id], options[:id])[1]

    # Implements update on Canvas
    response = self.update_existing_lesson(options, name, html)
    RepositoryInterface.local_repo_post_submission(options, response)
    puts "Canvas lesson updated. Lesson available at #{response['html_url']}"
  end

end

.update_existing_lesson(options, name, html) ⇒ Object 



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
 
# File 'lib/github-to-canvas/canvas_interface.rb', line 84

def self.update_existing_lesson(options, name, html)
  if options[:type] == "discussion"
    url = "#{ENV['CANVAS_API_PATH']}/courses/#{options[:course_id]}/#{options[:type]}_topics/#{options[:id]}"
  else
    url = "#{ENV['CANVAS_API_PATH']}/courses/#{options[:course_id]}/#{options[:type]}s/#{options[:id]}"
  end
  payload = self.build_payload(options, name, html)
  
  begin
    headers = self.headers
    if options[:type] == 'page' || options[:type] == 'Page'
      response = RestClient.get(url, headers)
      lesson_info = JSON.parse(response)
      lesson_info = lesson_info[0] if lesson_info.kind_of?(Array)
      url = url.sub(/[^\/]+$/, lesson_info["page_id"].to_s)
    end
    response = RestClient.put(url, payload, headers)
  rescue Exception => e
    puts "Something went wrong while pushing lesson #{options[:id]} to course #{options[:course_id]}"
    puts "Make sure you are working on lessons that are not locked"
    raise e
    abort
  end
  JSON.parse(response.body)
end