senkyoshi 1.0.1 → 1.0.2

data/lib/senkyoshi/models/qti.rb

@@ -0,0 +1,215 @@
+require "senkyoshi/models/assignment_group"
+require "senkyoshi/models/assignment"
+require "senkyoshi/models/question"
+require "senkyoshi/models/resource"
+
+QTI_TYPE = {
+  "Test" => "Assessment",
+  "Survey" => "Survey",
+  "Pool" => "QuestionBank",
+}.freeze
+
+module Senkyoshi
+  class QTI < Resource
+    def self.from(data, pre_data)
+      type = data.at("bbmd_assessmenttype").text
+      qti_class = Senkyoshi.const_get QTI_TYPE[type]
+      qti = qti_class.new
+      qti.iterate_xml(data, pre_data)
+    end
+
+    def initialize
+      @title = ""
+      @description = ""
+      @quiz_type = ""
+      @points_possible = 0
+      @items = []
+      @group_name = ""
+      @workflow_state = "published"
+      @available = true
+    end
+
+    def iterate_xml(data, pre_data)
+      @group_name = pre_data[:category] || data.at("bbmd_assessmenttype").text
+      @id = pre_data[:assignment_id] || pre_data[:file_name]
+      @title = data.at("assessment").attributes["title"].value
+      @points_possible = data.at("qmd_absolutescore_max").text
+      set_assessment_details(pre_data)
+      @due_at = pre_data[:due_at]
+
+      description = data.at("presentation_material").
+        at("mat_formattedtext").text
+      instructions = data.at("rubric").
+        at("mat_formattedtext").text
+      @description = %{
+        #{description}
+        #{instructions}
+      }
+      @items = data.search("item").to_a
+      @items += get_quiz_pool_items(data.search("selection_ordering"))
+      self
+    end
+
+    def set_assessment_details(pre_data)
+      @time_limit = pre_data[:time_limit]
+      @allowed_attempts = pre_data[:allowed_attempts]
+      @allowed_attempts = -1 if pre_data[:unlimited_attempts] == "true"
+      @cant_go_back = pre_data[:cant_go_back]
+      @show_correct_answers = pre_data[:show_correct_answers]
+      if pre_data[:access_code] && !pre_data[:access_code].empty?
+        @access_code = pre_data[:access_code]
+      end
+      if pre_data[:one_question_at_a_time] == "QUESTION_BY_QUESTION"
+        @one_question_at_a_time = "true"
+      else
+        @one_question_at_a_time = "false"
+      end
+    end
+
+    def get_quiz_pool_items(selection_order)
+      selection_order.flat_map do |selection|
+        weight = selection.previous.at("qmd_weighting").text
+        selection_number = selection.at("selection_number").text
+        item = {
+          weight: weight,
+          selection_number: selection_number,
+        }
+        if selection.at("sourcebank_ref")
+          sourcebank_ref = selection.at("sourcebank_ref").text
+          item[:file_name] = sourcebank_ref
+        elsif selection.at("or_selection")
+          questions = selection.search("selection_metadata").map(&:text)
+          item[:questions] = questions
+        end
+        item
+      end
+    end
+
+    def get_pre_data(xml, _)
+      {
+        original_file_name: xml.xpath("/COURSEASSESSMENT/
+          ASMTID/@value").first.text,
+        one_question_at_a_time: xml.xpath("/COURSEASSESSMENT/
+          DELIVERYTYPE/@value").first.text,
+        time_limit: xml.xpath("/COURSEASSESSMENT/
+          TIMELIMIT/@value").first.text,
+        access_code: xml.xpath("/COURSEASSESSMENT/
+          PASSWORD/@value").first.text,
+        allowed_attempts: xml.xpath("/COURSEASSESSMENT/
+          ATTEMPTCOUNT/@value").first.text,
+        unlimited_attempts: xml.xpath("/COURSEASSESSMENT/
+          FLAGS/ISUNLIMITEDATTEMPTS/@value").first.text,
+        cant_go_back: xml.xpath("/COURSEASSESSMENT/
+          FLAGS/ISBACKTRACKPROHIBITED/@value").first.text,
+        show_correct_answers: xml.xpath("/COURSEASSESSMENT/
+          FLAGS/SHOWCORRECTANSWER/@value").first.text,
+      }
+    end
+
+    def canvas_conversion(course, resources)
+      assessment = CanvasCc::CanvasCC::Models::Assessment.new
+      assessment.identifier = @id
+      course = create_assignment_group(course, resources)
+      assignment = create_assignment
+      assignment.quiz_identifier_ref = assessment.identifier
+      course.assignments << assignment
+      assessment = setup_assessment(assessment, assignment, resources)
+      assessment = create_items(course, assessment, resources)
+      course.assessments << assessment
+      course
+    end
+
+    def setup_assessment(assessment, assignment, resources)
+      assessment.title = @title
+      assessment.description = fix_html(@description, resources)
+      if @items.count.zero?
+        assessment.description +=
+          "Empty Quiz -- No questions were contained in the blackboard quiz"
+      end
+      assessment.available = @available
+      assessment.quiz_type = @quiz_type
+      assessment.points_possible = @points_possible
+      assessment.time_limit = @time_limit
+      assessment.access_code = @access_code
+      assessment.allowed_attempts = @allowed_attempts
+      assessment.cant_go_back = @cant_go_back
+      assessment.show_correct_answers = @show_correct_answers
+      assessment.one_question_at_a_time = @one_question_at_a_time
+      if @due_at && !@due_at.empty?
+        assessment.due_at = Time.strptime(@due_at, "%Y-%m-%d %H:%M:%S %z")
+      end
+      assessment.assignment = assignment
+      assessment
+    end
+
+    def create_items(course, assessment, resources)
+      questions = get_questions(course)
+      assessment.items = []
+      questions.each do |item|
+        if canvas_module?(item)
+          assessment.items << item
+        else
+          assessment.items << item.canvas_conversion(assessment, resources)
+        end
+      end
+      assessment
+    end
+
+    def get_questions(course)
+      @items = @items - ["", nil]
+      @items.flat_map do |item|
+        if !item[:selection_number]
+          Question.from(item)
+        else
+          get_question_group(course, item)
+        end
+      end
+    end
+
+    def canvas_module?(item)
+      item.is_a? CanvasCc::CanvasCC::Models::QuestionGroup
+    end
+
+    def get_question_group(course, item)
+      if item[:questions]
+        questions = course.question_banks.flat_map(&:questions)
+        canvas_questions = item[:questions].flat_map do |question|
+          questions.detect { |q| q.original_identifier == question }
+        end.compact
+      end
+      question_group = CanvasCc::CanvasCC::Models::QuestionGroup.new
+      question_group.identifier = Senkyoshi.create_random_hex
+      question_group.title = "Question Group"
+      question_group.selection_number = item[:selection_number]
+      question_group.questions = canvas_questions || []
+      question_group.sourcebank_ref = item[:file_name]
+      question_group.points_per_item = item[:weight]
+      question_group
+    end
+
+    def create_assignment_group(course, resources)
+      group = course.assignment_groups.detect { |a| a.title == @group_name }
+      if group
+        @group_id = group.identifier
+      else
+        @group_id = Senkyoshi.create_random_hex
+        assignment_group = AssignmentGroup.new(@group_name, @group_id)
+        course = assignment_group.canvas_conversion(course, resources)
+      end
+      course
+    end
+
+    def create_assignment
+      assignment = CanvasCc::CanvasCC::Models::Assignment.new
+      assignment.identifier = Senkyoshi.create_random_hex
+      assignment.assignment_group_identifier_ref = @group_id
+      assignment.title = @title
+      assignment.position = 1
+      assignment.submission_types << "online_quiz"
+      assignment.grading_type = "points"
+      assignment.workflow_state = @workflow_state
+      assignment.points_possible = @points_possible
+      assignment
+    end
+  end
+end

data/lib/senkyoshi/models/question.rb

@@ -81,9 +81,10 @@ module Senkyoshi
       self
     end
 
-    def canvas_conversion(assessment, resources)
+    def canvas_conversion(_, resources)
       @question.identifier = Senkyoshi.create_random_hex
       @question.title = @title
+      @question.original_identifier = @original_identifier
       @question.points_possible = @points_possible
       @question.material = fix_html(@material, resources)
       @question.general_feedback = fix_html(@general_feedback, resources)
@@ -97,8 +98,7 @@ module Senkyoshi
       @answers.each do |answer|
         @question = answer.canvas_conversion(@question, resources)
       end
-      assessment.items << @question
-      assessment
+      @question
     end
 
     def get_fraction(answer_text)

data/lib/senkyoshi/models/question_bank.rb

@@ -0,0 +1,46 @@
+require "senkyoshi/models/qti"
+
+module Senkyoshi
+  class QuestionBank < QTI
+    def canvas_conversion(course, resources)
+      question_bank = CanvasCc::CanvasCC::Models::QuestionBank.new
+      question_bank.identifier = @id
+      question_bank.title = @title
+      question_bank = setup_question_bank(question_bank, resources)
+      course.question_banks << question_bank
+      course
+    end
+
+    def setup_question_bank(question_bank, resources)
+      if @items.count.zero?
+        question_bank.description += "Empty Quiz -- No questions
+          were contained in the blackboard quiz bank"
+      end
+      question_bank = create_items(question_bank, resources)
+      question_bank
+    end
+
+    def create_items(question_bank, resources)
+      @items = @items - ["", nil]
+      questions = @items.map do |item|
+        Question.from(item)
+      end
+      question_bank.questions = []
+      questions.each do |item|
+        question = item.canvas_conversion(question_bank, resources)
+        question.material = clean_up_material(question)
+        question_bank.questions << question
+      end
+      question_bank
+    end
+
+    # This is to remove the random extra <p>.</p> included in the
+    # description that is just randomly there
+    def clean_up_material(question)
+      tag = "<p><span size=\"2\" style=\"font-size: small;\">.</span></p>"
+      question.material.gsub!(tag, "")
+      question.material.gsub!("<p>.</p>", "")
+      question.material.strip!
+    end
+  end
+end

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

@@ -4,7 +4,9 @@ module Senkyoshi
   class FillInBlank < Question
     def iterate_xml(data)
       super
-      conditionvar = data.at("resprocessing").at("conditionvar")
+      if data.at("resprocessing")
+        conditionvar = data.at("resprocessing").at("conditionvar")
+      end
       # not all fill in the blank questions have answers(ie: surveys)
       if conditionvar
         answer = Answer.new(conditionvar.at("varequal").text)

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

@@ -4,7 +4,9 @@ module Senkyoshi
   class FillInBlankPlus < Question
     def iterate_xml(data)
       super
-      conditionvar = data.at("resprocessing").at("conditionvar")
+      if data.at("resprocessing")
+        conditionvar = data.at("resprocessing").at("conditionvar")
+      end
       # not all fill in the blank questions have answers(ie: surveys)
       if conditionvar
         conditionvar.at("and").children.each do |or_child|

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

@@ -6,6 +6,7 @@ module Senkyoshi
       super
       @matches = []
       @matching_answers = {}
+      @distractors = []
     end
 
     def iterate_xml(data)
@@ -13,10 +14,11 @@ module Senkyoshi
       resprocessing = data.at("resprocessing")
       @matching_answers = set_matching_answers(resprocessing)
       matches_array = []
+      answers = []
       if match_block = data.at("flow[@class=RIGHT_MATCH_BLOCK]")
-        matches_array = match_block.children.map do |match|
-          match.at("mat_formattedtext").text
-        end
+        matches_array = match_block.
+          search("flow[@class=FORMATTED_TEXT_BLOCK]").
+          map(&:text)
       end
       if response_block = data.at("flow[@class=RESPONSE_BLOCK]")
         response_block.children.each do |response|
@@ -30,14 +32,17 @@ module Senkyoshi
               answer = matches_array[index]
             end
           end
+          answers << answer
           @matches << { id: id, question_text: question, answer_text: answer }
         end
       end
+      @distractors = matches_array.reject { |i| answers.include?(i) }
       self
     end
 
     def canvas_conversion(assessment, _resources = nil)
       @question.matches = @matches
+      @question.distractors = @distractors
       super
     end
 

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

@@ -16,5 +16,17 @@ module Senkyoshi
       end
       self
     end
+
+    def get_fraction(answer_text)
+      if @correct_answers && answer_text == @correct_answers["name"]
+        if @correct_answers["fraction"].to_f == 0.0
+          1.0
+        else
+          @correct_answers["fraction"].to_f
+        end
+      else
+        @incorrect_answers["fraction"].to_f
+      end
+    end
   end
 end

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

@@ -10,7 +10,10 @@ module Senkyoshi
 
     def iterate_xml(data)
       super
-      conditionvar = data.at("resprocessing").at("conditionvar")
+      if data.at("resprocessing")
+        conditionvar = data.at("resprocessing").at("conditionvar")
+      end
+
       if conditionvar
         range = CanvasCc::CanvasCC::Models::Range.new
         range.low_range = conditionvar.at("vargte").text.to_i

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

@@ -8,7 +8,7 @@ module Senkyoshi
       set_answers(data.at("resprocessing"))
       answers_array.each do |answer_text|
         answer = Answer.new(answer_text)
-        answer.fraction = get_fraction(answer_text)
+        answer.fraction = get_fraction(answer_text.to_s)
         @answers.push(answer)
       end
       self

data/lib/senkyoshi/models/resource.rb

@@ -1,5 +1,7 @@
 module Senkyoshi
   class Resource
+    def cleanup; end
+
     def fix_html(contents, resources)
       if contents && contents.respond_to?(:empty?) && !contents.empty?
         node_html = Nokogiri::HTML.fragment(contents)
@@ -20,12 +22,12 @@ module Senkyoshi
     def _search_and_replace(resources, node_html, tag, attr)
       node_html.search(tag).each do |element|
         original_src = element[attr]
-        xid = original_src.split("/").last
-        file_resource = resources.detect_xid(xid)
-
-        if file_resource
-          name = file_resource.name
-          element[attr] = "#{BASE}/#{IMPORTED_FILES_DIRNAME}/#{name}"
+        if original_src
+          xid = original_src.split("/").last
+          file_resource = resources.detect_xid(xid)
+          if file_resource
+            element[attr] = "#{BASE}/#{file_resource.path}"
+          end
         end
       end
     end

data/lib/senkyoshi/models/scorm_package.rb

@@ -1,52 +1,70 @@
 module Senkyoshi
   class ScormPackage
-    attr_accessor(:entries, :manifest)
+    attr_accessor(:entries, :manifest, :points_possible)
 
-    ##
-    # Scorm packages should include this string in the <schema> tag. We
-    # downcase, and remove spaces before checking to see if a manifest contains
-    # this schema to determine whether or not it belongs to a scorm package
-    ##
-    SCORM_SCHEMA = "adlscorm".freeze
-
-    def initialize(zip_file, manifest)
+    def initialize(zip_file, manifest, scorm_item = nil)
       @manifest = manifest
       @entries = ScormPackage.get_entries zip_file, manifest
+      @points_possible = if scorm_item
+                           scorm_item.xpath(
+                             "/scormItem/gradebookInfo/@pointsPossible",
+                           ).text
+                         end
+    end
+
+    ##
+    # Extracts scorm packages from a blackboard export zip file
+    ##
+    def self.get_scorm_packages(blackboard_export)
+      find_scorm_items(blackboard_export).
+        map do |item|
+          manifest_entry = find_scorm_manifest(blackboard_export, item)
+          ScormPackage.new blackboard_export, manifest_entry, item
+        end
     end
 
     ##
-    # Returns true if a manifest is a scorm manifest file, false otherwise
-    ##
-    def self.scorm_manifest?(manifest)
-      parsed_manifest = Nokogiri::XML(manifest.get_input_stream.read)
-      schema_name = parsed_manifest.
-        xpath("//xmlns:metadata/xmlns:schema").
-        text.delete(" ").downcase
-      return schema_name == SCORM_SCHEMA
-    # NOTE we occasionally run into malformed manifest files
-    rescue Nokogiri::XML::XPath::SyntaxError => e
-      filename = manifest.zipfile
-      STDERR.puts "Malformed scorm manifest found: #{manifest} in #{filename}"
+    # Returns paths to scormItem files
+    ##
+    def self.find_scorm_item_paths(zip_file)
+      Nokogiri::XML.parse(
+        Senkyoshi.read_file(zip_file, "imsmanifest.xml"),
+      ).
+        xpath("//resource[@type='resource/x-plugin-scormengine']").
+        map { |r| r.xpath("./@bb:file").text }
+    rescue Exceptions::MissingFileError => e
+      if zip_file
+        STDERR.puts "Blackboard export manifest file missing: #{zip_file.name}"
+      end
       STDERR.puts e.to_s
-      false
+
+      []
     end
 
     ##
-    # Extracts scorm packages from a blackboard export zip file
+    # Returns array of parsed scormItem files
     ##
-    def self.get_scorm_packages(blackboard_export)
-      find_scorm_manifests(blackboard_export).map do |manifest|
-        ScormPackage.new blackboard_export, manifest
+    def self.find_scorm_items(zip_file)
+      find_scorm_item_paths(zip_file).map do |path|
+        Nokogiri::XML.parse Senkyoshi.read_file(zip_file, path)
       end
     end
 
+    ##
+    # Returns the zip file entry for the scorm package manifest, given
+    # a scormItem file
+    ##
+    def self.find_scorm_manifest(zip_file, scorm_item)
+      path = scorm_item.xpath("/scormItem/@mappedContentId").text
+      zip_file.get_entry("#{path}/imsmanifest.xml")
+    end
+
     ##
     # Returns array of all scorm manifest files inside of blackboard export
     ##
     def self.find_scorm_manifests(zip_file)
-      return [] if zip_file.nil?
-      zip_file.entries.select do |e|
-        File.fnmatch("*imsmanifest.xml", e.name) && scorm_manifest?(e)
+      find_scorm_items(zip_file).map do |scorm_item|
+        find_scorm_manifest(zip_file, scorm_item)
       end
     end
 
@@ -81,9 +99,9 @@ module Senkyoshi
     # location of temporary file
     ##
     def write_zip(export_name)
-      @@dir ||= Dir.mktmpdir
+      @dir ||= Dir.mktmpdir
       scorm_path = File.dirname @manifest.name
-      path = "#{@@dir}/#{export_name}"
+      path = "#{@dir}/#{export_name}"
       Zip::File.open path, Zip::File::CREATE do |zip|
         @entries.each do |entry|
           if entry.file?
@@ -101,9 +119,8 @@ module Senkyoshi
     ##
     # Removes all temp files if they exist
     ##
-    def self.cleanup
-      @@dir ||= nil
-      FileUtils.rm_r @@dir unless @@dir.nil?
+    def cleanup
+      FileUtils.rm_r @dir unless @dir.nil?
     end
   end
 end

data/lib/senkyoshi/models/staff_info.rb

@@ -1,20 +1,18 @@
 require "senkyoshi/models/resource"
+require "active_support/core_ext/string"
 
 module Senkyoshi
   class StaffInfo < Resource
     attr_reader(
       :id,
       :title,
-      :bio,
-      :name,
-      :email,
-      :phone,
-      :office_hours,
-      :office_address,
-      :home_page,
-      :image,
+      :entries,
     )
 
+    def initialize
+      @entries = []
+    end
+
     def parse_name(contact)
       parts = [
         contact.xpath("./NAME/FORMALTITLE/@value").text,
@@ -32,36 +30,56 @@ module Senkyoshi
 
     def iterate_xml(xml, _pre_data)
       contact = xml.xpath("//CONTACT")
-      @id = xml.xpath("//STAFFINFO/@id").text
-      @title = xml.xpath("//STAFFINFO/TITLE/@value").text
-      @bio = xml.xpath("//BIOGRAPHY/TEXT").text
-      @name = parse_name(contact)
-      @email = xml.xpath("//CONTACT/EMAIL/@value").text
-      @phone = xml.xpath("//CONTACT/PHONE/@value").text
-      @office_hours = xml.xpath("//OFFICE/HOURS/@value").text
-      @office_address = xml.xpath("//OFFICE/ADDRESS/@value").text
-      @home_page = xml.xpath("//HOMEPAGE/@value").text
-      @image = xml.xpath("//IMAGE/@value").text
+      @id ||= xml.xpath("//STAFFINFO/@id").text || Senkyoshi.create_random_hex
+      @title ||= xml.xpath("//STAFFINFO/TITLE/@value").text
+      bio = xml.xpath("//BIOGRAPHY/TEXT").text
+      name = parse_name(contact)
+      email = xml.xpath("//CONTACT/EMAIL/@value").text
+      phone = xml.xpath("//CONTACT/PHONE/@value").text
+      office_hours = xml.xpath("//OFFICE/HOURS/@value").text
+      office_address = xml.xpath("//OFFICE/ADDRESS/@value").text
+      home_page = xml.xpath("//HOMEPAGE/@value").text
+      image = xml.xpath("//IMAGE/@value").text
+
+      @entries << construct_body(
+        bio: bio,
+        name: name,
+        email: email,
+        phone: phone,
+        office_hours: office_hours,
+        office_address: office_address,
+        home_page: home_page,
+        image: image,
+      )
 
       self
     end
 
-    def construct_body
-      <<-HTML
-        <h3>#{@name}</h3>
-        <p>#{@bio}</p>
-        <ul>
-          <li>Email: #{@email}</li>
-          <li>Phone: #{@phone}</li>
-          <li>Office Hours: #{@office_hours}</li>
-          <li>Office Address: #{@office_address}</li>
-        </ul>
-      HTML
+    def append_str(body, str, var)
+      body << str if var && !var.empty?
+    end
+
+    def humanize(symbol)
+      symbol.to_s.humanize.titleize
+    end
+
+    def construct_body(opts)
+      body = "<div>"
+      append_str body, "<img src=#{opts[:image]}/>", opts[:image]
+      append_str body, "<h3>#{opts[:name]}</h3>", opts[:name]
+      append_str body, "<p>#{opts[:bio]}</p>", opts[:bio]
+
+      body << "<ul>"
+      [:email, :phone, :office_hours, :office_address, :home_page].each do |key|
+        append_str body, "<li>#{humanize(key)}: #{opts[key]}</li>", opts[key]
+      end
+      body << "</ul></div>"
+      body
     end
 
-    def canvas_conversion(course, _resources = nil)
+    def canvas_conversion(course, resources)
       page = CanvasCc::CanvasCC::Models::Page.new
-      page.body = construct_body
+      page.body = fix_html(@entries.join(" "), resources)
       page.identifier = @id
       page.page_name = @title.empty? ? "Contact" : @title
 

data/lib/senkyoshi/models/survey.rb

@@ -0,0 +1,10 @@
+require "senkyoshi/models/qti"
+
+module Senkyoshi
+  class Survey < QTI
+    def iterate_xml(data, pre_data)
+      @quiz_type = "graded_survey"
+      super
+    end
+  end
+end