steam-api 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: a420d8645cd116e9df469e837dfd32cab3385a09
-  data.tar.gz: 40a66089d1cd4f233877a7eac8dd1dfa0874cbeb
+SHA1:
+  metadata.gz: d50be04a9a091da6291a0a4590554e82c6442869
+  data.tar.gz: 9102de40d9ff1aee65fe88425b9b3d54eae74512
 SHA512:
-  metadata.gz: 32d8f5be1ffe6d3918d4b3042d18992db77d2a978a59dee0be538418ece9ec533f41a3ac746778e03682eea2f9709011d424ed8c5752acfca1bc678cbac24c5e
-  data.tar.gz: b5459282ca4b3e5828101123e6671071d146c6894efb9d99099495391cc38bce6956d31ad1c7c33926c9c0debb391d1a4718693cfe9c0571a49ac8ad981bf26c
+  metadata.gz: fc84ebf654572c2ede0f7cdbca6c529ba627a0683d50bc31440b06c78abf7e7d54666cd48a5be180663265957be109fedb5e53a970f397151f5bdbaaa3003727
+  data.tar.gz: 9d66c4b0587ee46f410261b761ad644edbb2383c05d3bfc94da247c016f5702ff0aeae25bc4d629dbb24aec07a9c492ff67c3c8df9482fd7dbf9cf95e50e2dd7

data/.rspec

@@ -0,0 +1 @@
+-f d -c

data/lib/steam-api/helpers.rb

@@ -1,12 +1,12 @@
 module Steam
+  # Helper Module
   module Helpers
     # Conveniance method to build clients
     # @param [String] api The endpoint of the API
     # @param [String] base_url the root uri for steam's API
     # @return [Steam::Client] The Client
-    def build_client(api, base_url: 'http://api.steampowered.com')
+    def build_client(api, base_url: 'https://api.steampowered.com')
       Steam::Client.new([base_url, api].join('/'))
     end
   end
 end
-

data/lib/steam-api/response.rb

@@ -1,12 +1,12 @@
 module Steam
   # Since the steam responses are so randomly inconsistant we're making a new
   #   class to manage the responses.
-  # FIXME move all hash extensions here once the gem is finished and make
+  # FIXME: move all hash extensions here once the gem is finished and make
   class Response < Hash
-  #   def parse_key(key)
-  #     fail Steam::JSONError unless self.key?(key)
-  #     self[key]
-  #   end
+    # def parse_key(key)
+    #   fail Steam::JSONError unless self.key?(key)
+    #   self[key]
+    # end
   end
 end
 

data/lib/steam-api/steam.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Base class def
 module Steam
   @apikey = ENV['STEAM_API_KEY']

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

@@ -5,13 +5,13 @@ module Steam
   # @since 1.0.0
   module Apps
     # Get Steam Applications
-    # @return [Hash] A list of objects containing the title and app ID of each program
-    #   available in the store.
+    # @return [Hash] A list of objects containing the title and app ID of
+    #   each program available in the store.
     # @see http://wiki.teamfortress.com/wiki/WebAPI/GetAppList
     def self.get_all
       response = client.get('GetApplist/v2')
-        .parse_key('applist')
-        .parse_key('apps')
+                 .parse_key('applist')
+                 .parse_key('apps')
       response
     end
 

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

@@ -7,29 +7,35 @@ module Steam
     # Get Asset Class Info
     # @param [String] appid The application ID for the Steam Game.
     # @param [Hash] params Parameters to pass to the API
-    # @option params [Fixnum] :class_count The number of classids passed to the request.
-    # @option params [Fixnum] :classidN Where N can be a series of sequential numbers to form a list of class IDs. [1] [2]
-    # @option params [Fixnum] :instanceidN Instance ID of the nth class. (Optional)
-    # @option params [String] :language The ISO639-1 language code for the language all localized
-    #   strings should be returned in. Not all strings have been translated to every language.
-    #   If a language does not have a string, the English string will be returned instead. If this
-    #   parameter is omitted the string token will be returned for the strings. (Optional)
+    # @option params [Fixnum] :class_count The number of classids passed to
+    #   the request.
+    # @option params [Fixnum] :classidN Where N can be a series of sequential
+    #   numbers to form a list of class IDs. [1] [2]
+    # @option params [Fixnum] :instanceidN Instance ID of the nth class.
+    # @option params [String] :language The ISO639-1 language code for the
+    #   language all localized strings should be returned in. Not all strings
+    #   have been translated to every language.
+    #   If a language does not have a string, the English string will be
+    #   returned instead. If this parameter is omitted the string token will
+    #   be returned for the strings.
     # @return [Hash] A hash containing the API response
     # @see http://wiki.teamfortress.com/wiki/WebAPI/UpToDateCheck
     def self.asset_info(appid, params: {})
       params[:appid] = appid
-      response = client.get 'GetAssetClassInfo/v1',
-                 params: params
+      response = client.get 'GetAssetClassInfo/v1', params: params
       parse_response(response)
     end
 
     # Get Asset Prices
     # @param [String] appid The application ID for the Steam Game.
-    # @param [String] language The ISO639-1 language code for the language all localized
-    #   strings should be returned in. Not all strings have been translated to every language.
-    #   If a language does not have a string, the English string will be returned instead. If this
-    #   parameter is omitted the string token will be returned for the strings. (Optional)
-    # @param [String] currency The ISO 4217 code for currency specific filtering. (Optional)
+    # @param [String] language The ISO639-1 language code for the language
+    #   all localized strings should be returned in. Not all strings have been
+    #   translated to every language.
+    #   If a language does not have a string, the English string will be
+    #   returned instead. If this parameter is omitted the string token will
+    #   be returned for the strings. (Optional)
+    # @param [String] currency The ISO 4217 code for currency specific
+    #   filtering. (Optional)
     # @return [Hash] A hash containing the API response
     # @see http://wiki.teamfortress.com/wiki/WebAPI/GetAssetPrices
     def self.asset_prices(appid, language: nil, currency: nil)
@@ -37,7 +43,7 @@ module Steam
       params[:language] = language unless language.nil?
       params[:currency] = currency unless currency.nil?
       response = client.get 'GetAssetPrices/v1',
-                 params: params
+                            params: params
       parse_response(response)
     end
 

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

@@ -8,11 +8,16 @@ module Steam
     # @param [Hash] params Parameters to pass to the API
     # @option params [String] :appid The application ID for the Steam Game.
     # @option params [String] :key Steam Api Key
-    # @option params [Fixnum] :count How many news enties you want to get returned. (Optional)
-    # @option params [Fixnum] :maxlength Maximum length of each news entry. (Optional)
-    # @option params [Fixnum] :enddate Unix timestamp, returns posts before this date. (Optional)
-    # @option params [String] :feeds Commma-seperated list of feed names to return news for. (Optional)
-    # @return [Hash] A hash object of the latest news items for a game specified by its appID.
+    # @option params [Fixnum] :count How many news enties you want to get
+    #   returned. (Optional)
+    # @option params [Fixnum] :maxlength Maximum length of each news
+    #   entry. (Optional)
+    # @option params [Fixnum] :enddate Unix timestamp, returns posts before
+    #   this date. (Optional)
+    # @option params [String] :feeds Commma-seperated list of feed names to
+    #   return news for. (Optional)
+    # @return [Hash] A hash object of the latest news items for a game
+    #   specified by its appID.
     # @see http://wiki.teamfortress.com/wiki/WebAPI/GetNewsForApp
     def self.get(appid, params: {})
       params[:appid] = appid

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

@@ -7,14 +7,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 +27,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
@@ -42,7 +45,7 @@ module Steam
       response = client.get 'GetSteamLevel/v1',
                             params: { steamid: steamid }
       response.parse_key('response')
-              .parse_key('player_level')
+        .parse_key('player_level')
     end
 
     # Get a player's Steam badges
@@ -61,7 +64,7 @@ module Steam
       response = client.get 'GetCommunityBadgeProgress/v1',
                             params: { steamid: steamid }
       response.parse_key('response')
-              .parse_key('quests')
+        .parse_key('quests')
     end
 
     private

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
@@ -17,7 +17,7 @@ module Steam
                             params: { steamid: steamid,
                                       relationship: relationship }
       response = response.parse_key('friendslist')
-                         .parse_key('friends')
+                 .parse_key('friends')
       response
     end
 
@@ -54,7 +54,7 @@ module Steam
       response = client.get 'GetPlayerSummaries/v2/',
                             params: { steamids: steamids.join(',') }
       response.parse_key('response')
-              .parse_key('players')
+        .parse_key('players')
     end
 
     # Get User Groups

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

@@ -6,14 +6,14 @@ 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',
                             params: { gameid: appid }
       response = response.parse_key('achievementpercentages')
-                         .parse_key('achievements')
+                 .parse_key('achievements')
       response
     end
 
@@ -21,12 +21,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,16 +55,16 @@ 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')
+        .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)
+    # @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,6 +77,17 @@ module Steam
       response
     end
 
+    # 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
+
     private
 
     def self.client

data/lib/steam-api/version.rb

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

data/spec/steam/apps_spec.rb

@@ -2,60 +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
-      expect(Steam::Apps.get_all)
-        .to_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
-      expect(game).to have_key 'appid'
-      expect(game).to 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
-      expect(Steam::Apps.get_servers(addr: '192.168.1.1'))
-        .to_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
-      expect(Steam::Apps.get_servers(addr: '192.168.1.1'))
-        .to eq([])
+    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
-      expect(Steam::Apps.up_to_date(appid: 440, version: 10))
-        .to_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)
-      expect(check['up_to_date'])
-        .to be_falsey
-      expect(check['version_is_listable'])
-        .to be_falsey
-      expect(check)
-        .to have_key('required_version')
-      expect(check['message'])
-        .to eq('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)
-      expect(check['up_to_date'])
-        .to be_truthy
-      expect(check['version_is_listable'])
-        .to be_truthy
+    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
-      expect(lambda { Steam::Apps.up_to_date(appid: nil, version: 'foo') })
-        .to raise_error
+      expect { Steam::Apps.up_to_date(appid: nil, version: 'foo') }.to raise_error
     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
-      asset = Steam::Economy.asset_info(440, params: { class_count: 2,
+    let(:result) { Steam::Economy.asset_info(440,
+                                             params: { class_count: 2,
                                                        classid0: 195151,
-                                                       classid1: 16891096 })
-      expect(asset).to_not be_nil
+                                                       classid1: 16891096 })}
+
+    it 'returns data' do
+      expect(result).to_not be_nil
     end
 
-    it 'should require class params' do
-      expect(lambda { Steam::Economy.asset_info(440) })
-        .to raise_error
+    it 'requires class params' do
+      expect { Steam::Economy.asset_info(440) }.to 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 })
+    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
-      expect(Steam::Economy.asset_prices(440))
-        .to_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
-      expect(Steam::Economy.asset_prices(440))
-        .to 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
-      expect(Steam::Economy.asset_prices(440))
-        .to 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
-      expect(Steam::Economy.asset_prices(440))
-        .to 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
-      expect(Steam::News.get(440))
-        .to_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)
-      expect(news.count).to eq(20)
+    it 'returns the first 20 articles' do
+      expect(result.count).to eq(20)
     end
   end
 end

data/spec/steam/player_spec.rb

@@ -1,93 +1,106 @@
 require 'spec_helper'
 
 describe Steam::Player do
-  before(:each) do
-    @playerid = 76561197993276293
-  end
+  let(:playerid) { 76561197993276293 }
 
   describe '.owned_games' do
-    it 'should allow users to retrieve a list of games' do
-      expect(Steam::Player.owned_games(@playerid))
-        .to_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
-      expect(Steam::Player.owned_games(@playerid))
-        .to 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
-      expect(Steam::Player.owned_games(@playerid))
-        .to 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
-      expect(Steam::Player.recently_played_games(@playerid))
-        .to_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 '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
-      expect(Steam::Player.recently_played_games(@playerid))
-        .to have_key 'total_count'
+    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
-      expect(Steam::Player.steam_level(@playerid))
-        .to_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
-      expect(Steam::Player.steam_level(@playerid))
-        .to be_a(Fixnum)
+    it 'returns the level number' do
+      expect(result).to be_a(Fixnum)
     end
   end
 
   describe '.badges' do
-    it 'should allow a user to retrieve badges for a player' do
-      expect(Steam::Player.badges(@playerid))
-        .to_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
-      expect(Steam::Player.badges(@playerid))
-        .to 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
-      expect(Steam::Player.badges(@playerid))
-        .to have_key 'player_level'
+    it 'returns the player level as a number' do
+      expect(result['player_level']).to be_a(Fixnum)
     end
 
-    it 'should allow a user to retrieve badges for a player' do
-      expect(Steam::Player.badges(@playerid))
-        .to 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
-      expect(Steam::Player.badges(@playerid))
-        .to 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
-      expect(Steam::Player.badges(@playerid))
-        .to 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
-      expect(Steam::Player.community_badge_progress(@playerid))
-        .to_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(@playerid).first
-      expect(quest).to have_key 'questid'
-      expect(quest).to 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

data/spec/steam/users-stats_spec.rb

@@ -2,88 +2,95 @@ require 'spec_helper'
 
 describe Steam::UserStats do
   describe '.achievement_percentages' do
-    it 'should return achievement information' do
-      expect(Steam::UserStats.achievement_percentages(440))
-        .to_not be_nil
+    let(:result) { Steam::UserStats.achievement_percentages(440) }
+
+    it 'returns achievement information' do
+      expect(result).to_not be_nil
     end
 
-    it 'should return all achievements for a game' do
-      achs = Steam::UserStats.achievement_percentages(440)
-      expect(achs.first).to have_key('name')
-      expect(achs.first).to have_key('percent')
+    it 'returns all achievements for a game' do
+      expect(result.first).to have_key('name')
+      expect(result.first).to have_key('percent')
     end
   end
 
   describe '.game_schema' do
-    it 'should return global game stats' do
-      expect(Steam::UserStats.game_schema(440))
-        .to_not be_nil
-    end
+    let(:result) { Steam::UserStats.game_schema(440) }
 
-    it 'should return global game stats with proper schema' do
-      expect(Steam::UserStats.game_schema(440))
-        .to have_key('gameName')
+    it 'returns global game stats' do
+      expect(result).to_not be_nil
     end
 
-    it 'should return global game stats with proper schema' do
-      expect(Steam::UserStats.game_schema(440))
-        .to have_key('gameName')
+    it 'returns global game stats with a gameName' do
+      expect(result).to have_key('gameName')
     end
 
-    it 'should return global game stats with proper schema' do
-      expect(Steam::UserStats.game_schema(440))
-        .to have_key('gameVersion')
+    it 'returns global game stats with a gameVersion' do
+      expect(result).to have_key('gameVersion')
     end
 
-    it 'should return global game stats with proper schema' do
-      expect(Steam::UserStats.game_schema(440))
-        .to have_key('availableGameStats')
+    it 'returns global game stats with availableGameStats' do
+      expect(result).to have_key('availableGameStats')
     end
   end
 
   describe '.global_for_game' do
-    it 'should return global game stats' do
-      expect(Steam::UserStats.global_for_game(201830,
-                                       params: { 'name[0]' => 'totalDeaths',
-                                                 count: 10 }))
+    it 'returns global game stats' do
+      Steam::UserStats.global_for_game(201830, params: { 'name[0]' => 'totalDeaths', count: 10 })
     end
   end
 
   describe '.player_count' do
-    it 'should return a player count' do
-      expect(Steam::UserStats.player_count(440))
-        .to be_a(Fixnum)
+    it 'returns a player count' do
+      expect(Steam::UserStats.player_count(440)).to be_a(Fixnum)
     end
   end
 
   describe '.get_player_achievements' do
-    before(:each) do
-      @achs = Steam::UserStats.player_achievements(440, 76561197969622382)
+    let(:achs) { Steam::UserStats.player_achievements(440, 76561197969622382) }
+
+    it 'returns a list of player achievements' do
+      expect(achs).to have_key('achievements')
+    end
+
+    it 'returns a gameName' do
+      expect(achs).to have_key('gameName')
+    end
+
+    it 'returns correct gameName' do
+      expect(achs['gameName']).to eq('Team Fortress 2')
     end
 
-    it 'should return player achievements' do
-      expect(@achs)
-        .to have_key('achievements')
+    it 'returns a steamID' do
+      expect(achs).to have_key('steamID')
+    end
+
+    it 'returns the correct steamID' do
+      expect(achs['steamID']).to eq('76561197969622382')
+    end
+  end
+
+  describe '.player_stats' do
+    let(:stats) { Steam::UserStats.player_stats(440, 76561197969622382) }
+
+    it 'returns player stats' do
+      expect(stats).to have_key('stats')
     end
 
-    it 'should return player achievements' do
-      expect(@achs)
-        .to have_key('gameName')
+    it 'returns a gameName' do
+      expect(stats).to have_key('gameName')
     end
 
-    it 'should return player achievements' do
-      expect(@achs['gameName'])
-        .to eq('Team Fortress 2')
+    it 'returns the correct gameName' do
+      expect(stats['gameName']).to eq('Team Fortress 2')
     end
 
-    it 'should return player achievements' do
-      expect(Steam::UserStats.player_achievements(440, 76561197969622382))
-        .to have_key('steamID')
+    it 'returns a steamID' do
+      expect(stats).to have_key('steamID')
     end
 
-    it 'should return player achievements' do
-      expect(Steam::UserStats.player_achievements(440, 76561197969622382)['steamID'])
-        .to eq('76561197969622382')
+    it 'returns a correct steamID' do
+      expect(stats['steamID']).to eq('76561197969622382')
     end
   end
 end

data/spec/steam/users_spec.rb

@@ -1,89 +1,80 @@
 require 'spec_helper'
 
 describe Steam::User do
-  before(:each) do
-    @playerid = 76561197993276293
-    @playerid2 = 76561197969622382
-  end
+  let(:playerid) { 76561197993276293 }
+  let(:playerid2) { 76561197969622382 }
 
   describe '.friends' do
-    it 'should allow users to check a friends for a user' do
-      response = Steam::User.friends(@playerid)
-      expect(response).to_not be_nil
+    let(:result) { Steam::User.friends(playerid) }
+
+    it 'allows users to check a friends for a user' do
+      expect(result).to_not be_nil
     end
 
-    it 'should allow users to check a friends for a user' do
-      expect(Steam::User.friends(@playerid).map { |friend| friend.first.last })
-        .to include(@playerid2.to_s)
+    it 'returns a list of friends of a user' do
+      expect(result.map { |friend| friend.first.last }).to include(playerid2.to_s)
     end
 
-    it 'should return an error on a bad friend id' do
-      expect(lambda { Steam::User.friends('765611') })
-        .to raise_error
+    it 'raises an error on a bad friend id' do
+      expect { Steam::User.friends('765611') }.to raise_error
     end
 
-    it 'should return  the same content for :friends and :all' do
-      expect(Steam::User.friends(@playerid2, relationship: :friend))
-        .to eq(Steam::User.friends(@playerid2, relationship: :all))
+    it 'returns the same content for :friends and :all' do
+      friends = Steam::User.friends(playerid2, relationship: :friend)
+      all_friends = Steam::User.friends(playerid2, relationship: :all)
+      expect(friends).to eq(all_friends)
     end
 
-    it 'should return an error on a bad friend id' do
-      expect(lambda { Steam::User.friends(@playerid2, relationship: :sadsad) })
-        .to raise_error(Steam::JSONError)
+    it 'returns an error on a bad friend relationship' do
+      expect { Steam::User.friends(playerid2, relationship: :sadsad) }.to raise_error(Steam::JSONError)
     end
   end
 
   describe '.bans' do
-    it 'should allow users to check bans for a user' do
-      expect(Steam::User.bans(@playerid))
-        .to_not be_nil
+    it 'allows users to check bans for a user' do
+      expect(Steam::User.bans(playerid)).to_not be_nil
     end
 
-    it 'should return a blank list for bad ids' do
-      expect(Steam::User.bans(7993276293))
-        .to eq({ 'players' => [] })
+    it 'returns a blank list for bad ids' do
+      expect(Steam::User.bans(7993276293)).to eq({ 'players' => [] })
     end
 
-    it 'should allow users to check a bans for multiple steamids' do
-      expect(Steam::User.bans([@player, @player2]))
-        .to_not be_nil
+    it 'allow users to check bans for multiple steamids' do
+      expect(Steam::User.bans([playerid, playerid2])).to_not be_nil
     end
   end
 
   describe '.summary' do
-    it 'should allow users to get a summary for a user' do
-      expect(Steam::User.summary(@playerid))
-        .to_not be_nil
+    it 'allows users to get a summary for a user' do
+      expect(Steam::User.summary(playerid)).to_not be_nil
     end
 
-    it 'should allow users to check summaries for multiple accounts' do
-      expect(Steam::User.summaries([@player, @player2]))
-        .to_not be_nil
+    it 'allows users to check summaries for multiple accounts' do
+      expect(Steam::User.summaries([playerid, playerid2])).to_not be_nil
     end
   end
 
   describe '.vanity_to_steamid' do
-    it 'should return values when they look up vanity urls' do
-      expect(Steam::User.vanity_to_steamid('asmeroth'))
-        .to_not be_nil
+    let(:result) { Steam::User.vanity_to_steamid('asmeroth') }
+
+    it 'return values when they look up vanity urls' do
+      expect(result).to_not be_nil
     end
 
-    it 'should return the correct id when users look up vanity urls' do
-      expect(Steam::User.vanity_to_steamid('asmeroth'))
-        .to eq(@playerid.to_s)
+    it 'returns the correct id when users look up vanity urls' do
+      expect(result).to eq(playerid.to_s)
     end
   end
 
   describe '.groups' do
-    it 'should allow users to look groups a player is a member of' do
-      expect(Steam::User.groups(@playerid))
-        .to_not be_nil
+    let(:result) { Steam::User.groups(playerid) }
+
+    it 'allow users to look up a users groups' do
+      expect(result).to_not be_nil
     end
 
-    it 'should return an accurate list of groups a player is a member of' do
-      response = Steam::User.groups(@playerid)
-      expect(response.map { |g| g.values.first })
-        .to include '3640974'
+    it 'returns an accurate list of groups a player is a member of' do
+      expect(result.map { |g| g.values.first }).to include('3640974')
     end
   end
 end

data/spec/steam_spec.rb

@@ -1,38 +1,38 @@
 require 'spec_helper'
 
 describe Steam do
-  before(:all) do
-    @apikey = Steam.apikey
-  end
+  describe '.apikey' do
+    before(:all) do
+      @apikey = Steam.apikey
+    end
 
-  after(:each) do
-    Steam.apikey = @apikey
-  end
+    after(:each) do
+      Steam.apikey = @apikey
+    end
 
-  it 'should return a Steam API key if one is defined' do
-    expect(Steam.apikey).to_not be_nil
-  end
+    it 'returns a Steam API key if one is defined' do
+      expect(Steam.apikey).to_not be_nil
+    end
 
-  it 'should return an error if the Steam Key is missing' do
-    Steam.apikey = nil
-    ENV['STEAM_API_KEY'] = nil
-    expect(lambda { Steam.apikey })
-      .to raise_error(ArgumentError, /Please set your Steam API key/)
-  end
+    it 'returns an error if the Steam Key is missing' do
+      Steam.apikey = nil
+      ENV['STEAM_API_KEY'] = nil
+      expect { Steam.apikey }.to raise_error(ArgumentError, /Please set your Steam API key/)
+    end
 
-  it 'should return a new value if set to a different API key' do
-    old = Steam.apikey
-    Steam.apikey = 'blah'
-    expect(Steam.apikey).to_not eq(old)
-    expect(Steam.apikey).to eq('blah')
-  end
+    it 'returns a new value if set to a different API key' do
+      old = Steam.apikey
+      Steam.apikey = 'blah'
+      expect(Steam.apikey).to_not eq(old)
+      expect(Steam.apikey).to eq('blah')
+    end
 
-  it 'should allow users to set the apikey post init using ENV' do
-    Steam.apikey = nil
-    ENV['STEAM_API_KEY'] = nil
-    expect(lambda { Steam.apikey })
-      .to raise_error(ArgumentError, /Please set your Steam API key/)
-    ENV['STEAM_API_KEY'] = @apikey
-    expect(Steam.apikey).to eq(@apikey)
+    it 'allows users to set the apikey post init using ENV' do
+      Steam.apikey = nil
+      ENV['STEAM_API_KEY'] = nil
+      expect { Steam.apikey }.to raise_error(ArgumentError, /Please set your Steam API key/)
+      ENV['STEAM_API_KEY'] = @apikey
+      expect(Steam.apikey).to eq(@apikey)
+    end
   end
 end

metadata

@@ -1,109 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: steam-api
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Haberer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.7
 description: Simple Steam Gem
@@ -113,8 +113,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -154,17 +155,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple Gem to interact witht the Steam Web API
@@ -178,3 +179,4 @@ test_files:
 - spec/steam/users-stats_spec.rb
 - spec/steam/users_spec.rb
 - spec/steam_spec.rb
+has_rdoc: