github-to-canvas-quiz 0.1.0

data/lib/github_to_canvas_quiz/canvas_api/endpoints.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module CanvasAPI
+    module Endpoints
+      include Quizzes
+      include QuizQuestions
+    end
+  end
+end

data/lib/github_to_canvas_quiz/cli.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+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'
+    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
+      puts '✅ Done'
+    end
+
+    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...'
+      Synchronizer::Quiz.new(client, options[:directory]).sync
+      puts '✅ Done'
+    end
+
+    private
+
+    def client
+      @client ||= CanvasAPI::Client.new(api_key: ENV['CANVAS_API_KEY'], host: ENV['CANVAS_API_PATH'])
+    end
+  end
+end

data/lib/github_to_canvas_quiz/markdown_builder.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  # Custom DSL for building a Markdown string
+  class MarkdownBuilder
+    # Provides a custom DSL for building a Markdown string
+    # Usage:
+    #
+    #   MarkdownBuilder.build do |md|
+    #     md.h1('Hello')
+    #     md.ul('item 1', 'item 2')
+    #     md.blockquote('comment')
+    #   end
+    #
+    #   # => "# Hello\n\n- item 1\n- item 2\n\n> comment\n"
+    def self.build
+      raise ArgumentError, 'no block given' unless block_given?
+
+      builder = new
+      yield(builder)
+      builder.to_s
+    end
+
+    attr_accessor :blocks
+
+    def initialize
+      @blocks = []
+    end
+
+    # @return [String] markdown produced by joining all blocks
+    def to_s
+      "#{blocks.join("\n\n")}\n"
+    end
+
+    # Adds a frontmatter block
+    # @param hash [Hash] the data to covert to YAML for the frontmatter
+    def frontmatter(hash)
+      blocks << "#{hash.to_yaml.strip}\n---"
+    end
+
+    # Adds a H1 heading
+    # @param text [String] heading text
+    def h1(text)
+      blocks << "# #{text}"
+    end
+
+    # Adds a H2 heading
+    # @param text [String] heading text
+    def h2(text)
+      blocks << "## #{text}"
+    end
+
+    # Adds a paragraph
+    # @param text [String] paragraph text
+    def p(text)
+      blocks << escape(text)
+    end
+
+    # Adds a blockquote
+    # @param text [String] blockquote text
+    def blockquote(text)
+      text = text.gsub("\n", "\n> ")
+      blocks << "> #{text}"
+    end
+
+    # Adds multiple list items
+    # @param texts* [Strings] a list of text to convert to list items
+    def ul(*texts)
+      blocks << texts.map { |text| "- #{escape(text)}" }.join("\n")
+    end
+
+    # Adds a block of arbitrary markdown
+    # @param markdown [String] markdown string
+    def md(markdown)
+      blocks << markdown.strip
+    end
+
+    # TODO: This doesn't belong here...
+    def html_to_markdown(html)
+      ReverseMarkdown.convert(html, github_flavored: true).strip
+    end
+
+    private
+
+    # TODO: What needs escaping??
+    def escape(text)
+      text.gsub('_', '\_')
+    end
+  end
+end

data/lib/github_to_canvas_quiz/markdown_converter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  # Custom HTML renderer for Redcarpet, using Rouge for syntax highlighting
+  class HTMLRenderer < Redcarpet::Render::HTML
+    include Rouge::Plugins::Redcarpet
+  end
+
+  # Convert a string of Markdown to HTML using Redcarpet and Rouge.
+  #
+  # Useage:
+  #
+  #   MarkdownConverter.new("# Hello\n\nWorld\n").to_html
+  #   # => "<h1>Hello</h1>\n\n<p>World</p>\n"
+  class MarkdownConverter
+    attr_reader :options, :markdown
+
+    OPTIONS = {
+      tables: true,
+      autolink: true,
+      fenced_code_blocks: true,
+      disable_indented_code_blocks: true,
+      no_intra_emphasis: true
+    }.freeze
+
+    # @param [String] markdown The markdown to be converted
+    # @param [Hash] options Overrides the defaults for the [Redcarpet](https://github.com/vmg/redcarpet) gem
+    def initialize(markdown, options = {})
+      @options = OPTIONS.merge(options)
+      @markdown = markdown
+    end
+
+    # @return [String] the markdown converted to HTML
+    def to_html
+      Redcarpet::Markdown.new(renderer, options).render(markdown)
+    end
+
+    private
+
+    def renderer
+      HTMLRenderer.new(escape_html: true)
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    module Answer
+      class FillInMultipleBlanks
+        attr_accessor :title, :text, :comments, :blank_id
+
+        def initialize(options)
+          options.each do |key, value|
+            send("#{key}=", value) if respond_to?("#{key}=")
+          end
+        end
+
+        def to_markdown
+          MarkdownBuilder.build do |md|
+            md.h2(title)
+            md.ul(text, blank_id)
+            md.blockquote(md.html_to_markdown(comments)) unless comments.empty?
+          end
+        end
+
+        def to_h
+          {
+            'answer_text' => text,
+            'answer_weight' => title == 'Correct' ? 100 : 0,
+            'answer_comment_html' => comments,
+            'blank_id' => blank_id
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    module Answer
+      class Matching
+        attr_accessor :title, :text, :comments, :left, :right
+
+        def initialize(options)
+          options.each do |key, value|
+            send("#{key}=", value) if respond_to?("#{key}=")
+          end
+        end
+
+        def to_markdown
+          MarkdownBuilder.build do |md|
+            md.h2(title)
+            md.ul(left, right)
+            md.blockquote(md.html_to_markdown(comments)) unless comments.empty?
+          end
+        end
+
+        def to_h
+          {
+            'answer_text' => left,
+            'answer_weight' => 100,
+            'answer_comment_html' => comments,
+            'answer_match_left' => left,
+            'answer_match_right' => right
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    module Answer
+      class MultipleAnswers
+        attr_accessor :title, :text, :comments
+
+        def initialize(options)
+          options.each do |key, value|
+            send("#{key}=", value) if respond_to?("#{key}=")
+          end
+        end
+
+        def to_markdown
+          MarkdownBuilder.build do |md|
+            md.h2(title)
+            md.md(md.html_to_markdown(text))
+            md.blockquote(md.html_to_markdown(comments)) unless comments.empty?
+          end
+        end
+
+        def to_h
+          {
+            'answer_html' => text,
+            'answer_weight' => title == 'Correct' ? 100 : 0,
+            'answer_comment_html' => comments
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    module Answer
+      class MultipleChoice
+        attr_accessor :title, :text, :comments
+
+        def initialize(options)
+          options.each do |key, value|
+            send("#{key}=", value) if respond_to?("#{key}=")
+          end
+        end
+
+        def to_markdown
+          MarkdownBuilder.build do |md|
+            md.h2(title)
+            md.md(md.html_to_markdown(text))
+            md.blockquote(md.html_to_markdown(comments)) unless comments.empty?
+          end
+        end
+
+        def to_h
+          {
+            'answer_html' => text,
+            'answer_weight' => title == 'Correct' ? 100 : 0,
+            'answer_comment_html' => comments
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    module Answer
+      class MultipleDropdowns
+        attr_accessor :title, :text, :comments, :blank_id
+
+        def initialize(options)
+          options.each do |key, value|
+            send("#{key}=", value) if respond_to?("#{key}=")
+          end
+        end
+
+        def to_markdown
+          MarkdownBuilder.build do |md|
+            md.h2(title)
+            md.ul(text, blank_id)
+            md.blockquote(md.html_to_markdown(comments)) unless comments.empty?
+          end
+        end
+
+        def to_h
+          {
+            'answer_text' => text,
+            'answer_weight' => title == 'Correct' ? 100 : 0,
+            'answer_comment_html' => comments,
+            'blank_id' => blank_id
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    module Answer
+      class ShortAnswer
+        attr_accessor :title, :text, :comments
+
+        def initialize(options)
+          options.each do |key, value|
+            send("#{key}=", value) if respond_to?("#{key}=")
+          end
+        end
+
+        def to_markdown
+          MarkdownBuilder.build do |md|
+            md.h2(title)
+            md.p(text)
+            md.blockquote(md.html_to_markdown(comments)) unless comments.empty?
+          end
+        end
+
+        def to_h
+          {
+            'answer_text' => text,
+            'answer_weight' => title == 'Correct' ? 100 : 0,
+            'answer_comment_html' => comments
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    module Answer
+      class TrueFalse
+        attr_accessor :title, :text, :comments
+
+        def initialize(options)
+          options.each do |key, value|
+            send("#{key}=", value) if respond_to?("#{key}=")
+          end
+        end
+
+        def to_markdown
+          MarkdownBuilder.build do |md|
+            md.h2(title)
+            md.p(text)
+            md.blockquote(md.html_to_markdown(comments)) unless comments.empty?
+          end
+        end
+
+        def to_h
+          {
+            'answer_text' => text,
+            'answer_weight' => title == 'Correct' ? 100 : 0,
+            'answer_comment_html' => comments
+          }
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/model/question.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    class Question
+      attr_accessor :course_id, :quiz_id, :id, :type, :sources, :name, :description, :answers, :distractors
+
+      def initialize(options)
+        options.each do |key, value|
+          send("#{key}=", value) if respond_to?("#{key}=")
+        end
+      end
+
+      def to_markdown
+        MarkdownBuilder.build do |md|
+          md.frontmatter(frontmatter_hash)
+          md.h1(name)
+          md.md(md.html_to_markdown(description))
+          answers.each do |answer|
+            md.md(answer.to_markdown)
+          end
+          unless distractors.empty?
+            md.h2('Incorrect')
+            md.ul(*distractors)
+          end
+        end
+      end
+
+      def to_h
+        {
+          'question_name' => name,
+          'question_text' => description,
+          'question_type' => type,
+          'points_possible' => 1,
+          'neutral_comments_html' => sources.nil? || sources.empty? ? '' : sources_to_html,
+          'answers' => answers.map(&:to_h),
+          'matching_answer_incorrect_matches' => distractors.join("\n")
+        }
+      end
+
+      def frontmatter_hash
+        {
+          'course_id' => course_id,
+          'quiz_id' => quiz_id,
+          'id' => id,
+          'type' => type,
+          'sources' => sources
+        }
+      end
+
+      private
+
+      def sources_to_html
+        comments = sources.map do |source|
+          "<a href=\"#{source['url']}\">#{source['name']}</a>"
+        end.join
+        "<p><strong>Source/s:</strong> #{comments}</p>"
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/model/quiz.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Model
+    class Quiz
+      attr_accessor :course_id, :id, :repo, :title, :description
+
+      def initialize(options)
+        options.each do |key, value|
+          send("#{key}=", value) if respond_to?("#{key}=")
+        end
+      end
+
+      def to_markdown
+        MarkdownBuilder.build do |md|
+          md.frontmatter(frontmatter_hash)
+          md.h1(title)
+          md.md(md.html_to_markdown(description))
+        end
+      end
+
+      def to_h
+        {
+          'title' => title,
+          'description' => description_with_header,
+          'quiz_type' => 'assignment',
+          'shuffle_answers' => true,
+          'hide_results' => 'until_after_last_attempt',
+          'show_correct_answers_last_attempt' => true,
+          'allowed_attempts' => 3,
+          'scoring_policy' => 'keep_highest',
+          'one_question_at_a_time' => true
+        }
+      end
+
+      def frontmatter_hash
+        {
+          'id' => id,
+          'course_id' => course_id,
+          'repo' => repo
+        }
+      end
+
+      private
+
+      def description_with_header
+        [git_links_header, description].reject(&:nil?).join("\n")
+      end
+
+      def git_links_header
+        return unless repo
+
+        <<~HTML
+          <div id='git-data-element' data-org='learn-co-curriculum' data-repo='#{repo}'></div>
+          <header class='fis-header'>
+            <a class='fis-git-link' href='https://github.com/learn-co-curriculum/#{repo}/issues/new' target='_blank' rel='noopener'><img id='issue-img' title='Create New Issue' alt='Create New Issue' /></a>
+          </header>
+        HTML
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class Base
+          include Helpers
+
+          attr_reader :data
+
+          def initialize(data)
+            @data = data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer/fill_in_multiple_blanks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class FillInMultipleBlanks < Base
+          def parse
+            Model::Answer::FillInMultipleBlanks.new(
+              title: title,
+              text: data['text'],
+              comments: comments,
+              blank_id: data['blank_id']
+            )
+          end
+
+          private
+
+          def title
+            data.fetch('weight', 0).positive? ? 'Correct' : 'Incorrect'
+          end
+
+          def comments
+            choose_text(data.fetch('comments', ''), data.fetch('comments_html', ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer/matching.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class Matching < Base
+          def parse
+            Model::Answer::Matching.new(
+              title: title,
+              text: data['text'],
+              comments: comments,
+              left: data['left'],
+              right: data['right']
+            )
+          end
+
+          private
+
+          def title
+            data['left'].empty? ? 'Incorrect' : 'Correct'
+          end
+
+          def comments
+            choose_text(data.fetch('comments', ''), data.fetch('comments_html', ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer/multiple_answers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class MultipleAnswers < Base
+          def parse
+            Model::Answer::MultipleAnswers.new(
+              title: title,
+              text: text,
+              comments: comments
+            )
+          end
+
+          private
+
+          def title
+            data.fetch('weight', 0).positive? ? 'Correct' : 'Incorrect'
+          end
+
+          def text
+            choose_text(data.fetch('text', ''), data.fetch('html', ''))
+          end
+
+          def comments
+            choose_text(data.fetch('comments', ''), data.fetch('comments_html', ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer/multiple_choice.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class MultipleChoice < Base
+          def parse
+            Model::Answer::MultipleChoice.new(
+              title: title,
+              text: text,
+              comments: comments
+            )
+          end
+
+          private
+
+          def title
+            data.fetch('weight', 0).positive? ? 'Correct' : 'Incorrect'
+          end
+
+          def text
+            choose_text(data.fetch('text', ''), data.fetch('html', ''))
+          end
+
+          def comments
+            choose_text(data.fetch('comments', ''), data.fetch('comments_html', ''))
+          end
+        end
+      end
+    end
+  end
+end