steam-api 1.0.0 → 1.2.0

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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Steam
   # A Ruby DSL for communicating with the Steam Web API.
   # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
@@ -7,14 +6,16 @@ module Steam
     # Get Owned Games
     # @param [Hash] params Parameters to pass to the API
     # @option params [Fixnum] :steamid The 64 bit ID of the player. (Optional)
-    # @option params [Boolean] :include_appinfo (false) Whether or not to include additional
-    #   details of apps - name and images.
-    # @option params [Boolean] :include_played_free_games (false) Whether or not to list
-    #   free-to-play games in the results.
-    # @option params [Array] :appids_filter You can optionally filter the list to a set of appids.
-    #   Note that these cannot be passed as a URL parameter, instead you must use the JSON format
-    #   described in Steam_Web_API#Calling_Service_interfaces. The expected input is an array of
-    #   integers (in JSON: "appids_filter: [ 440, 500, 550 ]" )
+    # @option params [Integer] :include_appinfo (0) Whether or not to include
+    #   additional details of apps - name and images.
+    # @option params [Boolean] :include_played_free_games (false) Whether or
+    #   not to list free-to-play games in the results.
+    # @option params [Array] :appids_filter You can optionally filter the list
+    #   to a set of appids.
+    #   Note that these cannot be passed as a URL parameter, instead you must
+    #   use the JSON format described in
+    #   Steam_Web_API#Calling_Service_interfaces. The expected input is an
+    #   array of integers (in JSON: "appids_filter: [ 440, 500, 550 ]" )
     # @see http://wiki.teamfortress.com/wiki/WebAPI/GetOwnedGames
     def self.owned_games(steamid, params: {})
       params[:steamid] = steamid
@@ -25,8 +26,9 @@ module Steam
     # Get Recently Played Games
     # @param [Hash] params Parameters to pass to the API
     # @option params [String] :steamid The SteamID of the account.
-    # @option params [String] :count Optionally limit to a certain number of games (the number of
-    #   games a person has played in the last 2 weeks is typically very small)
+    # @option params [String] :count Optionally limit to a certain number of
+    #   games (the number of games a person has played in the last 2 weeks is
+    #   typically very small)
     # @see http://wiki.teamfortress.com/wiki/WebAPI/GetRecentlyPlayedGames
     def self.recently_played_games(steamid, params: {})
       params[:steamid] = steamid
@@ -64,8 +66,6 @@ module Steam
               .parse_key('quests')
     end
 
-    private
-
     def self.client
       build_client 'IPlayerService'
     end

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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Steam
   # A Ruby DSL for communicating with the Steam Web API.
   # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
@@ -29,8 +28,6 @@ module Steam
       response
     end
 
-    private
-
     def self.client
       build_client 'ISteamRemoteStorage'
     end

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

@@ -0,0 +1,20 @@
+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 Store
+    # Get App Details
+    # @param String appid The UUID of the Steam Application
+    # @see https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI#appdetails
+    def self.app_details(appid)
+      response = client.get 'appdetails', params: { appids: appid }
+      response
+    end
+
+    private
+
+    def self.client
+      build_client '', base_url: Steam::Helpers::STORE_API_BASE_URL
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module Steam
   # @since 1.0.0
   module User
     # Get User's Friend List
-    # @param [String] steamid 
+    # @param [String] steamid
     # @param [String] relationship Relationship filter.
     #   Possibles values: all, friend.
     # @return [Hash] A hash object resulting from the API call; should
@@ -81,8 +81,6 @@ module Steam
       response.parse_key('steamid')
     end
 
-    private
-
     def self.client
       build_client 'ISteamUser'
     end

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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Steam
   # A Ruby DSL for communicating with the Steam Web API.
   # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
@@ -6,8 +5,8 @@ module Steam
   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.
+    # @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',
@@ -21,12 +20,14 @@ module Steam
     # @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] :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)
+    # @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: {})
@@ -53,7 +54,7 @@ module Steam
     # @see http://wiki.teamfortress.com/wiki/WebAPI/GetNumberOfCurrentPlayers
     def self.player_count(appid)
       response = client.get 'GetNumberOfCurrentPlayers/v1',
-                                  params: { appid: appid }
+                            params: { appid: appid }
       response.parse_key('response')
               .parse_key('player_count')
     end
@@ -61,8 +62,8 @@ module Steam
     # 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)
+    # @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)
@@ -75,7 +76,16 @@ module Steam
       response
     end
 
-    private
+    # Get User Stats for Game
+    # @param [Fixnum] appid AppID to get stats for.
+    # @param [Fixnum] steamid 64 bit Steam ID to return stats for.
+    # @return [Hash] A hash containing the API response.
+    # @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetUserStatsForGame_.28v0002.29
+    def self.player_stats(appid, steamid)
+      params = { appid: appid, steamid: steamid }
+      response = client.get 'GetUserStatsForGame/v2', params: params
+      response.parse_key('playerstats')
+    end
 
     def self.client
       build_client('ISteamUserStats')

data/lib/steam-api/version.rb

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

data/spec/spec_helper.rb

@@ -1,10 +1,4 @@
-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")

data/spec/steam/apps_spec.rb

@@ -2,54 +2,73 @@ 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
+    let(:result) { Steam::Apps.get_all }
+
+    it 'returns a list of apps' do
+      expect(result).to_not be_nil
+    end
+
+    it 'returns an appid for each game' do
+      expect(result.first).to have_key 'appid'
     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'
+    it 'returns a name for each game' do
+      expect(result.first).to 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
+    let(:result) { Steam::Apps.get_servers(addr: '192.168.1.1') }
+
+    it 'returns a valid response' do
+      expect(result).to_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 == []
+    it 'returns an empty array for an ip with no servers' do
+      expect(result).to eq([])
     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
+    context 'when looking up out of date version info' do
+      let(:result) { Steam::Apps.up_to_date(appid: 440, version: 10) }
+
+      it 'does not return a nil response' do
+        expect(result).to_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'
+      it "returns a false value for 'up_to_date'" do
+        expect(result['up_to_date']).to be_falsey
+      end
+
+      it "returns a false value for 'version_is_listable'" do
+        expect(result['version_is_listable']).to be_falsey
+      end
+
+      it 'returns a required_version' do
+        expect(result).to have_key('required_version')
+      end
+
+      it 'returns an error message' do
+        expect(result['message']).to eq('Your server is out of date, please upgrade')
+      end
     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
+    context 'when looking up current version info' do
+      let(:current) { Steam::Apps.up_to_date(appid: 440, version: 10)['required_version'] }
+      let(:check) { Steam::Apps.up_to_date(appid: 440, version: current) }
+
+      it 'returns a positive up to date value' do
+        expect(check['up_to_date']).to be_truthy
+      end
+
+      it 'returns a positive version_is_listable value' do
+        expect(check['version_is_listable']).to be_truthy
+      end
     end
 
     it 'should capture json errors' do
-      lambda { Steam::Apps.up_to_date(appid: nil, version: 'foo') }
-        .should raise_error
+      expect { Steam::Apps.up_to_date(appid: nil, version: 'foo') }.to raise_error(Steam::JSONError)
     end
   end
 end

data/spec/steam/economy_spec.rb

@@ -2,46 +2,42 @@ 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
+    let(:result) { Steam::Economy.asset_info(440,
+                                             params: { class_count: 2,
+                                                       classid0: 195151,
+                                                       classid1: 16891096 })}
+
+    it 'returns data' do
+      expect(result).to_not be_nil
     end
 
-    it 'should require class params' do
-      lambda { Steam::Economy.asset_info(440) }
-        .should raise_error
+    it 'requires class params' do
+      expect { Steam::Economy.asset_info(440) }.to raise_error(Steam::JSONError)
     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')
+    it 'allows users to query asset info' do
+      expect(result).to have_key('195151')
+      expect(result).to 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
+    let(:result) { Steam::Economy.asset_prices(440) }
+
+    it 'allows users to look up a list asset prices' do
+      expect(result).to_not be_nil
     end
 
-    it 'should allow return a list of assets' do
-      Steam::Economy.asset_prices(440)
-        .should have_key('assets')
+    it 'returns a list of assets' do
+      expect(result).to have_key('assets')
     end
 
-    it 'should allow return a list of asset tags' do
-      Steam::Economy.asset_prices(440)
-        .should have_key('tags')
+    it 'returns a list of asset tags' do
+      expect(result).to 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')
+    it 'returns a list of asset tag ids' do
+      expect(result).to have_key('tag_ids')
     end
   end
 end

data/spec/steam/news_spec.rb

@@ -2,14 +2,14 @@ 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
+    let(:result) { Steam::News.get(440) }
+
+    it 'allow users to look up a news list' do
+      expect(result).to_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
+    it 'returns the first 20 articles' do
+      expect(result.count).to eq(20)
     end
   end
 end

data/spec/steam/player_spec.rb

@@ -1,94 +1,106 @@
 require 'spec_helper'
 
 describe Steam::Player do
+  let(:playerid) { 76561197993276293 }
+
   describe '.owned_games' do
-    it 'should allow users to retrieve a list of games' do
-      Steam::Player.owned_games(76561197993276293)
-        .should_not be_nil
+    let(:result) { Steam::Player.owned_games(playerid) }
+
+    it 'allows users to retrieve a list of games' do
+      expect(result).to_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')
+    it 'returns a game_count' do
+      expect(result).to 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')
+    it 'returns a list of games' do
+      expect(result).to 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
+    let(:result) { Steam::Player.recently_played_games(playerid) }
+
+    it 'allows users to list a players recent games' do
+      expect(result).to_not be_nil
+    end
+
+    it 'returns total_count' do
+      expect(result).to have_key('total_count')
+    end
+
+    it 'returns the list of games' do
+      expect(result).to have_key('games')
     end
 
-    it 'should allow users to list a players recent games' do
-      Steam::Player.recently_played_games(76561197993276293)
-        .should have_key 'total_count'
+    it 'returns the recent playtime for games' do
+      expect(result['games'].first).to have_key('playtime_2weeks')
     end
 
-    it 'should allow users to list a players recent games' do
-      Steam::Player.recently_played_games(76561197993276293)
-        .should have_key 'games'
+    it 'returns the full playtime for games' do
+      expect(result['games'].first).to have_key('playtime_forever')
     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
+    let(:result) { Steam::Player.steam_level(playerid) }
+
+    it 'allows users to retrieve a users steam level' do
+      expect(result).to_not be_nil
     end
 
-    it 'should allow users to retrieve a users steam level' do
-      Steam::Player.steam_level(76561197993276293)
-        .should be_a(Fixnum)
+    it 'returns the level number' do
+      expect(result).to be_a(Integer)
     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
+    let(:result) { Steam::Player.badges(playerid) }
+
+    it 'allows a user to retrieve badges for a player' do
+      expect(result).to_not be_nil
+    end
+
+    it 'returns a list of badges' do
+      expect(result).to have_key('badges')
     end
 
-    it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(76561197993276293)
-        .should have_key 'badges'
+    it 'returns the player level' do
+      expect(result).to 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_level'
+    it 'returns the player level as a number' do
+      expect(result['player_level']).to be_a(Integer)
     end
 
-    it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(76561197993276293)
-        .should have_key 'player_xp'
+    it 'returns the players current xp' do
+      expect(result).to 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'
+    it 'returns the xp a player needed to reach thier current level' do
+      expect(result).to 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'
+    it 'returns the xp a player needs to reach next level' do
+      expect(result).to 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
+    let(:result) { Steam::Player.community_badge_progress(playerid) }
+
+    it 'allows a user to retrieve community badge info for a player' do
+      expect(result).to_not be_nil
+    end
+
+    it 'returns a list of quests' do
+      expect(result).to be_a(Array)
     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'
+    it 'returns a list of quests with ids and completion status' do
+      expect(result.first).to have_key('questid')
+      expect(result.first).to have_key('completed')
     end
   end
 end