# glados > Monitor remote resource for changes Latest version **1.0.1** (published 2017-10-31) · MIT license · 0 weekly downloads ## Install ```sh npm install glados pnpm add glados yarn add glados bun add glados ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2017-10-31 | | First published | 2015-07-04 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 5 | | Known vulnerabilities | 0 (+17 in 3 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | fluffybunnies | | Maintainers | fluffybunnies | | Keywords | monitor, change, diff, remote, url, notify, email | ## Links - npm: https://www.npmjs.com/package/glados - Repository: https://github.com/fluffybunnies/glados - Issues: https://github.com/fluffybunnies/glados/issues - npm.io page: https://npm.io/package/glados ## Dependencies (5) - [diff](https://npm.io/package/diff.md) 1.4.0 - [sext](https://npm.io/package/sext.md) 0.1.6 - [minimist](https://npm.io/package/minimist.md) 1.1.1 - [nodemailer](https://npm.io/package/nodemailer.md) 1.4.0 - [nodemailer-ses-transport](https://npm.io/package/nodemailer-ses-transport.md) 1.3.0 ## Alternatives - [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads - [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads - [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads - [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads - [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads ## Recent versions - 1.0.1 (latest) — 2017-10-31 - 1.0.0 — 2015-07-09 - 0.0.12 — 2015-07-05 - 0.0.11 — 2015-07-05 - 0.0.10 — 2015-07-05 - 0.0.9 — 2015-07-05 - 0.0.8 — 2015-07-05 - 0.0.7 — 2015-07-05 - 0.0.6 — 2015-07-05 - 0.0.5 — 2015-07-05 - 0.0.4 — 2015-07-05 - 0.0.3 — 2015-07-05 - 0.0.2 — 2015-07-05 - 0.0.1 — 2015-07-05 - 0.0.0 — 2015-07-04 ## README [![Build Status](https://secure.travis-ci.org/fluffybunnies/glados.png)](http://travis-ci.org/fluffybunnies/glados) # glados Monitor remote resource for changes - Use the cli wrapper to send an email notification or POST to a url when the resource has changed - Diffs are calculated using kpdecker's [diff](https://www.npmjs.com/package/diff) - Will not start polling until client binds to `'change'` - Use the CLI Wrapper to take action on `'change'` - POST to an endpoint, or - send email notification (supports Gmail and SES) ## App ```javascript var glados = require('glados') var watcher = glados('http://example.com/sensitive_data.html', 1000*60) .on('change',function(diff){ // do something with diff }) .on('error',function(err){ // we have some problem connecting with resource }) ``` ## CLI Wrapper See api notes below for opts ```bash node ./bin/cli.js http://example.com/sensitive_data.html -n60000 \ -p http://myapi.example.com/notify_change \ -m volcomstoner2689@gmail.com ``` ## Forever Wrapper Make sure this thing never goes down. Wraps cli.js with sturdiness.
Kill the process, stop the forever, reboot the instance. Baby will still be kickin.
Most recently polled data is saved to tmp file in case process dies and reboots. ``` ./bin/forever.sh http://example.com/sensitive_data.html -n60000 \ -p http://myapi.example.com/notify_change \ -m ohsosexybrit@gmail.com ``` ##### Kill Forever Shut down what you started with `forever.sh` ``` ./bin/kill_forever.sh http://example.com/sensitive_data.html # or kill processes that contain -s (softmatch): ./bin/kill_forever.sh -s sensitive_data.html ``` ## App Api ##### glados( url [, pollInterval] ) returns a `watcher` that will monitor changes of `url`
`url` _string_ - remote resource to watch
`pollInterval` _int_ - interval in ms to check resource for changes. defaults to 1 minute ##### watcher.stop() Stop watching. No further events will be fired after this is called. ##### watcher.on('change', function(diff, data){}) Fired when a change has been detected in remote resource
`diff` _Array_ - an array of data comprising added, removed, and unchanged chunks
`data` _Buffer_ - the new data, unadulterated ##### watcher.on('connection', function(data){}) Fired on response from initial poll
`data` _Buffer_ - the response data ##### watcher.on('poll', function(){}) Fired immediately prior to each poll. The first `'poll'` event occurs before `'connection'` ##### watcher.on('error', function(err){}) Catch errors in the stream ## CLI Api ##### Arguments Applies to both `cli.js` and `forever.sh` - `[target]` - url of resource to watch - `-n` or `--interval` - pollInterval - optional, defaults to 1 minute - `-p` or `--post` - endpoint to post `diff` on change event - optional - supports multiple - `-m` or `--email` - email address to send `diff` on change event - optional - supports multiple ## Email Copy `config.json` to `config.local.json` and add credentials ##### Gmail Set `mailTransport` to 'gmail'
Use an application password (not your personal account password) ##### SES Set `mailTransport` to 'ses'
Set your AWS secret and key, along with an approved From address ## To Do - Using the softmatch option (`kill_forever.sh -s "substring"`) currently kills only the first match found, but deletes all matching saved data - Update script to kill all matches as advertised in readme - Add screenshot of pretty email to readme --- _Source: https://npm.io/package/glados · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._