ams_migration 0.1.3

data/lib/ams_migration/services/new_quiz_learnosity_transformer.rb

@@ -0,0 +1,115 @@
+# 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 Services
+    class NewQuizLearnosityTransformer
+      attr_reader :root_account_uuid
+
+      def initialize(root_account_uuid:)
+        @root_account_uuid = root_account_uuid
+      end
+
+      def transform(quiz)
+        serialized = serialize_quiz_items(quiz[:quiz_items])
+
+        questions = convert_to_questions(quiz[:quiz_items], serialized)
+        features = {}
+        items = convert_to_items(quiz[:quiz_items], serialized)
+        activities = [convert_to_activity(quiz, serialized)]
+
+        {
+          activities:,
+          items:,
+          questions:,
+          features:
+        }
+      end
+
+      protected
+
+      def serialize_quiz_items(quiz_items)
+        quiz_items.to_h do |item|
+          converted = AmsMigration::CanvasQuizzes::NewQuizItemConverterFactory.create_converter(item).convert
+          [item[:id], converted]
+        end
+      end
+
+      def convert_to_questions(quiz_entries, serialized)
+        quiz_entries.filter_map do |quiz_entry|
+          converted = serialized[quiz_entry[:id]]
+          next unless supported?(converted)
+
+          # TODO: should we use quiz_entry.id or item.id? here.
+          # This really depends on how we want to share bank items because in learnosity sharing is done at the item level, not question level.
+          # It is unclear how this is going to work with AMS Item Service either.
+          # For now I am using quiz_entry.id
+          id = quiz_entry[:id]
+
+          {
+            "reference" => "q-#{nq_ls_id(id)}",
+            "type" => converted.dig(:question, :type),
+            "data" => converted[:question]
+          }
+        end
+      end
+
+      def convert_to_activity(wrapper, serialized_items)
+        quiz = wrapper[:quiz]
+        quiz_entries = wrapper[:quiz_items]
+        data = {
+          "items" => quiz_entries.select { |item| supported?(serialized_items[item[:id]]) }
+                                 .sort_by { |item| item[:position] }
+                                 .map { |item| "i-#{nq_ls_id(item[:id])}" }
+        }
+
+        {
+          "reference" => "a-#{nq_ls_id(quiz[:id])}",
+          "data" => data,
+          "title" => quiz[:title],
+          "tags" => item_tags(quiz[:id])
+        }
+      end
+
+      def convert_to_items(quiz_entries, serialized)
+        quiz_entries.filter_map do |quiz_entry|
+          converted = serialized[quiz_entry[:id]]
+          next unless supported?(converted)
+
+          title = converted[:title]
+          id = quiz_entry[:id]
+          {
+            "reference" => "i-#{nq_ls_id(id)}",
+            "title" => title,
+            "status" => "published",
+            "definition" => {
+              "widgets" => [
+                { "reference" => "q-#{nq_ls_id(id)}" }
+              ]
+            },
+            "tags" => item_tags(id)
+          }
+        end
+      end
+
+      def nq_ls_id(id)
+        "nq-#{root_account_uuid}-#{id}"
+      end
+
+      def supported?(converted)
+        question = converted[:question]
+
+        question.is_a?(Hash) && !question.empty? && question[:type] != "unsupported_canvas_question_type"
+      end
+
+      def item_tags(id)
+        [
+          { "type" => "import_original_id", "name" => id.to_s },
+          { "type" => "import_account_id", "name" => root_account_uuid.to_s },
+          { "type" => "import_system", "name" => "NQ" }
+        ]
+      end
+    end
+  end
+end

data/lib/ams_migration/version.rb

@@ -0,0 +1,3 @@
+module AmsMigration
+  VERSION = "0.1.3".freeze
+end

data/lib/ams_migration.rb

@@ -0,0 +1,45 @@
+require_relative "ams_migration/version"
+
+require "nokogiri"
+require "json"
+require "active_support/core_ext/hash"
+
+# Require base classes first
+require_relative "ams_migration/canvas/converter/classic_quiz/classic_question"
+require_relative "ams_migration/canvas/converter/classic_quiz/multiple_choice"
+
+require_relative "ams_migration/canvas/converter/new_quiz/new_question"
+require_relative "ams_migration/canvas/converter/new_quiz/multiple_choice"
+
+Dir[File.expand_path("ams_migration/canvas/converter/**/*.rb", __dir__)].each do |file|
+  next if file.end_with?("classic_question.rb", "new_question.rb", "multiple_choice.rb")
+
+  require_relative file
+end
+
+# Require factories
+Dir[File.expand_path("factories/*.rb", __dir__)].each do |file|
+  require_relative file
+end
+
+# require service classes
+Dir[File.expand_path("ams_migration/services/**/*.rb", __dir__)].each do |file|
+  require_relative file
+end
+
+module AmsMigration
+  class Error < StandardError; end
+
+  module Canvas
+    module Converter
+      module ClassicQuiz
+      end
+
+      module NewQuiz
+      end
+    end
+  end
+
+  module CanvasQuizzes
+  end
+end

data/lib/factories/classic_quiz_item_converter_factory.rb

@@ -0,0 +1,43 @@
+module AmsMigration
+  module CanvasQuizzes
+    # Factory that handles the Canvas Quiz to MC Question converter
+    # based on the Classic Quiz Item passed into the create_converter method.
+    class ClassicQuizItemConverterFactory
+      TYPE_FIELD = "question_type".freeze
+
+      def self.create_converter(item)
+        type = item[TYPE_FIELD]
+        question = item.to_json
+
+        case type
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::MULTI_CHOICE
+          AmsMigration::Canvas::Converter::ClassicQuiz::MultipleChoice.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::MULTIPLE_ANSWERS
+          AmsMigration::Canvas::Converter::ClassicQuiz::MultipleAnswer.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::MATCHING
+          AmsMigration::Canvas::Converter::ClassicQuiz::Matching.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::FILL_IN_BLANK
+          AmsMigration::Canvas::Converter::ClassicQuiz::FillInBlank.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::FILL_IN_MULTIPLE_BLANKS
+          AmsMigration::Canvas::Converter::ClassicQuiz::FillInMultipleBlanks.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::MULTIPLE_DROPDOWNS
+          AmsMigration::Canvas::Converter::ClassicQuiz::MultipleDropdown.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::TRUE_FALSE
+          AmsMigration::Canvas::Converter::ClassicQuiz::TrueFalse.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::NUMERICAL
+          AmsMigration::Canvas::Converter::ClassicQuiz::Numerical.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::TEXT_ONLY
+          AmsMigration::Canvas::Converter::ClassicQuiz::Text.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::CALCULATED
+          AmsMigration::Canvas::Converter::ClassicQuiz::Calculated.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::FILE_UPLOAD
+          AmsMigration::Canvas::Converter::ClassicQuiz::FileUpload.new(question)
+        when AmsMigration::Canvas::Converter::ClassicQuiz::ClassicQuestion::ESSAY
+          AmsMigration::Canvas::Converter::ClassicQuiz::Essay.new(question)
+        else
+          AmsMigration::Canvas::Converter::ClassicQuiz::Unknown.new(question)
+        end
+      end
+    end
+  end
+end

data/lib/factories/new_quiz_item_converter_factory.rb

@@ -0,0 +1,76 @@
+module AmsMigration
+  module CanvasQuizzes
+    # Factory that handles the Canvas Quiz to MC Question converter
+    # based on the New Quiz Item passed into the create_converter method.
+    class NewQuizItemConverterFactory
+      QUESTION_TYPE_KEY = "interaction_type_slug".freeze
+      ENTRY_TYPE_ITEM = "Item".freeze
+      ENTRY_TYPE_STIMULUS = "Stimulus".freeze
+      ENTRY_TYPE_BANK_ENTRY = "BankEntry".freeze
+      ENTRY_TYPE_BANK = "Bank".freeze
+
+      def self.create_converter(item)
+        item = normalize(item.dup.with_indifferent_access)
+        type = type_of(item)
+        question = item.to_json
+
+        case type
+        when "choice"
+          AmsMigration::Canvas::Converter::NewQuiz::MultipleChoice.new(question)
+        when "multi-answer"
+          AmsMigration::Canvas::Converter::NewQuiz::MultipleAnswer.new(question)
+        when "matching"
+          AmsMigration::Canvas::Converter::NewQuiz::Matching.new(question)
+        when "categorization"
+          AmsMigration::Canvas::Converter::NewQuiz::Categorization.new(question)
+        when "essay"
+          AmsMigration::Canvas::Converter::NewQuiz::Essay.new(question)
+        when "file-upload"
+          AmsMigration::Canvas::Converter::NewQuiz::FileUpload.new(question)
+        when "formula"
+          AmsMigration::Canvas::Converter::NewQuiz::Formula.new(question)
+        when "ordering"
+          AmsMigration::Canvas::Converter::NewQuiz::Ordering.new(question)
+        when "true-false"
+          AmsMigration::Canvas::Converter::NewQuiz::TrueFalse.new(question)
+        when "hot-spot"
+          AmsMigration::Canvas::Converter::NewQuiz::Hotspot.new(question)
+        when "rich-fill-blank"
+          AmsMigration::Canvas::Converter::NewQuiz::FillInBlank.new(question)
+        when "stimulus"
+          AmsMigration::Canvas::Converter::NewQuiz::Stimulus.new(question)
+        when "numeric"
+          AmsMigration::Canvas::Converter::NewQuiz::Numerical.new(question)
+        else
+          AmsMigration::Canvas::Converter::NewQuiz::Unknown.new(question)
+        end
+      end
+
+      def self.entry_type(item)
+        item["entry_type"]
+      end
+
+      def self.type_of(item)
+        entry_type_map = {
+          ENTRY_TYPE_ITEM => item["entry"]&.[](QUESTION_TYPE_KEY) || item[QUESTION_TYPE_KEY],
+          ENTRY_TYPE_STIMULUS => "stimulus",
+          ENTRY_TYPE_BANK => "BankItem Type" # Currently Unsupported, See MCE-23091
+        }
+
+        entry_type_map[entry_type(item)]
+      end
+
+      # We hardcoded converters based on the 'Item' and 'Stimulus' entry types. When the input is 'BankEntry',
+      # we need to modify the input to have the expected shape so that it can be passed into our converters.
+      def self.normalize(item)
+        return item unless entry_type(item) == ENTRY_TYPE_BANK_ENTRY
+
+        item["entry_type"] = item["entry"]["entry_type"]
+        item["entry"] = item["entry"]["entry"]
+        item
+      end
+
+      private_class_method :entry_type, :type_of, :normalize
+    end
+  end
+end

data/spec/fixtures/sample_data/classic_quiz/calculated.json

@@ -0,0 +1,24 @@
+{
+  "id": 603207,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251789,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "calculated_question",
+  "question_text": "<p></p>",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "<p>General comments</p>",
+  "answers": [],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": null,
+  "matching_answer_incorrect_matches": null
+}

data/spec/fixtures/sample_data/classic_quiz/essay.json

@@ -0,0 +1,24 @@
+{
+  "id": 603207,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251789,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "essay_question",
+  "question_text": "<p>This is an essay</p> <img src=\"https://dummyfileurl.com/file.png\" alt=\"file.png\" data-api-endpoint=\"https://dummyfileurl.com\" data-api-returntype=\"File\" />",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "<p>General comments</p>",
+  "answers": [],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": null,
+  "matching_answer_incorrect_matches": null
+}

data/spec/fixtures/sample_data/classic_quiz/file_upload.json

@@ -0,0 +1,24 @@
+{
+  "id": 603207,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251789,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "file_upload_question",
+  "question_text": "<p></p>",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "<p>General comments</p>",
+  "answers": [],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": null,
+  "matching_answer_incorrect_matches": null
+}

data/spec/fixtures/sample_data/classic_quiz/fill_in_bank.json

@@ -0,0 +1,24 @@
+{
+  "id": 603207,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251789,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "file_upload_question",
+  "question_text": "<p></p>",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "<p>General comments</p>",
+  "answers": [],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": null,
+  "matching_answer_incorrect_matches": null
+}

data/spec/fixtures/sample_data/classic_quiz/fill_in_blank.json

@@ -0,0 +1,53 @@
+{
+  "id": 603200,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251782,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "short_answer_question",
+  "question_text": "<p>This is the fill in the blank</p> <img src=\"https://dummyfileurl.com/file.png\" alt=\"file.png\" data-api-endpoint=\"https://dummyfileurl.com\" data-api-returntype=\"File\" />",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "",
+  "answers": [
+    {
+      "id": 8166,
+      "text": "answer 1",
+      "comments": "",
+      "comments_html": "<p>answer comment 1</p>",
+      "weight": 100
+    },
+    {
+      "id": 1101,
+      "text": "answer 2",
+      "comments": "",
+      "comments_html": "<p>answer comment 2</p>",
+      "weight": 100
+    },
+    {
+      "id": 4121,
+      "text": "answer 3",
+      "comments": "",
+      "comments_html": "<p>answer comment 3</p>",
+      "weight": 100
+    },
+    {
+      "id": 814,
+      "text": "answer 4",
+      "comments": "",
+      "comments_html": "<p>answer comment 4</p>",
+      "weight": 100
+    }
+  ],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": null,
+  "matching_answer_incorrect_matches": null
+}

data/spec/fixtures/sample_data/classic_quiz/fill_in_multiple_blanks.json

@@ -0,0 +1,57 @@
+{
+  "id": 603201,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251783,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "fill_in_multiple_blanks_question",
+  "question_text": "<p><span>Roses are [color1], violets are [color2]</span></p> <img src=\"https://dummyfileurl.com/file.png\" alt=\"file.png\" data-api-endpoint=\"https://dummyfileurl.com\" data-api-returntype=\"File\" />",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "",
+  "answers": [
+    {
+      "id": "6444",
+      "text": "red",
+      "comments": "",
+      "comments_html": "<p>red comments</p>",
+      "weight": 100,
+      "blank_id": "color1"
+    },
+    {
+      "id": "4936",
+      "text": "blue",
+      "comments": "",
+      "comments_html": "<p>blue comments</p>",
+      "weight": 100,
+      "blank_id": "color1"
+    },
+    {
+      "id": "9143",
+      "text": "green",
+      "comments": "",
+      "comments_html": "<p>green comments</p>",
+      "weight": 100,
+      "blank_id": "color2"
+    },
+    {
+      "id": "9387",
+      "text": "pink",
+      "comments": "",
+      "comments_html": "<p>pink comments</p>",
+      "weight": 100,
+      "blank_id": "color2"
+    }
+  ],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": null,
+  "matching_answer_incorrect_matches": null
+}

data/spec/fixtures/sample_data/classic_quiz/matching.json

@@ -0,0 +1,107 @@
+{
+  "id": 603204,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251786,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "matching_question",
+  "question_text": "<p>Matching question</p> <img src=\"https://dummyfileurl.com/file.png\" alt=\"file.png\" data-api-endpoint=\"https://dummyfileurl.com\" data-api-returntype=\"File\" />",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "",
+  "answers": [
+    {
+      "id": 1803,
+      "text": "",
+      "left": "",
+      "right": "",
+      "comments": "",
+      "comments_html": "",
+      "match_id": 3540
+    },
+    {
+      "id": 5931,
+      "text": "",
+      "left": "",
+      "right": "",
+      "comments": "",
+      "comments_html": "",
+      "match_id": 3540
+    },
+    {
+      "id": 6193,
+      "text": "L1",
+      "left": "L1",
+      "right": "R1",
+      "comments": "",
+      "comments_html": "",
+      "match_id": 3284
+    },
+    {
+      "id": 4501,
+      "text": "L2",
+      "left": "L2",
+      "right": "R2",
+      "comments": "",
+      "comments_html": "",
+      "match_id": 9849
+    },
+    {
+      "id": 2844,
+      "text": "L3",
+      "left": "L3",
+      "right": "R3",
+      "comments": "",
+      "comments_html": "",
+      "match_id": 4557
+    }
+  ],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": [
+    {
+      "text": "",
+      "match_id": 3540
+    },
+    {
+      "text": "R1",
+      "match_id": 3284
+    },
+    {
+      "text": "R2",
+      "match_id": 9849
+    },
+    {
+      "text": "R3",
+      "match_id": 4557
+    },
+    {
+      "text": "d1",
+      "match_id": 2385
+    },
+    {
+      "text": "d2",
+      "match_id": 8504
+    },
+    {
+      "text": "d3",
+      "match_id": 8560
+    },
+    {
+      "text": "d4",
+      "match_id": 6143
+    },
+    {
+      "text": "d5",
+      "match_id": 5727
+    }
+  ],
+  "matching_answer_incorrect_matches": "d1\nd2\nd3\nd4\nd5"
+}

data/spec/fixtures/sample_data/classic_quiz/multiple_answer.json

@@ -0,0 +1,48 @@
+{
+  "id": 603202,
+  "quiz_id": 70667,
+  "quiz_group_id": null,
+  "assessment_question_id": 1251784,
+  "position": null,
+  "question_name": "Question",
+  "question_type": "multiple_answers_question",
+  "question_text": "<p>Multiple answer text</p> <img src=\"https://dummyfileurl.com/file.png\" alt=\"file.png\" data-api-endpoint=\"https://dummyfileurl.com\" data-api-returntype=\"File\" />",
+  "points_possible": 1,
+  "correct_comments": "",
+  "incorrect_comments": "",
+  "neutral_comments": "",
+  "correct_comments_html": "",
+  "incorrect_comments_html": "",
+  "neutral_comments_html": "",
+  "answers": [
+    {
+      "id": "6739",
+      "text": "Answer 1",
+      "comments": "",
+      "comments_html": "<p>Answer 1 comments</p>",
+      "weight": 100,
+      "html": "<p>Answer 1</p>"
+    },
+    {
+      "id": "1316",
+      "text": "Answer 2",
+      "comments": "",
+      "comments_html": "<p>Answer 2 comments</p>",
+      "weight": 100,
+      "html": "<p>Answer 2</p>"
+    },
+    {
+      "id": "6779",
+      "text": "Answer 3",
+      "comments": "",
+      "comments_html": "<p>Answer 3 comments</p>",
+      "weight": 0
+    }
+  ],
+  "variables": null,
+  "formulas": null,
+  "answer_tolerance": null,
+  "formula_decimal_places": null,
+  "matches": null,
+  "matching_answer_incorrect_matches": null
+}