senkyoshi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb37815e8613f1dc566a20f201f9613fd0caa850
+  data.tar.gz: e7c7eb79f471a87f0e2f3f103074294649128659
+SHA512:
+  metadata.gz: 437ab1a18a0f0fa3038317efaf884341ad25b03f0fcf3c9b3d0bbd44cefec3e407ee3f7a6c302ea1eb8e1455330f33ca09e0d2d17d0c6c042ece072715eaedb3
+  data.tar.gz: 2fe6f2ab0dba999722a2b93d4d2f7667a1833d00c2b0a62e6b6600fb1439e882d2981bbfbf3a31e3a64619f0711b8f4d45f89743b5c76f5539918e4498f74dc6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 AtomicJolt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Senkyoshi Converter [![Build Status](https://travis-ci.org/atomicjolt/senkyoshi.svg?branch=master)](https://travis-ci.org/atomicjolt/senkyoshi)
+
+TODO: Describe the gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "senkyoshi"
+gem "canvas_cc", git: "https://github.com/atomicjolt/canvas_cc.git"
+```
+
+And then execute:
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+```sh
+$ gem install senkyoshi
+```
+
+Create a `Rakefile` and add
+```ruby
+require "senkyoshi/tasks"
+Senkyoshi::Tasks.install_tasks
+```
+
+Create a `senkyoshi.yml` and add credentials
+```yaml
+# Generally looks like https://< mycanvas_instance >/api
+:canvas_url: <canvas instance api url>
+
+# Canvas tokens can be generated at <my_canvas_url>/profile/setting provided
+# that the user has the required priviledges
+:canvas_token: <canvas token>
+
+# Url of scorm manager. This could the the adhesion app
+# [https://github.com/atomicjolt/adhesion]
+:scorm_url: <scorm manager url>
+
+# This should be the endpoint to launch a given scorm course, in the case of
+# adhesion this will look like https://<adhesion url>/scorm_course
+:scorm_launch_url: <scorm launch url>
+
+# This is the secret to authenticate requests to the scorm manager. In the case
+# of adhesion you can generate a shared secret by logging into the server and
+# 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>
+```
+
+## Usage
+
+Run the rake task to convert from .zip to .imscc
+```sh
+rake 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
+```
+
+Delete entire outputs folder
+```sh
+rake clean
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+
+## License
+
+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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "senkyoshi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/import_blackboard

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "senkyoshi"
+
+# ruby -Ilib ./bin/import_blackboard ~/sources ~/canvas
+Senkyoshi.parse(*ARGV)

data/lib/senkyoshi/canvas_course.rb

@@ -0,0 +1,179 @@
+require "pandarus"
+require "senkyoshi/config"
+require "senkyoshi/models/scorm_package"
+require "rest-client"
+
+module Senkyoshi
+  ##
+  # This class represents a canvas course for which we are uploading data to
+  ##
+  class CanvasCourse
+    ##
+    # A new canvas course accepts the metadata for a course
+    # and the pandarus course resourse
+    ##
+    def initialize(metadata, course_resource, blackboard_export)
+      @metadata = metadata
+      @course_resource = course_resource
+      @scorm_packages = ScormPackage.get_scorm_packages(blackboard_export)
+    end
+
+    ##
+    # Given a filename to a zip file, extract the necessary metadata
+    # for the course
+    ##
+    def self.metadata_from_file(filename)
+      Zip::File.open(filename) do |file|
+        settings = "course_settings/course_settings.xml"
+        config = file.find_entry(settings).get_input_stream.read
+        doc = Nokogiri::XML(config)
+        {
+          name: doc.at("title").text,
+        }
+      end
+    end
+
+    ##
+    # Create a new pandarus instance to communicate with the canvas server
+    ##
+    def self.client
+      @client ||= Pandarus::Client.new(
+        prefix: Senkyoshi.canvas_url,
+        token: Senkyoshi.canvas_token,
+      )
+    end
+
+    ##
+    # Find or Create a new CanvasCourse instance from the given metadata
+    ##
+    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,
+          },
+        )
+      CanvasCourse.new(metadata, canvas_course, blackboard_export)
+    end
+
+    ##
+    # 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']}"
+
+      payload = {
+        assignment__submission_types__: ["external_tool"],
+        assignment__integration_id__: scorm_package["package_id"],
+        assignment__integration_data__: {
+          provider: "atomic-scorm",
+        },
+        assignment__external_tool_tag_attributes__: {
+          url: url,
+        },
+      }
+
+      CanvasCourse.client.create_assignment(
+        course_id,
+        scorm_package["title"],
+        payload,
+      )
+    end
+
+    ##
+    # Uploads a scorm package to scorm manager specified in senkyoshi.yml
+    # config file
+    ##
+    def upload_scorm_package(scorm_package, course_id, tmp_name)
+      zip = scorm_package.write_zip tmp_name
+      File.open(zip, "rb") do |file|
+        RestClient.post(
+          "#{Senkyoshi.scorm_url}/api/scorm_courses",
+          {
+            oauth_consumer_key: "scorm-player",
+            lms_course_id: course_id,
+            file: file,
+          },
+          SharedAuthorization: Senkyoshi.scorm_shared_auth,
+        ) do |resp|
+          JSON.parse(resp.body)["response"]
+        end
+      end
+    end
+
+    ##
+    # 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) }
+    end
+
+    ##
+    # Uploads all scorm packages to scorm manager specified in senkyoshi.yml
+    # config file
+    ##
+    def upload_scorm_packages(scorm_packages)
+      package_index = 0
+      scorm_packages.map do |pack|
+        package_index += 1
+        tmp_name = "#{@metadata[:name]}_#{package_index}.zip"
+        upload_scorm_package(pack, @course_resource.id, tmp_name)
+      end
+    end
+
+    ##
+    # Create a migration for the course
+    # and upload the imscc file to be imported into the course
+    ##
+    def upload_content(filename)
+      client = CanvasCourse.client
+      name = File.basename(filename)
+      # Create a migration for the course and get S3 upload authorization
+      migration = client.
+        create_content_migration_courses(
+          @course_resource.id,
+          :canvas_cartridge_importer,
+          pre_attachment: { name: name },
+        )
+
+      puts "Uploading: #{name}"
+      upload_to_s3(migration, filename)
+      puts "Done uploading: #{name}"
+
+      puts "Creating Scorm: #{name}"
+      create_scorm_assignments(
+        upload_scorm_packages(@scorm_packages),
+        @course_resource.id,
+      )
+      puts "Done creating scorm: #{name}"
+    end
+
+    def upload_to_s3(migration, filename)
+      File.open(filename, "rb") do |file|
+        # Attach the file to the S3 auth
+        pre_attachment = migration.pre_attachment
+        upload_url = pre_attachment["upload_url"]
+        upload_params = pre_attachment["upload_params"]
+        upload_params[:file] = file
+
+        # Post to S3
+        RestClient.post(
+          upload_url,
+          upload_params,
+        ) do |response|
+          # Post to Canvas
+          RestClient.post(
+            response.headers[:location],
+            nil,
+            Authorization: "Bearer #{Senkyoshi.canvas_token}",
+          )
+        end
+      end
+    end
+  end
+end

data/lib/senkyoshi/collection.rb

@@ -0,0 +1,26 @@
+module Senkyoshi
+  class Collection
+    attr_reader :resources
+
+    def initialize
+      @resources = []
+    end
+
+    def add(resources)
+      @resources.concat(resources)
+    end
+
+    def detect_xid(xid)
+      @resources.detect do |resource|
+        resource.matches_xid? xid
+      end
+    end
+
+    def each
+      @resources.each do |resource|
+        yield resource
+      end
+      self
+    end
+  end
+end

data/lib/senkyoshi/config.rb

@@ -0,0 +1,35 @@
+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

data/lib/senkyoshi/exceptions.rb

@@ -0,0 +1,13 @@
+module Exceptions
+  class BadFileNameError < StandardError
+    def initialize(msg = "Bad File Name")
+      super(msg)
+    end
+  end
+
+  class MissingFileError < StandardError
+    def initialize(msg = "Couldn't find file")
+      super(msg)
+    end
+  end
+end

data/lib/senkyoshi/models/announcement.rb

@@ -0,0 +1,36 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Announcement < Resource
+    def initialize
+      @title = ""
+      @text = ""
+      @delayed_post = ""
+      @posted_at = ""
+      @identifier = Senkyoshi.create_random_hex
+      @dependency = Senkyoshi.create_random_hex
+      @type = "announcement"
+    end
+
+    def iterate_xml(data, _)
+      dates = data.children.at("DATES")
+      @title = Senkyoshi.get_attribute_value(data, "TITLE")
+      @text = Senkyoshi.get_text(data, "TEXT")
+      @delayed_post = Senkyoshi.get_attribute_value(dates, "RESTRICTSTART")
+      @posted_at = Senkyoshi.get_attribute_value(dates, "CREATED")
+      self
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      announcement = CanvasCc::CanvasCC::Models::Announcement.new
+      announcement.title = @title
+      announcement.text = @text
+      announcement.delayed_post = @delayed_post
+      announcement.posted_at = @posted_at
+      announcement.identifier = @identifier
+      announcement.dependency = @dependency
+      course.announcements << announcement
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/answer.rb

@@ -0,0 +1,32 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Answer < Resource
+    attr_reader :id, :answer_text
+    attr_accessor :fraction, :resp_ident, :feedback
+
+    def initialize(text, id = Senkyoshi.create_random_hex)
+      @answer_text = text
+      @resp_ident = ""
+      @fraction = ""
+      @feedback = ""
+      @points = 0
+      @id = id
+    end
+
+    def iterate_xml
+      self
+    end
+
+    def canvas_conversion(question, resources)
+      answer = CanvasCc::CanvasCC::Models::Answer.new(@answer_text)
+      answer.answer_text = fix_html(@answer_text, resources)
+      answer.id = @id
+      answer.fraction = @fraction
+      answer.feedback = @feedback
+      answer.resp_ident = @resp_ident
+      question.answers << answer
+      question
+    end
+  end
+end

data/lib/senkyoshi/models/assessment.rb

@@ -0,0 +1,95 @@
+require "senkyoshi/models/assignment_group"
+require "senkyoshi/models/assignment"
+require "senkyoshi/models/question"
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Assessment < Resource
+    def initialize
+      @title = ""
+      @description = ""
+      @quiz_type = "assignment"
+      @points_possible = 0
+      @items = []
+      @group_name = ""
+      @workflow_state = "published"
+      @available = true
+    end
+
+    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
+      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
+    end
+  end
+end

data/lib/senkyoshi/models/assignment.rb

@@ -0,0 +1,26 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Assignment < Content
+    def canvas_conversion(course, resources)
+      unless @title == "--TOP--"
+        assignment = CanvasCc::CanvasCC::Models::Assignment.new
+        assignment.identifier = @id
+        assignment.title = @title
+        assignment.body = fix_html(@body, resources)
+        assignment.points_possible = @points
+        assignment.assignment_group_identifier_ref = @group_id
+        assignment.position = 1
+        assignment.workflow_state = "published"
+        assignment.submission_types << "online_text_entry"
+        assignment.submission_types << "online_upload"
+        assignment.grading_type = "points"
+
+        @files.each { |f| assignment.body << f.canvas_conversion }
+        course = create_module(course)
+        course.assignments << assignment
+      end
+      course
+    end
+  end
+end

data/lib/senkyoshi/models/assignment_group.rb

@@ -0,0 +1,23 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class AssignmentGroup < Resource
+    attr_reader :id
+    def initialize(name, group_id)
+      @title = name
+      @group_weight = ""
+      @rules = {}
+      @id = group_id
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      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
+    end
+  end
+end

data/lib/senkyoshi/models/blog.rb

@@ -0,0 +1,22 @@
+require "senkyoshi/models/resource"
+
+module Senkyoshi
+  class Blog < Resource
+    def initialize
+      @title = ""
+      @description = ""
+      @is_public = true
+    end
+
+    def iterate_xml(data, _)
+      @name = Senkyoshi.get_attribute_value(data, "TITLE")
+      @description = data.at("TEXT").text
+      @is_public = Senkyoshi.get_attribute_value(data, "ISAVAILABLE")
+      self
+    end
+
+    def canvas_conversion(course, _resources = nil)
+      course
+    end
+  end
+end