ircguerilla-irc 1.1.0 → 1.2.0

data/lib/irc/client/connected_state.rb

@@ -70,16 +70,6 @@ module IRC
         
       end 
       
-      # Sends the command to the server bypassing the command queue.      
-      def send_command(context, command)
-        context.command_handler.send_command(command)
-      end
-      
-      # Sends the command to the server using the command queue.      
-      def send_command_via_queue(context, command)
-        context.command_handler.send_command_via_queue(command)  
-      end        
-      
       # ConnectionListener
       
       # This method gets called when disconnected from a server.
@@ -87,6 +77,11 @@ module IRC
         log.debug("#{network_name(connection)} Successfully disconnected from #{server}. #{reason != nil ? reason + '.' : ''}")      
       end
       
+      # This method gets called when a ping message was received from the server.
+      def on_ping(connection, servers)
+        IRC::Commands::PongCommand.new(servers[0], servers[1]).execute(connection)
+      end      
+      
       
     end
     

data/lib/irc/client/connection_listener.rb

@@ -23,8 +23,6 @@
 #
 # $Id: connection_listener.rb 90 2006-08-13 14:45:04Z roman $
 # 
-require 'irc/commands/pong_command'
-require 'irc/models/server'
 require 'log4r'
 
 module IRC

data/lib/irc/client/connection_state.rb

@@ -57,10 +57,12 @@ module IRC
 
       # Sends the command to the server bypassing the command queue.      
       def send_command(context, command)
+        context.command_handler.send_command(command)      
       end
       
       # Sends the command to the server using the command queue.      
       def send_command_via_queue(context, command)
+        context.command_handler.send_command_via_queue(command)            
       end
       
       # ConnectionListener

data/lib/irc/client/context.rb

@@ -209,7 +209,7 @@ module IRC
         
         # Sends the command to the server bypassing the command queue.      
         def send_command(command)
-          state.send_command(self, command)
+          state.send_command(self, command)          
         end
 
         # Sends the command to the server using the command queue.      

data/lib/irc/client/message_handler.rb

@@ -51,7 +51,7 @@ module IRC
           loop do
             
             # Read the raw message from the socket.
-            raw_message = @context.socket.gets("\r\n")
+            raw_message = socket.gets("\r\n")
             
             # Log the raw message.
             @log.debug("[#{@context.network.to_s.upcase}] <<< #{raw_message.chomp}")
@@ -80,6 +80,12 @@ module IRC
         
       end
       
+      private
+      
+      def socket
+        return @context.socket
+      end
+      
     end
     
   end

data/lib/irc/client/registered_state.rb

@@ -46,12 +46,12 @@ module IRC
       
       # Joins the given channels.
       def join(context, channels)
-        IRC::Commands::JoinCommand.new(channels).send(context)
+        IRC::Commands::JoinCommand.new(channels).execute(context)
       end
       
       # Leaves the given channels.
       def part(context, channels)
-        IRC::Commands::PartCommand.new(channels).send(context)      
+        IRC::Commands::PartCommand.new(channels).execute(context)      
       end      
       
       # ConnectionListener

data/lib/irc/client/unregistered_state.rb

@@ -27,6 +27,9 @@ require 'irc/client/client_error'
 require 'irc/client/connected_state'
 require 'irc/client/registered_state'
 require 'irc/messages/error_message'
+require 'irc/commands/nick_command'
+require 'irc/messages/notice_message'
+require 'irc/commands/user_command'
 require 'log4r'
 
 module IRC
@@ -58,40 +61,42 @@ module IRC
       
       # This method gets called when a message from the server is received.
       def on_server_response(context, message)
-          
-        # The given nick name is not valid.  
-        if message.instance_of?(IRC::Messages::ErrorErroneusNickNameMessage)
-          registration_failure(context, message)               
-                  
-        # We didn't send a valid command. There are some parameters missing.       
-        elsif message.instance_of?(IRC::Messages::ErrorNeedMoreParametersMessage)            
-          registration_failure(context, message)     
-          
-        # Nick name collision.  
-        elsif message.instance_of?(IRC::Messages::ErrorNickCollisionMessage)
-          registration_failure(context, message)                        
-          
-        # The chosen nick name is already in use.  
-        elsif message.instance_of?(IRC::Messages::ErrorNickNameInUseMessage)
-          registration_failure(context, message)            
-          
-        # We didn't send a valid nick command. The nick name was missing.
-        elsif message.instance_of?(IRC::Messages::ErrorNoNickNameGivenMessage)
-          registration_failure(context, message)       
+            
+        case message.code
         
-        # Ignore notice messages.
-        elsif message.instance_of?(IRC::Messages::NoticeMessage)  
-          return
-
-        # We are already registered. Did we miss something?      
-        elsif message.instance_of?(IRC::Messages::ErrorAlreadyRegisteredMessage)  
-          change_state(context, RegisteredState.instance)
+          # Ignore notice messages.
+          when IRC::Messages::NoticeMessage::CODE
+            return
                   
-        # Everything ok. Change to the registered state.  
-        else
-          change_state(context, RegisteredState.instance)
-          
-        end
+          # The given nick name is not valid.  
+          when IRC::Messages::ErrorErroneusNickNameMessage::CODE
+            registration_failure(context, message)               
+                    
+          # We didn't send a valid command. There are some parameters missing.       
+          when IRC::Messages::ErrorNeedMoreParametersMessage::CODE
+            registration_failure(context, message)     
+            
+          # Nick name collision.  
+          when IRC::Messages::ErrorNickCollisionMessage::CODE
+            registration_failure(context, message)                        
+            
+          # The chosen nick name is already in use.  
+          when IRC::Messages::ErrorNickNameInUseMessage::CODE
+            registration_failure(context, message)            
+            
+          # We didn't send a valid nick command. The nick name was missing.
+          when IRC::Messages::ErrorNoNickNameGivenMessage::CODE
+            registration_failure(context, message)       
+  
+          # We are already registered. Did we miss something?      
+          when IRC::Messages::ErrorAlreadyRegisteredMessage::CODE
+            change_state(context, RegisteredState.instance)
+                    
+          # Everything ok. Change to the registered state.  
+          else
+            change_state(context, RegisteredState.instance)
+            
+          end
       
       end     
       
@@ -103,6 +108,9 @@ module IRC
         context.connection_listeners.each do |connection_listener|
           connection_listener.on_registration_failure(context, message)
         end
+        
+        IRC::Commands::NickCommand.new("au_lasa").execute(context)
+        IRC::Commands::UserCommand.new("au_lasa", Socket.gethostname, server.hostname, context.realname).execute(context)
       
       end
       

data/lib/irc/commands/command.rb

@@ -23,15 +23,23 @@
 #
 # $Id: command.rb 85 2006-08-13 11:42:07Z roman $
 # 
+require 'irc/client/connection_listener'
 require 'irc/commands/invalid_command'
+require 'monitor'
 
 module IRC
   
   module Commands
     
-    class Command
+    class Command < Monitor
+      
+      include IRC::Client::ConnectionListener
+
+      # The message that was sent by the IRC server as a response to the execution of the command.      
+      attr_reader :response
     
       def initialize(raw_command = "")
+        super()
         @raw_command = raw_command
       end
     
@@ -40,15 +48,65 @@ module IRC
         return @raw_command
       end
       
-      # Sends the command to the io object.
-      def send(io)
-        io << self
+      # Execute the command. The method registers the command as an connection listener
+      # at the connection object and sends the command. The method returns the command.
+      def execute(connection)
+      
+        # Register the command as a connection listener, so we can receive response messages
+        # from the server.
+        connection.add_connection_listener(self)
+        
+        # Send the message.
+        connection << self
+        
+        # Create a conditinal monitor variable.
+        self.synchronize do
+          @response_received ||= self.new_cond
+        end
+        
+        return self
+        
       end
       
       # Returns the command as a string.
       def to_s
         return command
       end
+      
+      # Returns true, if the message is a valid response to the command. This method should get 
+      # overriddn in subclasses. For this class every response is valid.
+      def valid_response?(message)
+        return true
+      end
+      
+      # Waits until a response for the command was sent by the IRC server. This method expects, 
+      # that the command has already been sent to the server by the execute method. A call to 
+      # this method blocks until a response was reseived from the server.
+      def wait
+      
+        # If the command has not been sent, or a response was already received. a
+        # call to this method doesn't make any sense.
+        raise Exception.new("Can't wait for response. The command was not send yet, or a response was already received.") if @response_received == nil
+        
+        # Wait until a response was received from the server.
+        synchronize do
+          @response_received.wait_until { response != nil }
+        end
+        
+      end
+      
+      # CONNECTION LISTENER
+      
+      # This method gets called when a message from the server is received. This method should be 
+      # overridden in subclasses to handle the command specific response messages from the server.
+      def on_server_response(connection, message)
+        
+        if valid_response?(message)
+          connection.remove_connection_listener(self)
+          @response = message
+        end
+        
+      end
   
     end
     

data/lib/irc/commands/join_command.rb

@@ -25,6 +25,7 @@
 # 
 require 'irc/commands/command'
 require 'irc/commands/invalid_command'
+require 'irc/messages/codes'
 
 module IRC
   
@@ -109,12 +110,26 @@ module IRC
           @passwords << passwords
         end
         
+        super(command)      
+                
       end
       
       def command 
         return "JOIN #{channels.join(',')} #{passwords.join(',')}".strip
       end
       
+      # Returns true, if the message is a valid response to the command. 
+      def valid_response?(message)
+
+        valid_reponse_codes = [IRC::Messages::Codes::ERR_NEEDMOREPARAMS, IRC::Messages::Codes::ERR_BANNEDFROMCHAN, 
+          IRC::Messages::Codes::ERR_INVITEONLYCHAN, IRC::Messages::Codes::ERR_BADCHANNELKEY, IRC::Messages::Codes::ERR_CHANNELISFULL, 	
+          IRC::Messages::Codes::ERR_BADCHANMASK, IRC::Messages::Codes::ERR_NOSUCHCHANNEL, IRC::Messages::Codes::ERR_TOOMANYCHANNELS,
+          IRC::Messages::Codes::RPL_TOPIC]
+          
+        return valid_reponse_codes.include?(message.code)
+
+      end
+      
     end      
     
   end

data/lib/irc/commands/nick_command.rb

@@ -73,6 +73,7 @@ module IRC
         raise InvalidCommand.new("Can't create nick command. No nick name.") unless nick
         @nick = nick
         @hopcount = hopcount
+        super(command)              
       end
       
       def command

data/lib/irc/commands/part_command.rb

@@ -71,6 +71,8 @@ module IRC
                   
         end
         
+        super(command)              
+        
       end
       
       def command 

data/lib/irc/commands/password_command.rb

@@ -59,6 +59,7 @@ module IRC
       def initialize(password)
         raise InvalidCommand.new("Can't create password command. No password.") unless password
         @password = password
+        super(command)              
       end
       
       def command 

data/lib/irc/commands/ping_command.rb

@@ -25,6 +25,8 @@
 # 
 require 'irc/commands/command'
 require 'irc/commands/invalid_command'
+require 'irc/messages/error_message'
+require 'irc/messages/pong_message'
 
 module IRC
   
@@ -66,12 +68,29 @@ module IRC
       def initialize(first_server, second_server = nil)
         raise InvalidCommand.new("Can't create ping command. No server.") unless first_server
         @first_server, @second_server = first_server, second_server
+        super(command)              
       end
       
+      # Returns the command as a string.
       def command
         return "PING #{first_server} #{second_server != nil ? second_server.to_s : ''}".strip
       end
       
+      # Returns true, if the message is a valid response to the command.
+      def valid_response?(message)
+      
+        if message.kind_of?(IRC::Messages::PongMessage)
+          return first_server == message.daemons[0] && second_server == message.daemons[1]
+          
+        elsif message.kind_of?(IRC::Messages::ErrorNoOriginMessage) || message.kind_of?(IRC::Messages::ErrorNoSuchServerMessage)
+          return true
+          
+        end      
+        
+        return false
+        
+      end
+      
     end      
   
   end

data/lib/irc/commands/pong_command.rb

@@ -32,7 +32,7 @@ module IRC
     
     # 4.6.3 Pong message
     # 
-    # Command: 	PONG
+    # Command: 	    PONG
     # Parameters: 	<daemon> [<daemon2>]
     # 
     # PONG message is a reply to ping message. If parameter <daemon2> is given this message must 
@@ -53,8 +53,11 @@ module IRC
       attr_reader :second_daemon      
       
       def initialize(first_daemon, second_daemon = nil)
+
         raise InvalidCommand.new("Can't create ping command. No daemon.") unless first_daemon
         @first_daemon, @second_daemon = first_daemon, second_daemon
+        super(command)              
+        
       end
       
       def command

data/lib/irc/commands/quit_command.rb

@@ -62,8 +62,12 @@ module IRC
       attr_reader :message
       
       def initialize(message)
+        
         raise InvalidCommand.new("Can't create quit command. No quit message.") unless message
         @message = message
+        
+        super(command)      
+                
       end
       
       def command 

data/lib/irc/commands/user_command.rb

@@ -58,8 +58,8 @@ module IRC
     # 
     # Numeric Replies:
     # 
-    # ERR_NEEDMOREPARAMS 	
-    # ERR_ALREADYREGISTRED
+    # * ERR_NEEDMOREPARAMS 	
+    # * ERR_ALREADYREGISTRED
     # 
     # Examples:
     # 
@@ -80,18 +80,20 @@ module IRC
       
       def initialize(user, host, server, realname)
 
-        raise InvalidCommand.new("Can't create user command. No user name.") unless user
+        raise InvalidCommand.new("Can't create user command. User name is missing.") unless user
         @user = user
         
-        raise InvalidCommand.new("Can't create user command. No host.") unless host        
+        raise InvalidCommand.new("Can't create user command. Host is missing.") unless host        
         @host = host
         
-        raise InvalidCommand.new("Can't create user command. No server.") unless server        
+        raise InvalidCommand.new("Can't create user command. Server is missing.") unless server        
         @server = server
         
-        raise InvalidCommand.new("Can't create user command. No real name.") unless realname        
+        raise InvalidCommand.new("Can't create user command. Real name is missing.") unless realname        
         @realname = realname
-        
+
+        super(command)      
+                
       end
       
       def command 

data/lib/irc/messages/error_message.rb

@@ -77,17 +77,25 @@ module IRC
     end      
 
     class ErrorNickNameInUseMessage < ErrorMessage
-      CODE = ERR_ERRONEUSNICKNAME
+      CODE = ERR_NICKNAMEINUSE
     end      
     
     class ErrorNoNickNameGivenMessage < ErrorMessage
       CODE = ERR_NONICKNAMEGIVEN
     end      
     
+    class ErrorNoOriginMessage < ErrorMessage
+      CODE = ERR_NOORIGIN
+    end
+    
     class ErrorNoSuchChannelMessage < ErrorJoinMessage
       CODE = ERR_NOSUCHCHANNEL
     end      
     
+    class ErrorNoSuchServerMessage < ErrorMessage
+      CODE = ERR_NOSUCHSERVER
+    end      
+    
     class ErrorNotOnChannelMessage < ErrorMessage
       CODE = ERR_NOTONCHANNEL
     end 

data/lib/irc/messages/factory.rb

@@ -31,6 +31,7 @@ require 'irc/messages/notice_message'
 require 'irc/messages/part_message'
 require 'irc/messages/ping_message'
 require 'irc/messages/pong_message'
+require 'irc/messages/private_message'
 
 module IRC
   
@@ -81,9 +82,15 @@ module IRC
 
         when ErrorNoNickNameGivenMessage::CODE
           return ErrorNoNickNameGivenMessage.new(raw_message)
+        
+        when ErrorNoOriginMessage::CODE
+          return ErrorNoOriginMessage.new(raw_message)
           
         when ErrorNoSuchChannelMessage::CODE
           return ErrorNoSuchChannelMessage.new(raw_message)
+        
+        when ErrorNoSuchServerMessage::CODE
+          return ErrorNoSuchServerMessage.new(raw_message)
           
         when ErrorNotOnChannelMessage::CODE
           return ErrorNotOnChannelMessage.new(raw_message)          
@@ -108,6 +115,9 @@ module IRC
 
         when PongMessage::CODE
           return PongMessage.new(raw_message)          
+
+        when PrivateMessage::CODE
+          return PrivateMessage.new(raw_message)
           
         end
         

data/lib/irc/messages/message.rb

@@ -96,7 +96,10 @@ module IRC
         @host = match_data[6]        
 
         # Extract the IRC message code. If the code is a number, convert it to an integer.
-        @code = (match_data[7] =~ /\d+/ ? match_data[7].to_i : match_data[7])
+        @code = (match_data[7].match(/\d+/) ? match_data[7].to_i : match_data[7])
+  
+#        puts @code
+#        puts @code.class
       
         # Extract the rest of the message. The message is everything after the IRC message code.
         @message = match_data[8]

data/lib/irc/messages/pong_message.rb

@@ -75,7 +75,7 @@ module IRC
 
         # Extract the message specific fields.
         match_data = Regexp.new(':?([^\s:]+)(\s+:?(.+))?').match(message)
-        raise InvalidMessage.new("Can't parse ping message. Invalid message format.") if match_data == nil || code != CODE
+        raise InvalidMessage.new("Can't parse pong message. Invalid message format.") if match_data == nil || code != CODE
 
         # Extract the servers and strip white spaces.
         @daemons = [match_data[1], match_data[3]].compact.map! { |element| element.strip }

data/test/functional/irc/client/connection_test.rb

@@ -42,7 +42,7 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     # Initialize the network, channel & server that is used for testing.
     network = IRC::Models::Network.new(:name => "Efnet")
     @channel = network.create_channel("#MP3_RAP_N_REGGAE")
-    @server = network.create_server("irc.efnet.net")
+    @server = network.create_server("irc.efnet.pl")
     
     # Initialize the connection connection.
     @connection = IRC::Client::Connection::Context.new("fumanshu")
@@ -58,20 +58,17 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     Timeout::timeout(IRC::Client::Connection::MAX_CONNECTION_TIMEOUT_IN_SEC) do
       @connection.connect(@server)    
       while !@connection.connected? do sleep 0.1; end
-      assert @connection.connected?
     end
     
     # Wait until the connection is registered.
     Timeout::timeout(5) do
       while !@connection.registered? do sleep 0.1; end
-      assert @connection.registered?
     end
     
     # Disconnect and wait until the connection is in the disconnected state.
     Timeout::timeout(5) do
       @connection.disconnect
       while @connection.connected? do sleep 0.1; end      
-      assert !@connection.connected?      
     end
     
   end
@@ -85,13 +82,11 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     Timeout::timeout(IRC::Client::Connection::MAX_CONNECTION_TIMEOUT_IN_SEC) do
       @connection.connect(@server)    
       while !@connection.connected? do sleep 0.1; end
-      assert @connection.connected?
     end
     
     # Wait until the connection is registered.
     Timeout::timeout(5) do
       while !@connection.registered? do sleep 0.1; end
-      assert @connection.registered?
     end
     
     # Join a channel & wait until the channel is joined and the block was called.
@@ -110,7 +105,6 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     Timeout::timeout(5) do
       @connection.disconnect
       while @connection.connected? do sleep 0.1; end      
-      assert !@connection.connected?      
     end
   
   end  

data/test/functional/irc/client/context_test.rb

@@ -42,7 +42,7 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
     # Initialize the network, channel & server that is used for testing.
     network = IRC::Models::Network.new(:name => "Efnet")
     @channel = network.create_channel("#ircguerilla")
-    @server = network.create_server("irc.efnet.net")
+    @server = network.create_server("irc.efnet.pl")
     
     # Initialize the connection context.
     @context = IRC::Client::Connection::Context.new("fumanshu")
@@ -60,8 +60,7 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
     # Connect to the server and wait until the context is in the unregistered state.
     Timeout::timeout(IRC::Client::Connection::MAX_CONNECTION_TIMEOUT_IN_SEC) do
       @context.connect(@server)    
-      while @context.state.instance_of?(IRC::Client::DisconnectedState) do sleep 0.1; end
-      assert @context.state.instance_of?(IRC::Client::UnregisteredState)
+      while !@context.connected? do sleep 0.1; end
     end
     
     # The context should be connected now.
@@ -69,17 +68,13 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
 
     # Wait until the connection is registered.
     Timeout::timeout(5) do
-      while @context.state.instance_of?(IRC::Client::UnregisteredState) do sleep 0.1; end
-      assert @context.state.instance_of?(IRC::Client::RegisteredState)
+      while !@context.registered? do sleep 0.1; end
     end
-    
-    IRC::Commands::Command.new("JOIN a").send(@context)
-    sleep 5
 
     # Disconnect and wait until the context is in the disconnected state.
     Timeout::timeout(5) do
       @context.disconnect
-      assert @context.state.instance_of?(IRC::Client::DisconnectedState)
+      while @context.connected? do sleep 0.1; end
     end
 
   end
@@ -92,14 +87,12 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
     # Connect to the server and wait until the context is in the unregistered state.
     Timeout::timeout(IRC::Client::Connection::MAX_CONNECTION_TIMEOUT_IN_SEC) do
       @context.connect(@server)    
-      while @context.state.instance_of?(IRC::Client::DisconnectedState) do sleep 0.1; end
-      assert @context.state.instance_of?(IRC::Client::UnregisteredState)
+      while !@context.connected? do sleep 0.1; end
     end
 
     # Wait until the connection is registered.
     Timeout::timeout(5) do
-      while @context.state.instance_of?(IRC::Client::UnregisteredState) do sleep 0.1; end
-      assert @context.state.instance_of?(IRC::Client::RegisteredState)
+      while !@context.registered? do sleep 0.1; end
     end
     
     # Join a channel & wait until the channel is joined and the block was called.
@@ -117,10 +110,11 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
     # Disconnect and wait until the context is in the disconnected state.
     Timeout::timeout(5) do
       @context.disconnect
-      assert @context.state.instance_of?(IRC::Client::DisconnectedState)
+      while @context.connected? do sleep 0.1; end
     end
 
   end
   
-  
+    def test_truth
+    end
 end

data/test/unit/irc/commands/command_test.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+# 
+# Copyright (c) 2006 Roman Scherer | IRC Guerilla | Rapid Packet Movement
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# $Id$
+# 
+require 'irc/client/connection_listener'
+require 'irc/commands/command'
+require 'irc/messages/nick_message'
+require 'timeout'
+require 'test/unit'
+
+class IRC::Commands::CommandTest < Test::Unit::TestCase
+
+  include IRC::Client::ConnectionListener
+  
+  class ConnectionMock
+    
+    attr_reader :commands
+    attr_reader :connection_listeners
+    
+    def initialize
+      @commands = StringIO.new
+      @connection_listeners = Array.new
+    end
+    
+    # Saves the command for later inspection in a string io object.
+    def <<(command)
+      @commands<<(command)
+    end
+    
+    # Adds a new connection listener. The connection listener gets notified when a 
+    # message was received from the IRC server.
+    def add_connection_listener(connection_listener)
+      connection_listeners << connection_listener unless connection_listeners.include?(connection_listener)
+    end    
+    
+    # Removes a previously added connection listener. The connection listener will not
+    # get notified any longer when a message was received from the IRC server.
+    def remove_connection_listener(connection_listener)
+      connection_listeners.delete(connection_listener)
+    end
+    
+  end
+  
+  def test_command
+    command = IRC::Commands::Command.new("NICK Wiz")
+    assert_equal "NICK Wiz", command.command
+  end
+  
+  def test_execute
+  
+    # The connection mock.
+    connection = ConnectionMock.new
+    
+    # Construct and execute the nick message.
+    command = IRC::Commands::Command.new("NICK Wiz")
+    command.execute(connection)
+    
+    # The command should be registered as a connection listener.
+    assert connection.connection_listeners.include?(command)
+    
+    # Send the response message.
+    command.on_server_response(connection, IRC::Messages::NickMessage.new(":WiZ NICK Kilroy"))
+
+    # Should return immediately.
+    command.wait
+
+    # The command should no longer be registered as a connection listener.
+    assert !connection.connection_listeners.include?(command)
+    
+    # The command should be available at the connection object.
+    connection.commands.rewind
+    assert_equal command.command, connection.commands.readline
+  
+  end
+
+  def test_to_s
+    command = IRC::Commands::Command.new("NICK Wiz")
+    assert_equal "NICK Wiz", command.to_s
+  end  
+  
+  def test_wait
+  
+    # The connection mock.
+    connection = ConnectionMock.new
+    
+    # Construct and execute the nick message.
+    command = IRC::Commands::Command.new("NICK Wiz")
+    command.execute(connection)
+        
+    # The command should be registered as a connection listener.
+    assert connection.connection_listeners.include?(command)
+    
+    # The wait method should block until a response was received. Because the VALID response
+    # hasn't been received yet this method should block forever. 
+    assert_raise(Timeout::Error) do
+      Timeout::timeout(0.1) { command.wait }
+    end
+    
+    # Send the response message.
+    command.on_server_response(connection, IRC::Messages::NickMessage.new(":WiZ NICK Kilroy"))
+    
+    # Now the methos shouldn't block anymore.
+    Timeout::timeout(0.1) do
+      command.wait 
+    end
+
+    # The command should no longer be registered as a connection listener.
+    assert !connection.connection_listeners.include?(command)
+    
+    # The command should be available at the connection object.
+    connection.commands.rewind
+    assert_equal command.command, connection.commands.readline
+  
+  end
+  
+end

data/test/unit/irc/commands/ping_command_test.rb

@@ -23,14 +23,144 @@
 #
 # $Id: ping_command_test.rb 85 2006-08-13 11:42:07Z roman $
 # 
+require 'irc/commands/command_test'
 require 'irc/commands/ping_command'
+require 'irc/messages/pong_message'
 require 'test/unit'
 
-class IRC::Commands::PingCommandTest < Test::Unit::TestCase
+class IRC::Commands::PingCommandTest < IRC::Commands::CommandTest
 
   def test_command
     assert_equal "PING WiZ", IRC::Commands::PingCommand.new("WiZ").command
     assert_equal "PING WiZ irc.efnet.pl", IRC::Commands::PingCommand.new("WiZ", "irc.efnet.pl").command    
   end
   
+  def test_execute
+  
+    # The connection mock.
+    connection = ConnectionMock.new
+    
+    # Construct and execute the nick message.
+    command = IRC::Commands::PingCommand.new("tolsun.oulu.fi")
+    command.execute(connection)
+    
+    # The command should be registered as a connection listener.
+    assert connection.connection_listeners.include?(command)
+    
+    # Send the response message.
+    command.on_server_response(connection, IRC::Messages::PongMessage.new("PONG tolsun.oulu.fi"))
+
+    # Should return immediately.
+    command.wait
+    
+    # The command should no longer be registered as a connection listener.
+    assert !connection.connection_listeners.include?(command)
+    
+    # The command should be available at the connection object.
+    connection.commands.rewind
+    assert_equal command.command, connection.commands.readline
+  
+  end
+
+  def test_to_s
+    command = IRC::Commands::PingCommand.new("WiZ")
+    assert_equal "PING WiZ", command.to_s
+  end  
+  
+  def test_wait_for_pong
+  
+    # The connection mock.
+    connection = ConnectionMock.new
+    
+    # Construct and execute the nick message.
+    command = IRC::Commands::PingCommand.new("tolsun.oulu.fi")
+    command.execute(connection)
+    
+    # The command should be registered as a connection listener.
+    assert connection.connection_listeners.include?(command)
+    
+    # The wait method should block until a response was received. Because the VALID response
+    # hasn't been received yet this method should block forever. 
+    assert_raise(Timeout::Error) do
+      command.on_server_response(connection, IRC::Messages::NickMessage.new(":WiZ NICK Kilroy"))
+      Timeout::timeout(0.1) { command.wait }
+    end
+    
+    # Send the response message.
+    command.on_server_response(connection, IRC::Messages::PongMessage.new("PONG tolsun.oulu.fi"))
+    
+    # Now the methos shouldn't block anymore.
+    Timeout::timeout(0.1) do
+      command.wait 
+    end
+
+    # The command should no longer be registered as a connection listener.
+    assert !connection.connection_listeners.include?(command)
+  
+  end  
+  
+  def test_wait_for_error_no_origin
+  
+    # The connection mock.
+    connection = ConnectionMock.new
+    
+    # Construct and execute the nick message.
+    command = IRC::Commands::PingCommand.new("tolsun.oulu.fi")
+    command.execute(connection)
+    
+    # The command should be registered as a connection listener.
+    assert connection.connection_listeners.include?(command)
+    
+    # The wait method should block until a response was received. Because the VALID response
+    # hasn't been received yet this method should block forever. 
+    assert_raise(Timeout::Error) do
+      command.on_server_response(connection, IRC::Messages::ErrorMessage.new(":irc.easynews.com 4XX"))
+      Timeout::timeout(0.1) { command.wait }
+    end
+    
+    # Send the response message.
+    command.on_server_response(connection, IRC::Messages::ErrorNoOriginMessage.new(":irc.easynews.com 4XX"))
+    
+    # Now the methos shouldn't block anymore.
+    Timeout::timeout(0.1) do
+      command.wait 
+    end
+
+    # The command should no longer be registered as a connection listener.
+    assert !connection.connection_listeners.include?(command)
+  
+  end  
+  
+  def test_wait_for_error_no_such_server
+  
+    # The connection mock.
+    connection = ConnectionMock.new
+    
+    # Construct and execute the nick message.
+    command = IRC::Commands::PingCommand.new("tolsun.oulu.fi")
+    command.execute(connection)
+    
+    # The command should be registered as a connection listener.
+    assert connection.connection_listeners.include?(command)
+    
+    # The wait method should block until a response was received. Because the VALID response
+    # hasn't been received yet this method should block forever. 
+    assert_raise(Timeout::Error) do
+      command.on_server_response(connection, IRC::Messages::ErrorMessage.new(":irc.easynews.com 4XX"))
+      Timeout::timeout(0.1) { command.wait }
+    end
+    
+    # Send the response message.
+    command.on_server_response(connection, IRC::Messages::ErrorNoSuchServerMessage.new(":irc.easynews.com 4XX"))
+    
+    # Now the methos shouldn't block anymore.
+    Timeout::timeout(0.1) do
+      command.wait 
+    end
+
+    # The command should no longer be registered as a connection listener.
+    assert !connection.connection_listeners.include?(command)
+  
+  end  
+  
 end

data/test/unit/irc/messages/factory_test.rb

@@ -57,6 +57,10 @@ class IRC::Messages::FactoryTest < Test::Unit::TestCase
     message = IRC::Messages::Factory.create("PONG tolsun.oulu.fi")
     assert message.instance_of?(IRC::Messages::PongMessage)
   end
-  
+
+  def test_private_message
+    message = IRC::Messages::Factory.create(":Angel PRIVMSG Wiz :Hello are you receiving this message ?")
+    assert message.instance_of?(IRC::Messages::PrivateMessage)
+  end
   
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ircguerilla-irc
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2006-08-15 00:00:00 +02:00
+  version: 1.2.0
+date: 2006-08-20 00:00:00 +02:00
 summary: A Ruby framework for the Internet Relay Chat (IRC) protocol.
 require_paths: 
 - lib
@@ -70,8 +70,9 @@ files:
 - lib/irc/client/command_handler.rb
 test_files: 
 - test/test_helper.rb
-- test/unit/irc/commands/password_command_test.rb
 - test/unit/irc/commands/quit_command_test.rb
+- test/unit/irc/commands/command_test.rb
+- test/unit/irc/commands/password_command_test.rb
 - test/unit/irc/commands/pong_command_test.rb
 - test/unit/irc/commands/nick_command_test.rb
 - test/unit/irc/commands/part_command_test.rb