scorm-package 0.1.0

data/lib/scorm_package/packaging/common/scormfunctions.js

@@ -0,0 +1,155 @@
+/*
+Source code created by Rustici Software, LLC is licensed under a 
+Creative Commons Attribution 3.0 United States License
+(http://creativecommons.org/licenses/by/3.0/us/)
+
+Want to make SCORM easy? See our solutions at http://www.scorm.com.
+
+This example provides for the bare minimum SCORM run-time calls.
+It will demonstrate using the API discovery algorithm to find the
+SCORM API and then calling Initialize and Terminate when the page
+loads and unloads respectively. This example also demonstrates
+some basic SCORM error handling.
+*/
+
+
+//Include the standard ADL-supplied API discovery algorithm
+
+
+///////////////////////////////////////////
+//Begin ADL-provided API discovery algorithm
+///////////////////////////////////////////
+var findAPITries = 0;
+
+function findAPI(win)
+{
+   // Check to see if the window (win) contains the API
+   // if the window (win) does not contain the API and
+   // the window (win) has a parent window and the parent window
+   // is not the same as the window (win)
+   while ( (win.API == null) &&
+           (win.parent != null) &&
+           (win.parent != win) )
+   {
+      // increment the number of findAPITries
+      findAPITries++;
+
+      // Note: 7 is an arbitrary number, but should be more than sufficient
+      if (findAPITries > 7)
+      {
+         alert("Error finding API -- too deeply nested.");
+         return null;
+      }
+
+      // set the variable that represents the window being
+      // being searched to be the parent of the current window
+      // then search for the API again
+      win = win.parent;
+   }
+   return win.API;
+}
+
+function getAPI()
+{
+   // start by looking for the API in the current window
+   var theAPI = findAPI(window);
+
+   // if the API is null (could not be found in the current window)
+   // and the current window has an opener window
+   if ( (theAPI == null) &&
+        (window.opener != null) &&
+        (typeof(window.opener) != "undefined") )
+   {
+      // try to find the API in the current window�s opener
+      theAPI = findAPI(window.opener);
+   }
+   // if the API has not been found
+   if (theAPI == null)
+   {
+      // Alert the user that the API Adapter could not be found
+      alert("Unable to find an API adapter");
+   }
+   return theAPI;
+}
+
+
+///////////////////////////////////////////
+//End ADL-provided API discovery algorithm
+///////////////////////////////////////////
+  
+  
+//Create function handlers for the loading and unloading of the page
+
+
+//Constants
+var SCORM_TRUE = "true";
+var SCORM_FALSE = "false";
+
+//Since the Unload handler will be called twice, from both the onunload
+//and onbeforeunload events, ensure that we only call LMSFinish once.
+var finishCalled = false;
+
+//Track whether or not we successfully initialized.
+var initialized = false;
+
+var API = null;
+
+function ScormProcessInitialize(){
+    var result;
+    
+    API = getAPI();
+    
+    if (API == null){
+        alert("ERROR - Could not establish a connection with the LMS.\n\nYour results may not be recorded.");
+        return;
+    }
+    
+    result = API.LMSInitialize("");
+    
+    if (result == SCORM_FALSE){
+        var errorNumber = API.LMSGetLastError();
+        var errorString = API.LMSGetErrorString(errorNumber);
+        var diagnostic = API.LMSGetDiagnostic(errorNumber);
+        
+        var errorDescription = "Number: " + errorNumber + "\nDescription: " + errorString + "\nDiagnostic: " + diagnostic;
+        
+        alert("Error - Could not initialize communication with the LMS.\n\nYour results may not be recorded.\n\n" + errorDescription);
+        return;
+    }
+    
+    initialized = true;
+}
+
+function ScormProcessFinish(){
+    
+    var result;
+    
+    //Don't terminate if we haven't initialized or if we've already terminated
+    if (initialized == false || finishCalled == true){return;}
+    
+    result = API.LMSFinish("");
+    
+    finishCalled = true;
+    
+    if (result == SCORM_FALSE){
+        var errorNumber = API.LMSGetLastError();
+        var errorString = API.LMSGetErrorString(errorNumber);
+        var diagnostic = API.LMSGetDiagnostic(errorNumber);
+        
+        var errorDescription = "Number: " + errorNumber + "\nDescription: " + errorString + "\nDiagnostic: " + diagnostic;
+        
+        alert("Error - Could not terminate communication with the LMS.\n\nYour results may not be recorded.\n\n" + errorDescription);
+        return;
+    }
+}
+
+
+/*
+Assign the processing functions to the page's load and unload
+events. The onbeforeunload event is included because it can be 
+more reliable than the onunload event and we want to make sure 
+that Terminate is ALWAYS called.
+*/
+window.onload = ScormProcessInitialize;
+window.onunload = ScormProcessFinish;
+window.onbeforeunload = ScormProcessFinish;

data/lib/scorm_package/packaging/create_zip.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "zip"
+
+module ScormPackage
+  module Packaging
+    class CreateZip
+      attr_reader :manifest, :lessons
+
+      root_path = File.expand_path("..", __dir__)
+
+      SCHEMA_FILES = [
+        File.join(root_path, "packaging", "common", "adlcp_rootv1p2.xsd"),
+        File.join(root_path, "packaging", "common", "ims_xml.xsd"),
+        File.join(root_path, "packaging", "common", "imscp_rootv1p1p2.xsd"),
+        File.join(root_path, "packaging", "common", "imsmd_rootv1p2p1.xsd"),
+        File.join(root_path, "packaging", "common", "scormfunctions.js")
+      ].freeze
+
+      def initialize(manifest, lessons)
+        @manifest = manifest
+        @lessons = lessons
+      end
+
+      def process
+        create_zip_package
+      end
+
+      private
+
+      def create_zip_package
+        buffer = Zip::OutputStream.write_buffer do |zipfile|
+          add_manifest(zipfile)
+          add_source_files(zipfile)
+          add_lesson_files(zipfile)
+        end
+        buffer.string
+      end
+
+      def add_manifest(zipfile)
+        zipfile.put_next_entry("imsmanifest.xml")
+        zipfile.write(manifest)
+      end
+
+      def add_source_files(zipfile)
+        SCHEMA_FILES.each do |file|
+          filename = File.basename(file)
+          zipfile.put_next_entry(filename)
+          zipfile.write(File.read(file))
+        end
+      end
+
+      def add_lesson_files(zipfile)
+        lessons.each do |lesson_path, lesson_content|
+          zipfile.put_next_entry(lesson_path)
+          zipfile.write(lesson_content)
+        end
+      end
+    end
+  end
+end

data/lib/scorm_package/packaging/generate.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require_relative "create_zip"
+
+module ScormPackage
+  module Packaging
+    class Generate
+      attr_reader :course, :scorm_token
+
+      def initialize(course, scorm_token)
+        @course = course
+        @scorm_token = scorm_token
+      end
+
+      def process
+        manifest = generate_manifest
+        lessons_html = generate_lesson_contents
+        ScormPackage::Packaging::CreateZip.new(manifest, lessons_html).process
+      end
+
+      private
+
+      def generate_manifest
+        <<~XML
+          <?xml version="1.0" standalone="no" ?>
+          <manifest identifier="#{course.title}" version="1"
+                    xmlns="http://www.imsproject.org/xsd/imscp_rootv1p1p2"
+                    xmlns:adlcp="http://www.adlnet.org/xsd/adlcp_rootv1p2"
+                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                    xsi:schemaLocation="http://www.imsproject.org/xsd/imscp_rootv1p1p2 imscp_rootv1p1p2.xsd
+                             http://www.imsglobal.org/xsd/imsmd_rootv1p2p1 imsmd_rootv1p2p1.xsd
+                             http://www.adlnet.org/xsd/adlcp_rootv1p2 adlcp_rootv1p2.xsd">
+            <metadata>
+              <schema>ADL SCORM</schema>
+              <schemaversion>1.2</schemaversion>
+            </metadata>
+            <organizations default="default-org">
+              <organization identifier="default-org">
+                <title>#{course.title}</title>
+                #{generate_modules(course.course_modules)}
+              </organization>
+            </organizations>
+            <resources>
+              #{generate_resources(course.course_modules)}
+              <resource identifier="common_files" type="webcontent" adlcp:scormtype="asset">
+                <file href="scormfunctions.js"/>
+              </resource>
+            </resources>
+          </manifest>
+        XML
+      end
+
+      def generate_modules(modules)
+        modules.map.with_index(1) do |mod, mod_index|
+          <<~XML
+            <item identifier="module-#{mod_index}">
+              <title>#{mod.title}</title>
+              #{generate_lessons(mod.lessons, mod_index)}
+            </item>
+          XML
+        end.join
+      end
+
+      def generate_lessons(lessons, mod_index)
+        lessons.map.with_index(1) do |lesson, lesson_index|
+          <<~XML
+            <item identifier="module-#{mod_index}-lesson-#{lesson_index}" identifierref="resource-module-#{mod_index}-lesson-#{lesson_index}">
+              <title>#{lesson.title}</title>
+            </item>
+          XML
+        end.join
+      end
+
+      def generate_resources(modules)
+        modules.flat_map.with_index(1) do |mod, mod_index|
+          mod.lessons.map.with_index(1) do |_, lesson_index|
+            <<~XML
+              <resource identifier="resource-module-#{mod_index}-lesson-#{lesson_index}" type="webcontent" adlcp:scormtype="sco" href="content/module#{mod_index}/lesson#{lesson_index}.html">
+                <file href="content/module#{mod_index}/lesson#{lesson_index}.html" />
+                <dependency identifierref="common_files" />
+              </resource>
+            XML
+          end
+        end.join
+      end
+
+      def generate_lesson_html(lesson)
+        <<~HTML
+          <!DOCTYPE html>
+          <html lang="en">
+          <head>
+            <meta charset="UTF-8">
+            <meta name="viewport" content="width=device-width, initial-scale=1.0">
+            <script src="../../scormfunctions.js"></script>
+            <title>#{lesson.title}</title>
+            <style>
+              .loader { display: none; position: fixed; top: 50%; left: 50%; transform: translate(-50%, -50%); }
+              iframe { display: none; width: 560px; height: 315px; border: none; }
+            </style>
+          </head>
+          <body>
+            <p>Lesson: #{lesson.title}</p>
+            <ul>#{lesson.videos.map do |video|
+              "<li>Language: #{video[:language]}<br>" \
+              "<div id=\"loader-#{video[:id]}\" class=\"loader\">Loading...</div>" \
+              "<iframe id=\"custom-iframe-#{video[:id]}\" data-video-url=\"#{video[:video_url]}\"></iframe></li>"
+            end.join}</ul>
+            <script>
+              const loadIframe = async (iframe) => {
+                const loader = document.getElementById(`loader-${iframe.id.split('-').pop()}`);
+                try {
+                  loader.style.display = 'block';
+                  const response = await fetch(iframe.dataset.videoUrl, {
+                    headers: { 'X-Scorm-Token': '#{scorm_token}' }
+                  });
+                  iframe.srcdoc = await response.text();
+                  iframe.style.display = 'block';
+                } catch (error) { console.error(error); }
+                finally { loader.style.display = 'none'; }
+              };
+              window.addEventListener('load', () =>
+                document.querySelectorAll('iframe[data-video-url]').forEach(loadIframe)
+              );
+            </script>
+          </body>
+          </html>
+        HTML
+      end
+
+      def generate_lesson_contents
+        lessons_hash = {}
+
+        course.course_modules.each_with_index do |mod, mod_index|
+          mod.lessons.each_with_index do |lesson, lesson_index|
+            lesson_path = "content/module#{mod_index + 1}/lesson#{lesson_index + 1}.html"
+            lessons_hash[lesson_path] = generate_lesson_html(lesson)
+          end
+        end
+        lessons_hash
+      end
+    end
+  end
+end

data/lib/scorm_package/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ScormPackage
+  VERSION = "0.1.0"
+end

data/lib/scorm_package.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "scorm_package/version"
+require_relative "scorm_package/abstract_course"
+require_relative "scorm_package/abstract_course_module"
+require_relative "scorm_package/abstract_lesson"
+require_relative "scorm_package/packaging/generate"
+
+module ScormPackage
+  class Error < StandardError; end
+end

data/sig/scorm_package.rbs

@@ -0,0 +1,4 @@
+module ScormPackage
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: scorm-package
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Sojan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-29 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- paul.eliassojan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scorm_package.rb
+- lib/scorm_package/abstract_course.rb
+- lib/scorm_package/abstract_course_module.rb
+- lib/scorm_package/abstract_lesson.rb
+- lib/scorm_package/packaging/common/adlcp_rootv1p2.xsd
+- lib/scorm_package/packaging/common/ims_xml.xsd
+- lib/scorm_package/packaging/common/imscp_rootv1p1p2.xsd
+- lib/scorm_package/packaging/common/imsmd_rootv1p2p1.xsd
+- lib/scorm_package/packaging/common/scormfunctions.js
+- lib/scorm_package/packaging/create_zip.rb
+- lib/scorm_package/packaging/generate.rb
+- lib/scorm_package/version.rb
+- sig/scorm_package.rbs
+homepage: https://github.com/openvitae-tech/scorm-package
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/openvitae-tech/scorm-package
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Gem to create scorm package.
+test_files: []