├── .gitignore ├── .npmrc ├── bin.js ├── index.js ├── lib ├── defaults.json ├── get.js └── save.js ├── license ├── package.json ├── readme.md ├── test.js └── utils ├── fs.js └── text.js /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules/ -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false -------------------------------------------------------------------------------- /bin.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | var yargs = require('yargs') 3 | var lib = require('.') 4 | 5 | yargs 6 | .usage('$0 [args]') 7 | .command('save [url]', 'save a url', function (yargs) { 8 | yargs 9 | .positional('url', { 10 | type: 'string', 11 | describe: 'the url to save' 12 | }) 13 | .option('output', { 14 | alias: 'o', 15 | describe: 'output directory', 16 | default: process.cwd() 17 | }) 18 | }, function (argv) { 19 | if (!argv.url) { 20 | return console.log('Please provide a URL: drop save [url]') 21 | } 22 | 23 | try { 24 | return lib.save(argv.url, argv) 25 | } catch (err) { 26 | return console.log('Can not save: ' + err.message) 27 | } 28 | }) 29 | .help() 30 | .argv 31 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var xtend = require('xtend') 2 | var path = require('path') 3 | var fs = require('./utils/fs') 4 | 5 | var template = '

{{TITLE}}

{{CONTENT}}
' 6 | var style = fs.readFileSync(path.join(__dirname, '/node_modules/github-markdown-css/github-markdown.css'), 'utf8') 7 | 8 | var libSave = require('./lib/save') 9 | var libGet = require('./lib/get') 10 | 11 | module.exports = { 12 | get: function (urlPage, opts, callback) { 13 | var options = xtend({ }, opts) 14 | return libGet(urlPage, options, callback) 15 | }, 16 | save: function (urlPage, opts) { 17 | var options = xtend({ 18 | template: template, 19 | style: style, 20 | fs: fs 21 | }, opts) 22 | return libSave(urlPage, options) 23 | } 24 | } -------------------------------------------------------------------------------- /lib/defaults.json: -------------------------------------------------------------------------------- 1 | { 2 | "prepend": "YYMMDD" 3 | } -------------------------------------------------------------------------------- /lib/get.js: -------------------------------------------------------------------------------- 1 | var normalizeUrl = require('normalize-url') 2 | var objectValues = require('object-values') 3 | var read = require('node-readability') 4 | var timestamp = require('time-stamp') 5 | var assert = require('assert') 6 | var xtend = require('xtend') 7 | var path = require('path') 8 | 9 | var utilText = require('../utils/text') 10 | var defaults = require('./defaults.json') 11 | 12 | module.exports = save 13 | 14 | function save (url, opts, callback) { 15 | assert.equal(typeof url, 'string', 'drop/save: arg1 url must be type string') 16 | assert.equal(typeof opts, 'object', 'drop/save: arg2 opts must be type string') 17 | assert.equal(typeof callback, 'function', 'drop/get: arg3 opts must be type function') 18 | 19 | var options = xtend(defaults, opts) 20 | var urlPage = normalizeUrl(url) 21 | 22 | read(urlPage, function (err, page, meta) { 23 | if (err) throw err.message 24 | var pageBasename = timestamp(options.prepend) + '-' + utilText.sanitize(page.title) 25 | 26 | callback(err, { 27 | basename: pageBasename, 28 | content: page.content, 29 | title: page.title, 30 | date: Date.now(), 31 | url: urlPage, 32 | source: url 33 | }) 34 | 35 | page.close() 36 | }) 37 | } 38 | 39 | function getPageImages (pageDocument) { 40 | try { 41 | var images = pageDocument.querySelectorAll('img') 42 | return objectValues(images).map(function (image) { 43 | return image.getAttribute('src') 44 | }) 45 | } catch (err) { 46 | return [ ] 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /lib/save.js: -------------------------------------------------------------------------------- 1 | var normalizeUrl = require('normalize-url') 2 | var objectValues = require('object-values') 3 | var createHTML = require('create-html') 4 | var read = require('node-readability') 5 | var timestamp = require('time-stamp') 6 | var assert = require('assert') 7 | var xtend = require('xtend') 8 | var path = require('path') 9 | var mkdirp = require("mkdirp") 10 | 11 | var libGet = require('./get') 12 | var utilText = require('../utils/text') 13 | var defaults = require('./defaults.json') 14 | 15 | module.exports = save 16 | 17 | function save (url, opts) { 18 | assert.equal(typeof url, 'string', 'drop/save: arg1 url must be type string') 19 | assert.equal(typeof opts, 'object', 'drop/save: arg2 opts must be type string') 20 | assert.equal(typeof opts.fs, 'object', 'drop/save: arg2 opts.fs must be type object') 21 | assert.equal(typeof opts.output, 'string', 'drop/save: arg2 opts.output must be type string') 22 | assert.equal(typeof opts.fs.mkdirSync, 'function', 'drop/save: arg2 opts.fs.mkdirSync must be type function') 23 | 24 | var fs = opts.fs 25 | var options = xtend(defaults, opts) 26 | var urlPage = normalizeUrl(url) 27 | 28 | libGet(urlPage, options, function (err, page) { 29 | if (err) throw err.message 30 | 31 | var pageContent = getPageContent(options.template, page) 32 | if (options.root) { 33 | if (!options.output) { 34 | throw new Error("options.root requires options.output") 35 | } 36 | var dirOutput = path.join(options.output) 37 | } else { 38 | var dirOutput = path.join(options.output, page.basename) 39 | } 40 | 41 | var outputContent = createHTML({ 42 | head: '', 43 | title: page.title, 44 | body: pageContent 45 | }) 46 | 47 | return new Promise((resolve, reject) => { 48 | mkdirp(dirOutput, (err) => { 49 | if (err) { console.error(err); return reject(err) } 50 | resolve() 51 | }) 52 | }).then(() => { 53 | try { 54 | fs.writeFileSync(path.join(dirOutput, 'index.html'), outputContent) 55 | fs.writeFileSync(path.join(dirOutput, 'index.json'), JSON.stringify(page, { }, 2)) 56 | } catch (err) { 57 | console.error(err) 58 | throw new Error('page has already been saved') 59 | } 60 | }) 61 | }) 62 | } 63 | 64 | function getPageContent (template, page) { 65 | assert.equal(typeof page, 'object', 'arg2 page must be type object') 66 | if (!template) return content 67 | else return template 68 | .replace('{{CONTENT}}', page.content) 69 | .replace('{{TITLE}}', page.title) 70 | } 71 | 72 | function getPageImages (pageDocument) { 73 | try { 74 | var images = pageDocument.querySelectorAll('img') 75 | return objectValues(images).map(function (image) { 76 | return image.getAttribute('src') 77 | }) 78 | } catch (err) { 79 | return [ ] 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /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 2017 Jon-Kyle Mohr 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 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "dropout", 3 | "version": "1.0.2", 4 | "description": "", 5 | "main": "index.js", 6 | "preferGlobal": "true", 7 | "bin": { 8 | "dropout": "bin.js" 9 | }, 10 | "directories": { 11 | "lib": "lib" 12 | }, 13 | "scripts": { 14 | "test": "echo \"Error: no test specified\" && exit 1" 15 | }, 16 | "repository": { 17 | "type": "git", 18 | "url": "git+https://github.com/jondashkyle/dropout.git" 19 | }, 20 | "keywords": [], 21 | "author": "", 22 | "license": "ISC", 23 | "bugs": { 24 | "url": "https://github.com/jondashkyle/dropout/issues" 25 | }, 26 | "homepage": "https://github.com/jondashkyle/dropout#readme", 27 | "dependencies": { 28 | "create-html": "^4.0.0", 29 | "github-markdown-css": "^2.9.0", 30 | "node-readability": "^3.0.0", 31 | "normalize-url": "^1.9.1", 32 | "object-values": "^1.0.0", 33 | "time-stamp": "^2.0.0", 34 | "xtend": "^4.0.1", 35 | "yargs": "^10.0.3" 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 |

dropout

2 | 3 |

4 | 5 | When interfaces are designed for capturing and exhausting your attention going offline is both an act of liberation and luxury. This is a tool of ethical technology enabling you to save pages for offline access and personal archival. 6 | 7 | ``` 8 | npm install dropout -g 9 | 10 | dropout save http://quillette.com/2017/10/22/liberals-turning-internet/ 11 | ``` 12 | 13 | ## features 14 | 15 | - Cleanup a page to showcase only the content 16 | - Static files, no database, so super extendable 17 | - Platforms 🖕, this is a tool 🎉 18 | 19 | ## usage 20 | 21 | You can use either the [command line interface](#cli) or the [module](#module) with js. There are plans for other things, too. 22 | 23 | ## cli 24 | 25 | ``` 26 | dropout [args] 27 | 28 | Commands: 29 | dropout save [url] save a url 30 | 31 | Options: 32 | --version Show version number 33 | --help Show help 34 | ``` 35 | 36 | ## module 37 | 38 | ``` 39 | var dropout = require('dropout') 40 | ``` 41 | 42 | ### `dropout.save(url, {options})` 43 | 44 | Save a page! Creates an `index.html` for easy viewing, and a `data.json` with some handy meta-data and the parsed content which is used to generate the html. 45 | 46 | ## options 47 | 48 | ### `options.fs` 49 | 50 | Pass a custom filesystem for saving. Expects `mkdirSync`, `writeFileSync`. 51 | 52 | ### `options.output` 53 | 54 | The output (parent) directory the page directory will be saved to. 55 | 56 | ### `options.root` 57 | 58 | Specifies that the `options.output` directory will be the root directory, rather than parent. Requires `options.output`. 59 | 60 | ### `options.prepend` 61 | 62 | Prepend the directory name with a custom [timestamp](https://www.npmjs.com/package/time-stamp). Defaults to `YYMMDD`. 63 | 64 | ### `options.style` 65 | 66 | The CSS for the document. Currently defaults to [Github Markdown CSS](https://github.com/sindresorhus/github-markdown-css). 67 | 68 | ### `options.template` 69 | 70 | A custom template with `{{TITLE}}` and `{{CONTENT}}` tags. The default is currently gnarly. 71 | 72 | ``` 73 |

{{TITLE}}

{{CONTENT}}
74 | ``` 75 | 76 | ## related 77 | 78 | - [`new-work`](https://github.com/s3ththompson/new-work), a CLI tool that automatically checks artists' websites for new work by Seth Thompson. 79 | - [Hardly Everything](http://hardlyeverything.com), an attempt to subvert the traditional feed by substituting activity with user-defined durations of passing time called rests. 80 | 81 | ## todo 82 | 83 | - [ ] Testing 84 | - [ ] Save media files (img, youtubedl, etc) 85 | - [ ] Custom CSS 86 | - [ ] Custom HTML template 87 | - [ ] Toggle page cleanup 88 | - [ ] Reading interface 89 | - [ ] Dat sync 90 | - [ ] Beaker Browser app (hosted micro-service to save when online) 91 | - [ ] `remove` lib method 92 | - [ ] Add to [Arena](https://are.na) support 93 | 94 | ## change log 95 | 96 | ### 10/26/17 97 | 98 | First release. Only the save functionality is there. Minimal documentation. 99 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jondashkyle/dropout/e285734606c9bf2cbfd7b1b154a2a3c0dc8e40b8/test.js -------------------------------------------------------------------------------- /utils/fs.js: -------------------------------------------------------------------------------- 1 | var fs = require('fs') 2 | 3 | module.exports = fs 4 | // module.exports = { 5 | // mkdirSync: function () { 6 | 7 | // }, 8 | // writeFileSync: function () { 9 | 10 | // } 11 | // } -------------------------------------------------------------------------------- /utils/text.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | sanitize: sanitize 3 | } 4 | 5 | function sanitize (str) { 6 | return str 7 | .replace(/[^\w\s]|_/g, '') 8 | .replace(/\s+/g, ' ') 9 | .replace(/\s+/g, '-') 10 | .toLowerCase() 11 | } 12 | --------------------------------------------------------------------------------