github-to-canvas-quiz 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92070ddfabd669585e03a0483a6c037285ede7ef273203b9f657ca2d8a31591a
-  data.tar.gz: 793083a3619e931c5a0f443186b851a30c62dcfc165e3c993ea418ba896b6506
+  metadata.gz: 1d17233ef60255fbf44c319a9f603698fce38bfdca6ef875fba36a9904a8b9e4
+  data.tar.gz: c6f727a34b726a41bfdc5a5a57fd9cebb2e3f07799fa2d8c69afdb858cee126a
 SHA512:
-  metadata.gz: 9ab93d1c07ccd0552abda64b9fcc7e5b1eb23f084f8386f1c6287531471858eb9887555799ea1c7c942b1a4216d04d0f2ced48b7d3502874c76fac04c6f1fc4c
-  data.tar.gz: 638e64bc77c6de8db38526556e35c9f2a9b84e7a74afed6be9d30b034761671418f0bf9e3f362f9064aa594122dea34f155251ca7b1921bf3c6f59a1dc123c8e
+  metadata.gz: 69ca6d0b1a7855fbf8445f857f715cf68eaa948017c40181e455516349249b03531a2812e3640e3195fdb02d560c38614c2843e3cd8a31b06d41946307e67f07
+  data.tar.gz: 29353d35a5a6a6f10155d26f96d5945ffe04521cd1824875996ec1344e4d660b5bdabbf13266c01e740a7d5eee5608968d4acf3809ebcff83bc2dd2d8bb7545e

data/lib/github_to_canvas_quiz/cli.rb

@@ -4,17 +4,26 @@ module GithubToCanvasQuiz
   class CLI < Thor
     option :course, type: :numeric, required: true, desc: 'Canvas Course ID'
     option :quiz, type: :numeric, required: true, desc: 'Canvas Quiz ID'
-    option :directory, default: '.',
-                       desc: '(optional) Directory to output markdown files. Defaults to current directory'
+    option :directory,
+           default: '.',
+           desc:
+             '(optional) Directory to output markdown files. Defaults to current directory'
     desc 'backup', 'Backup a Canvas quiz and its questions as markdown'
     def backup
       puts '⬇️ Converting quiz...'
-      Builder::Quiz.new(client, options[:course], options[:quiz], options[:directory]).build
+      Builder::Quiz.new(
+        client,
+        options[:course],
+        options[:quiz],
+        options[:directory],
+      ).build
       puts '✅ Done'
     end
 
-    option :directory, default: '.',
-                       desc: '(optional) Directory with markdown files to align. Defaults to current directory'
+    option :directory,
+           default: '.',
+           desc:
+             '(optional) Directory with markdown files to align. Defaults to current directory'
     desc 'align', 'Updates a Canvas quiz from Markdown files.'
     def align
       puts '⬆️ Aligning quiz...'
@@ -22,10 +31,19 @@ module GithubToCanvasQuiz
       puts '✅ Done'
     end
 
+    desc 'version', 'Display the Gem version'
+    def version
+      puts VERSION
+    end
+
     private
 
     def client
-      @client ||= CanvasAPI::Client.new(api_key: ENV['CANVAS_API_KEY'], host: ENV['CANVAS_API_PATH'])
+      @client ||=
+        CanvasAPI::Client.new(
+          api_key: ENV['CANVAS_API_KEY'],
+          host: ENV['CANVAS_API_PATH'],
+        )
     end
   end
 end

data/lib/github_to_canvas_quiz/model/answer/fill_in_multiple_blanks.rb

@@ -4,7 +4,7 @@ module GithubToCanvasQuiz
   module Model
     module Answer
       class FillInMultipleBlanks
-        attr_accessor :title, :text, :comments, :blank_id
+        attr_accessor :id, :title, :text, :comments, :blank_id
 
         def initialize(options)
           options.each do |key, value|
@@ -25,8 +25,9 @@ module GithubToCanvasQuiz
             'answer_text' => text,
             'answer_weight' => title == 'Correct' ? 100 : 0,
             'answer_comment_html' => comments,
-            'blank_id' => blank_id
-          }
+            'blank_id' => blank_id,
+            'id' => id
+          }.reject { |_,v| v.nil? }
         end
       end
     end

data/lib/github_to_canvas_quiz/model/answer/matching.rb

@@ -4,7 +4,7 @@ module GithubToCanvasQuiz
   module Model
     module Answer
       class Matching
-        attr_accessor :title, :text, :comments, :left, :right
+        attr_accessor :id, :title, :text, :comments, :left, :right
 
         def initialize(options)
           options.each do |key, value|
@@ -26,8 +26,9 @@ module GithubToCanvasQuiz
             'answer_weight' => 100,
             'answer_comment_html' => comments,
             'answer_match_left' => left,
-            'answer_match_right' => right
-          }
+            'answer_match_right' => right,
+            'id' => id
+          }.reject { |_,v| v.nil? }
         end
       end
     end

data/lib/github_to_canvas_quiz/model/answer/multiple_answers.rb

@@ -4,7 +4,7 @@ module GithubToCanvasQuiz
   module Model
     module Answer
       class MultipleAnswers
-        attr_accessor :title, :text, :comments
+        attr_accessor :id, :title, :text, :comments
 
         def initialize(options)
           options.each do |key, value|
@@ -24,8 +24,9 @@ module GithubToCanvasQuiz
           {
             'answer_html' => text,
             'answer_weight' => title == 'Correct' ? 100 : 0,
-            'answer_comment_html' => comments
-          }
+            'answer_comment_html' => comments,
+            'id' => id
+          }.reject { |_,v| v.nil? }
         end
       end
     end

data/lib/github_to_canvas_quiz/model/answer/multiple_choice.rb

@@ -4,7 +4,7 @@ module GithubToCanvasQuiz
   module Model
     module Answer
       class MultipleChoice
-        attr_accessor :title, :text, :comments
+        attr_accessor :id, :title, :text, :comments
 
         def initialize(options)
           options.each do |key, value|
@@ -24,8 +24,9 @@ module GithubToCanvasQuiz
           {
             'answer_html' => text,
             'answer_weight' => title == 'Correct' ? 100 : 0,
-            'answer_comment_html' => comments
-          }
+            'answer_comment_html' => comments,
+            'id' => id
+          }.reject { |_,v| v.nil? }
         end
       end
     end

data/lib/github_to_canvas_quiz/model/answer/multiple_dropdowns.rb

@@ -4,7 +4,7 @@ module GithubToCanvasQuiz
   module Model
     module Answer
       class MultipleDropdowns
-        attr_accessor :title, :text, :comments, :blank_id
+        attr_accessor :id, :title, :text, :comments, :blank_id
 
         def initialize(options)
           options.each do |key, value|
@@ -25,8 +25,9 @@ module GithubToCanvasQuiz
             'answer_text' => text,
             'answer_weight' => title == 'Correct' ? 100 : 0,
             'answer_comment_html' => comments,
-            'blank_id' => blank_id
-          }
+            'blank_id' => blank_id,
+            'id' => id
+          }.reject { |_,v| v.nil? }
         end
       end
     end

data/lib/github_to_canvas_quiz/model/answer/short_answer.rb

@@ -4,7 +4,7 @@ module GithubToCanvasQuiz
   module Model
     module Answer
       class ShortAnswer
-        attr_accessor :title, :text, :comments
+        attr_accessor :id, :title, :text, :comments
 
         def initialize(options)
           options.each do |key, value|
@@ -24,8 +24,9 @@ module GithubToCanvasQuiz
           {
             'answer_text' => text,
             'answer_weight' => title == 'Correct' ? 100 : 0,
-            'answer_comment_html' => comments
-          }
+            'answer_comment_html' => comments,
+            'id' => id
+          }.reject { |_,v| v.nil? }
         end
       end
     end

data/lib/github_to_canvas_quiz/model/answer/true_false.rb

@@ -4,7 +4,7 @@ module GithubToCanvasQuiz
   module Model
     module Answer
       class TrueFalse
-        attr_accessor :title, :text, :comments
+        attr_accessor :id, :title, :text, :comments
 
         def initialize(options)
           options.each do |key, value|
@@ -24,8 +24,9 @@ module GithubToCanvasQuiz
           {
             'answer_text' => text,
             'answer_weight' => title == 'Correct' ? 100 : 0,
-            'answer_comment_html' => comments
-          }
+            'answer_comment_html' => comments,
+            'id' => id
+          }.reject { |_,v| v.nil? }
         end
       end
     end

data/lib/github_to_canvas_quiz/synchronizer/quiz.rb

@@ -48,14 +48,37 @@ module GithubToCanvasQuiz
 
       # Get question data from Markdown files and return a Model::Question along with its path
       def parse_questions_with_path
+        # read Canvas question data
+        canvas_questions = client.list_questions(quiz.course_id, quiz.id)
+        
+        # read Markdown data
         Dir["#{path}/questions/*.md"].map do |question_path|
           question = Parser::Markdown::Question.new(File.read(question_path)).parse
           question.quiz_id = quiz.id
           question.course_id = quiz.course_id
+          
+          # find the matching Canvas answer
+          canvas_question = canvas_questions.find { |canvas_question| canvas_question['id'] == question.id }
+          get_answer_ids!(question, canvas_question) if canvas_question
+
           [question, question_path] # need that question path... gotta be a better way!
         end
       end
 
+      def get_answer_ids!(question, canvas_question)
+        question.answers.each do |answer|
+          # match the markdown answer to the Canvas answer based on the answer text
+          canvas_answer = canvas_question['answers'].find do |canvas_answer|
+            if canvas_answer['html'].nil? || canvas_answer['html'].empty?
+              canvas_answer['text'] == answer.text
+            else
+              canvas_answer['html'] == answer.text
+            end
+          end
+          answer.id = canvas_answer['id'].to_i if canvas_answer
+        end
+      end
+
       # create or update quiz on Canvas
       def sync_quiz!
         if quiz.id

data/lib/github_to_canvas_quiz/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GithubToCanvasQuiz
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas-quiz
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ihollander
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: front_matter_parser