New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

gu

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gu

Streaming bot makers library with hot code reloading and regex handlers

  • 0.1.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
14
decreased by-50%
Maintainers
1
Weekly downloads
 
Created
Source

Gu Build Status

TODO: david Gu is a streaming bot makers library that you can pipe your transports to and from.

It has three main features:

  • regular expression handlers in a style similar to hubot (but without all those annoying environment variables and coffee-script..)
  • hot code reloading of specified files (without the bot having to leave the server)
  • streaming input and output allows for easy control, extensibility and transport-less testing

Usage

Find a library that does the transport you want, say irc-streams:

Create a main file; bot.js:

var gu = require('gu')(scriptPath, files);
var ircStream = require('ircStream')(name, server, {chan: chan});

ircStream.pipe(gu).pipe(ircStream);

The script path and the files (relative to the scriptpath) will be watched for changes, and is assumed to contain handlers exported behind a function.

Then, put a file in your scriptpath, like.js, say, and add handlers therein:

module.exports = function (gu) {
  gu.handle(/^i like your (\w*)$/, function (what) {
    gu.say('i has ' + what + ' :O');
  });
};

Then fire up the bot with node bot.js, navigate to the specified server and channel (in ircOpts), and try saying botName: i like your charisma in the channel.

Changing the handler in like.js will result in different behaviour without having to restart bot.js.

A more extensive example is avaiable in the example directory.

Complete examples

The following personal bots are all built on gu:

Stream Specification

A gu instance expects to have objects written to it, and will new objects readable on the other end.

Therefore, the sensible interface (unless you are doing some weird asymmetrical connection setup), is a Duplex stream in objectMode.

Inputs & Outputs

Expected input objects:

{
  user: String, // unique identifier of user
  message: String, // raw message to be matched by gu
}

Output objects are identical. The user property is passed stright through and is can be anything as long as it can be used to again identify the user to send the response to on the other end. For irc-stream it is either the string: "#chan:user" for a channel message or "user" for a personal message.

An optional name property may be set on the input for the convenience of gu handlers - this name will be passed through to the handlers (after the say cb) and is assumed to be human readable.

Future

Alternative transport modules.

Caveats

The script path you specify to gu should only contain the handler functions. If you point the path at your lib dir, then it may reload all the files in that directory when you change one of your handlers.

If you have multiple handler files in your scriptdir, then if one changes, all these files will be reloaded, and any internal state in them will be cleared. To get around this, persist important state elsewhere.

Installation

$ npm install gu --save

Running tests

Install development dependencies

$ npm install

Run the tests

$ npm test

License

MIT-Licensed. See LICENSE file for details.

Keywords

FAQs

Package last updated on 20 Sep 2013

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc