ircguerilla-irc 1.1.0

data/lib/irc/models/packet.rb

@@ -0,0 +1,84 @@
+#!/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: packet.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/models/user'
+
+module IRC
+  
+  module Models
+    
+    class Packet 
+      
+      attr_reader :bot
+      attr_reader :number
+      
+      attr_accessor :description
+      attr_accessor :size_in_bytes
+      attr_accessor :number_of_downloads   
+      
+      def initialize(attributes)
+        
+        raise ArgumentError.new("Can't create a new packet. The :bot attribute is missing.") if attributes[:bot] == nil
+        @bot = attributes[:bot]
+        
+        raise ArgumentError.new("Can't create a new packet. The :number attribute is missing.") if attributes[:number] == nil
+        @number = attributes[:number]
+        
+        self.description = attributes[:description]
+        self.size_in_bytes = attributes[:size_in_bytes]
+        self.number_of_downloads = attributes[:number_of_downloads]   
+        
+      end
+      
+      def merge(other)
+        #      @bot = other.bot
+        @number = other.number
+        self.description = other.description
+        self.size_in_bytes = other.size_in_bytes
+        self.number_of_downloads = other.number_of_downloads
+      end    
+      
+      def ==(other)
+        return eql?(other)
+      end        
+      
+      # Returns true if the other Packet object is equal to the current.
+      def eql?(other)
+        return other.instance_of?(Packet) && bot == other.bot && number == other.number && description == other.description
+      end    
+      
+      def hash
+        return key.hash
+      end
+      
+      def key
+        return "#{bot.network.name.strip}|#{bot.nick.strip}|#{number.to_s}".downcase
+      end   
+      
+    end
+    
+  end
+  
+end

data/lib/irc/models/server.rb

@@ -0,0 +1,116 @@
+#!/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: server.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/models/network'
+
+module IRC
+  
+  module Models
+    
+    class Server
+      
+      DEFAULT_PORT = 6667
+      
+      attr_reader :network
+      attr_reader :hostname
+      attr_reader :port
+      
+      attr_accessor :password
+      attr_accessor :last_connect
+      attr_accessor :last_disconnect
+      
+      # Creates a new server object with a hostname, an optional 
+      # port and optinal password, that belongs to a network.  
+      def initialize(attributes)
+        
+        raise ArgumentError.new("Can't create a new server object. The :network attribute is missing.") if attributes[:network] == nil
+        @network = attributes[:network]
+        
+        raise ArgumentError.new("Can't create a new server object. The :hostname attribute is missing.") if attributes[:hostname] == nil
+        @hostname = attributes[:hostname].strip
+        
+        @port = attributes[:port] || DEFAULT_PORT
+        
+        self.password = attributes[:password]
+        self.last_connect = attributes[:last_connect]
+        self.last_disconnect = attributes[:last_disconnect]
+        
+      end
+      
+      def ==(other)
+        return eql?(other)
+      end        
+      
+      # Returns true if the other Server object is equal to the
+      # current.
+      def eql?(other)
+        return other.instance_of?(Server) && network == other.network && hostname == other.hostname && port == other.port    
+      end
+      
+      def hash
+        return key.hash
+      end    
+      
+      def key
+        return "#{network.name}|#{hostname}|#{port}".downcase
+      end    
+      
+      def merge(other)
+        
+        #      @network = other.network
+        @hostname = other.hostname
+        @port = other.port
+        
+        self.password = other.password
+        self.last_connect = other.last_connect
+        self.last_disconnect = other.last_disconnect
+        
+      end
+      
+      # Returns the name of the server. If the port is different from the 
+      # default IRC port the port number is also appended.
+      def to_s
+        return hostname
+      end
+      
+      # Returns the name of the server. If the port is different from the 
+      # default IRC port the port number is also appended.
+      def to_str
+        return to_s
+      end
+      
+      def to_xml
+        server = REXML::Element.new("Server")
+        server.add_element("Hostname").add_text(REXML::CData.new(hostname))
+        server.add_element("Port").add_text(port.to_s)
+        server.add_element("Password").add_text(REXML::CData.new(password)) if password != nil      
+        return server
+      end    
+      
+    end
+    
+  end
+  
+end

data/lib/irc/models/user.rb

@@ -0,0 +1,112 @@
+#!/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: user.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/models/network'
+
+module IRC
+  
+  module Models
+    
+    class User
+      
+      attr_reader :network
+      attr_reader :nick
+      
+      attr_accessor :login
+      attr_accessor :hostname  
+      attr_accessor :realname
+      
+      def initialize(attributes)
+        
+        raise ArgumentError.new("Can't create a new user object. The :network attribute is missing.") if attributes[:network] == nil
+        @network = attributes[:network]
+        
+        raise ArgumentError.new("Can't create a new user object. The :nick attribute is missing.") if attributes[:nick] == nil
+        @nick = attributes[:nick].strip
+        
+        @login = attributes[:login]
+        @hostname = attributes[:hostname]
+        
+        @channels = Hash.new
+        
+      end
+      
+      def add_channel(channel)
+        @channels[channel] = channel
+      end
+      
+      def channels
+        return @channels.values
+      end
+      
+      def eql?(other)
+        return (other.instance_of?(Bot) || other.instance_of?(User)) && network == other.network && nick == other.nick
+      end   
+      
+      def hash
+        return key.hash
+      end         
+      
+      def key
+        return "#{network.name.strip}|#{nick.strip}".downcase
+      end
+      
+      def merge(other)
+        
+        @nick = other.nick
+        
+        self.login = other.login
+        self.hostname = other.hostname
+        
+        other.channels.each do |other_channel|
+          channel = network.lookup_or_create_channel(other_channel.name)
+          add_channel(channel)
+        end
+        
+      end
+      
+      def remove_channel(channel)
+        return @channels.delete(channel)
+      end
+      
+      # Returns the nick name of the user.
+      def to_s
+        return @nick
+      end    
+      
+      # Returns the nick name of the user.
+      def to_str
+        return to_s
+      end    
+      
+      def ==(other)
+        return eql?(other)
+      end        
+      
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,118 @@
+#!/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 'stringio'
+require 'irc/client/connection'
+require 'irc/client/disconnected_state'
+require 'irc/models/network'
+require 'test/unit'
+require 'timeout'
+
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+@response = StringIO.new
+
+
+class IRC::Client::ConnectionTest < Test::Unit::TestCase
+  
+  def setup
+    
+    # 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")
+    
+    # Initialize the connection connection.
+    @connection = IRC::Client::Connection::Context.new("fumanshu")
+    
+  end
+  
+  def test_connect
+    
+    # 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
+      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
+  
+  def test_join_and_part
+    
+    # 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
+      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.
+    Timeout::timeout(5) do
+      @connection.join(@channel)
+      while !@connection.joined?(@channel) do sleep 0.1 end
+    end    
+    
+    # Leave the joined channel.
+    Timeout::timeout(5) do
+      @connection.part(@channel)
+      while @connection.joined?(@channel) 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      
+      assert !@connection.connected?      
+    end
+  
+  end  
+  
+end

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

@@ -0,0 +1,126 @@
+#!/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: context_test.rb 94 2006-08-13 21:40:40Z roman $
+# 
+require 'stringio'
+require 'irc/client/context'
+require 'irc/client/disconnected_state'
+require 'irc/models/network'
+require 'test/unit'
+require 'timeout'
+
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+@response = StringIO.new
+
+
+class IRC::Client::ContextTest < Test::Unit::TestCase
+  
+  def setup
+
+    # 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")
+    
+    # Initialize the connection context.
+    @context = IRC::Client::Connection::Context.new("fumanshu")
+  
+  end
+
+  def test_connect
+          
+    # The context should be in the disconnected state.
+    assert @context.state.instance_of?(IRC::Client::DisconnectedState)
+    
+    # The context shouldn't be connected now.
+    assert !@context.connected?
+
+    # 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)
+    end
+    
+    # The context should be connected now.
+    assert @context.connected?
+
+    # 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)
+    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)
+    end
+
+  end
+  
+  def test_join_and_part
+          
+    # The context should be in the disconnected state.
+    assert @context.state.instance_of?(IRC::Client::DisconnectedState)
+
+    # 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)
+    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)
+    end
+    
+    # Join a channel & wait until the channel is joined and the block was called.
+    Timeout::timeout(5) do
+      @context.join(@channel)
+      while !@context.joined?(@channel) do sleep 0.1 end
+    end    
+    
+    # Leave the joined channel.
+    Timeout::timeout(5) do
+      @context.part(@channel)
+      while @context.joined?(@channel) do sleep 0.1 end
+    end    
+
+    # 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)
+    end
+
+  end
+  
+  
+end