steam-api 1.0.0

data/lib/steam-api/steam/remote_storage.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # A Ruby DSL for communicating with the Steam Web API.
+  # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
+  # @since 1.0.0
+  class RemoteStorage
+    # Get Published File Details
+    # @param [Hash] params Parameters to pass to the API
+    # @option params [Fixnum] :itemcount Number of items being requested
+    # @option params [Fixnum] :publishedfileids Published file id to look up
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetPublishedFileDetails
+    def self.published_file(params: {})
+      response = client.get 'GetPublishedFileDetails/v1', params: params
+      response
+    end
+
+    # Get UGC File Details
+    # @param [Hash] params Parameters to pass to the API
+    # @option params [String] :key Steam Api Key
+    # @option params [Fixnum] :steamid If specified, only returns details
+    #   if the file is owned by the SteamID specified
+    # @option params [Fixnum] :ugcid ID of UGC file to get info for
+    # @option params [Fixnum] :appid appID of product
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetUGCFileDetails
+    def self.ugc_file(params: {})
+      response = client.get 'GetUGCFileDetails/v1', params: params
+      response
+    end
+
+    private
+
+    def self.client
+      build_client 'ISteamRemoteStorage'
+    end
+  end
+end

data/lib/steam-api/steam/user.rb

@@ -0,0 +1,90 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # A Ruby DSL for communicating with the Steam::User Web API.
+  # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
+  # @since 1.0.0
+  module User
+    # Get User's Friend List
+    # @param [String] steamid 
+    # @param [String] relationship Relationship filter.
+    #   Possibles values: all, friend.
+    # @return [Hash] A hash object resulting from the API call; should
+    #   returns the friend list of any Steam user, provided their Steam
+    #   Community profile visibility is set to "Public".
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetFriendList
+    def self.friends(steamid, relationship: :all)
+      response = client.get 'GetFriendList/v1/',
+                            params: { steamid: steamid,
+                                      relationship: relationship }
+      response = response.parse_key('friendslist')
+                         .parse_key('friends')
+      response
+    end
+
+    # Get Multiple Player Bans
+    # @param [Array] steamids Array of SteamIDs
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetPlayerBans
+    def self.bans(steamids)
+      steamids = [steamids] unless steamids.is_a?(Array)
+      response = client.get 'GetPlayerBans/v1/',
+                            params: { steamids: steamids.join(',') }
+      response
+    end
+
+    # Get Player Summaries
+    # @option params [Array] :steamids List of player's steamids
+    # @return [Hash] The hash object resulting from the API call. Some data
+    #   associated with a Steam account may be hidden if the user has their
+    #   profile visibility set to "Friends Only" or "Private". In that case,
+    #   only public data will be returned.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetPlayerSummaries
+    def self.summary(steamid)
+      summaries([steamid]).first
+    end
+
+    # Get Player Summaries
+    # @param [Array] steamids List of player's steamids
+    # @return [Hash] The hash object resulting from the API call. Some data
+    #   associated with a Steam account may be hidden if the user has their
+    #   profile visibility set to "Friends Only" or "Private". In that case,
+    #   only public data will be returned.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetPlayerSummaries
+    def self.summaries(steamids)
+      response = client.get 'GetPlayerSummaries/v2/',
+                            params: { steamids: steamids.join(',') }
+      response.parse_key('response')
+              .parse_key('players')
+    end
+
+    # Get User Groups
+    # @param [Fixnum] steamid 64bit Steam ID to return friend list.
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetUserGroupList
+    def self.groups(steamid)
+      response = client.get 'GetUserGroupList/v1', params: { steamid: steamid }
+      response = response.parse_key('response')
+      response.check_success
+      response.parse_key('groups')
+    end
+
+    # Resolve Vanity URL
+    # @param [String] vanityurl The vanity URL part of a user's Steam
+    #   profile URL. This is the basename of http://steamcommunity.com/id/ URLs
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/ResolveVanityURL
+    def self.vanity_to_steamid(vanityurl)
+      response = client.get 'ResolveVanityURL/v1',
+                            params: { vanityurl: vanityurl }
+      response = response.parse_key('response')
+      response.check_success(success_condition: 1)
+      response.parse_key('steamid')
+    end
+
+    private
+
+    def self.client
+      build_client 'ISteamUser'
+    end
+  end
+end

data/lib/steam-api/steam/user_stats.rb

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+module Steam
+  # A Ruby DSL for communicating with the Steam Web API.
+  # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
+  # @since 1.0.0
+  module UserStats
+    # Get Global Achievement Percentages for App
+    # @param [Fixnum] appid The ID of the game or application
+    # @return [Hash] The hash object of information on the global achievements overview of
+    #   a specific game in percentages.
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetGlobalAchievementPercentagesForApp
+    def self.achievement_percentages(appid)
+      response = client.get 'GetGlobalAchievementPercentagesForApp/v2',
+                            params: { gameid: appid }
+      response = response.parse_key('achievementpercentages')
+                         .parse_key('achievements')
+      response
+    end
+
+    # Get Global Stats for Game
+    # @param [Fixnum] appid The ID of the game or application
+    # @param [Hash] params Parameters to pass to the API
+    # @option params [Fixnum] :count Number of stats to get data for.
+    # @option params [String] :name[0] Names of the stats to get. For more than one value, use
+    #   a parameter for each request. (name[0], name[1], ...) Not all stats are globally
+    #   aggregated. The developer of the game must mark the stat as globally aggregated.
+    # @option params [String] :startdate Start date for daily totals
+    #   (unix epoch timestamp). (Optional)
+    # @option params [String] :enddate End date for daily totals (unix epoch timestamp). (Optional)
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetGlobalStatsForGame
+    def self.global_for_game(appid, params: {})
+      params[:appid] = appid
+      response = client.get 'GetGlobalStatsForGame/v1', params: params
+      response.parse_key('response')
+    end
+
+    # Get stat schema
+    # @param [Fixnum] appid The application ID for the Steam Game.
+    # @param [String] language (Optional) Language
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetSchemaForGame
+    def self.game_schema(appid, language: nil)
+      params = { appid: appid }
+      params[:l] = language unless language.nil?
+      response = client.get 'GetSchemaForGame/v2', params: params
+      response.parse_key('game')
+    end
+
+    # Get Number of Current Players
+    # @param [Fixnum] appid to pass to the API
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetNumberOfCurrentPlayers
+    def self.player_count(appid)
+      response = client.get 'GetNumberOfCurrentPlayers/v1',
+                                  params: { appid: appid }
+      response.parse_key('response')
+              .parse_key('player_count')
+    end
+
+    # Get Player Achievements
+    # @param [Fixnum] steamid 64 bit Steam ID to return Achievements list for.
+    # @param [Fixnum] appid AppID to get achievements for
+    # @param [String] language Language. If specified, it will return language data for
+    #   the requested language. (Optional)
+    # @return [Hash] A hash containing the API response
+    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetPlayerAchievements
+    def self.player_achievements(appid, steamid, language: nil)
+      params = { appid: appid, steamid: steamid }
+      params[:l] = language unless language.nil?
+      response = client.get 'GetPlayerAchievements/v1', params: params
+      response = response.parse_key('playerstats')
+      response.check_success
+      response.delete('success')
+      response
+    end
+
+    private
+
+    def self.client
+      build_client('ISteamUserStats')
+    end
+  end
+end

data/lib/steam-api/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+# Versioning Info
+module Steam
+  VERSION = '1.0.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+if File::exist? File.join(File.dirname(__FILE__), "secret.rb")
+  require 'secret'
+end
+
+require 'steam-api'

data/spec/steam/apps_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Steam::Apps do
+  describe '.get_all' do
+    it 'should allow users to look up a list of all apps' do
+      Steam::Apps.get_all
+        .should_not be_nil
+    end
+
+    it 'should allow users to look up a list of all apps' do
+      game = Steam::Apps.get_all.first
+      game.should have_key 'appid'
+      game.should have_key 'name'
+    end
+  end
+
+  describe '.get_servers' do
+    it 'should allow users to look up a list of servers at an ip' do
+      Steam::Apps.get_servers(addr: '192.168.1.1')
+        .should_not be_nil
+    end
+
+    it 'should allow users to look up a list of servers at an ip' do
+      Steam::Apps.get_servers(addr: '192.168.1.1')
+        .should == []
+    end
+  end
+
+  describe '.up_to_date' do
+    it 'should allow users to look up version info' do
+      Steam::Apps.up_to_date(appid: 440, version: 10)
+        .should_not be_nil
+    end
+
+    it 'should return a false up to date value if the verion is out of date' do
+      check = Steam::Apps.up_to_date(appid: 440, version: 10)
+      check['up_to_date'].should be_false
+      check['version_is_listable'].should be_false
+      check.should have_key('required_version')
+      check['message'].should == 'Your server is out of date, please upgrade'
+    end
+
+    it 'should return a positive up to date value if the version is correct' do
+      current = Steam::Apps.up_to_date(appid: 440, version: 10)['required_version']
+      check = Steam::Apps.up_to_date(appid: 440, version: current)
+      check['up_to_date'].should be_true
+      check['version_is_listable'].should be_true
+    end
+
+    it 'should capture json errors' do
+      lambda { Steam::Apps.up_to_date(appid: nil, version: 'foo') }
+        .should raise_error
+    end
+  end
+end

data/spec/steam/economy_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Steam::Economy do
+  describe '.asset_info' do
+    it 'should allow users to look up a list of all apps' do
+      Steam::Economy.asset_info(440, params: { class_count: 2,
+                                               classid0: 195151,
+                                               classid1: 16891096 })
+        .should_not be_nil
+    end
+
+    it 'should require class params' do
+      lambda { Steam::Economy.asset_info(440) }
+        .should raise_error
+    end
+
+    it 'should allow users to query asset info' do
+      result = Steam::Economy.asset_info(440, params: { class_count: 2,
+                                                        classid0: 195151,
+                                                        classid1: 16891096 })
+      result.should have_key('195151')
+      result.should have_key('16891096')
+    end
+  end
+
+  describe '.asset_prices' do
+    it 'should allow users to look up a list asset prices' do
+      Steam::Economy.asset_prices(440)
+        .should_not be_nil
+    end
+
+    it 'should allow return a list of assets' do
+      Steam::Economy.asset_prices(440)
+        .should have_key('assets')
+    end
+
+    it 'should allow return a list of asset tags' do
+      Steam::Economy.asset_prices(440)
+        .should have_key('tags')
+    end
+
+    it 'should allow return a list of asset tag ids' do
+      Steam::Economy.asset_prices(440)
+        .should have_key('tag_ids')
+    end
+  end
+end

data/spec/steam/news_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Steam::News do
+  describe '.get' do
+    it 'should allow users to look up a list news for an app' do
+      Steam::News.get(440)
+        .should_not be_nil
+    end
+
+    it 'should allow users to look up a list news for an app' do
+      news = Steam::News.get(440)
+      news.count.should == 20
+    end
+  end
+end

data/spec/steam/player_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Steam::Player do
+  describe '.owned_games' do
+    it 'should allow users to retrieve a list of games' do
+      Steam::Player.owned_games(76561197993276293)
+        .should_not be_nil
+    end
+
+    it 'should allow users to retrieve a list of games' do
+      Steam::Player.owned_games(76561197993276293)
+        .should have_key('game_count')
+    end
+
+    it 'should allow users to retrieve a list of games' do
+      Steam::Player.owned_games(76561197993276293)
+        .should have_key('games')
+    end
+  end
+
+  describe '.recently_played_games' do
+    it 'should allow users to list a players recent games' do
+      Steam::Player.recently_played_games(76561197993276293)
+        .should_not be_nil
+    end
+
+    it 'should allow users to list a players recent games' do
+      Steam::Player.recently_played_games(76561197993276293)
+        .should have_key 'total_count'
+    end
+
+    it 'should allow users to list a players recent games' do
+      Steam::Player.recently_played_games(76561197993276293)
+        .should have_key 'games'
+    end
+  end
+
+  describe '.steam_level' do
+    it 'should allow users to retrieve a users steam level' do
+      Steam::Player.steam_level(76561197993276293)
+        .should_not be_nil
+    end
+
+    it 'should allow users to retrieve a users steam level' do
+      Steam::Player.steam_level(76561197993276293)
+        .should be_a(Fixnum)
+    end
+  end
+
+  describe '.badges' do
+    it 'should allow a user to retrieve badges for a player' do
+      Steam::Player.badges(76561197993276293)
+        .should_not be_nil
+    end
+
+    it 'should allow a user to retrieve badges for a player' do
+      Steam::Player.badges(76561197993276293)
+        .should have_key 'badges'
+    end
+
+    it 'should allow a user to retrieve badges for a player' do
+      Steam::Player.badges(76561197993276293)
+        .should have_key 'player_level'
+    end
+
+    it 'should allow a user to retrieve badges for a player' do
+      Steam::Player.badges(76561197993276293)
+        .should have_key 'player_xp'
+    end
+
+    it 'should allow a user to retrieve badges for a player' do
+      Steam::Player.badges(76561197993276293)
+        .should have_key 'player_xp_needed_current_level'
+    end
+
+    it 'should allow a user to retrieve badges for a player' do
+      Steam::Player.badges(76561197993276293)
+        .should have_key 'player_xp_needed_to_level_up'
+    end
+  end
+
+  describe '.community_badge_progress' do
+    it 'should allow a user to retrieve community badge info for a player' do
+      Steam::Player.community_badge_progress(76561197993276293)
+        .should_not be_nil
+    end
+
+    it 'should allow a user to retrieve community badge info for a player' do
+      quest = Steam::Player.community_badge_progress(76561197993276293).first
+      quest.should have_key 'questid'
+      quest.should have_key 'completed'
+    end
+  end
+end