├── .gitignore
├── Gruntfile.js
├── LICENSE
├── README.md
├── dist
    └── backbone-jsonapi.min.js
├── package.json
├── src
    ├── backbone-jsonapi.js
    ├── toolbox.js
    └── umd.js
└── test
    ├── mock
        └── samples.js
    └── test.js


/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | npm-debug.log
3 | node_modules
4 | 


--------------------------------------------------------------------------------
/Gruntfile.js:
--------------------------------------------------------------------------------
  1 | module.exports = function (grunt) {
  2 |   grunt.initConfig({
  3 |     pkg: grunt.file.readJSON('package.json'),
  4 |     browserify: {
  5 |       dist: {
  6 |         files: {
  7 |           'dist/backbone-jsonapi.js': ['src/umd.js']
  8 |         },
  9 |       }
 10 |     },
 11 |     uglify: {
 12 |       options: {
 13 |         banner: '/*! <%= pkg.name %> - v <%= pkg.version %> - Copyright <%= pkg.author %> <%= grunt.template.today("yyyy-mm-dd") %> */\n'
 14 |       },
 15 |       dist: {
 16 |         files: {
 17 |           'dist/backbone-jsonapi.min.js': ['dist/backbone-jsonapi.js']
 18 |         }
 19 |       }
 20 |     },
 21 |     replace: {
 22 |       example: {
 23 |         src: ['src/backbone-jsonapi.js'],
 24 |         dest: 'src/backbone-jsonapi.js',
 25 |         replacements: [{
 26 |           from: /module.exports.VERSION = '[0-9]+\.[0-9]+\.[0-9]+';/,
 27 |           to: 'module.exports.VERSION = \'<%= pkg.version %>\';'
 28 |         }]
 29 |       }
 30 |     },
 31 |     clean: ['dist/backbone-jsonapi.js'],
 32 |     mochaTest: {
 33 |       all: {
 34 |         options: {
 35 |           reporter: 'spec'
 36 |         },
 37 |         src: ['test/**/*.js', '!test/mock/**']
 38 |       }
 39 |     },
 40 |     jshint: {
 41 |       options: {
 42 |         indent: 2,
 43 |         camelcase: true,
 44 |         nonew: true,
 45 |         plusplus: true,
 46 |         quotmark: true,
 47 |         bitwise: true,
 48 |         forin: true,
 49 |         curly: true,
 50 |         eqeqeq: true,
 51 |         immed: true,
 52 |         latedef: true,
 53 |         newcap: true,
 54 |         noarg: true,
 55 |         undef: true,
 56 |         unused: true,
 57 |         regexp: true,
 58 |         trailing: true,
 59 |         node: true,
 60 |         browser: true
 61 |       },
 62 |       gruntfile: {
 63 |         files: {
 64 |           src: ['Gruntfile.js']
 65 |         }
 66 |       },
 67 |       dev: {
 68 |         files: {
 69 |           src: ['src/**/*.js']
 70 |         },
 71 |         options: {
 72 |           debug: true,
 73 |           devel: true
 74 |         }
 75 |       },
 76 |       dist: {
 77 |         files: {
 78 |           src: ['src/**/*.js']
 79 |         }
 80 |       },
 81 |       test: {
 82 |         files: {
 83 |           src: ['test/**/*.js']
 84 |         },
 85 |         options: {
 86 |           globals: {
 87 |             describe: true,
 88 |             it: true,
 89 |             before: true,
 90 |             after: true,
 91 |             beforeEach: true,
 92 |             afterEach: true
 93 |           }
 94 |         }
 95 |       }
 96 |     }
 97 |   });
 98 | 
 99 |   grunt.loadNpmTasks('grunt-contrib-jshint');
100 |   grunt.loadNpmTasks('grunt-mocha-test');
101 |   grunt.loadNpmTasks('grunt-browserify');
102 |   grunt.loadNpmTasks('grunt-contrib-uglify');
103 |   grunt.loadNpmTasks('grunt-text-replace');
104 |   grunt.loadNpmTasks('grunt-contrib-clean');
105 | 
106 |   grunt.registerTask('lint', ['jshint']);
107 |   grunt.registerTask('test', ['mochaTest']);
108 |   grunt.registerTask('dist', ['replace', 'browserify', 'uglify', 'clean']);
109 |   grunt.registerTask('default', ['jshint', 'mochaTest', 'dist']);
110 | };


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2013 guillaumervls
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Backbone JSON-API
 2 | =================
 3 | 
 4 | Backbone Model &amp; Collection .parse() functions for data from a [JSON API](http://jsonapi.org/format/#url-based-json-api)
 5 | 
 6 | ### Install
 7 | 
 8 | ̀`npm install backbone-jsonapi`
 9 | 
10 | 
11 | # Use
12 | 
13 | The "ready to use" [script file](https://raw.github.com/guillaumervls/backbone-jsonapi/master/dist/backbone-jsonapi.min.js)
14 | is in the `dist` folder.
15 | 
16 | ```html
17 | <script src='backbone-jsonapi.min.js'></script>
18 | <!--
19 |   Works with or without AMD
20 |   In both case it requires '_' and 'Backbone'
21 |  -->
22 | ```
23 | 
24 | Also works with [Browserify](https://github.com/substack/node-browserify) :
25 | 
26 | ```javascript
27 | require('backbone-jsonapi')(Backbone, _);
28 | ```
29 | 
30 | 
31 | ## (Re)build
32 | 
33 | ```
34 | npm install
35 | grunt dist
36 | ```
37 | 
38 | ## Test
39 | 
40 | ```
41 | npm install
42 | grunt lint
43 | grunt test
44 | ```
45 | 
46 | ### Licence
47 | 
48 | **The MIT License (MIT)**
49 | 
50 | *Copyright (c) 2013 guillaumervls*
51 | 
52 | Permission is hereby granted, free of charge, to any person obtaining a copy of
53 | this software and associated documentation files (the "Software"), to deal in
54 | the Software without restriction, including without limitation the rights to
55 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
56 | the Software, and to permit persons to whom the Software is furnished to do so,
57 | subject to the following conditions:
58 | 
59 | The above copyright notice and this permission notice shall be included in all
60 | copies or substantial portions of the Software.
61 | 
62 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
63 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
64 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
65 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
66 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
67 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
68 | 


--------------------------------------------------------------------------------
/dist/backbone-jsonapi.min.js:
--------------------------------------------------------------------------------
1 | /*! backbone-jsonapi - v 0.1.6 - Copyright guillaumervls 2013-11-27 */
2 | !function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g<d.length;g++)e(d[g]);return e}({1:[function(a,b){var c=a("./toolbox");b.exports=function(a,d){if(!a||!d)throw new Error("Backbone and/or Lodash (or Underscore) are not loaded...");return c=c(d),a.Collection.prototype.parse=function(a){if(void 0!==a){var b=c.parse(a),e=c.getMainCollection(a);return d.each(b[e],function(a){a._alreadyBBJSONAPIParsed=!0})}},a.Model.prototype.parse=function(a){if(void 0!==a){if(a._alreadyBBJSONAPIParsed)return delete a._alreadyBBJSONAPIParsed,a;var b=c.parse(a),d=c.getMainCollection(a);return b[d][0]}},b.exports},b.exports.VERSION="0.1.6"},{"./toolbox":2}],2:[function(a,b){var c;b.exports=function(a){return c=a,c.forOwn=c.forOwn||function(a,b){var d;try{d=c.keys(a)}catch(e){return}c.each(d,function(c){b(a[c],c)})},b.exports};var d=b.exports.findById=function(a,b){return c.find(a,function(a){return a.id===b})},e=b.exports.applyTemplateUrl=function(a,b,c){var d=new RegExp("{"+a+"\\.(.+?)}","g"),e=d.exec(b);if(null!==e){if(void 0===c[e[1]]&&void 0===c.links[e[1]])throw new Error("Template required a property not present in data object");b=b.substr(0,e.index)+(c.links[e[1]]||c[e[1]])+b.substr(d.lastIndex)}return b},f=b.exports.processLink=function(a,b,f){var g=f.split("."),h=g[0],i=g[1];return c.each(a[h],function(c){if(c.links=c.links||{},void 0!==c.links[i]){var f=d(a[b.type],c.links[i]);void 0!==f&&(c[i]=f)}try{c.links[i]=e(h,b.href,c)}catch(g){}}),a};b.exports.parse=function(a){return c.forOwn(a.links,function(b,c){f(a,b,c)}),a},b.exports.getMainCollection=function(a){var b=c.without(c.keys(a),"links","meta"),d=c.pluck(c.values(a.links),"type");return c.difference(b,d)[0]}},{}],3:[function(a){var b=a("./backbone-jsonapi");"function"==typeof define&&define.amd?define(["Backbone","_"],function(a,c){return window.backboneJsonApi=b(a,c),window.backboneJsonApi}):window.backboneJsonApi=b(window.Backbone,window._)},{"./backbone-jsonapi":1}]},{},[3]);


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "backbone-jsonapi",
 3 |   "version": "0.1.6",
 4 |   "description": "Backbone Model & Collection .parse() functions for data from a JSON API",
 5 |   "scripts": {
 6 |     "test": "grunt test"
 7 |   },
 8 |   "repository": {
 9 |     "type": "git",
10 |     "url": "git://github.com/guillaumervls/backbone-jsonapi.git"
11 |   },
12 |   "main": "src/backbone-jsonapi.js",
13 |   "keywords": [
14 |     "backbone",
15 |     "json",
16 |     "api",
17 |     "parse"
18 |   ],
19 |   "devDependencies": {
20 |     "grunt": "~0.4.1",
21 |     "grunt-contrib-jshint": "~0.6.2",
22 |     "grunt-mocha-test": "~0.6.2",
23 |     "mocha": "~1.12.0",
24 |     "chai": "~1.7.2",
25 |     "lodash": "~2.2.0",
26 |     "browserify": "~2.33.1",
27 |     "grunt-browserify": "~1.2.8",
28 |     "grunt-contrib-uglify": "~0.2.4",
29 |     "grunt-text-replace": "~0.3.8",
30 |     "grunt-contrib-clean": "~0.5.0"
31 |   },
32 |   "author": "guillaumervls",
33 |   "license": "MIT",
34 |   "bugs": {
35 |     "url": "https://github.com/guillaumervls/backbone-jsonapi/issues"
36 |   }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/backbone-jsonapi.js:
--------------------------------------------------------------------------------
 1 | var toolbox = require('./toolbox');
 2 | 
 3 | module.exports = function (Backbone, _) {
 4 |   if (!Backbone || !_) {
 5 |     throw new Error('Backbone and/or Lodash (or Underscore) are not loaded...');
 6 |   }
 7 |   toolbox = toolbox(_); // Bootstrap toolbox;
 8 |   Backbone.Collection.prototype.parse = function (response) {
 9 |     if (response === undefined) {
10 |       return;
11 |     }
12 |     var output = toolbox.parse(response);
13 |     var mainCollection = toolbox.getMainCollection(response);
14 |     return _.each(output[mainCollection], function (obj) {
15 |       obj._alreadyBBJSONAPIParsed = true;
16 |     });
17 |   };
18 |   Backbone.Model.prototype.parse = function (response) {
19 |     if (response === undefined) {
20 |       return;
21 |     }
22 |     if (response._alreadyBBJSONAPIParsed) {
23 |       delete response._alreadyBBJSONAPIParsed;
24 |       return response;
25 |     }
26 |     var output = toolbox.parse(response);
27 |     var mainCollection = toolbox.getMainCollection(response);
28 |     return output[mainCollection][0];
29 |   };
30 |   return module.exports;
31 | };
32 | 
33 | module.exports.VERSION = '0.1.6';
34 | 


--------------------------------------------------------------------------------
/src/toolbox.js:
--------------------------------------------------------------------------------
 1 | var _;
 2 | 
 3 | module.exports = function bootStrapToolBox(lodash) {
 4 |   _ = lodash;
 5 |   // Underscore shim
 6 |   _.forOwn = _.forOwn || function (obj, iterator) {
 7 |     var keys;
 8 |     try {
 9 |       keys = _.keys(obj);
10 |     } catch (e) {
11 |       return;
12 |     }
13 |     _.each(keys, function (key) {
14 |       iterator(obj[key], key);
15 |     });
16 |   };
17 |   return module.exports;
18 | };
19 | 
20 | var findById = module.exports.findById = function (array, id) {
21 |   return _.find(array, function (item) {
22 |     return item.id === id;
23 |   });
24 | };
25 | 
26 | var applyTemplateUrl = module.exports.applyTemplateUrl = function (collectionName, template, data) {
27 |   var regex = new RegExp('{' + collectionName + '\\.(.+?)}', 'g'),
28 |     execResult = regex.exec(template);
29 |   if (execResult !== null) {
30 |     if (data[execResult[1]] === undefined && data.links[execResult[1]] === undefined) {
31 |       throw new Error('Template required a property not present in data object');
32 |     }
33 |     template = template.substr(0, execResult.index) + (data.links[execResult[1]] || data[execResult[1]]) + template.substr(regex.lastIndex);
34 |   }
35 |   return template;
36 | };
37 | 
38 | var processLink = module.exports.processLink = function (response, linkObj, linkName) {
39 |   var linkNameSplit = linkName.split('.'),
40 |     collection = linkNameSplit[0],
41 |     attribute = linkNameSplit[1];
42 | 
43 |   _.each(response[collection], function (item) {
44 |     item.links = item.links || {};
45 |     if (item.links[attribute] !== undefined) {
46 |       var preloadedItem = findById(response[linkObj.type], item.links[attribute]);
47 |       if (preloadedItem !== undefined) {
48 |         item[attribute] = preloadedItem;
49 |       }
50 |     }
51 |     try {
52 |       item.links[attribute] = applyTemplateUrl(collection, linkObj.href, item);
53 |     } catch (e) {}
54 |   });
55 |   return response;
56 | };
57 | 
58 | module.exports.parse = function (response) {
59 |   _.forOwn(response.links, function (value, key) {
60 |     processLink(response, value, key);
61 |   });
62 |   return response;
63 | };
64 | 
65 | module.exports.getMainCollection = function (response) {
66 |   var collections = _.without(_.keys(response), 'links', 'meta');
67 |   var types = _.pluck(_.values(response.links), 'type');
68 |   return _.difference(collections, types)[0];
69 | };


--------------------------------------------------------------------------------
/src/umd.js:
--------------------------------------------------------------------------------
 1 | /*global define*/
 2 | var backboneJsonApi = require('./backbone-jsonapi');
 3 | if (typeof define === 'function' && define.amd) {
 4 |   define(['Backbone', '_'], function (Backbone, _) {
 5 |     window.backboneJsonApi = backboneJsonApi(Backbone, _);
 6 |     return window.backboneJsonApi;
 7 |   });
 8 | } else {
 9 |   window.backboneJsonApi = backboneJsonApi(window.Backbone, window._);
10 | }


--------------------------------------------------------------------------------
/test/mock/samples.js:
--------------------------------------------------------------------------------
  1 | module.exports.input = {
  2 |   'videos': [{
  3 |     'voteCount': 1809,
  4 |     'title': 'Le grand détournement - La classe Américaine : Vous savez parler comme',
  5 |     'sourceUrl': 'http://youtu.be/HiIcjL9FKX4',
  6 |     'source': 'youtube',
  7 |     'playerUrl': '/iframe-wrappers/youtube?id=HiIcjL9FKX4',
  8 |     'pictureUrl': '//img.youtube.com/vi/HiIcjL9FKX4/0.jpg',
  9 |     'id': 'le-grand-detournement-la-classe-americaine-vous-savez-parler-comme-ca-e',
 10 |     'duration': 42,
 11 |     'date': '2013-10-01T09:47:15.243Z',
 12 |     'links': {
 13 |       'user': 'donald',
 14 |       'shortlist': 'classe-americaine',
 15 |       'category': 'cinema'
 16 |     }
 17 |   }, {
 18 |     'voteCount': 1363,
 19 |     'title': 'Le Grand Détournement - La classe Américaine : Chips !',
 20 |     'sourceUrl': 'http://youtu.be/2OXAFqcQAfo',
 21 |     'source': 'youtube',
 22 |     'playerUrl': '/iframe-wrappers/youtube?id=2OXAFqcQAfo',
 23 |     'pictureUrl': '//img.youtube.com/vi/2OXAFqcQAfo/0.jpg',
 24 |     'id': 'le-grand-detournement-la-classe-americaine-chips',
 25 |     'duration': 81,
 26 |     'date': '2013-10-01T09:47:14.583Z',
 27 |     'links': {
 28 |       'user': 'michelle',
 29 |       'shortlist': 'classe-americaine',
 30 |       'category': 'cinema'
 31 |     }
 32 |   }, {
 33 |     'voteCount': 1,
 34 |     'title': 'La Classe Américaine - Trailer',
 35 |     'sourceUrl': 'http://youtu.be/rb9e4mnF-zM',
 36 |     'source': 'youtube',
 37 |     'playerUrl': '/iframe-wrappers/youtube?id=rb9e4mnF-zM',
 38 |     'pictureUrl': '//img.youtube.com/vi/rb9e4mnF-zM/0.jpg',
 39 |     'id': 'la-classe-americaine-trailer',
 40 |     'duration': 115,
 41 |     'date': '2013-10-01T09:47:15.755Z',
 42 |     'links': {
 43 |       'user': 'george',
 44 |       'shortlist': 'classe-americaine',
 45 |       'category': 'cinema'
 46 |     }
 47 |   }, {
 48 |     'voteCount': 1,
 49 |     'title': 'La Classe Américaine - Mexican Food',
 50 |     'sourceUrl': 'http://youtu.be/SBW7FohL65I',
 51 |     'source': 'youtube',
 52 |     'playerUrl': '/iframe-wrappers/youtube?id=SBW7FohL65I',
 53 |     'pictureUrl': '//img.youtube.com/vi/SBW7FohL65I/0.jpg',
 54 |     'id': 'la-classe-americaine-mexican-food',
 55 |     'duration': 113,
 56 |     'date': '2013-10-01T09:47:15.589Z',
 57 |     'links': {
 58 |       'user': 'rick',
 59 |       'shortlist': 'classe-americaine',
 60 |       'category': 'cinema'
 61 |     }
 62 |   }, {
 63 |     'voteCount': 1,
 64 |     'title': 'La Classe Américaine - La lettre',
 65 |     'sourceUrl': 'http://youtu.be/lWwJ6VrKRWY',
 66 |     'source': 'youtube',
 67 |     'playerUrl': '/iframe-wrappers/youtube?id=lWwJ6VrKRWY',
 68 |     'pictureUrl': '//img.youtube.com/vi/lWwJ6VrKRWY/0.jpg',
 69 |     'id': 'la-classe-americaine-la-lettre',
 70 |     'duration': 445,
 71 |     'date': '2013-10-01T09:47:15.243Z',
 72 |     'links': {
 73 |       'user': 'richard',
 74 |       'shortlist': 'classe-americaine',
 75 |       'category': 'cinema'
 76 |     }
 77 |   }, {
 78 |     'voteCount': 1,
 79 |     'title': 'Le grand détournement - La Classe américaine complet',
 80 |     'sourceUrl': 'http://youtu.be/ZDMUu_JTa3s',
 81 |     'source': 'youtube',
 82 |     'playerUrl': '/iframe-wrappers/youtube?id=ZDMUu_JTa3s',
 83 |     'pictureUrl': '//img.youtube.com/vi/ZDMUu_JTa3s/0.jpg',
 84 |     'id': 'le-grand-detournement-la-classe-americaine-complet',
 85 |     'duration': 4312,
 86 |     'date': '2013-10-01T09:47:15.224Z',
 87 |     'links': {
 88 |       'user': 'donald',
 89 |       'shortlist': 'classe-americaine',
 90 |       'category': 'cinema'
 91 |     }
 92 |   }],
 93 |   'users': [{
 94 |     'name': 'Donald',
 95 |     'id': 'donald'
 96 |   }, {
 97 |     'name': 'Michelle',
 98 |     'id': 'michelle'
 99 |   }, {
100 |     'name': 'George',
101 |     'id': 'george'
102 |   }, {
103 |     'name': 'Rick',
104 |     'id': 'rick'
105 |   }, {
106 |     'name': 'Richard',
107 |     'id': 'richard'
108 |   }],
109 |   'shortlists': [{
110 |     'name': 'La Classe Américaine',
111 |     'id': 'classe-americaine'
112 |   }],
113 |   'categories': [{
114 |     'name': 'Cinema',
115 |     'id': 'cinema'
116 |   }],
117 |   'links': {
118 |     'videos.user': {
119 |       'href': '/engine/users/{videos.user}',
120 |       'type': 'users'
121 |     },
122 |     'videos.shortlist': {
123 |       'href': '/engine/shortlists/{videos.shortlist}',
124 |       'type': 'shortlists'
125 |     },
126 |     'videos.category': {
127 |       'href': '/engine/categories/{videos.category}',
128 |       'type': 'categories'
129 |     },
130 |     'videos.vote': {
131 |       'href': '/engine/videos/{videos.id}/votes'
132 |     }
133 |   }
134 | };
135 | 
136 | module.exports.output = [{
137 |   'voteCount': 1809,
138 |   'title': 'Le grand détournement - La classe Américaine : Vous savez parler comme',
139 |   'sourceUrl': 'http://youtu.be/HiIcjL9FKX4',
140 |   'source': 'youtube',
141 |   'playerUrl': '/iframe-wrappers/youtube?id=HiIcjL9FKX4',
142 |   'pictureUrl': '//img.youtube.com/vi/HiIcjL9FKX4/0.jpg',
143 |   'id': 'le-grand-detournement-la-classe-americaine-vous-savez-parler-comme-ca-e',
144 |   'duration': 42,
145 |   'date': '2013-10-01T09:47:15.243Z',
146 |   'category': {
147 |     'name': 'Cinema',
148 |     'id': 'cinema'
149 |   },
150 |   'shortlist': {
151 |     'name': 'La Classe Américaine',
152 |     'id': 'classe-americaine'
153 |   },
154 |   'user': {
155 |     'id': 'donald',
156 |     'name': 'Donald'
157 |   },
158 |   'links': {
159 |     'user': '/engine/users/donald',
160 |     'shortlist': '/engine/shortlists/classe-americaine',
161 |     'category': '/engine/categories/cinema',
162 |     'vote': '/engine/videos/le-grand-detournement-la-classe-americaine-vous-savez-parler-comme-ca-e/votes'
163 |   },
164 |   '_alreadyBBJSONAPIParsed': true
165 | }, {
166 |   'voteCount': 1363,
167 |   'title': 'Le Grand Détournement - La classe Américaine : Chips !',
168 |   'sourceUrl': 'http://youtu.be/2OXAFqcQAfo',
169 |   'source': 'youtube',
170 |   'playerUrl': '/iframe-wrappers/youtube?id=2OXAFqcQAfo',
171 |   'pictureUrl': '//img.youtube.com/vi/2OXAFqcQAfo/0.jpg',
172 |   'id': 'le-grand-detournement-la-classe-americaine-chips',
173 |   'duration': 81,
174 |   'date': '2013-10-01T09:47:14.583Z',
175 |   'category': {
176 |     'name': 'Cinema',
177 |     'id': 'cinema'
178 |   },
179 |   'shortlist': {
180 |     'name': 'La Classe Américaine',
181 |     'id': 'classe-americaine'
182 |   },
183 |   'user': {
184 |     'id': 'michelle',
185 |     'name': 'Michelle'
186 |   },
187 |   'links': {
188 |     'user': '/engine/users/michelle',
189 |     'shortlist': '/engine/shortlists/classe-americaine',
190 |     'category': '/engine/categories/cinema',
191 |     'vote': '/engine/videos/le-grand-detournement-la-classe-americaine-chips/votes'
192 |   },
193 |   '_alreadyBBJSONAPIParsed': true
194 | }, {
195 |   'voteCount': 1,
196 |   'title': 'La Classe Américaine - Trailer',
197 |   'sourceUrl': 'http://youtu.be/rb9e4mnF-zM',
198 |   'source': 'youtube',
199 |   'playerUrl': '/iframe-wrappers/youtube?id=rb9e4mnF-zM',
200 |   'pictureUrl': '//img.youtube.com/vi/rb9e4mnF-zM/0.jpg',
201 |   'id': 'la-classe-americaine-trailer',
202 |   'duration': 115,
203 |   'date': '2013-10-01T09:47:15.755Z',
204 |   'category': {
205 |     'name': 'Cinema',
206 |     'id': 'cinema'
207 |   },
208 |   'shortlist': {
209 |     'name': 'La Classe Américaine',
210 |     'id': 'classe-americaine'
211 |   },
212 |   'user': {
213 |     'id': 'george',
214 |     'name': 'George'
215 |   },
216 |   'links': {
217 |     'user': '/engine/users/george',
218 |     'shortlist': '/engine/shortlists/classe-americaine',
219 |     'category': '/engine/categories/cinema',
220 |     'vote': '/engine/videos/la-classe-americaine-trailer/votes'
221 |   },
222 |   '_alreadyBBJSONAPIParsed': true
223 | }, {
224 |   'voteCount': 1,
225 |   'title': 'La Classe Américaine - Mexican Food',
226 |   'sourceUrl': 'http://youtu.be/SBW7FohL65I',
227 |   'source': 'youtube',
228 |   'playerUrl': '/iframe-wrappers/youtube?id=SBW7FohL65I',
229 |   'pictureUrl': '//img.youtube.com/vi/SBW7FohL65I/0.jpg',
230 |   'id': 'la-classe-americaine-mexican-food',
231 |   'duration': 113,
232 |   'date': '2013-10-01T09:47:15.589Z',
233 |   'category': {
234 |     'name': 'Cinema',
235 |     'id': 'cinema'
236 |   },
237 |   'shortlist': {
238 |     'name': 'La Classe Américaine',
239 |     'id': 'classe-americaine'
240 |   },
241 |   'user': {
242 |     'id': 'rick',
243 |     'name': 'Rick'
244 |   },
245 |   'links': {
246 |     'user': '/engine/users/rick',
247 |     'shortlist': '/engine/shortlists/classe-americaine',
248 |     'category': '/engine/categories/cinema',
249 |     'vote': '/engine/videos/la-classe-americaine-mexican-food/votes'
250 |   },
251 |   '_alreadyBBJSONAPIParsed': true
252 | }, {
253 |   'voteCount': 1,
254 |   'title': 'La Classe Américaine - La lettre',
255 |   'sourceUrl': 'http://youtu.be/lWwJ6VrKRWY',
256 |   'source': 'youtube',
257 |   'playerUrl': '/iframe-wrappers/youtube?id=lWwJ6VrKRWY',
258 |   'pictureUrl': '//img.youtube.com/vi/lWwJ6VrKRWY/0.jpg',
259 |   'id': 'la-classe-americaine-la-lettre',
260 |   'duration': 445,
261 |   'date': '2013-10-01T09:47:15.243Z',
262 |   'category': {
263 |     'name': 'Cinema',
264 |     'id': 'cinema'
265 |   },
266 |   'shortlist': {
267 |     'name': 'La Classe Américaine',
268 |     'id': 'classe-americaine'
269 |   },
270 |   'user': {
271 |     'id': 'richard',
272 |     'name': 'Richard'
273 |   },
274 |   'links': {
275 |     'user': '/engine/users/richard',
276 |     'shortlist': '/engine/shortlists/classe-americaine',
277 |     'category': '/engine/categories/cinema',
278 |     'vote': '/engine/videos/la-classe-americaine-la-lettre/votes'
279 |   },
280 |   '_alreadyBBJSONAPIParsed': true
281 | }, {
282 |   'voteCount': 1,
283 |   'title': 'Le grand détournement - La Classe américaine complet',
284 |   'sourceUrl': 'http://youtu.be/ZDMUu_JTa3s',
285 |   'source': 'youtube',
286 |   'playerUrl': '/iframe-wrappers/youtube?id=ZDMUu_JTa3s',
287 |   'pictureUrl': '//img.youtube.com/vi/ZDMUu_JTa3s/0.jpg',
288 |   'id': 'le-grand-detournement-la-classe-americaine-complet',
289 |   'duration': 4312,
290 |   'date': '2013-10-01T09:47:15.224Z',
291 |   'category': {
292 |     'name': 'Cinema',
293 |     'id': 'cinema'
294 |   },
295 |   'shortlist': {
296 |     'name': 'La Classe Américaine',
297 |     'id': 'classe-americaine'
298 |   },
299 |   'user': {
300 |     'id': 'donald',
301 |     'name': 'Donald'
302 |   },
303 |   'links': {
304 |     'user': '/engine/users/donald',
305 |     'shortlist': '/engine/shortlists/classe-americaine',
306 |     'category': '/engine/categories/cinema',
307 |     'vote': '/engine/videos/le-grand-detournement-la-classe-americaine-complet/votes'
308 |   },
309 |   '_alreadyBBJSONAPIParsed': true
310 | }];


--------------------------------------------------------------------------------
/test/test.js:
--------------------------------------------------------------------------------
 1 | var chai = require('chai'),
 2 |   _ = require('lodash'),
 3 |   samples = require('./mock/samples'),
 4 |   toolbox = require('../src/toolbox')(_);
 5 | 
 6 | var Backbone = {
 7 |   Collection: function () {},
 8 |   Model: function () {}
 9 | };
10 | 
11 | require('../src/backbone-jsonapi.js')(Backbone, _);
12 | chai.should();
13 | 
14 | var model = new Backbone.Model();
15 | var collection = new Backbone.Collection();
16 | 
17 | var input;
18 | beforeEach(function () {
19 |   input = _.clone(samples.input, true);
20 | });
21 | 
22 | describe('Toolbox', function () {
23 |   it('findById should find an item in a collection by id', function () {
24 |     toolbox.findById(input.users, 'donald').name.should.equal('Donald');
25 |   });
26 |   it('processLink should create the proper links in the objects', function () {
27 |     toolbox.processLink(input, input.links['videos.user'], 'videos.user').videos[1].links.user.should.equal('/engine/users/michelle');
28 |     toolbox.processLink(input, input.links['videos.user'], 'videos.user').videos[2].user.name.should.equal('George');
29 |   });
30 |   it('getMainCollection should find the main collection', function () {
31 |     toolbox.getMainCollection(input).should.equal('videos');
32 |   });
33 | });
34 | 
35 | describe('Parser', function () {
36 |   it('should work for a collection', function () {
37 |     collection.parse(input).should.deep.equal(samples.output);
38 |   });
39 |   it('should work for a model', function () {
40 |     input.videos = [input.videos[3]];
41 |     model.parse(input).should.deep.equal(_.omit(samples.output[3], '_alreadyBBJSONAPIParsed'));
42 |   });
43 | });


--------------------------------------------------------------------------------