.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+
+
+Tested in:
+
+- [ ] Chrome xx
+- [ ] FireFox xx
+- [ ] Safari xx
+- [ ] Brave xx
+- [ ] IE Edge
+- [ ] IE 11
+- [ ] IE 10
+- [ ] IE 9
+- [ ] IE 8
+- [ ] IE 7
+- [ ] IE 6

.travis.yml

@@ -1,5 +1,10 @@
+sudo: false
 language: node_js
 node_js:
+  - "6"
+  - "5"
+  - "4"
+  - "0.12"
   - "0.10"
 before_install: npm install -g grunt-cli
 install: npm install

Gruntfile.js

@@ -2,8 +2,10 @@
 module.exports = function(grunt) {
     "use strict";
     var coreFileList = [
-        "vendor/cryptojs-v3.0.2/rollups/sha1.js",
-        "vendor/cryptojs-v3.0.2/components/enc-base64.js",
+        "vendor/cryptojs-v3.1.2/rollups/sha1.js",
+        "vendor/cryptojs-v3.1.2/rollups/sha256.js",
+        "vendor/cryptojs-v3.1.2/components/enc-base64.js",
+        "vendor/cryptojs-v3.1.2/components/lib-typedarrays.js",
         "src/TinCan.js",
         "src/Utils.js",
         "src/LRS.js",
@@ -25,21 +27,38 @@ module.exports = function(grunt) {
         "src/State.js",
         "src/ActivityProfile.js",
         "src/AgentProfile.js",
-        "src/About.js"
+        "src/About.js",
+        "src/Attachment.js"
     ],
     browserFileList = coreFileList.slice(),
-    nodeFileList = coreFileList.slice();
+    nodeFileList = coreFileList.slice(),
+    pkg,
+    bower;
 
     browserFileList.push(
-        "src/Environment/Browser.js"
+        "src/Environment/Browser.js",
+        // needed because IE10 doesn't support Uint8ClampedArray
+        // which is required by CryptoJS for typedarray support
+        "node_modules/js-polyfills/typedarray.js",
+        // needed because IE10 doesn't have ArrayBuffer slice
+        "node_modules/arraybuffer-slice/index.js",
+        // needed for IE and Safari for TextDecoder/TextEncoder
+        "node_modules/text-encoding/lib/encoding.js"
     );
     nodeFileList.push(
         "src/Environment/Node.js"
     );
 
+    pkg = grunt.file.readJSON("package.json");
+    bower = grunt.file.readJSON("bower.json");
+
+    if (pkg.version !== bower.version) {
+        grunt.fail.fatal("package.json and bower.json versions do not match");
+    }
+
     // Project configuration.
     grunt.initConfig({
-        pkg: grunt.file.readJSON("package.json"),
+        pkg: pkg,
 
         watch: {
             files: ["src/**/*.js"],
@@ -75,7 +94,8 @@ module.exports = function(grunt) {
                 onevar: true,
                 strict: true,
                 globals: {
-                    TinCan: true
+                    TinCan: true,
+                    JSON: true
                 }
             }
         },
@@ -108,7 +128,7 @@ module.exports = function(grunt) {
             compile: {
                 version: "<%= pkg.version %>",
                 name: "TinCanJS",
-                description: "Library for working with Tin Can API in JavaScript",
+                description: "Library for working with the Experience API (Tin Can API) in JavaScript",
                 url: "http://rusticisoftware.github.com/TinCanJS/",
                 options: {
                     paths: "src/",

README.md

@@ -1,19 +1,22 @@
-A JavaScript library for implementing Tin Can API.
+A JavaScript library for implementing the Experience API (Tin Can API).
 
 [![Build Status](https://travis-ci.org/RusticiSoftware/TinCanJS.png)](https://travis-ci.org/RusticiSoftware/TinCanJS)
+[![GitHub release](https://img.shields.io/github/release/RusticiSoftware/TinCanJS.svg?maxAge=2592000)](https://github.com/RusticiSoftware/TinCanJS/releases)
+[![npm](https://img.shields.io/npm/v/tincanjs.svg?maxAge=2592000)](https://www.npmjs.com/package/tincanjs)
+[![license](https://img.shields.io/github/license/RUsticiSoftware/TinCanJS.svg?maxAge=2592000)]()
 
 For hosted API documentation, basic usage instructions, supported version listing, etc. visit the main project website at:
 
 http://rusticisoftware.github.io/TinCanJS/
 
-For more information about the Tin Can API visit:
+For more information about the Experience API visit:
 
-http://tincanapi.com/
+http://experienceapi.com/
 
 Browser Usage
 -------------
 
-TinCanJS is available via Bower.
+TinCanJS is available via `npm` and Bower.
 
 The browser environment is well tested and supports two kinds of Cross Origin requests which
 is sufficient to cover most versions of Chrome, FireFox, Safari as well as IE 8+. IE 6+ are
@@ -45,5 +48,19 @@ Environments
 ------------
 
 Implementing a new Environment should be straightforward and requires overloading a couple
-of methods on the `TinCan.LRS` prototype. There are currently two examples, `Environment/Browser`
+of methods in the library. There are currently two examples, `Environment/Browser`
 and `Environment/Node`.
+
+Attachment Support
+------------------
+
+Sending and retrieving statements with attachments via the multipart/mixed request/response
+cycle works end to end with binary attachments in Node.js 4+ and in the typical modern browsers:
+Chrome 53+, Firefox 48+, Safari 9+, IE 10+ (current versions at time of implementation, older versions
+may work without changes but have not been tested). Attachments without included content (those using
+only the `fileUrl` property) should be supported in all environments supported by the library.
+
+Several polyfills (TypedArrays, ArrayBuffer w/ slice, Blob, TextDecoder/TextEncoder) are needed
+to support various browser versions, if you are targeting a recent enough set of browsers you
+can reduce the overall size of the built library by commenting out those polyfills in the
+`Gruntfile.js` file and building yourself.

bower.json

@@ -1,9 +1,9 @@
 {
   "name": "tincan",
-  "version": "0.32.0",
+  "version": "0.50.0",
   "homepage": "http://rusticisoftware.github.com/TinCanJS/",
   "authors": [
-    "Brian J. Miller <brian.miller@scorm.com>"
+    "Brian J. Miller <brian.miller@rusticisoftware.com>"
   ],
   "description": "A JavaScript library for talking Tin Can to the world.",
   "keywords": [
@@ -14,7 +14,8 @@
     "lrs",
     "experienceapi",
     "experience api",
-    "xapi"
+    "xapi",
+    "cmi5"
   ],
   "license": "Apache 2.0",
   "main": [
@@ -29,7 +30,6 @@
     "doc",
     "src",
     "test",
-    "vendor",
-    "yuidoc.json"
+    "vendor"
   ]
 }