senkyoshi 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7187188584379d9e573651fe9147e7bb50497ca
-  data.tar.gz: e595d29609ad508dfc443cf1543b0eecdd382ea5
+  metadata.gz: 26c7126fd95fa6cf136131c92014471f65e2089e
+  data.tar.gz: 6a6a5352177a859ddbb3ac1c83fe9ac465e927a9
 SHA512:
-  metadata.gz: c16a2de94714d3b58e2acaa22e17eb58fae79c1e17a13d8c987660ae60ffc3bf8e17d733b7ae1bc116e9d8e672a37d910c0efcce2952caad8d00f9032f94766f
-  data.tar.gz: 4d333e8b3a2e0b6000a41d3b49d28a2a2fe17f3add5a1b0248ecda417fa333df4a0aaae9e0c4d980d9bbf599c971ac449dd41adcb840b4726cdbbcc97c715343
+  metadata.gz: bb156e023de570e457222738c42a34af1433c279ad9879501fcd7ed82d5a76538f2e3bfc191832bdcdcd03a54f4486a87abe2fbc9783d2eb9d54a7b415dff903
+  data.tar.gz: fb795ce77619b24d9b0ec6e55eeba40ece4e82b5f325b8b48a39be08d970349e96828395a1c29e34d63e4b8d60cd96d16b8fe11c57b844a9b140b11f780bb400

data/README.md

@@ -4,6 +4,10 @@ Senkyoshi converts exported Blackboard packages into Canvas .imscc packages. It
 
 ## Installation
 
+#### Canvas
+See [Senkyoshi Canvas Plugin](https://github.com/atomicjolt/senkyoshi_canvas_plugin) if you want to enable this in your canvas app.
+
+#### CLI
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -32,24 +36,24 @@ Create a `senkyoshi.yml` and add credentials:
 # Generally looks like https://< mycanvas_instance >/api
 :canvas_url: <canvas instance api url>
 
-# Canvas tokens can be generated at <my_canvas_url>/profile/setting provided
-# that the user has the required priviledges
+# Canvas tokens can be generated at <my_canvas_url>/profile/settings provided
+# that the user has the required privileges
 :canvas_token: <canvas token>
 
-# Url of scorm manager. This could the the adhesion app
+# URL of SCORM manager. This could be the Adhesion app
 # [https://github.com/atomicjolt/adhesion]
 :scorm_url: <scorm manager url>
 
-# This should be the endpoint to launch a given scorm course, in the case of
-# adhesion this will look like https://<adhesion url>/scorm_course
+# This should be the endpoint to launch a given SCORM course. In the case of
+# Adhesion, this will look like https://<adhesion url>/scorm_course
 :scorm_launch_url: <scorm launch url>
 
-# This is the secret to authenticate requests to the scorm manager. In the case
-# of adhesion you can generate a shared secret by logging into the server and
+# This is the secret to authenticate requests to the SCORM manager. In the case
+# of Adhesion, you can generate a shared secret by logging into the server and
 # running rake shared_auth, which will generate and save a token
 :scorm_shared_auth: <scorm manager token>
 
-# The account or sub-account id. This can be :self, :default, or an id
+# The account or sub-account ID. This can be :self, :default, or an ID
 :account_id: <id>
 ```
 
@@ -63,7 +67,7 @@ This will take all your files in your source folder and convert them to your out
 
 Run converting files in parallel:
 ```sh
-time rake senkyoshi:imscc -m
+time rake senkyoshi:imscc -m # The `time` command is optional.
 ```
 
 Delete entire outputs folder:
@@ -90,7 +94,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/atomic
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-
-### Things Not Quite Implemented
-People, Groups, Sets, Blogs

data/lib/senkyoshi/collection.rb

@@ -2,8 +2,8 @@ module Senkyoshi
   class Collection
     attr_reader :resources
 
-    def initialize
-      @resources = []
+    def initialize(resources = [])
+      @resources = resources
     end
 
     def add(resources)
@@ -16,6 +16,20 @@ module Senkyoshi
       end
     end
 
+    def find_by_id(id)
+      @resources.detect { |item| item.respond_to?(:id) && item.id == id }
+    end
+
+    def find_instances_of(class_name)
+      @resources.select { |res| res.class == class_name }
+    end
+
+    def find_instances_not_of(types)
+      @resources.select do |res|
+        types.each { |type| res.class != type }
+      end
+    end
+
     def each
       @resources.each do |resource|
         yield resource

data/lib/senkyoshi/configuration.rb

@@ -20,7 +20,7 @@ module Senkyoshi
 
     def self._config
       @config ||= if File.exists? "senkyoshi.yml"
-                    YAML::load(File.read("senkyoshi.yml"))
+                    YAML::safe_load(File.read("senkyoshi.yml"), [Symbol])
                   else
                     {}
                   end

data/lib/senkyoshi/models/attachment.rb

@@ -10,6 +10,8 @@ module Senkyoshi
         @module_type,
         @files.first.name,
         @url,
+        @indent,
+        @file_name,
       ).canvas_conversion
       self
     end

data/lib/senkyoshi/models/content.rb

@@ -20,6 +20,7 @@ module Senkyoshi
       "x-bb-module-page" => "WikiPage",
       "x-bb-lesson-plan" => "WikiPage",
       "x-bb-syllabus" => "WikiPage",
+      "x-bb-courselink" => "WikiPage",
     }.freeze
 
     MODULE_TYPES = {
@@ -55,6 +56,8 @@ module Senkyoshi
     def iterate_xml(xml, pre_data)
       @points = pre_data[:points] || 0
       @parent_title = pre_data[:parent_title]
+      @indent = pre_data[:indent]
+      @file_name = pre_data[:file_name]
       @title = xml.xpath("/CONTENT/TITLE/@value").first.text
       @url = xml.at("URL")["value"]
       @body = xml.xpath("/CONTENT/BODY/TEXT").first.text
@@ -65,6 +68,7 @@ module Senkyoshi
       @type = xml.xpath("/CONTENT/RENDERTYPE/@value").first.text
       @parent_id = pre_data[:parent_id]
       @module_type = MODULE_TYPES[self.class.name]
+      @referred_to_title = pre_data[:referred_to_title]
 
       if pre_data[:assignment_id] && !pre_data[:assignment_id].empty?
         @id = pre_data[:assignment_id]
@@ -78,18 +82,14 @@ module Senkyoshi
     end
 
     def set_module
-      module_item = ModuleItem.new(@title, @module_type, @id, @url)
-      module_item.canvas_conversion
-    end
-
-    def self.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,
-      }
+      ModuleItem.new(
+        @title,
+        @module_type,
+        @id,
+        @url,
+        @indent,
+        @file_name,
+      ).canvas_conversion
     end
 
     def canvas_conversion(course, _resources = nil)
@@ -97,19 +97,7 @@ module Senkyoshi
     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
-        title = @parent_title || @title
-        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
+      super(course)
     end
   end
 end

data/lib/senkyoshi/models/content_reviewed_criteria.rb

@@ -0,0 +1,27 @@
+require "senkyoshi/models/rule_criteria"
+
+module Senkyoshi
+  class ContentReviewedCriteria < RuleCriteria
+    attr_reader(:reviewed_content_id)
+
+    def initialize(id, negated, reviewed_content_id)
+      super(id, negated)
+      @reviewed_content_id = reviewed_content_id
+    end
+
+    def self.from_xml(xml)
+      id = RuleCriteria.get_id xml
+      negated = Senkyoshi.true? RuleCriteria.get_negated(xml)
+      reviewed_content_id = xml.xpath("./REVIEWED_CONTENT_ID/@value").text
+      ContentReviewedCriteria.new(id, negated, reviewed_content_id)
+    end
+
+    def get_foreign_id
+      @reviewed_content_id
+    end
+
+    def get_completion_type
+      COMPLETION_TYPES[:must_view]
+    end
+  end
+end

data/lib/senkyoshi/models/course.rb

@@ -34,5 +34,9 @@ module Senkyoshi
       course.conclude_at = @conclude_at
       course
     end
+
+    def self.master_module(course)
+      course.canvas_modules.detect { |a| a.title == MASTER_MODULE }
+    end
   end
 end

data/lib/senkyoshi/models/course_toc.rb

@@ -0,0 +1,21 @@
+require "senkyoshi/models/resource"
+require "senkyoshi/models/content_file"
+
+module Senkyoshi
+  class CourseToc
+    def self.get_pre_data(xml, file_name)
+      target_type = xml.xpath("/COURSETOC/TARGETTYPE/@value").first.text
+      if target_type != "MODULE" || target_type != "DIVIDER"
+        title = xml.xpath("/COURSETOC/LABEL/@value").first.text
+        internal_handle = xml.xpath("/COURSETOC/INTERNALHANDLE/@value").
+          first.text
+        {
+          title: title,
+          target_type: target_type,
+          original_file: file_name,
+          internal_handle: internal_handle,
+        }
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/file_resource.rb

@@ -19,5 +19,19 @@ module Senkyoshi
     def iterate_xml(_xml, _pre_data)
       self
     end
+
+    def create_module(course)
+      course.canvas_modules ||= []
+      cc_module = Course.master_module(course)
+      if cc_module
+        cc_module.module_items << @module_item
+      else
+        cc_module = Module.new(MASTER_MODULE, MASTER_MODULE)
+        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/forum.rb

@@ -9,9 +9,19 @@ module Senkyoshi
       @discussion_type = "threaded"
     end
 
-    def iterate_xml(data, _)
+    def iterate_xml(data, pre_data)
       @title = Senkyoshi.get_attribute_value(data, "TITLE")
       @text = Senkyoshi.get_text(data, "TEXT")
+      if pre_data[:internal_handle]
+        @module_item = ModuleItem.new(
+          @title,
+          "DiscussionTopic",
+          @id,
+          nil,
+          pre_data[:indent],
+          @id,
+        ).canvas_conversion
+      end
       self
     end
 
@@ -22,6 +32,9 @@ module Senkyoshi
       discussion.identifier = @id
       discussion.discussion_type = @discussion_type
       course.discussions << discussion
+      if @module_item
+        course = create_module(course)
+      end
       course
     end
   end

data/lib/senkyoshi/models/grade_completed_criteria.rb

@@ -0,0 +1,8 @@
+require "senkyoshi/models/grade_criteria"
+module Senkyoshi
+  class GradeCompletedCriteria < GradeCriteria
+    def get_completion_type
+      COMPLETION_TYPES[:must_submit]
+    end
+  end
+end

data/lib/senkyoshi/models/grade_criteria.rb

@@ -0,0 +1,46 @@
+require "senkyoshi/models/rule_criteria"
+module Senkyoshi
+  class GradeCriteria < RuleCriteria
+    attr_reader(:outcome_def_id)
+
+    def initialize(id, outcome_def_id, negated)
+      super(id, negated)
+      @outcome_def_id = outcome_def_id
+      @foreign_content_id = nil
+    end
+
+    def get_foreign_id
+      @foreign_asidata_id || @foreign_content_id
+    end
+
+    def self.get_outcome_def_id(xml)
+      xml.xpath("./OUTCOME_DEFINITION_ID/@value").text
+    end
+
+    def self.from_xml(xml)
+      id = RuleCriteria.get_id xml
+      negated = Senkyoshi.true? RuleCriteria.get_negated xml
+      outcome_def_id = GradeCriteria.get_outcome_def_id xml
+      new(id, outcome_def_id, negated)
+    end
+
+    ##
+    # use gradebook to match outcome_definition_id to the
+    # assignment content id
+    ##
+    def set_foreign_ids(resources, outcome_def_id)
+      gradebook = resources.find_instances_of(Gradebook).first
+
+      outcome = gradebook.find_outcome_def(outcome_def_id)
+      if outcome
+        @foreign_content_id = outcome.content_id
+        @foreign_asidata_id = outcome.asidataid
+      end
+    end
+
+    def canvas_conversion(course, content_id, resources)
+      set_foreign_ids(resources, @outcome_def_id)
+      super(course, content_id, resources)
+    end
+  end
+end

data/lib/senkyoshi/models/grade_range_criteria.rb

@@ -0,0 +1,34 @@
+require "senkyoshi/models/grade_criteria"
+
+module Senkyoshi
+  class GradeRangeCriteria < GradeCriteria
+    attr_reader(:min_score)
+
+    def initialize(id, outcome_def_id, negated, min_score)
+      super(id, outcome_def_id, negated)
+      @min_score = min_score
+    end
+
+    def self.get_min_score(xml)
+      xml.xpath("./MIN_SCORE/@value").text
+    end
+
+    def self.from_xml(xml)
+      id = RuleCriteria.get_id xml
+      negated = Senkyoshi.true? RuleCriteria.get_negated xml
+      outcome_def_id = GradeCriteria.get_outcome_def_id xml
+      min_score = GradeRangePercentCriteria.get_min_score xml
+      new(id, outcome_def_id, negated, min_score)
+    end
+
+    def get_completion_type
+      COMPLETION_TYPES[:min_score]
+    end
+
+    def make_completion(mod)
+      super(mod).tap do |completion_requirement|
+        completion_requirement.min_score = @min_score
+      end
+    end
+  end
+end

data/lib/senkyoshi/models/grade_range_percent_criteria.rb

@@ -0,0 +1,28 @@
+require "senkyoshi/models/grade_range_criteria"
+
+module Senkyoshi
+  class GradeRangePercentCriteria < GradeRangeCriteria
+    def make_completion(mod)
+      super(mod).tap do |completion_requirement|
+        completion_requirement.min_score = GradeRangePercentCriteria.
+          get_percentage(@min_score, @points_possible)
+      end
+    end
+
+    def get_points_possible(resources, id)
+      resource = resources.find_by_id(id)
+      resource.points_possible if resource
+    end
+
+    def self.get_percentage(min_score, points_possible)
+      (min_score.to_f / 100) * points_possible.to_f
+    end
+
+    def canvas_conversion(course, content_id, resources)
+      set_foreign_ids(resources, @outcome_def_id)
+      @points_possible = get_points_possible(resources, get_foreign_id)
+
+      super(course, content_id, resources)
+    end
+  end
+end

data/lib/senkyoshi/models/gradebook.rb

@@ -57,6 +57,12 @@ module Senkyoshi
       end
     end
 
+    def find_outcome_def(outcome_def_id)
+      @outcome_definitions.detect do |outcome_def|
+        outcome_def.id == outcome_def_id
+      end
+    end
+
     def canvas_conversion(course, resources = nil)
       convert_categories(course)
       @outcome_definitions.

data/lib/senkyoshi/models/heirarchy.rb

@@ -0,0 +1,84 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Heirarchy
+    def self.item_iterator(item, course_toc, discussion_boards)
+      if item.search("item").count.zero?
+        toc_item = setup_item(item, item.parent, course_toc)
+        toc_item[:indent] = 0
+        set_discussion_boards(discussion_boards, toc_item)
+      else
+        item.search("item").flat_map do |internal_item|
+          toc_item = setup_item(internal_item, item, course_toc)
+          toc_item[:indent] = get_indent(internal_item)
+          toc_item = set_discussion_boards(discussion_boards, toc_item)
+          toc_item
+        end
+      end
+    end
+
+    def self.get_indent(item, indent = -2)
+      return indent if item.parent.name == "organization"
+      indent += 1
+      get_indent(item.parent, indent)
+    end
+
+    def self.set_discussion_boards(discussion_boards, toc_item)
+      if toc_item[:internal_handle] == "discussion_board_entry"
+        resource = discussion_boards.select do |db|
+          title_attribute = db.attributes["title"] || db.attributes["bb:title"]
+          title_attribute.value == toc_item[:title]
+        end
+        if resource.count == 1
+          file_attribute = resource.first.attributes["file"] ||
+            resource.first.attributes["bb:file"]
+          toc_item[:file_name] = file_attribute.value.gsub(".dat", "")
+        end
+      end
+      toc_item
+    end
+
+    def self.setup_item(item, parent_item, course_toc)
+      if item.attributes["identifierref"]
+        title = item.at("title").text
+        if title == "--TOP--"
+          file_name = item.parent.attributes["identifierref"].value
+          title = item.parent.at("title").text
+          item_id = item.parent.attributes["identifierref"].
+            value.gsub("res", "")
+        else
+          file_name = item.attributes["identifierref"].value
+          if parent_item.attributes["identifierref"]
+            item_id = parent_item.attributes["identifierref"].
+              value.gsub("res", "")
+          else
+            item_id = item.attributes["identifierref"].value.gsub("res", "")
+          end
+        end
+        toc_item = course_toc.
+          detect { |ct| ct[:original_file] == file_name } || {}
+        toc_item[:file_name] = file_name
+        toc_item[:title] = title
+        toc_item[:parent_id] = get_parent_id(course_toc, item_id)
+        toc_item
+      end
+    end
+
+    def self.get_parent_id(course_toc, item_id)
+      header_ids = get_headers(course_toc, "SUBHEADER")
+      if header_ids.empty?
+        header_ids = get_headers(course_toc, "CONTENT")
+      end
+      header_id = header_ids.
+        reject { |x| x.to_i > item_id.to_i }.
+        min_by { |x| (x.to_i - item_id.to_i).abs }
+
+      header_id ? "res#{header_id}" : nil
+    end
+
+    def self.get_headers(course_toc, target_type)
+      course_toc.select { |ct| ct[:target_type] == target_type }.
+        map { |sh| sh[:original_file].gsub("res", "") }
+    end
+  end
+end

data/lib/senkyoshi/models/link.rb

@@ -0,0 +1,15 @@
+module Senkyoshi
+  ##
+  # Represents a link between Blackboard resources.
+  ##
+  class Link < FileResource
+    def self.get_pre_data(xml_data, _file)
+      {
+        referrer: xml_data.children.at("REFERRER").attributes["id"].value,
+        referred_to: xml_data.children.at("REFERREDTO").attributes["id"].value,
+        referred_to_title: xml_data.children.at("TITLE").
+          attributes["value"].value,
+      }
+    end
+  end
+end

data/lib/senkyoshi/models/module.rb

@@ -10,6 +10,12 @@ module Senkyoshi
       @module_items = []
     end
 
+    def self.find_module_from_item_id(modules, id)
+      modules.detect do |mod|
+        mod.module_items.detect { |item| item.identifierref == id }
+      end
+    end
+
     def canvas_conversion(*)
       CanvasCc::CanvasCC::Models::CanvasModule.new.tap do |cc_module|
         cc_module.identifier = @identifier

data/lib/senkyoshi/models/module_converter.rb

@@ -0,0 +1,86 @@
+module Senkyoshi
+  class ModuleConverter
+    def self.set_modules(course, pre_data)
+      master_module = Course.master_module(course)
+      subheaders = get_subheaders(pre_data)
+      pre_data.each do |data|
+        if check_module_header(data, subheaders)
+          course = add_canvas_module(course, data)
+        elsif data[:target_type] == "CONTENT"
+          module_item = create_module_subheader(data)
+          course = add_canvas_module_item(course, module_item, data)
+        elsif data[:target_type] == nil || data[:target_type] == "APPLICATION"
+          module_item = master_module.module_items.
+            detect { |i| i.identifier == data[:file_name] }
+          if module_item
+            course = add_canvas_module_item(course, module_item, data)
+          end
+        end
+      end
+      course.canvas_modules.delete(master_module)
+      course
+    end
+
+    def self.check_module_header(data, subheaders)
+      data[:target_type] == "SUBHEADER" || data[:target_type] == "CONTENT" &&
+        (subheaders.empty? || !data[:parent_id])
+    end
+
+    def self.get_subheaders(pre_data)
+      pre_data.select { |ct| ct[:target_type] == "SUBHEADER" }.
+        map { |sh| sh[:original_file].gsub("res", "") }
+    end
+
+    def self.create_module_subheader(data)
+      ModuleItem.new(
+        data[:title],
+        "ContextModuleSubHeader",
+        data[:file_name],
+        nil,
+        data[:indent],
+        data[:file_name],
+      ).canvas_conversion
+    end
+
+    def self.add_canvas_module(course, data)
+      canvas_module = Module.new(data[:title], data[:file_name])
+      course.canvas_modules << canvas_module.canvas_conversion
+      course
+    end
+
+    def self.add_canvas_module_item(course, module_item, data)
+      parent_module = get_subheader_parent(course, data)
+      if !parent_module
+        parent_module = Module.new(course.title, MAIN_CANVAS_MODULE).
+          canvas_conversion
+        course.canvas_modules << parent_module
+      end
+      parent_module.module_items ||= {}
+      parent_module.module_items << module_item
+      course
+    end
+
+    def self.get_subheader_parent(course, data)
+      if !data[:parent_id]
+        parent_module = course.canvas_modules.
+          detect { |a| a.identifier == MAIN_CANVAS_MODULE }
+      else
+        parent_module = course.canvas_modules.
+          detect { |a| a.identifier == data[:parent_id] }
+        if !parent_module
+          course.canvas_modules.
+            reject { |a| a.title == MASTER_MODULE }.
+            each do |cc_module|
+            if cc_module.module_items
+              items = cc_module.module_items.flatten
+              item = items.
+                detect { |i| i.identifier == data[:parent_id] }
+              parent_module = cc_module if item
+            end
+          end
+        end
+      end
+      parent_module
+    end
+  end
+end

data/lib/senkyoshi/models/module_item.rb

@@ -2,15 +2,20 @@ require "senkyoshi/models/resource"
 
 module Senkyoshi
   class ModuleItem < Resource
-    def initialize(title, type, identifierref, url)
+    def initialize(title, type, identifierref, url, indent, id)
       @title = title
-      @identifier = Senkyoshi.create_random_hex
+      @identifier = id || Senkyoshi.create_random_hex
       @content_type = type
       @identifierref = identifierref
+      @indent = indent
       @workflow_state = "active"
       @url = url
     end
 
+    def self.find_item_from_id_ref(module_items, id_ref)
+      module_items.detect { |item| item.identifierref == id_ref }
+    end
+
     def canvas_conversion(*)
       CanvasCc::CanvasCC::Models::ModuleItem.new.tap do |item|
         item.title = @title
@@ -18,6 +23,7 @@ module Senkyoshi
         item.content_type = @content_type
         item.identifierref = @identifierref
         item.workflow_state = @workflow_state
+        item.indent = @indent
         item.url = @url
       end
     end

data/lib/senkyoshi/models/outcome_definition.rb

@@ -5,12 +5,15 @@ module Senkyoshi
   class OutcomeDefinition < Resource
     include Senkyoshi
     attr_reader :id, :content_id, :asidataid, :is_user_created
-    def self.from(xml, category)
-      outcome_definition = OutcomeDefinition.new(category)
+    def self.from(xml, category, id = nil)
+      outcome_definition = OutcomeDefinition.new(category, id)
       outcome_definition.iterate_xml(xml)
     end
 
-    def initialize(category)
+    def initialize(category, id, content_id = nil, asidataid = nil)
+      @id = id
+      @content_id = content_id
+      @asidataid = asidataid
       @category = category
     end
 
@@ -20,7 +23,9 @@ module Senkyoshi
       @id = xml.xpath("./@id").text
       @title = xml.xpath("./TITLE/@value").text
       @points_possible = xml.xpath("./POINTSPOSSIBLE/@value").text
-      @is_user_created = true? xml.xpath("./ISUSERCREATED/@value").text
+      @is_user_created = Senkyoshi.true?(
+        xml.xpath("./ISUSERCREATED/@value").text,
+      )
       self
     end
 
@@ -37,7 +42,7 @@ module Senkyoshi
     def canvas_conversion(course, _ = nil)
       assignment_group = AssignmentGroup.find_or_create(course, @category)
       assignment = CanvasCc::CanvasCC::Models::Assignment.new
-      assignment.identifier = Senkyoshi.create_random_hex
+      assignment.identifier = @id
       assignment.assignment_group_identifier_ref = assignment_group.identifier
       assignment.title = @title
       assignment.position = 1

data/lib/senkyoshi/models/qti.rb

@@ -11,6 +11,7 @@ QTI_TYPE = {
 
 module Senkyoshi
   class QTI < FileResource
+    attr_reader(:points_possible)
     def self.from(data, pre_data, _resource_xids = nil)
       type = data.at("bbmd_assessmenttype").text
       qti_class = Senkyoshi.const_get QTI_TYPE[type]

data/lib/senkyoshi/models/question.rb

@@ -102,7 +102,7 @@ module Senkyoshi
     end
 
     def get_fraction(answer_text)
-      if @correct_answers && answer_text == @correct_answers["name"]
+      if @correct_answers && answer_text.to_s == @correct_answers["name"].to_s
         @correct_answers["fraction"].to_f
       else
         @incorrect_answers["fraction"].to_f
@@ -125,7 +125,8 @@ module Senkyoshi
         if score_number > 0
           @correct_answers["fraction"] = score_number.to_f / @max_score.to_f
         else
-          @correct_answers["fraction"] = 0
+          # mark as correct when there is no score for the answer
+          @correct_answers["fraction"] = 1
         end
       end
     end

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

@@ -51,7 +51,11 @@ module Senkyoshi
           end
 
           answers << answer
-          @matches << { id: id, question_text: question, answer_text: answer }
+          @matches << {
+            id: Senkyoshi.create_random_hex,
+            question_text: question,
+            answer_text: answer,
+          }
         end
       end
       @distractors = matches_array.reject { |i| answers.include?(i) }

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

@@ -32,9 +32,11 @@ module Senkyoshi
     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
+      if correct
+        correct.at("and").children.each_with_index do |varequal, index|
+          id = varequal.text
+          order_answers[id] = index + 1
+        end
       end
       order_answers
     end

data/lib/senkyoshi/models/rule.rb

@@ -0,0 +1,46 @@
+require "senkyoshi/models/grade_completed_criteria"
+require "senkyoshi/models/content_reviewed_criteria"
+require "senkyoshi/models/grade_range_criteria"
+require "senkyoshi/models/grade_range_percent_criteria"
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Rule < FileResource
+    attr_reader(:title, :content_id, :criteria_list, :id)
+
+    CRITERIA_MAP = {
+      grade_completed_criteria: GradeCompletedCriteria,
+      content_reviewed_criteria: ContentReviewedCriteria,
+      grade_range_criteria: GradeRangeCriteria,
+      grade_range_percent_criteria: GradeRangePercentCriteria,
+    }.freeze
+
+    def initialize(resource_id)
+      super(resource_id)
+      @criteria_list = []
+    end
+
+    def get_criteria_list(xml)
+      xml.children.select { |child_xml| !child_xml.blank? }.
+        map do |child_xml|
+          criteria = CRITERIA_MAP[child_xml.name.downcase.to_sym]
+          criteria.from_xml(child_xml) if !criteria.nil?
+        end.compact
+    end
+
+    def iterate_xml(xml, _pre_data = nil)
+      @title = xml.xpath("./TITLE/@value").text
+      @content_id = xml.xpath("./CONTENT_ID/@value").text
+      @id = xml.xpath("./@id").text
+      @criteria_list = get_criteria_list(xml.xpath("./CRITERIA_LIST"))
+      self
+    end
+
+    def canvas_conversion(course, _resources)
+      @criteria_list.each do |criteria|
+        criteria.canvas_conversion(course, @content_id, _resources)
+      end
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/rule_criteria.rb

@@ -0,0 +1,146 @@
+require "senkyoshi"
+
+module Senkyoshi
+  class RuleCriteria
+    include Senkyoshi
+    attr_reader(:id, :negated, :content_id, :asidata_id)
+
+    COMPLETION_TYPES = {
+      must_view: "must_view",
+      must_submit: "must_submit",
+      min_score: "min_score",
+      must_contribute: "must_contribute",
+    }.freeze
+
+    def initialize(id, negated)
+      @id = id
+      @negated = negated
+    end
+
+    def add_if_unique(collection, item)
+      if collection.detect do |collection_item|
+           yield(collection_item, item)
+         end.nil?
+        collection << item
+      end
+      collection
+    end
+
+    def add_to_module_if_unique(items, item)
+      add_if_unique(
+        items, item
+      ) { |a, b| a.identifierref == b.identifierref }
+    end
+
+    def self.get_id(xml)
+      xml.xpath("./@id").text
+    end
+
+    def self.get_negated(xml)
+      xml.xpath("./NEGATED/@value").text
+    end
+
+    def self.from_xml(xml)
+      new(RuleCriteria.get_id(xml), RuleCriteria.get_negated(xml))
+    end
+
+    ##
+    # Determine two identifierrefs are pointed to by items in the same module
+    def self.in_same_module?(modules, content_id, resource_id)
+      content_module = Module.find_module_from_item_id(modules, content_id)
+      resource_module = Module.find_module_from_item_id(modules, resource_id)
+      return nil if content_module.nil? || resource_module.nil?
+      content_module == resource_module
+    end
+
+    def self.module_prerequisite?(modules, content_id, resource_id)
+      in_same_module?(modules, content_id, resource_id) == false
+    end
+
+    def self.module_completion_requirement?(modules, content_id, resource_id)
+      in_same_module?(modules, content_id, resource_id) == true
+    end
+
+    ##
+    # Returns the most applicable id. If we have an assignment id return that,
+    # otherwise return the content id.
+    ##
+    def get_id
+      @asidata_id || @content_id
+    end
+
+    ##
+    # Factory method to construct a completion requirement. Should be passed
+    # the module that the completion requirement should belong to
+    ##
+    def make_completion(mod)
+      CanvasCc::CanvasCC::Models::ModuleCompletionRequirement.new.tap do |req|
+        mod_item = ModuleItem.find_item_from_id_ref(
+          mod.module_items, get_foreign_id
+        )
+
+        req.identifierref = mod_item.identifier if mod_item
+        req.type = get_completion_type
+      end
+    end
+
+    ##
+    # Factory method to construct a module prerequisite. Should be passed the
+    # prerequisite module
+    ##
+    def make_prereq(prereq_module)
+      CanvasCc::CanvasCC::Models::ModulePrerequisite.new.tap do |prereq|
+        prereq.identifierref = prereq_module.identifier
+        prereq.type = "context_module"
+      end
+    end
+
+    ##
+    # Use gradebook to find assignment id if applicable
+    ##
+    def set_ids(content_id, resources)
+      @content_id = content_id
+      gradebook = resources.find_instances_of(Gradebook).first
+      if gradebook
+        outcome_def = gradebook.outcome_definitions.detect do |out_def|
+          out_def.content_id == content_id
+        end
+        @asidata_id = outcome_def.asidataid if outcome_def
+      end
+    end
+
+    def canvas_conversion(course, content_id, resources)
+      set_ids(content_id, resources)
+
+      mod = Module.find_module_from_item_id course.canvas_modules, get_id
+
+      is_completion = RuleCriteria.module_completion_requirement?(
+        course.canvas_modules, get_id, get_foreign_id
+      )
+
+      is_prereq = RuleCriteria.module_prerequisite?(
+        course.canvas_modules, get_id, get_foreign_id
+      )
+
+      if is_completion
+        add_to_module_if_unique(
+          mod.completion_requirements, make_completion(mod)
+        )
+      elsif is_prereq
+        prereq_module = Module.find_module_from_item_id(
+          course.canvas_modules, get_foreign_id
+        )
+
+        add_to_module_if_unique(
+          mod.prerequisites, make_prereq(prereq_module)
+        )
+
+        add_to_module_if_unique(
+          prereq_module.completion_requirements, make_completion(prereq_module)
+        )
+      end
+
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/wikipage.rb

@@ -35,6 +35,7 @@ module Senkyoshi
 
     def _set_body(original_body, url, extendeddata)
       body = original_body.dup
+
       if !url.empty?
         body = %{
           <a href="#{url}">
@@ -43,12 +44,21 @@ module Senkyoshi
           #{body}
         }
       end
+      if @referred_to_title.present?
+        body = %{
+          <a href="$CANVAS_COURSE_REFERENCE$#{@referred_to_title}">
+            Course Link: #{@referred_to_title}
+          </a>
+          #{body}
+        }
+      end
       if extendeddata
         body = %{
           #{body}
           #{_extendeddata(extendeddata)}
         }
       end
+
       body
     end
 
@@ -63,10 +73,10 @@ module Senkyoshi
     end
 
     def _component_label(node)
-      visible = true?(node.search("vislableToStudents/@value").to_s)
+      visible = Senkyoshi.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)
+        overridden = Senkyoshi.true?(node.search("labelOverridden/@value").to_s)
         if overridden
           component_label
         else

data/lib/senkyoshi/version.rb

@@ -1,3 +1,3 @@
 module Senkyoshi
-  VERSION = "1.0.3".freeze
+  VERSION = "1.0.4".freeze
 end

data/lib/senkyoshi/xml_parser.rb

@@ -20,21 +20,27 @@ require "senkyoshi/models/assessment"
 require "senkyoshi/models/question_bank"
 require "senkyoshi/models/survey"
 
+require "senkyoshi/models/heirarchy"
+
 require "senkyoshi/models/announcement"
 require "senkyoshi/models/answer"
-require "senkyoshi/models/qti"
 require "senkyoshi/models/assignment"
 require "senkyoshi/models/assignment_group"
+require "senkyoshi/models/attachment"
 require "senkyoshi/models/blog"
 require "senkyoshi/models/content"
 require "senkyoshi/models/content_file"
 require "senkyoshi/models/course"
+require "senkyoshi/models/course_toc"
+require "senkyoshi/models/external_url"
 require "senkyoshi/models/file"
 require "senkyoshi/models/forum"
 require "senkyoshi/models/gradebook"
 require "senkyoshi/models/group"
+require "senkyoshi/models/link"
 require "senkyoshi/models/module"
 require "senkyoshi/models/module_item"
+require "senkyoshi/models/qti"
 require "senkyoshi/models/question"
 require "senkyoshi/models/quiz"
 require "senkyoshi/models/resource"
@@ -43,7 +49,7 @@ require "senkyoshi/models/staff_info"
 require "senkyoshi/models/wikipage"
 require "senkyoshi/models/attachment"
 require "senkyoshi/models/external_url"
-
+require "senkyoshi/models/rule"
 require "senkyoshi/exceptions"
 
 module Senkyoshi
@@ -57,28 +63,21 @@ module Senkyoshi
     content: "Content",
     staffinfo: "StaffInfo",
     gradebook: "Gradebook",
+    rule: "Rule",
   }.freeze
 
   PRE_RESOURCE_TYPE = {
-    content: "Content",
+    coursetoc: "CourseToc",
     gradebook: "Gradebook",
+    link: "Link",
     courseassessment: "QTI",
   }.freeze
 
-  def self.parse_manifest(zip_file, manifest, resource_xids)
-    doc = Nokogiri::XML.parse(manifest)
-    resources = doc.at("resources")
-    organizations = doc.at("organizations")
-    iterate_xml(organizations, resources, zip_file, resource_xids).
-      flatten - ["", nil]
-  end
-
-  def self.iterate_xml(organizations, resources, zip_file, resource_xids)
-    pre_data = pre_iterator(organizations, resources, zip_file)
+  def self.iterate_xml(resources, zip_file, resource_xids, pre_data)
     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)
+        single_pre_data = get_single_pre_data(pre_data, file) || {}
         res_class = Senkyoshi.const_get RESOURCE_TYPE[type.to_sym]
         case type
         when "staffinfo"
@@ -87,12 +86,12 @@ module Senkyoshi
           res_class.from(xml_data, single_pre_data, resource_xids)
         end
       end
-    end
+    end.flatten - ["", nil]
   end
 
   def self.get_single_pre_data(pre_data, file)
-    pre_data.detect do |d|
-      d[:file_name] == file || d[:assignment_id] == file
+    pre_data.detect do |data_item|
+      data_item[:file_name] == file || data_item[:assignment_id] == file
     end || { file_name: file }
   end
 
@@ -119,8 +118,9 @@ module Senkyoshi
         pre_data[type].push(data) if data
       end
     end
+    pre_data["content"] = build_heirarchy(organizations, resources,
+                                          pre_data["coursetoc"]) - ["", nil]
     pre_data = connect_content(pre_data)
-    build_heirarchy(organizations, pre_data)
   end
 
   def self.connect_content(pre_data)
@@ -130,39 +130,33 @@ module Senkyoshi
           detect { |g| g[:content_id] == content[:file_name] }
         content.merge!(gradebook) if gradebook
       end
+
       if pre_data["courseassessment"]
         course_assessment = pre_data["courseassessment"].
           detect { |ca| ca[:original_file_name] == content[:assignment_id] }
         content.merge!(course_assessment) if course_assessment
       end
-    end
-    pre_data["content"]
-  end
 
-  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]
+      if pre_data["link"]
+        matching_link = pre_data["link"].detect do |link|
+          link[:referrer] == content[:file_name]
+        end
+
+        if matching_link
+          content[:referred_to_title] = matching_link[:referred_to_title]
+        end
       end
-      next if parents_ids.include?(content[:id])
-      next if parents_ids.include?(parent_id)
-      parents_ids << parent_id
-      parent[:parent_id] = parent[:id]
-      parent[:parent_title] = nil
     end
+
+    pre_data["content"]
   end
 
-  def self.get_title(organizations, content)
-    item = organizations.at("item[@identifierref=#{content[:file_name]}]")
-    item.parent.at("title").text
+  def self.build_heirarchy(organizations, resources, course_toc)
+    discussion_boards = resources.
+      search("resource[type=\"resource/x-bb-discussionboard\"]")
+    organizations.at("organization").children.flat_map do |item|
+      Heirarchy.item_iterator(item, course_toc, discussion_boards)
+    end
   end
 
   ##

data/lib/senkyoshi.rb

@@ -1,5 +1,6 @@
 require "senkyoshi/version"
 require "senkyoshi/xml_parser"
+require "senkyoshi/models/module_converter"
 require "senkyoshi/canvas_course"
 require "senkyoshi/collection"
 require "senkyoshi/configuration"
@@ -15,6 +16,8 @@ require "senkyoshi/exceptions"
 module Senkyoshi
   FILE_BASE = "$IMS-CC-FILEBASE$".freeze
   DIR_BASE = "$CANVAS_COURSE_REFERENCE$/files/folder".freeze
+  MAIN_CANVAS_MODULE = "aj_main_module".freeze
+  MASTER_MODULE = "master_module".freeze
 
   class << self
     attr_writer :configuration
@@ -41,9 +44,17 @@ module Senkyoshi
       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)
+      xml = Nokogiri::XML.parse(manifest)
+      xml_resources = xml.at("resources")
+      xml_organizations = xml.at("organizations")
+
+      pre_data = Senkyoshi.pre_iterator(xml_organizations, xml_resources, file)
+      resources.add(
+        Senkyoshi.iterate_xml(xml_resources, file, resource_xids, pre_data),
+      )
+
+      course = create_canvas_course(resources, zip_path, pre_data)
       build_file(course, imscc_path, resources)
     end
   end
@@ -73,12 +84,21 @@ module Senkyoshi
     resources.each(&:cleanup)
   end
 
-  def self.create_canvas_course(resources, zip_name)
+  def self.create_canvas_course(resources, zip_name, pre_data)
     course = CanvasCc::CanvasCC::Models::Course.new
     course.course_code = zip_name
-    resources.each do |resource|
+
+    # Wait until after we set modules to convert Rules
+    resources.find_instances_not_of([Rule]).each do |resource|
       course = resource.canvas_conversion(course, resources)
     end
+
+    course = ModuleConverter.set_modules(course, pre_data)
+
+    resources.find_instances_of(Rule).each do |rule|
+      course = rule.canvas_conversion(course, resources)
+    end
+
     course
   end
 
@@ -91,7 +111,7 @@ module Senkyoshi
     end
   end
 
-  def true?(obj)
+  def self.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.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Atomic Jolt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -177,14 +177,23 @@ files:
 - lib/senkyoshi/models/blog.rb
 - lib/senkyoshi/models/content.rb
 - lib/senkyoshi/models/content_file.rb
+- lib/senkyoshi/models/content_reviewed_criteria.rb
 - lib/senkyoshi/models/course.rb
+- lib/senkyoshi/models/course_toc.rb
 - lib/senkyoshi/models/external_url.rb
 - lib/senkyoshi/models/file.rb
 - lib/senkyoshi/models/file_resource.rb
 - lib/senkyoshi/models/forum.rb
+- lib/senkyoshi/models/grade_completed_criteria.rb
+- lib/senkyoshi/models/grade_criteria.rb
+- lib/senkyoshi/models/grade_range_criteria.rb
+- lib/senkyoshi/models/grade_range_percent_criteria.rb
 - lib/senkyoshi/models/gradebook.rb
 - lib/senkyoshi/models/group.rb
+- lib/senkyoshi/models/heirarchy.rb
+- lib/senkyoshi/models/link.rb
 - lib/senkyoshi/models/module.rb
+- lib/senkyoshi/models/module_converter.rb
 - lib/senkyoshi/models/module_item.rb
 - lib/senkyoshi/models/outcome_definition.rb
 - lib/senkyoshi/models/qti.rb
@@ -209,6 +218,8 @@ files:
 - lib/senkyoshi/models/questions/true_false.rb
 - lib/senkyoshi/models/quiz.rb
 - lib/senkyoshi/models/resource.rb
+- lib/senkyoshi/models/rule.rb
+- lib/senkyoshi/models/rule_criteria.rb
 - lib/senkyoshi/models/scorm_package.rb
 - lib/senkyoshi/models/staff_info.rb
 - lib/senkyoshi/models/survey.rb
@@ -236,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Converts Blackboard zip file to Canvas Common Cartridge