steam-condenser 0.13.1 → 0.14.0

data/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb

@@ -1,12 +1,18 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# The A2S_SERVERQUERY_GETCHALLENGE_Packet class represents a
-# A2S_SERVERQUERY_GETCHALLENGE request send to the server.
+# This packet class represents a A2S_SERVERQUERY_GETCHALLENGE request send to
+# a game server
+#
+# It is used to retrieve a challenge number from the game server, which helps
+# to identify the requesting client.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_challenge_number
 class A2S_SERVERQUERY_GETCHALLENGE_Packet
 
   include SteamPacket

data/lib/steam/packets/c2m_checkmd5_packet.rb

@@ -5,18 +5,24 @@
 
 require 'steam/packets/steam_packet'
 
-# The C2M_CHECKMD5 packet type is used to initialize (challenge) master server
-# communication.
+# This packet class represents a C2M_CHECKMD5 request sent to a master server
+#
+# It is used to initialize (challenge) master server communication.
+#
+# @author Sebastian Staudt
+# @see MasterServer#challenge
 class C2M_CHECKMD5_Packet
 
   include SteamPacket
 
-  # Creates a new challenge request packet for master server communication
+  # Creates a new C2M_CHECKMD5 request object
   def initialize
     super C2M_CHECKMD5_HEADER
   end
 
-  # Returns a byte array representation of the packet data
+  # Returns the raw data representing this packet
+  #
+  # @return string A string containing the raw data of this request packet
   def to_s
     [@header_data, 0xFF].pack('c2')
   end

data/lib/steam/packets/m2a_server_batch_packet.rb

@@ -1,16 +1,32 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
+# This packet class represents a M2A_SERVER_BATCH response replied by a master
+# server
+#
+# It contains a list of IP addresses and ports of game servers matching the
+# requested criteria.
+#
+# @author Sebastian Staudt
+# @see MasterServer#servers
 class M2A_SERVER_BATCH_Packet
 
   include SteamPacket
 
+  # Returns the list of servers returned from the server in this packet
+  #
+  # @return [Array<String>] An array of server addresses (i.e. IP addresses +
+  #         port numbers)
   attr_reader :servers
 
+  # Creates a new M2A_SERVER_BATCH response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
+  # @raises PacketFormatException if the packet data is not well formatted
   def initialize(data)
     super M2A_SERVER_BATCH_HEADER, data
 

data/lib/steam/packets/m2c_isvalidmd5_packet.rb

@@ -1,20 +1,29 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# A packet of type M2S_ISVALIDMD5 is used by the master server to provide a
-# challenge number to a game server
+# This packet class represents a M2S_ISVALIDMD5 response replied by a master
+# server
+#
+# It is used to provide a challenge number to a game server
+#
+# @author Sebastian Staudt
+# @see MasterServer#challenge
 class M2C_ISVALIDMD5_Packet
 
   include SteamPacket
 
   # Returns the challenge number to use for master server communication
+  #
+  # @return [Fixnum] The challenge number
   attr_reader :challenge
 
-  # Creates a new response packet with the data from the master server
+  # Creates a new M2S_ISVALIDMD5 response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
   def initialize(data)
     super M2C_ISVALIDMD5_HEADER, data
 

data/lib/steam/packets/m2s_requestrestart_packet.rb

@@ -5,18 +5,28 @@
 
 require 'steam/packets/steam_packet'
 
-# The M2S_REQUESTRESTART packet type is used to by master servers to request a
-# game server restart, e.g. when using outdated versions.
+# This packet class represent a M2S_REQUESTRESTART response replied from a
+# master server
+#
+# It is used to request a game server restart, e.g. when the server is
+# outdated.
+#
+# @author Sebastian Staudt
+# @see MasterServer#sendHeartbeat
 class M2S_REQUESTRESTART_Packet
 
   include SteamPacket
 
   # Returns the challenge number used for master server communication
+  #
+  # @return [Fixnum] The challenge number
   attr_reader :challenge
 
-  # Creates a new server restart request packet sent by a master server
+  # Creates a new M2S_REQUESTRESTART response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
   def initialize(data)
-    super C2M_CHECKMD5_HEADER, data
+    super M2S_REQUESTRESTART_HEADER, data
 
     @challenge = @content_data.long
   end

data/lib/steam/packets/rcon/rcon_auth_request.rb

@@ -1,14 +1,26 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/rcon/rcon_packet'
 
+# This packet class represents a SERVERDATA_AUTH request sent to a Source
+# server
+#
+# It is used to authenticate the client for RCON communication.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_auth
 class RCONAuthRequest
 
   include RCONPacket
 
+  # Creates a RCON authentication request for the given request ID and RCON
+  # password
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
+  # @param [String] rcon_password The RCON password of the server
   def initialize(request_id, rcon_password)
     super request_id, SERVERDATA_AUTH, rcon_password
   end

data/lib/steam/packets/rcon/rcon_auth_response.rb

@@ -1,14 +1,28 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/rcon/rcon_packet'
 
+# This packet class represents a SERVERDATA_AUTH_RESPONSE packet sent by a
+# Source server
+#
+# It is used to indicate the success or failure of an authentication attempt
+# of a client for RCON communication.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_auth
 class RCONAuthResponse
 
   include RCONPacket
 
+  # Creates a RCON authentication response for the given request ID
+  #
+  # The request ID of the packet will match the client's request if
+  # authentication was successful
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
   def initialize(request_id)
     super request_id, SERVERDATA_AUTH_RESPONSE, ''
   end

data/lib/steam/packets/rcon/rcon_exec_request.rb

@@ -1,14 +1,26 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/rcon/rcon_packet'
 
+# This packet class represents a SERVERDATA_EXECCOMMAND packet sent to a
+# Source server
+#
+# It is used to request a command execution on the server.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_exec
 class RCONExecRequest
 
   include RCONPacket
 
+  # Creates a RCON command execution request for the given request ID and
+  # command
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
+  # @param [String] rcon_command The command to execute on the server
   def initialize(request_id, rcon_command)
     super request_id, SERVERDATA_EXECCOMMAND, rcon_command
   end

data/lib/steam/packets/rcon/rcon_exec_response.rb

@@ -1,18 +1,35 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/rcon/rcon_packet'
 
+# This packet class represents a SERVERDATA_RESPONSE_VALUE packet sent by a
+# Source server
+#
+# It is used to transport the output of a command from the server to the client
+# which requested the command execution.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_exec
 class RCONExecResponse
 
   include RCONPacket
 
+  # Creates a RCON command response for the given request ID and command
+  # output
+  #
+  # @param [Fixnum] request_id The request ID of the RCON connection
+  # @param [String] command_response The output of the command executed on the
+  #        server
   def initialize(request_id, command_response)
     super request_id, SERVERDATA_RESPONSE_VALUE, command_response
   end
 
+  # Returns the output of the command execution
+  #
+  # @return [String] The output of the command
   def response
     @content_data.string[0..-3]
   end

data/lib/steam/packets/rcon/rcon_goldsrc_request.rb

@@ -1,18 +1,33 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
+# This packet class represents a RCON request packet sent to a GoldSrc server
+#
+# It is used to request a command execution on the server.
+#
+# @author Sebastian Staudt
+# @see GoldSrcServer#rcon_exec
 class RCONGoldSrcRequest
 
   include SteamPacket
 
+  # Creates a request for the given request string
+  #
+  # The request string has the form `rcon {challenge number} {RCON password}
+  # {command}`.
+  #
+  # @param [String] request The request string to send to the server
   def initialize(request)
     super 0x00, request
   end
 
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this request packet
   def to_s
     [0xFFFFFFFF, @content_data.string].pack('Va*')
   end

data/lib/steam/packets/rcon/rcon_goldsrc_response.rb

@@ -1,18 +1,32 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
+# This packet class represents a RCON response packet sent by a GoldSrc server
+#
+# It is used to transport the output of a command from the server to the client
+# which requested the command execution.
+#
+# @author Sebastian Staudt
+# @see GoldSrcServer#rcon_exec
 class RCONGoldSrcResponse
 
   include SteamPacket
 
+  # Creates a RCON command response for the given command output
+  #
+  # @param [String] command_response The output of the command executed on the
+  #        server
   def initialize(command_response)
     super RCON_GOLDSRC_RESPONSE_HEADER, command_response
   end
 
+  # Returns the output of the command execution
+  #
+  # @return [String] The output of the command
   def response
     @content_data.string[0..-3]
   end

data/lib/steam/packets/rcon/rcon_packet.rb

@@ -1,27 +1,55 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
+# This module is included by all classes representing a packet used by Source's
+# RCON protocol
+#
+# It provides a basic implementation for initializing and serializing such a
+# packet.
+#
+# @author Sebastian Staudt
+# @see RCONPacketFactory
 module RCONPacket
 
   include SteamPacket
 
+  # Header for authentication requests
   SERVERDATA_AUTH = 3
+
+  # Header for replies to authentication attempts
   SERVERDATA_AUTH_RESPONSE = 2
+
+  # Header for command execution requests
   SERVERDATA_EXECCOMMAND = 2
+
+  # Header for packets with the output of a command execution
   SERVERDATA_RESPONSE_VALUE = 0
 
+  # Returns the request ID used to identify the RCON communication
+  #
+  # @return [Fixnum] The request ID used to identify the RCON communication
   attr_reader :request_id
 
+  # Creates a new RCON packet object with the given request ID, type and
+  # content data
+  #
+  # @param [Fixnum] request_id The request ID for the current RCON
+  #        communication
+  # @param [Fixnum] rcon_header The header for the packet type
+  # @param [String] rcon_data The raw packet data
   def initialize(request_id, rcon_header, rcon_data)
     super rcon_header, "#{rcon_data}\0\0"
 
     @request_id = request_id
   end
 
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this RCON packet
   def to_s
     [@content_data.length + 8, @request_id, @header_data, @content_data.string].pack('V3a*')
   end

data/lib/steam/packets/rcon/rcon_packet_factory.rb

@@ -1,7 +1,7 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'stringio_additions'
 require 'exceptions/packet_format_exception'
@@ -9,10 +9,20 @@ require 'steam/packets/steam_packet_factory'
 require 'steam/packets/rcon/rcon_auth_response'
 require 'steam/packets/rcon/rcon_exec_response'
 
+# This module provides functionality to handle raw packet data for Source RCON
+#
+# It's is used to transform data bytes into packet objects for RCON
+# communication with Source servers.
+#
+# @author Sebastian Staudt
+# @see RCONPacket
 module RCONPacketFactory
 
-  include SteamPacketFactory
-
+  # Creates a new packet object based on the header byte of the given raw data
+  #
+  # @param [String] raw_data The raw data of the packet
+  # @raise [PacketFormatException] if the packet header is not recognized
+  # @return [RCONPacket] The packet object generated from the packet data
   def self.packet_from_data(raw_data)
     byte_buffer = StringIO.new raw_data