common_cartridge_parser 1.0.0

data/lib/common_cartridge/parsers/questions.rb

@@ -0,0 +1,34 @@
+module CommonCartridge
+  module Parsers
+    class Questions
+      def initialize(zipfile, quiz)
+        @zipfile = zipfile
+        @quiz = quiz
+      end
+
+      def parse!
+        @quiz.file_locations.each do |location|
+          Parser.use_file(@zipfile, location) do |xml|
+            doc = Nokogiri::XML(xml)
+            doc.remove_namespaces!
+            unless @quiz.question_count && !canvas?(location)
+              # We need all questions that aren't a text only question. Re-usable, important sibling XML elements *sigh*.
+              @quiz.question_count = doc.xpath("//item//fieldlabel[text()='question_type' or text()='cc_profile']/following-sibling::fieldentry[1][text() != 'text_only_question']").length
+            end
+
+            unless @quiz.points_possible
+              if points = doc.xpath("//fieldlabel[text()='points_possible']/following-sibling::fieldentry[1]")
+                @quiz.points_possible = points.text
+              end
+            end
+          end
+        end
+      end
+
+      private
+      def canvas?(location)
+        location =~ /non_cc_assessments/
+      end
+    end
+  end
+end

data/lib/common_cartridge/version.rb

@@ -0,0 +1,3 @@
+module CommonCartridge
+  VERSION = '1.0.0'.freeze
+end

data/spec/elements/lom_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    module Lom
+      describe General do
+        before(:all) do
+          manifest = CommonCartridge.parse_from_zip('canvas_small_1.1.imscc').manifest
+          @lom = manifest.metadata.lom
+        end
+
+        subject(:general) { @lom.general }
+
+        it "parses correctly" do
+          expect(general).to be_kind_of(CommonCartridge::Elements::Lom::General)
+        end
+
+        context "title element" do
+          it "parses correctly" do
+            expect(general.title).to be_kind_of(CommonCartridge::Elements::Lom::Title)
+          end
+
+          it "has a value attribute" do
+            expect(general.title.value).to eq("Common Cartridge Test Data Set - Validation Cartridge 1")
+          end
+
+          it "has a language attribute" do
+            expect(general.title.language).to eq("en-US")
+          end
+        end
+
+        context "description element" do
+          it "parses correctly" do
+            expect(general.description).to be_kind_of(CommonCartridge::Elements::Lom::Description)
+          end
+
+          it "has a value attribute" do
+            expect(general.description.value).to eq("Sample materials to test a variety of Common Cartridge content types")
+          end
+
+          it "has a language attribute" do
+            expect(general.description.language).to eq("en-US")
+          end
+        end
+
+        context "keywords elements" do
+          it "is a collection" do
+            expect(general.keywords).to be_kind_of(Array)
+          end
+
+          it "parses correctly" do
+            expect(general.keywords.first).to be_kind_of(CommonCartridge::Elements::Lom::Keyword)
+          end
+
+          it "has a value attribute" do
+            expect(general.keywords.first.value).to eq("Sample")
+          end
+
+          it "has a language attribute" do
+            expect(general.keywords.first.language).to eq("en-US")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/elements/manifest_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    describe Manifest do
+      before(:all) do
+        @manifest = CommonCartridge.parse_from_zip("canvas_large_1.3.imscc").manifest
+      end
+
+      it "recognizes the manifest file and parses it correctly" do
+        expect(@manifest).to be_kind_of(CommonCartridge::Elements::Manifest)
+      end
+
+      it "has metadata" do
+        expect(@manifest.metadata).to be_kind_of(CommonCartridge::Elements::Metadata)
+      end
+
+      it "has organizations" do
+        expect(@manifest.root_organization).to be_kind_of(CommonCartridge::Elements::Organizations::RootOrganization)
+      end
+
+      it "has resources" do
+        expect(@manifest.root_resource).to be_kind_of(CommonCartridge::Elements::Resources::RootResource)
+      end
+
+      it "has identifier" do
+        expect(@manifest.identifier).to eq('if33b9cbc13c56657b05bec722d30b84f')
+      end
+    end
+  end
+end

data/spec/elements/metadata_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    describe Metadata do
+      context "Common Cartridge 1.1" do
+        before(:all) { @metadata = CommonCartridge.parse_from_zip("canvas_small_1.1.imscc").manifest.metadata }
+
+        it "has a schema" do
+          expect(@metadata.schema).to eq("IMS Common Cartridge")
+        end
+
+        it "has a schemaversion" do
+          expect(@metadata.schemaversion).to eq("1.1.0")
+        end
+
+        it "has a lom" do
+          expect(@metadata.lom).to be_kind_of(CommonCartridge::Elements::Lom::Lom)
+        end
+      end
+
+      context "Common Cartridge 1.3" do
+        before(:all) { @metadata = CommonCartridge.parse_from_zip("canvas_large_1.3.imscc").manifest.metadata }
+
+        it "has a schema" do
+          expect(@metadata.schema).to eq("IMS Common Cartridge")
+        end
+
+        it "has a schemaversion" do
+          expect(@metadata.schemaversion).to eq("1.3.0")
+        end
+
+        it "has a lom" do
+          expect(@metadata.lom).to be_kind_of(CommonCartridge::Elements::Lom::Lom)
+        end
+      end
+    end
+  end
+end
+

data/spec/elements/organizations_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    describe Organizations do
+      before(:all) do
+        @manifest = CommonCartridge.parse_from_zip("canvas_large_1.3.imscc").manifest
+      end
+
+      let(:organizations) { @manifest.organizations }
+
+      it "has a root organization" do
+        expect(@manifest.root_organization).to be_kind_of(CommonCartridge::Elements::Organizations::RootOrganization)
+      end
+
+      it "has a root item" do
+        expect(organizations.first.root_item).to be_kind_of(CommonCartridge::Elements::Organizations::RootItem)
+      end
+
+      describe Organizations::RootItem do
+        let(:root_item) { organizations.first.root_item }
+
+        it "has an identifier" do
+          expect(root_item.identifier).to eq("LearningModules")
+        end
+
+        it "has a collection of items" do
+          expect(root_item.items).to be_kind_of(Array)
+
+          root_item.items.each do |item|
+            expect(item).to be_kind_of(CommonCartridge::Elements::Organizations::Item)
+          end
+        end
+      end
+
+      describe Organizations::Item do
+        # todo: use find_by method here when implemented
+        let(:item) { organizations.first.root_item.items.first }
+
+        it "has an identifier" do
+          expect(item.identifier).to eq("i224aa0e52b019dbf9aeece014df883c7")
+        end
+
+        it "has a title" do
+          expect(item.title).to eq("Example Course Module")
+        end
+      end
+    end
+  end
+end
+

data/spec/elements/outcomes/outcome_group_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    module Outcomes
+      describe OutcomeGroup do
+        before(:all) do
+          @package = CommonCartridge.parse_from_zip('canvas_small_1.1.imscc')
+        end
+
+        let(:outcome_groups) { @package.outcomes.outcome_groups }
+        let(:outcome_group) { outcome_groups.first }
+
+        it "is parsed correctly" do
+          expect(outcome_groups.size).to eq(1)
+        end
+
+        it "has an identifier attribute" do
+          expect(outcome_group.identifier).to eq("i5c10922a7fdce7cb710733108d3a26dc")
+        end
+
+        it "has a collection of outcomes" do
+          expect(outcome_group.outcomes.size).to eq(9)
+        end
+      end
+    end
+  end
+end
+

data/spec/elements/outcomes/outcome_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    module Outcomes
+      describe Outcome do
+        before(:all) do
+          @package = CommonCartridge.parse_from_zip('canvas_small_1.1.imscc')
+        end
+
+        let(:outcomes) { @package.all_outcomes }
+        let(:outcome) { @package.all_outcomes.first }
+
+        it "is parsed correctly" do
+          expect(outcomes.size).to eq(9)
+        end
+
+        it "has an identifier attribute" do
+          expect(outcome.identifier).to eq "i63a00efe444e7edfc75e3051a4f8edac"
+        end
+
+        it "has a title element" do
+          expect(outcome.title).to match(/You can speak the 'HigherEd-K12-Education' speak/)
+        end
+
+        it "has a points_possible element" do
+          expect(outcome.points_possible).to eq "5"
+        end
+
+        it "has a mastery_points element" do
+          expect(outcome.mastery_points).to eq "3"
+        end
+      end
+    end
+  end
+end
+

data/spec/elements/resources/assignment_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    module Resources
+      describe Assignment do
+        before(:all) do
+          package = CommonCartridge.parse_from_zip('canvas_large_1.3.imscc')
+          @assignment = package.assignments.first
+        end
+
+        it "parses correctly" do
+          expect(@assignment).to be_kind_of(CommonCartridge::Elements::Resources::Assignment)
+        end
+
+        it "has a title" do
+          expect(@assignment.title).to eq("Online Submission Assignment")
+        end
+
+        it "has a 'gradable' element" do
+          expect(@assignment.gradable).to eq("true")
+        end
+
+        context "text element" do
+          let(:text) { @assignment.text }
+
+          it "parses correctly" do
+            expect(text).to be_kind_of(CommonCartridge::Elements::Resources::Text)
+          end
+
+          it "has a value" do
+            expect(text.value).to match(/Lorem ipsum dolor sit amet, consectetur adipiscing elit/)
+          end
+        end
+
+        context "submission_formats" do
+          let(:submission_formats) { @assignment.submission_formats }
+
+          it "parses correctly" do
+            expect(submission_formats).to be_kind_of(CommonCartridge::Elements::Resources::SubmissionFormats)
+          end
+
+          it "has formats" do
+            expect(submission_formats.formats).to be_kind_of(Array)
+            expect(submission_formats.formats).not_to be_empty
+            expect(submission_formats.formats.first.type).to eq("html")
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/elements/resources/attachments_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    module Resources
+      describe Attachments do
+        before(:all) do
+          manifest = CommonCartridge.parse_from_zip('canvas_small_1.1.imscc').manifest
+          resource = manifest.resources.detect { |r| r.identifier =~ /I_00006_R/ }
+          @attachment = resource.files.first.content.attachments.first
+        end
+
+        it "is parsed correctly" do
+          expect(@attachment).to be_kind_of(CommonCartridge::Elements::Resources::Attachments::Attachment)
+        end
+
+        it "has a href" do
+          expect(@attachment.href).to match(/angry_person\.jpg/)
+        end
+      end
+    end
+  end
+end
+

data/spec/elements/resources/basic_lti_link_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    module Resources
+      describe BasicLtiLink do
+        before(:all) do
+          manifest = CommonCartridge.parse_from_zip('canvas_small_1.1.imscc').manifest
+          @resource = manifest.resources.detect { |r| r.identifier =~ /I_00015_R/ }
+        end
+
+        it 'is parsed correctly' do
+          expect(@resource.files.first.content).to be_kind_of(
+            CommonCartridge::Elements::Resources::BasicLtiLink::BasicLtiLink
+          )
+        end
+
+        it 'has a title' do
+          expect(@resource.files.first.content.title).to eq('Semester 1 Overview')
+        end
+
+        it 'has a secure_launch_url' do
+          expect(@resource.files.first.content.secure_launch_url).to eq('https://fakecollege.com/activity_lists/student-resources--122/activities/semester-1-overview--17?custom_course_id=275')
+        end
+      end
+    end
+  end
+end
+

data/spec/elements/resources/resources_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+module CommonCartridge
+  module Elements
+    module Resources
+      describe Resources do
+        before(:all) do
+          @package = CommonCartridge.parse_from_zip("canvas_small_1.1.imscc")
+          @resources = @package.manifest.resources
+        end
+
+        it "has a root resource" do
+          expect(@package.manifest.root_resource).to be_kind_of(CommonCartridge::Elements::Resources::RootResource)
+        end
+
+        it "has a collection of resources" do
+          expect(@resources).to be_kind_of(Array)
+
+          @resources.each do |resource|
+            expect(resource).to be_kind_of(CommonCartridge::Elements::Resources::Resource)
+          end
+        end
+
+
+        describe Resources::Resource do
+          # todo: implement 'find_by' method to use here
+          let(:resource) { @resources.first }
+
+          it "has an identifier" do
+            expect(resource.identifier).to eq('I_00001_R')
+          end
+
+          it "has a type" do
+            expect(resource.type).to eq('webcontent')
+          end
+
+          it "has a href" do
+            expect(resource.href).to eq('I_00001_R/Learning_Objectives.html')
+          end
+
+          it "has files" do
+            resource.files.each do |f|
+              expect(f).to be_kind_of(CommonCartridge::Elements::Resources::File)
+            end
+          end
+
+          context "when a quiz" do
+            let(:quiz) { @package.quizzes.first }
+            it "has question count" do
+              expect(quiz.question_count).to eq(11)
+            end
+          end
+        end
+
+        describe Resources::File do
+          let(:file) { @resources.first.files.first }
+
+          it "has a href" do
+            expect(file.href).to eq("I_00001_R/Learning_Objectives.html")
+          end
+        end
+
+        describe Resources::Dependency do
+          let(:dependency) { @resources[1].dependencies.first }
+
+          it "has an identifierref" do
+            expect(dependency.identifierref).to eq("I_00003_R_IMAGERESOURCE")
+          end
+        end
+      end
+    end
+  end
+end