├── .gitignore ├── LICENSE ├── README.md ├── __tests__ └── common-test.js ├── browser.js ├── common.js ├── index.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Build directory 2 | /dist 3 | 4 | # KDE hidden directories 5 | .directory 6 | 7 | # Server config files 8 | /config.js 9 | /config.js.old 10 | 11 | # Backup files 12 | *~ 13 | 14 | # Logs 15 | logs 16 | *.log 17 | 18 | # Runtime data 19 | pids 20 | *.pid 21 | *.seed 22 | 23 | # Directory for instrumented libs generated by jscoverage/JSCover 24 | lib-cov 25 | 26 | # Coverage directory used by tools like istanbul 27 | coverage 28 | 29 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 30 | .grunt 31 | 32 | # node-waf configuration 33 | .lock-wscript 34 | 35 | # Compiled binary addons (http://nodejs.org/api/addons.html) 36 | build/Release 37 | 38 | # Dependency directory 39 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git 40 | node_modules 41 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # superagent-jsonapify 2 | 3 | [![NPM](https://nodei.co/npm/superagent-jsonapify.png?downloads=true)](https://nodei.co/npm/superagent-jsonapify/) 4 | 5 | [![Dependencies](https://david-dm.org/alex94puchades/superagent-jsonapify.svg)](https://david-dm.org/alex94puchades/superagent-jsonapify) 6 | 7 | A lightweight json-api client addon for superagent. If you don't know about [jsonapify](https://www.npmjs.com/package/jsonapify) or the [JSON-API format](http://jsonapi.org/format/), you should have a look. 8 | 9 | ## Usage 10 | 11 | ES2015 style 12 | 13 | ```javascript 14 | import superagent from 'superagent'; 15 | import superagentJsonapify from 'superagent-jsonapify'; 16 | 17 | superagentJsonapify(superagent); 18 | 19 | const request = superagent.get('/api/videos?include=comments') 20 | .then(function(response) { 21 | const body = response.body; 22 | const video = body.data[0]; 23 | const comments = video.comments; 24 | }); 25 | ``` 26 | -------------------------------------------------------------------------------- /__tests__/common-test.js: -------------------------------------------------------------------------------- 1 | var common = require("../common"); 2 | 3 | describe("parse", function() { 4 | var sampleJSON = JSON.stringify({ 5 | data: { 6 | type: "products", 7 | id: "1", 8 | attributes: { 9 | "title": "Awesome product 1" 10 | }, 11 | relationships: { 12 | creator: { 13 | data: { 14 | id: "1", 15 | type: "users" 16 | } 17 | }, 18 | tags: { 19 | data: [ 20 | { 21 | id: "1", 22 | type: "tags" 23 | } 24 | ] 25 | }, 26 | comments: { 27 | data: [ 28 | { 29 | id: "1", 30 | type: "comments" 31 | } 32 | ] 33 | } 34 | } 35 | }, 36 | included: [ 37 | { 38 | type: "users", 39 | id: "1", 40 | attributes: { 41 | name: "example user 1" 42 | } 43 | }, 44 | { 45 | type: "tags", 46 | id: "1", 47 | attributes: { 48 | name: "example tag 1" 49 | } 50 | }, 51 | { 52 | type: "comments", 53 | id: "1", 54 | attributes: { 55 | body: "example comment 1" 56 | } 57 | } 58 | ] 59 | }); 60 | 61 | it("should parse json-api format json", function() { 62 | var result = common.parse(sampleJSON); 63 | expect(result["data"]["creator"]).toEqual({ 64 | type: "users", 65 | id: "1", 66 | attributes: { 67 | name: "example user 1" 68 | }, 69 | name: "example user 1" 70 | }); 71 | expect(result["data"]["tags"]).toEqual([{ 72 | type: "tags", 73 | id: "1", 74 | attributes: { 75 | name: "example tag 1" 76 | }, 77 | name: "example tag 1" 78 | }]); 79 | expect(result["data"]["comments"]).toEqual([{ 80 | type: "comments", 81 | id: "1", 82 | attributes: { 83 | body: "example comment 1" 84 | }, 85 | body: "example comment 1" 86 | }]); 87 | }); 88 | }); 89 | -------------------------------------------------------------------------------- /browser.js: -------------------------------------------------------------------------------- 1 | var common = require('./common'); 2 | 3 | var parse = common.parse; 4 | var serialize = common.serialize; 5 | 6 | module.exports = function(request) { 7 | request.parse['application/vnd.api+json'] = parse; 8 | request.serialize['application/vnd.api+json'] = serialize; 9 | }; 10 | -------------------------------------------------------------------------------- /common.js: -------------------------------------------------------------------------------- 1 | var _isUndefined = require('lodash/isUndefined'); 2 | var _isArray = require('lodash/isArray'); 3 | var _map = require('lodash/map'); 4 | var _partial = require('lodash/partial'); 5 | var _each = require('lodash/each'); 6 | var _camelCase = require('lodash/camelCase'); 7 | var _memoize = require('lodash/memoize'); 8 | var _chain = require('lodash/chain'); 9 | var _find = require('lodash/find'); 10 | var _clone = require('lodash/clone'); 11 | var _compact = require('lodash/compact'); 12 | 13 | exports.parse = function(text) { 14 | var response = JSON.parse(text); 15 | if (!_isUndefined(response.data)) 16 | response.data = parseResourceData(response, response.data); 17 | return response; 18 | }; 19 | 20 | exports.serialize = JSON.stringify; 21 | 22 | function parseResourceData(response, data) { 23 | if (!data) { 24 | return data; 25 | } else if (_isArray(data)) { 26 | return _map(data, _partial(parseResourceDataObject, response)); 27 | } else { 28 | return parseResourceDataObject(response, data); 29 | } 30 | } 31 | 32 | function parseResourceDataObject(response, data) { 33 | var result = _clone(data); 34 | _each(data.attributes, function(value, name) { 35 | Object.defineProperty(result, _camelCase(name), { value: value, enumerable: true }); 36 | }); 37 | _each(data.relationships, function(value, name) { 38 | if (_isArray(value.data)) { 39 | Object.defineProperty(result, _camelCase(name), { 40 | get: _memoize(function() { 41 | var related = _map(value.data, function(related) { 42 | var resdata = _find(response.included, function(included) { 43 | return included.id === related.id && included.type === related.type; 44 | }); 45 | if(resdata) 46 | return parseResourceDataObject(response, resdata); 47 | }); 48 | return _compact(related); 49 | }), 50 | enumerable: true 51 | }); 52 | } else if (value.data) { 53 | Object.defineProperty(result, _camelCase(name), { 54 | get: _memoize(function() { 55 | var resdata = _find(response.included, function(included) { 56 | return included.id === value.data.id && included.type === value.data.type; 57 | }); 58 | return resdata ? parseResourceDataObject(response, resdata) 59 | : null; 60 | }), 61 | enumerable: true 62 | }); 63 | } 64 | }); 65 | return result; 66 | } 67 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var common = require('./common'); 2 | 3 | var parse = common.parse; 4 | var serialize = common.serialize; 5 | 6 | module.exports = function(request) { 7 | request.parse['application/vnd.api+json'] = parseJsonApi; 8 | request.serialize['application/vnd.api+json'] = serialize; 9 | }; 10 | 11 | function parseJsonApi(res, callback) { 12 | res.text = ''; 13 | res.setEncoding('utf8'); 14 | res.on('data', function(chunk) { 15 | res.text += chunk.replace(/^\s*|\s*$/g, ''); 16 | }); 17 | res.on('end', function() { 18 | try { 19 | callback(null, parse(res.text)); 20 | } catch (err) { 21 | callback(err); 22 | } 23 | }); 24 | } 25 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "superagent-jsonapify", 3 | "version": "1.4.5", 4 | "description": "A lightweight json-api client addon for superagent", 5 | "main": "index.js", 6 | "browser": "browser.js", 7 | "scripts": { 8 | "test": "jest" 9 | }, 10 | "repository": { 11 | "type": "git", 12 | "url": "git+https://github.com/alex94puchades/superagent-jsonapify.git" 13 | }, 14 | "keywords": [ 15 | "superagent", 16 | "jsonapify", 17 | "jsonapi", 18 | "json-api", 19 | "json", 20 | "api", 21 | "rest", 22 | "client" 23 | ], 24 | "author": "Alejandro Caravaca Puchades ", 25 | "license": "Apache-2.0", 26 | "bugs": { 27 | "url": "https://github.com/alex94puchades/superagent-jsonapify/issues" 28 | }, 29 | "homepage": "https://github.com/alex94puchades/superagent-jsonapify#readme", 30 | "dependencies": { 31 | "lodash": "^4.16.2" 32 | }, 33 | "devDependencies": { 34 | "jest-cli": "^18.1.0" 35 | } 36 | } 37 | --------------------------------------------------------------------------------