Project

ruben

0.0
No commit activity in last 3 years
No release in over 3 years
Ruben is an IRC chat bot written in Ruby. He is inspired, in part, by Hubot, his CoffeeScript brother from another mother.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Ruben

Build Status

Description

Ruben is an IRC chat bot written in Ruby. He is inspired, in part, by Hubot, his CoffeeScript brother from another mother.

Dependencies

  • Ruby 1.9.3+
  • Rake 10.0.4 (for running tests, if that's your jam)
  • RSpec 2.13.0 (see above)

Installation

Version 1.1.0 is available from RubyGems; you can get your version of Ruben by typing

$ gem install ruben

Getting Started

Ruben comes with a bin/ruben executable, so you can run him with

$ ruben <server> <port> <channel> <nick>

Ruben takes a server name, port number, channel name, and nick as command line arguments. For example, if you type:

$ ruben irc.freenode.net 6667 test_chan ruben_

You should see:

$ >> USER ruben 0 * :Ruben
$ >> NICK ruben_
$ >> JOIN #test_chan

...

You can get Ruben's usage information by typing ruben -h or ruben --help.

Adding Scripts

You can extend Ruben's functionality by adding scripts to /scripts. Each script should be a .rb file that instantiates a new Listener object, like so:

thing_to_do lambda do
  # Arcane magicks go here
end

Listener.new(/Regexp/, thing_to_do)

Ruben's listeners hear every incoming IRC message. If a listener's Regexp matches the inbound message, Ruben will call the associated lambda.