senkyoshi 1.0.1 → 1.0.2

data/lib/senkyoshi/models/wikipage.rb

@@ -2,27 +2,29 @@ require "senkyoshi/models/content"
 
 module Senkyoshi
   class WikiPage < Content
+    include Senkyoshi
+
     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
+        @body = _set_body(@body, @url, @extendeddata)
         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 }
+        @files.each do |file|
+          if canvas_file = course.files.detect { |f| f.identifier == file.name }
+            page.body << file.canvas_conversion(canvas_file)
+          else
+            page.body << "<p>File: " + file.linkname +
+              " -- doesn't exist in blackboard</p>"
+          end
+        end
         course.pages << page
 
         course = create_module(course)
@@ -30,5 +32,49 @@ module Senkyoshi
 
       course
     end
+
+    def _set_body(original_body, url, extendeddata)
+      body = original_body.dup
+      if !url.empty?
+        body = %{
+          <a href="#{url}">
+            #{url}
+          </a>
+          #{body}
+        }
+      end
+      if extendeddata
+        body = %{
+          #{body}
+          #{_extendeddata(extendeddata)}
+        }
+      end
+      body
+    end
+
+    def _extendeddata(extendeddata)
+      Nokogiri::XML(extendeddata).
+        search("LessonPlanComponent").
+        map do |node|
+          _component_label(node) + node.search("componentValue/@value").to_s
+        end.
+        compact.
+        join(" ")
+    end
+
+    def _component_label(node)
+      visible = true?(node.search("vislableToStudents/@value").to_s)
+      if visible
+        component_label = node.search("componentLabel/@value").to_s
+        overridden = true?(node.search("labelOverridden/@value").to_s)
+        if overridden
+          component_label
+        else
+          component_label.split(".").last.capitalize
+        end
+      else
+        ""
+      end
+    end
   end
 end

data/lib/senkyoshi/version.rb

@@ -1,4 +1,3 @@
-
 module Senkyoshi
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.2".freeze
 end

data/lib/senkyoshi/xml_parser.rb

@@ -16,9 +16,13 @@ require "senkyoshi/models/questions/quiz_bowl"
 require "senkyoshi/models/questions/short_response"
 require "senkyoshi/models/questions/true_false"
 
+require "senkyoshi/models/assessment"
+require "senkyoshi/models/question_bank"
+require "senkyoshi/models/survey"
+
 require "senkyoshi/models/announcement"
 require "senkyoshi/models/answer"
-require "senkyoshi/models/assessment"
+require "senkyoshi/models/qti"
 require "senkyoshi/models/assignment"
 require "senkyoshi/models/assignment_group"
 require "senkyoshi/models/blog"
@@ -37,6 +41,8 @@ require "senkyoshi/models/resource"
 require "senkyoshi/models/scorm_package"
 require "senkyoshi/models/staff_info"
 require "senkyoshi/models/wikipage"
+require "senkyoshi/models/attachment"
+require "senkyoshi/models/external_url"
 
 require "senkyoshi/exceptions"
 
@@ -47,7 +53,7 @@ module Senkyoshi
     announcement: "Announcement",
     forum: "Forum",
     course: "Course",
-    questestinterop: "Assessment",
+    questestinterop: "QTI",
     content: "Content",
     staffinfo: "StaffInfo",
   }.freeze
@@ -55,22 +61,32 @@ module Senkyoshi
   PRE_RESOURCE_TYPE = {
     content: "Content",
     gradebook: "Gradebook",
+    courseassessment: "QTI",
   }.freeze
 
-  def self.parse_manifest(zip_file, manifest)
+  def self.parse_manifest(zip_file, manifest, resource_xids)
     doc = Nokogiri::XML.parse(manifest)
     resources = doc.at("resources")
-    iterate_xml(resources, zip_file).flatten - ["", nil]
+    organizations = doc.at("organizations")
+    iterate_xml(organizations, resources, zip_file, resource_xids).
+      flatten - ["", nil]
   end
 
-  def self.iterate_xml(resources, zip_file)
-    pre_data = pre_iterator(resources, zip_file)
+  def self.iterate_xml(organizations, resources, zip_file, resource_xids)
+    pre_data = pre_iterator(organizations, resources, zip_file)
+    staff_info = StaffInfo.new
     iterator_master(resources, zip_file) do |xml_data, type, file|
       if RESOURCE_TYPE[type.to_sym]
         single_pre_data = get_single_pre_data(pre_data, file)
         res_class = Senkyoshi.const_get RESOURCE_TYPE[type.to_sym]
-        if type == "content"
-          Content.from(xml_data, single_pre_data)
+        case type
+        when "content"
+          Content.from(xml_data, single_pre_data, resource_xids)
+        when "questestinterop"
+          single_pre_data ||= { file_name: file }
+          QTI.from(xml_data, single_pre_data)
+        when "staffinfo"
+          staff_info.iterate_xml(xml_data, single_pre_data)
         else
           resource = res_class.new
           resource.iterate_xml(xml_data, single_pre_data)
@@ -98,7 +114,7 @@ module Senkyoshi
     end
   end
 
-  def self.pre_iterator(resources, zip_file)
+  def self.pre_iterator(organizations, resources, zip_file)
     pre_data = {}
     iterator_master(resources, zip_file) do |xml_data, type, file|
       if PRE_RESOURCE_TYPE[type.to_sym]
@@ -109,41 +125,46 @@ module Senkyoshi
       end
     end
     pre_data = connect_content(pre_data)
-    build_heirarchy(pre_data)
+    build_heirarchy(organizations, pre_data)
   end
 
   def self.connect_content(pre_data)
     pre_data["content"].each do |content|
       gradebook = pre_data["gradebook"].first.
         detect { |g| g[:content_id] == content[:file_name] }
-      if gradebook
-        content[:points] = gradebook[:points] || ""
-        content[:assignment_id] = gradebook[:assignment_id] || ""
-      end
+      content.merge!(gradebook) if gradebook
+
+      course_assessment = pre_data["courseassessment"].
+        detect { |ca| ca[:original_file_name] == content[:assignment_id] }
+      content.merge!(course_assessment) if course_assessment
     end
     pre_data["content"]
   end
 
-  def self.build_heirarchy(pre_data)
-    parents_ids = pre_data.
-      select { |p| p[:parent_id] == "{unset id}" }.
-      map { |u| u[:id] }
+  def self.build_heirarchy(organizations, pre_data)
+    unset_id = "{unset id}"
+    parents = pre_data.
+      select { |p| p[:parent_id] == unset_id }
+    parents_ids = parents.map { |u| u[:id] }
     pre_data.each do |content|
+      parent_id = content[:parent_id]
+      parent = pre_data.detect { |p| p[:id] == parent_id }
+      if parent_id == unset_id
+        content[:title] = get_title(organizations, content)
+      elsif parent[:parent_id] == unset_id
+        content[:parent_title] = parent[:title]
+      end
       next if parents_ids.include?(content[:id])
-      next if parents_ids.include?(content[:parent_id])
-      parent_id = get_master_parent(pre_data, parents_ids,
-                                    content[:parent_id])
-      content[:parent_id] = parent_id
+      next if parents_ids.include?(parent_id)
+      parents_ids << parent_id
+      parent[:parent_id] = parent[:id]
+      parent[:parent_title] = nil
     end
   end
 
-  def self.get_master_parent(pre_data, parents_ids, parent_id)
-    parent = pre_data.detect { |p| p[:id] == parent_id }
-    if parents_ids.include? parent[:id]
-      parent[:id]
-    else
-      get_master_parent(pre_data, parents_ids, parent[:parent_id])
-    end
+  def self.get_title(organizations, content)
+    item = organizations.at("item[@identifierref=#{content[:file_name]}]")
+    item.parent.at("title").text
   end
 
   ##
@@ -153,17 +174,25 @@ module Senkyoshi
   def self.iterate_files(zipfile)
     files = zipfile.entries.select(&:file?)
 
+    dir_names = zipfile.entries.map { |entry| File.dirname(entry.name) }.uniq
     file_names = files.map(&:name)
+    entry_names = dir_names + file_names
+
     scorm_paths = ScormPackage.find_scorm_paths(zipfile)
 
     files.select do |file|
-      SenkyoshiFile.valid_file?(file_names, scorm_paths, file)
+      SenkyoshiFile.valid_file?(entry_names, scorm_paths, file)
     end.
       map { |file| SenkyoshiFile.new(file) }
   end
 
+  ##
+  # Create a random hex prepended with aj_
+  # This is because the instructure qti migration tool requires
+  # the first character to be a letter.
+  ##
   def self.create_random_hex
-    SecureRandom.hex
+    "aj_" + SecureRandom.hex(32)
   end
 
   def self.get_attribute_value(xml_data, type)

data/lib/senkyoshi.rb

@@ -12,7 +12,6 @@ require "zip"
 require "senkyoshi/exceptions"
 
 module Senkyoshi
-  IMPORTED_FILES_DIRNAME = "Imported".freeze
   BASE = "$IMS-CC-FILEBASE$".freeze
 
   def self.parse(zip_path, imscc_path)
@@ -20,11 +19,14 @@ module Senkyoshi
       manifest = read_file(file, "imsmanifest.xml")
 
       resources = Senkyoshi::Collection.new
-      resources.add(Senkyoshi.parse_manifest(file, manifest))
       resources.add(Senkyoshi.iterate_files(file))
+      resource_xids = resources.resources.
+        map(&:xid).
+        select { |r| r.include?("xid-") }
+      resources.add(Senkyoshi.parse_manifest(file, manifest, resource_xids))
 
       course = create_canvas_course(resources, zip_path)
-      build_file(course, imscc_path)
+      build_file(course, imscc_path, resources)
     end
   end
 
@@ -34,20 +36,19 @@ module Senkyoshi
     raise Exceptions::MissingFileError
   end
 
-  def self.build_file(course, imscc_path)
+  def self.build_file(course, imscc_path, resources)
     folder = imscc_path.split("/").first
     file = CanvasCc::CanvasCC::CartridgeCreator.new(course).create(folder)
     File.rename(file, imscc_path)
-    cleanup
+    cleanup resources
     puts "Created a file #{imscc_path}"
   end
 
   ##
   # Perform any necessary cleanup from creating canvas cartridge
   ##
-  def self.cleanup
-    SenkyoshiFile.cleanup
-    ScormPackage.cleanup
+  def self.cleanup(resources)
+    resources.each(&:cleanup)
   end
 
   def self.create_canvas_course(resources, zip_name)
@@ -64,6 +65,11 @@ module Senkyoshi
     Zip::File.open(blackboard_file_path, "rb") do |bb_zip|
       course = Senkyoshi::CanvasCourse.from_metadata(metadata, bb_zip)
       course.upload_content(canvas_file_path)
+      cleanup course.scorm_packages
     end
   end
+
+  def true?(obj)
+    obj.to_s == "true"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senkyoshi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Atomic Jolt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -173,17 +173,21 @@ files:
 - lib/senkyoshi/models/assessment.rb
 - lib/senkyoshi/models/assignment.rb
 - lib/senkyoshi/models/assignment_group.rb
+- lib/senkyoshi/models/attachment.rb
 - lib/senkyoshi/models/blog.rb
 - lib/senkyoshi/models/content.rb
 - lib/senkyoshi/models/content_file.rb
 - lib/senkyoshi/models/course.rb
+- lib/senkyoshi/models/external_url.rb
 - lib/senkyoshi/models/file.rb
 - lib/senkyoshi/models/forum.rb
 - lib/senkyoshi/models/gradebook.rb
 - lib/senkyoshi/models/group.rb
 - lib/senkyoshi/models/module.rb
 - lib/senkyoshi/models/module_item.rb
+- lib/senkyoshi/models/qti.rb
 - lib/senkyoshi/models/question.rb
+- lib/senkyoshi/models/question_bank.rb
 - lib/senkyoshi/models/questions/calculated.rb
 - lib/senkyoshi/models/questions/either_or.rb
 - lib/senkyoshi/models/questions/essay.rb
@@ -205,6 +209,7 @@ files:
 - lib/senkyoshi/models/resource.rb
 - lib/senkyoshi/models/scorm_package.rb
 - lib/senkyoshi/models/staff_info.rb
+- lib/senkyoshi/models/survey.rb
 - lib/senkyoshi/models/wikipage.rb
 - lib/senkyoshi/tasks.rb
 - lib/senkyoshi/version.rb
@@ -229,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Converts Blackboard zip file to Canvas Common Cartridge