ril 0.1.1

data/COPYING

@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                          675 Mass Ave, Cambridge, MA 02139, USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	Appendix: How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) 19yy  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) 19yy name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README

@@ -0,0 +1,32 @@
+Ril is just a simple IRC "library" that is made to make building IRC bots
+easier. Instead of focusing on creating functions, and binding messages. Ril
+is designed so that you can build a completely functional IRC bot within
+minutes of opening your favorite editor and saving the file. The magic is that
+you don't need to handle anything that is on the IRC under layer, only create
+an object that inherits Ril::RilBot, and start defining your methods, the
+syntax is as follows:
+
+  def on_privmsg(userinfo, target, message)
+    nick, user, host = userinfo_to_a(userinfo)
+
+    puts "<#{nick}/#{target}> #{message}"
+  end
+
+  -or-
+
+  def on_375(userinfo, target, message)
+    @message_of_the_day = ""
+  end
+
+  def on_372(userinfo, target, message)
+    @message_of_the_day += "#{message}\n"
+  end
+
+all functions will be called with the three parameters +userinfo+, +target+,
+and +message+, depending on the type of message it is, may mean that +target+
+will be nil, and +message+ will have the data you are looking for, or vice
+versa, so some IRC protocol knowledge is required. Check out the examples, for
+more fun!
+
+Thanks for looking,
+The Ril Tream

data/examples/vbot.rb

@@ -0,0 +1,43 @@
+#! /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

data/lib/ril.rb

@@ -0,0 +1,365 @@
+###
+#   ril.rb - ruby irc library
+#     $Release Version: 0.1.1 $
+#     $Revision: 4 $
+#     by Joey Kinsella <jkinsella(at)rubyforge(dot)org>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+####
+require 'socket'
+
+module Ril
+  Ril_VERSION = "Ril - Ruby IRC Library v0.1.1 by Joey Kinsella"
+
+####
+# c:RilBot
+
+# The RilBot object creates a connection to an IRC server, and then sits
+# in a processing loop, calling the appropriate functions.
+#
+# The idea behind RilBot, is to create your own bot object that inherits
+# RilBot, and then override the on_* methods, with your own.
+#
+class RilBot
+
+  # initializes an instance of RilBot.
+  #
+  #  * server_args is a hash variable containing appropriate settings.
+  #  
+  #    == IRC related settings ==
+  #  :hostname => server to connect to [required]
+  #  :port     => port number to connect to [defaults to 6667]
+  #  :nickname => nickname to use [required]
+  #  :username => username to use, [defaults to nickname if not set]
+  #  :realname => realname to use, [defaults to nickname if not set]
+  #  :password => PASS to send to server
+  #
+  #    == RilBot related settings ==
+  #  :verbose  => true or false, if true prints the IRC messages out.
+  #
+  # * 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
+  # * parameter, which is just a reference to self.
+  #
+  def initialize(server_args, &block)
+    # verbose flag
+    @verbose = server_args[:verbose]
+    @verbose = false if @verbose.nil?
+
+    # identified flag
+    @identified = false
+
+    # keep the run loop running
+    @run_loop = true
+
+    # server to connect to.
+    @hostname = server_args[:hostname]
+    raise ArgumentError, "No hostname defined." if @hostname.nil?
+
+    # need a nickname to use
+    @nickname = server_args[:nickname]
+    raise ArgumentError, "No nickname defined." if @nickname.nil?
+
+    # port, defaults to 6667 (obviously)
+    @port = server_args[:port]
+    @port = 6667 if @port.nil?
+
+    # username
+    @username = server_args[:username]
+    @username = @nickname if @username.nil?
+
+    # realname
+    @realname = server_args[:realname]
+    @realname = @nickname if @realname.nil?
+
+    # IRC password
+    @irc_password = server_args[:password]
+
+    # initialize method keeper
+    @method_keeper = Hash.new
+
+    vputs "connecting to irc://#{@hostname}:#{@port}"
+
+    # bind block
+    if block_given?
+      @method_keeper['first_run'] = block
+    end
+
+    # bind the default methods...
+    bind_ping(method(:on_ping))
+    bind_notice_auth(method(:on_notice_auth))
+
+    begin
+      # try to connect.
+      @socket = TCPSocket.new(@hostname, @port)
+    rescue
+      vputs "Failed to connect to irc://#{@hostname}:#{@port}"
+      raise
+    end
+  end # initialize
+
+  # binds to ``NOTICE AUTH''
+  # Will either call the method pointed to by callback_obj, or execute
+  # the given block, this function should have one parameter, and it
+  # will contain the text given to you from the server. +msg+
+  def bind_notice_auth(callback_obj = nil, &block)
+    if block_given?
+      @method_keeper['notice_auth'] = block
+    elsif callback_obj.nil? == false
+      @method_keeper['notice_auth'] = callback_obj
+    else
+      raise ArgumentError
+    end
+  end # bind_notice_auth
+
+  # binds to PING message
+  # will call the binded function with the servers hostname.
+  def bind_ping(callback_obj = nil, &block)
+    if block_given?
+      @method_keeper['ping'] = block
+    elsif callback_obj.nil? == false
+      @method_keeper['ping'] = callback_obj
+    else
+      raise ArgumentError
+    end
+  end
+
+  # 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)
+    end
+  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
+  def identified?
+    @identified
+  end # identified?
+
+  # returns the nickname you are currently using.
+  def my_nick
+    @nickname
+  end # my_nick
+
+  # little utility function to convert a +userinfo+ hash to an array
+  # useful so you can do: 
+  #   nickname, username, hostname = userinfo_to_a(userinfo)
+  def userinfo_to_a(userinfo)
+    [ userinfo[:nickname], userinfo[:username], userinfo[:hostname] ]
+  end # userinfo_to_a
+
+  ######
+  # start IRC stuff
+  ###
+
+  # sends +msg+ as a raw IRC message, eg: PRIVMSG #ruby :hello
+  def send_raw(msg)
+    vputs ">>> #{msg}"
+
+    if msg.length > 512
+      vputs "*** WARNING: +msg+ is over 512 bytes cutting..."
+      msg = msg[0..511]
+    end
+
+    @socket.puts msg
+  end
+
+  # send +message+ to +target+, if +safety+ is true check to see if
+  # +target+ is my_nick, if so don't send..
+  def privmsg(target, message, safety = true)
+    return if target == my_nick and safety == true
+
+    send_raw("PRIVMSG #{target} :#{message}")
+  end # privmsg
+
+  # sends +message+ to +target+ via notice, if +safety+ is true check to see
+  # if +target+ is my_nick, if so don't send...
+  def notice(target, message, safety = true)
+    return if target == my_nick and safety == true
+
+    send_raw("NOTICE #{target} :#{message}")
+  end # notice
+
+  # joins +channel+ with +key+
+  #
+  # if +channel+ is an array it will join each channel in that array.
+  # +key+ can also be an array of keys.
+  def join(channel, key = nil)
+    channels = (channel.is_a? Array) ? channel.join(",") : channel
+    keys = (key.is_a? Array) ? key.join(",") : key
+    keys = "" if keys.nil?
+
+    send_raw("JOIN #{channels} #{keys}")
+  end # join
+
+  # parts +channel+, leaving them with +part_msg+
+  def part(channel, part_msg = nil)
+    send_raw("PART #{channel} :#{msg}")
+  end # part
+
+  # adjusts mode to +mode+ on +target+, with +mode_opts+
+  #
+  # if +mode_opts+ is an array it will be converted to a space delimited string.
+  def mode(target, mode, mode_opts = nil)
+    mode_opts = "" if mode_opts.nil?
+    mode_opts = (mode_opts.is_a? Array) ? mode_opts.join(" ") : mode_opts
+
+    send_raw("MODE #{target} #{mode} #{mode_opts}")
+  end # mode
+
+  # changes topic on +channel+ to +new_topic+
+  #
+  # if +new_topic+ is nil, it will unset the topic.
+  def topic(channel, new_topic = nil)
+    new_topic = "" if new_topic.nil?
+
+    send_raw("TOPIC #{channel} :#{new_topic}")
+  end # topic
+
+  # invite +nick+ to +channel+
+  def invite(channel, nick)
+    send_raw("INVITE #{channel} #{nick}")
+  end # invite
+
+  # set an away message to +message+
+  #
+  # if +message+ is nil, it will remove your away message.
+  def away(message = nil)
+    send_raw("AWAY :#{message}") unless message.nil?
+    send_raw("AWAY") if message.nil?
+  end # away
+
+  # quits the server with +message+
+  #
+  # if +message+ is nil, then it just quits reporting version info.
+  def quit(message = nil)
+    message = version() if quit.nil?
+
+    stop
+    send_raw("QUIT :#{message}")
+  end # quit
+
+  # handles a PING response, if you override this function
+  # be sure to send a PONG back.
+  def on_ping(hostname)
+    send_raw("PONG :#{hostname}")
+  end # on_ping
+
+  # handles a NOTICE AUTH response, if you override this method
+  # be sure to send NICK, USER, PASS, and the .identified? method
+  # will become completely useless... +msg+ is just what was sent
+  # as the message.
+  def on_notice_auth(msg)
+    unless @identified
+      send_raw("NICK #{@nickname}\r\nUSER #{@username} 0 0 :#{@realname}")
+      send_raw("PASS #{@irc_password}") if @irc_password.nil? == false
+
+      @identified = true
+    end
+  end
+
+protected
+  def version
+    Ril::Ril_VERSION
+  end
+
+private
+  # prints +str+ if verbosity is enabled.
+  def vputs(str)
+    puts str if @verbose
+  end
+
+  # parses the irc +msg+
+  def parse(msg)
+    vputs "<<< #{msg}"
+
+    msg.each_line do |m|
+      prefix, data = m.split(' :')
+      data.chomp! unless data.nil?
+
+      if prefix == 'NOTICE AUTH' 
+        unless @method_keeper['notice_auth'].nil?
+          @method_keeper['notice_auth'].call(data)
+        end
+      elsif prefix == 'PING'
+        unless @method_keeper['ping'].nil?
+          @method_keeper['ping'].call(data)
+        end
+      else
+        irc_message = prefix.split(' ')[1]
+        
+        if irc_message == "422" or irc_message == "376"
+          unless @method_keeper['first_run'].nil?
+            @method_keeper['first_run'].call(self)
+
+            # we don't want this running if your bot does a MOTD.
+            @method_keeper['first_run'] = nil
+          end
+        end
+
+        # run the appropriate method...
+        lookup_method(irc_message, prefix, data)
+      end # prefix == ???
+    end # msg.each
+  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(' ')
+
+    if prefix_a.nil? and $DEBUG
+      vputs ">>>DEBUGGING<<<"
+      vputs "message: #{message}"
+      vputs "prefix: #{prefix}"
+      vputs "data: #{data}"
+      vputs ">>>DEBUGGING<<<"
+    end
+      
+    prefix_a[0].slice!(0)
+
+    if prefix_a[0].index('!').nil?
+      userinfo = { :hostname => prefix_a[0] }
+    else
+      userinfo = {
+        :nickname => prefix_a[0].split('!')[0],
+        :username => prefix_a[0].split('!')[1].split('@')[0],
+        :hostname => prefix_a[0].split('@')[0],
+      }
+    end
+
+    prefix_a.slice!(0, 2)
+    target = prefix_a.join(' ')
+
+    callback = "on_#{message}".downcase.to_sym
+    if self.respond_to?(callback)
+      method(callback).call(userinfo, target, data)
+    end
+  end # lookup_method
+end # /c:RilBot
+
+end # module

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: ril
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Joey Kinsella
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Ril is a inheritence based IRC library.
+email: jkinsella@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ril.rb
+- examples/vbot.rb
+- README
+- COPYING
+has_rdoc: true
+homepage: http://rubyforge.org/projects/ril
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: http://ril.rubyforge.org/
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: provides IRC support to ruby
+test_files: []
+