senkyoshi_canvas_plugin 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5f2c6cbc6d5973e7c8b10b93a2293d365b6c3e5
+  data.tar.gz: 7b141a269fd70dfe2d51e297bab57064d3938e23
+SHA512:
+  metadata.gz: dd324b5342914f3e59c3b2be0288123674a735bb4421fb44b5bb1032da7d12b830760c520b056f7d1176b2907a2950c30d4399c4f40c470a2410a0518721ea27
+  data.tar.gz: 6bff729cc57f5b57cefc2f457357f27bf2e3c466d9791f482ce8b99d26f350ee5a8e9a17aaf32bacf544ffbfe4845bae4cfb0b5b1daf4f33efdba67bb984be95

data/README.md

@@ -0,0 +1,25 @@
+# Senkyoshi Canvas Plugin
+
+This plugin enables the use of the Senkyoshi converter inside of Canvas. It adds a blackboard cartridge option to the import content dropdown for a course.
+
+## Installation
+
+Add a file inside the `Gemfile.d` folder
+
+```ruby
+# Gemfile.d/senkyoshi.rb
+gem "canvas_cc", git: "https://github.com/atomicjolt/canvas_cc.git"
+```
+
+```sh
+sysadmin@appserver:~$ cd /path/to/canvas/gems/plugins
+sysadmin@appserver:/path/to/canvas/gems/plugins$ git clone https://github.com/atomicjolt/senkyoshi_canvas_plugin.git
+```
+
+Now `bundle install` and `bundle exec rake canvas:compile_assets` and `rails server`.
+
+After it is up, login with the site admin account and head over to the `/plugins` route (Navigated to by clicking `Admin -> Site Admin -> Plugins`).
+Once there, scroll down to `Senkyoshi Conversion Importer` and click into it. Enable the plugin and add your Scorm information if needed.
+
+You should be all set now. Enjoy!
+

data/app/coffeescripts/bundles/content_migration_senkyoshi.coffee

@@ -0,0 +1,18 @@
+# Copyright (C) 2017 Atomic Jolt
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require [
+  'senkyoshi_canvas_plugin/compiled/content_migration_setup_senkyoshi'
+], () ->

data/app/coffeescripts/content_migration_setup_senkyoshi.coffee

@@ -0,0 +1,71 @@
+# Copyright (C) 2017 Atomic Jolt
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Parts of this file have been copied from Instructures file located at
+# https://github.com/instructure/canvas-lms/blob/4d944663f8ee9e17eb20fdf280333f9a6c04e749/app/coffeescripts/bundles/modules/content_migration_setup.coffee
+
+define [
+  'jquery'
+  'i18n!content_migrations'
+  'compiled/collections/DaySubstitutionCollection'
+  'compiled/views/CollectionView'
+  'compiled/views/content_migrations/ConverterViewControl'
+  'compiled/views/content_migrations/CanvasExportView'
+  'compiled/views/content_migrations/subviews/ChooseMigrationFileView'
+  'compiled/views/content_migrations/subviews/SelectContentCheckboxView'
+  'compiled/views/content_migrations/subviews/DateShiftView'
+  'compiled/views/content_migrations/subviews/DaySubstitutionView'
+  'vendor/jquery.ba-tinypubsub'
+  'jst/content_migrations/subviews/DaySubstitutionCollection'
+  'compiled/bundles/modules/content_migration_setup'
+], (
+  $,
+  I18n,
+  DaySubstitutionCollection,
+  CollectionView,
+  ConverterViewControl,
+  CanvasExportView,
+  ChooseMigrationFileView,
+  SelectContentCheckboxView,
+  DateShiftView,
+  DaySubView,
+  pubsub,
+  daySubCollectionTemplate
+) ->
+
+  emptyMessage = I18n.t('no_day_substitutions', "No Day Substitutions Added")
+  daySubCollection = new DaySubstitutionCollection
+  daySubCollectionView = new CollectionView
+    collection: daySubCollection
+    emptyMessage: -> emptyMessage
+    itemView: DaySubView
+    template: daySubCollectionTemplate
+
+  ConverterViewControl.register
+    key: 'senkyoshi_importer'
+    view: new CanvasExportView
+      chooseMigrationFile: new ChooseMigrationFileView
+        model: ConverterViewControl.getModel()
+        fileSizeLimit: ENV.UPLOAD_LIMIT
+
+      selectContent: new SelectContentCheckboxView
+        model: ConverterViewControl.getModel()
+
+      dateShift: new DateShiftView
+        model: ConverterViewControl.getModel()
+        collection: daySubCollection
+        daySubstitution: daySubCollectionView
+        oldStartDate: ENV.OLD_START_DATE
+        oldEndDate: ENV.OLD_END_DATE

data/app/views/content_migrations/index.erb

@@ -0,0 +1,19 @@
+<!--
+Copyright (C) 2017 Atomic Jolt
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<%= render file: "#{Rails.root}/app/views/content_migrations/index.html.erb" %>
+<% js_bundle :content_migration_senkyoshi, plugin: :senkyoshi_canvas_plugin %>

data/app/views/senkyoshi_canvas_plugin/_plugin_settings.erb

@@ -0,0 +1,38 @@
+<!--
+Copyright (C) 2017 Atomic Jolt
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<%= fields_for :settings, OpenObject.new(settings) do |f| %>
+  <table style="width: 500px;" class="formtable">
+    <tr>
+      <td colspan="2">
+        <%= mt :description, "You will need access to a [Scorm Player](%{url}) service if you want to also convert courses with scorm content.", url: "https://github.com/atomicjolt/adhesion" %>
+      </td>
+    </tr>
+    <tr>
+      <td><%= f.blabel :scorm_url, en: "Scorm URL" %></td>
+      <td><%= f.text_field :scorm_url %></td>
+    </tr>
+    <tr>
+      <td><%= f.blabel :scorm_launch_url, en: "Scorm Launch URL" %></td>
+      <td><%= f.text_field :scorm_launch_url %></td>
+    </tr>
+    <tr>
+      <td><%= f.blabel :scorm_shared_auth, en: "Scorm Shared Auth" %></td>
+      <td><%= f.text_field :scorm_shared_auth %></td>
+    </tr>
+  </table>
+<% end %>

data/lib/canvas/migration/worker/senkyoshi_worker.rb

@@ -0,0 +1,198 @@
+# Copyright (C) 2017 Atomic Jolt
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "senkyoshi"
+
+ARGUMENT_ERROR =
+  "converter_class required for content migration with no file".freeze
+
+module Canvas
+  module Migration
+    module Worker
+      class SenkyoshiWorker < Base
+        def perform
+          migration ||= ContentMigration.where(id: migration_id).first
+          migration.job_progress.start unless migration.skip_job_progress
+
+          begin
+            migration.update_conversion_progress(1)
+
+            settings = _setup_settings(migration)
+
+            # Create the imscc file using Senkyoshi
+            imscc_path = settings[:file_path].ext(".imscc")
+            Senkyoshi.parse_and_process_single(settings[:file_path], imscc_path)
+
+            migration.update_conversion_progress(50)
+
+            if File.exists?(imscc_path)
+              _process_imscc(migration, settings, imscc_path)
+            else
+              text = I18n.t(:no_imscc_file, "Imscc file creation failed.")
+              raise Canvas::Migration::Error, text
+            end
+          rescue Canvas::Migration::Error => e
+            migration.add_error(e.message, exception: e)
+            migration.workflow_state = :failed
+            migration.job_progress.fail unless migration.skip_job_progress
+            migration.save
+          rescue => e
+            migration.fail_with_error!(e) if migration
+          end
+        end
+
+        def self.enqueue(content_migration)
+          Delayed::Job.enqueue(
+            new(content_migration.id),
+            priority: Delayed::LOW_PRIORITY,
+            max_attempts: 1,
+            strand: content_migration.strand,
+          )
+        end
+
+        def _setup_settings(migration)
+          settings = migration.migration_settings.clone
+          settings[:content_migration_id] = migration_id
+          settings[:user_id] = migration.user_id
+          settings[:content_migration] = migration
+
+          if migration.attachment
+            settings[:attachment_id] = migration.attachment.id
+            settings[:file_path] = migration.attachment.full_filename
+          elsif settings[:file_url]
+            attachment = Canvas::Migration::Worker.
+              download_attachment(migration, settings[:file_url])
+            settings[:attachment_id] = attachment.id
+            settings[:file_path] = attachment.full_filename
+          elsif !settings[:no_archive_file]
+            no_migration_file = "File required for content migration."
+            text = I18n.t(:no_migration_file, no_migration_file)
+            raise Canvas::Migration::Error, text
+          end
+          settings
+        end
+
+        def _process_imscc(migration, settings, imscc_path)
+          # Get the attachment for the ContentMigration
+          # And change its file to the imscc file temporarily
+          attachment = migration.attachment
+          attachment.write_attribute(:filename, File.basename(imscc_path))
+          attachment.save
+
+          converter_class = settings[:converter_class]
+          unless converter_class
+            if settings[:no_archive_file]
+              raise ArgumentError, ARGUMENT_ERROR
+            end
+            settings[:archive] = Canvas::Migration::Archive.new(settings)
+            converter_class = settings[:archive].get_converter
+          end
+
+          converter = converter_class.new(settings)
+          course = converter.export
+          export_folder_path = course[:export_folder_path]
+          overview_file_path = course[:overview_file_path]
+
+          _process_converted_data(
+            migration,
+            overview_file_path,
+            export_folder_path,
+          )
+
+          migration.migration_settings[:worker_class] = converter_class.name
+          migration.migration_settings[:migration_ids_to_import] =
+            { copy: { everything: true } }.merge(
+              migration.migration_settings[:migration_ids_to_import] || {},
+            )
+          if path = converter.course[:files_import_root_path]
+            migration.migration_settings[:files_import_root_path] = path
+          end
+
+          migration.workflow_state = :exported
+          saved = migration.save
+          migration.update_conversion_progress(100)
+
+          if migration.import_immediately? && !migration.for_course_copy?
+            _import_scorm(migration, settings)
+            saved = _import_content(migration, settings, attachment, converter)
+          end
+          saved
+        end
+
+        def _process_converted_data(migration,
+                                    overview_file_path,
+                                    export_folder_path)
+          if overview_file_path
+            file = File.new(overview_file_path)
+            Canvas::Migration::Worker::upload_overview_file(file, migration)
+            migration.update_conversion_progress(90)
+          end
+
+          if export_folder_path
+            Canvas::Migration::Worker::upload_exported_data(
+              export_folder_path,
+              migration,
+            )
+            Canvas::Migration::Worker::clear_exported_data(
+              export_folder_path,
+            )
+          end
+        end
+
+        def _import_scorm(migration, settings)
+          plugin = PluginSetting.find_by(name: "senkyoshi_importer")
+          if !plugin.disabled
+            Senkyoshi.configure do |config|
+              config.scorm_url = plugin.settings[:scorm_url]
+              config.scorm_launch_url = plugin.settings[:scorm_launch_url]
+              config.scorm_shared_auth = plugin.settings[:scorm_shared_auth]
+            end
+
+            meta = {
+              name: migration.context.name,
+            }
+            Zip::File.open(settings[:file_path], "rb") do |bb_zip|
+              senkyoshi_course = Senkyoshi::CanvasCourse.new(
+                meta,
+                migration.context,
+                bb_zip,
+              )
+              senkyoshi_course.process_scorm(local: true)
+            end
+            migration.update_import_progress(90)
+          end
+        end
+
+        def _import_content(migration, settings, attachment, converter)
+          migration.import_content
+
+          # Now that the import is done, change the attachment back
+          # to the blackboard zip for record keeping
+          attachment.write_attribute(
+            :filename,
+            File.basename(settings[:file_path]),
+          )
+          attachment.save
+          migration.update_import_progress(100)
+          saved = migration.save
+          if converter.respond_to?(:post_process)
+            converter.post_process
+          end
+          saved
+        end
+      end
+    end
+  end
+end

data/lib/senkyoshi_canvas_plugin.rb

@@ -0,0 +1,19 @@
+# Copyright (C) 2017 Atomic Jolt
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "senkyoshi_canvas_plugin/engine"
+
+module SenkyoshiCanvasPlugin
+end

data/lib/senkyoshi_canvas_plugin/engine.rb

@@ -0,0 +1,51 @@
+# Copyright (C) 2017 Atomic Jolt
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module SenkyoshiCanvasPlugin
+  NAME = "Senkyoshi Conversion Importer".freeze
+  DISPLAY_NAME = "Blackboard Cartridge".freeze
+  DESCRIPTION =
+    "This enables importing Blackboard Cartridges into Canvas.".freeze
+  class Engine < ::Rails::Engine
+    config.autoload_paths << File.expand_path(File.join(__FILE__, "../.."))
+
+    config.to_prepare do
+      Canvas::Plugin.register(
+        :senkyoshi_importer,
+        :export_system,
+        name: -> { I18n.t(:senkyoshi_name, NAME) },
+        display_name: -> { I18n.t :senkyoshi_display, DISPLAY_NAME },
+        author: "Atomic Jolt",
+        author_website: "http://www.atomicjolt.com/",
+        description: -> { t(:description, DESCRIPTION) },
+        version: SenkyoshiCanvasPlugin::VERSION,
+        settings_partial: "senkyoshi_canvas_plugin/plugin_settings",
+        select_text: -> do
+          I18n.t(:senkyoshi_importer_description, DISPLAY_NAME)
+        end,
+        settings: {
+          worker: "SenkyoshiWorker",
+          migration_partial: "canvas_config",
+          requires_file_upload: true,
+          provides: {
+            bb_learn: CC::Importer::Canvas::Converter,
+          },
+          valid_contexts: %w{Account Course},
+        },
+      )
+      require "senkyoshi_canvas_plugin/senkyoshi_migration"
+    end
+  end
+end

data/lib/senkyoshi_canvas_plugin/senkyoshi_migration.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2017 Atomic Jolt
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_dependency "app/controllers/content_migrations_controller"
+
+ENGINE_ROOT = SenkyoshiCanvasPlugin::Engine.root
+
+class ContentMigrationsController
+  alias index_without_senkyoshi index
+  def index
+    index_without_senkyoshi
+    if !performed?
+      render file: "#{ENGINE_ROOT}/app/views/content_migrations/index.erb"
+    end
+  end
+end

data/lib/senkyoshi_canvas_plugin/version.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2017 Atomic Jolt
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module SenkyoshiCanvasPlugin
+  VERSION = "1.0.1".freeze
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: senkyoshi_canvas_plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- James Carbine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: canvas_cc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: senkyoshi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- james.carbine@atomicjolt.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- app/coffeescripts/bundles/content_migration_senkyoshi.coffee
+- app/coffeescripts/content_migration_setup_senkyoshi.coffee
+- app/views/content_migrations/index.erb
+- app/views/senkyoshi_canvas_plugin/_plugin_settings.erb
+- lib/canvas/migration/worker/senkyoshi_worker.rb
+- lib/senkyoshi_canvas_plugin.rb
+- lib/senkyoshi_canvas_plugin/engine.rb
+- lib/senkyoshi_canvas_plugin/senkyoshi_migration.rb
+- lib/senkyoshi_canvas_plugin/version.rb
+homepage: http://www.atomicjolt.com
+licenses:
+- AGPL-3.0
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Senkyoshi Blackboard importer
+test_files: []