ircguerilla-irc 1.2.0 → 1.3.0

data/lib/irc/util/nick_generator.rb

@@ -0,0 +1,58 @@
+#!/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$
+# 
+module IRC
+  
+  module Util 
+    
+    class NickGenerator
+      
+      attr_reader :names
+      
+      def initialize(nick, nick_length = nil, max_nicks = 10)
+        
+        nick_length = !nick_length.nil? ? nick_length : nick.size + max_nicks.to_s.length 
+        
+        @names = Array.new
+        
+        1.upto(max_nicks) do |number|
+          @names << nick[0, nick_length - number.to_s.size] + number.to_s
+        end
+        
+      end
+      
+      def each
+        @names.each { |name| yield name }
+      end
+      
+      def pop
+        @names.pop
+      end
+      
+    end
+    
+  end
+  
+end  

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

@@ -45,7 +45,7 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     @server = network.create_server("irc.efnet.pl")
     
     # Initialize the connection connection.
-    @connection = IRC::Client::Connection::Context.new("fumanshu")
+    @connection = IRC::Client::Connection.new("fumanshu")
     
   end
   
@@ -62,6 +62,7 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     
     # Wait until the connection is registered.
     Timeout::timeout(5) do
+      @connection.register
       while !@connection.registered? do sleep 0.1; end
     end
     
@@ -73,6 +74,37 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     
   end
   
+  def test_nick_change
+  
+    # The connection shouldn't be connected now.
+    assert !@connection.connected?
+    
+    # Connect to the server and wait until the connection is in the unregistered state.
+    Timeout::timeout(IRC::Client::Connection::MAX_CONNECTION_TIMEOUT_IN_SEC) do
+      @connection.connect(@server)    
+      while !@connection.connected? do sleep 0.1; end
+    end
+    
+    # Wait until the connection is registered.
+    Timeout::timeout(5) do
+      @connection.register
+      while !@connection.registered? do sleep 0.1; end
+    end
+    
+    # Try to change the nick name & wait until changed.
+    Timeout::timeout(5) do
+      @connection.nick = "N1CKCHANGE"
+      while @connection.nick != "N1CKCHANGE"[0..@connection.nick.size-1] do sleep 0.1; end      
+    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      
+    end
+  
+  end
+  
   def test_join_and_part
     
     # The connection shouldn't be connected now.
@@ -86,6 +118,7 @@ class IRC::Client::ConnectionTest < Test::Unit::TestCase
     
     # Wait until the connection is registered.
     Timeout::timeout(5) do
+      @connection.register
       while !@connection.registered? do sleep 0.1; end
     end
     

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

@@ -68,6 +68,7 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
 
     # Wait until the connection is registered.
     Timeout::timeout(5) do
+      @context.register    
       while !@context.registered? do sleep 0.1; end
     end
 
@@ -92,6 +93,7 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
 
     # Wait until the connection is registered.
     Timeout::timeout(5) do
+      @context.register    
       while !@context.registered? do sleep 0.1; end
     end
     
@@ -115,6 +117,7 @@ class IRC::Client::ContextTest < Test::Unit::TestCase
 
   end
   
-    def test_truth
-    end
+  def test_truth
+  end  
+  
 end

data/test/mocks/test/irc/client/connection.rb

@@ -0,0 +1,128 @@
+#!/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 File.dirname(__FILE__) + '/../../../../../lib/irc/client/connection'
+
+module IRC
+  
+  module Client
+    
+    class Connection
+      
+      attr_reader :context
+      
+      def connect(server)
+      
+        if context.input_socket == nil
+
+          context.server = server
+          
+          register_connection_messages
+          register_registration_messages
+          
+        end
+  
+        context.connect(server)
+        
+      end
+      
+      def register_raw_message(raw_message)
+      
+        # Create an input socket if not done already.
+        context.input_socket ||= StringIO.new     
+        
+        # Save the input socket position and seek to the end.
+        position = context.input_socket.pos
+        context.input_socket.seek(0, IO::SEEK_END)
+        
+        # Append the raw message to the end of the string io object.
+        context.input_socket << "#{IRC::Messages::Message.new(raw_message).to_s}\r\n"
+
+        # Seek back to the saved position.
+        context.input_socket.seek(position, IO::SEEK_SET)
+        
+      end
+      
+      def register_raw_messages(raw_messages)
+        
+        raw_messages.each do |raw_message| 
+          register_raw_message(raw_message)
+        end
+        
+      end
+      
+      def register_connection_messages
+        
+        raw_messages = [
+          "NOTICE AUTH :*** Looking up your hostname...",
+          "NOTICE AUTH :*** Checking Ident",
+          "NOTICE AUTH :*** Found your hostname",
+          "NOTICE AUTH :*** Got Ident response"
+        ]
+        
+        register_raw_messages(raw_messages)
+        
+      end
+      
+      def register_registration_messages
+        
+        raw_messages = [
+          ":#{context.server.hostname} 001 #{context.nick} :Welcome to the EFNet Internet Relay Chat Network #{context.nick}",
+          ":#{context.server.hostname} 002 #{context.nick} :Your host is #{context.server.hostname}[#{context.server.hostname}/6667], running version ircd-ratbox-1.5-3",
+          ":#{context.server.hostname} 003 #{context.nick} :This server was created Wto 30 Lis CET at 18:36:52 2004",
+          ":#{context.server.hostname} 004 #{context.nick} #{context.server.hostname} ircd-ratbox-1.5-3 oiwszcerkfydnxbauglZ biklmnopstveI bkloveI",
+          ":#{context.server.hostname} 005 #{context.nick} STD=i-d STATUSMSG=@+ KNOCK EXCEPTS INVEX MODES=4 MAXCHANNELS=25 MAXBANS=100 MAXTARGETS=4 NICKLEN=9 TOPICLEN=120 KICKLEN=120 :are supported by this server",
+          ":#{context.server.hostname} 005 #{context.nick} CHANTYPES=#& PREFIX=(ov)@+ CHANMODES=eIb,k,l,imnpst NETWORK=EFNet CASEMAPPING=rfc1459 CHARSET=ascii CALLERID ETRACE WALLCHOPS SAFELIST ELIST=U :are supported by this server",
+          ":#{context.server.hostname} 251 #{context.nick} :There are 8205 users and 63039 invisible on 59 servers",
+          ":#{context.server.hostname} 252 #{context.nick} 437 :IRC Operators online",
+          ":#{context.server.hostname} 254 #{context.nick} 33951 :channels formed",
+          ":#{context.server.hostname} 255 #{context.nick} :I have 5548 clients and 1 servers",
+          ":#{context.server.hostname} 265 #{context.nick} :Current local  users: 5548  Max: 6470",
+          ":#{context.server.hostname} 266 #{context.nick} :Current global users: 71244  Max: 80036",
+          ":#{context.server.hostname} 250 #{context.nick} :Highest connection count: 6471 (6470 clients) (217198 connections received)",
+          ":#{context.server.hostname} 375 #{context.nick} :- #{context.server.hostname} Message of the Day -",
+          ":#{context.server.hostname} 372 #{context.nick} :-",
+          ":#{context.server.hostname} 372 #{context.nick} :- w   w w   w w   w   a  ttt m   m  ccc ooo m   m ppp l",
+          ":#{context.server.hostname} 372 #{context.nick} :- w   w w   w w   w  a a  t  mm mm c    o o mm mm p p l",
+          ":#{context.server.hostname} 372 #{context.nick} :- w w w w w w w w w aaaaa t  m m m c    o o m m m ppp l",
+          ":#{context.server.hostname} 372 #{context.nick} :-  w w   w w   w w .a   a t  m   m .ccc ooo m   m.p   llll",
+          ":#{context.server.hostname} 372 #{context.nick} :-",
+          ":#{context.server.hostname} 372 #{context.nick} :- WWW.ATM.COM.PL",
+          ":#{context.server.hostname} 372 #{context.nick} :-",
+          ":#{context.server.hostname} 376 #{context.nick} :End of /MOTD command.",
+          ":#{context.nick} MODE #{context.nick} :+i"
+        ]
+        
+        register_raw_messages(raw_messages)
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end

data/test/mocks/test/irc/client/disconnected_state.rb

@@ -0,0 +1,44 @@
+#!/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 File.dirname(__FILE__) + '/../../../../../lib/irc/client/disconnected_state'
+
+module IRC
+  
+  module Client
+    
+    class DisconnectedState < ConnectionState
+      
+      private
+      
+      def establish_connection(context, server)
+        context.output_socket = StringIO.new     
+      end
+      
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -27,6 +27,6 @@ require 'log4r/configurator'
 
 class Test::Unit::TestCase
 
-  Log4r::Configurator.load_xml_file(File.dirname(__FILE__) + '/log4r.xml')
+Log4r::Configurator.load_xml_file(File.dirname(__FILE__) + '/log4r.xml')
   
 end

data/test/unit/irc/client/command_handler_test.rb

@@ -38,7 +38,7 @@ class IRC::Client::CommandHandlerTest < Test::Unit::TestCase
     # Set up a connection context.
     @context = IRC::Client::Connection::Context.new
     @context.network = IRC::Models::Network.new(:name => "Efnet")
-    @context.socket = StringIO.new("", "w+")
+    @context.output_socket = StringIO.new("", "w+")
 
     # Initialize the command handler with the mock connection context.
     @command_handler = IRC::Client::CommandHandler.new(@context)
@@ -84,14 +84,14 @@ class IRC::Client::CommandHandlerTest < Test::Unit::TestCase
     @command_handler.send_command(nick_command)
 
     # Rewind the stringio object, so we can read from it.
-    @context.socket.rewind
+    @context.output_socket.rewind
     
     # Both commands should be available immediately, since they were not sent through the queue.
-    assert_equal password_command.command, @context.socket.readline.chomp
-    assert_equal nick_command.command, @context.socket.readline.chomp    
+    assert_equal password_command.command, @context.output_socket.readline.chomp
+    assert_equal nick_command.command, @context.output_socket.readline.chomp    
     
     # There should be no more commands available.
-    assert_raise(EOFError) { @context.socket.readline }    
+    assert_raise(EOFError) { @context.output_socket.readline }    
 
     # Stop the command handler.
     @command_handler.stop        
@@ -112,22 +112,22 @@ class IRC::Client::CommandHandlerTest < Test::Unit::TestCase
     @command_handler << nick_command
     
     # Rewind the stringio object, so we can read from it.
-    @context.socket.rewind
+    @context.output_socket.rewind
 
     # The first command got sent but the second is still in the queue.
-    assert_equal password_command.command, @context.socket.readline.chomp
-    assert_raise(EOFError) { @context.socket.readline }
+    assert_equal password_command.command, @context.output_socket.readline.chomp
+    assert_raise(EOFError) { @context.output_socket.readline }
 
     # Wait for the 2nd command.
     sleep @command_handler.delay * 1.5
 
     # Rewind again and start reading all commands from scratch.
-    @context.socket.rewind
-    assert_equal password_command.command, @context.socket.readline.chomp
-    assert_equal nick_command.command, @context.socket.readline.chomp    
+    @context.output_socket.rewind
+    assert_equal password_command.command, @context.output_socket.readline.chomp
+    assert_equal nick_command.command, @context.output_socket.readline.chomp    
     
     # There should be no more commands available.
-    assert_raise(EOFError) { @context.socket.readline }
+    assert_raise(EOFError) { @context.output_socket.readline }
 
     # Stop the command handler.
     @command_handler.stop        

data/test/unit/irc/client/message_handler_test.rb

@@ -0,0 +1,136 @@
+#!/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/message_handler'
+require 'irc/client/context'
+require 'irc/commands/nick_command'
+require 'irc/commands/password_command'
+require 'irc/models/network'
+require 'stringio'
+require 'test/unit'
+
+class IRC::Client::MessageHandlerTest < Test::Unit::TestCase
+
+  def setup
+  
+    # Set up a connection context.
+    @context = IRC::Client::Connection::Context.new
+    @context.network = IRC::Models::Network.new(:name => "Efnet")
+    @context.input_socket = StringIO.new("", "w+")
+
+    # Initialize the command handler with the mock connection context.
+    @message_handler = IRC::Client::MessageHandler.new(@context)
+    
+  end
+
+  def test_start
+  
+    # Start the command handler.
+    @message_handler.start
+    
+    # Starting the command handler again should raise an exception.
+    assert_raise(IRC::Client::MessageHandlerError) { @message_handler.start }
+    
+    # Stop the command handler.
+    @message_handler.stop    
+    
+  end
+
+  def test_stop
+  
+    # Stopping a not started command handler should raise an exception.
+    assert_raise(IRC::Client::MessageHandlerError) { @message_handler.stop }
+    
+    # Stopping a command handler after it was started should work fine.
+    @message_handler.start
+    @message_handler.stop        
+    
+  end
+  
+#  def test_send_command
+#  
+#    # Start the command handler.
+#    @command_handler.start
+#
+#    # Send the password command.
+#    password_command = IRC::Commands::PasswordCommand.new("secret")      
+#    @command_handler.send_command(password_command)
+#
+#    # Send the nick command.
+#    nick_command = IRC::Commands::NickCommand.new("fumanshu")
+#    @command_handler.send_command(nick_command)
+#
+#    # Rewind the stringio object, so we can read from it.
+#    @context.output_socket.rewind
+#    
+#    # Both commands should be available immediately, since they were not sent through the queue.
+#    assert_equal password_command.command, @context.output_socket.readline.chomp
+#    assert_equal nick_command.command, @context.output_socket.readline.chomp    
+#    
+#    # There should be no more commands available.
+#    assert_raise(EOFError) { @context.output_socket.readline }    
+#
+#    # Stop the command handler.
+#    @command_handler.stop        
+#    
+#  end
+#  
+#  def test_send_command_via_queue
+#  
+#    # Start the command handler.
+#    @command_handler.start
+#
+#    # Send the password command.
+#    password_command = IRC::Commands::PasswordCommand.new("secret")      
+#    @command_handler.send_command_via_queue(password_command)
+#    
+#    # Send the nick command.
+#    nick_command = IRC::Commands::NickCommand.new("fumanshu")
+#    @command_handler << nick_command
+#    
+#    # Rewind the stringio object, so we can read from it.
+#    @context.output_socket.rewind
+#
+#    # The first command got sent but the second is still in the queue.
+#    assert_equal password_command.command, @context.output_socket.readline.chomp
+#    assert_raise(EOFError) { @context.output_socket.readline }
+#
+#    # Wait for the 2nd command.
+#    sleep @command_handler.delay * 1.5
+#
+#    # Rewind again and start reading all commands from scratch.
+#    @context.output_socket.rewind
+#    assert_equal password_command.command, @context.output_socket.readline.chomp
+#    assert_equal nick_command.command, @context.output_socket.readline.chomp    
+#    
+#    # There should be no more commands available.
+#    assert_raise(EOFError) { @context.output_socket.readline }
+#
+#    # Stop the command handler.
+#    @command_handler.stop        
+#  
+#  end
+  
+end