steam-condenser 0.13.1 → 0.14.0

data/lib/steam/community/portal2/portal2_inventory.rb

@@ -0,0 +1,21 @@
+# 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 'steam/community/game_inventory'
+require 'steam/community/portal2/portal2_item'
+
+# Represents the inventory (a.k.a. Robot Enrichment) of a Portal 2 player
+class Portal2Inventory
+
+  include Cacheable
+  cacheable_with_ids :steam_id64
+
+  include GameInventory
+
+  @@app_id = 620
+
+  @@item_class = Portal2Item
+
+end

data/lib/steam/community/portal2/portal2_item.rb

@@ -0,0 +1,35 @@
+# 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 'steam/community/game_item'
+
+# Represents a Portal 2 item
+class Portal2Item
+
+  include GameItem
+
+  BOTS = [ :pbody, :atlas ]
+
+  # Creates a new instance of a Portal2Item with the given data
+  def initialize(inventory, item_data)
+    super
+
+    @equipped = {}
+    BOTS.each_index do |class_id|
+      @equipped[BOTS[class_id]] = (item_data[:inventory] & (1 << 16 + class_id) != 0)
+    end
+  end
+
+  # Returns the symbols for each bot this player has equipped this item
+  def bots_equipped?
+    @equipped.reject { |bot_id, equipped| !equipped }
+  end
+
+  # Returns whether this item is equipped by this player at all
+  def equipped?
+    @equipped.has_value? true
+  end
+
+end

data/lib/steam/community/portal2/portal2_stats.rb

@@ -0,0 +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) 2011, Sebastian Staudt
+
+require 'steam/community/game_stats'
+require 'steam/community/portal2/portal2_inventory'
+
+# The Portal2Stats class represents the game statistics for a single user in
+# Portal 2
+class Portal2Stats < GameStats
+
+  attr_reader :accumulated_points
+
+  # Creates a Portal2Stats object by calling the super constructor with the
+  # game name "portal2"
+  def initialize(steam_id)
+    super steam_id, 'portal2'
+  end
+
+  # Returns the current Portal 2 inventory (a.k.a Robot Enrichment) of this
+  # player
+  def inventory
+    @inventory = Portal2Inventory.new(steam_id64) if @inventory.nil?
+    @inventory
+  end
+
+end

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

@@ -1,11 +1,10 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2010-2011, Sebastian Staudt
 
-require 'steam/community/cacheable'
+require 'steam/community/game_inventory'
 require 'steam/community/tf2/tf2_item'
-require 'steam/community/web_api'
 
 # Represents the inventory (aka. Backpack) of a Team Fortress 2 player
 class TF2Inventory
@@ -13,39 +12,10 @@ class TF2Inventory
   include Cacheable
   cacheable_with_ids :steam_id64
 
-  attr_reader :items, :steam_id64
+  include GameInventory
 
-  # Creates a new inventory object for the given SteamID64. This calls update
-  # to fetch the data and create the TF2Item instances contained in this
-  # players backpack
-  def initialize(steam_id64, fetch_now = true)
-    @steam_id64 = steam_id64
+  @@app_id = 440
 
-    super(fetch_now)
-  end
-
-  # Returns the item at the given position in the backpack. The positions range
-  # from 1 to 100 instead of the usual array indices (0 to 99).
-  def [](index)
-    @items[index - 1]
-  end
-
-  # Updates the contents of the backpack using Steam Web API
-  def fetch
-    result = WebApi.json!('ITFItems_440', 'GetPlayerItems', 1, { :SteamID => @steam_id64 })
-
-    @items = []
-    result[:items][:item].each do |item_data|
-      unless item_data.nil?
-        item = TF2Item.new(item_data)
-        @items[item.backpack_position - 1] = item
-      end
-    end
-  end
-
-  # Returns the number of items in the user's backpack
-  def size
-    @items.size
-  end
+  @@item_class = TF2Item
 
 end

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

@@ -1,71 +1,25 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2010-2011, Sebastian Staudt
 
-require 'steam/community/web_api'
+require 'steam/community/game_item'
 
 # Represents a Team Fortress 2 item
 class TF2Item
 
-  CLASSES = [ :scout, :sniper, :soldier, :demoman, :medic, :heavy, :pyro, :spy ]
-
-  attr_reader :attributes, :backpack_position, :class, :count, :defindex, :id,
-              :level, :name, :quality, :slot, :type
-
-  @@attribute_schema = nil
-
-  @@item_schema = nil
+  include GameItem
 
-  @@schema_language = 'en'
-
-  # Returns the attribute schema
-  #
-  # The attribute schema is fetched first if not done already
-  def self.attribute_schema
-    update_schema if @@attribute_schema.nil?
-
-    @@attribute_schema
-  end
-
-  # Returns the item schema
-  #
-  # The item schema is fetched first if not done already
-  def self.item_schema
-    update_schema if @@item_schema.nil?
-
-    @@item_schema
-  end
-
-  # Sets the language the schema should be fetched in (default is: +'en'+)
-  def self.schema_language=(language)
-    @@schema_language = language
-  end
+  CLASSES = [ :scout, :sniper, :soldier, :demoman, :medic, :heavy, :pyro, :spy ]
 
   # Creates a new instance of a TF2Item with the given data
-  def initialize(item_data)
-    update_schema if @@item_schema.nil?
-
-    @defindex          = item_data[:defindex]
-
-    @backpack_position = item_data[:inventory] & 0xffff
-    @class             = @@item_schema[@defindex][:item_class]
-    @count             = item_data[:quantity]
-    @id                = item_data[:id]
-    @level             = item_data[:level]
-    @name              = @@item_schema[@defindex][:item_name]
-    @quality           = @@qualities[item_data[:quality]]
-    @slot              = @@item_schema[@defindex][:item_slot]
-    @type              = @@item_schema[@defindex][:item_type_name]
+  def initialize(inventory, item_data)
+    super
 
     @equipped = {}
     CLASSES.each_index do |class_id|
       @equipped[CLASSES[class_id]] = (item_data[:inventory] & (1 << 16 + class_id) != 0)
     end
-
-    unless @@item_schema[@defindex][:attributes].nil?
-      @attributes = @@item_schema[@defindex][:attributes][:attribute]
-    end
   end
 
   # Returns the class symbols for each class this player has equipped this item
@@ -78,29 +32,4 @@ class TF2Item
     @equipped.has_value? true
   end
 
-  protected
-
-  # Updates the item schema (this includes attributes and qualities) using the
-  # +GetSchema+ method of interface +ITFItems_440+
-  def update_schema
-    params = {}
-    params[:language] = @@schema_language unless @@schema_language.nil?
-    result = WebApi.json!('ITFItems_440', 'GetSchema', 1, params)
-
-    @@attribute_schema = {}
-    result[:attributes][:attribute].each do |attribute_data|
-      @@attribute_schema[attribute_data[:name]] = attribute_data
-    end
-
-    @@item_schema = []
-    result[:items][:item].each do |item_data|
-      @@item_schema[item_data[:defindex]] = item_data
-    end
-
-    @@qualities = []
-    result[:qualities].each do |quality, id|
-      @@qualities[id] = quality
-    end
-  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.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/community/game_stats'
 require 'steam/community/tf2/tf2_class_factory'
@@ -23,16 +23,6 @@ class TF2Stats < GameStats
     end
   end
 
-  # Returns the current Team Fortress 2 inventory (a.k.a. backpack) of this
-  # player
-  def inventory
-    if @inventory.nil?
-      @inventory = TF2Inventory.new(steam_id64)
-    end
-
-    @inventory
-  end
-
   # Returns a Hash of TF2Class for this user containing all Team Fortress 2
   # classes. If the classes haven't been parsed already, parsing is done now.
   def class_stats
@@ -48,4 +38,11 @@ class TF2Stats < GameStats
     @class_stats
   end
 
+  # Returns the current Team Fortress 2 inventory (a.k.a. backpack) of this
+  # player
+  def inventory
+    @inventory = TF2Inventory.new(steam_id64) if @inventory.nil?
+    @inventory
+  end
+
 end

data/lib/steam/community/web_api.rb

@@ -88,6 +88,7 @@ module WebApi
       open(url, { :proxy => true }).read
     rescue OpenURI::HTTPError
       status = $!.io.status[0]
+      status = [status, ''] unless status.is_a? Array
       raise WebApiException.new(:unauthorized) if status[0].to_i == 401
       raise WebApiException.new(:http_error, status[0].to_i, status[1])
     end

data/lib/steam/packets/a2m_get_servers_batch2_packet.rb

@@ -1,16 +1,46 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# 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.
+  # 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
 
@@ -19,6 +49,9 @@ class A2M_GET_SERVERS_BATCH2_Packet
     @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

data/lib/steam/packets/a2s_info_packet.rb

@@ -1,12 +1,17 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# The A2S_INFO_Packet class represents a A2S_INFO request send to the
-# server.
+# 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

data/lib/steam/packets/a2s_player_packet.rb

@@ -1,19 +1,29 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/request_with_challenge'
 require 'steam/packets/steam_packet'
 
-# The A2S_PLAYER_Packet class represents a A2S_PLAYER request send to the
-# server.
+# 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
+  # 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

data/lib/steam/packets/a2s_rules_packet.rb

@@ -1,18 +1,30 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# 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'
 
-# Creates a new A2S_RULES request object including the challenge_number
+# 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
+  # 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