net-yail 1.2.3 → 1.3.0

data/README

@@ -1,5 +1,7 @@
 Rubyforge page: http://rubyforge.org/projects/ruby-irc-yail
 
+*Want to jump straight to the examples instead of reading this lame "about the project" doc?  Just click on Net::YAIL !*
+
 Net::YAIL is a library built for dealing with IRC communications in Ruby.
 This is a project I've been building for about three years, based
 originally on the very messy initial release of IRCSocket (back when I first

data/lib/net/yail.rb

@@ -9,6 +9,9 @@ require 'net/yail/magic_events'
 require 'net/yail/default_events'
 require 'net/yail/output_api'
 
+# Finally, a real class to include!
+require 'net/yail/message_parser.rb'
+
 # If a thread crashes, I want the app to die.  My threads are persistent, not
 # temporary.
 Thread.abort_on_exception = true
@@ -36,7 +39,7 @@ module Net
 # ==Incoming Events
 #
 # Current list of incoming events and the parameters sent to the handler:
-# * :incoming_any(event) - "global" handler that catches all events and may
+# * :incoming_any(raw) - "global" handler that catches all events and may
 #   modify their data as necessary before the real handler is hit.  This
 #   only be used in cases where it's necessary to grab a lot of events that
 #   also need to be processed elsewhere, such as doing input filtering for
@@ -227,6 +230,8 @@ class YAIL
   include Net::IRCEvents::Defaults
   include Net::IRCOutputAPI
 
+  VERSION = '1.3.0'
+
   attr_reader(
     :me,                # Nickname on the IRC server
     :registered,        # If true, we've been welcomed
@@ -458,42 +463,71 @@ class YAIL
 
   # Gets some input, sends stuff off to a handler.  Yay.
   def process_input(line)
-    # Allow global handler to break the chain, filter the line, whatever
-    return if handle :incoming_any, line
-
-    case line
-      # Numerics must be handled first!  Otherwise a numeric message that's
-      # formatted just right will accidentally match another handler.
-      when /^:((.+?)(?:!.+?)?) (\d{3})\s+(\S+?) (.+?)$/
-        handle_numeric($3.to_i, $1, $2, $4, $5)
-      when /^PING :?(.+?)$/
-        handle :incoming_ping, $1
-      when /^:((.+?)(?:!.+?)?) INVITE \S+ :(\S+)/
-        handle :incoming_invite, $1, $2, $3
-      when /^:((.+?)(?:!.+?)?) PRIVMSG (\S+) :?\001ACTION (.+?)\001$/
-        handle :incoming_act, $1, $2, $3, $4
-      when /^:((.+?)(?:!.+?)?) PRIVMSG (\S+?) :?\001(.+?)\001$/
-        handle :incoming_ctcp, $1, $2, $3, $4
-      when /^:((.+?)(?:!.+?)?) PRIVMSG (\S+?) :?(.+?)$/
-        handle :incoming_msg, $1, $2, $3, $4
-      when /^:((.+?)(?:!.+?)?) NOTICE (\S+?) :?\001(.+?)\001$/
-        handle :incoming_ctcpreply, $1, $2, $3, $4
-      when /^:((.+?)(?:!.+?)?) NOTICE (\S+?) :?(.+?)$/
-        handle :incoming_notice, $1, $2, $3, $4
-      when /^:((.+?)(?:!.+?)?) MODE (\S+?) :?(\S+?)(?: (.+?))?$/
-        handle :incoming_mode, $1, $2, $3, $4, $5
-      when /^:((.+?)(?:!.+?)?) JOIN :?(\S+?)$/
-        handle :incoming_join, $1, $2, $3
-      when /^:((.+?)(?:!.+?)?) PART (\S+?)(?: :?(\S+?)?)?$/
-        handle :incoming_part, $1, $2, $3, $4
-      when /^:((.+?)(?:!.+?)?) KICK (\S+?) (\S+?) :?(.+?)$/
-        handle :incoming_kick, $1, $2, $3, $4, $5
-      when /^:((.+?)(?:!.+?)?) QUIT :?(.+?)$/
-        handle :incoming_quit, $1, $2, $3
-      when /^:((.+?)(?:!.+?)?) NICK :?(\S+?)$/
-        handle :incoming_nick, $1, $2, $3
+    # Allow global handler to break the chain, filter the line, whatever.  For
+    # this release, it's a hack.  2.0 will be better.
+    for handler in @handlers[:incoming_any]
+      result = handler.call(line)
+      return if result == true
+    end
+
+    # Use the exciting new parser
+    msg = Net::YAIL::MessageParser.new(line)
+
+    # In the legacy system, there are never situations where we want the params
+    # separated into array elements.  So we convert them here, since so many
+    # handlers require a param or two followed by "everything else".
+    params = msg.params.dup
+    param1 = params.shift
+    other1 = params.join(' ') || ''
+    param2 = params.shift
+    other2 = params.join(' ') || ''
+
+    case msg.command
+      # Ping is important to handle quickly, so it comes first.
+      when 'PING'
+        handle(:incoming_ping, msg.params.first)
+      when /^\d{3}$/
+        handle_numeric(msg.command.to_i, msg.prefix, msg.nick, param1, other1)
+      when 'INVITE'
+        handle(:incoming_invite, msg.prefix, msg.nick, msg.params.last)
+
+      # This can encompass three possible messages, so further refining happens here - the last param
+      # is always the message itself, so we look for patterns there.
+      when 'PRIVMSG'
+        case msg.params.last
+          when /^\001ACTION (.+?)\001$/
+            handle(:incoming_act, msg.prefix, msg.nick, msg.params.first, $1)
+          when /^\001(.+?)\001$/
+            handle(:incoming_ctcp, msg.prefix, msg.nick, msg.params.first, $1)
+          else
+            handle(:incoming_msg, msg.prefix, msg.nick, param1, other1)
+        end
+
+      # This can encompass two possible messages, again based on final param
+      when 'NOTICE'
+        case msg.params.last
+          when /^\001(.+?)\001$/
+            handle(:incoming_ctcpreply, msg.prefix, msg.nick, msg.params.first, $1)
+          else
+            handle(:incoming_notice, msg.prefix, msg.nick, param1, other1)
+        end
+
+      when 'MODE'
+        handle(:incoming_mode, msg.prefix, msg.nick, param1, param2, other2)
+      when 'JOIN'
+        handle(:incoming_join, msg.prefix, msg.nick, param1)
+      when 'PART'
+        handle(:incoming_part, msg.prefix, msg.nick, param1, other1)
+      when 'KICK'
+        handle(:incoming_kick, msg.prefix, msg.nick, param1, param2, other2)
+      when 'QUIT'
+        handle(:incoming_quit, msg.prefix, msg.nick, param1)
+      when 'NICK'
+        handle(:incoming_nick, msg.prefix, msg.nick, param1)
+
+      # Unknown line!
       else
-        handle :incoming_miscellany, line
+        handle(:incoming_miscellany, line)
     end
   end
 

data/lib/net/yail/message_parser.rb

@@ -0,0 +1,66 @@
+module Net
+class YAIL
+
+# This is my lame attempt to convert the BNF-style grammar from RFC 1459 into
+# useable ruby regexes.  The hope here is that one can effectively match an
+# incoming message with high accuracy.  Usage:
+#
+#     line = ':Nerdmaster!jeremy@nerdbucket.com PRIVMSG Nerdminion :Do my bidding!!'
+#     message = Net::YAIL::MessageParser.new(line)
+#     # hash now has all kinds of useful pieces of the incoming message:
+#     puts line.nick        # "Nerdmaster"
+#     puts line.user        # "jeremy"
+#     puts line.host        # "nerdbucket.com"
+#     puts line.prefix      # "Nerdmaster!jeremy@nerdbucket.com"
+#     puts line.command     # "PRIVMSG"
+#     puts line.params      # ["Nerdminion", "Do my bidding!!"]
+class MessageParser
+  attr_reader :nick, :user, :host, :prefix, :command, :params, :servername
+
+  # Note that all regexes are non-greedy.  I'm scared of greedy regexes, sirs.
+  USER        = /\S+?/
+  NICK        = /\w[\w\d\\`'^{}\]\[-]+?/
+  HOST        = /\S+?/
+  SERVERNAME  = /\S+?/
+
+  # This is automatically grouped for ease of use in the parsing.  Group 1 is
+  # the full prefix; 2, 3, and 4 are nick/user/host; 1 is also servername if
+  # there was no match to populate 2, 3, and 4.
+  PREFIX      = /((#{NICK})!(#{USER})@(#{HOST})|#{SERVERNAME})/
+  COMMAND     = /(\w+|\d{3})/
+  TRAILING    = /\:\S*?/
+  MIDDLE      = /(?: +([^ :]\S*))/
+
+  MESSAGE     = /^(?::#{PREFIX} +)?#{COMMAND}(.*)$/
+
+  def initialize(line)
+    @params = []
+
+    if line =~ MESSAGE
+      matches = Regexp.last_match
+
+      @prefix = matches[1]
+      if (matches[2])
+        @nick = matches[2]
+        @user = matches[3]
+        @host = matches[4]
+      else
+        @servername = matches[1]
+      end
+
+      @command = matches[5]
+
+      # Args are a bit tricky.  First off, we know there must be a single
+      # space before the arglist, so we need to strip that.  Then we have to
+      # separate the trailing arg as it can contain nearly any character. And
+      # finally, we split the "middle" args on space.
+      arglist = matches[6].sub(/^ +/, '')
+      (middle_args, trailing_arg) = arglist.split(/ +:/, 2)
+      @params.push(middle_args.split(/ +/), trailing_arg)
+      @params.flatten!
+    end
+  end
+end
+
+end
+end

data/tests/net_yail.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
+require 'net/yail'
+require 'net/yail/message_parser'
+puts "VERSION: #{Net::YAIL::VERSION}"

data/tests/tc_message_parser.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/net_yail'
+require 'test/unit'
+
+class MessageParserText < Test::Unit::TestCase
+  # Very simple parsing of easy strings
+  def test_parse_basic
+    # Basic test of privmsg-type command
+    msg = Net::YAIL::MessageParser.new(':Nerdmaster!jeremy@nerdbucket.com PRIVMSG Nerdminion :Do my bidding!!')
+    assert_equal 'Nerdmaster', msg.nick
+    assert_equal 'jeremy', msg.user
+    assert_equal 'nerdbucket.com', msg.host
+    assert_equal 'Nerdmaster!jeremy@nerdbucket.com', msg.prefix
+    assert_equal 'PRIVMSG', msg.command
+    assert_equal 'Nerdminion', msg.params[0]
+    assert_equal 'Do my bidding!!', msg.params[1]
+
+    # Server command of some type
+    msg = Net::YAIL::MessageParser.new(':nerdbucket.com SERVERCOMMAND arg1 arg2 :final :trailing :arg, --fd9823')
+    assert_equal 'nerdbucket.com', msg.servername
+    assert_nil msg.user
+    assert_nil msg.nick
+    assert_nil msg.host
+    assert_equal 'nerdbucket.com', msg.prefix
+    assert_equal 'arg1', msg.params[0]
+    assert_equal 'arg2', msg.params[1]
+    assert_equal 'final :trailing :arg, --fd9823', msg.params[2]
+
+    # WTF?  Well, IRC spec says it's valid
+    msg = Net::YAIL::MessageParser.new('MAGICFUNKYFRESHCMD arg1 arg2')
+    assert_nil msg.servername
+    assert_equal 'MAGICFUNKYFRESHCMD', msg.command
+    assert_equal 'arg1', msg.params[0]
+    assert_equal 'arg2', msg.params[1]
+
+    # Action
+    msg = Net::YAIL::MessageParser.new(':Nerdmaster!jeremy@nerdbucket.com PRIVMSG #bottest :\001ACTION gives Towelie a joint\001')
+    assert_equal 'Nerdmaster', msg.nick
+    assert_equal 'PRIVMSG', msg.command
+    assert_equal '#bottest', msg.params.first
+    assert_equal '\001ACTION gives Towelie a joint\001', msg.params.last
+
+    # Bot sets mode
+    msg = Net::YAIL::MessageParser.new(':Towelie!~x2e521146@towelie.foo.bar MODE Towelie :+i')
+    assert_equal 'Towelie', msg.nick
+    assert_equal 'towelie.foo.bar', msg.host
+    assert_equal 'MODE', msg.command
+    assert_equal 'Towelie', msg.params.first
+    assert_equal '+i', msg.params.last
+
+    # Numeric message with a : before final param
+    msg = Net::YAIL::MessageParser.new(':someserver.co.uk.fn.bb 366 Towelie #bottest :End of /NAMES list.')
+    assert_nil msg.nick
+    assert_nil msg.host
+    assert_equal '366', msg.command
+    assert_equal 'Towelie', msg.params.shift
+    assert_equal '#bottest', msg.params.shift
+    assert_equal 'End of /NAMES list.', msg.params.shift
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: net-yail
 version: !ruby/object:Gem::Version 
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors: 
 - Jeremy Echols
@@ -9,7 +9,7 @@ autorequire: net/yail
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -07:00
+date: 2009-04-28 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,7 @@ files:
 - lib/net/yail/magic_events.rb
 - lib/net/yail/eventmap.yml
 - lib/net/yail/IRCBot.rb
+- lib/net/yail/message_parser.rb
 - README
 has_rdoc: true
 homepage: http://ruby-irc-yail.nerdbucket.com/
@@ -59,5 +60,6 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: "Yet Another IRC Library: wrapper for IRC communications in Ruby."
-test_files: []
-
+test_files: 
+- tests/net_yail.rb
+- tests/tc_message_parser.rb