github-to-canvas-quiz 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92070ddfabd669585e03a0483a6c037285ede7ef273203b9f657ca2d8a31591a
-  data.tar.gz: 793083a3619e931c5a0f443186b851a30c62dcfc165e3c993ea418ba896b6506
+  metadata.gz: e555944c5bbb43ede1e842476996a905bacf1f923d16b61a1eb2940bf596d409
+  data.tar.gz: c21175afacb3f8ea41bda6ec0cf7b962a93b79c2dbcbf898a757941fe95f0156
 SHA512:
-  metadata.gz: 9ab93d1c07ccd0552abda64b9fcc7e5b1eb23f084f8386f1c6287531471858eb9887555799ea1c7c942b1a4216d04d0f2ced48b7d3502874c76fac04c6f1fc4c
-  data.tar.gz: 638e64bc77c6de8db38526556e35c9f2a9b84e7a74afed6be9d30b034761671418f0bf9e3f362f9064aa594122dea34f155251ca7b1921bf3c6f59a1dc123c8e
+  metadata.gz: 6a4e9b94994681e11f48e5d368fb9d55cad4c6a26697d91247341f5b6fd6385a5cdf00afbf943571380539e5deaf647a4476e73fd563629cf72cab1e711d4e99
+  data.tar.gz: eec67a66fdcfed1ada76c6cf1ed96169352ae03a998c1d2c5fa359e10d1b18dbcdba0b6de9c8f6d56eb97730a54a6b65915ba436f69e2b87f040d2bab9bb294a

data/README.md

@@ -1,24 +1,9 @@
 # GithubToCanvasQuiz
 
-
-A tool for resizing and uploading images to AWS S3.
+A tool maintaining Canvas quizzes as markdown files in GitHub.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'github-to-canvas-quiz'
-```
-
-And then execute:
-
-```console
-$ bundle install
-```
-
-Or install it yourself as:
-
 ```console
 $ gem install github-to-canvas-quiz
 ```
@@ -29,14 +14,17 @@ Interacting with the Canvas API requires that you have the following environment
 variables set:
 
 - `ENV['CANVAS_API_PATH']`
-  - The base URL for your institution's Canvas API (`https://flatironlearn.beta.instructure.com/api/v1`)
+  - The base URL for your institution's Canvas API
+    (`https://flatironlearn.beta.instructure.com/api/v1`)
 - `ENV['CANVAS_API_KEY']`
-  - Your [Canvas Access Token](https://canvas.instructure.com/doc/api/file.oauth.html#manual-token-generation)
+  - Your
+    [Canvas Access Token](https://canvas.instructure.com/doc/api/file.oauth.html#manual-token-generation)
 
 ## Usage
 
 This gem provides two key features via the CLI: backing up Canvas quizzes to
-markdown, and updating a Canvas quiz from an existing directory of markdown files.
+markdown, and updating a Canvas quiz from an existing directory of markdown
+files.
 
 ### Backup
 
@@ -72,10 +60,10 @@ git commits and the created tag, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/ihollander/flatiron-s3-uploader. This project is intended to
-be a safe, welcoming space for collaboration, and contributors are expected to
-adhere to the
-[code of conduct](https://github.com/ihollander/flatiron-s3-uploader/blob/main/CODE_OF_CONDUCT.md).
+https://github.com/learn-co-curriculum/github-to-canvas-quiz. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the
+[code of conduct](https://github.com/learn-co-curriculum/github-to-canvas-quiz/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -86,4 +74,4 @@ The gem is available as open source under the terms of the
 
 Everyone interacting in the FlatironS3Uploader project's codebases, issue
 trackers, chat rooms and mailing lists is expected to follow the
-[code of conduct](https://github.com/ihollander/flatiron-s3-uploader/blob/main/CODE_OF_CONDUCT.md).
+[code of conduct](https://github.com/learn-co-curriculum/github-to-canvas-quiz/blob/main/CODE_OF_CONDUCT.md).

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

@@ -22,16 +22,16 @@ module GithubToCanvasQuiz
       def initialize(client, path)
         path = File.expand_path(path)
         raise DirectoryNotFoundError unless Pathname(path).directory?
-
+        
         @client = client
         @path = path
         @repo = RepositoryInterface.new(path)
         @quiz = parse_quiz
-        @questions_with_path = parse_questions_with_path
+        @questions_with_path = parse_questions_with_path if @quiz.id
       end
 
       def sync
-        backup_canvas_to_json!
+        backup_canvas_to_json! if @quiz.id
         sync_quiz!
         sync_questions!
         backup_canvas_to_json!
@@ -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
@@ -81,6 +104,8 @@ module GithubToCanvasQuiz
 
       # Create or update questions on Canvas
       def sync_questions!
+        @questions_with_path ||= parse_questions_with_path
+
         questions_with_path.each do |question_with_path|
           question, path = question_with_path
           if question.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.4'
 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.4
 platform: ruby
 authors:
 - ihollander
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: front_matter_parser