canvas_cc 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 034bb68abda058a2fa71a6e86d924d3c7b059ca0
-  data.tar.gz: 277db8637afa11a36f247484c623eff0bd4cd8d0
+  metadata.gz: 2f86794affc4033afb84e2972e08ff383331d65e
+  data.tar.gz: 98fd7535f07d5e624d244a820d5a2b3ba4a9f313
 SHA512:
-  metadata.gz: 7af394a205b88d2477b100fb184a0adccaf491658e8bda7a2ae6ce3fd0af37dfaefa7c5f41b7c124cc318e100d5a63d6bda185dab34d615b9b58bffa836961b6
-  data.tar.gz: 2b96e940598465ec89c0ebcf2ec7d4f657519f52fe6890144efc6531308637fee69aec6e96993b21fd46d98b87e2740dcb0974960ec19e87c39f23be19ce4208
+  metadata.gz: adce606f2fb582b1609ad19f3db16ba87f2c4331d821a3d2e7f0d683e55fecdfae5f3fb2df02e24408a5fff136d9af26a8f04ecace963a409169e01b27269035
+  data.tar.gz: ec55da56ea3b4dc62285655412078144553374915c19eed1418f9554b7961a8b71c8e2768d9ee10566b1d2a223b475f65a3cc78f90e9aec7799cc576e100d49e

data/lib/canvas_cc/canvas_cc/cartridge_creator.rb

@@ -40,7 +40,7 @@ module CanvasCc::CanvasCC
       CanvasCc::CanvasCC::AssignmentGroupWriter.new(dir, @course.assignment_groups).write
       CanvasCc::CanvasCC::ModuleMetaWriter.new(dir, *@course.canvas_modules).write
       CanvasCc::CanvasCC::ImsManifestGenerator.new(dir, @course).write
-      CanvasCc::CanvasCC::FileMetaWriter.new(dir, *@course.files).write
+      CanvasCc::CanvasCC::FileMetaWriter.new(dir, @course.files, @course.folders).write
       CanvasCc::CanvasCC::PageWriter.new(dir, *@course.pages).write
       CanvasCc::CanvasCC::DiscussionWriter.new(dir, *@course.discussions).write
       CanvasCc::CanvasCC::AssignmentWriter.new(dir, *@course.assignments).write

data/lib/canvas_cc/canvas_cc/file_meta_writer.rb

@@ -3,20 +3,45 @@ module CanvasCc::CanvasCC
 
     FILE_META_FILE = 'files_meta.xml'
 
-    def initialize(work_dir, *canvas_files)
+    def initialize(work_dir, canvas_files, canvas_folders)
       @work_dir = work_dir
-      @canvas_files = canvas_files
+      @canvas_files = [canvas_files].flatten.compact
+      @canvas_folders = [canvas_folders].flatten.compact
     end
 
     def write
-      copy_files
-      write_xml
+      copy_files unless @canvas_files.nil?
+      write_xml do |xml|
+        write_folders(xml) unless @canvas_folders.empty?
+        write_files(xml) unless @canvas_files.empty?
+      end
     end
 
     private
 
-    def copy_files
+    def write_folders(xml)
+      xml.folders{
+        @canvas_folders.each do |folder|
+          xml.folder('path' => folder.folder_location){
+            xml.hidden folder.hidden unless folder.hidden.nil?
+            xml.locked folder.locked unless folder.locked.nil?
+          }
+        end
+      }
+    end
 
+    def write_files(xml)
+      xml.files{
+        @canvas_files.each do |file|
+          xml.file('identifier' => file.identifier){
+            xml.hidden file.hidden unless file.hidden.nil?
+            xml.locked file.locked unless file.locked.nil?
+          }
+        end
+      }
+    end
+
+    def copy_files
       @canvas_files.each do |canvas_file|
         FileUtils.mkdir_p(File.dirname(File.join(@work_dir, canvas_file.href)))
         FileUtils.cp(canvas_file.file_location, File.join(@work_dir, canvas_file.href))
@@ -29,10 +54,12 @@ module CanvasCc::CanvasCC
           'xmlns' => 'http://canvas.instructure.com/xsd/cccv1p0',
           'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
           'xsi:schemaLocation' => 'http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd'
-        )
+        ){
+          yield xml
+        }
       end.to_xml
       File.open(File.join(@work_dir, CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR, FILE_META_FILE), 'w') { |f| f.write(xml) }
     end
 
   end
-end
+end

data/lib/canvas_cc/canvas_cc/models/canvas_file.rb

@@ -4,7 +4,7 @@ module CanvasCc::CanvasCC::Models
     WEB_RESOURCES = 'web_resources'
 
     attr_reader :file_path
-    attr_accessor :file_location
+    attr_accessor :file_location, :hidden, :locked
 
     def initialize
       super
@@ -19,4 +19,4 @@ module CanvasCc::CanvasCC::Models
 
 
   end
-end
+end

data/lib/canvas_cc/canvas_cc/models/canvas_folder.rb

@@ -0,0 +1,15 @@
+module CanvasCc::CanvasCC::Models
+  class CanvasFolder < CanvasCc::CanvasCC::Models::Resource
+
+    WEB_RESOURCES = 'web_resources'
+
+    attr_accessor :folder_location, :hidden, :locked
+
+    def initialize
+      super
+      @type = WEB_CONTENT_TYPE
+    end
+
+
+  end
+end

data/lib/canvas_cc/canvas_cc/models/course.rb

@@ -2,13 +2,14 @@ module CanvasCc::CanvasCC::Models
   class Course
 
     attr_accessor :format, :identifier, :copyright, :settings, :resources, :canvas_modules, :files, :pages, :discussions,
-                  :assignments, :assessments, :question_banks, :assignment_groups
+                  :assignments, :assessments, :question_banks, :assignment_groups, :folders
 
     def initialize
       @settings = {}
       @resources = []
       @canvas_modules = []
       @files = []
+      @folders = []
       @pages = []
       @discussions = []
       @assignments = []

data/lib/canvas_cc/version.rb

@@ -1,3 +1,3 @@
 module CanvasCc
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/canvas_cc.rb

@@ -86,6 +86,7 @@ module CanvasCc
       autoload :CanvasModule, 'canvas_cc/canvas_cc/models/canvas_module'
       autoload :ModuleItem, 'canvas_cc/canvas_cc/models/module_item'
       autoload :CanvasFile, 'canvas_cc/canvas_cc/models/canvas_file'
+      autoload :CanvasFolder, 'canvas_cc/canvas_cc/models/canvas_folder'
       autoload :Page, 'canvas_cc/canvas_cc/models/page'
       autoload :Discussion, 'canvas_cc/canvas_cc/models/discussion'
       autoload :WorkflowState, 'canvas_cc/canvas_cc/models/workflow_state'

data/spec/moodle2cc/canvas_cc/file_meta_writer_spec.rb

@@ -4,6 +4,7 @@ module CanvasCc::CanvasCC
   describe FileMetaWriter do
 
     let(:file) { Models::CanvasFile.new }
+    let(:folder) { Models::CanvasFolder.new }
     let(:tmpdir) { Dir.mktmpdir }
 
     before :each do
@@ -15,28 +16,59 @@ module CanvasCc::CanvasCC
     end
 
     it 'xml contains the correct schema' do
-      meta_writer = writer(file)
+      meta_writer = writer(file, nil)
       meta_writer.stub(:copy_files) { nil }
       xml = write_xml(meta_writer)
       assert_xml_schema(xml)
     end
 
     it '#write' do
-      Dir.mktmpdir do |dir|
-        source_file = File.join(dir, 'sample.txt')
-        FileUtils.touch(source_file)
+      create_file('sample.txt') do |source_file|
         file.file_location = source_file
         file.file_path = 'sample.txt'
-        write_xml(writer(file))
+        write_xml(writer(file, nil))
         path = File.join(tmpdir, Models::CanvasFile::WEB_RESOURCES, 'sample.txt')
         expect(File.exist?(path)).to be_true
       end
     end
 
+    it 'writes files' do
+      file.hidden = true
+      file.locked = true
+      file.identifier = 'abc123'
+      create_file('sample.txt') do |source_file|
+        file.file_location = source_file
+        file.file_path = 'sample.txt'
+        xml = write_xml(writer(file, nil))
+        expect(xml.at_xpath('xmlns:fileMeta/xmlns:files/xmlns:file/@identifier').text).to eq 'abc123'
+        expect(xml.at_xpath('xmlns:fileMeta/xmlns:files/xmlns:file/xmlns:locked').text).to eq 'true'
+        expect(xml.at_xpath('xmlns:fileMeta/xmlns:files/xmlns:file/xmlns:hidden').text).to eq 'true'
+      end
+    end
+
+    it 'writes folders' do
+      folder.hidden = true
+      folder.locked = true
+      folder.folder_location = '/folder1'
+      xml = write_xml(writer(nil, folder))
+      expect(xml.at_xpath('xmlns:fileMeta/xmlns:folders/xmlns:folder/@path').text).to eq '/folder1'
+      expect(xml.at_xpath('xmlns:fileMeta/xmlns:folders/xmlns:folder/xmlns:locked').text).to eq 'true'
+      expect(xml.at_xpath('xmlns:fileMeta/xmlns:folders/xmlns:folder/xmlns:hidden').text).to eq 'true'
+
+    end
+
     private
 
-    def writer(file)
-      FileMetaWriter.new(tmpdir, file)
+    def create_file(name)
+      Dir.mktmpdir do |dir|
+        source_file = File.join(dir, name)
+        FileUtils.touch(source_file)
+        yield source_file
+      end
+    end
+
+    def writer(file, folder)
+      FileMetaWriter.new(tmpdir, file, folder)
     end
 
     def write_xml(writer)
@@ -54,4 +86,4 @@ module CanvasCc::CanvasCC
     end
 
   end
-end
+end

data/spec/moodle2cc/canvas_cc/models/canvas_file_spec.rb

@@ -5,6 +5,8 @@ module CanvasCc::CanvasCC::Models
 
     it_behaves_like 'a CanvasCc::CanvasCC::Models::Resource'
     it_behaves_like 'it has an attribute for', :file_location
+    it_behaves_like 'it has an attribute for', :hidden
+    it_behaves_like 'it has an attribute for', :locked
 
     it 'has a type to webcontent' do
       expect(subject.type).to eq(Resource::WEB_CONTENT_TYPE)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_cc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -268,6 +268,7 @@ files:
 - lib/canvas_cc/canvas_cc/models/assignment_group.rb
 - lib/canvas_cc/canvas_cc/models/calculated_question.rb
 - lib/canvas_cc/canvas_cc/models/canvas_file.rb
+- lib/canvas_cc/canvas_cc/models/canvas_folder.rb
 - lib/canvas_cc/canvas_cc/models/canvas_module.rb
 - lib/canvas_cc/canvas_cc/models/course.rb
 - lib/canvas_cc/canvas_cc/models/discussion.rb