steam-api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 126cf4dc03315490747599e176d6f314b72237e4
-  data.tar.gz: 712bca6def072b84cba7c953678e5b5f695ee225
+  metadata.gz: e0baaf180a77930f5d4f6c330611a73ce8fe980e
+  data.tar.gz: 2de31d7ddbcbf8cc5656648515b015b14bb2753e
 SHA512:
-  metadata.gz: 48b6e6aa5c27fa05dd9ecb1e824a9781176beb99eb0f02b7d3256a9a02c6d185666f6d479f726e75225f0a082ece6981e280f75f3e48fcb518d3c20637061bb9
-  data.tar.gz: 0248892823f35756eb80cef56d129f4f9ec8d6a48941725c2c5a301e52565928bb0ff88c60967ff86af331f1331997cdc83b0760cdd1dcde6e278565e4d051c5
+  metadata.gz: dcffe8cc1ee1b03737d4b3fa59f8a224004a2d5cde6cb65cc181eaf86f338618b21ffba2e3ac1e92237dc1e84c44a8939dd9144d7f682a9cf819a4cd212ea3dc
+  data.tar.gz: 1b25675f516359a5df9f346a12c486ec4106a3114911a7e175822114c84fda0683643121013f06f86788eab67c56b05412ac8c65986000dfdd4972fac030b81e

data/lib/steam-api/steam.rb

@@ -4,7 +4,13 @@ module Steam
   @apikey = ENV['STEAM_API_KEY']
 
   def self.apikey
-    fail ArgumentError, 'Please set your Steam API key.' if @apikey.nil?
+    if @apikey.nil?
+      if ENV.key?('STEAM_API_KEY')
+        @apikey = ENV['STEAM_API_KEY']
+      else
+        fail ArgumentError, 'Please set your Steam API key.'
+      end
+    end
     @apikey
   end
 

data/lib/steam-api/version.rb

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

data/spec/steam/apps_spec.rb

@@ -3,53 +3,59 @@ 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
+      expect(Steam::Apps.get_all)
+        .to_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'
+      expect(game).to have_key 'appid'
+      expect(game).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
+      expect(Steam::Apps.get_servers(addr: '192.168.1.1'))
+        .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 == []
+      expect(Steam::Apps.get_servers(addr: '192.168.1.1'))
+        .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
+      expect(Steam::Apps.up_to_date(appid: 440, version: 10))
+        .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'
+      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')
     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
+      expect(check['up_to_date'])
+        .to be_truthy
+      expect(check['version_is_listable'])
+        .to be_truthy
     end
 
     it 'should capture json errors' do
-      lambda { Steam::Apps.up_to_date(appid: nil, version: 'foo') }
-        .should raise_error
+      expect(lambda { Steam::Apps.up_to_date(appid: nil, version: 'foo') })
+        .to raise_error
     end
   end
 end

data/spec/steam/economy_spec.rb

@@ -3,45 +3,45 @@ 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
+      asset = Steam::Economy.asset_info(440, params: { class_count: 2,
+                                                       classid0: 195151,
+                                                       classid1: 16891096 })
+      expect(asset).to_not be_nil
     end
 
     it 'should require class params' do
-      lambda { Steam::Economy.asset_info(440) }
-        .should raise_error
+      expect(lambda { 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 })
-      result.should have_key('195151')
-      result.should have_key('16891096')
+      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
+      expect(Steam::Economy.asset_prices(440))
+        .to_not be_nil
     end
 
     it 'should allow return a list of assets' do
-      Steam::Economy.asset_prices(440)
-        .should have_key('assets')
+      expect(Steam::Economy.asset_prices(440))
+        .to have_key('assets')
     end
 
     it 'should allow return a list of asset tags' do
-      Steam::Economy.asset_prices(440)
-        .should have_key('tags')
+      expect(Steam::Economy.asset_prices(440))
+        .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')
+      expect(Steam::Economy.asset_prices(440))
+        .to have_key('tag_ids')
     end
   end
 end

data/spec/steam/news_spec.rb

@@ -3,13 +3,13 @@ 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
+      expect(Steam::News.get(440))
+        .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
+      expect(news.count).to eq(20)
     end
   end
 end

data/spec/steam/player_spec.rb

@@ -7,87 +7,87 @@ describe Steam::Player do
 
   describe '.owned_games' do
     it 'should allow users to retrieve a list of games' do
-      Steam::Player.owned_games(@playerid)
-        .should_not be_nil
+      expect(Steam::Player.owned_games(@playerid))
+        .to_not be_nil
     end
 
     it 'should allow users to retrieve a list of games' do
-      Steam::Player.owned_games(@playerid)
-        .should have_key('game_count')
+      expect(Steam::Player.owned_games(@playerid))
+        .to have_key('game_count')
     end
 
     it 'should allow users to retrieve a list of games' do
-      Steam::Player.owned_games(@playerid)
-        .should have_key('games')
+      expect(Steam::Player.owned_games(@playerid))
+        .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(@playerid)
-        .should_not be_nil
+      expect(Steam::Player.recently_played_games(@playerid))
+        .to_not be_nil
     end
 
     it 'should allow users to list a players recent games' do
-      Steam::Player.recently_played_games(@playerid)
-        .should have_key 'total_count'
+      expect(Steam::Player.recently_played_games(@playerid))
+        .to have_key 'total_count'
     end
   end
 
   describe '.steam_level' do
     it 'should allow users to retrieve a users steam level' do
-      Steam::Player.steam_level(@playerid)
-        .should_not be_nil
+      expect(Steam::Player.steam_level(@playerid))
+        .to_not be_nil
     end
 
     it 'should allow users to retrieve a users steam level' do
-      Steam::Player.steam_level(@playerid)
-        .should be_a(Fixnum)
+      expect(Steam::Player.steam_level(@playerid))
+        .to be_a(Fixnum)
     end
   end
 
   describe '.badges' do
     it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(@playerid)
-        .should_not be_nil
+      expect(Steam::Player.badges(@playerid))
+        .to_not be_nil
     end
 
     it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(@playerid)
-        .should have_key 'badges'
+      expect(Steam::Player.badges(@playerid))
+        .to have_key 'badges'
     end
 
     it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(@playerid)
-        .should have_key 'player_level'
+      expect(Steam::Player.badges(@playerid))
+        .to have_key 'player_level'
     end
 
     it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(@playerid)
-        .should have_key 'player_xp'
+      expect(Steam::Player.badges(@playerid))
+        .to have_key 'player_xp'
     end
 
     it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(@playerid)
-        .should have_key 'player_xp_needed_current_level'
+      expect(Steam::Player.badges(@playerid))
+        .to have_key 'player_xp_needed_current_level'
     end
 
     it 'should allow a user to retrieve badges for a player' do
-      Steam::Player.badges(@playerid)
-        .should have_key 'player_xp_needed_to_level_up'
+      expect(Steam::Player.badges(@playerid))
+        .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(@playerid)
-        .should_not be_nil
+      expect(Steam::Player.community_badge_progress(@playerid))
+        .to_not be_nil
     end
 
     it 'should allow a user to retrieve community badge info for a player' do
       quest = Steam::Player.community_badge_progress(@playerid).first
-      quest.should have_key 'questid'
-      quest.should have_key 'completed'
+      expect(quest).to have_key 'questid'
+      expect(quest).to have_key 'completed'
     end
   end
 end

data/spec/steam/users-stats_spec.rb

@@ -3,83 +3,87 @@ require 'spec_helper'
 describe Steam::UserStats do
   describe '.achievement_percentages' do
     it 'should return achievement information' do
-      Steam::UserStats.achievement_percentages(440)
-        .should_not be_nil
+      expect(Steam::UserStats.achievement_percentages(440))
+        .to_not be_nil
     end
 
     it 'should return all achievements for a game' do
       achs = Steam::UserStats.achievement_percentages(440)
-      achs.first.should have_key('name')
-      achs.first.should have_key('percent')
+      expect(achs.first).to have_key('name')
+      expect(achs.first).to have_key('percent')
     end
   end
 
   describe '.game_schema' do
     it 'should return global game stats' do
-      Steam::UserStats.game_schema(440)
-        .should_not be_nil
+      expect(Steam::UserStats.game_schema(440))
+        .to_not be_nil
     end
 
     it 'should return global game stats with proper schema' do
-      Steam::UserStats.game_schema(440)
-        .should have_key('gameName')
+      expect(Steam::UserStats.game_schema(440))
+        .to have_key('gameName')
     end
 
     it 'should return global game stats with proper schema' do
-      Steam::UserStats.game_schema(440)
-        .should have_key('gameName')
+      expect(Steam::UserStats.game_schema(440))
+        .to have_key('gameName')
     end
 
     it 'should return global game stats with proper schema' do
-      Steam::UserStats.game_schema(440)
-        .should have_key('gameVersion')
+      expect(Steam::UserStats.game_schema(440))
+        .to have_key('gameVersion')
     end
 
     it 'should return global game stats with proper schema' do
-      Steam::UserStats.game_schema(440)
-        .should have_key('availableGameStats')
+      expect(Steam::UserStats.game_schema(440))
+        .to have_key('availableGameStats')
     end
   end
 
   describe '.global_for_game' do
     it 'should return global game stats' do
-      Steam::UserStats.global_for_game(201830,
+      expect(Steam::UserStats.global_for_game(201830,
                                        params: { 'name[0]' => 'totalDeaths',
-                                                 count: 10 })
+                                                 count: 10 }))
     end
   end
 
   describe '.player_count' do
     it 'should return a player count' do
-      Steam::UserStats.player_count(440)
-        .should be_a(Fixnum)
+      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)
+    end
+
     it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)
-        .should have_key('achievements')
+      expect(@achs)
+        .to have_key('achievements')
     end
 
     it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)
-        .should have_key('gameName')
+      expect(@achs)
+        .to have_key('gameName')
     end
 
     it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)['gameName']
-        .should == 'Team Fortress 2'
+      expect(@achs['gameName'])
+        .to eq('Team Fortress 2')
     end
 
     it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)
-        .should have_key('steamID')
+      expect(Steam::UserStats.player_achievements(440, 76561197969622382))
+        .to have_key('steamID')
     end
 
     it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)['steamID']
-        .should == '76561197969622382'
+      expect(Steam::UserStats.player_achievements(440, 76561197969622382)['steamID'])
+        .to eq('76561197969622382')
     end
   end
 end

data/spec/steam/users_spec.rb

@@ -9,82 +9,81 @@ describe Steam::User do
   describe '.friends' do
     it 'should allow users to check a friends for a user' do
       response = Steam::User.friends(@playerid)
-      response.should_not be_nil
+      expect(response).to_not be_nil
     end
 
     it 'should allow users to check a friends for a user' do
-      Steam::User.friends(@playerid)
-        .map { |friend| friend.first.last }
-        .should include(@playerid2.to_s)
+      expect(Steam::User.friends(@playerid).map { |friend| friend.first.last })
+        .to include(@playerid2.to_s)
     end
 
     it 'should return an error on a bad friend id' do
-      lambda { Steam::User.friends('765611') }
-        .should raise_error
+      expect(lambda { Steam::User.friends('765611') })
+        .to raise_error
     end
 
     it 'should return  the same content for :friends and :all' do
-      Steam::User.friends(@playerid2, relationship: :friend)
-        .should == Steam::User.friends(@playerid2, relationship: :all)
+      expect(Steam::User.friends(@playerid2, relationship: :friend))
+        .to eq(Steam::User.friends(@playerid2, relationship: :all))
     end
 
     it 'should return an error on a bad friend id' do
-      lambda { Steam::User.friends(@playerid2, relationship: :sadsad) }
-        .should raise_error(Steam::JSONError)
+      expect(lambda { 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
-      Steam::User.bans(@playerid)
-        .should_not be_nil
+      expect(Steam::User.bans(@playerid))
+        .to_not be_nil
     end
 
     it 'should return a blank list for bad ids' do
-      Steam::User.bans(7993276293)
-        .should == { 'players' => [] }
+      expect(Steam::User.bans(7993276293))
+        .to eq({ 'players' => [] })
     end
 
     it 'should allow users to check a bans for multiple steamids' do
-      Steam::User.bans([@player, @player2])
-        .should_not be_nil
+      expect(Steam::User.bans([@player, @player2]))
+        .to_not be_nil
     end
   end
 
   describe '.summary' do
     it 'should allow users to get a summary for a user' do
-      Steam::User.summary(@playerid)
-        .should_not be_nil
+      expect(Steam::User.summary(@playerid))
+        .to_not be_nil
     end
 
     it 'should allow users to check summaries for multiple accounts' do
-      Steam::User.summaries([@player, @player2])
-        .should_not be_nil
+      expect(Steam::User.summaries([@player, @player2]))
+        .to_not be_nil
     end
   end
 
   describe '.vanity_to_steamid' do
     it 'should return values when they look up vanity urls' do
-      Steam::User.vanity_to_steamid('asmeroth')
-        .should_not be_nil
+      expect(Steam::User.vanity_to_steamid('asmeroth'))
+        .to_not be_nil
     end
 
     it 'should return the correct id when users look up vanity urls' do
-      Steam::User.vanity_to_steamid('asmeroth')
-        .should == @playerid.to_s
+      expect(Steam::User.vanity_to_steamid('asmeroth'))
+        .to eq(@playerid.to_s)
     end
   end
 
   describe '.groups' do
     it 'should allow users to look groups a player is a member of' do
-      Steam::User.groups(@playerid)
-        .should_not be_nil
+      expect(Steam::User.groups(@playerid))
+        .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)
-      response.map { |g| g.values.first }
-        .should include '3640974'
+      expect(response.map { |g| g.values.first })
+        .to include '3640974'
     end
   end
 end

data/spec/steam_spec.rb

@@ -10,19 +10,29 @@ describe Steam do
   end
 
   it 'should return a Steam API key if one is defined' do
-    Steam.apikey.should_not be_nil
+    expect(Steam.apikey).to_not be_nil
   end
 
   it 'should return an error if the Steam Key is missing' do
     Steam.apikey = nil
-    lambda { Steam.apikey }
-      .should raise_error(ArgumentError, /Please set your Steam API key/)
+    ENV['STEAM_API_KEY'] = nil
+    expect(lambda { 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'
-    Steam.apikey.should_not == old
-    Steam.apikey.should == '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)
   end
 end

data/steam-api.gemspec

@@ -11,17 +11,17 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Simple Steam Gem}
   gem.summary       = %q{Simple Gem to interact witht the Steam Web API}
   gem.homepage      = 'https://github.com/bhaberer/steam-api'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'coveralls'
-
-  gem.add_dependency    'faraday', '0.9.0'
-  gem.add_dependency    'multi_json', '>= 1.7.7'
-  gem.add_dependency    'json', '>= 1.7.7'
+  gem.add_development_dependency 'rake', '~> 10'
+  gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'coveralls', '~> 0.7'
+  gem.add_dependency 'faraday', '0.9.0'
+  gem.add_dependency 'multi_json', '~> 1.7', '>= 1.7.7'
+  gem.add_dependency 'json', '~> 1.7', '>= 1.7.7'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: steam-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Brian Haberer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,9 @@ dependencies:
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
@@ -77,6 +80,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
@@ -84,6 +90,9 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
@@ -91,6 +100,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
@@ -133,7 +145,8 @@ files:
 - spec/steam_spec.rb
 - steam-api.gemspec
 homepage: https://github.com/bhaberer/steam-api
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []