steam-condenser 1.1.0 → 1.2.0

data/lib/steam/community/tf2/tf2_sniper.rb

@@ -8,9 +8,7 @@ require 'steam/community/tf2/tf2_class'
 # Represents the stats for the Team Fortress 2 Sniper class for a specific user
 #
 # @author Sebastian Staudt
-class TF2Sniper
-
-  include TF2Class
+class TF2Sniper < TF2Class
 
   # Returns the maximum number enemies killed with a headshot by the player in
   # a single life as a Sniper
@@ -20,11 +18,11 @@ class TF2Sniper
 
   # Creates a new instance of the Sniper class based on the given XML data
   #
-  # @param [REXML::Element] class_data The XML data for this Sniper
+  # @param [Hash<String, Object>] class_data The XML data for this Sniper
   def initialize(class_data)
     super class_data
 
-    @max_headshots = class_data.elements['iheadshots'].text.to_i
+    @max_headshots = class_data['iheadshots'].to_i
   end
 
 end

data/lib/steam/community/tf2/tf2_spy.rb

@@ -8,9 +8,7 @@ require 'steam/community/tf2/tf2_class'
 # Represents the stats for the Team Fortress 2 Spy class for a specific user
 #
 # @author Sebastian Staudt
-class TF2Spy
-
-  include TF2Class
+class TF2Spy < TF2Class
 
   # Returns the maximum number enemies killed with a backstab by the player in
   # a single life as a Spy
@@ -18,6 +16,11 @@ class TF2Spy
   # @return [Fixnum] Maximum number of buildings built
   attr_reader :max_backstabs
 
+  # Returns the head shots by the player in a single life as a Spy
+  #
+  # @return [Fixnum] Maximum number of head shots
+  attr_reader :max_head_shots
+
   # Returns the maximum health leeched from enemies by the player in a single
   # life as a Spy
   #
@@ -26,12 +29,13 @@ class TF2Spy
 
   # Creates a new instance of the Spy class based on the given XML data
   #
-  # @param [REXML::Element] class_data The XML data for this Spy
+  # @param [Hash<String, Object>] class_data The XML data for this Spy
   def initialize(class_data)
     super class_data
 
-    @max_backstabs      = class_data.elements['ibackstabs'].text.to_i
-    @max_health_leeched = class_data.elements['ihealthpointsleached'].text.to_i
+    @max_backstabs      = class_data['ibackstabs'].to_i
+    @max_head_shots     = class_data['iheadshots'].to_i
+    @max_health_leeched = class_data['ihealthpointsleached'].to_i
   end
 
 end

data/lib/steam/community/tf2/tf2_stats.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-2011, Sebastian Staudt
+# Copyright (c) 2008-2012, Sebastian Staudt
 
 require 'steam/community/game_stats'
 require 'steam/community/tf2/tf2_beta_inventory'
@@ -19,6 +19,11 @@ class TF2Stats < GameStats
   # @return [Fixnum] This player's accumulated points
   attr_reader :accumulated_points
 
+  # Returns the accumulated number of seconds this player has spent playing as a TF2 class
+  #
+  # @return [Fixnum] total seconds played as a TF2 class
+  attr_reader :total_playtime
+
   # Creates a `TF2Stats` instance by calling the super constructor with the
   # game name `'tf2'`
   #
@@ -28,8 +33,11 @@ class TF2Stats < GameStats
   def initialize(steam_id, beta = false)
     super steam_id, (beta ? '520' : 'tf2')
 
-    if public? && !@xml_data.elements['stats/accumulatedPoints'].nil?
-      @accumulated_points = @xml_data.elements['stats/accumulatedPoints'].text.to_i
+    if public? && !@xml_data['stats']['accumulatedPoints'].nil?
+      @accumulated_points = @xml_data['stats']['accumulatedPoints'].to_i
+    end
+    if public? && !@xml_data['stats']['secondsPlayedAllClassesLifetime'].nil?
+      @total_playtime = @xml_data['stats']['secondsPlayedAllClassesLifetime']
     end
   end
 
@@ -44,8 +52,8 @@ class TF2Stats < GameStats
 
     if @class_stats.nil?
       @class_stats = Hash.new
-      @xml_data.elements.each('stats/classData') do |class_data|
-        @class_stats[class_data.elements['className'].text] = TF2ClassFactory.tf2_class(class_data)
+      @xml_data['stats']['classData'].each do |class_data|
+        @class_stats[class_data['className']] = TF2ClassFactory.tf2_class(class_data)
       end
     end
 
@@ -58,8 +66,8 @@ class TF2Stats < GameStats
   # @return [TF2Inventory] This player's TF2 backpack
   def inventory
     if @inventory.nil?
-      inventory_class = (game_friendly_name == 'tf2') ? TF2Inventory : TF2BetaInventory
-      @inventory = inventory_class.new(steam_id64) if @inventory.nil?
+      inventory_class = (game.short_name == 'tf2') ? TF2Inventory : TF2BetaInventory
+      @inventory = inventory_class.new(user.steam_id64) if @inventory.nil?
     end
 
     @inventory

data/lib/steam/community/web_api.rb

@@ -16,6 +16,8 @@ require 'errors/web_api_error'
 # @author Sebastian
 module WebApi
 
+  @@api_key = nil
+
   # Returns the Steam Web API key currently used by Steam Condenser
   #
   # @return [String] The currently active Steam Web API key
@@ -37,6 +39,18 @@ module WebApi
     @@api_key = api_key
   end
 
+  # Returns a raw list of interfaces and their methods that are available in
+  # Steam's Web API
+  #
+  # This can be used for reference when accessing interfaces and methods that
+  # have not yet been implemented by Steam Condenser.
+  #
+  # @return [Array<Hash>] The list of interfaces and methods
+  def self.interfaces
+    data = json 'ISteamWebAPIUtil', 'GetSupportedAPIList'
+    MultiJson.load(data, { :symbolize_keys => true })[:apilist][:interfaces]
+  end
+
   # Fetches JSON data from Steam Web API using the specified interface, method
   # and version. Additional parameters are supplied via HTTP GET.
   # Data is returned as a JSON-encoded string.
@@ -67,7 +81,7 @@ module WebApi
   # @return [Hash<Symbol, Object>] The JSON data replied to the request
   def self.json!(interface, method, version = 1, params = nil)
     data = json(interface, method, version, params)
-    result = MultiJson.decode(data, { :symbolize_keys => true })[:result]
+    result = MultiJson.load(data, { :symbolize_keys => true })[:result]
 
     status = result[:status]
     if status != 1

data/lib/steam/community/xml_data.rb

@@ -0,0 +1,17 @@
+# 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 'open-uri'
+
+require 'multi_xml'
+
+module XMLData
+
+  def parse(url)
+    data = open(url, { :proxy => true })
+    @xml_data = MultiXml.parse(data).values.first
+  end
+
+end

data/lib/steam/servers/game_server.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-2011, Sebastian Staudt
+# Copyright (c) 2008-2012, Sebastian Staudt
 
 require 'errors/steam_condenser_error'
 require 'errors/timeout_error'
@@ -203,7 +203,7 @@ module GameServer
   def handle_response_for_request(request_type, repeat_on_failure = true)
     case request_type
       when :challenge then
-        request_packet = A2S_SERVERQUERY_GETCHALLENGE_Packet.new
+        request_packet = A2S_PLAYER_Packet.new
         expected_response = S2C_CHALLENGE_Packet
       when :info then
         request_packet = A2S_INFO_Packet.new
@@ -346,8 +346,8 @@ module GameServer
   def to_s
     return_string = ''
 
-    return_string << "Ping: #{@ping}\n"
-    return_string << "Challenge number: #{@challenge_number}\n"
+    return_string << "Ping: #@ping\n"
+    return_string << "Challenge number: #@challenge_number\n"
 
     unless @info_hash.nil?
       return_string << "Info:\n"

data/lib/steam/servers/master_server.rb

@@ -28,7 +28,7 @@ class MasterServer
   # The master server address to query for GoldSrc game servers
   GOLDSRC_MASTER_SERVER = 'hl1master.steampowered.com', 27010
 
-  # The master server address to query for GoldSrc game servers
+  # The master server address to query for Source game servers
   SOURCE_MASTER_SERVER = 'hl2master.steampowered.com', 27011
 
   # The region code for the US east coast
@@ -103,7 +103,7 @@ class MasterServer
   # * `\map\[mapname]`: Request only servers running a specific map
   # * `\linux\1`: Request only linux servers
   # * `\emtpy\1`: Request only **non**-empty servers
-  # * `\full\`: Request only servers **not** full
+  # * `\full\1`: Request only servers **not** full
   # * `\proxy\1`: Request only spectator proxy servers
   #
   # @note Receiving all servers from the master server is taking quite some

data/lib/steam/servers/source_server.rb

@@ -68,8 +68,6 @@ class SourceServer
     @rcon_socket.reply
     reply = @rcon_socket.reply
 
-    raise RCONNoAuthError if reply.request_id == -1
-
     @rcon_authenticated = reply.request_id == @rcon_request_id
   end
 

data/lib/steam/sockets/goldsrc_socket.rb

@@ -90,8 +90,8 @@ class GoldSrcSocket
   def rcon_exec(password, command)
     rcon_challenge if @rcon_challenge.nil? || @is_hltv
 
-    rcon_send "rcon #{@rcon_challenge} #{password} #{command}"
-    rcon_send "rcon #{@rcon_challenge} #{password}"
+    rcon_send "rcon #@rcon_challenge #{password} #{command}"
+    rcon_send "rcon #@rcon_challenge #{password}"
     if @is_hltv
       begin
         response = reply.response

data/lib/steam/steam_player.rb

@@ -134,9 +134,9 @@ class SteamPlayer
   # @return [String] A string representing this player
   def to_s
     if @extended
-      "\##{@real_id} \"#{@name}\", SteamID: #{@steam_id}, Score: #{@score}, Time: #{@connect_time}"
+      "\##@real_id \"#@name\", SteamID: #@steam_id, Score: #@score, Time: #@connect_time"
     else
-      "\##{@id} \"#{@name}\", Score: #{@score}, Time: #{@connect_time}"
+      "\##@id \"#@name\", Score: #@score, Time: #@connect_time"
     end
   end
 

data/steam-condenser.gemspec

@@ -11,9 +11,10 @@ Gem::Specification.new do |s|
   s.description = 'A multi-language library for querying the Steam Community, Source, GoldSrc servers and Steam master servers'
 
   s.add_dependency 'bzip2-ruby', '~> 0.2.7'
-  s.add_dependency 'multi_json', '~> 1.0.3'
+  s.add_dependency 'multi_json', '~> 1.3.1'
+  s.add_dependency 'multi_xml', '~> 0.4.1'
 
-  s.add_development_dependency 'mocha', '~> 0.10.0'
+  s.add_development_dependency 'mocha', '~> 0.11.1'
   s.add_development_dependency 'rake', '~> 0.9.2'
   s.add_development_dependency 'shoulda-context', '~> 1.0.0'
   s.add_development_dependency 'yard', '~> 0.7.2'

data/test/helper.rb

@@ -26,12 +26,20 @@ class Test::Unit::TestCase
     assert !boolean, message
   end
 
-  # Reads a file with fixtures from `./test/`
+  # Reads the contents of a fixture file from `./test/`
   #
   # @param [String] name The name of the fixtures file
   # @return [String] The contents of the file
   def fixture(name)
-    File.read File.join(File.dirname(__FILE__), 'fixtures', name)
+    fixture_io(name).read
+  end
+
+  # Opens a file with fixtures from `./test/`
+  #
+  # @param [String] name The name of the fixtures file
+  # @return [File] The file handle
+  def fixture_io(name)
+    File.open File.join(File.dirname(__FILE__), 'fixtures', name)
   end
 
 end

data/test/steam/communtiy/test_steam_group.rb

@@ -29,7 +29,7 @@ class TestSteamGroup < Test::Unit::TestCase
     end
 
     should 'be able to fetch its members' do
-      url = mock :read => fixture('valve-members.xml')
+      url = fixture_io 'valve-members.xml'
       SteamGroup.any_instance.expects(:open).with('http://steamcommunity.com/groups/valve/memberslistxml?p=1', { :proxy => true }).returns url
 
       group = SteamGroup.new 'valve'
@@ -58,7 +58,7 @@ class TestSteamGroup < Test::Unit::TestCase
 
     should 'raise an exception when parsing invalid XML' do
       error = assert_raises SteamCondenserError do
-        url = mock :read => fixture('invalid.xml')
+        url = fixture_io 'invalid.xml'
         SteamGroup.any_instance.expects(:open).with('http://steamcommunity.com/groups/valve/memberslistxml?p=1', { :proxy => true }).returns url
 
         SteamGroup.new 'valve'
@@ -67,8 +67,8 @@ class TestSteamGroup < Test::Unit::TestCase
     end
 
     should 'be able to parse just the member count' do
-      url = mock :read => fixture('valve-members.xml')
-      SteamGroup.any_instance.expects(:open).with('http://steamcommunity.com/groups/valve/memberslistxml', { :proxy => true }).returns url
+      url = fixture_io 'valve-members.xml'
+      SteamGroup.any_instance.expects(:open).with('http://steamcommunity.com/groups/valve/memberslistxml?p=1', { :proxy => true }).returns url
 
       group = SteamGroup.new 'valve', false
       assert_equal 221, group.member_count

data/test/steam/communtiy/test_steam_id.rb

@@ -42,14 +42,40 @@ class TestSteamId < Test::Unit::TestCase
       assert SteamId.cached? 'son_of_Thor'
     end
 
+    should 'have an ID' do
+      steam_id1 = SteamId.new 76561197983311154, false
+      steam_id2 = SteamId.new 'Son_of_Thor', false
+
+      assert_equal 76561197983311154, steam_id1.id
+      assert_equal 'son_of_thor', steam_id2.id
+    end
+
     should 'be able to fetch its data' do
-      url = mock :read => fixture('sonofthor.xml')
+      url = fixture_io 'sonofthor.xml'
       SteamId.any_instance.expects(:open).with('http://steamcommunity.com/id/son_of_thor?xml=1', { :proxy => true }).returns url
 
       steam_id = SteamId.new 'Son_of_Thor'
 
       assert_equal 76561197983311154, steam_id.steam_id64
+      assert_equal 'son_of_thor', steam_id.custom_url
+      assert_equal 'Bellevue, Washington, United States', steam_id.location
+      assert_equal 'Dad serious.', steam_id.head_line
+      assert_equal 'Son of Thor', steam_id.nickname
+      assert_equal 'Torsten Zabka', steam_id.real_name
+      assert_equal 'Last Online: 3 days ago', steam_id.state_message
+      assert_equal 'We jump that fence when we get to it.', steam_id.summary
+      assert_equal 'None', steam_id.trade_ban_state
+
+      assert_equal 'http://media.steampowered.com/steamcommunity/public/images/avatars/b8/b8438d91481295b7cc8da9578004cd63a2c3b2e4_full.jpg', steam_id.full_avatar_url
+      assert_equal 'http://media.steampowered.com/steamcommunity/public/images/avatars/b8/b8438d91481295b7cc8da9578004cd63a2c3b2e4.jpg', steam_id.icon_url
+      assert_equal 'http://media.steampowered.com/steamcommunity/public/images/avatars/b8/b8438d91481295b7cc8da9578004cd63a2c3b2e4_medium.jpg', steam_id.medium_avatar_url
+
+      assert_not steam_id.banned?
+      assert_not steam_id.limited?
+      assert_not steam_id.online?
       assert steam_id.fetched?
+
+      assert steam_id.public?
     end
 
     should 'be found by the 64bit SteamID' do
@@ -68,7 +94,7 @@ class TestSteamId < Test::Unit::TestCase
 
     should 'raise an exception when parsing invalid XML' do
       error = assert_raises SteamCondenserError do
-        url = mock :read => fixture('invalid.xml')
+        url = fixture_io 'invalid.xml'
         SteamId.any_instance.expects(:open).with('http://steamcommunity.com/id/son_of_thor?xml=1', { :proxy => true }).returns url
 
         SteamId.new 'Son_of_Thor'

data/test/steam/communtiy/test_web_api.rb

@@ -41,7 +41,7 @@ class TestWebApi < Test::Unit::TestCase
       data = mock
       WebApi.expects(:json).with('interface', 'method', 2, { :test => 'param' }).
         returns data
-      MultiJson.expects(:decode).with(data, { :symbolize_keys => true }).
+      MultiJson.expects(:load).with(data, { :symbolize_keys => true }).
         returns({ :result => { :status => 1 }})
 
       assert_equal({ :status => 1 }, WebApi.json!('interface', 'method', 2, { :test => 'param' }))
@@ -51,7 +51,7 @@ class TestWebApi < Test::Unit::TestCase
       data = mock
       WebApi.expects(:json).with('interface', 'method', 2, { :test => 'param' }).
         returns data
-      MultiJson.expects(:decode).with(data, { :symbolize_keys => true }).
+      MultiJson.expects(:load).with(data, { :symbolize_keys => true }).
         returns({ :result => { :status => 2, :statusDetail => 'error' } })
 
       error = assert_raises WebApiError do

data/test/steam/packets/test_steam_packet.rb

@@ -0,0 +1,37 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2012, Sebastian Staudt
+
+require 'helper'
+require 'steam/packets/steam_packet'
+
+class TestSteamPacket < Test::Unit::TestCase
+
+  class GenericSteamPacket
+    include SteamPacket
+  end
+
+  context 'A packet' do
+
+    setup do
+      @packet = GenericSteamPacket.new 0x61, 'test'
+    end
+
+    should 'have a data buffer' do
+      data = @packet.instance_variable_get(:@content_data)
+      assert_instance_of StringIO, data
+      assert_equal 'test', data.string
+    end
+
+    should 'know its header' do
+      assert_equal 0x61, @packet.instance_variable_get(:@header_data)
+    end
+
+    should 'have a valid byte representation' do
+      assert_equal "\xFF\xFF\xFF\xFFatest", @packet.to_s
+    end
+
+  end
+
+end

data/test/steam/servers/test_game_server.rb

@@ -1,308 +1,296 @@
-# 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 'helper'
-require 'steam/servers/game_server'
-
-class TestGameServer < Test::Unit::TestCase
-
-  context 'A generic game server' do
-
-    class GenericGameServer
-      include GameServer
-    end
-
-    setup do
-      Socket.stubs(:getaddrinfo).
-        with('game', 27015, Socket::AF_INET, Socket::SOCK_DGRAM).
-        returns [[nil, nil, 'game', '127.0.0.1']]
-      @socket = mock
-
-      @server = GenericGameServer.new 'game', 27015
-      @server.instance_variable_set :@socket, @socket
-    end
-
-    should 'send packets using its client socket' do
-      packet = mock
-      @socket.expects(:send).with packet
-
-      @server.send :send_request, packet
-    end
-
-    should 'get replies using its client socket' do
-      packet = mock
-      @socket.expects(:reply).returns packet
-
-      assert_equal packet, @server.send(:reply)
-    end
-
-    should 'be able to calculate the latency of the server' do
-      @server.expects(:send_request).with do |packet|
-        packet.is_a? A2S_INFO_Packet
-      end
-      @server.expects(:reply).with { || sleep 0.05 }
-
-      @server.update_ping
-      assert_operator @server.instance_variable_get(:@ping), :>=, 50
-    end
-
-    should 'be able to get a challenge from the server' do
-      @server.expects(:handle_response_for_request).with :challenge
-
-      @server.update_challenge_number
-    end
-
-    should 'be able to get information about server' do
-      @server.expects(:handle_response_for_request).with :info
-
-      @server.update_server_info
-    end
-
-    should 'be able to get the server rules' do
-      @server.expects(:handle_response_for_request).with :rules
-
-      @server.update_rules
-    end
-
-    should 'be able to get the players on the server' do
-      @server.expects(:handle_response_for_request).with :players
-
-      @server.update_players
-    end
-
-    should 'provide a convenience wrapper for basic server methods' do
-      @server.expects :update_ping
-      @server.expects :update_server_info
-      @server.expects :update_challenge_number
-
-      @server.init
-    end
-
-    should 'know if its RCON connection is authenticated' do
-      assert_equal @server.instance_variable_get(:@rcon_authenticated),
-                   @server.rcon_authenticated?
-    end
-
-    should 'cache the ping of the server' do
-      @server.expects :update_ping
-
-      @server.ping
-
-      @server.instance_variable_set :@ping, 0
-
-      @server.ping
-    end
-
-    should 'cache the players on the server' do
-      @server.expects :update_players
-
-      @server.players
-
-      @server.instance_variable_set :@player_hash, 0
-
-      @server.players
-    end
-
-    should 'cache the server rules' do
-      @server.expects :update_rules
-
-      @server.rules
-
-      @server.instance_variable_set :@rules_hash, 0
-
-      @server.rules
-    end
-
-    should 'cache the server information' do
-      @server.expects :update_server_info
-
-      @server.server_info
-
-      @server.instance_variable_set :@info_hash, 0
-
-      @server.server_info
-    end
-
-    context 'be able to get additional information about the players on a Source server' do
-
-      setup do
-        status = fixture 'status_source'
-
-        @someone = mock
-        @somebody = mock
-        player_hash = { 'someone' => @someone, 'somebody' => @somebody }
-        @server.instance_variable_set :@player_hash, player_hash
-
-        @server.expects(:handle_response_for_request).with :players
-        @server.expects(:rcon_exec).with('status').returns status
-
-        someone_data = { :name => 'someone', :userid => '1', :uniqueid => 'STEAM_0:0:123456', :score => '10', :time => '3:52', :ping => '12', :loss => '0', :state => 'active' }
-        somebody_data = { :name => 'somebody', :userid => '2', :uniqueid => 'STEAM_0:0:123457', :score => '3', :time => '2:42', :ping => '34', :loss => '0', :state => 'active' }
-
-        attributes = mock
-        GameServer.expects(:player_status_attributes).
-          with('userid name           uniqueid            score connected ping loss state').
-          returns attributes
-        GameServer.expects(:split_player_status).
-          with(attributes, '1 "someone"      STEAM_0:0:123456    10    3:52      12   0    active').
-          returns somebody_data
-        GameServer.expects(:split_player_status).
-          with(attributes, '2 "somebody"     STEAM_0:0:123457    3     2:42      34   0    active').
-          returns someone_data
-
-        @somebody.expects(:add_info).with somebody_data
-        @someone.expects(:add_info).with someone_data
-      end
-
-      should 'with the RCON password' do
-        @server.expects(:rcon_auth).with 'password'
-
-        @server.update_players 'password'
-      end
-
-      should 'if the RCON connection is authenticated' do
-        @server.instance_variable_set :@rcon_authenticated, true
-
-        @server.update_players
-      end
-
-    end
-
-    context 'be able to get additional information about the players on a GoldSrc server' do
-
-      setup do
-        status = fixture 'status_goldsrc'
-
-        @someone = mock
-        @somebody = mock
-        player_hash = { 'someone' => @someone, 'somebody' => @somebody }
-        @server.instance_variable_set :@player_hash, player_hash
-
-        @server.expects(:handle_response_for_request).with :players
-        @server.expects(:rcon_exec).with('status').returns status
-
-        someone_data = { :name => 'someone', :userid => '1', :uniqueid => 'STEAM_0:0:123456', :score => '10', :time => '3:52', :ping => '12', :loss => '0', :adr => '0' }
-        somebody_data = { :name => 'somebody', :userid => '2', :uniqueid => 'STEAM_0:0:123457', :score => '3', :time => '2:42', :ping => '34', :loss => '0', :adr => '0' }
-
-        attributes = mock
-        GameServer.expects(:player_status_attributes).
-          with('name userid uniqueid frag time ping loss adr').
-          returns attributes
-        GameServer.expects(:split_player_status).
-          with(attributes, '1   "someone" 1 STEAM_0:0:123456 10 3:52 12 0 0').
-          returns somebody_data
-        GameServer.expects(:split_player_status).
-          with(attributes, '2   "somebody" 2 STEAM_0:0:123457 3 2:42 34 0 0').
-          returns someone_data
-
-        @somebody.expects(:add_info).with somebody_data
-        @someone.expects(:add_info).with someone_data
-      end
-
-      should 'with the RCON password' do
-        @server.expects(:rcon_auth).with 'password'
-
-        @server.update_players 'password'
-      end
-
-      should 'if the RCON connection is authenticated' do
-        @server.instance_variable_set :@rcon_authenticated, true
-
-        @server.update_players
-      end
-
-    end
-
-    should 'handle challenge requests' do
-      @server.expects(:send_request).with do |packet|
-        packet.is_a? A2S_SERVERQUERY_GETCHALLENGE_Packet
-      end
-
-      packet = mock
-      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
-      packet.expects(:kind_of?).with(S2A_PLAYER_Packet).returns false
-      packet.expects(:kind_of?).with(S2A_RULES_Packet).returns false
-      packet.expects(:kind_of?).with(S2C_CHALLENGE_Packet).twice.returns true
-
-      packet.expects(:challenge_number).returns 1234
-      @server.expects(:reply).returns packet
-
-      @server.handle_response_for_request :challenge
-
-      assert_equal 1234, @server.instance_variable_get(:@challenge_number)
-    end
-
-    should 'handle info requests' do
-      @server.expects(:send_request).with do |packet|
-        packet.is_a? A2S_INFO_Packet
-      end
-
-      packet = mock
-      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).twice.returns true
-      packet.expects(:info_hash).returns({ :test => 'test' })
-      @server.expects(:reply).returns packet
-
-      @server.handle_response_for_request :info
-
-      assert_equal({ :test => 'test' }, @server.instance_variable_get(:@info_hash))
-    end
-
-    should 'server rule requests' do
-      @server.expects(:send_request).with do |packet|
-        packet.is_a? A2S_RULES_Packet
-      end
-
-      packet = mock
-      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
-      packet.expects(:kind_of?).with(S2A_PLAYER_Packet).returns false
-      packet.expects(:kind_of?).with(S2A_RULES_Packet).twice.returns true
-      packet.expects(:rules_hash).returns({ :test => 'test' })
-      @server.expects(:reply).returns packet
-
-      @server.handle_response_for_request :rules
-
-      assert_equal({ :test => 'test' }, @server.instance_variable_get(:@rules_hash))
-    end
-
-    should 'player requests' do
-      @server.expects(:send_request).with do |packet|
-        packet.is_a? A2S_PLAYER_Packet
-      end
-
-      packet = mock
-      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
-      packet.expects(:kind_of?).with(S2A_PLAYER_Packet).twice.returns true
-      packet.expects(:player_hash).returns({ :test => 'test' })
-      @server.expects(:reply).returns packet
-
-      @server.handle_response_for_request :players
-
-      assert_equal({ :test => 'test' }, @server.instance_variable_get(:@player_hash))
-    end
-
-    should 'handle unexpected answers and retry' do
-      @server.expects(:send_request).twice.with do |packet|
-        packet.is_a? A2S_PLAYER_Packet
-      end
-
-      packet1 = mock
-      packet1.expects(:kind_of?).with(S2A_INFO_BasePacket).returns true
-      packet1.expects(:kind_of?).with(S2A_PLAYER_Packet).returns false
-      packet1.expects(:info_hash).returns({ :test => 'test1' })
-      packet2 = mock
-      packet2.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
-      packet2.expects(:kind_of?).with(S2A_PLAYER_Packet).twice.returns true
-      packet2.expects(:player_hash).returns({ :test => 'test2' })
-      @server.expects(:reply).twice.returns(packet1).returns packet2
-
-      @server.handle_response_for_request :players
-
-      assert_equal({ :test => 'test1' }, @server.instance_variable_get(:@info_hash))
-      assert_equal({ :test => 'test2' }, @server.instance_variable_get(:@player_hash))
-    end
-
-  end
-
-end
+# 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 'helper'
+require 'steam/servers/game_server'
+
+class TestGameServer < Test::Unit::TestCase
+
+  context 'A generic game server' do
+
+    class GenericGameServer
+      include GameServer
+    end
+
+    setup do
+      Socket.stubs(:getaddrinfo).
+        with('game', 27015, Socket::AF_INET, Socket::SOCK_DGRAM).
+        returns [[nil, nil, 'game', '127.0.0.1']]
+      @socket = mock
+
+      @server = GenericGameServer.new 'game', 27015
+      @server.instance_variable_set :@socket, @socket
+    end
+
+    should 'send packets using its client socket' do
+      packet = mock
+      @socket.expects(:send).with packet
+
+      @server.send :send_request, packet
+    end
+
+    should 'get replies using its client socket' do
+      packet = mock
+      @socket.expects(:reply).returns packet
+
+      assert_equal packet, @server.send(:reply)
+    end
+
+    should 'be able to calculate the latency of the server' do
+      @server.expects(:send_request).with do |packet|
+        packet.is_a? A2S_INFO_Packet
+      end
+      @server.expects(:reply).with { || sleep 0.05 }
+
+      @server.update_ping
+      assert_operator @server.instance_variable_get(:@ping), :>=, 50
+    end
+
+    should 'be able to get a challenge from the server' do
+      @server.expects(:handle_response_for_request).with :challenge
+
+      @server.update_challenge_number
+    end
+
+    should 'be able to get information about server' do
+      @server.expects(:handle_response_for_request).with :info
+
+      @server.update_server_info
+    end
+
+    should 'be able to get the server rules' do
+      @server.expects(:handle_response_for_request).with :rules
+
+      @server.update_rules
+    end
+
+    should 'be able to get the players on the server' do
+      @server.expects(:handle_response_for_request).with :players
+
+      @server.update_players
+    end
+
+    should 'provide a convenience wrapper for basic server methods' do
+      @server.expects :update_ping
+      @server.expects :update_server_info
+      @server.expects :update_challenge_number
+
+      @server.init
+    end
+
+    should 'know if its RCON connection is authenticated' do
+      assert_equal @server.instance_variable_get(:@rcon_authenticated),
+                   @server.rcon_authenticated?
+    end
+
+    should 'cache the ping of the server' do
+      @server.expects :update_ping
+
+      @server.ping
+
+      @server.instance_variable_set :@ping, 0
+
+      @server.ping
+    end
+
+    should 'cache the players on the server' do
+      @server.expects :update_players
+
+      @server.players
+
+      @server.instance_variable_set :@player_hash, 0
+
+      @server.players
+    end
+
+    should 'cache the server rules' do
+      @server.expects :update_rules
+
+      @server.rules
+
+      @server.instance_variable_set :@rules_hash, 0
+
+      @server.rules
+    end
+
+    should 'cache the server information' do
+      @server.expects :update_server_info
+
+      @server.server_info
+
+      @server.instance_variable_set :@info_hash, 0
+
+      @server.server_info
+    end
+
+    context 'be able to get additional information about the players on a Source server' do
+
+      setup do
+        status = fixture 'status_source'
+
+        @someone = mock
+        @somebody = mock
+        player_hash = { 'someone' => @someone, 'somebody' => @somebody }
+        @server.instance_variable_set :@player_hash, player_hash
+
+        @server.expects(:handle_response_for_request).with :players
+        @server.expects(:rcon_exec).with('status').returns status
+
+        someone_data = { :name => 'someone', :userid => '1', :uniqueid => 'STEAM_0:0:123456', :score => '10', :time => '3:52', :ping => '12', :loss => '0', :state => 'active' }
+        somebody_data = { :name => 'somebody', :userid => '2', :uniqueid => 'STEAM_0:0:123457', :score => '3', :time => '2:42', :ping => '34', :loss => '0', :state => 'active' }
+
+        attributes = mock
+        GameServer.expects(:player_status_attributes).
+          with('userid name           uniqueid            score connected ping loss state').
+          returns attributes
+        GameServer.expects(:split_player_status).
+          with(attributes, '1 "someone"      STEAM_0:0:123456    10    3:52      12   0    active').
+          returns somebody_data
+        GameServer.expects(:split_player_status).
+          with(attributes, '2 "somebody"     STEAM_0:0:123457    3     2:42      34   0    active').
+          returns someone_data
+
+        @somebody.expects(:add_info).with somebody_data
+        @someone.expects(:add_info).with someone_data
+      end
+
+      should 'with the RCON password' do
+        @server.expects(:rcon_auth).with 'password'
+
+        @server.update_players 'password'
+      end
+
+      should 'if the RCON connection is authenticated' do
+        @server.instance_variable_set :@rcon_authenticated, true
+
+        @server.update_players
+      end
+
+    end
+
+    should 'be able to get additional information about the players on a GoldSrc server with the RCON password' do
+      status = fixture 'status_goldsrc'
+
+      @someone = mock
+      @somebody = mock
+      player_hash = { 'someone' => @someone, 'somebody' => @somebody }
+      @server.instance_variable_set :@player_hash, player_hash
+
+      @server.expects(:handle_response_for_request).with :players
+      @server.expects(:rcon_exec).with('status').returns status
+
+      someone_data = { :name => 'someone', :userid => '1', :uniqueid => 'STEAM_0:0:123456', :score => '10', :time => '3:52', :ping => '12', :loss => '0', :adr => '0' }
+      somebody_data = { :name => 'somebody', :userid => '2', :uniqueid => 'STEAM_0:0:123457', :score => '3', :time => '2:42', :ping => '34', :loss => '0', :adr => '0' }
+
+      attributes = mock
+      GameServer.expects(:player_status_attributes).
+        with('name userid uniqueid frag time ping loss adr').
+        returns attributes
+      GameServer.expects(:split_player_status).
+        with(attributes, '1   "someone" 1 STEAM_0:0:123456 10 3:52 12 0 0').
+        returns somebody_data
+      GameServer.expects(:split_player_status).
+        with(attributes, '2   "somebody" 2 STEAM_0:0:123457 3 2:42 34 0 0').
+        returns someone_data
+
+      @somebody.expects(:add_info).with somebody_data
+      @someone.expects(:add_info).with someone_data
+
+      @server.expects(:rcon_auth).with 'password'
+
+      @server.update_players 'password'
+    end
+
+    should 'handle challenge requests' do
+      @server.expects(:send_request).with do |packet|
+        packet.is_a? A2S_PLAYER_Packet
+      end
+
+      packet = mock
+      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
+      packet.expects(:kind_of?).with(S2A_PLAYER_Packet).returns false
+      packet.expects(:kind_of?).with(S2A_RULES_Packet).returns false
+      packet.expects(:kind_of?).with(S2C_CHALLENGE_Packet).twice.returns true
+
+      packet.expects(:challenge_number).returns 1234
+      @server.expects(:reply).returns packet
+
+      @server.handle_response_for_request :challenge
+
+      assert_equal 1234, @server.instance_variable_get(:@challenge_number)
+    end
+
+    should 'handle info requests' do
+      @server.expects(:send_request).with do |packet|
+        packet.is_a? A2S_INFO_Packet
+      end
+
+      packet = mock
+      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).twice.returns true
+      packet.expects(:info_hash).returns({ :test => 'test' })
+      @server.expects(:reply).returns packet
+
+      @server.handle_response_for_request :info
+
+      assert_equal({ :test => 'test' }, @server.instance_variable_get(:@info_hash))
+    end
+
+    should 'handle rule requests' do
+      @server.expects(:send_request).with do |packet|
+        packet.is_a? A2S_RULES_Packet
+      end
+
+      packet = mock
+      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
+      packet.expects(:kind_of?).with(S2A_PLAYER_Packet).returns false
+      packet.expects(:kind_of?).with(S2A_RULES_Packet).twice.returns true
+      packet.expects(:rules_hash).returns({ :test => 'test' })
+      @server.expects(:reply).returns packet
+
+      @server.handle_response_for_request :rules
+
+      assert_equal({ :test => 'test' }, @server.instance_variable_get(:@rules_hash))
+    end
+
+    should 'handle player requests' do
+      @server.expects(:send_request).with do |packet|
+        packet.is_a? A2S_PLAYER_Packet
+      end
+
+      packet = mock
+      packet.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
+      packet.expects(:kind_of?).with(S2A_PLAYER_Packet).twice.returns true
+      packet.expects(:player_hash).returns({ :test => 'test' })
+      @server.expects(:reply).returns packet
+
+      @server.handle_response_for_request :players
+
+      assert_equal({ :test => 'test' }, @server.instance_variable_get(:@player_hash))
+    end
+
+    should 'handle unexpected answers and retry' do
+      @server.expects(:send_request).twice.with do |packet|
+        packet.is_a? A2S_PLAYER_Packet
+      end
+
+      packet1 = mock
+      packet1.expects(:kind_of?).with(S2A_INFO_BasePacket).returns true
+      packet1.expects(:kind_of?).with(S2A_PLAYER_Packet).returns false
+      packet1.expects(:info_hash).returns({ :test => 'test1' })
+      packet2 = mock
+      packet2.expects(:kind_of?).with(S2A_INFO_BasePacket).returns false
+      packet2.expects(:kind_of?).with(S2A_PLAYER_Packet).twice.returns true
+      packet2.expects(:player_hash).returns({ :test => 'test2' })
+      @server.expects(:reply).twice.returns(packet1).returns packet2
+
+      @server.handle_response_for_request :players
+
+      assert_equal({ :test => 'test1' }, @server.instance_variable_get(:@info_hash))
+      assert_equal({ :test => 'test2' }, @server.instance_variable_get(:@player_hash))
+    end
+
+  end
+
+end