JustBot, an IRC bot

"JustBot" IRC Bot

by Jake Teton-Landis just.1.jake@gmail.com copyright 2012, all rights reserved

About

You can discover the plugins availible in Justbot by looking at {Justbot::Plugins}

Here are a few of the better features:

  • tweet right from irc by typing !tweet <update text>
  • follow all your Rescomp freinds at once by typing JustBot: twitter followall
  • bask in the warm glow of the social as JustBot prints tweets to ## in 3-color glory!

This bot is build on the Cinch framework, a ruby library for building IRC bots which features a nicely threaded design. It allows you to build bot capabilities through plugins, so you can easily separate bot functionality.

There are a few components that are not Cinch-dependent, such as the DataMapper users support, but they are ment to be used from Cinch plugins.

Requirements

Core Requirements

In order of importance:

  1. Ruby 1.9.1 or better.
  2. Cinch framework (gem install cinch) is the core library for the bot.
  3. Two (!) gems are used for interfacing with the Twitter APIs:
    1. twitter is used for most Twitter API interaction
    2. twitter_oauth is used during user creation to get oauth tokens and twitter_id
  4. Users support depends on DataMapper for ORM, although only only 'dm-core', 'dm-migrations' and 'dm-transactions' are required at present. It'll try to connect to a sqlite database in config by default. Edit lib/database.rb to customize.
  5. Tweets are run through HTMLentities before being displayed, so you'll need to have that gem installed, too

More Requirements

  • {Justbot::Session}, {Justbot::User}: these modules have inline Rspec tests. Install 'rspec' or remove the tests.
  • {Justbot::Plugins::SteamPowered}: requires 'steam-condenser', an apllingly poor gem for interacting with Valve Software's products.
  • This documentation is generated using YARD but really if you like Ruby (or even use it at all) you should have yard server --gems running somewhere.

Bot Usage from IRC

/msg <botname> help will give you an overview of the active plugins in a bot instance:

 > help
            Help for JustBot
            plugins:
            Administration, Friendly, Help, Registration, Sessions, Tweet, TwitterFeed, Steam
            help in Help
              help [PLUGIN] [COMMAND]
              show help information for the bot, for PLUGIN in bot, or for a COMMAND in PLUGIN
            

You can then query to get help about specific plugins. Plugin help uses prefix-based matching, so 'help admin' will show the help for the Adimistration plugin.

The confusing thing is, commands are not called prefixed by module name. For example, if you wanted to get help about command twitter follow in module TwitterFeed you might type the following:

> JustBot: help twit twitter follow
            or
            > /msg JustBot help twit twitter follow
            

but to actually request the command, you would type

> JustBot: twitter follow @justbotirc
            or
            > /msg JustBot twitter follow @justbotirc
            

Developments

Issue Tracker

Source Code Access

The bot is closed source for now, because there are secrets in the source codes. If you pester me enough I'll create a new repo where there's no history, and also no secrets in the past. But for now this is a side-side-project and has like zero real brain power in it.

To Run

$ cd /path/to/bot/
            $ ruby -v # should be >= 1.9.1
            $ ruby bin/justbot