steam-condenser 0.10.1 → 0.11.0

data/lib/steam/servers/game_server.rb

@@ -1,92 +1,81 @@
 # 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
-
-require "abstract_class"
-require "exceptions/steam_condenser_exception"
-require "steam/steam_player"
-require "steam/packets/a2s_info_packet"
-require "steam/packets/a2a_ping_packet"
-require "steam/packets/a2s_player_packet"
-require "steam/packets/a2s_rules_packet"
-require "steam/packets/a2s_serverquery_getchallenge_packet"
-require "steam/packets/s2a_info_base_packet"
-require "steam/packets/s2a_player_packet"
-require "steam/packets/s2a_rules_packet"
-require "steam/packets/s2c_challenge_packet"
+# Copyright (c) 2008-2010, Sebastian Staudt
+
+require 'abstract_class'
+require 'exceptions/steam_condenser_exception'
+require 'steam/steam_player'
+require 'steam/packets/a2s_info_packet'
+require 'steam/packets/a2a_ping_packet'
+require 'steam/packets/a2s_player_packet'
+require 'steam/packets/a2s_rules_packet'
+require 'steam/packets/a2s_serverquery_getchallenge_packet'
+require 'steam/packets/s2a_info_base_packet'
+require 'steam/packets/s2a_player_packet'
+require 'steam/packets/s2a_rules_packet'
+require 'steam/packets/s2c_challenge_packet'
 
 class GameServer
-  
+
   include AbstractClass
-  
+
   REQUEST_CHALLENGE = 0
   REQUEST_INFO = 1
   REQUEST_PLAYER = 2
   REQUEST_RULES = 3
-  
+
   # Returns the last measured response time of this server
   #
   # If there's no data, update_ping is called to measure the current response
   # time of the server.
   #
   # Whenever you want to get a new value for the ping time call update_ping.
-  def get_ping
-    if @ping == nil
-      self.update_ping
-    end
-    return @ping
+  def ping
+    update_ping if @ping.nil?
+    @ping
   end
-  
+
   # Returns an array of the player's currently playing on this server.
   #
   # If there's no data, update_player_info is called to get the current list of
   # players.
-  #  
+  #
   # As the players and their scores change quite often be sure to update this
   # list regularly by calling update_player_info.
-  def get_players(rcon_password = nil)
-    if @player_hash == nil
-      self.update_player_info(rcon_password)
-    end
-    
-    return @player_hash
+  def players(rcon_password = nil)
+    update_player_info(rcon_password) if @player_hash.nil?
+    @player_hash
   end
-  
+
   # Returns a hash of the settings applied on the server. These settings are
   # also called rules.
   # The hash has the format of +rule_name+ => +rule_value+
-  # 
+  #
   # If there's no data, update_rules_info is called to get the current list of
   # rules.
   #
   # As the rules usually don't change often, there's almost no need to update
   # this hash. But if you need to, you can achieve this by calling
   # update_rules_info.
-  def get_rules
-    if @rules_hash == nil
-      self.update_rules_info
-    end
-    
-    return @rules_hash
+  def rules
+    update_rules_info if @rules_hash.nil?
+    @rules_hash
   end
-  
+
   # Returns a hash with basic information on the server.
-  # 
+  #
   # If there's no data, update_server_info is called to get up-to-date
   # information.
   #
   # The server information usually only changes on map change and when players
   # join or leave. As the latter changes can be monitored by calling
   # update_player_info, there's no need to call update_server_info very often.
-  def get_server_info
-    if @info_hash == nil
-      self.update_server_info
-    end
-    
-    return @info_hash
+  def server_info
+    update_server_info if @info_hash.nil?
+    @info_hash
   end
-  
+
   def handle_response_for_request(request_type, repeat_on_failure = true)
     begin
       case request_type
@@ -105,39 +94,39 @@ class GameServer
         else
           raise SteamCondenserException.new("Called with wrong request type.")
       end
-      
-      self.send_request request_packet
-      response_packet = self.get_reply
+
+      send_request request_packet
+      response_packet = reply
 
       if response_packet.kind_of? S2A_INFO_BasePacket
-        @info_hash = response_packet.get_info_hash
+        @info_hash = response_packet.info_hash
       elsif response_packet.kind_of? S2A_PLAYER_Packet
         @player_hash = response_packet.player_hash
       elsif response_packet.kind_of? S2A_RULES_Packet
-        @rules_hash = response_packet.get_rules_hash
+        @rules_hash = response_packet.rules_hash
       elsif response_packet.kind_of? S2C_CHALLENGE_Packet
-        @challenge_number = response_packet.get_challenge_number
+        @challenge_number = response_packet.challenge_number
       else
         raise SteamCondenserException.new("Response of type #{response_packet.class} cannot be handled by this method.")
       end
-      
+
       unless response_packet.kind_of? expected_response
         puts "Expected #{expected_response}, got #{response_packet.class}." if $DEBUG
-        self.handle_response_for_request(request_type, false) if repeat_on_failure
+        handle_response_for_request(request_type, false) if repeat_on_failure
       end
     rescue TimeoutException
       puts "Expected #{expected_response}, but timed out." if $DEBUG
     end
   end
-  
+
   def init
-    self.update_ping
-    self.update_server_info
-    self.update_challenge_number
+    update_ping
+    update_server_info
+    update_challenge_number
   end
 
   def update_player_info(rcon_password = nil)
-    self.handle_response_for_request GameServer::REQUEST_PLAYER
+    handle_response_for_request GameServer::REQUEST_PLAYER
 
     unless rcon_password.nil? or @player_hash.empty?
       rcon_auth(rcon_password)
@@ -152,69 +141,70 @@ class GameServer
   end
 
   def update_rules_info
-    self.handle_response_for_request GameServer::REQUEST_RULES
+    handle_response_for_request GameServer::REQUEST_RULES
   end
-  
+
   def update_server_info
-    self.handle_response_for_request GameServer::REQUEST_INFO
+    handle_response_for_request GameServer::REQUEST_INFO
   end
-  
+
   def update_challenge_number
-    self.handle_response_for_request GameServer::REQUEST_CHALLENGE
+    handle_response_for_request GameServer::REQUEST_CHALLENGE
   end
- 
+
   def update_ping
-    self.send_request A2A_PING_Packet.new
+    send_request A2A_PING_Packet.new
     start_time = Time.now
-    self.get_reply
+    reply
     end_time = Time.now
-    return @ping = (end_time - start_time) * 1000
+    @ping = (end_time - start_time) * 1000
   end
-  
-  # Checks whether the listening port number of the server is in a valid range 
+
+  # Checks whether the listening port number of the server is in a valid range
   def initialize(port_number = 27015)
     unless port_number.to_i > 0 and port_number.to_i < 65536
-      raise ArgumentError.new("The listening port of the server has to be a number greater than 0 and less than 65536.")
+      raise ArgumentError.new('The listening port of the server has to be a number greater than 0 and less than 65536.')
     end
   end
-  
+
   def to_s
-    return_string = ""
-    
+    return_string = ''
+
     return_string << "Ping: #{@ping}\n"
     return_string << "Challenge number: #{@challenge_number}\n"
-    
-    if @info_hash != nil
+
+    unless @info_hash.nil?
       return_string << "Info:\n"
       @info_hash.each do |key, value|
         return_string << "  #{key}: #{value.inspect}\n"
       end
     end
-    
-    if @player_hash != nil
+
+    unless @player_hash.nil?
       return_string << "Players:\n"
       @player_hash.each_value do |player|
         return_string << "  #{player}\n"
       end
     end
-    
-    if @rules_hash != nil
+
+    unless @rules_hash.nil?
       return_string << "Rules:\n"
       @rules_hash.each do |key, value|
         return_string << "  #{key}: #{value}\n"
       end
     end
-    
-    return return_string
+
+    return_string
   end
 
   protected
 
-  def get_reply
-    @socket.get_reply
+  def reply
+    @socket.reply
   end
-  
+
   def send_request packet
     @socket.send packet
   end
+
 end

data/lib/steam/servers/goldsrc_server.rb

@@ -1,10 +1,10 @@
 # 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/servers/game_server"
-require "steam/sockets/goldsrc_socket"
+require 'steam/servers/game_server'
+require 'steam/sockets/goldsrc_socket'
 
 class GoldSrcServer < GameServer
 
@@ -26,11 +26,11 @@ class GoldSrcServer < GameServer
 
   def rcon_auth(password)
     @rcon_password = password
-    return true
+    true
   end
 
   def rcon_exec(command)
-    return @socket.rcon_exec(@rcon_password, command).strip
+    @socket.rcon_exec(@rcon_password, command).strip
   end
 
 end

data/lib/steam/servers/master_server.rb

@@ -1,15 +1,15 @@
 # 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/a2m_get_servers_batch2_packet"
-require "steam/sockets/master_server_socket"
+require 'steam/packets/a2m_get_servers_batch2_packet'
+require 'steam/sockets/master_server_socket'
 
 class MasterServer
-  
-  GOLDSRC_MASTER_SERVER = "hl1master.steampowered.com", 27010
-  SOURCE_MASTER_SERVER = "hl2master.steampowered.com", 27011
+
+  GOLDSRC_MASTER_SERVER = 'hl1master.steampowered.com', 27013
+  SOURCE_MASTER_SERVER = 'hl2master.steampowered.com', 27011
 
   REGION_US_EAST_COAST = 0x00
   REGION_US_WEST_COAST = 0x01
@@ -20,39 +20,39 @@ class MasterServer
   REGION_MIDDLE_EAST = 0x06
   REGION_AFRICA = 0x07
   REGION_ALL = 0xFF
-  
+
   def initialize(master_server_address, master_server_port)
     @socket = MasterServerSocket.new master_server_address, master_server_port
-    @server_array = Array.new
+    @server_array = []
   end
-  
-  def get_servers(region_code = MasterServer::REGION_ALL, filters = "")
-    if @server_array.empty?
-      self.update_servers region_code, filters
-    end
-    
-    return @server_array
+
+  def servers(region_code = MasterServer::REGION_ALL, filters = '')
+    update_servers region_code, filters if @server_array.empty?
+    @server_array
   end
-  
+
   def update_servers(region_code, filters)
-    finished = false
-    current_server = "0.0.0.0:0"
-    
+    fail_count     = 0
+    finished       = false
+    current_server = '0.0.0.0:0'
+
     begin
       @socket.send A2M_GET_SERVERS_BATCH2_Packet.new(region_code, current_server, filters)
       begin
-        servers = @socket.get_reply.get_servers
+        servers = @socket.reply.servers
         servers.each do |server|
-          if server == "0.0.0.0:0"
+          if server == '0.0.0.0:0'
             finished = true
           else
             current_server = server
-            @server_array << server.split(":")
+            @server_array << server.split(':')
           end
         end
+        fail_count = 0
       rescue TimeoutException
+        raise $! if (fail_count += 1) == 3
       end
     end while !finished
   end
-  
-end
+
+end

data/lib/steam/servers/source_server.rb

@@ -1,15 +1,15 @@
 # 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 "exceptions/rcon_no_auth_exception"
-require "steam/packets/rcon/rcon_auth_request"
-require "steam/packets/rcon/rcon_auth_response"
-require "steam/packets/rcon/rcon_exec_request"
-require "steam/servers/game_server"
-require "steam/sockets/rcon_socket"
-require "steam/sockets/source_socket"
+require 'exceptions/rcon_no_auth_exception'
+require 'steam/packets/rcon/rcon_auth_request'
+require 'steam/packets/rcon/rcon_auth_response'
+require 'steam/packets/rcon/rcon_exec_request'
+require 'steam/servers/game_server'
+require 'steam/sockets/rcon_socket'
+require 'steam/sockets/source_socket'
 
 class SourceServer < GameServer
 
@@ -32,23 +32,21 @@ class SourceServer < GameServer
     @rcon_request_id = rand 2**16
 
     @rcon_socket.send RCONAuthRequest.new(@rcon_request_id, password)
-    @rcon_socket.get_reply
-    reply = @rcon_socket.get_reply
+    @rcon_socket.reply
+    reply = @rcon_socket.reply
 
-    if reply.request_id == -1
-      raise RCONNoAuthException.new
-    end
+    raise RCONNoAuthException.new if reply.request_id == -1
 
-    return reply.get_request_id == @rcon_request_id
+    reply.request_id == @rcon_request_id
   end
 
   def rcon_exec(command)
     @rcon_socket.send RCONExecRequest.new(@rcon_request_id, command)
-    response_packets = Array.new
+    response_packets = []
 
     begin
       begin
-        response_packet = @rcon_socket.get_reply
+        response_packet = @rcon_socket.reply
         raise RCONNoAuthException.new if response_packet.is_a? RCONAuthResponse
         response_packets << response_packet
       end while true
@@ -56,12 +54,12 @@ class SourceServer < GameServer
       raise $! if response_packets.empty?
     end
 
-    response = String.new
+    response = ''
     response_packets.each do |packet|
-      response << packet.get_response
+      response << packet.response
     end
 
-    return response.strip
+    response.strip
   end
 
 end