ircguerilla-irc 1.1.0

data/lib/irc/commands/nick_command.rb

@@ -0,0 +1,86 @@
+#!/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: nick_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # 4.1.2 Nick message
+    # 
+    # Command: 	NICK
+    # Parameters: 	<nickname> [ <hopcount> ]
+    # 
+    # NICK message is used to give user a nickname or change the previous one. The 
+    # <hopcount> parameter is only used by servers to indicate how far away a nick 
+    # is from its home server. A local connection has a hopcount of 0. If supplied 
+    # by a client, it must be ignored.
+    # 
+    # If a NICK message arrives at a server which already knows about an identical 
+    # nickname for another client, a nickname collision occurs. As a result of a 
+    # nickname collision, all instances of the nickname are removed from the server's 
+    # database, and a KILL command is issued to remove the nickname from all other 
+    # server's database. If the NICK message causing the collision was a nickname 
+    # change, then the original (old) nick must be removed as well.
+    # 
+    # If the server recieves an identical NICK from a client which is directly 
+    # connected, it may issue an ERR_NICKCOLLISION to the local client, drop the NICK 
+    # command, and not generate any kills.
+    # 
+    # Numeric Replies:
+    # 
+    # ERR_NONICKNAMEGIVEN 	
+    # ERR_ERRONEUSNICKNAME
+    # ERR_NICKNAMEINUSE 	
+    # ERR_NICKCOLLISION
+    # 
+    # Example:
+    # 
+    # NICK Wiz                 ; Introducing new nick "Wiz".
+    # 
+    # :WiZ NICK Kilroy         ; WiZ changed his nickname to Kilroy.
+    #     
+    class NickCommand < Command
+      
+      attr_reader :nick
+      attr_reader :hopcount      
+      
+      def initialize(nick, hopcount = nil)
+        raise InvalidCommand.new("Can't create nick command. No nick name.") unless nick
+        @nick = nick
+        @hopcount = hopcount
+      end
+      
+      def command
+        return "NICK #{nick} #{hopcount ? hopcount.to_s : ''}"
+      end
+      
+    end      
+  
+  end
+  
+end  

data/lib/irc/commands/part_command.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: part_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # 4.2.2 Part message
+    # 
+    # Command: 	    PART
+    # Parameters: 	<channel>{,<channel>}
+    # 
+    # The PART message causes the client sending the message to be removed 
+    # from the list of active users for all given channels listed in the 
+    # parameter string.
+    # 
+    # Numeric Replies:
+    # 
+    # ERR_NEEDMOREPARAMS 	
+    # ERR_NOSUCHCHANNEL
+    # ERR_NOTONCHANNEL 	
+    # 
+    # Examples:
+    # 
+    # PART #twilight_zone    ; leave channel "#twilight_zone"
+    # 
+    # PART #oz-ops,&group5   ; leave both channels "&group5" and
+    #                        ; "#oz-ops".
+    # 
+    class PartCommand < Command
+      
+      attr_reader :channels
+      
+      def initialize(channels)
+
+        raise InvalidCommand.new("Can't create part command. No channels.") unless channels
+        
+        if channels.instance_of?(Array)
+        
+          @channels = channels
+        
+        else
+        
+          @channels = Array.new
+          @channels << channels
+                  
+        end
+        
+      end
+      
+      def command 
+        return "PART #{channels.join(',')}"
+      end
+      
+    end      
+    
+  end
+  
+end  

data/lib/irc/commands/password_command.rb

@@ -0,0 +1,72 @@
+#!/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: password_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # 4.1.1 Password message
+    # 
+    # Command:	PASS
+    # Parameters:	<password>
+    # 
+    # The PASS command is used to set a 'connection password'. The password can and must 
+    # be set before any attempt to register the connection is made. Currently this requires 
+    # that clients send a PASS command before sending the NICK/USER combination and servers 
+    # *must* send a PASS command before any SERVER command. The password supplied must match 
+    # the one contained in the C/N lines (for servers) or I lines (for clients). It is 
+    # possible to send multiple PASS commands before registering but only the last one sent 
+    # is used for verification and it may not be changed once registered. 
+    # 
+    # Numeric Replies:
+    # 
+    # ERR_NEEDMOREPARAMS 	
+    # ERR_ALREADYREGISTRED
+    # 
+    # Example:
+    # 
+    # PASS secretpasswordhere
+    #   
+    class PasswordCommand < Command
+      
+      attr_reader :password
+      
+      def initialize(password)
+        raise InvalidCommand.new("Can't create password command. No password.") unless password
+        @password = password
+      end
+      
+      def command 
+        return "PASS #{password}"
+      end
+      
+    end      
+    
+  end
+  
+end  

data/lib/irc/commands/ping_command.rb

@@ -0,0 +1,79 @@
+#!/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: ping_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # 4.6.2 Ping message
+    # 
+    # Command: 	    PING
+    # Parameters: 	<server1> [<server2>]
+    # 
+    # The PING message is used to test the presence of an active client at the other end of 
+    # the connection. A PING message is sent at regular intervals if no other activity detected 
+    # coming from a connection. If a connection fails to respond to a PING command within a set 
+    # amount of time, that connection is closed.
+    # 
+    # Any client which receives a PING message must respond to <server1> (server which sent the 
+    # PING message out) as quickly as possible with an appropriate PONG message to indicate it 
+    # is still there and alive. Servers should not respond to PING commands but rely on PINGs 
+    # from the other end of the connection to indicate the connection is alive. If the <server2> 
+    # parameter is specified, the PING message gets forwarded there.
+    # 
+    # Numeric Replies:
+    # * ERR_NOORIGIN 	
+    # * ERR_NOSUCHSERVER
+    # 
+    # Examples:
+    # 
+    # PING tolsun.oulu.fi  ; server sending a PING message to
+    #                      another server to indicate it is still
+    #                      alive.
+    # 
+    # PING WiZ             ; PING message being sent to nick WiZ
+    # 
+    class PingCommand < Command
+      
+      attr_reader :first_server
+      attr_reader :second_server      
+      
+      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
+      end
+      
+      def command
+        return "PING #{first_server} #{second_server != nil ? second_server.to_s : ''}".strip
+      end
+      
+    end      
+  
+  end
+  
+end  

data/lib/irc/commands/pong_command.rb

@@ -0,0 +1,68 @@
+#!/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: pong_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # 4.6.3 Pong message
+    # 
+    # Command: 	PONG
+    # Parameters: 	<daemon> [<daemon2>]
+    # 
+    # PONG message is a reply to ping message. If parameter <daemon2> is given this message must 
+    # be forwarded to given daemon. The <daemon> parameter is the name of the daemon who has responded 
+    # to PING message and generated this message.
+    # 
+    # Numeric Replies:
+    # * ERR_NOORIGIN 
+    # *	ERR_NOSUCHSERVER
+    # 
+    # Examples:
+    # 
+    # PONG csd.bu.edu tolsun.oulu.fi  ; PONG message from csd.bu.edu to
+    # 
+    class PongCommand < Command
+      
+      attr_reader :first_daemon
+      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
+      end
+      
+      def command
+        return "PONG #{first_daemon} #{second_daemon != nil ? second_daemon.to_s : ''}".strip
+      end
+      
+    end      
+  
+  end
+  
+end  

data/lib/irc/commands/quit_command.rb

@@ -0,0 +1,77 @@
+#!/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: quit_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # 4.1.6 Quit
+    # 
+    # Command: 	    QUIT
+    # Parameters: 	[<Quit message>]
+    # 
+    # A client session is ended with a quit message. The server must close the 
+    # connection to a client which sends a QUIT message. If a "Quit Message" is 
+    # given, this will be sent instead of the default message, the nickname.
+    # 
+    # When netsplits (disconnecting of two servers) occur, the quit message is 
+    # composed of the names of two servers involved, separated by a space. The 
+    # first name is that of the server which is still connected and the second 
+    # name is that of the server that has become disconnected.
+    # 
+    # If, for some other reason, a client connection is closed without the 
+    # client issuing a QUIT command (e.g. client dies and EOF occurs on socket), 
+    # the server is required to fill in the quit message with some sort of message 
+    # reflecting the nature of the event which caused it to happen.
+    # 
+    # Numeric Replies:
+    # 
+    # None.
+    # 
+    # Examples:
+    # 
+    # QUIT :Gone to have lunch     ; Preferred message format.
+    # 
+    class QuitCommand < Command
+      
+      attr_reader :message
+      
+      def initialize(message)
+        raise InvalidCommand.new("Can't create quit command. No quit message.") unless message
+        @message = message
+      end
+      
+      def command 
+        return "QUIT :#{message}"
+      end
+      
+    end      
+    
+  end
+  
+end