senkyoshi 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13edfb731484992561073e292a28f75a15bfaa5d
-  data.tar.gz: 528e83f4e9f0a60f88a40cd8d503e35b07fa8655
+  metadata.gz: d7187188584379d9e573651fe9147e7bb50497ca
+  data.tar.gz: e595d29609ad508dfc443cf1543b0eecdd382ea5
 SHA512:
-  metadata.gz: 470eafc042455cf9221aac1dca5544fb2ad335c5c9ab5f4fc5c368bd270c6ee40d25ffcb4991f5625351f21ead8220f3178315bf9076d2c455f1d421b9debb1d
-  data.tar.gz: 57c7176e3b952dbf02dff18ba3546ac02a2ebe35b72bafd3f8b52f220cb9cf759f21c25ab9518d10ebadaafa4fe1eb6f739888badba46d5909de7f39a403cc12
+  metadata.gz: c16a2de94714d3b58e2acaa22e17eb58fae79c1e17a13d8c987660ae60ffc3bf8e17d733b7ae1bc116e9d8e672a37d910c0efcce2952caad8d00f9032f94766f
+  data.tar.gz: 4d333e8b3a2e0b6000a41d3b49d28a2a2fe17f3add5a1b0248ecda417fa333df4a0aaae9e0c4d980d9bbf599c971ac449dd41adcb840b4726cdbbcc97c715343

data/README.md

@@ -1,6 +1,6 @@
 # Senkyoshi Converter [![Build Status](https://travis-ci.org/atomicjolt/senkyoshi.svg?branch=master)](https://travis-ci.org/atomicjolt/senkyoshi)
 
-TODO: Describe the gem
+Senkyoshi converts exported Blackboard packages into Canvas .imscc packages. It also allows you to upload those converted packages to a Canvas instance.
 
 ## Installation
 
@@ -21,13 +21,13 @@ Or install it yourself as:
 $ gem install senkyoshi
 ```
 
-Create a `Rakefile` and add
+Create a `Rakefile` and add:
 ```ruby
 require "senkyoshi/tasks"
 Senkyoshi::Tasks.install_tasks
 ```
 
-Create a `senkyoshi.yml` and add credentials
+Create a `senkyoshi.yml` and add credentials:
 ```yaml
 # Generally looks like https://< mycanvas_instance >/api
 :canvas_url: <canvas instance api url>
@@ -55,23 +55,23 @@ Create a `senkyoshi.yml` and add credentials
 
 ## Usage
 
-Run the rake task to convert from .zip to .imscc
+Run the rake task to convert from .zip to .imscc:
 ```sh
 rake senkyoshi:imscc
 ```
-This will take all your files in your source folder and convert them to your outputs folder
+This will take all your files in your source folder and convert them to your outputs folder.
 
-Run converting files in parallel
+Run converting files in parallel:
 ```sh
 time rake senkyoshi:imscc -m
 ```
 
-Delete entire outputs folder
+Delete entire outputs folder:
 ```sh
 rake clean
 ```
 
-Upload to canvas to process
+Upload to Canvas to process:
 ```sh
 rake senkyoshi:upload
 ```
@@ -84,7 +84,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/senkyoshi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/atomicjolt/senkyoshi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
@@ -92,6 +92,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 
-### Things not quite implemented
-People Group Sets
-Blogs
+### Things Not Quite Implemented
+People, Groups, Sets, Blogs

data/lib/senkyoshi/canvas_course.rb

@@ -1,11 +1,7 @@
 require "pandarus"
-require "senkyoshi/config"
 require "senkyoshi/models/scorm_package"
 require "rest-client"
 
-require "openssl"
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-
 module Senkyoshi
   ##
   # This class represents a canvas course for which we are uploading data to
@@ -43,8 +39,8 @@ module Senkyoshi
     ##
     def self.client
       @client ||= Pandarus::Client.new(
-        prefix: Senkyoshi.canvas_url,
-        token: Senkyoshi.canvas_token,
+        prefix: Senkyoshi.configuration.canvas_url,
+        token: Senkyoshi.configuration.canvas_token,
       )
     end
 
@@ -54,7 +50,7 @@ module Senkyoshi
     def self.from_metadata(metadata, blackboard_export = nil)
       course_name = metadata[:name] || metadata[:title]
       canvas_course = client.create_new_course(
-        Senkyoshi.account_id,
+        Senkyoshi.configuration.account_id,
         course: {
           name: course_name,
         },
@@ -66,9 +62,49 @@ module Senkyoshi
     # Creates a canvas assignment from a scorm package that has already been
     # uploaded to a scorm manager
     ##
-    def create_scorm_assignment(scorm_package, course_id)
-      url = Senkyoshi.scorm_launch_url +
-        "?course_id=#{scorm_package['package_id']}"
+    def create_scorm_assignment(scorm_package, course_id, local)
+      if local
+        _create_scorm_assignment_local(scorm_package)
+      else
+        _create_scorm_assignment_external(scorm_package, course_id)
+      end
+    end
+
+    ##
+    # Assembles the launch url with the course_id
+    ##
+    def _scorm_launch_url(package_id)
+      "#{Senkyoshi.configuration.scorm_launch_url}?course_id=#{package_id}"
+    end
+
+    ##
+    # Creates a scorm assignment from a Canvas course object
+    ##
+    def _create_scorm_assignment_local(scorm_package)
+      url = _scorm_launch_url(scorm_package["package_id"])
+
+      payload = {
+        title: scorm_package["title"],
+        submission_types: "external_tool",
+        integration_id: scorm_package["package_id"],
+        integration_data: {
+          provider: "atomic-scorm",
+        },
+        external_tool_tag_attributes: {
+          url: url,
+        },
+        points_possible: scorm_package["points_possible"],
+      }
+
+      # @course_resource in this case is a Canvas course object
+      @course_resource.assignments.create(payload)
+    end
+
+    ##
+    # Creates a scorm assignment using the Canvas api
+    ##
+    def _create_scorm_assignment_external(scorm_package, course_id)
+      url = _scorm_launch_url(scorm_package["package_id"])
 
       payload = {
         assignment__submission_types__: ["external_tool"],
@@ -97,13 +133,13 @@ module Senkyoshi
       zip = scorm_package.write_zip tmp_name
       File.open(zip, "rb") do |file|
         RestClient.post(
-          "#{Senkyoshi.scorm_url}/api/scorm_courses",
+          "#{Senkyoshi.configuration.scorm_url}/api/scorm_courses",
           {
             oauth_consumer_key: "scorm-player",
             lms_course_id: course_id,
             file: file,
           },
-          SharedAuthorization: Senkyoshi.scorm_shared_auth,
+          SharedAuthorization: Senkyoshi.configuration.scorm_shared_auth,
         ) do |resp|
           result = JSON.parse(resp.body)["response"]
           result["points_possible"] = scorm_package.points_possible
@@ -115,8 +151,10 @@ module Senkyoshi
     ##
     # Creates assignments from all previously uploaded scorm packages
     ##
-    def create_scorm_assignments(scorm_packages, course_id)
-      scorm_packages.each { |pack| create_scorm_assignment(pack, course_id) }
+    def create_scorm_assignments(scorm_packages, course_id, local)
+      scorm_packages.each do |pack|
+        create_scorm_assignment(pack, course_id, local)
+      end
     end
 
     ##
@@ -132,6 +170,14 @@ module Senkyoshi
       end
     end
 
+    def process_scorm(local: false)
+      create_scorm_assignments(
+        upload_scorm_packages(@scorm_packages),
+        @course_resource.id,
+        local,
+      )
+    end
+
     ##
     # Create a migration for the course
     # and upload the imscc file to be imported into the course
@@ -152,10 +198,7 @@ module Senkyoshi
       puts "Done uploading: #{name}"
 
       puts "Creating Scorm: #{name}"
-      create_scorm_assignments(
-        upload_scorm_packages(@scorm_packages),
-        @course_resource.id,
-      )
+      process_scorm
       puts "Done creating scorm: #{name}"
     end
 
@@ -176,7 +219,7 @@ module Senkyoshi
           RestClient.post(
             response.headers[:location],
             nil,
-            Authorization: "Bearer #{Senkyoshi.canvas_token}",
+            Authorization: "Bearer #{Senkyoshi.configuration.canvas_token}",
           )
         end
       end

data/lib/senkyoshi/configuration.rb

@@ -0,0 +1,29 @@
+require "yaml"
+
+module Senkyoshi
+  class Configuration
+    attr_accessor :canvas_url
+    attr_accessor :canvas_token
+    attr_accessor :account_id
+    attr_accessor :scorm_url
+    attr_accessor :scorm_launch_url
+    attr_accessor :scorm_shared_auth
+
+    def initialize
+      @canvas_url = Configuration._config[:canvas_url]
+      @canvas_token = Configuration._config[:canvas_token]
+      @account_id = Configuration._config[:account_id] || :self
+      @scorm_url = Configuration._config[:scorm_url]
+      @scorm_launch_url = Configuration._config[:scorm_launch_url]
+      @scorm_shared_auth = Configuration._config[:scorm_shared_auth]
+    end
+
+    def self._config
+      @config ||= if File.exists? "senkyoshi.yml"
+                    YAML::load(File.read("senkyoshi.yml"))
+                  else
+                    {}
+                  end
+    end
+  end
+end

data/lib/senkyoshi/models/announcement.rb

@@ -1,13 +1,13 @@
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 
 module Senkyoshi
-  class Announcement < Resource
-    def initialize
+  class Announcement < FileResource
+    def initialize(resource_id)
+      super(resource_id)
       @title = ""
       @text = ""
       @delayed_post = ""
       @posted_at = ""
-      @identifier = Senkyoshi.create_random_hex
       @dependency = Senkyoshi.create_random_hex
       @type = "announcement"
     end
@@ -21,13 +21,13 @@ module Senkyoshi
       self
     end
 
-    def canvas_conversion(course, _resources = nil)
+    def canvas_conversion(course, resources)
       announcement = CanvasCc::CanvasCC::Models::Announcement.new
       announcement.title = @title
-      announcement.text = @text
+      announcement.text = fix_html(@text, resources)
       announcement.delayed_post = @delayed_post
       announcement.posted_at = @posted_at
-      announcement.identifier = @identifier
+      announcement.identifier = @id
       announcement.dependency = @dependency
       course.announcements << announcement
       course

data/lib/senkyoshi/models/assignment.rb

@@ -16,7 +16,9 @@ module Senkyoshi
         assignment.submission_types << "online_upload"
         assignment.grading_type = "points"
 
-        @files.each { |f| assignment.body << f.canvas_conversion }
+        @files.each do |file|
+          assignment.body << file.canvas_conversion(resources)
+        end
         course = create_module(course)
         course.assignments << assignment
       end

data/lib/senkyoshi/models/assignment_group.rb

@@ -3,21 +3,40 @@ require "senkyoshi/models/resource"
 module Senkyoshi
   class AssignmentGroup < Resource
     attr_reader :id
-    def initialize(name, group_id)
+    def initialize(name, id)
       @title = name
       @group_weight = ""
       @rules = {}
-      @id = group_id
+      @id = id
     end
 
-    def canvas_conversion(course, _resources = nil)
+    def canvas_conversion
       assignment_group = CanvasCc::CanvasCC::Models::AssignmentGroup.new
       assignment_group.identifier = @id
       assignment_group.title = @title
       assignment_group.group_weight = @group_weight
       assignment_group.rules = @rules
-      course.assignment_groups << assignment_group
-      course
+      assignment_group
+    end
+
+    def self.create_assignment_group(group_name)
+      id = Senkyoshi.create_random_hex
+      group = AssignmentGroup.new(group_name, id)
+      group.canvas_conversion
+    end
+
+    def self.find_group(course, category)
+      course.assignment_groups.
+        detect { |a| a.title == category }
+    end
+
+    def self.find_or_create(course, category)
+      assignment_group = find_group(course, category)
+      if !assignment_group
+        assignment_group = AssignmentGroup.create_assignment_group(category)
+        course.assignment_groups << assignment_group
+      end
+      assignment_group
     end
   end
 end

data/lib/senkyoshi/models/blog.rb

@@ -1,8 +1,9 @@
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 
 module Senkyoshi
-  class Blog < Resource
-    def initialize
+  class Blog < FileResource
+    def initialize(resource_id)
+      super(resource_id)
       @title = ""
       @description = ""
       @is_public = true

data/lib/senkyoshi/models/content.rb

@@ -1,8 +1,8 @@
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 require "senkyoshi/models/content_file"
 
 module Senkyoshi
-  class Content < Resource
+  class Content < FileResource
     CONTENT_TYPES = {
       "x-bb-asmt-test-link" => "Quiz",
       "x-bb-asmt-survey-link" => "Quiz",
@@ -30,12 +30,13 @@ module Senkyoshi
       "Senkyoshi::Quiz" => "Quizzes::Quiz",
     }.freeze
 
-    attr_accessor(:title, :body, :id, :files, :url)
+    attr_accessor(:title, :body, :files, :url)
     attr_reader(:extendeddata)
 
     def self.from(xml, pre_data, resource_xids)
       type = xml.xpath("/CONTENT/CONTENTHANDLER/@value").first.text
       type.slice! "resource/"
+
       xml.xpath("//FILES/FILE").each do |file|
         file_name = ContentFile.clean_xid file.at("NAME").text
         is_attachment = CONTENT_TYPES[type] == "Attachment"
@@ -44,10 +45,10 @@ module Senkyoshi
           break
         end
       end
+
       if content_type = CONTENT_TYPES[type]
         content_class = Senkyoshi.const_get content_type
-        content = content_class.new
-        content.iterate_xml(xml, pre_data)
+        content_class.new(pre_data[:file_name]).iterate_xml(xml, pre_data)
       end
     end
 
@@ -64,10 +65,11 @@ module Senkyoshi
       @type = xml.xpath("/CONTENT/RENDERTYPE/@value").first.text
       @parent_id = pre_data[:parent_id]
       @module_type = MODULE_TYPES[self.class.name]
-      @id = xml.xpath("/CONTENT/@id").first.text
+
       if pre_data[:assignment_id] && !pre_data[:assignment_id].empty?
         @id = pre_data[:assignment_id]
       end
+
       @files = xml.xpath("//FILES/FILE").map do |file|
         ContentFile.new(file)
       end
@@ -80,7 +82,7 @@ module Senkyoshi
       module_item.canvas_conversion
     end
 
-    def get_pre_data(xml, file_name)
+    def self.get_pre_data(xml, file_name)
       id = xml.xpath("/CONTENT/@id").first.text
       parent_id = xml.xpath("/CONTENT/PARENTID/@value").first.text
       {

data/lib/senkyoshi/models/content_file.rb

@@ -26,10 +26,15 @@ module Senkyoshi
       canvas_file.file_path.split("/").last
     end
 
-    def canvas_conversion(canvas_file = nil)
-      path = canvas_file ? canvas_file.file_path : @linkname
+    def canvas_conversion(resources, canvas_file = nil)
+      path = if canvas_file
+               canvas_file.file_path
+             else
+               resource = resources.detect_xid(@name)
+               resource.path if resource
+             end
       query = "?canvas_download=1&canvas_qs_wrap=1"
-      href = "$IMS_CC_FILEBASE$/#{path}#{query}"
+      href = "#{FILE_BASE}/#{path}#{query}"
       %{
         <a
           class="instructure_scribd_file instructure_file_link"

data/lib/senkyoshi/models/course.rb

@@ -1,14 +1,14 @@
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 
 module Senkyoshi
-  class Course < Resource
+  class Course < FileResource
     ##
     # This class represents a reader for one zip file, and allows the usage of
     # individual files within zip file
     ##
-    def initialize
+    def initialize(resource_id = nil)
+      super(resource_id)
       @course_code = ""
-      @identifier = ""
       @title = ""
       @description = ""
       @is_public = false
@@ -17,7 +17,6 @@ module Senkyoshi
     end
 
     def iterate_xml(data, _)
-      @identifier = data["id"]
       @title = Senkyoshi.get_attribute_value(data, "TITLE")
       @description = Senkyoshi.get_description(data)
       @is_public = Senkyoshi.get_attribute_value(data, "ISAVAILABLE")
@@ -27,7 +26,7 @@ module Senkyoshi
     end
 
     def canvas_conversion(course, _resources = nil)
-      course.identifier = @identifier
+      course.identifier = @id
       course.title = @title
       course.description = @description
       course.is_public = @is_public

data/lib/senkyoshi/models/file.rb

@@ -18,10 +18,6 @@ module Senkyoshi
         Senkyoshi.create_random_hex
     end
 
-    def strip_xid(name)
-      name.gsub(/__xid-[0-9]+_[0-9]+/, "")
-    end
-
     def matches_xid?(xid)
       @xid == xid
     end

data/lib/senkyoshi/models/file_resource.rb

@@ -0,0 +1,23 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  ##
+  # Class to represent a resource constructed from a single 'dat' file.
+  ##
+  class FileResource < Resource
+    attr_reader(:id)
+
+    def initialize(id = nil)
+      @id = id
+    end
+
+    def self.from(xml, pre_data, _resource_xids = nil)
+      resource = new(pre_data[:file_name])
+      resource.iterate_xml(xml, pre_data)
+    end
+
+    def iterate_xml(_xml, _pre_data)
+      self
+    end
+  end
+end

data/lib/senkyoshi/models/forum.rb

@@ -1,11 +1,11 @@
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 
 module Senkyoshi
-  class Forum < Resource
-    def initialize
+  class Forum < FileResource
+    def initialize(resource_id)
+      super(resource_id)
       @title = ""
       @text = ""
-      @identifier = Senkyoshi.create_random_hex
       @discussion_type = "threaded"
     end
 
@@ -19,7 +19,7 @@ module Senkyoshi
       discussion = CanvasCc::CanvasCC::Models::Discussion.new
       discussion.title = @title
       discussion.text = @text
-      discussion.identifier = @identifier
+      discussion.identifier = @id
       discussion.discussion_type = @discussion_type
       course.discussions << discussion
       course

data/lib/senkyoshi/models/gradebook.rb

@@ -1,6 +1,23 @@
+require "senkyoshi/models/outcome_definition"
+require "senkyoshi/models/file_resource"
+
 module Senkyoshi
-  class Gradebook
-    def get_pre_data(data, _)
+  class Gradebook < FileResource
+    attr_reader(:outcome_definitions, :categories)
+
+    def initialize(resource_id = nil, categories = [], outcome_definitions = [])
+      super(resource_id)
+      @categories = categories
+      @outcome_definitions = outcome_definitions
+    end
+
+    def iterate_xml(xml_data, _)
+      @categories = Gradebook.get_categories(xml_data)
+      @outcome_definitions = get_outcome_definitions(xml_data).compact
+      self
+    end
+
+    def self.get_pre_data(data, _)
       categories = get_categories(data)
       data.search("OUTCOMEDEFINITIONS").children.map do |outcome|
         category_id = outcome.at("CATEGORYID").attributes["value"].value
@@ -14,7 +31,7 @@ module Senkyoshi
       end
     end
 
-    def get_categories(data)
+    def self.get_categories(data)
       data.at("CATEGORIES").children.
         each_with_object({}) do |category, categories|
         id = category.attributes["id"].value
@@ -23,5 +40,29 @@ module Senkyoshi
         categories[id] = title
       end
     end
+
+    def get_outcome_definitions(xml)
+      xml.xpath("//OUTCOMEDEFINITION").map do |outcome_def|
+        category_id = outcome_def.xpath("CATEGORYID/@value").first.value
+        OutcomeDefinition.from(outcome_def, @categories[category_id])
+      end
+    end
+
+    def convert_categories(course)
+      @categories.each do |category|
+        if AssignmentGroup.find_group(course, category.last).nil?
+          course.assignment_groups <<
+            AssignmentGroup.create_assignment_group(category.last)
+        end
+      end
+    end
+
+    def canvas_conversion(course, resources = nil)
+      convert_categories(course)
+      @outcome_definitions.
+        select { |outcome_def| OutcomeDefinition.orphan? outcome_def }.
+        each { |outcome_def| outcome_def.canvas_conversion course, resources }
+      course
+    end
   end
 end

data/lib/senkyoshi/models/group.rb

@@ -1,8 +1,9 @@
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 
 module Senkyoshi
-  class Group < Resource
-    def initialize
+  class Group < FileResource
+    def initialize(resource_id)
+      super(resource_id)
       @name = ""
       @description = ""
       @is_public = true

data/lib/senkyoshi/models/outcome_definition.rb

@@ -0,0 +1,52 @@
+require "senkyoshi/models/resource"
+require "senkyoshi/models/assignment_group"
+
+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)
+      outcome_definition.iterate_xml(xml)
+    end
+
+    def initialize(category)
+      @category = category
+    end
+
+    def iterate_xml(xml)
+      @content_id = xml.xpath("./CONTENTID/@value").text
+      @asidataid = xml.xpath("./ASIDATAID/@value").text
+      @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
+      self
+    end
+
+    ##
+    # Determine if an outcome definition is user created and linked to any
+    # other 'CONTENT' or assignments
+    ##
+    def self.orphan?(outcome_def)
+      outcome_def.content_id.empty? &&
+        outcome_def.asidataid.empty? &&
+        outcome_def.is_user_created
+    end
+
+    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.assignment_group_identifier_ref = assignment_group.identifier
+      assignment.title = @title
+      assignment.position = 1
+      assignment.points_possible = @points_possible
+      assignment.workflow_state = "published"
+      assignment.grading_type = "points"
+
+      course.assignments << assignment
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/qti.rb

@@ -1,7 +1,7 @@
 require "senkyoshi/models/assignment_group"
 require "senkyoshi/models/assignment"
 require "senkyoshi/models/question"
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 
 QTI_TYPE = {
   "Test" => "Assessment",
@@ -10,15 +10,16 @@ QTI_TYPE = {
 }.freeze
 
 module Senkyoshi
-  class QTI < Resource
-    def self.from(data, pre_data)
+  class QTI < FileResource
+    def self.from(data, pre_data, _resource_xids = nil)
       type = data.at("bbmd_assessmenttype").text
       qti_class = Senkyoshi.const_get QTI_TYPE[type]
-      qti = qti_class.new
+      qti = qti_class.new(pre_data[:file_name])
       qti.iterate_xml(data, pre_data)
     end
 
-    def initialize
+    def initialize(resource_id = nil)
+      super(resource_id)
       @title = ""
       @description = ""
       @quiz_type = ""
@@ -85,7 +86,7 @@ module Senkyoshi
       end
     end
 
-    def get_pre_data(xml, _)
+    def self.get_pre_data(xml, _)
       {
         original_file_name: xml.xpath("/COURSEASSESSMENT/
           ASMTID/@value").first.text,
@@ -109,8 +110,8 @@ module Senkyoshi
     def canvas_conversion(course, resources)
       assessment = CanvasCc::CanvasCC::Models::Assessment.new
       assessment.identifier = @id
-      course = create_assignment_group(course, resources)
-      assignment = create_assignment
+      assignment_group = AssignmentGroup.find_or_create(course, @group_name)
+      assignment = create_assignment(assignment_group.identifier)
       assignment.quiz_identifier_ref = assessment.identifier
       course.assignments << assignment
       assessment = setup_assessment(assessment, assignment, resources)
@@ -187,22 +188,10 @@ module Senkyoshi
       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
+    def create_assignment(group_id)
       assignment = CanvasCc::CanvasCC::Models::Assignment.new
       assignment.identifier = Senkyoshi.create_random_hex
-      assignment.assignment_group_identifier_ref = @group_id
+      assignment.assignment_group_identifier_ref = group_id
       assignment.title = @title
       assignment.position = 1
       assignment.submission_types << "online_quiz"

data/lib/senkyoshi/models/question_bank.rb

@@ -2,6 +2,12 @@ require "senkyoshi/models/qti"
 
 module Senkyoshi
   class QuestionBank < QTI
+    TAGS = {
+      "<p><span size=\"2\" style=\"font-size: small;\">.</span></p>" => "",
+      "<p>.</p>" => "",
+    }.freeze
+    TAGS_RE = Regexp.union(TAGS.keys)
+
     def canvas_conversion(course, resources)
       question_bank = CanvasCc::CanvasCC::Models::QuestionBank.new
       question_bank.identifier = @id
@@ -28,7 +34,7 @@ module Senkyoshi
       question_bank.questions = []
       questions.each do |item|
         question = item.canvas_conversion(question_bank, resources)
-        question.material = clean_up_material(question)
+        question.material = clean_up_material(question.material)
         question_bank.questions << question
       end
       question_bank
@@ -36,11 +42,12 @@ module Senkyoshi
 
     # 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!
+    def clean_up_material(material)
+      if material
+        material = material.gsub(TAGS_RE, TAGS)
+        material = material.strip
+      end
+      material
     end
   end
 end

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

@@ -2,6 +2,17 @@ require "senkyoshi/models/question"
 
 module Senkyoshi
   class Matching < Question
+    TAGS_PATTERN = Regexp.union(
+      /<\/?p[^>]*>/i,             # <p> tags
+      /<\/?b[^>]*>/i,             # <b> tags
+      /<\/?strong[^>]*>/i,        # <strong> tags
+      /<\/?em[^>]*>/i,            # <em> tags
+      /<\/?span[^>]*>/i,          # <span> tags
+      /<\/?font[^>]*>/i,          # <font> tags
+      /<\/?i(?!mg)[^>]*>/i,       # <i> tags, no <img>
+      / style=("|')[^"']*("|')/i, # inline styles
+    )
+
     def initialize
       super
       @matches = []
@@ -9,6 +20,10 @@ module Senkyoshi
       @distractors = []
     end
 
+    def strip_select_html(text)
+      text.gsub(TAGS_PATTERN, "")
+    end
+
     def iterate_xml(data)
       super
       resprocessing = data.at("resprocessing")
@@ -18,20 +33,23 @@ module Senkyoshi
       if match_block = data.at("flow[@class=RIGHT_MATCH_BLOCK]")
         matches_array = match_block.
           search("flow[@class=FORMATTED_TEXT_BLOCK]").
-          map(&:text)
+          map { |match| strip_select_html(match.text) }
       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
+
           answers << answer
           @matches << { id: id, question_text: question, answer_text: answer }
         end
@@ -40,7 +58,12 @@ module Senkyoshi
       self
     end
 
-    def canvas_conversion(assessment, _resources = nil)
+    def canvas_conversion(assessment, resources)
+      @matches.each do |match|
+        match[:question_text] = fix_html(match[:question_text], resources)
+        match[:answer_text] = fix_html(match[:answer_text], resources)
+      end
+
       @question.matches = @matches
       @question.distractors = @distractors
       super

data/lib/senkyoshi/models/resource.rb

@@ -19,17 +19,53 @@ module Senkyoshi
       false
     end
 
+    def strip_xid(name)
+      name.gsub(/__xid-[0-9]+_[0-9]+/, "")
+    end
+
+    def _matches_directory_xid?(xid, directory)
+      dir_xid = directory[/xid-[0-9]+_[0-9]+\z/]
+      xid == dir_xid
+    end
+
+    def _find_directories(resources)
+      resources.resources.map do |resource|
+        if resource.respond_to?(:location)
+          File.dirname(resource.location)[/csfiles.*/]
+        end
+      end.uniq.compact
+    end
+
+    def _fix_path(original_src, resources, dir_names)
+      xid = original_src.split("/").last
+      file_resource = resources.detect_xid(xid)
+
+      if file_resource
+        "#{FILE_BASE}/#{file_resource.path}"
+      else
+        matching_dir = dir_names.detect do |dir|
+          _matches_directory_xid?(xid, dir)
+        end
+
+        if matching_dir
+          "#{DIR_BASE}/#{strip_xid(matching_dir)}"
+        end
+      end
+    end
+
     def _search_and_replace(resources, node_html, tag, attr)
+      dir_names = _find_directories(resources)
+
       node_html.search(tag).each do |element|
         original_src = element[attr]
+
         if original_src
-          xid = original_src.split("/").last
-          file_resource = resources.detect_xid(xid)
-          if file_resource
-            element[attr] = "#{BASE}/#{file_resource.path}"
-          end
+          path = _fix_path(original_src, resources, dir_names)
+          element[attr] = path if path
         end
       end
     end
+
+    def self.get_pre_data(_xml, _file_name); end
   end
 end

data/lib/senkyoshi/models/staff_info.rb

@@ -1,15 +1,12 @@
-require "senkyoshi/models/resource"
+require "senkyoshi/models/file_resource"
 require "active_support/core_ext/string"
 
 module Senkyoshi
-  class StaffInfo < Resource
-    attr_reader(
-      :id,
-      :title,
-      :entries,
-    )
+  class StaffInfo < FileResource
+    attr_reader(:title, :entries)
 
-    def initialize
+    def initialize(resource_id = nil)
+      super(resource_id)
       @entries = []
     end
 

data/lib/senkyoshi/models/wikipage.rb

@@ -19,10 +19,10 @@ module Senkyoshi
         # Add page links to page body
         @files.each do |file|
           if canvas_file = course.files.detect { |f| f.identifier == file.name }
-            page.body << file.canvas_conversion(canvas_file)
+            page.body << file.canvas_conversion(resources, canvas_file)
           else
-            page.body << "<p>File: " + file.linkname +
-              " -- doesn't exist in blackboard</p>"
+            page.body <<
+              "<p>File: #{file.linkname} -- doesn't exist in blackboard</p>"
           end
         end
         course.pages << page

data/lib/senkyoshi/tasks.rb

@@ -54,6 +54,17 @@ module Senkyoshi
     ##
     def self.install_tasks
       namespace :senkyoshi do
+        desc "Convert a single given blackboard cartridge to a canvas cartridge"
+        task :imscc_single, [:file_path] do |_t, args|
+          file_path = args.file_path
+          if file_path
+            imscc_path = file_path.clone.ext(".imscc")
+            Senkyoshi.parse_and_process_single(file_path, imscc_path)
+          else
+            puts "No file given"
+          end
+        end
+
         desc "Convert blackboard cartridges to canvas cartridges"
         task imscc: SOURCE_FILES.pathmap(
           "%{^#{SOURCE_NAME}/,#{OUTPUT_DIR}/}X.imscc",

data/lib/senkyoshi/version.rb

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

data/lib/senkyoshi/xml_parser.rb

@@ -56,6 +56,7 @@ module Senkyoshi
     questestinterop: "QTI",
     content: "Content",
     staffinfo: "StaffInfo",
+    gradebook: "Gradebook",
   }.freeze
 
   PRE_RESOURCE_TYPE = {
@@ -80,16 +81,10 @@ module Senkyoshi
         single_pre_data = get_single_pre_data(pre_data, file)
         res_class = Senkyoshi.const_get RESOURCE_TYPE[type.to_sym]
         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)
+          res_class.from(xml_data, single_pre_data, resource_xids)
         end
       end
     end
@@ -98,7 +93,7 @@ module Senkyoshi
   def self.get_single_pre_data(pre_data, file)
     pre_data.detect do |d|
       d[:file_name] == file || d[:assignment_id] == file
-    end
+    end || { file_name: file }
   end
 
   def self.iterator_master(resources, zip_file)
@@ -119,9 +114,9 @@ module Senkyoshi
     iterator_master(resources, zip_file) do |xml_data, type, file|
       if PRE_RESOURCE_TYPE[type.to_sym]
         res_class = Senkyoshi.const_get PRE_RESOURCE_TYPE[type.to_sym]
-        resource_class = res_class.new
         pre_data[type] ||= []
-        pre_data[type].push(resource_class.get_pre_data(xml_data, file))
+        data = res_class.get_pre_data(xml_data, file)
+        pre_data[type].push(data) if data
       end
     end
     pre_data = connect_content(pre_data)
@@ -130,13 +125,16 @@ module Senkyoshi
 
   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] }
-      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
+      if pre_data["gradebook"]
+        gradebook = pre_data["gradebook"].first.
+          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

data/lib/senkyoshi.rb

@@ -2,6 +2,7 @@ require "senkyoshi/version"
 require "senkyoshi/xml_parser"
 require "senkyoshi/canvas_course"
 require "senkyoshi/collection"
+require "senkyoshi/configuration"
 
 require "canvas_cc"
 require "optparse"
@@ -12,7 +13,24 @@ require "zip"
 require "senkyoshi/exceptions"
 
 module Senkyoshi
-  BASE = "$IMS-CC-FILEBASE$".freeze
+  FILE_BASE = "$IMS-CC-FILEBASE$".freeze
+  DIR_BASE = "$CANVAS_COURSE_REFERENCE$/files/folder".freeze
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
 
   def self.parse(zip_path, imscc_path)
     Zip::File.open(zip_path) do |file|
@@ -30,6 +48,10 @@ module Senkyoshi
     end
   end
 
+  def self.parse_and_process_single(zip_path, imscc_path)
+    Senkyoshi.parse(zip_path, imscc_path)
+  end
+
   def self.read_file(zip_file, file_name)
     zip_file.find_entry(file_name).get_input_stream.read
   rescue NoMethodError
@@ -37,7 +59,7 @@ module Senkyoshi
   end
 
   def self.build_file(course, imscc_path, resources)
-    folder = imscc_path.split("/").first
+    folder = File.dirname(imscc_path)
     file = CanvasCc::CanvasCC::CartridgeCreator.new(course).create(folder)
     File.rename(file, imscc_path)
     cleanup resources

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senkyoshi
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Atomic Jolt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -166,7 +166,7 @@ files:
 - lib/senkyoshi.rb
 - lib/senkyoshi/canvas_course.rb
 - lib/senkyoshi/collection.rb
-- lib/senkyoshi/config.rb
+- lib/senkyoshi/configuration.rb
 - lib/senkyoshi/exceptions.rb
 - lib/senkyoshi/models/announcement.rb
 - lib/senkyoshi/models/answer.rb
@@ -180,11 +180,13 @@ files:
 - lib/senkyoshi/models/course.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/gradebook.rb
 - lib/senkyoshi/models/group.rb
 - lib/senkyoshi/models/module.rb
 - lib/senkyoshi/models/module_item.rb
+- lib/senkyoshi/models/outcome_definition.rb
 - lib/senkyoshi/models/qti.rb
 - lib/senkyoshi/models/question.rb
 - lib/senkyoshi/models/question_bank.rb

data/lib/senkyoshi/config.rb

@@ -1,35 +0,0 @@
-require "yaml"
-
-module Senkyoshi
-  def self.canvas_url
-    Senkyoshi._config[:canvas_url]
-  end
-
-  def self.canvas_token
-    Senkyoshi._config[:canvas_token]
-  end
-
-  def self.scorm_launch_url
-    Senkyoshi._config[:scorm_launch_url]
-  end
-
-  def self.scorm_url
-    Senkyoshi._config[:scorm_url]
-  end
-
-  def self.scorm_shared_auth
-    Senkyoshi._config[:scorm_shared_auth]
-  end
-
-  def self.account_id
-    Senkyoshi._config[:account_id] || :self
-  end
-
-  def self._config
-    @config ||= if File.exists? "senkyoshi.yml"
-                  YAML::load(File.read("senkyoshi.yml"))
-                else
-                  {}
-                end
-  end
-end