steam-condenser 0.10.1 → 0.11.0

data/lib/steam/packets/request_with_challenge.rb

@@ -1,14 +1,14 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
 # This module implements a to_s method for request packets which send a challenge number
 module RequestWithChallenge
-  
+
   # Returns a packed version of the request
   def to_s
-    return [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.array.to_i].pack("c5l")
+    [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.data.to_i].pack('c5l')
   end
-  
-end
+
+end

data/lib/steam/packets/s2a_info2_packet.rb

@@ -1,50 +1,48 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "steam/packets/s2a_info_base_packet"
+require 'steam/packets/s2a_info_base_packet'
 
 # The S2A_INFO2_Packet class represents the response to a A2A_INFO
 # request send to a Source server.
 class S2A_INFO2_Packet < S2A_INFO_BasePacket
-  
+
   # Creates a S2A_INFO2 response object based on the data received.
   def initialize(data)
     super SteamPacket::S2A_INFO2_HEADER, data
-    
-    @protocol_version = @content_data.get_byte
-    @server_name = @content_data.get_string
-    @map_name = @content_data.get_string
-    @game_directory = @content_data.get_string
-    @game_description = @content_data.get_string
-    @app_id = @content_data.get_short
-    @number_of_players = @content_data.get_byte
-    @max_players = @content_data.get_byte
-    @number_of_bots = @content_data.get_byte
-    @dedicated = @content_data.get_byte.chr
-    @operating_system = @content_data.get_byte.chr
-    @password_needed = @content_data.get_byte == 1
-    @secure = @content_data.get_byte == 1
-    @game_version = @content_data.get_string
-    extra_data_flag = @content_data.get_byte
-
-    unless extra_data_flag & 0x80 == 0
-      @server_port = @content_data.get_short
-    end
+
+    @protocol_version = @content_data.byte
+    @server_name = @content_data.string
+    @map_name = @content_data.string
+    @game_directory = @content_data.string
+    @game_description = @content_data.string
+    @app_id = @content_data.short
+    @number_of_players = @content_data.byte
+    @max_players = @content_data.byte
+    @number_of_bots = @content_data.byte
+    @dedicated = @content_data.byte.chr
+    @operating_system = @content_data.byte.chr
+    @password_needed = @content_data.byte == 1
+    @secure = @content_data.byte == 1
+    @game_version = @content_data.string
+    extra_data_flag = @content_data.byte
+
+    @server_port = @content_data.short unless extra_data_flag & 0x80 == 0
 
     unless extra_data_flag & 0x10 == 0
-      @server_id =  @content_data.get_long | (@content_data.get_long << 32)
+      @server_id =  @content_data.long | (@content_data.long << 32)
     end
 
     unless extra_data_flag & 0x40 == 0
-      @tv_port = @content_data.get_short
-      @tv_name = @content_data.get_string
+      @tv_port = @content_data.short
+      @tv_name = @content_data.string
     end
 
-    unless extra_data_flag & 0x20 == 0
-      @server_tags = @content_data.get_string
-    end
+    @server_tags = @content_data.string unless extra_data_flag & 0x20 == 0
+
+    generate_info_hash
   end
-  
+
 end

data/lib/steam/packets/s2a_info_base_packet.rb

@@ -1,31 +1,26 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "abstract_class"
-require "steam/packets/steam_packet"
+require 'abstract_class'
+require 'steam/packets/steam_packet'
 
 # The S2A_INFO_BasePacket class represents the response to a A2S_INFO
 # request send to the server.
 class S2A_INFO_BasePacket < SteamPacket
-  
+
   include AbstractClass
-  
-  # Creates a S2A_INFO[...] response object based on the data received.
-  def initialize(header, data)
-    super header, data
-  end
-  
+
+  attr_reader :info_hash
+
   # Returns the hash containing information on the server
-  public
-  def get_info_hash
-    return Hash[
+  def generate_info_hash
+    @info_hash = Hash[
       *instance_variables.map { |var|
-        if var != "@content_data" && var != "@header_data"
-          [var[1..-1], instance_variable_get(var)]
-        end
+        [var[1..-1], instance_variable_get(var)] if var != '@content_data' && var != '@header_data'
       }.compact.flatten
     ]
   end
+
 end

data/lib/steam/packets/s2a_info_detailed_packet.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.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
 require "steam/packets/s2a_info_base_packet"
 
@@ -10,41 +10,43 @@ require "steam/packets/s2a_info_base_packet"
 # This is deprecated by 10/24/2008 for GoldSrc servers. They use the same
 # format as Source servers (S2A_INFO2) now.
 class S2A_INFO_DETAILED_Packet < S2A_INFO_BasePacket
-  
+
   # Creates a S2A_INFO_DETAILED response object based on the data received.
   def initialize(data)
     super SteamPacket::S2A_INFO_DETAILED_HEADER, data
 
-    @game_ip = @content_data.get_string
-    @server_name = @content_data.get_string
-    @map_name = @content_data.get_string
-    @game_directory = @content_data.get_string
-    @game_description = @content_data.get_string
-    @number_of_players = @content_data.get_byte
-    @max_players = @content_data.get_byte
-    @network_version = @content_data.get_byte
-    @dedicated = @content_data.get_byte.chr
-    @operating_system = @content_data.get_byte.chr
-    @password_needed = @content_data.get_byte == 1
-    @is_mod = @content_data.get_byte == 1
-    
+    @game_ip = @content_data.string
+    @server_name = @content_data.string
+    @map_name = @content_data.string
+    @game_directory = @content_data.string
+    @game_description = @content_data.string
+    @number_of_players = @content_data.byte
+    @max_players = @content_data.byte
+    @network_version = @content_data.byte
+    @dedicated = @content_data.byte.chr
+    @operating_system = @content_data.byte.chr
+    @password_needed = @content_data.byte == 1
+    @is_mod = @content_data.byte == 1
+
     if @is_mod
-      @mod_info = Hash.new
-      @mod_info["url_info"] = @content_data.get_string
-      @mod_info["url_dl"] = @content_data.get_string
-      @content_data.get_byte
+      @mod_info = {}
+      @mod_info['url_info'] = @content_data.string
+      @mod_info['url_dl'] = @content_data.string
+      @content_data.byte
       if @content_data.remaining == 12
-        @mod_info["mod_version"] = @content_data.get_long
-        @mod_info["mod_size"] = @content_data.get_long
-        @mod_info["sv_only"] = @content_data.get_byte == 1
-        @mod_info["cl_dll"] = @content_data.get_byte == 1
-        @secure = @content_data.get_byte == 1
-        @number_of_bots = @content_data.get_byte
+        @mod_info['mod_version'] = @content_data.long
+        @mod_info['mod_size'] = @content_data.long
+        @mod_info['sv_only'] = @content_data.byte == 1
+        @mod_info['cl_dll'] = @content_data.byte == 1
+        @secure = @content_data.byte == 1
+        @number_of_bots = @content_data.byte
       end
     else
-      @secure = @content_data.get_byte == 1
-      @number_of_bots = @content_data.get_byte
+      @secure = @content_data.byte == 1
+      @number_of_bots = @content_data.byte
     end
+
+    generate_info_hash
   end
-  
+
 end

data/lib/steam/packets/s2a_player_packet.rb

@@ -1,30 +1,28 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "steam/packets/steam_packet"
+require 'steam/packets/steam_packet'
 
 # The S2A_PLAYER_Packet class represents the response to a A2S_PLAYER
 # request send to the server.
 class S2A_PLAYER_Packet < SteamPacket
 
   attr_reader :player_hash
-  
+
   # Creates a S2A_PLAYER response object based on the data received.
   def initialize(content_data)
-    if content_data == nil
-      raise Exception.new("Wrong formatted S2A_PLAYER packet.")
-    end
-    
+    raise Exception.new('Wrong formatted S2A_PLAYER packet.') if content_data.nil?
+
     super SteamPacket::S2A_PLAYER_HEADER, content_data
 
     # Ignore player count
-    @content_data.get_byte
+    @content_data.byte
     @player_hash = {}
 
     while @content_data.remaining > 0
-      player_data = @content_data.get_byte, @content_data.get_string, @content_data.get_signed_long, @content_data.get_float
+      player_data = @content_data.byte, @content_data.string, @content_data.signed_long, @content_data.float
       @player_hash[player_data[1]] = SteamPlayer.new(*player_data[0..3])
     end
   end

data/lib/steam/packets/s2a_rules_packet.rb

@@ -1,29 +1,29 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "steam/packets/steam_packet"
+require 'steam/packets/steam_packet'
 
 # The S2A_RULES_Packet class represents the response to a A2S_RULES
 # request send to the server.
 class S2A_RULES_Packet < SteamPacket
 
+  attr_reader :rules_hash
+
   # Creates a S2A_RULES response object based on the data received.
   def initialize(content_data)
-    if content_data == nil
-      raise Exception.new("Wrong formatted A2A_RULES response packet.")
-    end
+    raise Exception.new('Wrong formatted A2A_RULES response packet.') if content_data.nil?
 
     super SteamPacket::S2A_RULES_HEADER, content_data
 
-    rules_count = @content_data.get_short
+    rules_count = @content_data.short
 
     @rules_hash = {}
 
     rules_count.times do
-      rule  = @content_data.get_string
-      value = @content_data.get_string
+      rule  = @content_data.string
+      value = @content_data.string
 
       # This is a workaround for servers sending corrupt replies
       break if rule.empty? or value.empty?
@@ -32,8 +32,4 @@ class S2A_RULES_Packet < SteamPacket
     end
   end
 
-  # Returns the hash containing the server rules
-  def get_rules_hash
-    return @rules_hash
-  end
 end

data/lib/steam/packets/s2c_challenge_packet.rb

@@ -1,21 +1,22 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "steam/packets/steam_packet"
+require 'steam/packets/steam_packet'
 
 # The S2C_CHALLENGE_Packet class represents the response
 # to a A2S_SERVERQUERY_GETCHALLENGE request send to the server.
 class S2C_CHALLENGE_Packet < SteamPacket
-  
+
   # Creates a AS2C_CHALLENGE response object based on the data received.
   def initialize(challenge_number)
     super S2C_CHALLENGE_HEADER, challenge_number
   end
-  
+
   # Returns the challenge number received from the server
-  def get_challenge_number
-    return @content_data.rewind.get_long
+  def challenge_number
+    @content_data.rewind
+    @content_data.long
   end
 end

data/lib/steam/packets/steam_packet.rb

@@ -3,6 +3,8 @@
 #
 # Copyright (c) 2008-2010, Sebastian Staudt
 
+require 'stringio_additions'
+
 # This class represents a packet used by the Source query protocol
 class SteamPacket
 
@@ -25,15 +27,14 @@ class SteamPacket
   S2C_CHALLENGE_HEADER = 0x41
 
   # Creates a new SteamPacket object with given header and content data
-  def initialize(header_data, content_data = "")
-    @content_data = ByteBuffer.new content_data
-    @header_data = header_data
+  def initialize(header_data, content_data = '')
+    @content_data = StringIO.new content_data.to_s
+    @header_data  = header_data
   end
 
   # Returns a packed string representing the packet's data
   def to_s
-    packet_data = [0xFF, 0xFF, 0xFF, 0xFF].pack("cccc")
-
-    return packet_data << [@header_data, @content_data.array].pack("ca*")
+    [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.data].pack('c5a*')
   end
+
 end

data/lib/steam/packets/steam_packet_factory.rb

@@ -1,40 +1,41 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
 require 'zlib'
 
-require "abstract_class"
-require "steam/packets/s2a_info_detailed_packet"
-require "steam/packets/a2s_info_packet"
-require "steam/packets/s2a_info2_packet"
-require "steam/packets/a2a_ping_packet"
-require "steam/packets/a2a_ack_packet"
-require "steam/packets/a2s_player_packet"
-require "steam/packets/s2a_player_packet"
-require "steam/packets/a2s_rules_packet"
-require "steam/packets/s2a_rules_packet"
-require "steam/packets/a2s_serverquery_getchallenge_packet"
-require "steam/packets/s2c_challenge_packet"
-require "steam/packets/a2m_get_servers_batch2_packet"
-require "steam/packets/m2a_server_batch_packet"
-require "steam/packets/rcon/rcon_goldsrc_response"
+require 'abstract_class'
+require 'exceptions/steam_condenser_exception'
+require 'steam/packets/s2a_info_detailed_packet'
+require 'steam/packets/a2s_info_packet'
+require 'steam/packets/s2a_info2_packet'
+require 'steam/packets/a2a_ping_packet'
+require 'steam/packets/a2a_ack_packet'
+require 'steam/packets/a2s_player_packet'
+require 'steam/packets/s2a_player_packet'
+require 'steam/packets/a2s_rules_packet'
+require 'steam/packets/s2a_rules_packet'
+require 'steam/packets/a2s_serverquery_getchallenge_packet'
+require 'steam/packets/s2c_challenge_packet'
+require 'steam/packets/a2m_get_servers_batch2_packet'
+require 'steam/packets/m2a_server_batch_packet'
+require 'steam/packets/rcon/rcon_goldsrc_response'
 
 class SteamPacketFactory
-  
+
   include AbstractClass
-  
+
   # Creates a new packet object based on the header byte of the given raw data
-  def self.get_packet_from_data(raw_data)
-    header = raw_data[0].to_i;
-    data = raw_data[1..-1];
-    
+  def self.packet_from_data(raw_data)
+    header = raw_data[0].to_i
+    data = raw_data[1..-1]
+
     case header
       when SteamPacket::S2A_INFO_DETAILED_HEADER
         return S2A_INFO_DETAILED_Packet.new(data)
       when SteamPacket::A2S_INFO_HEADER
-        return A2S_INFO_Packet.new;
+        return A2S_INFO_Packet.new
       when SteamPacket::S2A_INFO2_HEADER
         return S2A_INFO2_Packet.new(data)
       when SteamPacket::A2A_PING_HEADER
@@ -54,7 +55,7 @@ class SteamPacketFactory
       when SteamPacket::S2C_CHALLENGE_HEADER
         return S2C_CHALLENGE_Packet.new(data)
       when SteamPacket::A2M_GET_SERVERS_BATCH2_HEADER
-        return A2M_GET_SERVERS_BATCH2.new(data)
+        return A2M_GET_SERVERS_BATCH2_Packet.new(data)
       when SteamPacket::M2A_SERVER_BATCH_HEADER
         return M2A_SERVER_BATCH_Packet.new(data)
       when SteamPacket::RCON_GOLDSRC_CHALLENGE_HEADER,
@@ -62,29 +63,27 @@ class SteamPacketFactory
            SteamPacket::RCON_GOLDSRC_RESPONSE_HEADER
         return RCONGoldSrcResponse.new(data)
       else
-        raise Exception.new("Unknown packet with header 0x#{header.to_s 16} received.")
+        raise SteamCondenserException.new("Unknown packet with header 0x#{header.to_s(16)} received.")
     end
   end
-  
+
   def self.reassemble_packet(split_packets, is_compressed = false, packet_checksum = 0)
-    packet_data = split_packets.join ""
-    
+    packet_data = split_packets.join ''
+
     if is_compressed
       begin
         require 'bz2'
         packet_data = BZ2.uncompress(packet_data)
       rescue LoadError
-        raise SteamCondenserException.new("You need to install the libbzip2 interface for Ruby.")
+        raise SteamCondenserException.new('You need to install the libbzip2 interface for Ruby.')
       end
-      
-      if Zlib.crc32(packet_data) != packet_checksum
-        raise PacketFormatException.new("CRC32 checksum mismatch of uncompressed packet data.")
+
+      unless Zlib.crc32(packet_data) == packet_checksum
+        raise PacketFormatException.new('CRC32 checksum mismatch of uncompressed packet data.')
       end
     end
-    
-    packet_data = packet_data[4..-1]
-    
-    return self.get_packet_from_data(packet_data)
+
+    packet_from_data packet_data[4..-1]
   end
-  
-end
+
+end