multi_version_common_cartridge 1.0.0

data/README.md

@@ -0,0 +1,36 @@
+# multi_version_common_cartridge
+A gem for writing different versions of Common Cartridges.
+
+It supports Common Cartridge version 1.1, 1.2, 1.3 and Thin CC version 1.2 and 1.3.
+
+## Usage
+``` ruby
+# Create a Common Cartridge
+cartridge = MultiVersionCommonCartridge::Cartridge.new
+cartridge.manifest.set_title('My cartridge')
+cartridge.items = [
+  MultiVersionCommonCartridge::Item.new.tap do |item|
+    item.title = 'My activity'
+    item.identifier = 'Some identifier'
+    item.resource = MultiVersionCommonCartridge::Resources::BasicLtiLink::BasicLtiLink.new.tap do |lti|
+      lti.title = 'My activity title'
+      lti.identiier = 'My activity identifier'
+      lti.scure_launch_url = 'https://example.com/lti'
+    end
+  end
+]
+
+# Create a Common Cartridge writer for version 1.2.0
+writer = MultiVersionCommonCartridge::Writers::CartridgeWriter.new(
+  cartridge, '1.2.0'
+end
+
+# Finalize the Common Cartridge for the specified version.
+writer.finalize
+
+# Check for error
+return if writer.errors?
+
+# Write the Common Cartridge
+writer.write_to_zip('cartridge.imscc')
+```

data/lib/multi_version_common_cartridge.rb

@@ -0,0 +1,38 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'multi_version_common_cartridge/version'
+require 'multi_version_common_cartridge/sax_machine_nokogiri_xml_saver'
+
+require 'multi_version_common_cartridge/cartridge_versions'
+require 'multi_version_common_cartridge/item'
+require 'multi_version_common_cartridge/resources/resource'
+require 'multi_version_common_cartridge/resources/basic_lti_link'
+require 'multi_version_common_cartridge/manifest'
+require 'multi_version_common_cartridge/cartridge'
+require 'multi_version_common_cartridge/xml_definitions'
+require 'multi_version_common_cartridge/writers/supported_versions'
+require 'multi_version_common_cartridge/writers/item_writer'
+require 'multi_version_common_cartridge/writers/resource_writer'
+require 'multi_version_common_cartridge/writers/basic_lti_vendor_writer'
+require 'multi_version_common_cartridge/writers/basic_lti_extension_writer'
+require 'multi_version_common_cartridge/writers/basic_lti_link_writer'
+require 'multi_version_common_cartridge/writers/manifest_writer'
+require 'multi_version_common_cartridge/writers/manifest_metadata_writer'
+require 'multi_version_common_cartridge/writers/manifest_organization_writer'
+require 'multi_version_common_cartridge/writers/manifest_resources_writer'
+require 'multi_version_common_cartridge/writers/cartridge_writer'
+require 'multi_version_common_cartridge/writers/factory'

data/lib/multi_version_common_cartridge/cartridge.rb

@@ -0,0 +1,53 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  class Cartridge
+    attr_accessor :items
+
+    def initialize
+      @items = []
+    end
+
+    def manifest
+      @manifest ||= Manifest.new
+    end
+
+    def add_item(item)
+      @items << item
+    end
+
+    def all_items
+      @all_items ||= begin
+                       @items.each_with_object([]) do |item, memo|
+                         memo << item
+                         child_items(item, memo)
+                       end
+                     end.flatten
+    end
+
+    def all_resources
+      @all_resources ||= all_items.map(&:resource).compact
+    end
+
+    private def child_items(item, memo)
+      item.children.each do |child|
+        memo << child
+        child_items(child, memo)
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/cartridge_versions.rb

@@ -0,0 +1,25 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module CartridgeVersions
+    CC_1_1_0 = '1.1.0'.freeze
+    CC_1_2_0 = '1.2.0'.freeze
+    CC_1_3_0 = '1.3.0'.freeze
+    THIN_CC_1_2_0 = 'Thin 1.2.0'.freeze
+    THIN_CC_1_3_0 = 'Thin 1.3.0'.freeze
+  end
+end

data/lib/multi_version_common_cartridge/item.rb

@@ -0,0 +1,29 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  class Item
+    attr_accessor :title, :identifier, :resource, :children
+
+    def initialize
+      @children = []
+    end
+
+    def add_item(item)
+      children << item
+    end
+  end
+end

data/lib/multi_version_common_cartridge/manifest.rb

@@ -0,0 +1,33 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  class Manifest
+    attr_accessor :identifier, :titles, :description, :organization_identifier
+
+    def initialize
+      @titles = {}
+    end
+
+    def set_title(title, language: 'en-US')
+      titles[language] = title
+    end
+
+    def title(language)
+      titles[language]
+    end
+  end
+end

data/lib/multi_version_common_cartridge/resources/basic_lti_link.rb

@@ -0,0 +1,46 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module Resources
+    module BasicLtiLink
+      class Vendor
+        attr_accessor :code, :name, :description, :url, :contact_email
+      end
+
+      class BasicLtiLink < MultiVersionCommonCartridge::Resources::Resource
+        attr_accessor :title, :description, :secure_launch_url, :extensions
+
+        def initialize
+          @extensions = []
+        end
+
+        def vendor
+          @vendor ||= Vendor.new
+        end
+      end
+
+      class Extension
+        attr_accessor :platform, :properties
+
+        def initialize(platform)
+          @platform = platform
+          @properties = {}
+        end
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/resources/resource.rb

@@ -0,0 +1,23 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge. If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module Resources
+    class Resource
+      attr_accessor :identifier
+    end
+  end
+end

data/lib/multi_version_common_cartridge/sax_machine_nokogiri_xml_saver.rb

@@ -0,0 +1,85 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+class SaxMachineNokogiriXmlSaver
+  def save(builder, object, name)
+    sax_config = sax_config_for(object)
+    unless sax_config
+      builder.send(name, object)
+      return
+    end
+
+    attrs = xml_attributes(object, sax_config)
+    content = xml_content(object, sax_config)
+    create_xml_node(builder, name, content, attrs) do |xml_element|
+      sax_config.top_level_elements.each do |_, configs|
+        configs.each do |config|
+          as = config.instance_variable_get(:@as)
+          save(xml_element, object.send(as), config.name)
+        end
+      end
+
+      sax_config.collection_elements.each do |_, configs|
+        configs.each do |config|
+          as = config.instance_variable_get(:@as)
+          object.send(as).each do |elm|
+            save(xml_element, elm, config.name)
+          end
+        end
+      end
+    end
+  end
+
+  private def xml_attributes(object, sax_config)
+    attrs = sax_config.top_level_attributes.map do |attr|
+      [attr.name, object.send(attr.instance_variable_get(:@as))]
+    end.to_h
+    attrs.delete_if { |_, v| v.nil? }
+  end
+
+  private def xml_content(object, sax_config)
+    return if sax_config.top_level_element_value.empty?
+    element_value_config = sax_config.top_level_element_value.last
+    object.send(element_value_config.name)
+  end
+
+  private def create_xml_node(builder, name, content, attrs, &block)
+    if name.include?(':')
+      namespace, name = name.split(':', 2)
+      create_xml_element(builder[namespace], name, content, attrs, &block)
+    else
+      create_xml_element(builder, name, content, attrs, &block)
+    end
+  end
+
+  private def create_xml_element(builder, name, content, attrs, &block)
+    if content
+      builder.send(name, content, attrs) do |xml_element|
+        yield xml_element
+      end
+    else
+      builder.send(name, attrs) do |xml_element|
+        yield xml_element
+      end
+    end
+  end
+
+  private def sax_config_for(object)
+    if object.class.respond_to?(:sax_config)
+      object.class.sax_config
+    end
+  end
+end

data/lib/multi_version_common_cartridge/version.rb

@@ -0,0 +1,19 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  VERSION = '1.0.0'.freeze
+end

data/lib/multi_version_common_cartridge/writers/basic_lti_extension_writer.rb

@@ -0,0 +1,45 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module Writers
+    class BasicLtiExtensionWriter
+      include SupportedVersions
+
+      attr_reader :extension
+
+      def initialize(extension, version)
+        @extension = extension
+        @version = validate_version(version)
+      end
+
+      def finalize
+      end
+
+      def extension_element
+        @extension_element ||= CommonCartridge::Elements::Resources::BasicLtiLink::Extension.new.tap do |element|
+          element.platform = extension.platform
+          element.properties = extension.properties.map do |key, value|
+            CommonCartridge::Elements::Resources::BasicLtiLink::ExtensionProperty.new(
+              name: key, value: value
+            )
+          end
+        end
+      end
+    end
+  end
+end
+