senkyoshi 1.0.0

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

@@ -0,0 +1,4 @@
+module Senkyoshi
+  class FileUpload < Question
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+module Senkyoshi
+  class FillInBlankPlus < Question
+    def iterate_xml(data)
+      super
+      conditionvar = data.at("resprocessing").at("conditionvar")
+      # not all fill in the blank questions have answers(ie: surveys)
+      if conditionvar
+        conditionvar.at("and").children.each do |or_child|
+          or_child.children.each do |varequal|
+            answer = Answer.new(varequal.text)
+            answer.resp_ident = varequal.attributes["respident"].value
+            answer.fraction = @max_score
+            @answers.push(answer)
+          end
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Senkyoshi
+  class HotSpot < Question
+    def iterate_xml(data)
+      super
+      @material = "#{@title} -- This question was imported from an
+        external source. It was a #{@blackboard_type} question, which
+        is not supported in this quiz tool."
+      self
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Senkyoshi
+  class JumbledSentence < Question
+    def initialize
+      @responses = []
+      super
+    end
+
+    def iterate_xml(data)
+      super
+      if response_block = data.at("flow[@class=RESPONSE_BLOCK]")
+        choices = []
+        response_block.at("flow_label").children.each do |response|
+          text = response.at("mattext").text
+          choices << { id: response.attributes["ident"], text: text }
+        end
+        set_answers(data.at("resprocessing"))
+        correct = data.at("respcondition[title=correct]")
+        correct.at("and").children.each do |answer_element|
+          id = answer_element.text
+          response_label = data.at("response_label[ident='#{id}']")
+          answer_text = response_label.at("mattext").text
+          answer = Answer.new(answer_text, id)
+          resp_ident = answer_element.attributes["respident"].value
+          answer.resp_ident = resp_ident
+          @responses << { id: resp_ident, choices: choices }
+          @answers.push(answer)
+        end
+      end
+      self
+    end
+
+    def canvas_conversion(assessment, _resources = nil)
+      @question.responses = @responses
+      super
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Senkyoshi
+  class Matching < Question
+    def initialize
+      super
+      @matches = []
+      @matching_answers = {}
+    end
+
+    def iterate_xml(data)
+      super
+      resprocessing = data.at("resprocessing")
+      @matching_answers = set_matching_answers(resprocessing)
+      matches_array = []
+      if match_block = data.at("flow[@class=RIGHT_MATCH_BLOCK]")
+        matches_array = match_block.children.map do |match|
+          match.at("mat_formattedtext").text
+        end
+      end
+      if response_block = data.at("flow[@class=RESPONSE_BLOCK]")
+        response_block.children.each do |response|
+          id = response.at("response_lid").attributes["ident"].value
+          question = response.at("mat_formattedtext").text
+          answer_id = @matching_answers[id]
+          answer = ""
+          flow_label = response.at("flow_label")
+          flow_label.children.each_with_index do |label, index|
+            if label.attributes["ident"].value == answer_id
+              answer = matches_array[index]
+            end
+          end
+          @matches << { id: id, question_text: question, answer_text: answer }
+        end
+      end
+      self
+    end
+
+    def canvas_conversion(assessment, _resources = nil)
+      @question.matches = @matches
+      super
+    end
+
+    def set_matching_answers(resprocessing)
+      matching_answers = {}
+      respcondition = resprocessing.css("respcondition")
+      respcondition.each do |condition|
+        if condition.attributes["title"] != "incorrect"
+          varequal = condition.at("varequal")
+          if varequal
+            id = varequal.attributes["respident"].value
+            matching_answers[id] = varequal.text
+          end
+        end
+      end
+      matching_answers
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module Senkyoshi
+  class MultipleAnswer < Question
+    def iterate_xml(data)
+      super
+      if response_block = data.at("flow[@class=RESPONSE_BLOCK]")
+        set_answers(data.at("resprocessing"))
+        response_block.at("render_choice").children.each do |choice|
+          id = choice.at("response_label").attributes["ident"].value
+          @answer_text = choice.at("mat_formattedtext").text
+          answer = Answer.new(@answer_text, id)
+          answer.fraction = get_fraction(id)
+          @answers.push(answer)
+        end
+      end
+      self
+    end
+
+    def set_answers(resprocessing)
+      @correct_answers = set_correct_answer(resprocessing)
+      @incorrect_answers = set_incorrect_answer(resprocessing)
+    end
+
+    def set_correct_answer(resprocessing)
+      correct_answers = {}
+      correct = resprocessing.at("respcondition[title=correct]")
+      if correct
+        correct.at("and").children.each do |answer|
+          if answer.name == "varequal"
+            id = answer.text
+            correct_answers[id] = {}
+            correct_answers[id]["name"] = id
+            if correct.at("setvar")
+              score = correct.at("setvar").text
+              score_number = score == "SCORE.max" ? @max_score.to_f : score.to_f
+              correct_answers[id]["fraction"] = score_number
+            else
+              correct_answers[id]["fraction"] = 0
+            end
+          end
+        end
+      end
+      correct_answers
+    end
+
+    def set_incorrect_answer(resprocessing)
+      incorrect = resprocessing.at("respcondition[ident=incorrect]")
+      incorrect_answers = {}
+      if incorrect && incorrect.at("setvar")
+        incorrect_answers["fraction"] = incorrect.at("setvar").text
+      else
+        incorrect_answers["fraction"] = 0
+      end
+      incorrect_answers
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Senkyoshi
+  class MultipleChoice < Question
+    def iterate_xml(data)
+      super
+      if response_block = data.at("flow[@class=RESPONSE_BLOCK]")
+        set_answers(data)
+        response_block.at("render_choice").children.each do |choice|
+          id = choice.at("response_label").attributes["ident"].value
+          answer_text = choice.at("mat_formattedtext").text
+          answer = Answer.new(answer_text, id)
+          answer.fraction = get_fraction(id)
+          @answers.push(answer)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Senkyoshi
+  class NumericalQuestion < Question
+    def initialize
+      @ranges = {}
+      @tolerances = {}
+      super
+    end
+
+    def iterate_xml(data)
+      super
+      conditionvar = data.at("resprocessing").at("conditionvar")
+      if conditionvar
+        range = CanvasCc::CanvasCC::Models::Range.new
+        range.low_range = conditionvar.at("vargte").text.to_i
+        range.high_range = conditionvar.at("varlte").text.to_i
+        answer_text = conditionvar.at("varequal").text.to_i
+        answer = Answer.new(answer_text)
+        @ranges[answer.id] = range
+        answer.fraction = @max_score
+        @answers.push(answer)
+      end
+      self
+    end
+
+    def canvas_conversion(assessment, _resources = nil)
+      @question.tolerances = @tolerances
+      @question.ranges = @ranges
+      super
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Senkyoshi
+  class OpinionScale < Question
+    def iterate_xml(data)
+      super
+      if response_block = data.at("flow[@class=RESPONSE_BLOCK]")
+        set_answers(data.at("resprocessing"))
+        response_block.at("render_choice").children.each do |choice|
+          id = choice.at("response_label").attributes["ident"].value
+          @answer_text = choice.at("mat_formattedtext").text
+          answer = Answer.new(@answer_text, id)
+          answer.fraction = get_fraction(id)
+          @answers.push(answer)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Senkyoshi
+  class Ordering < Question
+    def initialize
+      super
+      @matches = []
+      @order_answers = {}
+    end
+
+    def iterate_xml(data)
+      super
+      resprocessing = data.at("resprocessing")
+      @order_answers = set_order_answers(resprocessing)
+      if response_block = data.at("flow[@class=RESPONSE_BLOCK]")
+        response_block.at("render_choice").children.each do |choice|
+          id = choice.at("response_label").attributes["ident"].value
+          question = @order_answers[id].to_s
+          answer = choice.at("mat_formattedtext").text
+          @matches << { id: id, question_text: question, answer_text: answer }
+        end
+        @matches = @matches.sort_by { |hsh| hsh[:question_text] }
+      end
+      self
+    end
+
+    def canvas_conversion(assessment, _resources = nil)
+      @question.matches = @matches
+      super
+    end
+
+    def set_order_answers(resprocessing)
+      order_answers = {}
+      correct = resprocessing.at("respcondition[title=correct]")
+      correct.at("and").children.each_with_index do |varequal, index|
+        id = varequal.text
+        order_answers[id] = index + 1
+      end
+      order_answers
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Senkyoshi
+  class QuizBowl < Question
+    def iterate_xml(data)
+      super
+      @material = "#{@title} -- This question was imported from
+        an external source. It was a #{@blackboard_type} question,
+        which is not supported in this quiz tool."
+      self
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+module Senkyoshi
+  class ShortResponse < Question
+  end
+end

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

@@ -0,0 +1,15 @@
+module Senkyoshi
+  class TrueFalse < Question
+    def iterate_xml(data)
+      super
+      answers_array = [true, false]
+      set_answers(data.at("resprocessing"))
+      answers_array.each do |answer_text|
+        answer = Answer.new(answer_text)
+        answer.fraction = get_fraction(answer_text)
+        @answers.push(answer)
+      end
+      self
+    end
+  end
+end

data/lib/senkyoshi/models/quiz.rb

@@ -0,0 +1,7 @@
+module Senkyoshi
+  class Quiz < Content
+    def canvas_conversion(course, _resource)
+      create_module(course)
+    end
+  end
+end

data/lib/senkyoshi/models/resource.rb

@@ -0,0 +1,33 @@
+module Senkyoshi
+  class Resource
+    def fix_html(contents, resources)
+      if contents && contents.respond_to?(:empty?) && !contents.empty?
+        node_html = Nokogiri::HTML.fragment(contents)
+
+        _search_and_replace(resources, node_html, "a", "href")
+        _search_and_replace(resources, node_html, "img", "src")
+
+        node_html.to_s
+      else
+        contents
+      end
+    end
+
+    def matches_xid?(_xid)
+      false
+    end
+
+    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}"
+        end
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/scorm_package.rb

@@ -0,0 +1,109 @@
+module Senkyoshi
+  class ScormPackage
+    attr_accessor(:entries, :manifest)
+
+    ##
+    # 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)
+      @manifest = manifest
+      @entries = ScormPackage.get_entries zip_file, manifest
+    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}"
+      STDERR.puts e.to_s
+      false
+    end
+
+    ##
+    # Extracts scorm packages from a blackboard export zip file
+    ##
+    def self.get_scorm_packages(blackboard_export)
+      find_scorm_manifests(blackboard_export).map do |manifest|
+        ScormPackage.new blackboard_export, manifest
+      end
+    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)
+      end
+    end
+
+    ##
+    # Returns array of paths to scorm packages
+    ##
+    def self.find_scorm_paths(zip_file)
+      manifests = ScormPackage.find_scorm_manifests(zip_file)
+      manifests.map { |manifest| File.dirname(manifest.name) }
+    end
+
+    ##
+    # Returns array of all zip file entries that belong in scorm package
+    ##
+    def self.get_entries(zip_file, manifest)
+      zip_file.entries.select do |e|
+        File.dirname(e.name).start_with?(File.dirname(manifest.name)) &&
+          !e.directory?
+      end
+    end
+
+    ##
+    # Returns file path with relative path to scorm package removed
+    ##
+    def self.correct_path(path, scorm_path)
+      corrected = path.gsub(scorm_path, "")
+      corrected.slice(1, corrected.size) if corrected.start_with? "/"
+    end
+
+    ##
+    # Writes all entries to a zip file in a temporary directory and returns
+    # location of temporary file
+    ##
+    def write_zip(export_name)
+      @@dir ||= Dir.mktmpdir
+      scorm_path = File.dirname @manifest.name
+      path = "#{@@dir}/#{export_name}"
+      Zip::File.open path, Zip::File::CREATE do |zip|
+        @entries.each do |entry|
+          if entry.file?
+            zip.get_output_stream(
+              ScormPackage.correct_path(entry.name, scorm_path),
+            ) do |file|
+              file.write(entry.get_input_stream.read)
+            end
+          end
+        end
+      end
+      path
+    end
+
+    ##
+    # Removes all temp files if they exist
+    ##
+    def self.cleanup
+      @@dir ||= nil
+      FileUtils.rm_r @@dir unless @@dir.nil?
+    end
+  end
+end

data/lib/senkyoshi/models/staff_info.rb

@@ -0,0 +1,72 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class StaffInfo < Resource
+    attr_reader(
+      :id,
+      :title,
+      :bio,
+      :name,
+      :email,
+      :phone,
+      :office_hours,
+      :office_address,
+      :home_page,
+      :image,
+    )
+
+    def parse_name(contact)
+      parts = [
+        contact.xpath("./NAME/FORMALTITLE/@value").text,
+        contact.xpath("./NAME/GIVEN/@value").text,
+        contact.xpath("./NAME/FAMILY/@value").text,
+      ]
+
+      resp = ""
+      parts.each do |part|
+        resp << " " unless resp.empty?
+        resp << part unless part.empty?
+      end
+      resp
+    end
+
+    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
+
+      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
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      page = CanvasCc::CanvasCC::Models::Page.new
+      page.body = construct_body
+      page.identifier = @id
+      page.page_name = @title.empty? ? "Contact" : @title
+
+      course.pages << page
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/wikipage.rb

@@ -0,0 +1,34 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class WikiPage < Content
+    def canvas_conversion(course, resources)
+      unless @title == "--TOP--"
+        page_count = course.pages.
+          select { |p| p.title.start_with? @title }.count
+        @title = "#{@title}-#{page_count + 1}" if page_count > 0
+        page = CanvasCc::CanvasCC::Models::Page.new
+        if !@url.empty?
+          @body = %{
+            <a href="#{@url}">
+              #{@url}
+            </a>
+            #{@body}
+          }
+        end
+        page.body = fix_html(@body, resources)
+        page.identifier = @id
+        page.page_name = @title
+        page.workflow_state = "active"
+
+        # Add page links to page body
+        @files.each { |f| page.body << f.canvas_conversion }
+        course.pages << page
+
+        course = create_module(course)
+      end
+
+      course
+    end
+  end
+end