common_cartridge_parser 1.0.0

data/lib/common_cartridge/elements/resources/attachments.rb

@@ -0,0 +1,20 @@
+module CommonCartridge
+  module Elements
+    module Resources
+      module Attachments
+        class Attachment
+          include SAXMachine
+
+          attribute :href
+          attribute :role
+        end
+
+        class RootAttachment
+          include SAXMachine
+
+          elements :'dt:attachment', class: Attachment, as: :attachments
+        end
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/resources/basic_lti_link.rb

@@ -0,0 +1,66 @@
+module CommonCartridge
+  module Elements
+    module Resources
+      module BasicLtiLink
+        class VendorContact
+          include SAXMachine
+
+          element 'lticp:email', as: :email
+        end
+
+        class Vendor
+          include SAXMachine
+
+          element 'lticp:code', as: :code
+          element 'lticp:name', as: :name
+          element 'lticp:description', as: :description
+          element 'lticp:url', as: :url
+          element 'lticp:contact', class: VendorContact, as: :contact
+        end
+
+        class ExtensionProperty
+          include SAXMachine
+
+          attribute :name
+          value :value
+        end
+
+        class Extension
+          include SAXMachine
+
+          attribute :platform
+          elements 'lticm:property', class: ExtensionProperty, as: :properties
+        end
+
+        class BasicLtiLink
+          attr_accessor :identifier
+
+          include SAXMachine
+
+          attribute :xmlns
+          attribute 'xmlns:blti', as: :xmlns_blti
+          attribute 'xmlns:lticm', as: :xmlns_lticm
+          attribute 'xmlns:lticp', as: :xmlns_lticp
+          attribute 'xmlns:xsi', as: :xmlns_xsi
+          attribute 'xsi:schemaLocation', as: :xsi_schema_location
+
+          element 'blti:title', as: :title
+          element 'blti:description', as: :description
+          element 'blti:secure_launch_url', as: :secure_launch_url
+          element 'blti:launch_url', as: :launch_url
+          element 'blti:vendor', class: Vendor, as: :vendor
+
+          elements 'blti:extensions', class: Extension, as: :extensions
+
+          def self.type
+            :basic_lti_link
+          end
+
+          def self.pattern
+            /imsbasiclti_xmlv1p/
+          end
+        end
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/resources/page.rb

@@ -0,0 +1,22 @@
+module CommonCartridge
+  module Elements
+    module Resources
+      class Page
+        attr_accessor :identifier, :identifierref
+
+        include SAXMachine
+        element :title
+        element :text
+        element :text, value: :texttype, as: :text_type
+
+        def self.type
+          :page
+        end
+
+        def self.pattern
+          /webcontent/
+        end
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/resources/topic.rb

@@ -0,0 +1,28 @@
+module CommonCartridge
+  module Elements
+    module Resources
+      class Topic
+        attr_accessor :identifier
+
+        include SAXMachine
+
+        element 'dt:title', as: :title
+        element 'dt:text', as: :text
+        element 'dt:text', value: :texttype, as: :text_type
+        element 'dt:attachments', class: Attachments::RootAttachment, as: :attachment_root
+
+        def attachments
+          attachment_root.attachments
+        end
+
+        def self.type
+          :discussion
+        end
+
+        def self.pattern
+          /imsdt/
+        end
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/resources/web_link.rb

@@ -0,0 +1,25 @@
+module CommonCartridge
+  module Elements
+    module Resources
+      class WebLink
+        attr_accessor :identifier
+
+        include SAXMachine
+
+        element :title
+        element :url
+        element :url, value: :href, as: :href
+        element :url, value: :target, as: :target
+        element :url, value: :windoFeatures, as: :window_features
+
+        def self.type
+          :weblink
+        end
+
+        def self.pattern
+          /wl/
+        end
+      end
+    end
+  end
+end

data/lib/common_cartridge/package.rb

@@ -0,0 +1,87 @@
+module CommonCartridge
+  class Package
+    attr_accessor :manifest, :outcomes, :assignments
+
+    def initialize
+      @assignments = []
+    end
+
+    def find_resource(identifier)
+      manifest.resources.find { |r| r.identifier == identifier }
+    end
+
+    def outcome_groups
+      @outcome_groups ||= outcomes ? outcomes.outcome_groups : []
+    end
+
+    def all_outcomes
+      @all_outcomes ||= outcome_groups.collect { |g| g.outcomes }.flatten
+    end
+
+    def modules
+      @modules ||= manifest.organization.root_item.items
+    end
+
+    def discussions
+      @discussions ||= resources_of_type(Elements::Resources::Topic).reject { |d| d.is_announcement? }
+    end
+
+    def announcements
+      @announcements ||= resources_of_type(Elements::Resources::Topic).select { |d| d.is_announcement? }
+    end
+
+    def pages
+      @pages ||= begin
+                   pages = resources_of_type(Elements::Resources::Page).each do |page|
+                     assign_title(page)
+                   end
+                  filter_pages(pages)
+                end
+    end
+
+
+    def quizzes
+      @quizzes ||= resources_of_type(Elements::Resources::Assessment).each do |quiz|
+                       assign_title(quiz) unless quiz.title
+      end
+    end
+
+
+    private
+    def filter_pages(pages)
+      pages.select do |page|
+        (page.href =~ /wiki/ || page.href =~ /html$/) && page.title
+      end
+    end
+
+    def assign_title(obj)
+      if ref = find_item_by_ref(obj.identifier)
+        obj.title = ref.title
+      end
+    end
+
+    def resources_of_type(type)
+      manifest.resources.select { |r| r.type =~ type.pattern }
+    end
+
+    def find_item_by_ref(ref)
+      all_items.detect do |item|
+        item.identifierref == ref
+      end
+    end
+
+    def all_items
+      @all_items ||= begin
+                       modules.each_with_object([]) do |mod, memo|
+                         memo << mod.items
+                         mod.items.each do |item|
+                           memo << item.items if item.items
+                         end
+                       end.flatten
+                     end
+    end
+
+
+
+  end
+end

data/lib/common_cartridge/parsers/dependencies.rb

@@ -0,0 +1,23 @@
+module CommonCartridge
+  module Parsers
+    class Dependencies
+      attr_reader :resource
+
+      def initialize(zipfile, resource)
+        @zipfile = zipfile
+        @resource = resource
+      end
+
+      def parse!(package)
+        resource.dependencies.each do |d|
+          resource = package.find_resource(d.identifierref)
+          resource.files.each do |f|
+            Parser.use_file(@zipfile, f.href) do |xml|
+              d.contents << CommonCartridge::Elements::Resources::Content.parse(xml)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/common_cartridge/parsers/files.rb

@@ -0,0 +1,34 @@
+module CommonCartridge
+  module Parsers
+    class Files
+      attr_reader :resource
+
+      def initialize(zipfile, resource)
+        @zipfile = zipfile
+        @resource = resource
+      end
+
+      def parse!(package)
+        if mapping = resource_to_mapping(resource)
+          resource.files.each do |f|
+            Parser.use_file(@zipfile, f.href) do |xml|
+              f.content = mapping.last.parse(xml)
+              f.content.identifier = resource.identifier
+              if resource.type =~ CommonCartridge::Elements::Resources::Assignment.pattern && f.href =~ /assignment.*xml/ && !(resource.href =~ /course/)
+                doc = Nokogiri::XML(xml)
+                doc.remove_namespaces!
+                f.content.points_possible = doc.xpath('//points_possible').text
+                package.assignments << f.content
+              end
+            end
+          end
+        end
+      end
+
+      private
+      def resource_to_mapping(resource)
+        CommonCartridge::Elements::Resources.type_mappings.detect { |regex, klass| resource.type =~ regex }
+      end
+    end
+  end
+end

data/lib/common_cartridge/parsers/items.rb

@@ -0,0 +1,58 @@
+module CommonCartridge
+  module Parsers
+    class Items
+      def initialize(zipfile, mod, resources)
+        @zipfile = zipfile
+        @mod = mod
+        @resources = resources
+      end
+
+      def parse!
+        @mod.items.each do |item|
+          map_item_to_type(item)
+          unless item.items.empty?
+            item.items.each { |i| map_item_to_type(i) }
+          end
+        end
+      end
+
+      private
+      def map_item_to_type(item)
+        if resource = find_resource_by_ref(item.identifierref)
+          if types = Elements::Resources.type_mappings.detect { |pattern, type| resource.type =~ pattern }
+            item.type = types.last.type
+          else !resource.type.empty?
+            item.type = resource.type
+          end
+
+          if item.type == :page && resource.href =~ /web_resources/
+            item.type = 'file'
+          end
+        end
+
+        if item.type.nil? || item.type.empty?
+          Parser.use_file(@zipfile, 'course_settings/module_meta.xml') do |xml|
+            doc = Nokogiri::XML(xml)
+            doc.remove_namespaces!
+            item.type = snake_case(doc.xpath("//item[@identifier = '#{item.identifier}' or @identifier='#{item.identifierref}']/content_type").text)
+
+          end
+        end
+      end
+
+      def find_resource_by_ref(ref)
+        @resources.detect do |resource|
+          resource.identifier == ref
+        end
+      end
+
+      def snake_case(text)
+        text.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+      end
+    end
+  end
+end

data/lib/common_cartridge/parsers/outcomes.rb

@@ -0,0 +1,17 @@
+module CommonCartridge
+  module Parsers
+    class Outcomes
+      def initialize(zipfile)
+        @zipfile = zipfile
+      end
+
+      def parse!
+        Parser.use_file(@zipfile, 'course_settings/learning_outcomes.xml') do |xml|
+          return CommonCartridge::Elements::Outcomes::OutcomeRoot.parse(xml)
+        end
+      end
+    end
+  end
+end
+
+

data/lib/common_cartridge/parsers/parser.rb

@@ -0,0 +1,84 @@
+require 'zip'
+
+require 'common_cartridge/parsers/dependencies'
+require 'common_cartridge/parsers/files'
+require 'common_cartridge/parsers/outcomes'
+require 'common_cartridge/parsers/questions'
+require 'common_cartridge/parsers/items'
+
+module CommonCartridge
+  module Parsers
+    class Parser
+      class ManifestDocument
+        include SAXMachine
+
+        element :manifest, class: CommonCartridge::Elements::Manifest, required: true
+      end
+
+      def self.use_file(zipfile, path)
+        Zip::File.open(File.join(CommonCartridge.config.import_directory, zipfile)) do |file|
+          f = file.glob(path).first
+          unless f.nil?
+            yield f.get_input_stream.read
+          end
+        end
+      end
+
+      def initialize(zipfile)
+        @zipfile = zipfile
+        @package = Package.new
+      end
+
+      def parse
+        Parser.use_file(@zipfile, 'imsmanifest.xml') do |xml|
+          @package.manifest = ManifestDocument.parse(xml).manifest
+        end
+
+        parse_content!
+        @package.outcomes = parse_outcomes
+        parse_questions!
+        parse_module_items!
+        @package
+      end
+
+      private
+      def parse_module_items!
+        @package.modules.each do |mod|
+          item_parser = Parsers::Items.new(@zipfile, mod, @package.manifest.resources)
+          item_parser.parse!
+        end
+      end
+
+      def parse_outcomes
+        outcomes_parser = Parsers::Outcomes.new(@zipfile)
+        outcomes_parser.parse!
+      end
+
+      def parse_content!
+        @package.manifest.resources.map do |resource|
+          parse_resource! resource
+        end
+      end
+
+      def parse_resource! resource
+        file_parser = Parsers::Files.new(@zipfile, resource)
+        file_parser.parse!(@package)
+        dependency_parser = Parsers::Dependencies.new(@zipfile, resource)
+        dependency_parser.parse!(@package)
+      rescue RuntimeError => e
+        Rails.logger.error "CommonCartridge parse error: #{e.to_s}"
+        Rails.logger.error e.backtrace
+      end
+
+      def parse_questions!
+        @package.quizzes.each do |quiz|
+          parser = Parsers::Questions.new(@zipfile, quiz)
+          parser.parse!
+        end
+      end
+
+    end
+  end
+end
+
+