senkyoshi 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f06aa757d486bafb9556bfea1a3c4ba6d6c308c
-  data.tar.gz: 8425b48104e9e39bc67f7880d8ac26cfbdd1c350
+  metadata.gz: 99658502a8221b6898e129443137b24fb32e6428
+  data.tar.gz: d1e6c9a353a2c2bef8f800bbf1c660809b72264b
 SHA512:
-  metadata.gz: 9198a33902b72af0ce2910a75735b27220433fbc4e9125990dd963f48218939e47eee0e7dcdfbd9f5a368c411a4dee961b1798c57ed06bd0d0c64a904b45ac2b
-  data.tar.gz: b883f8a69ed45e7319230d1bc113c39427a0bece0e08cbdbdf22baded66ab8167d56daf82036010fd573128eb65d10dfea9ed861fcc1f03783499fc6d71fd37e
+  metadata.gz: eb318a13ce550e2d7da69a49c58d6f1ae36b3d549c25eb4158f2c74d28d166f2f3f103f2a847c5efc22bf771dd11d500a22a79ce62d3fa3f16ff7cc35b53e1a0
+  data.tar.gz: 8f602f3422c21effdd47d583c102d61f6a1971e01f7e026a767acaf73c65c3babd32c6eb587a8798a5c930e4708b51b856a282539881fba1ca9fcb3bd58d3af6

data/README.md

@@ -2,6 +2,22 @@
 
 Senkyoshi converts exported Blackboard packages into Canvas .imscc packages. It also allows you to upload those converted packages to a Canvas instance.
 
+## Feature Comparison
+
+Senkyoshi converts Blackboard course exports as well as Instructure's converter with several improvements detailed in the table below:
+
+| Feature  | Instructure Blackboard Converter | Senkyoshi |
+|:---------|----------------------------------|-----------|
+| Announcements | Partial Conversion, links embedded or otherwise are not converted/broken. | Converts all announcements including all links. |
+|Assignments|All assignments lumped into one big group.  No separations from quizzes, surveys, and assignments, some broken links in content.| Separates the assignments into a few categories based on Blackboard structure: Tests, Assignments, Surveys, Practicums, and Quizzes. A few courses have broken links to files that did not exist in the Blackboard course file. All links in content work appropriately. |
+|Discussions|Basic conversion supported, some discussions missing.| All discussions, including Blackboard Seminar Discussions, are imported with topic content.|
+|Pages|Basic conversion supported, some pages missing or content links broken.|Creates pages for most all module items and separates them per assignment and lesson page from Blackboard structure.  Creates additional pages for Blackboard attachments that have content descriptions.|
+|Files|Basic support, flattened file directories into a single top level with all files. | Keeps folder/file structure from Blackboard when importing to Canvas Files. |
+|Quizzes|Basic support, unable to convert quiz answers in certain formats and converts an incorrect number of quizzes from the quiz banks.| Converts the correct amount of quizzes and is able to determine all the correct answers for each quiz. Changes Blackboard formats that Canvas doesn't support into correct formats.|
+|Modules|Basic support, modules created at a single level and category. | Converts Blackboard Lesson Category structure into Canvas Modules with indented structure for sub-content. |
+|Pre-requisites|No support for Blackboard Adaptive Release.| Converts Blackboard Adaptive Release content into Canvas Pre-Requisite requirements to view certain class material. Follows same format that was used in Blackboard.|
+|SCORM|No support for SCORM content.|*(Optional)* Uploads SCORM packages to a SCORM management system tool in Canvas as well as place them into Canvas Files. Will find any SCORM packages that exist in a Blackboard course export.|
+
 ## Installation
 
 #### Canvas
@@ -40,6 +56,9 @@ Create a `senkyoshi.yml` and add credentials:
 # that the user has the required privileges
 :canvas_token: <canvas token>
 
+# The account or sub-account ID. This can be :self, :default, or an ID
+:account_id: <id>
+
 # URL of SCORM manager. This could be the Adhesion app
 # [https://github.com/atomicjolt/adhesion]
 :scorm_url: <scorm manager url>
@@ -53,33 +72,34 @@ Create a `senkyoshi.yml` and add credentials:
 # 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
-:account_id: <id>
-
 # The number of seconds before uploads timeout. Defaults to 1800 (30 minutes)
 :request_timeout: <request timeout seconds>
 ```
 
-## Usage
+## CLI Usage
+
+Senkyoshi rake tasks can be used to batch convert Blackboard Courses to Canvas Courses and optionally upload them to a Canvas instance.
+
+It expects all Blackboard courses to be converted to be in a folder called `sources`, and outputs to a folder
 
 Run the rake task to convert from .zip to .imscc:
-```sh
+```bash
 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
+```bash
 time rake senkyoshi:imscc -m # The `time` command is optional.
 ```
 
 Delete entire outputs folder:
-```sh
+```bash
 rake clean
 ```
 
 Upload to Canvas to process:
-```sh
+```bash
 rake senkyoshi:upload
 ```
 

data/lib/senkyoshi/version.rb

@@ -14,5 +14,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module Senkyoshi
-  VERSION = "1.0.8".freeze
+  VERSION = "1.0.9".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senkyoshi
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Atomic Jolt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: pandarus
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,14 @@ dependencies:
   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
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Converts Blackboard zip file to Canvas Common Cartridge