canvas_cc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d5b190664a730e9d2839c9b715a20e8a91988d9
+  data.tar.gz: 4452a41e24adc5fd4bf4770c5b323ea30e505e63
+SHA512:
+  metadata.gz: 519c8fc168efbd2d16d9a5ddfcc55acd3f35f6463834d99099e73300972e1672f1510c035001e484b1fa99e858cf9104e5bc04568797f2320251d600bc78c7b3
+  data.tar.gz: 3a6c5a60d809a6e047e5e4d2c57d234137ad2c31b2b1a87b057176237fbf95e5ffafee18b853315f614c46cce15a8a1ba40a7b737e85d7910d63dbe5b01941c8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in canvas_cc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brandon Broschinsky
+
+MIT License
+
+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,29 @@
+# CanvasCc
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'canvas_cc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install canvas_cc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/canvas_cc/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/canvas_cc.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'canvas_cc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "canvas_cc"
+  spec.version       = CanvasCc::VERSION
+  spec.authors       = ["Instructure"]
+  spec.email         = ["pseng@instructure.com"]
+  spec.summary       = %q{Create Canvas CC compatible file}
+  spec.description   = %q{Create Canvas CC compatible file}
+  spec.homepage      = ""
+  spec.license       = "AGPLv3"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubyzip", '>=1.0.0'
+  spec.add_runtime_dependency "happymapper"
+  spec.add_runtime_dependency "builder"
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "rdiscount"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rspec", "~> 2"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "bundler", "~> 1.5"
+end

data/lib/canvas_cc/canvas/assessment.rb

@@ -0,0 +1,124 @@
+module CanvasCc::Canvas
+  class Assessment < CanvasCc::CC::Assessment
+    include Resource
+    META_ATTRIBUTES = [:title, :description, :lock_at, :unlock_at, :allowed_attempts,
+      :scoring_policy, :access_code, :ip_filter, :shuffle_answers, :time_limit, :quiz_type]
+
+    attr_accessor :questions, :non_cc_assessments_identifier, *META_ATTRIBUTES
+
+    def initialize(mod, position=0)
+      super
+      description = [mod.intro, mod.content, mod.text, mod.summary].compact.reject { |d| d.length == 0 }.first || ''
+      @description = convert_file_path_tokens(description)
+      if mod.time_close.to_i > 0
+        @lock_at = ims_datetime(Time.at(mod.time_close))
+      end
+      if mod.time_open.to_i > 0
+        @unlock_at = ims_datetime(Time.at(mod.time_open))
+      end
+      @time_limit = mod.time_limit
+      @allowed_attempts = mod.attempts_number
+      @scoring_policy = mod.grade_method == 4 ? 'keep_latest' : 'keep_highest'
+      @access_code = mod.password
+      @ip_filter = mod.subnet
+      @shuffle_answers = mod.shuffle_answers
+      @quiz_type = 'survey' unless mod.mod_type == 'quiz'
+      @non_cc_assessments_identifier = create_key(@id, 'non_cc_assessments_')
+      @questions = []
+      mod.questions.each do |question|
+        if question.type == 'random'
+          question_bank = QuestionBank.new question.question_category
+          last = @questions.last
+          if last && last.is_a?(QuestionGroup) && last.points_per_item == question.grade && last.sourcebank_ref == question_bank.identifier
+            last.increment_selection_number
+          else
+            group = @questions.select { |q| q.is_a?(QuestionGroup) }.last
+            id = group ? group.id + 1 : 1
+            @questions << QuestionGroup.new(:id => id, :question_bank => question_bank, :points_per_item => question.grade)
+          end
+        else
+          @questions << Question.new(question, self)
+        end
+      end
+    end
+
+    def create_resource_node(resources_node)
+      super
+
+      href = File.join(identifier, ASSESSMENT_META)
+      resources_node.resource(
+        :href => href,
+        :type => LOR,
+        :identifier => non_cc_assessments_identifier
+      ) do |resource_node|
+        resource_node.file(:href => href)
+        resource_node.file(:href => File.join(ASSESSMENT_NON_CC_FOLDER, "#{identifier}.xml.qti"))
+      end
+    end
+
+    def create_resource_sub_nodes(resource_node)
+      resource_node.dependency :identifierref => non_cc_assessments_identifier
+    end
+
+    def create_files(export_dir)
+      create_assessment_meta_xml(export_dir)
+      create_non_cc_qti_xml(export_dir)
+    end
+
+    def create_assessment_meta_xml(export_dir)
+      path = File.join(export_dir, identifier, ASSESSMENT_META)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        node.instruct!
+        node.quiz(
+          :identifier => identifier,
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |quiz_node|
+          META_ATTRIBUTES.each do |attr|
+            quiz_node.tag!(attr, send(attr)) unless send(attr).nil?
+          end
+        end
+      end
+    end
+
+    def create_non_cc_qti_xml(export_dir)
+      path = File.join(export_dir, ASSESSMENT_NON_CC_FOLDER, "#{identifier}.xml.qti")
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        node.instruct!
+        node.questestinterop(
+          'xsi:schemaLocation' => "http://www.imsglobal.org/xsd/ims_qtiasiv1p2 http://www.imsglobal.org/xsd/ims_qtiasiv1p2p1.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://www.imsglobal.org/xsd/ims_qtiasiv1p2"
+        ) do |root_node|
+          root_node.assessment(:title => title, :ident => identifier) do |assessment_node|
+            assessment_node.qtimetadata do |qtimetadata_node|
+              qtimetadata_node.qtimetadatafield do |qtimetadatafield_node|
+                qtimetadatafield_node.fieldlabel "qmd_timelimit"
+                qtimetadatafield_node.fieldentry time_limit
+              end
+              qtimetadata_node.qtimetadatafield do |qtimetadatafield_node|
+                qtimetadatafield_node.fieldlabel "cc_maxattempts"
+                qtimetadatafield_node.fieldentry allowed_attempts
+              end
+            end
+            assessment_node.section(:ident => 'root_section') do |section_node|
+              @questions.each do |question|
+                question.create_item_xml(section_node)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'Quiz'
+      item_node.identifierref @identifier
+    end
+  end
+end

data/lib/canvas_cc/canvas/assignment.rb

@@ -0,0 +1,98 @@
+module CanvasCc::Canvas
+  class Assignment < CanvasCc::CC::Assignment
+    include Resource
+    SETTINGS_ATTRIBUTES = [:title, :points_possible, :grading_type, :due_at,
+      :lock_at, :unlock_at, :all_day, :all_day_date, :submission_types,
+      :position, :peer_reviews, :automatic_peer_reviews, :peer_review_count,
+      :anonymous_peer_reviews, :assignment_group_identifierref]
+
+    attr_accessor *SETTINGS_ATTRIBUTES
+
+    def initialize(mod, position=0)
+      super
+      @rel_path = "#{identifier}/#{file_slug(@title)}.html"
+      @resource_type = LOR
+      @body = convert_file_path_tokens(mod.description)
+      @points_possible = mod.grade_item ? mod.grade_item.grade_max : mod.grade
+      @grading_type = 'points'
+      if mod.time_due.to_i > 0
+        @due_at = ims_datetime(Time.at(mod.time_due))
+        @all_day = Time.at(mod.time_due).utc.strftime('%H:%M') == '23:59' ? true : false
+        if @all_day
+          @all_day_date = ims_date(Time.at(mod.time_due))
+        end
+        if mod.prevent_late
+          @lock_at = @due_at
+        end
+      end
+      if mod.time_available.to_i > 0
+        @unlock_at = ims_datetime(Time.at(mod.time_available))
+      end
+      if mod.submission_end.to_i > 0
+        @due_at = ims_datetime(Time.at(mod.submission_end))
+      end
+      @submission_types = get_submission_types(mod)
+      @position = position
+      @peer_reviews = @automatic_peer_reviews = mod.mod_type == 'workshop'
+      @peer_review_count = mod.number_of_student_assessments
+      @anonymous_peer_reviews = mod.anonymous
+      @assignment_group_identifierref = create_key(mod.section_mod.section.id, 'assignment_group_')
+    end
+
+    def get_submission_types(mod)
+      if mod.mod_type == 'assignment'
+        case mod.assignment_type
+        when 'online'
+          'online_text_entry'
+        when 'upload'
+          if mod.var2 == 1
+            'online_upload,online_text_entry'
+          else
+            'online_upload'
+          end
+        when 'uploadsingle'
+          'online_upload'
+        else
+          'none'
+        end
+      elsif mod.mod_type == 'workshop'
+        submission_types = ['online_text_entry']
+        submission_types.unshift('online_upload') if mod.number_of_attachments > 0
+        submission_types.join(',')
+      end
+    end
+
+    def create_resource_sub_nodes(resource_node)
+      resource_node.file(:href => File.join(identifier, ASSIGNMENT_SETTINGS))
+    end
+
+    def create_files(export_dir)
+      super
+      create_settings_xml(export_dir)
+    end
+
+    def create_settings_xml(export_dir)
+      path = File.join(export_dir, identifier, ASSIGNMENT_SETTINGS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        settings_node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        settings_node.instruct!
+        settings_node.assignment(
+          :identifier => identifier,
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |assignment_node|
+          SETTINGS_ATTRIBUTES.each do |attr|
+            assignment_node.tag!(attr, send(attr)) unless send(attr).nil?
+          end
+        end
+      end
+    end
+
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'Assignment'
+      item_node.identifierref @identifier
+    end
+  end
+end

data/lib/canvas_cc/canvas/converter.rb

@@ -0,0 +1,30 @@
+module CanvasCc::Canvas
+  class Converter < CanvasCc::CC::Converter
+    def initialize(moodle_backup, destination_dir)
+      super
+      @resource_factory = CanvasCc::ResourceFactory.new CanvasCc::Canvas
+    end
+
+    def create_resources(resources_node)
+      create_course_content(resources_node)
+      @moodle_backup.course.question_categories.each do |question_category|
+        create_question_bank_resource(resources_node, question_category)
+      end
+      super
+    end
+
+    def create_question_bank_resource(resources_node, question_category)
+      question_bank = QuestionBank.new(question_category)
+      if question_bank.questions.length > 0
+        question_bank.create_resource_node(resources_node)
+        question_bank.create_files(@export_dir)
+      end
+    end
+
+    def create_course_content(resources_node)
+      course = Course.new(@moodle_backup.course)
+      course.create_resource_node(resources_node)
+      course.create_files(@export_dir)
+    end
+  end
+end

data/lib/canvas_cc/canvas/course.rb

@@ -0,0 +1,143 @@
+module CanvasCc::Canvas
+  class Course < CanvasCc::CC::Course
+
+    attr_accessor :id, :title, :course_code, :start_at, :format, :is_public, :syllabus_body
+
+    def initialize(course)
+      super
+
+      @course = course
+
+      @id = course.id
+      @title = course.fullname
+      @course_code = course.shortname
+      @start_at = ims_datetime(Time.at(course.startdate))
+      @is_public = course.visible
+      @syllabus_body = convert_file_path_tokens(course.sections.first.summary)
+      @resource_factory = CanvasCc::ResourceFactory.new CanvasCc::Canvas
+    end
+
+    def identifier
+      create_key(id, 'course_')
+    end
+
+    def create_resource_node(resources_node)
+      syllabus_href = File.join(COURSE_SETTINGS_DIR, SYLLABUS)
+      resources_node.resource(
+        :intendeduse => 'syllabus',
+        :href => syllabus_href,
+        :type => LOR,
+        :identifier => create_key(syllabus_href, 'resource_')
+      ) do |resource_node|
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, SYLLABUS))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, COURSE_SETTINGS))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, FILES_META))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, MODULE_META))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, ASSIGNMENT_GROUPS))
+      end
+    end
+
+    def create_files(export_dir)
+      create_syllabus_file(export_dir)
+      create_course_settings_xml(export_dir)
+      create_files_meta_xml(export_dir)
+      create_assignment_groups_xml(export_dir)
+      create_module_meta_xml(export_dir)
+    end
+
+    def create_syllabus_file(export_dir)
+      template = File.expand_path('../templates/syllabus.html.erb', __FILE__)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, SYLLABUS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        erb = ERB.new(File.read(template))
+        file.write(erb.result(binding))
+      end
+    end
+
+    def create_course_settings_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, COURSE_SETTINGS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.course(
+          :identifier => identifier,
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |course_node|
+          course_node.title @title
+          course_node.course_code @course_code
+          course_node.start_at @start_at
+          course_node.is_public @is_public
+          course_node.license 'private'
+        end
+      end
+    end
+
+    def create_module_meta_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, MODULE_META)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.modules(
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |modules_node|
+          @course.sections.each do |section|
+            next if section.mods.length == 0
+            modules_node.module(:identifier => create_key(section.id, 'section_')) do |module_node|
+              module_node.title "#{@format} #{section.number}"
+              module_node.position section.number
+              module_node.require_sequential_progress false
+              module_node.items do |items_node|
+                section.mods.each_with_index do |mod, index|
+                  resource = @resource_factory.get_resource_from_mod(mod.instance)
+                  resource.create_module_meta_item_node(items_node, index) if resource
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def create_assignment_groups_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, ASSIGNMENT_GROUPS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.assignmentGroups(
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |assignment_groups_node|
+          @course.sections.each do |section|
+            next unless section.mods.select { |mod| mod.instance.mod_type == "assignment" }.length > 0
+            assignment_groups_node.assignmentGroup(:identifier => create_key(section.id, "assignment_group_")) do |assignment_group_node|
+              assignment_group_node.title "Week #{section.number}"
+            end
+          end
+        end
+      end
+    end
+
+    def create_files_meta_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, FILES_META)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.filesMeta(
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0")
+      end
+    end
+
+  end
+end

data/lib/canvas_cc/canvas/discussion_topic.rb

@@ -0,0 +1,64 @@
+module CanvasCc::Canvas
+  class DiscussionTopic < CanvasCc::CC::DiscussionTopic
+    include Resource
+    attr_accessor :posted_at, :position, :type, :identifierref
+
+    def initialize(mod, position=0)
+      super
+      @text = convert_file_path_tokens(mod.intro)
+
+      if mod.section_mod && mod.section_mod.added.to_i > 0
+        @posted_at = ims_datetime(Time.at(mod.section_mod.added))
+      end
+
+      @position = position
+      @type = 'topic'
+      @identifierref = create_key(@id, 'topic_meta_')
+    end
+
+    def create_resource_node(resources_node)
+      super
+      resources_node.resource(
+        :type => LOR,
+        :identifier => @identifierref,
+        :href => "#{@identifierref}.xml"
+      ) do |resource_node|
+        resource_node.file(:href => "#{@identifierref}.xml")
+      end
+    end
+
+    def create_resource_sub_nodes(resource_node)
+      resource_node.dependency(:identifierref => @identifierref)
+    end
+
+    def create_files(export_dir)
+      super
+      create_topic_meta_xml(export_dir)
+    end
+
+    def create_topic_meta_xml(export_dir)
+      path = File.join(export_dir, "#{@identifierref}.xml")
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.topicMeta(
+          :identifier => @identifierref,
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |topic_meta|
+          topic_meta.topic_id identifier
+          topic_meta.title @title
+          topic_meta.posted_at @posted_at
+          topic_meta.position @position
+          topic_meta.type @type
+        end
+      end
+    end
+
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'DiscussionTopic'
+      item_node.identifierref @identifier
+    end
+  end
+end

data/lib/canvas_cc/canvas/label.rb

@@ -0,0 +1,8 @@
+module CanvasCc::Canvas
+  class Label < CanvasCc::CC::Label
+    include Resource
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'ContextModuleSubHeader'
+    end
+  end
+end