ams_migration 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1bf85b2c570c6df0426d11cf34c77a9e4dbe5ba464168e98f339f9bd440f93a7
+  data.tar.gz: dd39b8350b3a7925ebc5cb91a8ec296c964a381d12526f559d13822f104e3647
+SHA512:
+  metadata.gz: 7e768993b323305cdc1df07fb4f8635fe6c9871e0e43e4bfbf9930e95d0cc0b58c09935d4a6ce1e002722116e6dae800ffda728cea8458c1aa23ce3061640b09
+  data.tar.gz: 9fa668be4c9bf06ce1472469aa12c7258d8357f5d423c5f463cc33122f229c1d1471f6a87e0a179c7fed2f9fbbbdf73a49ce0fc3e7cc136605f1fa0114a1ef79

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Proprietary License – Limited Educational Use
+
+Copyright (C) 2025–present Instructure, Inc.
+
+This code is made publicly available for educational and reference purposes only.
+You may not copy, modify, distribute, or use this code in any software or service 
+without express written permission from Instructure, Inc.
+
+All rights reserved.

data/README.md

@@ -0,0 +1,33 @@
+# AMS Migration
+
+A collection of services to help with data migration tasks.
+
+NOTE: The code for the services was copied from the MasteryConnect and slightly adjusted. Refer to [MasteryConnect](https://github.com/instructure/mc-mothership) for the git history.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ams_migration'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ams_migration
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome.

data/lib/ams_migration/canvas/converter/classic_quiz/calculated.rb

@@ -0,0 +1,33 @@
+require_relative "../question_type"
+
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class Calculated < ClassicQuestion
+          # This question type will be skipped in the conversion process and the
+          # question will not be included in the quiz.  The JSON returned will be
+          # an essay question with text noting the question has been skipped.
+          def convert
+            super
+            {
+              question: {
+                stimulus: "The Calculated item was removed from the quiz because there is no equivalent item type in Mastery Connect.  Please check the original quiz for this question.",
+                type: QuestionType::UNSUPPORTED_CANVAS_TYPE,
+                validation: {
+                  valid_response: {
+                    score: 0,
+                    value: ""
+                  },
+                  scoring_type: "exactMatch"
+                },
+                is_math: true
+              },
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/classic_question.rb

@@ -0,0 +1,114 @@
+# Copyright (C) 2025 - present Instructure, Inc.
+# This code is made publicly available for educational and reference purposes only.
+# You may not copy, modify, redistribute, or use this code in any software or service without explicit permission.
+
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class ClassicQuestion
+          MULTI_CHOICE = "multiple_choice_question".freeze
+          TRUE_FALSE = "true_false_question".freeze
+          ESSAY = "essay_question".freeze
+          FILL_IN_BLANK = "short_answer_question".freeze
+          FILL_IN_MULTIPLE_BLANKS = "fill_in_multiple_blanks_question".freeze
+          MULTIPLE_ANSWERS = "multiple_answers_question".freeze
+          MULTIPLE_DROPDOWNS = "multiple_dropdowns_question".freeze
+          MATCHING = "matching_question".freeze
+          NUMERICAL = "numerical_question".freeze
+          TEXT_ONLY = "text_only_question".freeze
+          CALCULATED = "calculated_question".freeze
+          FILE_UPLOAD = "file_upload_question".freeze
+
+          attr_reader :notifications, :image_sources
+
+          def initialize(question)
+            @question_json = question
+            @question = nil
+            @converted_question = {}
+            @conversion_errors = []
+            @notifications = []
+            @image_sources = []
+          end
+
+          def title
+            @question[:question_name] || ""
+          end
+
+          def stimulus
+            @question[:question_text]
+          end
+
+          def convert
+            begin
+              @question = JSON.parse(@question_json).deep_symbolize_keys
+            rescue JSON::ParserError => e
+              @question = ""
+              @conversion_errors << e.message
+            end
+            {
+              question: @converted_question,
+              errors: @conversion_errors
+            }
+          end
+
+          def point_value
+            point_value = @question[:points_possible] || 0
+            if point_value % 1 != 0
+              @notifications << "Partial points are not supported.  After conversion points have been rounded to the nearest whole number."
+            end
+            point_value.round(0)
+          end
+
+          def post_convert
+            process_question_text
+          end
+
+          def process_question_text
+            if @converted_question.is_a?(Hash)
+              if @converted_question.key?(:stimulus)
+                @converted_question[:stimulus] = substitute_mathml(@converted_question[:stimulus])
+                update_image_sources(@converted_question[:stimulus])
+              end
+              if @converted_question.key?(:template)
+                @converted_question[:template] = substitute_mathml(@converted_question[:template])
+                update_image_sources(@converted_question[:template])
+              end
+
+              if @converted_question.key?(:options)
+                @converted_question[:options].each do |option|
+                  option[:label] = substitute_mathml(option[:label])
+                  update_image_sources(option[:label])
+                  option[:value] = substitute_mathml(option[:value])
+                  update_image_sources(option[:value])
+                end
+              end
+            else
+              @converted_question = substitute_mathml(@converted_question) unless @converted_question.nil?
+              update_image_sources(@converted_question) unless @converted_question.nil?
+            end
+          end
+
+          def substitute_mathml(fragment)
+            html = Nokogiri::HTML::DocumentFragment.parse(fragment, "UTF-8")
+            html.css("img.equation_image[x-canvaslms-safe-mathml]").each do |img|
+              img.replace(img.attr("x-canvaslms-safe-mathml"))
+            end
+            html.to_xhtml(indent: 0).delete("\n")
+          end
+
+          def update_image_sources(fragment)
+            html = Nokogiri::HTML::DocumentFragment.parse(fragment, "UTF-8")
+            html.css("img[data-api-endpoint]").each do |img|
+              @image_sources << img.attr("src")
+            end
+          end
+
+          def to_h
+            @question
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/essay.rb

@@ -0,0 +1,36 @@
+# Copyright (C) 2025 - present Instructure, Inc.
+# This code is made publicly available for educational and reference purposes only.
+# You may not copy, modify, redistribute, or use this code in any software or service without explicit permission.
+
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class Essay < ClassicQuestion
+          def convert
+            super
+            begin
+              @converted_question =
+                {
+                  stimulus:,
+                  type: "longtextV2",
+                  metadata: {
+                    rubric: "Rubric",
+                    rubric_points: point_value
+                  },
+                  is_math: true
+                }
+            rescue => e
+              @conversion_errors << e.message
+            end
+            post_convert
+            {
+              question: @converted_question,
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/file_upload.rb

@@ -0,0 +1,35 @@
+# Copyright (C) 2025 - present Instructure, Inc.
+# This code is made publicly available for educational and reference purposes only.
+# You may not copy, modify, redistribute, or use this code in any software or service without explicit permission.
+
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class FileUpload < ClassicQuestion
+          # This question type will be skipped in the conversion process and the
+          # question will not be included in the quiz.  The JSON returned will be
+          # an essay question with text noting the question has been skipped.
+          def convert
+            super
+            {
+              question: {
+                stimulus: "The File upload item was removed from the quiz because there is no equivalent item type in Mastery Connect.  Please check the original quiz for this question.",
+                type: QuestionType::UNSUPPORTED_CANVAS_TYPE,
+                validation: {
+                  valid_response: {
+                    score: 0,
+                    value: ""
+                  },
+                  scoring_type: "exactMatch"
+                },
+                is_math: true
+              },
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/fill_in_blank.rb

@@ -0,0 +1,63 @@
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class FillInBlank < ClassicQuestion
+          def correct_answer
+            @question[:answers][0][:text] ||= ""
+          end
+
+          def alternate_responses
+            @question[:answers].drop(1).map do |answer|
+              {
+                score: (answer[:weight] == 100) ? point_value : 0,
+                value: answer[:text] ||= ""
+              }
+            end
+          end
+
+          def distractors
+            distractors = []
+            has_distractors = false
+            @question[:answers].each do |answer|
+              distractor = answer[:comments_html] ||= ""
+              distractors << distractor
+              has_distractors = true if distractor != ""
+            end
+            has_distractors ? distractors : nil
+          end
+
+          def convert
+            super
+            begin
+              @converted_question = {
+                template: "#{stimulus}<br/>{{response}}",
+                type: "clozetext",
+                validation: {
+                  valid_response: {
+                    score: point_value,
+                    value: [correct_answer]
+                  },
+                  scoring_type: "exactMatch"
+                },
+                is_math: true
+              }
+
+              # distractors?
+              @converted_question[:metadata] = {
+                distractor_rationale_response_level: distractors
+              }
+            rescue => e
+              @conversion_errors << e.message
+            end
+            post_convert
+            {
+              question: @converted_question,
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/fill_in_multiple_blanks.rb

@@ -0,0 +1,111 @@
+# Copyright (C) 2025 - present Instructure, Inc.
+# This code is made publicly available for educational and reference purposes only.
+# You may not copy, modify, redistribute, or use this code in any software or service without explicit permission.
+
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class FillInMultipleBlanks < ClassicQuestion
+          def correct_answer
+            valid_values = {}
+            alternate_values = {}
+            ordered_templates = []
+            stimulus.scan(/\[.*?\]/).each_with_index do |template, _index|
+              template = template.delete("[").delete("]")
+              ordered_templates << template
+              @question[:answers].select { |answer| answer[:blank_id] == template }.each_with_index do |answer, index|
+                if index.zero? && answer[:text] && answer[:blank_id]
+                  if valid_values[answer[:blank_id]]
+                    valid_values[answer[:blank_id]] << answer[:text]
+                  else
+                    valid_values[answer[:blank_id]] = [answer[:text]]
+                  end
+                elsif answer[:text] && answer[:blank_id]
+                  if alternate_values[answer[:blank_id]]
+                    alternate_values[answer[:blank_id]] << answer[:text]
+                  else
+                    alternate_values[answer[:blank_id]] = [answer[:text]]
+                  end
+                end
+              end
+            end
+
+            valid_values.values.map(&:size).max
+
+            correct_values = ordered_templates.map do |template|
+              valid_values[template].first
+            end
+
+            valid_response = {
+              score: point_value,
+              value: correct_values
+            }
+
+            alternate_responses = []
+            max_answers = alternate_values.values.map(&:size).max
+            if max_answers
+              (0..(max_answers - 1)).each do |i|
+                alternate_response = ordered_templates.filter_map do |template|
+                  alternate_values&.dig(template, i)
+                end
+                alternate_responses << {
+                  score: 1,
+                  value: alternate_response
+                }
+              end
+            end
+            {
+              valid_response:,
+              alternate_responses:
+            }
+          end
+
+          def distractors
+            result = []
+            has_distractors = false
+            @question[:answers].each do |answer|
+              distractor = answer[:comments_html] ||= ""
+              result << distractor
+              has_distractors = true if distractor != ""
+            end
+            has_distractors ? result : nil
+          end
+
+          def convert
+            super
+            begin
+              correct_values = correct_answer
+
+              @converted_question = {
+                template: stimulus.gsub("[", "{{response}}").delete("]").to_s,
+                type: "clozetext",
+                validation: {
+                  valid_response: correct_values[:valid_response],
+                  scoring_type: "exactMatch",
+                  match_all_possible_responses: true
+                },
+                is_math: true
+              }
+
+              if correct_values[:alternate_responses].size.positive?
+                @converted_question[:validation][:alt_responses] = correct_values[:alternate_responses]
+              end
+
+              @converted_question[:metadata] = {
+                distractor_rationale_response_level: distractors
+              }
+            rescue => e
+              @conversion_errors << e.message
+            end
+            post_convert
+            {
+              question: @converted_question,
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/matching.rb

@@ -0,0 +1,66 @@
+# Copyright (C) 2025 - present Instructure, Inc.
+# This code is made publicly available for educational and reference purposes only.
+# You may not copy, modify, redistribute, or use this code in any software or service without explicit permission.
+
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class Matching < ClassicQuestion
+          def option_response_pairs
+            return @option_response_pairs if defined? @option_response_pairs
+
+            stimulus_list = []
+            possible_responses = []
+            correct_values = []
+            @question[:answers].each do |answer|
+              stimulus_list << answer[:text] ||= ""
+              @question[:matches].each do |match|
+                correct_values << match[:text] if answer[:match_id] == match[:match_id]
+              end
+            end
+
+            possible_responses += correct_values
+            if @question[:matching_answer_incorrect_matches].present?
+              incorrect_values = @question[:matching_answer_incorrect_matches].split("\n")
+              possible_responses += incorrect_values
+            end
+
+            @option_response_pairs = {
+              stimulus_list:,
+              possible_responses:,
+              correct_values:
+            }
+          end
+
+          def convert
+            super
+            begin
+              @converted_question = {
+                stimulus:,
+                possible_responses: option_response_pairs[:possible_responses],
+                stimulus_list: option_response_pairs[:stimulus_list],
+                type: "association",
+                validation: {
+                  valid_response: {
+                    score: point_value,
+                    value: option_response_pairs[:correct_values]
+                  },
+                  scoring_type: "exactMatch"
+                },
+                is_math: true
+              }
+            rescue => e
+              @conversion_errors << e.message
+            end
+            post_convert
+            {
+              question: @converted_question,
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/multiple_answer.rb

@@ -0,0 +1,27 @@
+# Copyright (C) 2025 - present Instructure, Inc.
+# This code is made publicly available for educational and reference purposes only.
+# You may not copy, modify, redistribute, or use this code in any software or service without explicit permission.
+
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class MultipleAnswer < MultipleChoice
+          def convert
+            begin
+              multiple_answer = super
+              multiple_answer[:question][:multiple_responses] = true if multiple_answer[:errors].empty?
+            rescue => e
+              @conversion_errors << e.message
+            end
+            post_convert
+            {
+              question: @converted_question,
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ams_migration/canvas/converter/classic_quiz/multiple_choice.rb

@@ -0,0 +1,57 @@
+module AmsMigration
+  module Canvas
+    module Converter
+      module ClassicQuiz
+        class MultipleChoice < ClassicQuestion
+          def to_h
+            @question
+          end
+
+          def options
+            @question[:answers].map do |answer|
+              label = answer[:text]
+              # html content will take precedence if present
+              label = answer[:html] if answer[:html].present?
+              {
+                label:,
+                value: answer[:id].to_s
+              }
+            end
+          end
+
+          def correct_answer
+            @question[:answers].filter_map do |answer|
+              answer[:id].to_s if answer[:weight] == 100
+            end
+          end
+
+          def convert
+            super
+            begin
+              @converted_question = {
+                stimulus:,
+                options:,
+                type: "mcq",
+                validation: {
+                  valid_response: {
+                    score: point_value,
+                    value: correct_answer
+                  },
+                  scoring_type: "exactMatch"
+                },
+                is_math: true
+              }
+            rescue => e
+              @conversion_errors << e.message
+            end
+            post_convert
+            {
+              question: @converted_question,
+              errors: @conversion_errors
+            }
+          end
+        end
+      end
+    end
+  end
+end