steam-condenser 0.8.0

data/lib/steam/steam_player.rb

@@ -0,0 +1,51 @@
+# 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 'exceptions/steam_condenser_exception'
+
+# The SteamPlayer class represents a player connected to a server
+class SteamPlayer
+
+  attr_reader :connect_time, :id, :name, :loss, :ping, :real_id, :score, :state,
+              :steam_id
+  
+  # Creates a new SteamPlayer object based on the given information
+  def initialize(id, name, score, connect_time)
+    @connect_time = connect_time
+    @id = id
+    @name = name
+    @score = score
+    @extended = false
+  end
+
+  # Extends this player object with additional information acquired using RCON
+  # status
+  def add_info(real_id, name, steam_id, *player_data)
+    @extended = true
+
+    raise SteamCondenserException.new('Information to add belongs to a different player.') unless name == @name
+
+    @real_id  = real_id
+    @steam_id = steam_id
+    if steam_id == 'BOT'
+      @state = player_data[0]
+    else
+      @addr  = player_data[4]
+      @loss  = player_data[2]
+      @ping  = player_data[1]
+      @state = player_data[3]
+    end
+  end
+
+  # Returns a String representation of this player
+  def to_s
+    if @extended
+      "\##{@real_id} \"#{@name}\", SteamID: #{@steam_id}, Score: #{@score}, Time: #{@connect_time}"
+    else
+      "\##{@id} \"#{@name}\", Score: #{@score}, Time: #{@connect_time}"
+    end
+  end
+  
+end

data/test/query_tests.rb

@@ -0,0 +1,71 @@
+# 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
+#
+# $Id$
+
+$:.push File.join(File.dirname(__FILE__), "../lib")
+
+require "exceptions/timeout_exception"
+require "ipaddr"
+require "steam/servers/goldsrc_server"
+require "steam/servers/master_server"
+require "steam/servers/source_server"
+require "test/unit"
+
+class QueryTests < Test::Unit::TestCase
+
+  # This test tries to initialize an invalid GoldSrc server
+  def test_invalid_goldsrc_server
+    assert_raise TimeoutException do
+      invalid_server = GoldSrcServer.new IPAddr.new("1.0.0.0")
+      invalid_server.get_ping
+    end
+  end
+
+  # This test tries to initialize an invalid Source server
+  def test_invalid_source_server
+    assert_raise TimeoutException do
+      invalid_server = SourceServer.new IPAddr.new("1.0.0.0")
+      invalid_server.get_ping
+    end
+  end
+  
+  # This test gets a random GoldSrc server from the master server and does a
+  # full query on it
+  def test_random_goldsrc_server
+    assert_nothing_raised do
+      master_server = MasterServer.new(*MasterServer::GOLDSRC_MASTER_SERVER)
+      servers = master_server.get_servers MasterServer::REGION_ALL, "\\type\\d\\empty\\1\\full\\1\\gamedir\\valve"
+
+      assert !servers.empty?, "Got no servers from master server."
+
+      server = GoldSrcServer.new(*servers[rand(servers.length)])
+      server.init
+      server.update_player_info
+      server.update_rules_info
+
+      print server.to_s
+    end
+  end
+  
+  # This test gets a random Source server from the master server and does a
+  # full query on it
+  def test_random_source_server
+    assert_nothing_raised do
+      master_server = MasterServer.new(*MasterServer::SOURCE_MASTER_SERVER)
+      servers = master_server.get_servers MasterServer::REGION_ALL, "\\type\\d\\empty\\1\\full\\1\\gamedir\\tf"
+
+      assert !servers.empty?, "Got no servers from master server."
+
+      server = SourceServer.new(*servers[rand(servers.length)])
+      server.init
+      server.update_player_info
+      server.update_rules_info
+
+      print server.to_s
+    end
+  end
+  
+end

data/test/rcon_tests.rb

@@ -0,0 +1,79 @@
+# 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
+#
+# $Id$
+
+$:.push File.join(File.dirname(__FILE__), "../lib")
+
+require "ipaddr"
+require "steam/servers/goldsrc_server"
+require "steam/servers/source_server"
+require "test/unit"
+
+class RCONTests < Test::Unit::TestCase
+
+  # This test tries to run the "status" command over RCON on a GoldSrc server
+  def test_long_rcon_goldsrc_server
+    assert_nothing_raised do
+      server = GoldSrcServer.new IPAddr.new("127.0.0.1")
+      server.rcon_auth "test"
+      rcon_reply = server.rcon_exec "cvarlist"
+      print "#{rcon_reply}\n"
+
+      assert(
+        rcon_reply.include?("CvarList ? for syntax"),
+        "Did not receive complete cvarlist.")
+    end
+  end
+  
+  # This test tries to run the "status" command over RCON on a Source server
+  def test_long_rcon_source_server
+    assert_nothing_raised do
+      server = SourceServer.new IPAddr.new("127.0.0.1")
+      if server.rcon_auth "test"
+        rcon_reply = server.rcon_exec "cvarlist"
+        print "#{rcon_reply}\n"
+      end
+
+      assert(
+        rcon_reply.include?("total convars/concommands"),
+        "Did not receive complete cvarlist.")
+    end
+  end
+  
+  # This test tries to run the "status" command over RCON on a GoldSrc server
+  def test_short_rcon_goldsrc_server
+    assert_nothing_raised do
+      server = GoldSrcServer.new IPAddr.new("127.0.0.1")
+      server.rcon_auth "test"
+      rcon_reply = server.rcon_exec "version"
+      print "#{rcon_reply}\n"
+
+      assert(
+        rcon_reply.include?("Protocol version") &&
+        rcon_reply.include?("Exe version") &&
+        rcon_reply.include?("Exe build"),
+        "Did not receive correct version response.");
+    end
+  end
+
+  # This test tries to run the "status" command over RCON on a Source server
+  def test_short_rcon_source_server
+    assert_nothing_raised do
+      server = SourceServer.new IPAddr.new("127.0.0.1")
+      if server.rcon_auth "test"
+        rcon_reply = server.rcon_exec "version"
+        print "#{rcon_reply}\n"
+      end
+
+      assert(
+        rcon_reply.include?("Protocol version") &&
+        rcon_reply.include?("Exe version") &&
+        rcon_reply.include?("Exe build"),
+        "Did not receive correct version response.");
+    end
+  end
+
+end

data/test/steam_community_tests.rb

@@ -0,0 +1,36 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008, Sebastian Staudt
+#
+# $Id$
+
+$:.push File.join(File.dirname(__FILE__), "../lib")
+
+require "steam/community/steam_id"
+require "test/unit"
+
+class SteamCommunityTests < Test::Unit::TestCase
+  
+  # This test tries to aquire information from a online Steam ID by using the
+  # custom URL. This test only passes if the parsing of the XML document works
+  def test_steam_id_by_custom_url
+    assert_nothing_raised do
+      steam_id = SteamId.new "Koraktor"
+      p steam_id
+      p steam_id.get_game_stats "TF2"
+    end
+  end
+
+  # This test tries to aquire information from a online Steam ID by using the
+  # 64bit numeric SteamID. This test only passes if the parsing of the XML
+  # document works
+  def test_steam_id_by_steamid_64
+    assert_nothing_raised do
+      steam_id = SteamId.new 76561197961384956
+      p steam_id
+      p steam_id.get_game_stats "TF2"
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: steam-condenser
+version: !ruby/object:Gem::Version 
+  version: 0.8.0
+platform: ruby
+authors: 
+- Sebastian Staudt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-13 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A multi-language library for querying Source, GoldSrc servers and Steam master servers
+email: koraktor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/abstract_class.rb
+- lib/byte_buffer.rb
+- lib/datagram_channel.rb
+- lib/exceptions/buffer_underflow_exception.rb
+- lib/exceptions/packet_format_exception.rb
+- lib/exceptions/rcon_no_auth_exception.rb
+- lib/exceptions/steam_condenser_exception.rb
+- lib/exceptions/timeout_exception.rb
+- lib/socket_channel.rb
+- lib/steam-condenser.rb
+- lib/steam/community/dods/dods_class.rb
+- lib/steam/community/dods/dods_stats.rb
+- lib/steam/community/dods/dods_weapon.rb
+- lib/steam/community/game_achievement.rb
+- lib/steam/community/game_class.rb
+- lib/steam/community/game_stats.rb
+- lib/steam/community/game_weapon.rb
+- lib/steam/community/l4d/l4d_explosive.rb
+- lib/steam/community/l4d/l4d_map.rb
+- lib/steam/community/l4d/l4d_stats.rb
+- lib/steam/community/l4d/l4d_weapon.rb
+- lib/steam/community/steam_group.rb
+- lib/steam/community/steam_id.rb
+- lib/steam/community/tf2/tf2_class.rb
+- lib/steam/community/tf2/tf2_class_factory.rb
+- lib/steam/community/tf2/tf2_engineer.rb
+- lib/steam/community/tf2/tf2_medic.rb
+- lib/steam/community/tf2/tf2_sniper.rb
+- lib/steam/community/tf2/tf2_spy.rb
+- lib/steam/community/tf2/tf2_stats.rb
+- lib/steam/packets/a2a_ack_packet.rb
+- lib/steam/packets/a2a_ping_packet.rb
+- lib/steam/packets/a2m_get_servers_batch2_packet.rb
+- lib/steam/packets/a2s_info_packet.rb
+- lib/steam/packets/a2s_player_packet.rb
+- lib/steam/packets/a2s_rules_packet.rb
+- lib/steam/packets/a2s_serverquery_getchallenge_packet.rb
+- lib/steam/packets/m2a_server_batch_packet.rb
+- lib/steam/packets/rcon/rcon_auth_request.rb
+- lib/steam/packets/rcon/rcon_auth_response.rb
+- lib/steam/packets/rcon/rcon_exec_request.rb
+- lib/steam/packets/rcon/rcon_exec_response.rb
+- lib/steam/packets/rcon/rcon_goldsrc_request.rb
+- lib/steam/packets/rcon/rcon_goldsrc_response.rb
+- lib/steam/packets/rcon/rcon_packet.rb
+- lib/steam/packets/rcon/rcon_packet_factory.rb
+- lib/steam/packets/request_with_challenge.rb
+- lib/steam/packets/s2a_info2_packet.rb
+- lib/steam/packets/s2a_info_base_packet.rb
+- lib/steam/packets/s2a_info_detailed_packet.rb
+- lib/steam/packets/s2a_player_packet.rb
+- lib/steam/packets/s2a_rules_packet.rb
+- lib/steam/packets/s2c_challenge_packet.rb
+- lib/steam/packets/steam_packet.rb
+- lib/steam/packets/steam_packet_factory.rb
+- lib/steam/servers/game_server.rb
+- lib/steam/servers/goldsrc_server.rb
+- lib/steam/servers/master_server.rb
+- lib/steam/servers/source_server.rb
+- lib/steam/sockets/goldsrc_socket.rb
+- lib/steam/sockets/master_server_socket.rb
+- lib/steam/sockets/rcon_socket.rb
+- lib/steam/sockets/source_socket.rb
+- lib/steam/sockets/steam_socket.rb
+- lib/steam/steam_player.rb
+- test/query_tests.rb
+- test/rcon_tests.rb
+- test/steam_community_tests.rb
+has_rdoc: true
+homepage: http://github.com/koraktor/steam-condenser
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --all
+- --inline-source
+- --line-numbers
+- --charset=utf-8
+- --webcvs=http://github.com/koraktor/steam-condenser/source/blob/master/ruby/%s
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: steam-condenser
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Steam Condenser - A Steam query library
+test_files: 
+- test/query_tests.rb
+- test/rcon_tests.rb
+- test/steam_community_tests.rb