Ircmad
Bringing IRC into WebSocket.
IRC <-> WebSoket Server(This product) <-> WebSocket Client
If you use this gateway, you can assess IRC from browser easily.
Data format is JSON.
WebSocket Server - '{"from":"ToQoz","to":"#channel1","body":"hello world"}' -> WebSocket Client
WebSocket Server <- '{"to":"#channel1","body":"yes!!!"}' -> WebSocket Client
Installation
Add this line to your application's Gemfile:
gem 'ircmad'
And then execute:
$ bundle
Or install it yourself as:
$ gem install ircmad
Usage
# proxy.rb
require 'ircmad'
Ircmad.new do
set :host, '127.0.0.1'
set :port, 6667
set :channel_list, [ '#channel', '#channel2' ]
set :username, 'username'
set :password, 'password' # if required
set :websocket_port, 3333 # [default is unused port selected automatically]
end.run!
$
$ ruby proxy.rb
In browser
var socket = new WebSocket('ws://localhost:3333')
// Send
socket.send(JSON.stringify({ channel: '#channel1', body: 'yeah' }))
ws.send(JSON.stringify({ type: 'join', channel: '#ruby'}))
// Get
socket.onmessage = function(msg) { console.log(msg.data) };
// => '{"from":"ToQoz","to":"#channel1","body":"hello world","type":"privmsg"}'
// => {"from":"zlfu","to":"#ruby","body":null,"type":"join"}
// => {"from":"hybrid7.debian.local","to":"zlfu","body":"@","type":"353"}
// => {"from":"hybrid7.debian.local","to":"zlfu","body":"#ruby","type":"366"}
Examples
In examples/
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request