├── .gitignore ├── LICENSE ├── README.md ├── examples └── books.js ├── lib ├── index.js └── schemas.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # Compiled binary addons (http://nodejs.org/api/addons.html) 20 | build/Release 21 | 22 | # Dependency directory 23 | # Commenting this out is preferred by some people, see 24 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- 25 | node_modules 26 | 27 | # Users Environment Variables 28 | .lock-wscript 29 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2014 FriendCode Inc. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # node-opds 2 | 3 | This is a library to parse or generate OPDS feed. It makes it easy to generate a feed from a list of book., it also handles correctly BISAC subjects. 4 | 5 | ## How to install it? 6 | 7 | ``` 8 | $ npm install opds 9 | ``` 10 | 11 | ## How to use it? 12 | 13 | :warning: This example is incomplete to pass OPDS Validation (http://opds-validator.appspot.com). 14 | 15 | ```js 16 | var opds = require("opds"); 17 | 18 | var xml = opds.create({ 19 | title: "My Catalog", 20 | author: { 21 | name: "Samy Pesse", 22 | uri: "https://www.gitbook.com" 23 | }, 24 | books: [ 25 | { 26 | title: "A book", 27 | summary: "This is a test book", 28 | updated: new Date(), 29 | author: { 30 | name: "Aaron O'Mullan", 31 | uri: "https://www.gitbook.com/@aaron" 32 | }, 33 | links: [ 34 | { 35 | rel: "image", 36 | href: "/book/test.jpg", 37 | type: "image/jpeg" 38 | }, 39 | { 40 | rel: "acquisition/buy", 41 | href: "/book/test.epub", 42 | type: "application/epub+zip" 43 | } 44 | ], 45 | categories: [ 46 | "FIC020000" 47 | ] 48 | } 49 | ] 50 | }); 51 | ``` 52 | 53 | 54 | You can also parse an OPDS feed: 55 | 56 | ```js 57 | 58 | var feed = opds.parse('...'); 59 | ``` 60 | 61 | 62 | -------------------------------------------------------------------------------- /examples/books.js: -------------------------------------------------------------------------------- 1 | var opds = require("../lib"); 2 | 3 | 4 | var xml = opds.create({ 5 | title: "My Catalog", 6 | authors: [ 7 | { 8 | name: "Samy Pesse", 9 | uri: "https://www.gitbook.com" 10 | } 11 | ], 12 | books: [ 13 | { 14 | title: "A book", 15 | summary: "This is a test book", 16 | updated: new Date(), 17 | authors: [ 18 | { 19 | name: "Aaron O'Mullan", 20 | uri: "https://www.gitbook.com/@aaron" 21 | } 22 | ], 23 | links: [ 24 | { 25 | rel: "image", 26 | href: "/book/test.jpg", 27 | type: "image/jpeg" 28 | }, 29 | { 30 | rel: "acquisition/buy", 31 | href: "/book/test.epub", 32 | type: "application/epub+zip", 33 | price: 10 34 | } 35 | ], 36 | categories: [ 37 | "FIC020000" 38 | ], 39 | content: { 40 | type: 'xhtml', 41 | value: "Hello World" 42 | } 43 | } 44 | ] 45 | }); 46 | 47 | console.log(opds.parse(xml)); -------------------------------------------------------------------------------- /lib/index.js: -------------------------------------------------------------------------------- 1 | var _ = require("lodash"); 2 | var XMLSchema = require("xml-schema"); 3 | var subjects = require("subjects-utils"); 4 | 5 | var schemas = require('./schemas'); 6 | 7 | var opdsSchema = new XMLSchema(schemas.FEED); 8 | 9 | // Create an opds feed 10 | function create(feed) { 11 | return opdsSchema.generate(feed, { 12 | version: '1.0', 13 | encoding: 'UTF-8', 14 | standalone: true, 15 | pretty: true 16 | }); 17 | } 18 | 19 | function parse(xml) { 20 | return opdsSchema.parse(xml); 21 | } 22 | 23 | module.exports = { 24 | create: create, 25 | parse: parse 26 | }; 27 | -------------------------------------------------------------------------------- /lib/schemas.js: -------------------------------------------------------------------------------- 1 | var DATE = { 2 | transform: function(d) { 3 | return (new Date(d)).toISOString(); 4 | } 5 | }; 6 | 7 | var AUTHOR = { 8 | tag: 'author', 9 | array: true, 10 | fields: { 11 | name: {}, 12 | uri: {}, 13 | email: {} 14 | }, 15 | map: { 16 | to: 'name' 17 | } 18 | }; 19 | 20 | var PRICE = { 21 | tag: 'opds:price', 22 | inner: 'value', 23 | attributes: { 24 | currency: { 25 | name: 'currencycode', 26 | default: 'USD' 27 | } 28 | }, 29 | map: { 30 | to: 'value' 31 | } 32 | }; 33 | 34 | var LINK = { 35 | tag: 'link', 36 | array: true, 37 | attributes: { 38 | href: {}, 39 | rel: { 40 | transform: function(v) { 41 | return "http://opds-spec.org/"+v; 42 | } 43 | }, 44 | type: {} 45 | }, 46 | fields: { 47 | price: PRICE, 48 | prices: PRICE 49 | }, 50 | map: { 51 | href: 'name' 52 | } 53 | }; 54 | 55 | var CATEGORY = { 56 | tag: 'category', 57 | array: true, 58 | attributes: { 59 | code: { 60 | name: 'term' 61 | }, 62 | label: {}, 63 | scheme: { 64 | default: "http://www.bisg.org/standards/bisac_subject/index.html" 65 | } 66 | }, 67 | map: { 68 | to: 'code' 69 | } 70 | }; 71 | 72 | var CONTENT = { 73 | tag: 'content', 74 | inner: 'value', 75 | raw: function() { 76 | return !!(this.value.type && this.value.type != 'text'); 77 | }, 78 | attributes: { 79 | type: { 80 | default: "text" 81 | } 82 | }, 83 | map: { 84 | to: 'value' 85 | } 86 | }; 87 | 88 | var ENTRY = { 89 | tag: 'entry', 90 | array: true, 91 | fields: { 92 | id: {}, 93 | title: {}, 94 | updated: DATE, 95 | summary: {}, 96 | links: LINK, 97 | authors: AUTHOR, 98 | categories: CATEGORY, 99 | issued: { 100 | tag: "dc:issued", 101 | transform: function(d) { 102 | return d.getFullYear()+"-"+(d.getMonth()+1)+"-"+d.getDate(); 103 | } 104 | }, 105 | publisher: { 106 | tag: "dc:publisher" 107 | }, 108 | language: { 109 | tag: "dc:language" 110 | }, 111 | rights: {}, 112 | content: CONTENT 113 | } 114 | }; 115 | 116 | var FEED = { 117 | tag: 'feed', 118 | attributes: { 119 | xmlns: { 120 | default: "http://www.w3.org/2005/Atom" 121 | }, 122 | xmlnsdc: { 123 | name: "xmlns:dc", 124 | default: "http://purl.org/dc/terms/" 125 | }, 126 | xmlnsopds: { 127 | name: "xmlns:opds", 128 | default: "http://opds-spec.org/2010/catalog" 129 | } 130 | }, 131 | fields: { 132 | id: {}, 133 | title: {}, 134 | icon: {}, 135 | updated: DATE, 136 | links: LINK, 137 | authors: AUTHOR, 138 | books: ENTRY 139 | } 140 | }; 141 | 142 | module.exports = { 143 | FEED: FEED 144 | }; 145 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "opds", 3 | "version": "2.0.0", 4 | "main": "lib/index.js", 5 | "author": "GitBook ", 6 | "description": "Library to parse/generate OPDS feed", 7 | "bugs": "https://github.com/GitbookIO/node-opds/issues", 8 | "license": "Apache-2.0", 9 | "engines": { 10 | "node": ">=0.6" 11 | }, 12 | "dependencies": { 13 | "lodash": "^3.9.3", 14 | "xml-schema": "2.0.0", 15 | "subjects-utils": "0.0.1" 16 | }, 17 | "repository": { 18 | "type": "git", 19 | "url": "https://github.com/GitbookIO/node-opds.git" 20 | } 21 | } 22 | --------------------------------------------------------------------------------