Rakefile SHAFT @@ -1,5 +1,4 @@ = Isaac - the smallish DSL for writing IRC bots -You want to create an IRC bot quickly? Then Isaac is you. It will be. At some point, at least. But you shall be welcome to try it out and help me extend and beautify it. Be aware, the code is not stellar by any measure, most likely it is very crude and a large portion of the IRC standard has not been implemented, simply because I haven't needed it yet. Oh, and a lot of concepts were borrowed from Sinatra (http://sinatrarb.com). Thanks. == Features * Wraps parsing of incoming messages and raw IRC commands in simple constructs. @@ -9,7 +8,7 @@ You want to create an IRC bot quickly? Then Isaac is you. It will be. At some po == Getting started An Isaac-bot needs a few basics: require 'isaac' - config do |c| + configure do |c| c.nick = "AwesomeBot" c.server = "irc.freenode.net" c.port = 6667 @@ -25,21 +24,23 @@ After the bot has connected to the IRC server you might want to join some channe === Responding to messages Joining a channel and sitting idle is not much fun. Let's repeat everything being said in these channels: - on :channel, /.*/ do + on :channel, // do msg channel, message end -Notice the +channel+ and +message+ variables. Additionally +nick+ and +match+ is available for channel-events. +nick+ being the sender of the message, +match+ being a MatchData object returned by the regular expression you specified: +Notice the +channel+ and +message+ variables. Additionally +nick+ and +match+ is +available for channel-events. +nick+ being the sender of the message, +match+ +being an array of captures from the regular expression: on :channel, /^quote this: (.*)/ do - msg channel, "Quote: '#{match[1]}' by #{nick}" + msg channel, "Quote: '#{match[0]}' by #{nick}" end If you want to match private messages use the +on :private+ event: on :private, /^login (\S+) (\S+)/ do - username = match[1] - password = match[2] + username = match[0] + password = match[0] # do something to authorize or whatevz. msg nick, "Login successful!" end @@ -84,11 +85,4 @@ You might want to send messages, join channels etc. without it strictly being th The source is hosted at GitHub: http://github.com/ichverstehe/isaac == License - ------------------------------------------------------------------------------ - "THE BEER-WARE LICENSE" (Revision 42): - <ichverstehe@gmail.com> wrote this file. As long as you retain this notice you - can do whatever you want with this stuff. If we meet some day, and you think - this stuff is worth it, you can buy me a beer in return. - ------------------------------------------------------------------------------ - - +The MIT. Google it. README.rdoc @@ -1,6 +1,6 @@ require 'lib/isaac.rb' -config do |c| +configure do |c| c.nick = "The_Echo_Bot" c.server = "irc.freenode.net" c.port = 6667 examples/excess_flood.rb @@ -4,7 +4,6 @@ config do |c| c.nick = "SomeBot" c.server = "irc.freenode.net" c.port = 6667 - c.username = 'ihayes' c.realname = 'Isaac Hayes' c.verbose = true c.version = 'SchemaBot v0.1.2' examples/schema.rb @@ -18,6 +18,8 @@ module Isaac instance_eval(&b) if block_given? end + def binding; binding; end + def start @irc = IRC.new(self, @config) @irc.connect @@ -41,15 +43,15 @@ module Isaac env[:nick], env[:userhost], env[:channel], env[:error] self.message = env[:message] || "" - regexp, block = @events[event] && @events[event].detect do |regexp, block| + event = @events[event] && @events[event].detect do |regexp,_| message.match(regexp) end - self.match = message.match(regexp) - match_arr = match.to_a - match_arr.shift - - catch(:halt) { block.call(*match_arr) } + if event + regexp, block = *event + self.match = message.match(regexp).captures + catch(:halt) { instance_eval(&block) } + end end def halt @@ -73,6 +75,8 @@ module Isaac def initialize(bot, config) @bot, @config = bot, config @transfered = 0 + @registration = [] + @lock = false @queue = [] end @@ -81,6 +85,7 @@ module Isaac message "PASSWORD #{@config.password}" if @config.password message "NICK #{@config.nick}" message "USER #{@config.nick} 0 * :#{@config.realname}" + @lock = true # This should probably be somewhere else.. if @config.environment == :test @@ -99,8 +104,15 @@ module Isaac def parse(input) puts "<< #{input}" if @bot.config.verbose case input + when /^:\S+ 00([1-4])/ + @registration << $1.to_i + if registered? + @lock = false + @bot.dispatch(:connect) + continue_queue + end when /^PING (\S+)/ - @transfered = 0 + @transfered, @lock = 0, false message "PONG #{$1}" continue_queue when /^:(\S+)!(\S+) PRIVMSG (\S+) :?(.*)/ @@ -111,11 +123,15 @@ module Isaac env = {:error => $1.to_i, :message => $1, :nick => $2, :channel => $2} @bot.dispatch(:error, env) when /^:\S+ PONG/ - @transfered = 0 + @transfered, @lock = 0, false continue_queue end end + def registered? + ([1,2,3,4] - @registration).empty? + end + def message(msg) @queue << msg continue_queue @@ -123,13 +139,14 @@ module Isaac def continue_queue # <= 1472 allows for \n - while msg = @queue.shift + while !@lock && msg = @queue.shift if (@transfered + msg.size) < 1472 @socket.puts msg puts ">> #{msg}" if @bot.config.verbose @transfered += msg.size + 1 else @queue.unshift(msg) + @lock = true @socket.puts "PING :#{@bot.config.server}" break end lib/isaac.rb @@ -31,6 +31,7 @@ class Test::Unit::TestCase def bot_is_connected assert_equal "NICK isaac\n", @server.gets assert_equal "USER isaac 0 * :Isaac\n", @server.gets + 1.upto(4) {|i| @server.puts ":localhost 00#{i}"} end def assert_empty_buffer(io) test/helper.rb @@ -38,28 +38,27 @@ class TestEvents < Test::Unit::TestCase } bot_is_connected - bot.dispatch(:connect) assert_equal "PRIVMSG foo :bar baz\n", @server.gets end test "regular expression match is accessible" do bot = mock_bot { - on(:channel, /foo (bar)/) {assert_equal "bar", match[1]} + on(:channel, /foo (bar)/) {assert_equal "bar", match[0]} } bot_is_connected bot.dispatch(:channel, :message => "foo bar") end - test "regular expression matches is handed to block arguments" do - bot = mock_bot { - on :channel, /(foo) (bar)/ do |foo,bar| - assert_equal "foo", foo - assert_equal "bar", bar - end - } - bot_is_connected + #test "regular expression matches is handed to block arguments" do + #bot = mock_bot { + #on :channel, /(foo) (bar)/ do |foo,bar| + #assert_equal "foo", foo + #assert_equal "bar", bar + #end + #} + #bot_is_connected - bot.dispatch(:channel, :message => "foo bar") - end + #bot.dispatch(:channel, :message => "foo bar") + #end end test/test_events.rb @@ -13,4 +13,25 @@ class TestIrc < Test::Unit::TestCase } assert_equal "PASSWORD foo\n", @server.gets end + + test "no messages are sent when registration isn't complete" do + bot = mock_bot { + on(:connect) {raw "Connected!"} + } + 2.times { @server.gets } # NICK / USER + bot.dispatch :connect + + assert_empty_buffer @server + end + + test "no messages are sent until registration is complete" do + bot = mock_bot { + on(:connect) {raw "Connected!"} + } + 2.times { @server.gets } # NICK / USER + bot.dispatch :connect + + 1.upto(4) {|i| @server.puts ":localhost 00#{i}"} + assert_equal "Connected!\n", @server.gets + end end test/test_irc.rb examples/execute.rb 39c3201109e7961aacf32f0ea7617dc848858b5d Harry Vangberg harry@vangberg.name http://github.com/ichverstehe/isaac/commit/590082e0755f70f10fc30415d167cdd1d55d33b0 590082e0755f70f10fc30415d167cdd1d55d33b0 2009-02-23T12:51:49-08:00 2009-02-23T12:51:49-08:00 more stuff 8e3cfa2c2707fe0c0dafa833dea145b7d1fa0388 Harry Vangberg harry@vangberg.name