scorm_rte 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c3c6ac2ca40a1285cbe11dbe9031b0320bcc152
+  data.tar.gz: 2a94ad15b82c043fbe1489acfa6a0308cb719995
+SHA512:
+  metadata.gz: 66a27c2ac503427fcd88678fc964c8d01148b116edcde6dc56bd14ac3c0ba105075d2c54e0c64bdad207d17701216c03cf393cbcabbade7b3c77d6aed0f11ca5
+  data.tar.gz: 879f70b186c1ec2672f608363ac727266065f74646cf14384b1f1ba82d342c7b02dad68f806bfd4892dd602d0b3b20545d02991b78a2e4c0bcc9a597c10e93aa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 paresharma
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ScormRte'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/scorm_rte/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/scorm_rte/rte.js

@@ -0,0 +1,285 @@
+function LMSAPI(){
+  this.cache = {};
+  this.SCOInstanceID = 123456789;
+
+  // 1.2
+  this.LMSInitialize=LMSInitialize;
+  this.LMSGetValue=LMSGetValue;
+  this.LMSSetValue=LMSSetValue;
+  this.LMSCommit=LMSCommit;
+  this.LMSFinish=LMSFinish;
+  this.LMSGetLastError=LMSGetLastError;
+  this.LMSGetDiagnostic=LMSGetDiagnostic;
+  this.LMSGetErrorString=LMSGetErrorString;
+
+  // 2004
+  this.Initialize=LMSInitialize;
+  this.GetValue=LMSGetValue;
+  this.SetValue=LMSSetValue;
+  this.Commit=LMSCommit;
+  this.Treminate=LMSFinish;
+  this.GetLastError=LMSGetLastError;
+  this.GetDiagnostic=LMSGetDiagnostic;
+  this.GetErrorString=LMSGetErrorString;
+
+  // ------------------------------------------
+  //   Status Flags
+  // ------------------------------------------
+  var flagFinished = false;
+
+  // ------------------------------------------
+  //   SCO Data Cache - Initialization
+  // ------------------------------------------
+
+  // ------------------------------------------
+  //   SCORM RTE Functions - Initialization
+  // ------------------------------------------
+  function LMSInitialize(dummyString) {
+    console.log('***');
+    console.log('initialized');
+    console.log(this.cache);
+
+    var url = 'http://localhost:3000/scorm_rte/stores/fetch?sco_instance_id='+this.SCOInstanceID;
+    var tempCache = {};
+
+    $.ajax({
+      url: url,
+      dataType: 'json',
+      async: false
+    }).done(function( data ) {
+      tempCache = data;
+    });
+
+    // this.cache = JSON.parse(localStorage.getItem('k')) || {}
+    this.cache = tempCache;
+    console.log(this.cache);
+    console.log('***');
+    return "true";
+  }
+
+  // ------------------------------------------
+  //   SCORM RTE Functions - Getting and Setting Values
+  // ------------------------------------------
+  function LMSGetValue(varname) {
+      //alert(this.cache[varname]);
+      var v = this.cache[varname];
+      if(v == undefined){
+          v = ""
+      }
+      return v
+  }
+
+  function LMSSetValue(varname,varvalue) {
+    this.cache[varname] = varvalue;
+    return "true";
+  }
+
+  // ------------------------------------------
+  //   SCORM RTE Functions - Saving the Cache to the Database
+  // ------------------------------------------
+  function LMSCommit(dummyString) {
+    // code to prevent caching
+    var d = new Date();
+
+
+    // create a POST-formatted list of cached data elements
+    // include only SCO-writeable data elements
+    var params = 'scorm_rte_store[sco_instance_id]='+this.SCOInstanceID+'&code='+d.getTime();
+    params += "&scorm_rte_store[data][cmi.core.lesson_location]="+urlencode(this.cache['cmi.core.lesson_location']);
+    params += "&scorm_rte_store[data][cmi.core.lesson_status]="+urlencode(this.cache['cmi.core.lesson_status']);
+    params += "&scorm_rte_store[data][cmi.core.exit]="+urlencode(this.cache['cmi.core.exit']);
+    params += "&scorm_rte_store[data][cmi.core.session_time]="+urlencode(this.cache['cmi.core.session_time']);
+    params += "&scorm_rte_store[data][cmi.core.score.raw]="+urlencode(this.cache['cmi.core.score.raw']);
+    params += "&scorm_rte_store[data][cmi.suspend_data]="+urlencode(this.cache['cmi.suspend_data']);
+
+    // submit to the server for processing
+    var url = "http://localhost:3000/scorm_rte/stores"
+    $.ajax({
+      type: "POST",
+      headers: {
+          'Content-type' : 'application/x-www-form-urlencoded',
+          'Content-length' : params.length,
+          'Connection' : 'close'
+      },
+      url: url,
+      data: params
+    });
+
+    // process returned data - error condition
+    // if (req.status != 200) {
+    //   alert('Problem with AJAX Request in LMSCommit()');
+    //   return "false";
+    // }
+
+    // process returned data - OK
+    // else {
+    //   return "true";
+    // }
+    return "true";
+  }
+
+  // ------------------------------------------
+  //   SCORM RTE Functions - Closing The Session
+  // ------------------------------------------
+  function LMSFinish(dummyString) {
+
+    // already finished - prevent repeat call
+    if (flagFinished) {
+      return "true";
+    }
+
+    // commit cached values to the database
+      console.log('!! finish')
+
+      // console.log('***')
+      // console.log(localStorage.getItem('k'))
+      // localStorage.setItem('k', JSON.stringify(this.cache))
+      console.log(this.cache)
+      // console.log(JSON.parse(localStorage.getItem('k')))
+      // console.log('###')
+
+      LMSCommit('');
+      console.log('!! finish !!')
+      /*
+    // create request object
+    var req = createRequest();
+
+    // code to prevent caching
+    var d = new Date();
+
+    // set up request parameters - uses GET method
+    req.open('GET','finish.php?SCOInstanceID=<?php print $SCOInstanceID; ?>&code='+d.getTime(),false);
+
+    // submit to the server for processing
+    req.send(null);
+
+    // process returned data - error condition
+    if (req.status != 200) {
+      alert('Problem with AJAX Request in LMSFinish()');
+      return "";
+    }
+
+      */
+    // set finish flag
+    flagFinished = true;
+    // return to calling program
+    return "true";
+
+  }
+
+  // ------------------------------------------
+  //   SCORM RTE Functions - Error Handling
+  // ------------------------------------------
+  function LMSGetLastError() {
+    return 0;
+  }
+
+  function LMSGetDiagnostic(errorCode) {
+    return "diagnostic string";
+  }
+
+  function LMSGetErrorString(errorCode) {
+    return "error string";
+  }
+
+  // ------------------------------------------
+  //   URL Encoding
+  // ------------------------------------------
+  function urlencode( str ) {
+    //
+    // Ref: http://kevin.vanzonneveld.net/techblog/article/javascript_equivalent_for_phps_urlencode/
+    //
+      // http://kevin.vanzonneveld.net
+      // +   original by: Philip Peterson
+      // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
+      // +      input by: AJ
+      // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
+      // +   improved by: Brett Zamir (http://brettz9.blogspot.com)
+      // +   bugfixed by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
+      // +      input by: travc
+      // +      input by: Brett Zamir (http://brettz9.blogspot.com)
+      // +   bugfixed by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
+      // +   improved by: Lars Fischer
+      // %          note 1: info on what encoding functions to use from: http://xkr.us/articles/javascript/encode-compare/
+      // *     example 1: urlencode('Kevin van Zonneveld!');
+      // *     returns 1: 'Kevin+van+Zonneveld%21'
+      // *     example 2: urlencode('http://kevin.vanzonneveld.net/');
+      // *     returns 2: 'http%3A%2F%2Fkevin.vanzonneveld.net%2F'
+      // *     example 3: urlencode('http://www.google.nl/search?q=php.js&ie=utf-8&oe=utf-8&aq=t&rls=com.ubuntu:en-US:unofficial&client=firefox-a');
+      // *     returns 3: 'http%3A%2F%2Fwww.google.nl%2Fsearch%3Fq%3Dphp.js%26ie%3Dutf-8%26oe%3Dutf-8%26aq%3Dt%26rls%3Dcom.ubuntu%3Aen-US%3Aunofficial%26client%3Dfirefox-a'
+
+      var histogram = {}, unicodeStr='', hexEscStr='';
+      var ret = (str+'').toString();
+
+      var replacer = function(search, replace, str) {
+          var tmp_arr = [];
+          tmp_arr = str.split(search);
+          return tmp_arr.join(replace);
+      };
+
+      // The histogram is identical to the one in urldecode.
+      histogram["'"]   = '%27';
+      histogram['(']   = '%28';
+      histogram[')']   = '%29';
+      histogram['*']   = '%2A';
+      histogram['~']   = '%7E';
+      histogram['!']   = '%21';
+      histogram['%20'] = '+';
+      histogram['\u00DC'] = '%DC';
+      histogram['\u00FC'] = '%FC';
+      histogram['\u00C4'] = '%D4';
+      histogram['\u00E4'] = '%E4';
+      histogram['\u00D6'] = '%D6';
+      histogram['\u00F6'] = '%F6';
+      histogram['\u00DF'] = '%DF';
+      histogram['\u20AC'] = '%80';
+      histogram['\u0081'] = '%81';
+      histogram['\u201A'] = '%82';
+      histogram['\u0192'] = '%83';
+      histogram['\u201E'] = '%84';
+      histogram['\u2026'] = '%85';
+      histogram['\u2020'] = '%86';
+      histogram['\u2021'] = '%87';
+      histogram['\u02C6'] = '%88';
+      histogram['\u2030'] = '%89';
+      histogram['\u0160'] = '%8A';
+      histogram['\u2039'] = '%8B';
+      histogram['\u0152'] = '%8C';
+      histogram['\u008D'] = '%8D';
+      histogram['\u017D'] = '%8E';
+      histogram['\u008F'] = '%8F';
+      histogram['\u0090'] = '%90';
+      histogram['\u2018'] = '%91';
+      histogram['\u2019'] = '%92';
+      histogram['\u201C'] = '%93';
+      histogram['\u201D'] = '%94';
+      histogram['\u2022'] = '%95';
+      histogram['\u2013'] = '%96';
+      histogram['\u2014'] = '%97';
+      histogram['\u02DC'] = '%98';
+      histogram['\u2122'] = '%99';
+      histogram['\u0161'] = '%9A';
+      histogram['\u203A'] = '%9B';
+      histogram['\u0153'] = '%9C';
+      histogram['\u009D'] = '%9D';
+      histogram['\u017E'] = '%9E';
+      histogram['\u0178'] = '%9F';
+
+      // Begin with encodeURIComponent, which most resembles PHP's encoding functions
+      ret = encodeURIComponent(ret);
+
+      for (unicodeStr in histogram) {
+          hexEscStr = histogram[unicodeStr];
+          ret = replacer(unicodeStr, hexEscStr, ret); // Custom replace. No regexing
+      }
+
+      // Uppercase for full PHP compatibility
+      return ret.replace(/(\%([a-z0-9]{2}))/g, function(full, m1, m2) {
+          return "%"+m2.toUpperCase();
+      });
+  }
+
+}
+
+window.API = new LMSAPI();
+window.API_1484_11 = new LMSAPI();

data/app/assets/stylesheets/scorm_rte/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/scorm_rte/application_controller.rb

@@ -0,0 +1,4 @@
+module ScormRte
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/scorm_rte/stores_controller.rb

@@ -0,0 +1,19 @@
+module ScormRte
+  class StoresController < ApplicationController
+    def fetch
+      store = Store.find_by(sco_instance_id: params[:sco_instance_id])
+      render json: (store.data || {}.to_json)
+    end
+
+    def create
+      store = Store.find_or_initialize_by(
+        sco_instance_id: params[:scorm_rte_store][:sco_instance_id]
+      )
+
+      store.data = params[:scorm_rte_store][:data].to_json
+      store.save
+
+      render nothing: true
+    end
+  end
+end

data/app/helpers/scorm_rte/application_helper.rb

@@ -0,0 +1,4 @@
+module ScormRte
+  module ApplicationHelper
+  end
+end

data/app/models/scorm_rte/store.rb

@@ -0,0 +1,4 @@
+module ScormRte
+  class Store < ActiveRecord::Base
+  end
+end

data/app/views/layouts/scorm_rte/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ScormRte</title>
+  <%= stylesheet_link_tag    "scorm_rte/application", media: "all" %>
+  <%= javascript_include_tag "scorm_rte/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+ScormRte::Engine.routes.draw do
+  resource :stores, only: :create do
+    get :fetch
+  end
+end

data/db/migrate/20150321231502_create_scorm_rte_stores.rb

@@ -0,0 +1,10 @@
+class CreateScormRteStores < ActiveRecord::Migration
+  def change
+    create_table :scorm_rte_stores do |t|
+      t.string :sco_instance_id
+      t.text :data
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/scorm_rte.rb

@@ -0,0 +1,4 @@
+require 'scorm_rte/engine'
+
+module ScormRte
+end

data/lib/scorm_rte/engine.rb

@@ -0,0 +1,5 @@
+module ScormRte
+  class Engine < ::Rails::Engine
+    isolate_namespace ScormRte
+  end
+end

data/lib/scorm_rte/version.rb

@@ -0,0 +1,3 @@
+module ScormRte
+  VERSION = '0.0.2'
+end

data/lib/tasks/scorm_rte_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :scorm_rte do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: scorm_rte
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- paresharma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is an attempt to a mountable rails engine for SCORM RTE.
+email:
+- paresharma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/scorm_rte/application.js
+- app/assets/javascripts/scorm_rte/rte.js
+- app/assets/stylesheets/scorm_rte/application.css
+- app/controllers/scorm_rte/application_controller.rb
+- app/controllers/scorm_rte/stores_controller.rb
+- app/helpers/scorm_rte/application_helper.rb
+- app/models/scorm_rte/store.rb
+- app/views/layouts/scorm_rte/application.html.erb
+- config/routes.rb
+- db/migrate/20150321231502_create_scorm_rte_stores.rb
+- lib/scorm_rte.rb
+- lib/scorm_rte/engine.rb
+- lib/scorm_rte/version.rb
+- lib/tasks/scorm_rte_tasks.rake
+homepage: https://github.com/pukei/scorm_rte
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Mountable Runtime Environment for SCORM RTE.
+test_files: []