steam-condenser 1.2.0 → 1.2.1

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_stats.rb

@@ -0,0 +1,76 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2012, Sebastian Staudt
+
+require 'steam/community/game_stats'
+require 'steam/community/tf2/tf2_beta_inventory'
+require 'steam/community/tf2/tf2_class_factory'
+require 'steam/community/tf2/tf2_inventory'
+
+# This class represents the game statistics for a single user in Team Fortress
+# 2
+#
+# @author Sebastian Staudt
+class TF2Stats < GameStats
+
+  # Returns the total points this player has achieved in his career
+  #
+  # @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'`
+  #
+  # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
+  #        user
+  # @param [Boolean] beta If `true, creates stats for the public TF2 beta
+  def initialize(steam_id, beta = false)
+    super steam_id, (beta ? '520' : 'tf2')
+
+    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
+
+  # Returns the statistics for all Team Fortress 2 classes for this user
+  #
+  # If the classes haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, TF2Class>] A hash storing individual stats for each
+  #         Team Fortress 2 class
+  def class_stats
+    return unless public?
+
+    if @class_stats.nil?
+      @class_stats = Hash.new
+      @xml_data['stats']['classData'].each do |class_data|
+        @class_stats[class_data['className']] = TF2ClassFactory.tf2_class(class_data)
+      end
+    end
+
+    @class_stats
+  end
+
+  # Returns the current Team Fortress 2 inventory (a.k.a. backpack) of this
+  # player
+  #
+  # @return [TF2Inventory] This player's TF2 backpack
+  def inventory
+    if @inventory.nil?
+      inventory_class = (game.short_name == 'tf2') ? TF2Inventory : TF2BetaInventory
+      @inventory = inventory_class.new(user.steam_id64) if @inventory.nil?
+    end
+
+    @inventory
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/web_api.rb

@@ -0,0 +1,129 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'multi_json'
+require 'open-uri'
+
+require 'errors/web_api_error'
+
+# This module provides functionality for accessing Steam's Web API
+#
+# The Web API requires you to register a domain with your Steam account to
+# acquire an API key. See http://steamcommunity.com/dev for further details.
+#
+# @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
+  def self.api_key
+    @@api_key
+  end
+
+  # Sets the Steam Web API key
+  #
+  # @param [String] api_key The 128bit API key as a hexadecimal string that has
+  #        to be requested from http://steamcommunity.com/dev
+  # @raise [WebApiError] if the given API key is not a valid 128bit hexadecimal
+  #        string
+  def self.api_key=(api_key)
+    unless api_key.nil? || api_key.match(/^[0-9A-F]{32}$/)
+      raise WebApiError, :invalid_key
+    end
+
+    @@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.
+  #
+  # @param [String] interface The Web API interface to call, e.g. `ISteamUser`
+  # @param [String] method The Web API method to call, e.g.
+  #        `GetPlayerSummaries`
+  # @param [Fixnum] version The API method version to use
+  # @param [Hash<Symbol, Object>] params Additional parameters to supply via
+  #        HTTP GET
+  # @raise [WebApiError] if the request to Steam's Web API fails
+  # @return [String] The raw JSON data replied to the request
+  def self.json(interface, method, version = 1, params = nil)
+    get(:json, interface, method, version, params)
+  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 Hash containing the JSON data.
+  #
+  # @param [String] interface The Web API interface to call, e.g. `ISteamUser`
+  # @param [String] method The Web API method to call, e.g.
+  #        `GetPlayerSummaries`
+  # @param [Fixnum] version The API method version to use
+  # @param [Hash<Symbol, Object>] params Additional parameters to supply via
+  #        HTTP GET
+  # @raise [WebApiError] if the request to Steam's Web API fails
+  # @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.load(data, { :symbolize_keys => true })[:result]
+
+    status = result[:status]
+    if status != 1
+      raise WebApiError.new :status_bad, status, result[:statusDetail]
+    end
+
+    result
+  end
+
+  # Fetches data from Steam Web API using the specified interface, method and
+  # version. Additional parameters are supplied via HTTP GET. Data is returned
+  # as a string in the given format.
+  #
+  # @param [Symbol] format The format to load from the API (`:json`, `:vdf`, or
+  #        `:xml`)
+  # @param [String] interface The Web API interface to call, e.g. `ISteamUser`
+  # @param [String] method The Web API method to call, e.g.
+  #        `GetPlayerSummaries`
+  # @param [Fixnum] version The API method version to use
+  # @param [Hash<Symbol, Object>] params Additional parameters to supply via
+  #        HTTP GET
+  # @raise [WebApiError] if the request to Steam's Web API fails
+  # @return [String] The data as replied by the Web API in the desired format
+  def self.get(format, interface, method, version = 1, params = nil)
+    version = version.to_s.rjust(4, '0')
+    url = "http://api.steampowered.com/#{interface}/#{method}/v#{version}/"
+    params = {} unless params.is_a?(Hash)
+    params[:format] = format
+    params[:key] = WebApi.api_key
+
+    unless params.nil? && params.empty?
+      url += '?' + params.map { |k,v| "#{k}=#{v}" }.join('&')
+    end
+
+    begin
+      open(url, { :proxy => true }).read
+    rescue OpenURI::HTTPError
+      status = $!.io.status[0]
+      status = [status, ''] unless status.is_a? Array
+      raise WebApiError, :unauthorized if status[0].to_i == 401
+      raise WebApiError.new :http_error, status[0].to_i, status[1]
+    end
+  end
+
+end

data/pkg/steam-condenser-1.2.0/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/pkg/steam-condenser-1.2.0/lib/steam/packets/a2m_get_servers_batch2_packet.rb

@@ -0,0 +1,59 @@
+# 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
+
+require 'steam/packets/steam_packet'
+require 'steam/servers/master_server'
+
+# This packet class represents a A2M_GET_SERVERS_BATCH2 request sent to a
+# master server
+#
+# It is used to receive a list of game servers matching the specified filters.
+#
+# Filtering:
+# Instead of filtering the results sent by the master server locally, you
+# should at least use the following filters to narrow down the results sent by
+# the master server. Receiving all servers from the master server is taking
+# quite some time.
+#
+# Available filters:
+#
+# * `\type\d`: Request only dedicated servers
+# * `\secure\1`: Request only secure servers
+# * `\gamedir\[mod]`: Request only servers of a specific mod
+# * `\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
+# * `\proxy\1`: Request only spectator proxy servers
+#
+# @author Sebastian Staudt
+# @see MasterServer#servers
+class A2M_GET_SERVERS_BATCH2_Packet
+
+  include SteamPacket
+
+  # Creates a master server request, filtering by the given paramters
+  #
+  # @param [Numeric] region_code The region code to filter servers by region
+  # @param [String] start_ip This should be the last IP received from the
+  #        master server or 0.0.0.0
+  # @param [String] filter The filters to apply in the form
+  #        "\filtername\value..."
+  def initialize(region_code = MasterServer::REGION_ALL, start_ip = '0.0.0.0:0', filter = '')
+    super A2M_GET_SERVERS_BATCH2_HEADER
+
+    @filter = filter
+    @region_code = region_code
+    @start_ip = start_ip
+  end
+
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this request packet
+  def to_s
+    [@header_data, @region_code, @start_ip, @filter].pack('c2Z*Z*')
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_info_packet.rb

@@ -0,0 +1,24 @@
+# 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
+
+require 'steam/packets/steam_packet'
+
+# This packet class class represents a A2S_INFO request send to a game server
+#
+# It will cause the server to send some basic information about itself, e.g.
+# the running game, map and the number of players.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_server_info
+class A2S_INFO_Packet
+
+  include SteamPacket
+
+  # Creates a new A2S_INFO request object
+  def initialize
+    super A2S_INFO_HEADER, "Source Engine Query\0"
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_player_packet.rb

@@ -0,0 +1,31 @@
+# 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
+
+require 'steam/packets/request_with_challenge'
+require 'steam/packets/steam_packet'
+
+# This packet class represents a A2S_PLAYER request send to a game server
+#
+# It is used to request the list of players currently playing on the server.
+#
+# This packet type requires the client to challenge the server in advance,
+# which is done automatically if required.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_player_info
+class A2S_PLAYER_Packet
+
+  include SteamPacket
+  include RequestWithChallenge
+
+  # Creates a new A2S_PLAYER request object including the challenge number
+  #
+  # @param [Numeric] challenge_number The challenge number received from the
+  #        server
+  def initialize(challenge_number = -1)
+    super A2S_PLAYER_HEADER, challenge_number
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_rules_packet.rb

@@ -0,0 +1,32 @@
+# 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
+
+require 'steam/packets/request_with_challenge'
+require 'steam/packets/steam_packet'
+
+# This packet class represents a A2S_RULES request send to a game server
+#
+# The game server will return a list of currently active game rules, e.g.
+# `mp_friendlyfire = 1`.
+#
+# This packet type requires the client to challenge the server in advance,
+# which is done automatically if required.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_rules_info
+class A2S_RULES_Packet
+
+  include SteamPacket
+  include RequestWithChallenge
+
+  # Creates a new A2S_RULES request object including the challenge number
+  #
+  # @param [Numeric] challenge_number The challenge number received from the
+  #        server
+  def initialize(challenge_number = -1)
+    super A2S_RULES_HEADER, challenge_number
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb

@@ -0,0 +1,25 @@
+# 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
+
+require 'steam/packets/steam_packet'
+
+# 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
+
+  # Creates a new A2S_SERVERQUERY_GETCHALLENGE request object
+  def initialize
+    super A2S_SERVERQUERY_GETCHALLENGE_HEADER
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/c2m_checkmd5_packet.rb

@@ -0,0 +1,30 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'steam/packets/steam_packet'
+
+# 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 C2M_CHECKMD5 request object
+  def initialize
+    super C2M_CHECKMD5_HEADER
+  end
+
+  # 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
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2a_server_batch_packet.rb

@@ -0,0 +1,52 @@
+# 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
+
+require 'errors/packet_format_error'
+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
+  # @raise [PacketFormatError] if the packet data is not well formatted
+  def initialize(data)
+    super M2A_SERVER_BATCH_HEADER, data
+
+    unless @content_data.byte == 0x0A
+      raise PacketFormatError, 'Master query response is missing additional 0x0A byte.'
+    end
+
+    @servers = []
+
+    begin
+      first_octet = @content_data.byte
+      second_octet = @content_data.byte
+      third_octet = @content_data.byte
+      fourth_octet = @content_data.byte
+      port_number = @content_data.short
+      port_number = ((port_number & 0xFF) << 8) + (port_number >> 8)
+
+      @servers << "#{first_octet}.#{second_octet}.#{third_octet}.#{fourth_octet}:#{port_number}"
+    end while @content_data.remaining > 0
+  end
+
+end