Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 1.51 KB

README.rdoc

File metadata and controls

55 lines (43 loc) · 1.51 KB

Jabber::Bot

Easily create simple regex powered Jabber bots.

Jabber::Bot makes it simple to create and command your own Jabber bot. Bots are created by defining commands powered by regular expressions and Ruby.

Author

Brett Stimmerman ([email protected])

Version

1.3.0 (2011-05-15)

Copyright

Copyright © 2011 Brett Stimmerman. All rights reserved.

License

New BSD License (opensource.org/licenses/bsd-license.php)

Website

github.com/brettstimmerman/jabber-bot

Requires

  • RubyGems

  • Jabber::Simple 0.8.7+

Usage

require 'rubygems'
require 'jabber/bot'

# Create a public Jabber::Bot
config = {
  :name      => 'SampleBot',
  :jabber_id => '[email protected]',
  :password  => 'secret',
  :master    => '[email protected]',
  :is_public => true
}

bot = Jabber::Bot.new(config)

# Give your bot a private command, 'rand'
bot.add_command(
  :syntax      => 'rand',
  :description => 'Produce a random number from 0 to 10',
  :regex       => /^rand$/
) { rand(10).to_s }

# Give your bot a public command, 'puts <string>' with an alias 'p <string>'
bot.add_command(
  :syntax      => 'puts <string>',
  :description => 'Write something to $stdout',
  :regex       => /^puts\s+(.+)$/,
  :alias       => [ :alias => 'p <string>', :regex => /^p\s+(.+)$/ ],
  :is_public   => true
) do |sender, message|
  puts "#{sender} says '#{message}'"
  "'#{message}' written to $stdout"
end

# Bring your new bot to life
bot.connect