ril 0.1.1 → 0.1.2

data/examples/opbot.rb

@@ -0,0 +1,186 @@
+#! /usr/bin/env ruby
+#
+# opbot.rb - simple operator bot!
+#   simple bot that connects to <server> with <nick>, joins <channel>, and
+#   handles the one command !version
+
+require 'ril'
+include Ril
+
+# c:VersionBot
+class VersionBot < RilBot
+  # override the initialize function.. not really.. just want to pre-define
+  # a few of our own variables...
+  def initialize(server_args, &block)
+    super(server_args, &block)
+
+    @banning_user = nil
+    @unbanning_user = nil
+    @motd = ""
+  end # initialize
+
+  # handle a PRIVMSG message.
+  def on_privmsg(userinfo, target, message)
+    msg = message.split(' ')
+    command = msg.shift
+
+    data = msg.join(' ')
+
+    case command
+    when '!version'
+      privmsg(target, version)
+    when '!say'
+      privmsg(target, data)
+    when '!action'
+      data = "\001ACTION #{data}\001"
+      privmsg(target, data)
+    else
+      if $privy.index(userinfo[:nickname]) != nil
+        return privy_command(userinfo, target, command, data)
+      end
+    end
+
+    false
+  end # on_privmsg
+
+  # handle the invite command
+  def on_invite(userinfo, target, message)
+    if $privy.index(userinfo[:nickname]) != nil
+      join(message)
+    end
+
+    false
+  end # on_invite
+
+  # handles a privileged users command
+  def privy_command(userinfo, target, command, data)
+    if target[0..0] != '#'
+      return false
+    end
+
+    if data.length == 0
+      nickname = userinfo[:nickname]
+    else
+      nickname = data
+    end
+
+    case command
+    when '!quit'
+      quit(data)
+      return true # kill the bot processor
+    when '!op'
+      mode(target, '+ooo', nickname)
+    when '!deop'
+      mode(target, '-ooo', nickname)
+    when '!voice'
+      mode(target, '+vvv', nickname)
+    when '!devoice'
+      mode(target, '-vvv', nickname)
+    when '!topic'
+      topic(target, data)
+    when '!join'
+      join(data)
+    when '!part'
+      if data.length == 0
+        data = target
+      end
+
+      part(data)
+    when '!cycle'
+      if data.length == 0
+        data = target
+      end
+
+      part(data)
+      sleep 0.2
+      join(data)
+    when '!invite'
+      invite(target, data)
+    when '!print_motd'
+      puts @motd
+    when '!ban'
+      if data != userinfo[:nickname]
+        @banning_user = target
+        whois(data)
+      end
+    when '!unban'
+      if data != userinfo[:nickname]
+        @unbanning_user = target
+        whois(data)
+      end
+    end
+
+    false
+  end # privy_command
+
+  # whois ?
+  def whois(nick)
+    send_raw("WHOIS #{nick}")
+
+    false
+  end # whois
+
+  # RPL_MOTDSTART
+  def on_375(userinfo, target, message)
+    @motd = ""
+
+    false
+  end # on_375
+
+  # RPL_MOTD
+  def on_372(userinfo, target, message)
+    @motd += "#{message}\n"
+
+    false
+  end # on_372
+
+  # ERR_NOMOTD
+  def on_422(userinfo, target, message)
+    on_376(userinfo, target, message)
+
+    false
+  end # on_422
+
+  # RPL_WHOISUSER
+  def on_311(userinfo, target, message)
+    # target contains something like:
+    #   <<my nick>> <<their nick>> <<their user>> <<their host>> *
+    ####
+    me, nick, user, host, ast = target.split(' ')
+
+    unless @banning_user.nil?
+      mode(@banning_user, "+b", "#{nick}!#{user}@#{host}")
+      @banning_user = nil
+    end
+
+    unless @unbanning_user.nil?
+      mode(@unbanning_user, "-b", "#{nick}!#{user}@#{host}")
+    end
+
+    false
+  end # on_311
+
+  # RPL_ENDOFMOTD
+  def on_376(userinfo, target, message)
+    join($channel)
+
+    false
+  end # on_376
+end # /c:VersionBot
+
+if __FILE__ == $0
+  if ARGV.length < 3
+    puts "Usage: #{$0} <irc server> <nickname> <channel> [privileged,users]"
+    exit 1
+  end
+
+  $channel = ARGV[2]
+
+  if ARGV[3] != nil
+    $privy = ARGV[3].split(',')
+  end
+
+  vbot = VersionBot.new(:hostname => ARGV[0],
+    :nickname => ARGV[1], :verbose => true)
+  vbot.run
+end

data/lib/ril.rb

@@ -1,7 +1,7 @@
 ###
 #   ril.rb - ruby irc library
-#     $Release Version: 0.1.1 $
-#     $Revision: 4 $
+#     $Release Version: 0.1.2 $
+#     $Revision: 9 $
 #     by Joey Kinsella <jkinsella(at)rubyforge(dot)org>
 #
 #  This program is free software; you can redistribute it and/or modify
@@ -22,7 +22,7 @@
 require 'socket'
 
 module Ril
-  Ril_VERSION = "Ril - Ruby IRC Library v0.1.1 by Joey Kinsella"
+  Ril_VERSION = "Ril - Ruby IRC Library v0.1.2 by Joey Kinsella"
 
 ####
 # c:RilBot
@@ -49,6 +49,7 @@ class RilBot
   #
   #    == RilBot related settings ==
   #  :verbose  => true or false, if true prints the IRC messages out.
+  #  :throttle => throttle time for sending messages [defaults to 2 seconds.]
   #
   # * If a block is given it is executed when the IRC server sends either a 
   # * 422 (ERR_NOMOTD), or 376 (RPL_ENDOFMOTD). it will be called with one
@@ -65,6 +66,16 @@ class RilBot
     # keep the run loop running
     @run_loop = true
 
+    # output buffer
+    @output_buffer = []
+
+    # throttle time
+    @throttle = server_args[:throttle]
+    @throttle = 2 if @throttle.nil?
+
+    # last time a message was sent
+    @last_send = Time.now.to_i
+
     # server to connect to.
     @hostname = server_args[:hostname]
     raise ArgumentError, "No hostname defined." if @hostname.nil?
@@ -105,6 +116,7 @@ class RilBot
     begin
       # try to connect.
       @socket = TCPSocket.new(@hostname, @port)
+      @socket_mutex = Mutex.new
     rescue
       vputs "Failed to connect to irc://#{@hostname}:#{@port}"
       raise
@@ -140,19 +152,31 @@ class RilBot
   # runs the bot in a main loop, sitting on the socket waiting for stuff
   # to happen, then calling the appropriate bound function.
   def run
-    # the irc standard denotes that no message is over 512, but I'll
-    # double that here, if for some reason you use this library on a
-    # non RFC compliant server.
-    while @run_loop and (irc_msg = @socket.recv(1024)) != ""
-      parse(irc_msg)
+    @output_thread = Thread.new { process_output_buffer }
+
+    while @run_loop
+      poll = select([@socket], nil, nil, 0)
+
+      if poll
+        irc_msg = ""
+
+        @socket_mutex.synchronize do
+          irc_msg = @socket.gets
+        end
+
+        if parse(irc_msg)
+          @run_loop = false
+        end
+      end
     end
+
+    @output_thread.terminate
+    @socket.close
   end # run
 
   # call this when you want to kill the bot.
   def stop
     @run_loop = false
-
-    @socket.close
   end
 
   # returns whether or not you are identified to the server
@@ -185,7 +209,7 @@ class RilBot
       msg = msg[0..511]
     end
 
-    @socket.puts msg
+    @output_buffer << msg
   end
 
   # send +message+ to +target+, if +safety+ is true check to see if
@@ -218,7 +242,7 @@ class RilBot
 
   # parts +channel+, leaving them with +part_msg+
   def part(channel, part_msg = nil)
-    send_raw("PART #{channel} :#{msg}")
+    send_raw("PART #{channel} :#{part_msg}")
   end # part
 
   # adjusts mode to +mode+ on +target+, with +mode_opts+
@@ -257,9 +281,8 @@ class RilBot
   #
   # if +message+ is nil, then it just quits reporting version info.
   def quit(message = nil)
-    message = version() if quit.nil?
+    message = version if message.nil?
 
-    stop
     send_raw("QUIT :#{message}")
   end # quit
 
@@ -282,7 +305,6 @@ class RilBot
     end
   end
 
-protected
   def version
     Ril::Ril_VERSION
   end
@@ -293,9 +315,32 @@ private
     puts str if @verbose
   end
 
+  # just checks the output buffer, if there is data, send it when you
+  # it is safe to do so.
+  def process_output_buffer
+    while true
+      if not @output_buffer.empty?
+        @socket_mutex.synchronize do
+          while @output_buffer.empty? == false
+            if Time.now.to_i > (@last_send + @throttle)
+              data = @output_buffer.pop
+
+              @socket.puts data
+              @last_send = Time.now.to_i
+            end
+            sleep 0.2
+          end
+        end
+      end
+
+      sleep 0.5 # don't chew the processor...
+    end
+  end # process_output_buffer
+
   # parses the irc +msg+
   def parse(msg)
     vputs "<<< #{msg}"
+    result = false
 
     msg.each_line do |m|
       prefix, data = m.split(' :')
@@ -322,15 +367,18 @@ private
         end
 
         # run the appropriate method...
-        lookup_method(irc_message, prefix, data)
+        result = lookup_method(irc_message, prefix, data)
       end # prefix == ???
     end # msg.each
+
+    result
   end # parse
 
   # this does the actual parsing, and running of methods...
   def lookup_method(message, prefix, data)
     # prefix chunked out by a space...
     prefix_a = prefix.split(' ')
+    result = false
 
     if prefix_a.nil? and $DEBUG
       vputs ">>>DEBUGGING<<<"
@@ -357,8 +405,10 @@ private
 
     callback = "on_#{message}".downcase.to_sym
     if self.respond_to?(callback)
-      method(callback).call(userinfo, target, data)
+      result = method(callback).call(userinfo, target, data)
     end
+
+    result
   end # lookup_method
 end # /c:RilBot
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ril
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Joey Kinsella
@@ -23,7 +23,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/ril.rb
-- examples/vbot.rb
+- examples/opbot.rb
 - README
 - COPYING
 has_rdoc: true

data/examples/vbot.rb

@@ -1,43 +0,0 @@
-#! /usr/bin/env ruby
-#
-# vbot.rb - just prints the version!
-#   simple bot that connects to <server> with <nick>, joins <channel>, and
-#   handles the one command !version
-
-require 'ril'
-include Ril
-
-# c:VersionBot
-class VersionBot < RilBot
-  # hanle a PRIVMSG message.
-  def on_privmsg(userinfo, target, message)
-    command = message.split(' ').first
-
-    if command == '!version'
-      privmsg(target, version)
-    end
-  end # on_privmsg
-
-  # ERR_NOMOTD
-  def on_422(userinfo, target, message)
-    on_376(userinfo, target, message)
-  end # on_422
-
-  # RPL_ENDOFMOTD
-  def on_376(userinfo, target, message)
-    join($channel)
-  end # on_376
-end # /c:VersionBot
-
-if __FILE__ == $0
-  if ARGV.length != 3
-    puts "Usage: #{$0} <irc server> <nickname> <channel>"
-    exit 1
-  end
-
-  $channel = ARGV[2]
-
-  vbot = VersionBot.new(:hostname => ARGV[0],
-    :nickname => ARGV[1], :verbose => true)
-  vbot.run
-end