thorncp / rubot Goto Github PK

A Ruby Bot Framework for IRC. More importantly, a project used to learn Ruby.

Home Page: http://github.com/thorncp/rubot

Ruby 100.00%

rubot's Introduction

Rubot is a framework for creating IRC bots.

Installation

gem install rubot
rubot new botname
cd botname
bundle install 
vim config.yml
bundle exec rubot server
nohup bundle exec rubot server &

Usage

Rubot::Controller adds functionality to the class, namely the message method. message is an instance of the message that matched a listener or triggered a command.

You can get the message sender's nick from message.from

adding a command

class WebLinkController < Rubot::Controller
  command :calc do
    reply Google.calc(:q => message.text)
  end
  
  command :google, :g do
    reply Google.lmgtfy_url_for(message.text)
  end
end

using listeners

class SubstitutionsController < Rubot::Controller
  listener :matches => /hello/ do
    reply "hello, #{message.from}"
  end
end

adding resources

A resource is just a class or module that is a source of data. Resources are looked for in APP_ROOT/resources

module Google
  def self.lmgtfy_url_for(query)
    "http://www.lmgtfy.com/?q=#{CGI.escape(query)}"
  end
end

using `Rubot::WebResource`

Rubot ships with a Rubot::WebResource class that can be subclassed to add simple web scraping functionality.

class Google < Rubot::WebResource
  get :calc, "http://www.google.com/search" do |doc|
    doc.css(".r")[0].text
  end
end

generate a migration

rake db:migration migration_name

migrate the database

rake db:migrate

NOTE: both the migrations and the sqlite database itself are stored within APP_ROOT/db

use database in a resource

class Fact < Sequel::Model
  def self.random
    # this is a pretty shitty way of getting a random record
    DB["select * from facts order by random() limit 1"].first
  end
end

now Fact.random can be used from a controller

why should I use rubot to build my IRC bot?

provides a very simple DSL for quickly adding commands
can update the application via git and reload

Future

incorporate some resources, commands, listeners as core configurable extensions/plugins?

Authors

Chris Thorn (@thorncp)

Matt Culpepper (@mculp)

rubot's People

Contributors

Stargazers

Watchers

Forkers

erreon rsdehart bhelx jtroe

rubot's Issues

remove hard dependency on nokogiri for WebResource

something like

get :block, "http://www.bitcoins.lc/stats.json", :with => :json

would be nice

Investigate controller and channel variables

https://gist.github.com/1003398

Web Service Manager

Create manager for using web resources. This could possibly be a part of the Resource Manager, or at least in the same module.

Find some way for commands to take advantage of aliases, either by passing a block when defining them, or just a message.alias that holds the name that was used to invoke the command, or... some other solution.

Logging

Implement an unobtrusive logger

Message Replies

See about having commands set a reply variable on messages instead of calling server.msg themselves. It'd be nice to get server out of the commands all together, but it is used for things other than .msg, like access to the connection time, sending actions, and possibly other things.

Syntax errors are not reported on reload

The block wrapper in dispatcher should rescue SyntaxError or ScriptError in addition to StandardError.

Use threads to run commands and listeners

We don't want long winded actions to hold up everything else

Default values for controller, channel, and nick variables

channel_variable :thing
channel_variable :thing, 42

channel_variable :thing1, :thing2
channel_variable thing1: 42, thing2: []

Message Splitting Seems Broken

Sending long messages doesn't seem to be splitting them. Instead, it just sends the max characters and the remaining text is lost.

Update readme to match current codebase

The current readme is behind on reality.

Windows Executable

Get rubot executable working on Windows

Smarter Message Breaking

See about breaking long winded messages on a punctuation mark, so they are split in a grammatically meaningful manner to improve readability.

Refactor database loading

Hardcoding the database name is not very friendly, and the code that does it is in a terrible location.

NEW RELEASE

Last gem pushed out was version 0.2, and there have been 128 commits since then. Need to push out a new release now.

Determine the public api

Message Queue

Need a message queue with a delay so we don't get excess flood kicked for long winded messages

Message#pm?

Add this.

runners and exiters should have the option to run on reload

Runners and exiters that set up commands and listeners are kind pointless if everything gets wiped out on a reload. Let's give them an option to be run during reload.

Documentation

Yes please!

Add message.authenticated

Add authentication to Message so commands/listeners can have protected and non-protected pieces

No Rakefile included with the `new` command

The readme makes references to rake db:migration and rake db:migrate tasks, but a Rakefile is not included in the new bot template.

https://github.com/thorncp/rubot/tree/d6ef9a03e1c1c1dd81917f003c4dfb3864fde324#generate-a-migration

Bug with message parsing

Using the following command

command :raw, :protected => true do
  puts message.text
  server.raw message.text
end

and executing the command

!raw PRIVMSG #channel :derp

message.text is empty. The incoming string is

:thorncp!~thorncp@server PRIVMSG #channel :!raw PRIVMSG #channel :derp