Ruby-IRC 1.0.7 → 1.0.10

data/lib/IRC.rb

@@ -66,13 +66,17 @@ class IRC
 
     IRCConnection.handle_connection(@server, @port, @nick, @realname) do
       # Log in information moved to IRCConnection
-      threads = []
+      @threads = []
       IRCConnection.main do |event|
-        threads << Thread.new(event) {|localevent|
-          localevent.process
-        }
+        if event.kind_of?(Array)
+          event.each {|event|
+            thread_event(event)
+          }
+        else
+          thread_event(event)
+        end
       end
-      threads.each {|thr| thr.join }
+      @threads.each {|thr| thr.join }
     end
   end
   
@@ -89,7 +93,17 @@ class IRC
       @channels.delete_if {|chan| chan.name == channel }
     end
   end
-  
+
+  # kicks a user from a channel (does not check for operator privledge)
+  def kick(channel, user, message)
+    IRCConnection.send_to_server("KICK #{channel} #{user} :#{message || user || 'kicked'}")
+  end
+
+  # sets the topic of the given channel
+  def set_topic(channel, topic)
+    IRCConnection.send_to_server("TOPIC #{channel} :#{topic}");
+  end
+
   # Sends a private message, or channel message
   def send_message(to, message)
     IRCConnection.send_to_server("privmsg #{to} :#{message}");
@@ -140,4 +154,10 @@ class IRC
   def get_user_info(user)
     IRCConnection.send_to_server("WHO #{user}")
   end
+  private
+  def thread_event (event)
+    @threads << Thread.new(event) {|localevent|
+      localevent.process
+    }
+  end
 end

data/lib/IRC.rb.~1.8.~

@@ -0,0 +1,153 @@
+
+require 'socket'
+require 'IRCConnection'
+require 'IRCEvent'
+require 'IRCChannel'
+require 'IRCUser'
+require 'IRCUtil'
+
+
+
+# Class IRC is a master class that handles connection to the irc
+# server and pasring of IRC events, through the IRCEvent class. 
+class IRC
+  @channels = nil
+  # Create a new IRC Object instance
+  def initialize( nick, server, port, realname='RBot')
+    @nick = nick
+    @server = server
+    @port = port
+    @realname = realname
+    @channels = Array.new(0)
+    # Some good default Event handlers. These can and will be overridden by users.
+    # Thses make changes on the IRCbot object. So they need to be here.
+    
+    # Topic events can come on two tags, so we create on proc to handle them.
+
+    topic_proc = Proc.new { |event|
+      self.channels.each { |chan| 
+        if chan == event.channel
+          chan.topic = event.message
+        end
+      }
+    }
+    
+    IRCEvent.add_handler('332', topic_proc)
+    IRCEvent.add_handler('topic', topic_proc)
+
+  
+  end
+  
+  attr_reader :nick, :server, :port
+  
+  # Join a channel, adding it to the list of joined channels
+  def add_channel channel
+    join(channel)
+    self
+  end
+  
+  # Returns a list of channels joined
+  def channels
+    @channels
+  end
+  
+  # Alias for IRC.connect
+  def start
+    self.connect
+  end
+  
+  # Open a connection to the server using the IRC Connect
+  # method. Events yielded from the IRCConnection handler are
+  # processed and then control is returned to IRCConnection
+  def connect
+    quithandler = lambda { send_quit(); IRCConnection.quit }
+    trap("INT", quithandler) 
+    trap("TERM", quithandler)
+
+    IRCConnection.handle_connection(@server, @port, @nick, @realname) do
+      # Log in information moved to IRCConnection
+      threads = []
+      IRCConnection.main do |event|
+        threads << Thread.new(event) {|localevent|
+          localevent.process
+        }
+      end
+      threads.each {|thr| thr.join }
+    end
+  end
+  
+  # Joins a channel on a server.
+  def join(channel)
+    if (IRCConnection.send_to_server("JOIN #{channel}"))
+      @channels.push(IRCChannel.new(channel));
+    end
+  end
+  
+  # Leaves a channel on a server
+  def part(channel)
+    if (IRCConnection.send_to_server("PART #{channel}")) 
+      @channels.delete_if {|chan| chan.name == channel }
+    end
+  end
+
+  # kicks a user from a channel (does not check for operator privledge)
+  def kick(channel, user, message)
+    IRCConnection.send_to_server("KICK #{channel} #{user} :#{message || user || 'kicked'}")
+  end
+
+  # sets the topic of the given channel
+  def set_topic(channel, topic)
+    IRCConnection.send_to_server("TOPIC #{channel} :#{topic}");
+  end
+
+  # Sends a private message, or channel message
+  def send_message(to, message)
+    IRCConnection.send_to_server("privmsg #{to} :#{message}");
+  end
+  
+  # Sends a notice
+  def send_notice(to, message)
+    IRCConnection.send_to_server("NOTICE #{to} :#{message}");
+  end
+  
+  # performs an action
+  def send_action(to, action)
+    send_ctcp(to, 'ACTION', action);
+  end
+
+  # send CTCP
+  def send_ctcp(to, type, message)
+    IRCConnection.send_to_server("privmsg #{to} :\001#{type} #{message}");
+  end
+  
+  # Quits the IRC Server
+  def send_quit
+    IRCConnection.send_to_server("QUIT : Quit ordered by user")
+  end
+  
+  # Ops selected user.
+  def op(channel, user)
+    IRCConnection.send_to_server("MODE #{channel} +o #{user}")
+  end
+  
+  # Changes the current nickname
+  def ch_nick(nick)
+    IRCConnection.send_to_server("NICK #{nick}")
+    @nick = nick
+  end
+  
+  # Removes operator status from a user
+  def deop(channel, user)
+    IRCConnection.send_to_server("MODE #{channel} -o #{user}")
+  end
+  
+  # Changes target users mode
+  def mode(channel, user, mode)
+    IRCConnection.send_to_server("MODE #{channel} #{mode} #{user}")
+  end
+  
+  # Retrievs user information from the server
+  def get_user_info(user)
+    IRCConnection.send_to_server("WHO #{user}")
+  end
+end

data/lib/IRCConnection.rb

@@ -1,9 +1,12 @@
 
 # Handles connection to IRC Server
 class IRCConnection
-  @@quit = 0
-  @@readsockets = Array.new(0)
-  @@events      = Hash.new()
+  @@quit          = 0
+  @@readsockets   = Array.new(0)
+  @@output_buffer = Array.new(0)
+  @@events        = Hash.new()
+  @@last_send     = Time.now.to_f
+  @@message_delay = 0.2 # Default delay to 1 fifth of a second.
   # Creates a socket connection and then yields.
   def IRCConnection.handle_connection(server, port, nick='ChangeMe', realname='MeToo' )
     @server = server;
@@ -45,6 +48,12 @@ class IRCConnection
     @@socket.write(line + "\n")
   end
   
+  # Adds data an output buffer. This let's us keep a handle on how
+  # fast we send things. Yay.
+  def IRCConnection.output_push(line)
+    @@output_buffer.push(line)
+  end
+
   # This loop monitors all IO_Sockets IRCConnection controls
   # (including the IRC socket) and yields events to the IO_Sockets
   # event handler. 
@@ -59,24 +68,38 @@ class IRCConnection
   # Makes one single loop pass, checking all sockets for data to read,
   # and yields the data to the sockets event handler.
   def IRCConnection.do_one_loop
-    read_sockets = select(@@readsockets, nil, nil, nil);
-    read_sockets[0].each {|sock|
-      if sock.eof? && sock == @@socket
-        p "Detected Socket Close"
-        remove_IO_socket(sock)
-        sleep 10
-        handle_connection(@server, @port, @nick, @realname)
-      else
-        yield @@events[sock.to_i].call(sock)
+    read_sockets = select(@@readsockets, nil, nil, 0.1);
+    if !read_sockets.nil?
+      read_sockets[0].each {|sock|
+        if sock.eof? && sock == @@socket
+          p "Detected Socket Close"
+          remove_IO_socket(sock)
+          sleep 10
+          handle_connection(@server, @port, @nick, @realname)
+        else
+          yield @@events[sock.to_i].call(sock)
+        end
+      }
+    end
+    if @@output_buffer.length > 0
+      timer = Time.now.to_f
+      if (timer > @@last_send + @@message_delay) 
+        message = @@output_buffer.shift();
+        if !message.nil?
+          IRCConnection.send_to_server(message);
+          @@last_send = timer
+        end
       end
-    }
+    end
   end
 
   # Ends connection to the irc server
   def IRCConnection.quit
     @@quit = 1
   end 
-
+  def IRCConnection.delay=(delay)
+    @@message_delay = delay.to_f
+  end
   # Retrieves user info from the server
   def IRCConnection.get_user_info(user)
     IRCConnection.send_to_server("WHOIS #{user}")
@@ -88,7 +111,7 @@ class IRCConnection
     @@events[socket.to_i] = event_generator
   end
 
-  def IRCConnection.remove_IO_socket(socket)
+  def IRCConnection.remove_IO_socket(sock)
     sock.close
     @@readsockets.delete_if {|item| item == sock }
   end

data/lib/IRCConnection.rb.~1.4.~

@@ -0,0 +1,97 @@
+
+# Handles connection to IRC Server
+class IRCConnection
+  @@quit = 0
+  @@readsockets = Array.new(0)
+  @@events      = Hash.new()
+  # Creates a socket connection and then yields.
+  def IRCConnection.handle_connection(server, port, nick='ChangeMe', realname='MeToo' )
+    @server = server;
+    @port = port
+    @nick = nick
+    @realname = realname
+    socket = create_tcp_socket(server, port)
+    add_IO_socket(socket) {|sock| 
+      begin
+        IRCEvent.new(sock.readline.chomp) 
+      rescue Errno::ECONNRESET
+        # Catches connection reset by peer, attempts to reconnect
+        # after sleeping for 10 second.
+        remove_IO_socket(sock)
+        sleep 10
+        handle_connection(@server, @port, @nick, @realname)
+      end
+    }
+    send_to_server "NICK #{nick}"
+    send_to_server "USER #{nick} 8 * :#{realname}"
+    if block_given?
+      yield
+      @@socket.close
+    end
+  end
+  
+  def IRCConnection.create_tcp_socket(server, port)
+    @@socket = TCPsocket.open(server, port)
+    if block_given?
+      yield
+      @@socket.close
+      return
+    end
+    return @@socket
+  end
+  
+  # Sends a line of text to the server
+  def IRCConnection.send_to_server(line)
+    @@socket.write(line + "\n")
+  end
+  
+  # This loop monitors all IO_Sockets IRCConnection controls
+  # (including the IRC socket) and yields events to the IO_Sockets
+  # event handler. 
+  def IRCConnection.main
+    while(@@quit == 0)
+      do_one_loop { |event|
+        yield event
+      }
+    end
+  end
+
+  # Makes one single loop pass, checking all sockets for data to read,
+  # and yields the data to the sockets event handler.
+  def IRCConnection.do_one_loop
+    read_sockets = select(@@readsockets, nil, nil, nil);
+    read_sockets[0].each {|sock|
+      if sock.eof? && sock == @@socket
+        p "Detected Socket Close"
+        remove_IO_socket(sock)
+        sleep 10
+        handle_connection(@server, @port, @nick, @realname)
+      else
+        yield @@events[sock.to_i].call(sock)
+      end
+    }
+  end
+
+  # Ends connection to the irc server
+  def IRCConnection.quit
+    @@quit = 1
+  end 
+
+  # Retrieves user info from the server
+  def IRCConnection.get_user_info(user)
+    IRCConnection.send_to_server("WHOIS #{user}")
+  end
+
+  # Adds a new socket to the list of sockets to monitor for new data.
+  def IRCConnection.add_IO_socket(socket, &event_generator)
+    @@readsockets.push(socket)
+    @@events[socket.to_i] = event_generator
+  end
+
+  def IRCConnection.remove_IO_socket(socket)
+    sock.close
+    @@readsockets.delete_if {|item| item == sock }
+  end
+end
+
+

data/lib/IRCEvent.rb

@@ -40,7 +40,8 @@ class IRCEvent
       @from    = @stats[0] 
       @user    = IRCUser.create_user(@from)
     end
-    @hostmask = @stats[1] if %W(privmsg join).include? @event_type
+    # FIXME: this list would probably be more accurate to exclude commands than to include them
+    @hostmask = @stats[1] if %W(topic privmsg join).include? @event_type
     @channel = @stats[3] if @stats[3] && !@channel
     @target  = @stats[5] if @stats[5]
     @mode    = @stats[4] if @stats[4]

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: Ruby-IRC
 version: !ruby/object:Gem::Version 
-  version: 1.0.7
-date: 2006-12-14 00:00:00 -08:00
+  version: 1.0.10
+date: 2007-11-07 00:00:00 -08:00
 summary: An IRC Client library
 require_paths: 
 - lib
@@ -25,16 +25,19 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Chris Boyer
 files: 
 - lib/IRCEvent.rb
 - lib/IRC.rb
+- lib/IRC.rb.~1.8.~
 - lib/IRCChannel.rb
 - lib/IRCConnection.rb
 - lib/IRCUser.rb
 - lib/IRCUtil.rb
 - lib/eventmap.yml
+- lib/IRCConnection.rb.~1.4.~
 - README
 test_files: []