steam-api 1.0.0 → 1.2.0

data/spec/steam/store_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+
+describe Steam::Store do
+  let(:appid) { 976730 }
+
+  describe '.app_details' do
+    let (:result) { Steam::Store.app_details(appid) }
+    
+    it 'returns the details of an application' do
+      expect(result).to_not be_nil
+    end
+
+    it 'returns a JSON structure containing details of the returned app' do
+      expect(result).to include("976730")
+    end
+  end
+end

data/spec/steam/users-stats_spec.rb

@@ -2,84 +2,95 @@ 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
+    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)
-      achs.first.should have_key('name')
-      achs.first.should 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
-      Steam::UserStats.game_schema(440)
-        .should_not be_nil
-    end
+    let(:result) { Steam::UserStats.game_schema(440) }
 
-    it 'should return global game stats with proper schema' do
-      Steam::UserStats.game_schema(440)
-        .should 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
-      Steam::UserStats.game_schema(440)
-        .should 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
-      Steam::UserStats.game_schema(440)
-        .should 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
-      Steam::UserStats.game_schema(440)
-        .should 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
-      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
-      Steam::UserStats.player_count(440)
-        .should be_a(Fixnum)
+    it 'returns a player count' do
+      expect(Steam::UserStats.player_count(440)).to be_a(Integer)
     end
   end
 
   describe '.get_player_achievements' do
-    it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)
-        .should have_key('achievements')
+    let(:achs) { Steam::UserStats.player_achievements(440, 76561197993276293) }
+
+    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 'returns a steamID' do
+      expect(achs).to have_key('steamID')
+    end
+
+    it 'returns the correct steamID' do
+      expect(achs['steamID']).to eq('76561197993276293')
+    end
+  end
+
+  describe '.player_stats' do
+    let(:stats) { Steam::UserStats.player_stats(440, 76561197993276293) }
+
+    it 'returns player stats' do
+      expect(stats).to have_key('stats')
     end
 
-    it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)
-        .should have_key('gameName')
+    it 'returns a gameName' do
+      expect(stats).to have_key('gameName')
     end
 
-    it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)['gameName']
-        .should == 'Team Fortress 2'
+    it 'returns the correct gameName' do
+      expect(stats['gameName']).to eq('Team Fortress 2')
     end
 
-    it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)
-        .should have_key('steamID')
+    it 'returns a steamID' do
+      expect(stats).to have_key('steamID')
     end
 
-    it 'should return player achievements' do
-      Steam::UserStats.player_achievements(440, 76561197969622382)['steamID']
-        .should == '76561197969622382'
+    it 'returns a correct steamID' do
+      expect(stats['steamID']).to eq('76561197993276293')
     end
   end
 end

data/spec/steam/users_spec.rb

@@ -1,86 +1,80 @@
 require 'spec_helper'
 
 describe Steam::User do
+  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(76561197993276293)
-      response.should_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
-      Steam::User.friends(76561197993276293)
-        .map {|f| f.first.last }
-        .should include('76561197969622382')
+    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
-      lambda { Steam::User.friends('765611') }
-        .should raise_error
+    it 'raises an error on a bad friend id' do
+      expect { Steam::User.friends('765611') }.to raise_error(Steam::JSONError)
     end
 
-    it 'should return  the same content for :friends and :all' do
-      Steam::User.friends('76561197969622382', relationship: :friend)
-        .should == Steam::User.friends('76561197969622382', 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
-      lambda { Steam::User.friends('76561197969622382', relationship: :sadsad) }
-        .should 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
-      Steam::User.bans(76561197993276293)
-        .should_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
-      Steam::User.bans(7993276293)
-        .should == { '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
-      Steam::User.bans([76561197993276293, 76561197966796383])
-        .should_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
-      Steam::User.summary(76561197993276293)
-        .should_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
-      Steam::User.summaries([76561197993276293, 76561197966796383])
-        .should_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
-      Steam::User.vanity_to_steamid('asmeroth')
-        .should_not be_nil
+    let(:result) { Steam::User.vanity_to_steamid('theasmer') }
+
+    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
-      Steam::User.vanity_to_steamid('asmeroth')
-        .should == '76561197993276293'
+    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
-      Steam::User.groups(76561197993276293)
-        .should_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(76561197993276293)
-      response.map { |g| g.values.first }
-        .should 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,33 +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
-    Steam.apikey.should_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
-    lambda { Steam.apikey }
-      .should 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'
-    Steam.apikey.should_not == old
-    Steam.apikey.should == '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 update the ENV variable if set' do
-    Steam.apikey = 'test'
-    ENV['STEAM_API_KEY'].should == 'test'
+    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

data/steam-api.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'steam-api/version'
 
@@ -8,23 +7,19 @@ Gem::Specification.new do |gem|
   gem.version       = Steam::VERSION
   gem.authors       = ['Brian Haberer']
   gem.email         = ['bhaberer@gmail.com']
-  gem.description   = %q{Simple Steam Gem}
-  gem.summary       = %q{Simple Gem to interact witht the Steam Web API}
+  gem.description   = 'Simple Steam Gem'
+  gem.summary       = 'Simple Gem to interact with 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.files         = `git ls-files`.split($RS)
+  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.required_ruby_version = '>= 2.0.0'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rspec', '~> 3.9'
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'coveralls'
-
-  gem.add_dependency    'weary',        '1.1.3'
-  gem.add_dependency    'faraday'
-  gem.add_dependency    'multi_json',   '1.7.7'
-  gem.add_dependency    'json',         '~> 1.7.7'
+  gem.add_dependency 'faraday', '~> 1.0'
 end

metadata

@@ -1,113 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: steam-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Brian Haberer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: weary
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !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.7
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '1.0'
 description: Simple Steam Gem
 email:
 - bhaberer@gmail.com
@@ -115,8 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,6 +92,7 @@ files:
 - lib/steam-api/steam/news.rb
 - lib/steam-api/steam/player.rb
 - lib/steam-api/steam/remote_storage.rb
+- lib/steam-api/steam/store.rb
 - lib/steam-api/steam/user.rb
 - lib/steam-api/steam/user_stats.rb
 - lib/steam-api/version.rb
@@ -142,12 +102,14 @@ files:
 - spec/steam/news_spec.rb
 - spec/steam/player_spec.rb
 - spec/steam/remote-storage_spec.rb
+- spec/steam/store_spec.rb
 - spec/steam/users-stats_spec.rb
 - spec/steam/users_spec.rb
 - spec/steam_spec.rb
 - steam-api.gemspec
 homepage: https://github.com/bhaberer/steam-api
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -155,20 +117,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Simple Gem to interact witht the Steam Web API
+summary: Simple Gem to interact with the Steam Web API
 test_files:
 - spec/spec_helper.rb
 - spec/steam/apps_spec.rb
@@ -176,7 +138,7 @@ test_files:
 - spec/steam/news_spec.rb
 - spec/steam/player_spec.rb
 - spec/steam/remote-storage_spec.rb
+- spec/steam/store_spec.rb
 - spec/steam/users-stats_spec.rb
 - spec/steam/users_spec.rb
 - spec/steam_spec.rb
-has_rdoc: