steam-condenser 1.2.1 → 1.3.0

data/lib/steam/community/game_item_schema.rb

@@ -0,0 +1,131 @@
+# 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 'steam/community/cacheable'
+
+# Provides item definitions and related data that specify the items of a game
+#
+# @author Sebastian Staudt
+class GameItemSchema
+
+  include Cacheable
+  cacheable_with_ids [ :app_id, :language ]
+
+  # Returns the application ID of the game this item schema belongs to
+  #
+  # @return [Fixnum] The application ID of the game
+  attr_reader :app_id
+
+  # The attributes defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's attributes
+  attr_reader :attributes
+
+  # The effects defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's effects
+  attr_reader :effects
+
+  # The levels defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's item levels
+  attr_reader :item_levels
+
+  # A mapping from the item name to the item's defindex
+  #
+  # @return [Hash<Symbol, Object>] The item name mapping
+  attr_reader :item_names
+
+  # The item sets defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's item sets
+  attr_reader :item_sets
+
+  # The items defined for this game
+  #
+  # @return [Hash<Symbol, Object>] The items in this schema
+  attr_reader :items
+
+  # The language of this item schema
+  #
+  # @return [Symbol] The language of this item schema
+  attr_reader :language
+
+  # The item origins defined for this game's items
+  #
+  # @return [Array<String>] This item schema's origins
+  attr_reader :origins
+
+  # The item qualities defined for this game's items
+  #
+  # @return [Array<String>] This item schema's qualities
+  attr_reader :qualities
+
+  # Creates a new item schema for the game with the given application ID and
+  # with descriptions in the given language
+  #
+  # @param [Fixnum] app_id The application ID of the game
+  # @param [Symbol] language The language of description strings
+  # @macro cacheable
+  def initialize(app_id, language = nil)
+    @app_id   = app_id
+    @language = language
+  end
+
+  # Updates the item definitions of this schema using the Steam Web API
+  def fetch
+    params = { :language => language }
+    data = WebApi.json!("IEconItems_#{app_id}", 'GetSchema', 1, params)
+
+    @attributes = {}
+    data[:attributes].each do |attribute|
+      @attributes[attribute[:defindex]] = attribute
+      @attributes[attribute[:name]]     = attribute
+    end
+
+    @effects = {}
+    data[:attribute_controlled_attached_particles].each do |effect|
+      @effects[effect[:id]] = effect[:name]
+    end
+
+    @items = {}
+    @item_names = {}
+    data[:items].each do |item|
+      @items[item[:defindex]] = item
+      @item_names[item[:name]] = item[:defindex]
+    end
+
+    @item_levels = {}
+    data[:item_levels].each do |item_level_type|
+      @item_levels[item_level_type[:name]] = {}
+      item_level_type[:levels].each do |level|
+        @item_levels[item_level_type[:name]][level[:level]] = level[:name]
+      end
+    end if data.key? :item_levels
+
+    @item_sets = {}
+    data[:item_sets].each do |item_set|
+      @item_sets[item_set[:item_set]] = item_set
+    end
+
+    @origins = []
+    data[:originNames].each do |origin|
+      @origins[origin[:origin]] = origin[:name]
+    end
+
+    @qualities = []
+    data[:qualities].keys.each_with_index do |key, index|
+      @qualities[index] = data[:qualityNames][key] || key.to_s.capitalize
+    end
+  end
+
+  # Returns a short, human-readable string representation of this item schema
+  #
+  # @return [String] A string representation of this item schema
+  def inspect
+    "#<#{self.class}:#@app_id (#@language) - #{fetch_time || 'not fetched'}>"
+  end
+
+end

data/lib/steam/community/game_stats.rb

@@ -109,7 +109,7 @@ class GameStats
 
     @privacy_state = @xml_data['privacyState']
     if public?
-      app_id        = @xml_data['game']['gameLink'].match(/http:\/\/+store\.steampowered\.com\/+app\/+([1-9][0-9]*)/)[1].to_i
+      app_id        = @xml_data['game']['gameLink'].match(/http:\/\/steamcommunity\.com\/+app\/+([1-9][0-9]*)/)[1].to_i
       @game         = SteamGame.new app_id, @xml_data['game']
       @hours_played = @xml_data['stats']['hoursPlayed'] unless @xml_data['stats']['hoursPlayed'].nil?
     end

data/lib/steam/community/l4d/l4d2_stats.rb

@@ -28,7 +28,9 @@ class L4D2Stats < GameStats
   # Creates a `L4D2Stats` object by calling the super constructor with the game
   # name `'l4d2'`
   #
-  # @param [String] steam_id The custom URL or 64bit Steam ID of the user
+  # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
+  #        user
+  # @macro cacheable
   def initialize(steam_id)
     super steam_id, 'l4d2'
 

data/lib/steam/community/l4d/l4d_stats.rb

@@ -18,7 +18,9 @@ class L4DStats < GameStats
   # Creates a `L4DStats` object by calling the super constructor
   # with the game name `'l4d'`
   #
-  # @param [String] steam_id The custom URL or 64bit Steam ID of the user
+  # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
+  #        user
+  # @macro cacheable
   def initialize(steam_id)
     super steam_id, 'l4d'
   end

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

@@ -11,6 +11,9 @@ require 'steam/community/portal2/portal2_item'
 # @author Sebastian Staudt
 class Portal2Inventory < GameInventory
 
+  # The Steam application ID of Portal 2
+  APP_ID = 620
+
   # Creates a new inventory object for the given SteamID64 in Portal 2 (App ID
   # 620)
   #
@@ -18,7 +21,7 @@ class Portal2Inventory < GameInventory
   #        inventory for
   # @macro cacheable
   def initialize(steam_id64)
-    super 620, steam_id64
+    super APP_ID, steam_id64
   end
 
   # The class representing Portal 2 items

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

@@ -15,6 +15,12 @@ class Portal2Item
   # The names of the bots available in Portal 2
   BOTS = [ :pbody, :atlas ]
 
+  # Returns the slot where this item can be equipped in or `nil` if this item
+  # cannot be equipped
+  #
+  # @return [String, nil] The slot where this item can be equipped in
+  attr_reader :slot
+
   # Creates a new instance of a Portal 2 item with the given data
   #
   # @param [Portal2Inventory] inventory The inventory this item is contained in
@@ -23,6 +29,8 @@ class Portal2Item
   def initialize(inventory, item_data)
     super
 
+    @slot = schema_data[:item_slot]
+
     @equipped = {}
     BOTS.each_index do |class_id|
       @equipped[BOTS[class_id]] = (item_data[:inventory] & (1 << 16 + class_id) != 0)

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

@@ -16,6 +16,7 @@ class Portal2Stats < GameStats
   #
   # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
   #        user
+  # @macro cacheable
   def initialize(steam_id)
     super steam_id, 'portal2'
   end

data/lib/steam/community/steam_game.rb

@@ -80,6 +80,16 @@ class SteamGame
     result[:up_to_date]
   end
 
+  # Returns the overall number of players currently playing this game
+  #
+  # @return [Fixnum] The number of players playing this game
+  def player_count
+    params = { :appid => @app_id }
+    result = WebApi.json 'ISteamUserStats', 'GetNumberOfCurrentPlayers', 1, params
+    result = MultiJson.load(result, { :symbolize_keys => true})[:response]
+    result[:player_count]
+  end
+
   # Returns whether this game has statistics available
   #
   # @return [Boolean] `true` if this game has stats
@@ -115,6 +125,7 @@ class SteamGame
   #
   # @return [String] The URL for the game logo
   def logo_url
+    return nil if @logo_hash.nil?
     "http://media.steampowered.com/steamcommunity/public/images/apps/#@app_id/#@logo_hash.jpg"
   end
 
@@ -122,7 +133,8 @@ class SteamGame
   #
   # @return [String] The URL for the game logo thumbnail
   def logo_thumbnail_url
-    "http://media.steampowered.com/steamcommunity/public/images/apps/#@app_id/#@logo_hash_thumb.jpg"
+    return nil if @logo_hash.nil?
+    "http://media.steampowered.com/steamcommunity/public/images/apps/#@app_id/#{@logo_hash}_thumb.jpg"
   end
 
   # Returns the URL of this game's page in the Steam Store
@@ -162,7 +174,8 @@ class SteamGame
     @app_id   = app_id
 
     if game_data.key? 'name'
-      @logo_hash = game_data['logo'].match(/\/#{app_id}\/([0-9a-f]+).jpg/)[1]
+      hash = game_data['logo'].match /\/#{app_id}\/([0-9a-f]+).jpg/
+      @logo_hash = hash[1] unless hash.nil?
       @name      = game_data['name']
 
       if game_data.key? 'globalStatsLink'

data/lib/steam/community/steam_id.rb

@@ -31,20 +31,6 @@ class SteamId
   # @return [String] The custom URL of this Steam ID
   attr_reader :custom_url
 
-  # Returns the favorite game of this user
-  #
-  # @deprecated The favorite game is no longer listed for new users
-  # @return [String] The favorite game of this user
-  attr_reader :favorite_game
-
-  # Returns the number of hours that this user played his/her favorite game in
-  # the last two weeks
-  #
-  # @deprecated The favorite game is no longer listed for new users
-  # @return [String] The number of hours the favorite game has been played
-  #         recently
-  attr_reader :favorite_game_hours_played
-
   # Returns the groups this user is a member of
   #
   # @return [Array<SteamGroup>] The groups this user is a member of
@@ -157,6 +143,21 @@ class SteamId
     "STEAM_0:#{steam_id1}:#{steam_id2}"
   end
 
+  # Resolves a vanity URL of a Steam Community profile to a 64bit numeric
+  # SteamID
+  #
+  # @param [String] vanity_url The vanity URL of a Steam Community profile
+  # @return [Fixnum] The 64bit numeric SteamID
+  def self.resolve_vanity_url(vanity_url)
+    params = { :vanityurl => vanity_url }
+    json = WebApi.json 'ISteamUser', 'ResolveVanityURL', 1, params
+    result = MultiJson.load(json, :symbolize_keys => true)[:response]
+
+    return nil if result[:success] != 1
+
+    result[:steamid].to_i
+  end
+
   # Converts a SteamID as reported by game servers to a 64bit numeric SteamID
   # as used by the Steam Community
   #
@@ -168,13 +169,15 @@ class SteamId
   def self.steam_id_to_community_id(steam_id)
     if steam_id == 'STEAM_ID_LAN' || steam_id == 'BOT'
       raise SteamCondenserError, "Cannot convert SteamID \"#{steam_id}\" to a community ID."
-    elsif steam_id.match(/^STEAM_[0-1]:[0-1]:[0-9]+$/).nil?
+    elsif steam_id =~ /^STEAM_[0-1]:[0-1]:[0-9]+$/
+      steam_id = steam_id[8..-1].split(':').map! { |s| s.to_i }
+      steam_id[0] + steam_id[1] * 2 + 76561197960265728
+    elsif steam_id =~ /\[U:[0-1]:[0-9]+\]/
+      steam_id = steam_id[3..-2].split(':').map! { |s| s.to_i }
+      steam_id[0] + steam_id[1] + 76561197960265727
+    else
       raise SteamCondenserError, "SteamID \"#{steam_id}\" doesn't have the correct format."
     end
-
-    steam_id = steam_id[6..-1].split(':').map!{|s| s.to_i}
-
-    steam_id[1] + steam_id[2] * 2 + 76561197960265728
   end
 
   class << self
@@ -205,7 +208,11 @@ class SteamId
     if id.is_a? Numeric
       @steam_id64 = id
     else
-      @custom_url = id.downcase
+      if id =~ /^STEAM_[0-1]:[0-1]:[0-9]+$/ || id =~ /\[U:[0-1]:[0-9]+\]/
+        @steam_id64 = self.steam_id_to_community_id id
+      else
+        @custom_url = id.downcase
+      end
     end
   end
 
@@ -240,11 +247,9 @@ class SteamId
     begin
       profile = parse "#{base_url}?xml=1"
 
-      if profile.key? 'error'
-        raise SteamCondenserError, profile['error']
-      end
+      raise SteamCondenserError, profile['error'] unless profile['error'].nil?
 
-      if profile.key? 'privacyMessage'
+      unless profile['privacyMessage'].nil?
         raise SteamCondenserError, profile['privacyMessage']
       end
 
@@ -261,14 +266,9 @@ class SteamId
       @visibility_state = profile['visibilityState'].to_i
 
       if public?
-        @custom_url = profile['customURL'].downcase
+        @custom_url = profile['customURL'].downcase rescue ''
         @custom_url = nil if @custom_url.empty?
 
-        if profile.key? 'favoriteGame'
-          @favorite_game              = profile['favoriteGame']['name']
-          @favorite_game_hours_played = profile['favoriteGame']['hoursPlayed2wk']
-        end
-
         @head_line    = CGI.unescapeHTML profile['headline'] || ''
         @hours_played = profile['hoursPlayed2Wk'].to_f
         @location     = profile['location']
@@ -278,21 +278,21 @@ class SteamId
         @summary      = CGI.unescapeHTML profile['summary'] || ''
 
         @most_played_games = {}
-        if profile.key? 'mostPlayedGames'
+        unless profile['mostPlayedGames'].to_s.strip.empty?
           [profile['mostPlayedGames']['mostPlayedGame']].flatten.each do |most_played_game|
             @most_played_games[most_played_game['gameName']] = most_played_game['hoursPlayed'].to_f
           end
         end
 
         @groups = []
-        if profile.key? 'groups'
+        unless profile['groups'].to_s.strip.empty?
           [profile['groups']['group']].flatten.each do |group|
             @groups << SteamGroup.new(group['groupID64'].to_i, false)
           end
         end
 
         @links = {}
-        if profile.key? 'weblinks'
+        unless profile['weblinks'].to_s.strip.empty?
           [profile['weblinks']['weblink']].flatten.each do |link|
             @links[CGI.unescapeHTML link['title']] = link['link']
           end
@@ -330,17 +330,14 @@ class SteamId
     @games     = {}
     @playtimes = {}
     games_data = parse "#{base_url}/games?xml=1"
-    [games_data['games']['game']].flatten.each do |game_data|
+    games_data['games']['game'].each do |game_data|
       app_id = game_data['appID'].to_i
       game = SteamGame.new app_id, game_data
       @games[app_id] = game
-      recent = total = 0
-      if game_data.key? 'hoursLast2Weeks'
-        recent = game_data['hoursLast2Weeks'].to_f
-      end
-      if game_data.key? 'hoursOnRecord'
-        total = game_data['hoursOnRecord'].to_f
-      end
+
+      recent = game_data['hoursLast2Weeks'].to_f
+      total = (game_data['hoursOnRecord'] || '').delete(',').to_f
+
       @playtimes[app_id] = [(recent * 60).to_i, (total * 60).to_i]
     end
 
@@ -485,7 +482,7 @@ class SteamId
   #        game with the given ID exists
   # @return [SteamGame] The game found with the given ID
   def find_game(id)
-    if id.is_a? Integer
+    if id.is_a? Numeric
       game = games[id]
     else
       game = games.values.find do |game|

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

@@ -10,6 +10,9 @@ require 'steam/community/tf2/tf2_item'
 # Fortress 2 beta
 class TF2BetaInventory < GameInventory
 
+  # The Steam application ID of the Team Fortress 2 beta
+  APP_ID = 520
+
   # Creates a new inventory object for the given SteamID64 in the Team Fortress
   # 2 beta (App ID 520)
   #
@@ -17,7 +20,7 @@ class TF2BetaInventory < GameInventory
   #        inventory for
   # @macro cacheable
   def initialize(steam_id64)
-    super 520, steam_id64
+    super APP_ID, steam_id64
   end
 
   @@item_class = TF2Item

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

@@ -11,6 +11,9 @@ require 'steam/community/tf2/tf2_item'
 # @author Sebastian Staudt
 class TF2Inventory < GameInventory
 
+  # The Steam application ID of Team Fortress 2
+  APP_ID = 440
+
   # Creates a new inventory object for the given SteamID64 in Team Fortress 2
   # (App ID 440)
   #
@@ -18,7 +21,7 @@ class TF2Inventory < GameInventory
   #        inventory for
   # @macro cacheable
   def initialize(steam_id64)
-    super 440, steam_id64
+    super APP_ID, steam_id64
   end
 
   # The class representing Team Fortress 2 items