senkyoshi 1.0.0

data/lib/senkyoshi/models/content.rb

@@ -0,0 +1,92 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Content < Resource
+    CONTENT_TYPES = {
+      "x-bb-asmt-test-link" => "Quiz",
+      "x-bb-asmt-survey-link" => "Quiz",
+      "x-bb-assignment" => "Assignment",
+      "x-bbpi-selfpeer-type1" => "Assignment",
+      "x-bb-document" => "WikiPage",
+      "x-bb-file" => "WikiPage",
+      "x-bb-audio" => "WikiPage",
+      "x-bb-image" => "WikiPage",
+      "x-bb-video" => "WikiPage",
+      "x-bb-externallink" => "WikiPage",
+      "x-bb-blankpage" => "WikiPage",
+      "x-bb-lesson" => "WikiPage",
+      "x-bb-folder" => "WikiPage",
+      "x-bb-module-page" => "WikiPage",
+      "x-bb-lesson-plan" => "WikiPage",
+      "x-bb-syllabus" => "WikiPage",
+    }.freeze
+
+    attr_accessor(:title, :body, :id, :files)
+
+    def self.from(xml, pre_data)
+      type = xml.xpath("/CONTENT/CONTENTHANDLER/@value").first.text
+      type.slice! "resource/"
+      if content_type = CONTENT_TYPES[type]
+        content_class = Senkyoshi.const_get content_type
+        content = content_class.new
+        content.iterate_xml(xml, pre_data)
+      end
+    end
+
+    def iterate_xml(xml, pre_data)
+      @points = pre_data[:points] || 0
+      @title = xml.xpath("/CONTENT/TITLE/@value").first.text
+      @url = xml.at("URL")["value"]
+      @body = xml.xpath("/CONTENT/BODY/TEXT").first.text
+      @type = xml.xpath("/CONTENT/RENDERTYPE/@value").first.text
+      @parent_id = pre_data[:parent_id]
+      bb_type = xml.xpath("/CONTENT/CONTENTHANDLER/@value").first.text
+      bb_type.slice! "resource/"
+      @module_type = CONTENT_TYPES[bb_type]
+      @id = xml.xpath("/CONTENT/@id").first.text
+      if pre_data[:assignment_id] && !pre_data[:assignment_id].empty?
+        @id = pre_data[:assignment_id]
+      end
+      @module_item = set_module if @module_type
+      @files = xml.xpath("//FILES/FILE").map do |file|
+        ContentFile.new(file)
+      end
+      self
+    end
+
+    def get_pre_data(xml, file_name)
+      id = xml.xpath("/CONTENT/@id").first.text
+      parent_id = xml.xpath("/CONTENT/PARENTID/@value").first.text
+      {
+        id: id,
+        parent_id: parent_id,
+        file_name: file_name,
+      }
+    end
+
+    def set_module
+      @module_type = "Quizzes::Quiz" if @module_type == "Quiz"
+      module_item = ModuleItem.new(@title, @module_type, @id)
+      module_item.canvas_conversion
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      course
+    end
+
+    def create_module(course)
+      course.canvas_modules ||= []
+      cc_module = course.canvas_modules.
+        detect { |a| a.identifier == @parent_id }
+      if cc_module
+        cc_module.module_items << @module_item
+      else
+        cc_module = Module.new(@title, @parent_id)
+        cc_module = cc_module.canvas_conversion
+        cc_module.module_items << @module_item
+        course.canvas_modules << cc_module
+      end
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/content_file.rb

@@ -0,0 +1,26 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class ContentFile < Resource
+    attr_accessor(:id, :name, :linkname)
+
+    def initialize(xml)
+      @id = xml.xpath("./@id").first.text
+      @name = xml.xpath("./NAME").first.text
+      @linkname = xml.xpath("./LINKNAME/@value").first.text
+    end
+
+    def canvas_conversion(*)
+      query = "?canvas_download=1&amp;canvas_qs_wrap=1"
+      href = "$IMS_CC_FILEBASE$/#{IMPORTED_FILES_DIRNAME}/#{@linkname}#{query}"
+      %{
+        <a
+          class="instructure_scribd_file instructure_file_link"
+          title="#{@linkname}"
+          href="#{href}">
+          #{@linkname}
+        </a>
+      }
+    end
+  end
+end

data/lib/senkyoshi/models/course.rb

@@ -0,0 +1,39 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Course < Resource
+    ##
+    # This class represents a reader for one zip file, and allows the usage of
+    # individual files within zip file
+    ##
+    def initialize
+      @course_code = ""
+      @identifier = ""
+      @title = ""
+      @description = ""
+      @is_public = false
+      @start_at = ""
+      @conclude_at = ""
+    end
+
+    def iterate_xml(data, _)
+      @identifier = data["id"]
+      @title = Senkyoshi.get_attribute_value(data, "TITLE")
+      @description = Senkyoshi.get_description(data)
+      @is_public = Senkyoshi.get_attribute_value(data, "ISAVAILABLE")
+      @start_at = Senkyoshi.get_attribute_value(data, "COURSESTART")
+      @conclude_at = Senkyoshi.get_attribute_value(data, "COURSEEND")
+      self
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      course.identifier = @identifier
+      course.title = @title
+      course.description = @description
+      course.is_public = @is_public
+      course.start_at = @start_at
+      course.conclude_at = @conclude_at
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/file.rb

@@ -0,0 +1,99 @@
+require "senkyoshi/models/resource"
+require "senkyoshi/exceptions"
+
+module Senkyoshi
+  class SenkyoshiFile < Resource
+    attr_accessor(:id, :location, :name)
+    @@dir = nil
+
+    FILE_BLACKLIST = [
+      "*.dat",
+    ].freeze
+
+    def initialize(zip_entry)
+      path = zip_entry.name
+      id = File.basename(path)
+      xid = id[/__(xid-[0-9]+_[0-9]+)/, 1]
+      name = id.gsub(/__xid-[0-9]+_[0-9]+/, "")
+
+      @location = extract_file(zip_entry) # Location of file on local filesystem
+      @name = name
+      @id = id
+      @xid = xid
+    end
+
+    def matches_xid?(xid)
+      @xid == xid
+    end
+
+    def extract_file(entry)
+      @@dir ||= Dir.mktmpdir
+
+      name = "#{@@dir}/#{entry.name}"
+      path = File.dirname(name)
+      FileUtils.mkdir_p path unless Dir.exist? path
+      entry.extract(name)
+      name
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      file = CanvasCc::CanvasCC::Models::CanvasFile.new
+      file.identifier = @id
+      file.file_location = @location
+      file.file_path = "#{IMPORTED_FILES_DIRNAME}/#{@name}"
+      file.hidden = false
+
+      course.files << file
+      course
+    end
+
+    ##
+    # Remove temporary files
+    ##
+    def self.cleanup
+      FileUtils.rm_r @@dir unless @@dir.nil?
+    end
+
+    ##
+    # Determine if a file is on the blacklist
+    ##
+    def self.blacklisted?(file)
+      FILE_BLACKLIST.any? { |list_item| File.fnmatch?(list_item, file.name) }
+    end
+
+    ##
+    # Determine whether or not a file is a metadata file or not
+    ##
+    def self.metadata_file?(file_names, file)
+      if File.extname(file.name) == ".xml"
+        # Detect and skip metadata files.
+        concrete_file = File.join(
+          File.dirname(file.name),
+          File.basename(file.name, ".xml"),
+        )
+        file_names.include?(concrete_file)
+      else
+        false
+      end
+    end
+
+    ##
+    # Determine whether or not a file is a part of a scorm package
+    ##
+    def self.belongs_to_scorm_package?(package_paths, file)
+      package_paths.any? do |path|
+        File.dirname(file.name).start_with? path
+      end
+    end
+
+    ##
+    # Determine if a file should be included in course files or not
+    ##
+    def self.valid_file?(file_names, scorm_paths, file)
+      return false if SenkyoshiFile.blacklisted? file
+      return false if SenkyoshiFile.metadata_file? file_names, file
+      return false if SenkyoshiFile.belongs_to_scorm_package? scorm_paths, file
+      true
+    end
+  end
+end

data/lib/senkyoshi/models/forum.rb

@@ -0,0 +1,28 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Forum < Resource
+    def initialize
+      @title = ""
+      @text = ""
+      @identifier = Senkyoshi.create_random_hex
+      @discussion_type = "threaded"
+    end
+
+    def iterate_xml(data, _)
+      @title = Senkyoshi.get_attribute_value(data, "TITLE")
+      @text = Senkyoshi.get_text(data, "TEXT")
+      self
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      discussion = CanvasCc::CanvasCC::Models::Discussion.new
+      discussion.title = @title
+      discussion.text = @text
+      discussion.identifier = @identifier
+      discussion.discussion_type = @discussion_type
+      course.discussions << discussion
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/gradebook.rb

@@ -0,0 +1,30 @@
+module Senkyoshi
+  class Gradebook
+    def get_pre_data(data, _)
+      categories = get_categories(data)
+      data.search("OUTCOMEDEFINITIONS").children.map do |outcome|
+        content_id = outcome.at("CONTENTID").attributes["value"].value
+        assignment_id = outcome.at("ASIDATAID").attributes["value"].value
+        category_id = outcome.at("CATEGORYID").attributes["value"].value
+        category = categories[category_id]
+        points = outcome.at("POINTSPOSSIBLE").attributes["value"].value
+        {
+          category: category,
+          points: points,
+          content_id: content_id,
+          assignment_id: assignment_id,
+        }
+      end
+    end
+
+    def get_categories(data)
+      data.at("CATEGORIES").children.
+        each_with_object({}) do |category, categories|
+        id = category.attributes["id"].value
+        title = category.at("TITLE").
+          attributes["value"].value.gsub(".name", "")
+        categories[id] = title
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/group.rb

@@ -0,0 +1,22 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Group < Resource
+    def initialize
+      @name = ""
+      @description = ""
+      @is_public = true
+    end
+
+    def iterate_xml(data, _)
+      @name = Senkyoshi.get_attribute_value(data, "TITLE")
+      @description = data.at("TEXT").children.text
+      @is_public = Senkyoshi.get_attribute_value(data, "ISAVAILABLE")
+      self
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/module.rb

@@ -0,0 +1,22 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Module < Resource
+    attr_accessor :module_items
+
+    def initialize(title, identifier)
+      @identifier = identifier
+      @title = title
+      @module_items = []
+    end
+
+    def canvas_conversion(*)
+      CanvasCc::CanvasCC::Models::CanvasModule.new.tap do |cc_module|
+        cc_module.identifier = @identifier
+        cc_module.title = @title
+        cc_module.workflow_state = "published"
+        cc_module.module_items = @module_items
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/module_item.rb

@@ -0,0 +1,23 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class ModuleItem < Resource
+    def initialize(title, type, identifierref)
+      @title = title
+      @identifier = Senkyoshi.create_random_hex
+      @content_type = type
+      @identifierref = identifierref
+      @workflow_state = "active"
+    end
+
+    def canvas_conversion(*)
+      CanvasCc::CanvasCC::Models::ModuleItem.new.tap do |item|
+        item.title = @title
+        item.identifier = @identifier
+        item.content_type = @content_type
+        item.identifierref = @identifierref
+        item.workflow_state = @workflow_state
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/question.rb

@@ -0,0 +1,188 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Question < Resource
+    attr_reader :answers
+
+    QUESTION_TYPE = {
+      "True/False" => "true_false_question",
+      "Numeric" => "numerical_question",
+      "Multiple Choice" => "multiple_choice_question",
+      "Multiple Answer" => "multiple_answers_question",
+      "Matching" => "matching_question",
+      "Fill in the Blank" => "short_answer_question",
+      "Fill in the Blank Plus" => "fill_in_multiple_blanks_question",
+      "File Upload" => "file_upload_question",
+      "Essay" => "essay_question",
+      "Calculated" => "calculated_question",
+      "Jumbled Sentence" => "multiple_dropdowns_question",
+      "Either/Or" => "multiple_choice_question",
+      "Hot Spot" => "text_only_question",
+      "Opinion Scale" => "multiple_answers_question",
+      "Ordering" => "matching_question",
+      "Quiz Bowl" => "text_only_question",
+      "Short Response" => "essay_question",
+    }.freeze
+
+    ITEM_FUNCTION = {
+      "True/False" => "TrueFalse",
+      "Numeric" => "NumericalQuestion",
+      "Multiple Choice" => "MultipleChoice",
+      "Multiple Answer" => "MultipleAnswer",
+      "Matching" => "Matching",
+      "Fill in the Blank" => "FillInBlank",
+      "Fill in Multiple Blanks" => "FillInMultipleBlanks",
+      "Fill in the Blank Plus" => "FillInBlankPlus",
+      "File Upload" => "FileUpload",
+      "Essay" => "Essay",
+      "Calculated" => "Calculated",
+      "Jumbled Sentence" => "JumbledSentence",
+      "Either/Or" => "EitherOr",
+      "Hot Spot" => "HotSpot",
+      "Opinion Scale" => "OpinionScale",
+      "Ordering" => "Ordering",
+      "Quiz Bowl" => "QuizBowl",
+      "Short Response" => "ShortResponse",
+    }.freeze
+
+    def self.from(item)
+      type = item.at("bbmd_questiontype").children.text
+      item_class = Senkyoshi.const_get ITEM_FUNCTION[type]
+      question = item_class.new
+      question.iterate_xml(item)
+    end
+
+    def initialize
+      @original_identifier = ""
+      @question = nil
+      @question_type = ""
+      @points_possible = ""
+      @title = "Question"
+      @material = ""
+      @answers = []
+      @general_feedback = ""
+      @general_correct_feedback = ""
+      @general_incorrect_feedback = ""
+      @blackboard_type = ""
+      @correct_answers = {}
+      @incorrect_answers = {}
+      @max_score = 1
+    end
+
+    def iterate_xml(data)
+      @original_identifier = data.at("bbmd_asi_object_id").text
+      @blackboard_type = data.at("bbmd_questiontype").text
+      @question_type = QUESTION_TYPE[@blackboard_type]
+      @question = CanvasCc::CanvasCC::Models::Question.create(@question_type)
+      @points_possible = data.at("qmd_absolutescore_max").text
+      title = data.attributes["title"]
+      @title = title ? title.value : ""
+      iterate_item(data)
+      self
+    end
+
+    def canvas_conversion(assessment, resources)
+      @question.identifier = Senkyoshi.create_random_hex
+      @question.title = @title
+      @question.points_possible = @points_possible
+      @question.material = fix_html(@material, resources)
+      @question.general_feedback = fix_html(@general_feedback, resources)
+      @general_correct_feedback =
+        fix_html(@general_correct_feedback, resources)
+      @question.general_correct_feedback = @general_correct_feedback
+      @general_incorrect_feedback =
+        fix_html(@general_incorrect_feedback, resources)
+      @question.general_incorrect_feedback = @general_incorrect_feedback
+      @question.answers = []
+      @answers.each do |answer|
+        @question = answer.canvas_conversion(@question, resources)
+      end
+      assessment.items << @question
+      assessment
+    end
+
+    def get_fraction(answer_text)
+      if @correct_answers && answer_text == @correct_answers["name"]
+        @correct_answers["fraction"].to_f
+      else
+        @incorrect_answers["fraction"].to_f
+      end
+    end
+
+    def set_answers(resprocessing)
+      set_correct_answers(resprocessing)
+      set_incorrect_answers(resprocessing)
+    end
+
+    def set_correct_answers(resprocessing)
+      correct = resprocessing.at("respcondition[title=correct]")
+      if correct
+        if correct.at("varequal")
+          @correct_answers["name"] = correct.at("varequal").text
+        end
+        score = correct.at("setvar") ? correct.at("setvar").text : 0
+        score_number = score == "SCORE.max" ? @max_score.to_f : score.to_f
+        if score_number > 0
+          @correct_answers["fraction"] = score_number.to_f / @max_score.to_f
+        else
+          @correct_answers["fraction"] = 0
+        end
+      end
+    end
+
+    def set_incorrect_answers(resprocessing)
+      incorrect = resprocessing.at("respcondition[title=incorrect]")
+      if incorrect
+        if incorrect.at("varequal")
+          @incorrect_answers["name"] = incorrect.at("varequal").text
+        end
+        score = incorrect.at("setvar") ? incorrect.at("setvar").text : 0
+        score_number = score == "SCORE.max" ? @max_score.to_f : score.to_f
+        if score_number > 0
+          @incorrect_answers["fraction"] = score_number.to_f / @max_score.to_f
+        else
+          @incorrect_answers["fraction"] = 0
+        end
+      end
+    end
+
+    def iterate_item(data)
+      @general_correct_feedback = set_feedback(data, "correct")
+      @general_incorrect_feedback = set_feedback(data, "incorrect")
+      @material = set_material(data)
+      resprocessing = data.at("resprocessing")
+      @max_score = set_max_score(resprocessing)
+    end
+
+    def set_feedback(data, type)
+      feedback = data.at("itemfeedback[ident=#{type}]")
+      if feedback && feedback.at("mat_formattedtext")
+        feedback.at("mat_formattedtext").text
+      else
+        ""
+      end
+    end
+
+    def set_material(data)
+      if (question_block = data.at("flow[@class=QUESTION_BLOCK]"))
+        question_block.at("mat_formattedtext").text
+      else
+        ""
+      end
+    end
+
+    def set_max_score(resprocessing)
+      no_score = "0.0"
+      outcomes = resprocessing.at("outcomes")
+      if outcomes && !outcomes.at("decvar").nil?
+        if outcomes.at("decvar").attributes["maxvalue"]
+          outcomes.at("decvar").attributes["maxvalue"].value
+        else
+          no_score
+        end
+      else
+        no_score
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/questions/calculated.rb

@@ -0,0 +1,72 @@
+module Senkyoshi
+  class Calculated < Question
+    attr_reader :dataset_definitions, :var_sets
+
+    def initialize
+      @dataset_definitions = []
+      @var_sets = []
+      @correct_answer_length = 0
+      @correct_answer_format = 0
+      @tolerance = 0
+      super
+    end
+
+    def canvas_conversion(*)
+      @question.dataset_definitions = @dataset_definitions
+      @question.var_sets = @var_sets
+      @question.correct_answer_length = @correct_answer_length
+      @question.correct_answer_format = @correct_answer_format
+      @question.tolerance = @tolerance
+      super
+    end
+
+    def iterate_xml(data)
+      super
+      calculated_node = data.at("itemproc_extension > calculated")
+      math_ml = CGI.unescapeHTML(calculated_node.at("formula").text)
+      formula = Nokogiri::HTML(math_ml).text
+
+      answer = Answer.new(formula)
+      @answers.push(answer)
+
+      @tolerance = calculated_node.at("answer_tolerance").text
+      # canvas_cc only uses the correct_answer_length if the
+      # correct_answer_format is 1. It is not known what 1 represents.
+      @correct_answer_format = 1
+      @correct_answer_length = calculated_node.at("answer_scale").text
+
+      @dataset_definitions = _parse_vars(calculated_node.at("vars"))
+      @var_sets = _parse_var_sets(calculated_node.at("var_sets"))
+
+      self
+    end
+
+    def _parse_vars(parent_node)
+      parent_node.search("var").map do |var|
+        scale = var.attributes["scale"]
+        min = var.at("min").text
+        max = var.at("max").text
+        options = ":#{min}:#{max}:#{scale}"
+
+        {
+          name: var.attributes["name"].value,
+          options: options,
+        }
+      end
+    end
+
+    def _parse_var_sets(parent_node)
+      parent_node.search("var_set").map do |var_set|
+        vars = var_set.search("var").each_with_object({}) do |var, hash|
+          hash[var.attributes["name"].text] = var.text
+        end
+
+        {
+          ident: var_set.attributes["ident"].text,
+          answer: var_set.at("answer").text,
+          vars: vars,
+        }
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/questions/either_or.rb

@@ -0,0 +1,31 @@
+module Senkyoshi
+  class EitherOr < Question
+    EITHER_OR = {
+      "yes_no.true" => "Yes",
+      "yes_no.false" => "No",
+      "agree_disagree.true" => "Agree",
+      "agree_disagree.false" => "Disagree",
+      "right_wrong.true" => "Right",
+      "right_wrong.false" => "Wrong",
+      "true_false.true" => "True",
+      "true_false.false" => "False",
+    }.freeze
+
+    def initialize
+      super
+      @original_text = ""
+    end
+
+    def iterate_xml(data)
+      super
+      set_answers(data.at("resprocessing"))
+      data.at("flow_label").children.each do |response|
+        answer_text = response.at("mattext").text
+        answer = Answer.new(EITHER_OR[answer_text])
+        answer.fraction = get_fraction(answer_text)
+        @answers.push(answer)
+      end
+      self
+    end
+  end
+end

data/lib/senkyoshi/models/questions/essay.rb

@@ -0,0 +1,11 @@
+module Senkyoshi
+  class Essay < Question
+    def iterate_xml(data)
+      super
+      itemfeedback = data.at("itemfeedback[ident=solution]")
+      feedback = itemfeedback.at("mat_formattedtext").text
+      @general_feedback = feedback
+      self
+    end
+  end
+end