https://github.com/creatorrr/hubot.io

A socket.io server for hubot.
https://github.com/creatorrr/hubot.io

Last synced: about 2 months ago
JSON representation

A socket.io server for hubot.

• Host: GitHub
• URL: https://github.com/creatorrr/hubot.io
• Owner: creatorrr
• Created: 2013-03-27T18:06:18.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-03-30T00:04:30.000Z (over 11 years ago)
• Last Synced: 2024-05-02T01:04:47.521Z (5 months ago)
• Language: CoffeeScript
• Size: 128 KB
• Stars: 13
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - creatorrr/hubot.io - A socket.io server for hubot. (CoffeeScript)

README

        
# Hubot.io

This is an external [hubot-script](https://github.com/github/hubot/blob/master/README.md#external-scripts) that attaches a [socket.io](http://socket.io/) instance to [Hubot](http://hubot.github.com/)'s HTTP Listener. Because, why not?

## Installing

1. Add `hubot.io` as a dependency to your hubot:

    `"hubot.io": ">= 0.1.0"`

2. Tell hubot to load it. Add `"hubot.io"` to the `external-scripts.json` list in the hubot root folder.

3. `npm install` while you grab a beer.

4. _(Optional but recommended)_ Set environment variable `NODE_ENV` to `production`.

## Usage & Examples

Initialize your [socket.io](http://socket.io/) code by attaching callback to the `sockets:connection` event on hubot and proceed to use [socket.io](http://socket.io/) as usual.

```coffeescript

module.exports = (robot) ->

  robot.on 'sockets:connection', (socket) ->

    socket.emit 'news', hello: 'world'

    socket.on 'other event', (data) -> console.log data

  # Don't forget to include client-side code

  robot.router.get '/', (req, res) ->

    res.writeHead 200, 'Content-Type': 'text/html'

    res.end '''

      

      

        var socket = io.connect('http://localhost');

        socket.on('news', function (data) {

          console.log(data);

          socket.emit('my other event', { my: 'data' });

        });

      

      

        

      

    '''

```

## Contributing

Patches, bugs, ideas, love? Feel free to open issues or ping me at [email protected]

## License

Copyright (c) 2013, Diwank Singh 

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.