senkyoshi 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63edf40048f5120e752632b9543bad9e4e94b89b
-  data.tar.gz: 5025f718ff91feb1119a5ce0ce28a69f31419ec0
+  metadata.gz: 13edfb731484992561073e292a28f75a15bfaa5d
+  data.tar.gz: 528e83f4e9f0a60f88a40cd8d503e35b07fa8655
 SHA512:
-  metadata.gz: a4e99212a4e440653bd0c08965154968bead3244dd51b9a899de53234229c09b986011ce05bff159867d33a325a20f7ba51745084b42ccae102deaf27e5f3ba7
-  data.tar.gz: 1ff2837fb0e44abe572bbdd09f4449a4dfeb4174c667a6de777db390c4f14f60aa9b009677749695d80a6e2ac80d8bfb6a19d03c39f57a76b772a4c2450a77d0
+  metadata.gz: 470eafc042455cf9221aac1dca5544fb2ad335c5c9ab5f4fc5c368bd270c6ee40d25ffcb4991f5625351f21ead8220f3178315bf9076d2c455f1d421b9debb1d
+  data.tar.gz: 57c7176e3b952dbf02dff18ba3546ac02a2ebe35b72bafd3f8b52f220cb9cf759f21c25ab9518d10ebadaafa4fe1eb6f739888badba46d5909de7f39a403cc12

data/README.md

@@ -57,13 +57,13 @@ Create a `senkyoshi.yml` and add credentials
 
 Run the rake task to convert from .zip to .imscc
 ```sh
-rake imscc
+rake senkyoshi:imscc
 ```
 This will take all your files in your source folder and convert them to your outputs folder
 
 Run converting files in parallel
 ```sh
-time rake imscc -m
+time rake senkyoshi:imscc -m
 ```
 
 Delete entire outputs folder
@@ -71,6 +71,11 @@ Delete entire outputs folder
 rake clean
 ```
 
+Upload to canvas to process
+```sh
+rake senkyoshi:upload
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/senkyoshi/canvas_course.rb

@@ -3,11 +3,16 @@ 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
   ##
   class CanvasCourse
+    attr_reader :scorm_packages
+
     ##
     # A new canvas course accepts the metadata for a course
     # and the pandarus course resourse
@@ -48,14 +53,12 @@ module Senkyoshi
     ##
     def self.from_metadata(metadata, blackboard_export = nil)
       course_name = metadata[:name] || metadata[:title]
-      courses = client.list_active_courses_in_account(Senkyoshi.account_id)
-      canvas_course = courses.detect { |course| course.name == course_name } ||
-        client.create_new_course(
-          Senkyoshi.account_id,
-          course: {
-            name: course_name,
-          },
-        )
+      canvas_course = client.create_new_course(
+        Senkyoshi.account_id,
+        course: {
+          name: course_name,
+        },
+      )
       CanvasCourse.new(metadata, canvas_course, blackboard_export)
     end
 
@@ -76,6 +79,7 @@ module Senkyoshi
         assignment__external_tool_tag_attributes__: {
           url: url,
         },
+        assignment__points_possible__: scorm_package["points_possible"],
       }
 
       CanvasCourse.client.create_assignment(
@@ -101,7 +105,9 @@ module Senkyoshi
           },
           SharedAuthorization: Senkyoshi.scorm_shared_auth,
         ) do |resp|
-          JSON.parse(resp.body)["response"]
+          result = JSON.parse(resp.body)["response"]
+          result["points_possible"] = scorm_package.points_possible
+          result
         end
       end
     end

data/lib/senkyoshi/models/assessment.rb

@@ -1,99 +1,10 @@
-require "senkyoshi/models/assignment_group"
-require "senkyoshi/models/assignment"
-require "senkyoshi/models/question"
-require "senkyoshi/models/resource"
+require "senkyoshi/models/qti"
 
 module Senkyoshi
-  class Assessment < Resource
-    def initialize
-      @title = ""
-      @description = ""
-      @quiz_type = "assignment"
-      @points_possible = 0
-      @items = []
-      @group_name = ""
-      @workflow_state = "published"
-      @available = true
-    end
-
+  class Assessment < QTI
     def iterate_xml(data, pre_data)
-      pre_data ||= {}
-      @id = pre_data[:assignment_id] || Senkyoshi.create_random_hex
-      @title = data.at("assessment").attributes["title"].value
-      @points_possible = data.at("qmd_absolutescore_max").text
-      @description = data.at("presentation_material").
-        at("mat_formattedtext").text
-      @group_name = data.at("bbmd_assessmenttype").text
-      case @group_name.downcase
-      when "survey"
-        @quiz_type = "survey"
-      end
-      data.at("section").children.map do |item|
-        @items.push(item) if item.name == "item"
-      end
-      self
-    end
-
-    def canvas_conversion(course, resources)
-      if @items.count > 0
-        assessment = CanvasCc::CanvasCC::Models::Assessment.new
-        assessment.identifier = @id
-        course = create_assignment_group(course, resources)
-        assignment = create_assignment
-        assignment.quiz_identifier_ref = assessment.identifier
-        course.assignments << assignment
-        assessment = setup_assessment(assessment, assignment, resources)
-        course.assessments << assessment
-      end
-      course
-    end
-
-    def setup_assessment(assessment, assignment, resources)
-      assessment.title = @title
-      assessment.description = fix_html(@description, resources)
-      assessment.available = @available
-      assessment.quiz_type = @quiz_type
-      assessment.points_possible = @points_possible
-      assessment = create_items(assessment, resources)
-      assessment.assignment = assignment
-      assessment
-    end
-
-    def create_items(assessment, resources)
-      @items = @items - ["", nil]
-      questions = @items.map do |item|
-        Question.from(item)
-      end
-      assessment.items = []
-      questions.each do |item|
-        assessment = item.canvas_conversion(assessment, resources)
-      end
-      assessment
-    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
-      assignment = CanvasCc::CanvasCC::Models::Assignment.new
-      assignment.identifier = Senkyoshi.create_random_hex
-      assignment.assignment_group_identifier_ref = @group_id
-      assignment.title = @title
-      assignment.position = 1
-      assignment.submission_types << "online_quiz"
-      assignment.grading_type = "points"
-      assignment.workflow_state = @workflow_state
-      assignment.points_possible = @points_possible
-      assignment
+      @quiz_type = "assignment"
+      super
     end
   end
 end

data/lib/senkyoshi/models/attachment.rb

@@ -0,0 +1,21 @@
+require "senkyoshi/models/content"
+require "senkyoshi/models/module_item"
+
+module Senkyoshi
+  class Attachment < Content
+    def iterate_xml(xml, pre_data)
+      super
+      @module_item = ModuleItem.new(
+        @title,
+        @module_type,
+        @files.first.name,
+        @url,
+      ).canvas_conversion
+      self
+    end
+
+    def canvas_conversion(course, _resource)
+      create_module(course)
+    end
+  end
+end

data/lib/senkyoshi/models/content.rb

@@ -1,4 +1,5 @@
 require "senkyoshi/models/resource"
+require "senkyoshi/models/content_file"
 
 module Senkyoshi
   class Content < Resource
@@ -8,11 +9,11 @@ module Senkyoshi
       "x-bb-assignment" => "Assignment",
       "x-bbpi-selfpeer-type1" => "Assignment",
       "x-bb-document" => "WikiPage",
-      "x-bb-file" => "WikiPage",
-      "x-bb-audio" => "WikiPage",
-      "x-bb-image" => "WikiPage",
-      "x-bb-video" => "WikiPage",
-      "x-bb-externallink" => "WikiPage",
+      "x-bb-file" => "Attachment",
+      "x-bb-audio" => "Attachment",
+      "x-bb-image" => "Attachment",
+      "x-bb-video" => "Attachment",
+      "x-bb-externallink" => "ExternalUrl",
       "x-bb-blankpage" => "WikiPage",
       "x-bb-lesson" => "WikiPage",
       "x-bb-folder" => "WikiPage",
@@ -21,11 +22,28 @@ module Senkyoshi
       "x-bb-syllabus" => "WikiPage",
     }.freeze
 
-    attr_accessor(:title, :body, :id, :files)
+    MODULE_TYPES = {
+      "Senkyoshi::Attachment" => "Attachment",
+      "Senkyoshi::Assignment" => "Assignment",
+      "Senkyoshi::ExternalUrl" => "ExternalUrl",
+      "Senkyoshi::WikiPage" => "WikiPage",
+      "Senkyoshi::Quiz" => "Quizzes::Quiz",
+    }.freeze
+
+    attr_accessor(:title, :body, :id, :files, :url)
+    attr_reader(:extendeddata)
 
-    def self.from(xml, pre_data)
+    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"
+        if !resource_xids.include?(file_name) && is_attachment
+          type = "x-bb-document"
+          break
+        end
+      end
       if content_type = CONTENT_TYPES[type]
         content_class = Senkyoshi.const_get content_type
         content = content_class.new
@@ -35,25 +53,33 @@ module Senkyoshi
 
     def iterate_xml(xml, pre_data)
       @points = pre_data[:points] || 0
+      @parent_title = pre_data[:parent_title]
       @title = xml.xpath("/CONTENT/TITLE/@value").first.text
       @url = xml.at("URL")["value"]
       @body = xml.xpath("/CONTENT/BODY/TEXT").first.text
+      @extendeddata = xml.at("/CONTENT/EXTENDEDDATA/ENTRY")
+      if @extendeddata
+        @extendeddata = @extendeddata.text
+      end
       @type = xml.xpath("/CONTENT/RENDERTYPE/@value").first.text
       @parent_id = pre_data[:parent_id]
-      bb_type = xml.xpath("/CONTENT/CONTENTHANDLER/@value").first.text
-      bb_type.slice! "resource/"
-      @module_type = CONTENT_TYPES[bb_type]
+      @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
-      @module_item = set_module if @module_type
       @files = xml.xpath("//FILES/FILE").map do |file|
         ContentFile.new(file)
       end
+      @module_item = set_module if @module_type
       self
     end
 
+    def set_module
+      module_item = ModuleItem.new(@title, @module_type, @id, @url)
+      module_item.canvas_conversion
+    end
+
     def get_pre_data(xml, file_name)
       id = xml.xpath("/CONTENT/@id").first.text
       parent_id = xml.xpath("/CONTENT/PARENTID/@value").first.text
@@ -64,12 +90,6 @@ module Senkyoshi
       }
     end
 
-    def set_module
-      @module_type = "Quizzes::Quiz" if @module_type == "Quiz"
-      module_item = ModuleItem.new(@title, @module_type, @id)
-      module_item.canvas_conversion
-    end
-
     def canvas_conversion(course, _resources = nil)
       course
     end
@@ -81,7 +101,8 @@ module Senkyoshi
       if cc_module
         cc_module.module_items << @module_item
       else
-        cc_module = Module.new(@title, @parent_id)
+        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

data/lib/senkyoshi/models/content_file.rb

@@ -2,17 +2,34 @@ require "senkyoshi/models/resource"
 
 module Senkyoshi
   class ContentFile < Resource
-    attr_accessor(:id, :name, :linkname)
+    attr_reader(:id, :name, :linkname)
 
     def initialize(xml)
       @id = xml.xpath("./@id").first.text
-      @name = xml.xpath("./NAME").first.text
       @linkname = xml.xpath("./LINKNAME/@value").first.text
+      @name = ContentFile.clean_xid xml.xpath("./NAME").first.text
     end
 
-    def canvas_conversion(*)
+    ##
+    # Remove leading slash if necessary so that ContentFile.name will match
+    # the Senkyoshi.xid
+    ##
+    def self.clean_xid(xid)
+      if xid.start_with? "/"
+        xid[1..-1]
+      else
+        xid
+      end
+    end
+
+    def self.correct_linkname(canvas_file)
+      canvas_file.file_path.split("/").last
+    end
+
+    def canvas_conversion(canvas_file = nil)
+      path = canvas_file ? canvas_file.file_path : @linkname
       query = "?canvas_download=1&amp;canvas_qs_wrap=1"
-      href = "$IMS_CC_FILEBASE$/#{IMPORTED_FILES_DIRNAME}/#{@linkname}#{query}"
+      href = "$IMS_CC_FILEBASE$/#{path}#{query}"
       %{
         <a
           class="instructure_scribd_file instructure_file_link"

data/lib/senkyoshi/models/external_url.rb

@@ -0,0 +1,9 @@
+require "senkyoshi/models/content"
+
+module Senkyoshi
+  class ExternalUrl < Content
+    def canvas_conversion(course, _resource)
+      create_module(course)
+    end
+  end
+end

data/lib/senkyoshi/models/file.rb

@@ -3,23 +3,23 @@ require "senkyoshi/exceptions"
 
 module Senkyoshi
   class SenkyoshiFile < Resource
-    attr_accessor(:id, :location, :name)
-    @@dir = nil
+    attr_accessor(:xid, :location, :path)
 
     FILE_BLACKLIST = [
       "*.dat",
     ].freeze
 
     def initialize(zip_entry)
-      path = zip_entry.name
-      id = File.basename(path)
-      xid = id[/__(xid-[0-9]+_[0-9]+)/, 1]
-      name = id.gsub(/__xid-[0-9]+_[0-9]+/, "")
-
+      @path = strip_xid zip_entry.name
       @location = extract_file(zip_entry) # Location of file on local filesystem
-      @name = name
-      @id = id
-      @xid = xid
+
+      base_name = File.basename(zip_entry.name)
+      @xid = base_name[/__(xid-[0-9]+_[0-9]+)/, 1] ||
+        Senkyoshi.create_random_hex
+    end
+
+    def strip_xid(name)
+      name.gsub(/__xid-[0-9]+_[0-9]+/, "")
     end
 
     def matches_xid?(xid)
@@ -27,9 +27,9 @@ module Senkyoshi
     end
 
     def extract_file(entry)
-      @@dir ||= Dir.mktmpdir
+      @dir ||= Dir.mktmpdir
 
-      name = "#{@@dir}/#{entry.name}"
+      name = "#{@dir}/#{entry.name}"
       path = File.dirname(name)
       FileUtils.mkdir_p path unless Dir.exist? path
       entry.extract(name)
@@ -38,9 +38,9 @@ module Senkyoshi
 
     def canvas_conversion(course, _resources = nil)
       file = CanvasCc::CanvasCC::Models::CanvasFile.new
-      file.identifier = @id
+      file.identifier = @xid
       file.file_location = @location
-      file.file_path = "#{IMPORTED_FILES_DIRNAME}/#{@name}"
+      file.file_path = @path
       file.hidden = false
 
       course.files << file
@@ -50,8 +50,8 @@ module Senkyoshi
     ##
     # Remove temporary files
     ##
-    def self.cleanup
-      FileUtils.rm_r @@dir unless @@dir.nil?
+    def cleanup
+      FileUtils.rm_r @dir unless @dir.nil?
     end
 
     ##
@@ -64,14 +64,15 @@ module Senkyoshi
     ##
     # Determine whether or not a file is a metadata file or not
     ##
-    def self.metadata_file?(file_names, file)
+    def self.metadata_file?(entry_names, file)
       if File.extname(file.name) == ".xml"
         # Detect and skip metadata files.
-        concrete_file = File.join(
+        non_meta_file = File.join(
           File.dirname(file.name),
           File.basename(file.name, ".xml"),
         )
-        file_names.include?(concrete_file)
+
+        entry_names.include?(non_meta_file)
       else
         false
       end
@@ -89,9 +90,9 @@ module Senkyoshi
     ##
     # Determine if a file should be included in course files or not
     ##
-    def self.valid_file?(file_names, scorm_paths, file)
+    def self.valid_file?(entry_names, scorm_paths, file)
       return false if SenkyoshiFile.blacklisted? file
-      return false if SenkyoshiFile.metadata_file? file_names, file
+      return false if SenkyoshiFile.metadata_file? entry_names, file
       return false if SenkyoshiFile.belongs_to_scorm_package? scorm_paths, file
       true
     end

data/lib/senkyoshi/models/gradebook.rb

@@ -3,16 +3,13 @@ module Senkyoshi
     def get_pre_data(data, _)
       categories = get_categories(data)
       data.search("OUTCOMEDEFINITIONS").children.map do |outcome|
-        content_id = outcome.at("CONTENTID").attributes["value"].value
-        assignment_id = outcome.at("ASIDATAID").attributes["value"].value
         category_id = outcome.at("CATEGORYID").attributes["value"].value
-        category = categories[category_id]
-        points = outcome.at("POINTSPOSSIBLE").attributes["value"].value
         {
-          category: category,
-          points: points,
-          content_id: content_id,
-          assignment_id: assignment_id,
+          category: categories[category_id],
+          points: outcome.at("POINTSPOSSIBLE").attributes["value"].value,
+          content_id: outcome.at("CONTENTID").attributes["value"].value,
+          assignment_id: outcome.at("ASIDATAID").attributes["value"].value,
+          due_at: outcome.at("DUE").attributes["value"].value,
         }
       end
     end

data/lib/senkyoshi/models/module_item.rb

@@ -2,12 +2,13 @@ require "senkyoshi/models/resource"
 
 module Senkyoshi
   class ModuleItem < Resource
-    def initialize(title, type, identifierref)
+    def initialize(title, type, identifierref, url)
       @title = title
       @identifier = Senkyoshi.create_random_hex
       @content_type = type
       @identifierref = identifierref
       @workflow_state = "active"
+      @url = url
     end
 
     def canvas_conversion(*)
@@ -17,6 +18,7 @@ module Senkyoshi
         item.content_type = @content_type
         item.identifierref = @identifierref
         item.workflow_state = @workflow_state
+        item.url = @url
       end
     end
   end