Added server-side node compatibility

[oliverfoster]

67

Works

• Upgraded grunt
• Added umd wrapper and grunt code to produce a umd module
• Shimmed window.location in node
• Fixed a few scope issues
• Fixed the way the text-encoding module requires in node
• Added url parser to distinguish between node and browser apis
• Moved http request abstraction out of ADL.XHR_request and into a new function
• Added a node shim for XMLHttpRequest
• Changed test readme
• Fixed old test for ADL.xapiutil
• Added 1 new test for the minified file

Notes

• The grunt config can produce source maps for the minified library, just uncomment the respective lines
• I've tried to do this with minimal disruption to existing file structures and inferred utilisation patterns.
• All files should be able to be used individually in the browser via script tags as before.

  xapiwrapper.min.js

• Contains the same bundled modules as before.
• Should now work in requirejs, commonjs and window.ADL global environments.
• Is the main file for the node package and can be included via const adl = require('xapiwrapper'); if published on npm.
• Doesn't include a working verson of ADL.launch in node

[vbhayden]

Tracking, but a PR of this scale is going to take a bit to move forward. While I get the interest in having an NPM module with xAPI-everything included, it feels like this would make curation pretty muddy.

Will review this in the next week or so.

[oliverfoster]

Let me know once you've reviewed it.

[oliverfoster]

Just checking in. Any thoughts on this?

[vbhayden]

Ok, going to look at this today. Do you have a sample app.js file or something to show it working that I could use as a starting place?

[oliverfoster]

I was using the tests to do that.

This file can be run using $ mocha test/tests/test.xapiwrapper.js https://github.com/adlnet/xAPIWrapper/blob/29154f51be1c0df8753923116100f66fdecf1a4e/test/tests/test.xapiwrapper.js

This one to get the above text running in the browser: https://github.com/adlnet/xAPIWrapper/blob/29154f51be1c0df8753923116100f66fdecf1a4e/test/textXAPIWrapper.html

It demonstrates the xapiwrapper.min.js statement, verbs, activity etc api working in both node and the browser. Launch doesn't work in node. It'll give an error. ADL.launch()

[vbhayden]

Simple examples seem to run, will look more at it later. 👍

In the meantime, it doesn't produce intellisense and we'll probably need to have more rigorous tests with more complex statement varieties.

[oliverfoster]

Yup, totally agree.

Do you have any suggestions for statement varieties?

For the intellisense I reckon it'd be easiest to produce a non-minified but compiled version with comments intact. I will have a look to see if we can just import the uncompiled source files instead though. Irritatingly the ADL object transcends multiple files but hopefully the code is segregated enough to allow that to happen without one file needing references to code in another. I don't know if it's preferable to use the uncompiled source directly? Any thoughts?

[oliverfoster]

Closed in favour of https://github.com/adlnet/xAPIWrapper/pull/126 : with intellisense and a few of the more complex bits removed.