Quickly and easily integrate with the event distribution platform: ubsub.io
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
lib
.eslintrc
.gitignore
.nvmrc
.travis.yml
README.md
cli.js
index.js
package.json

README.md

ubsub-client

Build Status npm npm

The ubsub-client is a nodejs module to easily connect to send and receive events from UbSub using sockets and https.

It also provides convenient wrappers to forward HTTP connections behind a NAT, to easily give you an endpoint to forward events from the public internet to a local network.

Using

Installing CLI

To use the ubsub CLI on your command line, make sure you have a recent version of NodeJS installed, and then run:

npm install -g ubsub
ubsub login

Once installed, you can run ubsub help from command line to see help output.

Outputting events to the terminal

ubsub listen <topic id>

Forwarding to an internal URL

One of the great uses is the ability to forward an external event URL to something behind your firewall and/or NAT.

ubsub forward <topic id> http://localhost:4000/path/to/it --method POST

This will invoke the endpoint every time the public UbSub URL is hit.

Creating external URL to forward

This is similar to forward, but will create a new topic automatically to be hit.

ubsub webhook http://localhost:4000 [--method POST] [--name mywebhook] [--keyless]

The URL for this topic will be output after starting, and deleted automatically upon exist (unless --keep is specified).

Piping stdin to a topic

You can also pipe stdin (or a file) to a topic.

# Piping and following syslog to a topic
tail -f /var/log/syslog | ubsub pipe <topicId>

Managing Templates

You're able to completely manage templates via the CLI client.

Get existing template:

ubsub templates get --id <id>

Upload a template (will create new if --id is unspecified):

# Update
ubsub templates push --id <id> filename.js

# Create new
ubsub templates push --lang JSVM --name test filename.js

Installing for App Use

Installing into your project:

npm install --save ubsub

See examples/ for some sample uses.

Listening to a Topic

const ubsub = require('ubsub')(<user id>, <user secret>, [opts]);

ubsub.listen(<topic id>, (event, rawSocketEvent ) => {
	console.log('received event ' + JSON.stringify(event));
});

Forwarding a Topic to an HTTP endpoint

const ubsub = require('ubsub')(<user id>, <user secret>, [opts]);

ubsub.forward(<topic id>, 'http://localhost:5000', {..optional axios opts..});

Sending an Event

const ubsub = require('ubsub')(<user id>, <user secret>, [opts]);

ubsub.send('topicId', 'key'/null, { payload: 123 }, [method = 'POST']);

Options

reconnectOnError: Whether or not to reconnect on a fatal error. This is separate from the default SocketIO reconnect. (default: true)

reconnectOnErrorDelay: Number of milliseconds to delay the reconnect on error (default: 5000)

License

Copyright (c) 2017 Christopher LaPointe

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.