net-yail 1.4.3 → 1.4.4

data/lib/net/yail.rb

@@ -277,6 +277,9 @@ class YAIL
   # * <tt>:username</tt>: Username reported to server
   # * <tt>:realname</tt>: Real name reported to server
   # * <tt>:nicknames</tt>: Array of nicknames to cycle through
+  # * <tt>:io</tt>: TCP replacement object to use, should already be connected and ready for sending
+  #   the "connect" data (:outgoing_begin_connection handler does this)
+  #   If this is passed, :address and :port are ignored.
   # * <tt>:silent</tt>: DEPRECATED - Sets Logger level to FATAL and silences most non-Logger
   #   messages.
   # * <tt>:loud</tt>: DEPRECATED - Sets Logger level to DEBUG. Spits out too many messages for your own good,
@@ -298,6 +301,7 @@ class YAIL
     @username           = options[:username]
     @realname           = options[:realname]
     @address            = options[:address]
+    @io                 = options[:io]
     @port               = options[:port] || 6667
     @log_silent         = options[:silent] || false
     @log_loud           = options[:loud] || false
@@ -312,15 +316,15 @@ class YAIL
       @log = Logger.new(options[:log_io] || STDERR)
       @log.level = Logger::WARN
  
+      if (options[:silent] || options[:loud])
+        @log.warn '[DEPRECATED] - passing :silent and :loud options to constructor are deprecated as of 1.4.1'
+      end
+
       # Convert old-school options into logger stuff
       @log.level = Logger::DEBUG if @log_loud
       @log.level = Logger::FATAL if @log_silent
     end
 
-    if (options[:silent] || options[:loud])
-      @log.warn '[DEPRECATED] - passing :silent and :loud options to constructor are deprecated as of 1.4.1'
-    end
-
     # Read in map of event numbers and names.  Yes, I stole this event map
     # file from RubyIRC and made very minor changes....  They stole it from
     # somewhere else anyway, so it's okay.
@@ -331,13 +335,17 @@ class YAIL
     @dead_socket = false
 
     # Build our socket - if something goes wrong, it's immediately a dead socket.
-    begin
-      @socket = TCPSocket.new(@address, @port)
-      setup_ssl if @ssl
-    rescue StandardError => boom
-      @log.fatal "+++ERROR: Unable to open socket connection in Net::YAIL.initialize: #{boom.inspect}"
-      @dead_socket = true
-      raise
+    if @io
+      @socket = @io
+    else
+      begin
+        @socket = TCPSocket.new(@address, @port)
+        setup_ssl if @ssl
+      rescue StandardError => boom
+        @log.fatal "+++ERROR: Unable to open socket connection in Net::YAIL.initialize: #{boom.inspect}"
+        @dead_socket = true
+        raise
+      end
     end
 
     # Shared resources for threads to try and coordinate....  I know very
@@ -350,7 +358,6 @@ class YAIL
 
     # Buffered output is allowed to go out right away.
     @next_message_time = Time.now
-
     # Setup handlers
     @handlers = Hash.new
     setup_default_handlers
@@ -476,8 +483,19 @@ class YAIL
   # forever for incoming data, and calling handlers due to this listening
   def io_loop
     loop do
-      # if no data is coming in, don't block the socket!
-      read_incoming_data if Kernel.select([@socket], nil, nil, 0)
+      # Possible fix for SSL one-message-behind issue from BP - thanks!
+      #
+      # If SSL, we just assume we're ready so we're always grabbing the latest message(s) from the
+      # socket.  I don't know if this will have any side-effects, but it seems to work in at least
+      # one situation, sooo....
+      ready = true if @ssl
+      unless ready
+        # if no data is coming in, don't block the socket!  To allow for mocked IO objects, allow
+        # a non-IO to let us know if it's ready
+        ready = @socket.kind_of?(IO) ? Kernel.select([@socket], nil, nil, 0) : @socket.ready?
+      end
+
+      read_incoming_data if ready
 
       # Check for dead socket
       @dead_socket = true if @socket.eof?

data/lib/net/yail/yail-version.rb

@@ -1,5 +1,5 @@
 module Net
   class YAIL
-    VERSION = '1.4.3'
+    VERSION = '1.4.4'
   end
 end

data/tests/mock_irc.rb

@@ -0,0 +1,153 @@
+# An IO-like class that does IRC-like magic for us
+class MockIRC
+  SERVER = "fakeirc.org"
+  USERHOST = "fakey@nerdbucket.com"
+
+  # Init - just call super and set up a couple vars
+  def initialize(*args)
+    super
+    @connected = false
+    @logged_in = false
+    @closed = false
+    @server = ''
+    @output = []
+    @mutex = Mutex.new
+  end
+
+  # All output sent to the IO uses puts in YAIL.  I hope.
+  def puts(*args)
+    @mutex.synchronize do
+      for string in args
+        handle_command(string.strip)
+      end
+    end
+    return nil
+  end
+
+  # Lets us know if we are an open "socket" or not - if the socket is closed *and* we're out of
+  # output, we are done
+  def eof
+    @mutex.synchronize do
+      return @output.empty? && @closed
+    end
+  end
+
+  alias_method :eof?, :eof
+
+  # Pulls the first element off of @output
+  def gets
+    output = nil
+    @mutex.synchronize do
+      output = @output.shift
+    end
+
+    puts "WTF NO DATA!" if !output
+
+    return output
+  end
+
+  # Hack to let YAIL know if we have data to read
+  def ready?
+    return @output.empty? ? nil : true
+  end
+
+  # All the magic goes here
+  def handle_command(cmd)
+    unless @connected
+      handle_connected(cmd)
+      return
+    end
+
+    unless @logged_in
+      handle_nick(cmd)
+      return
+    end
+
+    # TODO: Handle other commands
+    case cmd
+      when /^QUIT/
+        add_output ":#{SERVER} NOTICE #{@nick} :See ya, jerk"
+        @closed = true
+
+      when /^NICK/    then handle_nick(cmd)
+      when /^JOIN/    then handle_join(cmd)
+    end
+  end
+
+  # Handles a connection command (USER) or errors
+  def handle_connected(cmd)
+    if cmd =~ /^USER (\S+) (\S+) (\S+) :(.*)$/
+      add_output ":#{SERVER} NOTICE AUTH :*** Looking up your hostname..."
+      @connected = true
+      return
+    end
+
+    add_output ":#{SERVER} ERROR :You need to authenticate or something"
+  end
+
+  # Handles a NICK request, but no error if no nick set - not sure what a real server does here
+  def handle_nick(cmd)
+    unless cmd =~ /^NICK :(.*)$/
+      return
+    end
+
+    nick = $1
+
+    if "InUseNick" == nick
+      add_output ":#{SERVER} 433 * #{nick} :Nickname is already in use."
+      return
+    end
+
+    oldnick = @nick
+    @nick = nick
+
+    unless @logged_in
+      add_output ":#{SERVER} NOTICE #{@nick} :*** You are exempt from user limits. congrats.",
+                 ":#{SERVER} 001 #{@nick} :Welcome to the Fakey-fake Internet Relay Chat Network #{@nick}",
+                 ":#{SERVER} 002 #{@nick} :Your host is #{SERVER}[0.0.0.0/6667], running version mock-irc-1.7.7",
+                 ":#{SERVER} 003 #{@nick} :This server was created Nov 21 2009 at 21:20:48",
+                 ":#{SERVER} 004 #{@nick} #{SERVER} mock-irc-1.7.7 foobar barbaz bazfoo",
+                 ":#{SERVER} 005 #{@nick} CALLERID CASEMAPPING=rfc1459 DEAF=D KICKLEN=160 MODES=4 NICKLEN=15 PREFIX=(ohv)@%+ STATUSMSG=@%+ TOPICLEN=350 NETWORK=Fakeyfake MAXLIST=beI:25 MAXTARGETS=4 CHANTYPES=#& :are supported by this server",
+                 ":#{SERVER} 251 #{@nick} :There are 0 users and 24 invisible on 1 servers",
+                 ":#{SERVER} 254 #{@nick} 3 :channels formed",
+                 ":#{SERVER} 255 #{@nick} :I have 24 clients and 0 servers",
+                 ":#{SERVER} 265 #{@nick} :Current local users: 24  Max: 30",
+                 ":#{SERVER} 266 #{@nick} :Current global users: 24  Max: 33",
+                 ":#{SERVER} 250 #{@nick} :Highest connection count: 30 (30 clients) (4215 connections received)",
+                 ":#{SERVER} 375 #{@nick} :- #{SERVER} Message of the Day - ",
+                 ":#{SERVER} 372 #{@nick} :-           BOO!",
+                 ":#{SERVER} 372 #{@nick} :-     Did I scare you?",
+                 ":#{SERVER} 372 #{@nick} :-        BOO again!",
+                 ":#{SERVER} 376 #{@nick} :End of /MOTD command."
+      @logged_in = true
+      return
+    end
+
+    # Hostmask is faked, but otherwise this is the message we send in response to a nick change
+    add_output ":#{oldnick}!#{USERHOST} NICK :#{@nick}"
+  end
+
+  def handle_join(cmd)
+    unless cmd =~ /^JOIN (\S*)( (\S*))?$/
+      return
+    end
+
+    channel = $1
+    pass = $2
+    if "#banned" == channel
+      add_output ":#{SERVER} 474 T-meister #{channel}:Cannot join channel (+b)"
+      return
+    end
+
+    add_output ":#{@nick}!#{USERHOST} JOIN :#{channel}",
+               ":#{SERVER} 332 #{@nick} #{channel} :This is a topic, y'all!",
+               ":#{SERVER} 333 #{@nick} #{channel} user!user@user.com 1291781166",
+               ":#{SERVER} 353 #{@nick} = #{channel} :#{@nick} @Nerdmaster another_bot",
+               ":#{SERVER} 366 #{@nick} #{channel} :End of /NAMES list."
+  end
+
+  # Sets up our internal string to add the given string arguments for a gets call to pull
+  def add_output(*args)
+    args.each {|arg| @output.push(arg + "\n")}
+  end
+end

data/tests/tc_event.rb

@@ -99,6 +99,22 @@ class MessageParserEventTest < Test::Unit::TestCase
 
     # First param in the message params list should still be nick
     assert_equal 'Towelie', event.msg.params.first
+
+    # This is a weird numeric causing errors for a user
+    event = Net::YAIL::IncomingEvent.parse(":irc.somehost.xx 322 user #CrAzY_MaNiCoMiCuM 12 :[+ntr] \253'\002\0033,3 \0030 I \0030,0 \0034T \0034,4 " +
+        "\0031A \0031,1\0038\273\0031,9 OrA NuOvO ErOtIcI Su FFTXL\0030,13 #CrAzY_MaNiCoMiCuM:\0032,4 QuI ReGnAnO PeR OrA I + PaZZi DeL WeB, " +
+        "\0031,8TuTTi AnCoRa In PRoVa..\0034M\00307w\00308a\00303H\00311u\0031 \0031,9PrEpArAtE Le RiChIeStE PeR Il RiCoVeRo a ViTa\0030,13PoStI " +
+        "LiBeRi!!\0031,4!PaZZi Da STaRe InSiEmE. :\336")
+    assert_equal 'irc.somehost.xx', event.from
+    assert_equal :incoming_322, event.type
+    assert_equal :incoming_numeric, event.parent.type
+    assert_equal 'user', event.target
+    assert_equal ['#CrAzY_MaNiCoMiCuM', '12'], event.parameters[0..1]
+    assert event.server?
+    assert_equal "#CrAzY_MaNiCoMiCuM 12 [+ntr] \253'\002\0033,3 \0030 I \0030,0 \0034T \0034,4 \0031A \0031,1\0038\273\0031,9 OrA NuOvO " +
+        "ErOtIcI Su FFTXL\0030,13 #CrAzY_MaNiCoMiCuM:\0032,4 QuI ReGnAnO PeR OrA I + PaZZi DeL WeB, \0031,8TuTTi AnCoRa In PRoVa..\0034M" +
+        "\00307w\00308a\00303H\00311u\0031 \0031,9PrEpArAtE Le RiChIeStE PeR Il RiCoVeRo a ViTa\0030,13PoStI LiBeRi!!\0031,4!PaZZi Da " +
+        "STaRe InSiEmE. :\336", event.text
   end
 
   # Test an invite

data/tests/tc_yail.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + "/net_yail"
+require File.dirname(__FILE__) + "/mock_irc"
+require "test/unit"
+
+# This test suite is built as an attempt to validate basic functionality in YAIL.  Due to the
+# threading of the library, things are going to be... weird.  Good luck, me.
+class YailSessionTest < Test::Unit::TestCase
+  def setup
+    @mockirc = MockIRC.new
+    @log = Logger.new($stderr)
+    @log.level = Logger::WARN
+    @yail = Net::YAIL.new(
+      :io => @mockirc, :address => "fake-irc.nerdbucket.com", :log => @log,
+      :nicknames => ["Bot"], :realname => "Net::YAIL", :username => "Username"
+    )
+  end
+
+  # Sets up all our handlers the legacy way - allows testing that things work as they used to
+  def setup_legacy_handling
+    ###
+    # Simple counters for basic testing of successful handler registration
+    ###
+
+    @msg = Hash.new(0)
+    @yail.prepend_handler(:incoming_welcome)        { |text, args|                          @msg[:welcome] += 1 }
+    @yail.prepend_handler(:incoming_endofmotd)      { |text, args|                          @msg[:endofmotd] += 1 }
+    @yail.prepend_handler(:incoming_notice)         { |f, actor, target, text|              @msg[:notice] += 1 }
+    @yail.prepend_handler(:incoming_nick)           { |f, actor, nick|                      @msg[:nick] += 1 }
+    @yail.prepend_handler(:incoming_bannedfromchan) { |text, args|                          @msg[:bannedfromchan] += 1 }
+    @yail.prepend_handler(:incoming_join)           { |f, actor, target|                    @msg[:join] += 1 }
+    @yail.prepend_handler(:incoming_mode)           { |f, actor, target, modes, objects|    @msg[:mode] += 1 }
+    @yail.prepend_handler(:incoming_msg)            { |f, actor, target, text|              @msg[:msg] += 1 }
+    @yail.prepend_handler(:incoming_act)            { |f, actor, target, text|              @msg[:act] += 1 }
+    @yail.prepend_handler(:incoming_ctcp)           { |f, actor, target, text|              @msg[:ctcp] += 1 }
+    @yail.prepend_handler(:incoming_ping)           { |text|                                @msg[:ping] += 1 }
+    @yail.prepend_handler(:incoming_quit)           { |f, actor, text|                      @msg[:quit] += 1 }
+    @yail.prepend_handler(:outgoing_mode)           { |target, modes, objects|              @msg[:o_mode] += 1 }
+    @yail.prepend_handler(:outgoing_join)           { |channel, pass|                       @msg[:o_join] += 1 }
+
+    ###
+    # More complex handlers to test parsing of messages
+    ###
+
+    # Channels list helps us test joins
+    @channels = []
+    @yail.prepend_handler(:incoming_join) do |fullactor, actor, target|
+      @channels.push(target) if @yail.me == actor
+    end
+
+    # Gotta store extra info on notices to test event parsing
+    @notices = []
+    @yail.prepend_handler(:incoming_notice) do |f, actor, target, text|
+      @notices.push({:server => f, :nick => actor, :target => target, :text => text})
+    end
+
+    @yail.prepend_handler(:incoming_ping) { |text| @ping_message = text }
+    @yail.prepend_handler(:incoming_quit) { |f, actor, text| @quit = {:full => f, :nick => actor, :text => text} }
+    @yail.prepend_handler(:outgoing_join) {|channel, pass| @out_join = {:channel => channel, :password => pass} }
+    @yail.prepend_handler(:incoming_msg) {|f, actor, channel, text| @privmsg = {:channel => channel, :nick => actor, :text => text} }
+    @yail.prepend_handler(:incoming_ctcp) {|f, actor, channel, text| @ctcp = {:channel => channel, :nick => actor, :text => text} }
+    @yail.prepend_handler(:incoming_act) {|f, actor, channel, text| @act = {:channel => channel, :nick => actor, :text => text} }
+  end
+
+  # Waits until the mock IRC reports it has no more output - i.e., we've read everything available
+  def wait_for_irc
+    while @mockirc.ready?
+      sleep 0.05
+    end
+
+    # For safety, we need to wait yet again to be sure YAIL has processed the data it read.
+    # This is hacky, but it decreases random failures quite a bit
+    sleep 0.1
+  end
+
+  # Log in to fake server, do stuff, see that basic handling and such are working.  For simplicity,
+  # this will be the all-encompassing "everything" test for legacy handling
+  def test_legacy
+    # Set up legacy handlers
+    setup_legacy_handling
+
+    common_tests
+  end
+
+  # Resets the messages hash, mocks the IRC server to send string to us, waits for the response, yields to the block
+  def mock_message(string)
+    @msg = Hash.new(0)
+    @mockirc.add_output string
+    wait_for_irc
+    yield
+  end
+
+  # Runs basic tests, verifying that we get expected results from a mocked session.  Handlers set
+  # via legacy prepend_handler should be just the same as new handler system.
+  def common_tests
+    @yail.start_listening
+
+    # Wait until all data has been read and check messages
+    wait_for_irc
+    assert_equal 1, @msg[:welcome]
+    assert_equal 1, @msg[:endofmotd]
+    assert_equal 2, @msg[:notice]
+
+    # Intense notice test - make sure all events were properly translated
+    assert_equal ['fakeirc.org', 'fakeirc.org'], @notices.collect {|n| n[:server]}
+    assert_equal ['', ''], @notices.collect {|n| n[:nick]}
+    assert_equal ['AUTH', 'Bot'], @notices.collect {|n| n[:target]}
+    assert_match %r|looking up your host|i, @notices.first[:text]
+    assert_match %r|you are exempt|i, @notices.last[:text]
+
+    # Test magic methods that set up the bot
+    assert_equal "Bot", @yail.me, "Should have set @yail.me automatically on welcome handler"
+    assert_equal 1, @msg[:o_mode], "Should have auto-sent mode +i"
+
+    # Make sure nick change works
+    @yail.nick "Foo"
+    wait_for_irc
+    assert_equal "Foo", @yail.me, "Should have set @yail.me on explicit nick change"
+
+    # Join a channel where we've been banned
+    @yail.join("#banned")
+    wait_for_irc
+    assert_equal 1, @msg[:bannedfromchan]
+    assert_equal "#banned", @out_join[:channel]
+    assert_equal "", @out_join[:password]
+    assert_equal [], @channels
+
+    # Join some other channel
+    @yail.join("#foosball", "pass")
+    wait_for_irc
+    assert_equal "#foosball", @out_join[:channel]
+    assert_equal "pass", @out_join[:password]
+    assert_equal ['#foosball'], @channels
+
+    # Mock some chatter to verify PRIVMSG info
+    mock_message ":Nerdmaster!nerd@nerdbucket.com PRIVMSG #foosball :#{@yail.me}: Welcome!" do
+      assert_equal 1, @msg[:msg]
+      assert_equal 0, @msg[:act]
+      assert_equal 0, @msg[:ctcp]
+
+      assert_equal "Nerdmaster", @privmsg[:nick]
+      assert_equal "#foosball", @privmsg[:channel]
+      assert_equal "#{@yail.me}: Welcome!", @privmsg[:text]
+    end
+
+    # CTCP
+    mock_message ":Nerdmaster!nerd@nerdbucket.com PRIVMSG #foosball :\001CTCP THING\001" do
+      assert_equal 0, @msg[:msg]
+      assert_equal 0, @msg[:act]
+      assert_equal 1, @msg[:ctcp]
+
+      assert_equal "Nerdmaster", @ctcp[:nick]
+      assert_equal "#foosball", @ctcp[:channel]
+      assert_equal "CTCP THING", @ctcp[:text]
+    end
+
+    # ACT
+    mock_message ":Nerdmaster!nerd@nerdbucket.com PRIVMSG #foosball :\001ACTION vomits on you\001" do
+      assert_equal 0, @msg[:msg]
+      assert_equal 1, @msg[:act]
+      assert_equal 0, @msg[:ctcp]
+
+      assert_equal "Nerdmaster", @act[:nick]
+      assert_equal "#foosball", @act[:channel]
+      assert_equal "vomits on you", @act[:text]
+    end
+
+    # PING
+    mock_message "PING boo" do
+      assert_equal 1, @msg[:ping]
+      assert_equal 'boo', @ping_message
+    end
+
+    # User quits
+    mock_message ":Nerdmaster!nerd@nerdbucket.com QUIT :Quit: Bye byes" do
+      assert_equal 1, @msg[:quit]
+      assert_equal 'Nerdmaster!nerd@nerdbucket.com', @quit[:full]
+      assert_equal 'Nerdmaster', @quit[:nick]
+      assert_equal 'Quit: Bye byes', @quit[:text]
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: net-yail
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
   - 1
   - 4
-  - 3
-  version: 1.4.3
+  - 4
+  version: 1.4.4
 platform: ruby
 authors: 
 - Jeremy Echols
@@ -14,7 +15,7 @@ autorequire: net/yail
 bindir: bin
 cert_chain: []
 
-date: 2010-09-20 00:00:00 -04:00
+date: 2011-03-22 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -44,6 +45,8 @@ files:
 - tests/net_yail.rb
 - tests/tc_message_parser.rb
 - tests/tc_event.rb
+- tests/tc_yail.rb
+- tests/mock_irc.rb
 - YAIL-RDOC
 has_rdoc: true
 homepage: http://ruby-irc-yail.nerdbucket.com/
@@ -60,6 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -68,6 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -82,3 +87,5 @@ test_files:
 - tests/net_yail.rb
 - tests/tc_message_parser.rb
 - tests/tc_event.rb
+- tests/tc_yail.rb
+- tests/mock_irc.rb