senkyoshi 1.0.0

data/lib/senkyoshi/tasks.rb

@@ -0,0 +1,90 @@
+require "rake"
+require "rake/clean"
+require "senkyoshi"
+require "byebug"
+
+## CHANGED THESE TO CHANGE THE FOLDER LOCATIONS
+SOURCE_DIR = "sources".freeze
+OUTPUT_DIR = "canvas".freeze
+UPLOAD_DIR = "uploaded".freeze
+
+## Don't change these, these are just getting the last
+## of the folder name for the script below to use
+SOURCE_NAME = SOURCE_DIR.split("/").last
+OUTPUT_NAME = OUTPUT_DIR.split("/").last
+UPLOAD_NAME = UPLOAD_DIR.split("/").last
+SOURCE_FILES = Rake::FileList.new("#{SOURCE_DIR}/*.zip")
+CONVERTED_FILES = Rake::FileList.new("#{OUTPUT_DIR}/*.imscc")
+
+def source_for_imscc(imscc_file)
+  SOURCE_FILES.detect do |f|
+    path = imscc_file.pathmap("%{^#{OUTPUT_DIR}/,#{SOURCE_DIR}/}X")
+    f.ext("") == path
+  end
+end
+
+def source_for_upload_log(upload_log)
+  CONVERTED_FILES.detect do |f|
+    path = upload_log.pathmap("%{^#{UPLOAD_DIR}/,#{OUTPUT_DIR}/}X")
+    f.ext("") == path
+  end
+end
+
+def make_directories(name, upload_dir)
+  mkdir_p name.pathmap("%d")
+  mkdir_p upload_dir
+end
+
+def log_file(name)
+  sh "touch #{name}"
+  sh "date >> #{name}"
+end
+
+module Senkyoshi
+  class Tasks
+    extend Rake::DSL if defined? Rake::DSL
+
+    ##
+    # Creates rake tasks that can be ran from the gem.
+    #
+    # Add this to your Rakefile
+    #
+    #   require "senkyoshi/tasks"
+    #   Senkyoshi::Tasks.install_tasks
+    #
+    ##
+    def self.install_tasks
+      namespace :senkyoshi do
+        desc "Convert blackboard cartridges to canvas cartridges"
+        task imscc: SOURCE_FILES.pathmap(
+          "%{^#{SOURCE_NAME}/,#{OUTPUT_DIR}/}X.imscc",
+        )
+
+        directory OUTPUT_NAME
+
+        rule ".imscc" => [->(f) { source_for_imscc(f) }, OUTPUT_NAME] do |t|
+          make_directories(t.name, OUTPUT_DIR)
+          Senkyoshi.parse(t.source, t.name)
+        end
+
+        desc "Upload converted files to canvas"
+        task upload: CONVERTED_FILES.pathmap(
+          "%{^#{OUTPUT_NAME}/,#{UPLOAD_DIR}/}X.txt",
+        )
+
+        directory UPLOAD_NAME
+
+        rule ".txt" => [->(f) { source_for_upload_log(f) }, UPLOAD_NAME] do |t|
+          make_directories(t.name, UPLOAD_DIR)
+          Senkyoshi.initialize_course(t.source, source_for_imscc(t.source))
+          log_file(t.name)
+        end
+
+        desc "Completely delete all converted files"
+        task :clean do
+          rm_rf OUTPUT_DIR
+        end
+      end
+    end
+  end
+end

data/lib/senkyoshi/version.rb

@@ -0,0 +1,3 @@
+module Senkyoshi
+  VERSION = "1.0.0".freeze
+end

data/lib/senkyoshi/xml_parser.rb

@@ -0,0 +1,154 @@
+require "require_all"
+require_all "lib/senkyoshi/models/**/*.rb"
+require_relative "exceptions"
+
+module Senkyoshi
+  RESOURCE_TYPE = {
+    groups: "Group",
+    blog: "Blog",
+    announcement: "Announcement",
+    forum: "Forum",
+    course: "Course",
+    questestinterop: "Assessment",
+    content: "Content",
+    staffinfo: "StaffInfo",
+  }.freeze
+
+  PRE_RESOURCE_TYPE = {
+    content: "Content",
+    gradebook: "Gradebook",
+  }.freeze
+
+  def self.parse_manifest(zip_file, manifest)
+    doc = Nokogiri::XML.parse(manifest)
+    resources = doc.at("resources")
+    iterate_xml(resources, zip_file).flatten - ["", nil]
+  end
+
+  def self.iterate_xml(resources, zip_file)
+    pre_data = pre_iterator(resources, zip_file)
+    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)
+        else
+          resource = res_class.new
+          resource.iterate_xml(xml_data, single_pre_data)
+        end
+      end
+    end
+  end
+
+  def self.get_single_pre_data(pre_data, file)
+    pre_data.detect do |d|
+      d[:file_name] == file || d[:assignment_id] == file
+    end
+  end
+
+  def self.iterator_master(resources, zip_file)
+    resources.children.map do |resource|
+      file_name = resource.attributes["file"].value
+      file = File.basename(file_name, ".dat")
+      if zip_file.find_entry(file_name)
+        data_file = Senkyoshi.read_file(zip_file, file_name)
+        xml_data = Nokogiri::XML.parse(data_file).children.first
+        type = xml_data.name.downcase
+        yield xml_data, type, file
+      end
+    end
+  end
+
+  def self.pre_iterator(resources, zip_file)
+    pre_data = {}
+    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))
+      end
+    end
+    pre_data = connect_content(pre_data)
+    build_heirarchy(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
+    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] }
+    pre_data.each do |content|
+      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
+    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
+  end
+
+  ##
+  # Iterate through course files and create new SenkyoshiFile for each
+  # non-metadata file.
+  ##
+  def self.iterate_files(zipfile)
+    files = zipfile.entries.select(&:file?)
+
+    file_names = files.map(&:name)
+    scorm_paths = ScormPackage.find_scorm_paths(zipfile)
+
+    files.select do |file|
+      SenkyoshiFile.valid_file?(file_names, scorm_paths, file)
+    end.
+      map { |file| SenkyoshiFile.new(file) }
+  end
+
+  def self.create_random_hex
+    SecureRandom.hex
+  end
+
+  def self.get_attribute_value(xml_data, type)
+    value = ""
+    if xml_data.children.at(type).attributes["value"]
+      value = xml_data.children.at(type).attributes["value"].value
+    end
+    value
+  end
+
+  def self.get_text(xml_data, type)
+    value = ""
+    if xml_data.children.at(type)
+      value = xml_data.children.at(type).text
+    end
+    value
+  end
+
+  def self.get_description(xml_data)
+    value = ""
+    if xml_data.children.at("DESCRIPTION")
+      value = xml_data.children.at("DESCRIPTION").text
+    end
+    value
+  end
+end

data/lib/senkyoshi.rb

@@ -0,0 +1,69 @@
+require "senkyoshi/version"
+require "senkyoshi/xml_parser"
+require "senkyoshi/canvas_course"
+require "senkyoshi/collection"
+
+require "canvas_cc"
+require "optparse"
+require "ostruct"
+require "nokogiri"
+require "zip"
+
+require_relative "./senkyoshi/exceptions"
+
+module Senkyoshi
+  IMPORTED_FILES_DIRNAME = "Imported".freeze
+  BASE = "$IMS-CC-FILEBASE$".freeze
+
+  def self.parse(zip_path, imscc_path)
+    Zip::File.open(zip_path) do |file|
+      manifest = read_file(file, "imsmanifest.xml")
+
+      resources = Senkyoshi::Collection.new
+      resources.add(Senkyoshi.parse_manifest(file, manifest))
+      resources.add(Senkyoshi.iterate_files(file))
+
+      course = create_canvas_course(resources, zip_path)
+      build_file(course, imscc_path)
+    end
+  end
+
+  def self.read_file(zip_file, file_name)
+    zip_file.find_entry(file_name).get_input_stream.read
+  rescue NoMethodError
+    raise Exceptions::MissingFileError
+  end
+
+  def self.build_file(course, imscc_path)
+    folder = imscc_path.split("/").first
+    file = CanvasCc::CanvasCC::CartridgeCreator.new(course).create(folder)
+    File.rename(file, imscc_path)
+    cleanup
+    puts "Created a file #{imscc_path}"
+  end
+
+  ##
+  # Perform any necessary cleanup from creating canvas cartridge
+  ##
+  def self.cleanup
+    SenkyoshiFile.cleanup
+    ScormPackage.cleanup
+  end
+
+  def self.create_canvas_course(resources, zip_name)
+    course = CanvasCc::CanvasCC::Models::Course.new
+    course.course_code = zip_name
+    resources.each do |resource|
+      course = resource.canvas_conversion(course, resources)
+    end
+    course
+  end
+
+  def self.initialize_course(canvas_file_path, blackboard_file_path)
+    metadata = Senkyoshi::CanvasCourse.metadata_from_file(canvas_file_path)
+    Zip::File.open(blackboard_file_path, "rb") do |bb_zip|
+      course = Senkyoshi::CanvasCourse.from_metadata(metadata, bb_zip)
+      course.upload_content(canvas_file_path)
+    end
+  end
+end

metadata

@@ -0,0 +1,250 @@
+--- !ruby/object:Gem::Specification
+name: senkyoshi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Atomic Jolt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: pandarus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Commandline tool for converting blackboard to canvas
+email: 
+executables:
+- console
+- import_blackboard
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/import_blackboard
+- lib/senkyoshi.rb
+- lib/senkyoshi/canvas_course.rb
+- lib/senkyoshi/collection.rb
+- lib/senkyoshi/config.rb
+- lib/senkyoshi/exceptions.rb
+- lib/senkyoshi/models/announcement.rb
+- lib/senkyoshi/models/answer.rb
+- lib/senkyoshi/models/assessment.rb
+- lib/senkyoshi/models/assignment.rb
+- lib/senkyoshi/models/assignment_group.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/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/question.rb
+- lib/senkyoshi/models/questions/calculated.rb
+- lib/senkyoshi/models/questions/either_or.rb
+- lib/senkyoshi/models/questions/essay.rb
+- lib/senkyoshi/models/questions/file_upload.rb
+- lib/senkyoshi/models/questions/fill_in_blank.rb
+- lib/senkyoshi/models/questions/fill_in_blank_plus.rb
+- lib/senkyoshi/models/questions/hot_spot.rb
+- lib/senkyoshi/models/questions/jumbled_sentence.rb
+- lib/senkyoshi/models/questions/matching.rb
+- lib/senkyoshi/models/questions/multiple_answer.rb
+- lib/senkyoshi/models/questions/multiple_choice.rb
+- lib/senkyoshi/models/questions/numerical.rb
+- lib/senkyoshi/models/questions/opinion_scale.rb
+- lib/senkyoshi/models/questions/ordering.rb
+- lib/senkyoshi/models/questions/quiz_bowl.rb
+- lib/senkyoshi/models/questions/short_response.rb
+- lib/senkyoshi/models/questions/true_false.rb
+- lib/senkyoshi/models/quiz.rb
+- lib/senkyoshi/models/resource.rb
+- lib/senkyoshi/models/scorm_package.rb
+- lib/senkyoshi/models/staff_info.rb
+- lib/senkyoshi/models/wikipage.rb
+- lib/senkyoshi/tasks.rb
+- lib/senkyoshi/version.rb
+- lib/senkyoshi/xml_parser.rb
+homepage: https://github.com/atomicjolt/senkyoshi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Converts Blackboard zip file to Canvas Common Cartridge
+test_files: []