steam_web_api 0.0.1

data/spec/steam_web_api/game_spec.rb

@@ -0,0 +1,137 @@
+require "spec_helper"
+
+RSpec.describe SteamWebApi::Game do
+
+	let(:game) { SteamWebApi::Game.new(8930) }
+	let(:non_existing_game) { SteamWebApi::Game.new('non-existing') }
+
+	before do
+	  SteamWebApi.configure do |config|
+	  	config.api_key = ENV['STEAM_WEB_API_KEY']
+	  end
+	end
+  
+	describe '.all' do
+
+		before do
+			# this is a huge list, so just stub and not use vcr
+		  stub_request(:get, 'http://api.steampowered.com/ISteamApps/GetAppList/v0002/')
+		  	.to_return(body: '
+		  		{
+		  			"applist": {
+		  				"apps": [
+		  					{
+		  						"appid": 5,
+		  						"name": "Dedicated Server"
+		  					},
+		  					{
+		  						"appid": 7,
+		  						"name": "Steam Client"
+		  					},
+		  					{
+		  						"appid": 8,
+		  						"name": "winui2"
+		  					}
+		  				]
+		  			}
+		  		}
+		  	')
+		end
+	  
+		it 'return lists of all games on Steam' do
+			data = SteamWebApi::Game.all
+			expect(data.success).to be true
+			expect(data.games.size).to eq 3
+		end
+
+	end
+
+	describe '#schema' do
+	  
+		it 'returns game schema' do
+		  VCR.use_cassette('game_schema') do
+		  	schema = game.schema
+		  	expect(schema.name).to eq 'ValveTestApp8930'
+		  	expect(schema.version).to eq '108'
+		  	expect(schema.achievements.first).to eq(
+		  			{ 
+		  				"name" => "ACHIEVEMENT_WIN_WASHINGTON",
+							"defaultvalue" => 0,
+							"displayName" => "First in the Hearts of Your Countrymen",
+							"hidden" => 0,
+							"description" => "Beat the game on any difficulty setting as Washington.",
+							"icon" => "http://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/8930/4cf17a59d70b2decfd4369de8a7429e7b00f5ab8.jpg",
+							"icongray" => "http://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/8930/2ce109f9be6cb3193a385444b9b0b0ffcc7b2219.jpg"
+		  			}
+		  		)
+		  	expect(schema.stats.first).to eq(
+		  		{
+		  			"name" => "ESTEAMSTAT_TOTAL_WINS",
+						"defaultvalue" => 0,
+						"displayName" => "Total Games Won."
+		  		}
+		  	) 
+		  	expect(schema.success).to be true
+		  end
+		end
+
+	end
+
+	describe '#achievement_percentages' do
+
+		context 'when the response is successful' do
+		 	
+			it 'returns list of achievements with global percentage stats' do
+			  VCR.use_cassette('game_achievement_percentages') do
+			  	data = game.achievement_percentages
+			  	expect(data.achievements.first['name']).to eq 'ACHIEVEMENT_ANCIENT_RUIN'
+			  	expect(data.achievements.first['percent']).to eq 76.74992370605469
+			  	expect(data.success).to be true 
+			  end
+			end
+
+		end
+	  
+	  context 'when the response is not successful' do
+	    
+	  	it 'returns object with attribute success equals false and empty list' do
+	  	  VCR.use_cassette('game_achievement_percentages_error') do
+	  	  	data = non_existing_game.achievement_percentages
+	  	  	expect(data.success).to be false
+	  	  end
+	  	end
+
+	  end
+		
+
+	end
+
+	describe '#news' do
+	  
+		context 'when response is successful' do
+		  
+			it 'returns list of news' do
+			  VCR.use_cassette('game_news_success') do
+			  	data = game.news(count: 4)
+			  	expect(data.news_items.size).to eq 4
+			  	expect(data.app_id).to eq 8930
+			  	expect(data.success).to be true   
+			  end
+			end
+
+		end
+
+		context 'when response is not successful' do
+		  
+			it 'returns object with attribute success equals false and empty list' do
+			  VCR.use_cassette('game_news_error') do
+			  	data = non_existing_game.news
+			  	expect(data.success).to be false
+			  end
+			end
+
+		end
+
+	end
+
+end

data/spec/steam_web_api/player_spec.rb

@@ -0,0 +1,362 @@
+require "spec_helper"
+
+RSpec.describe SteamWebApi::Player do
+
+	let(:player) { SteamWebApi::Player.new('76561198046174695') }
+	let(:player_2) { SteamWebApi::Player.new('76561197960435530') }
+	let(:player_non_existing) { SteamWebApi::Player.new('aaa') }
+
+	before do
+	  SteamWebApi.configure do |config|
+	  	config.api_key = ENV['STEAM_WEB_API_KEY']
+	  end
+	end
+
+	describe '#owned_games' do
+		
+		it 'returns list of games for player' do
+			VCR.use_cassette('player_owned_games') do
+			  player_data = player.owned_games
+			  expect(player_data.count).to eq 45
+			  expect(player_data.games.first['appid']).to eq 4760 
+			  expect(player_data.games.last['playtime_forever']).to eq 0 
+			end
+		end
+
+		context 'when include_appinfo config attribute was set to true' do
+
+			it 'returns additional info about game' do
+				VCR.use_cassette('player_owned_games_appinfo') do
+					player_data = player.owned_games(include_appinfo: true)
+					game = player_data.games[3]
+					expect(game['name']).to eq 'Napoleon: Total War'
+					expect(game['img_icon_url']).to eq 'e6263fa77b39b3b83db00d089aed8dc0aac11b20'
+					expect(game['img_logo_url']).to eq 'eca670df2bb35587996bfb4da6a45a8985ace139'
+					expect(game['has_community_visible_stats']).to be true
+				end  	  
+			end
+
+		end
+
+	end
+
+	describe '#stats_for_game' do
+
+		context 'when game has stats' do
+			
+			it 'returns player stats for a game' do
+				VCR.use_cassette('stats_for_game') do
+					data = player.stats_for_game(8930)
+					expect(data.steam_id).to eq '76561198046174695'
+					expect(data.game_name).to eq 'ValveTestApp8930' 		
+					expect(data.achievements.length).to eq 151	
+					expect(data.stats.length).to eq 134
+					expect(data.success).to be true	
+				end
+			end
+
+		end
+
+		context 'when game does not have stats' do
+
+			it 'returns object with success attribute set to false' do
+				VCR.use_cassette('stats_for_game_empty') do
+			  	data = player.stats_for_game(4760)
+			  	expect(data.success).to be false 
+				end
+			end
+
+		end
+	  
+
+	end
+
+	describe '#achievements' do
+
+		context 'when game has stats' do
+
+			it 'returns list of player achievements for game' do
+				VCR.use_cassette('player_achievements') do
+				  data = player.achievements(232050)
+				  expect(data.steam_id).to eq '76561198046174695'
+				  expect(data.game_name).to eq 'Eador. Masters of the Broken World'
+				  expect(data.achievements.size).to eq 55
+				  expect(data.success).to be true 
+				end
+			end
+		  
+		end
+
+		context 'when game does not have stats' do
+
+			it 'returns object with success attribute set to false' do
+				VCR.use_cassette('player_achievements_empty') do
+			  	data = player.achievements(4760)
+			  	expect(data.success).to eq false 
+				end
+			end
+
+		end
+	  
+
+	end
+
+	describe '.summary' do
+	  
+		context 'when response is successful' do
+		  
+			it 'returns profile information for players' do
+				VCR.use_cassette('player_summary') do
+					data = SteamWebApi::Player.summary(player.steam_id, player_2.steam_id)
+					first_player = data.players.first
+					second_player = data.players[1]
+					expect(first_player['steamid']).to eq '76561198046174695'
+					expect(first_player['personaname']).to eq 'gravin79'
+					expect(first_player['realname']).to eq 'GTomasz'     
+					expect(second_player['steamid']).to eq '76561197960435530'
+					expect(second_player['realname']).to eq 'Robin Walker'
+					expect(second_player['personaname']).to eq 'Robin'
+				end		  
+			end
+
+		end
+
+		context 'when response is not successful' do
+
+			before do
+			  SteamWebApi.configure do |config|
+			  	config.api_key = 'invalid'
+			  end
+			end
+		  
+			it 'returns object with attribute success equals false and empty list' do
+			  VCR.use_cassette('player_summary_error') do
+			  	data = SteamWebApi::Player.summary(player.steam_id, player_2.steam_id)
+			  	expect(data.success).to be false
+			  end
+			end
+
+		end
+
+	end
+
+	describe '#summary' do
+
+		context 'when response is successful' do
+		  
+			it 'returns profile information for single player' do
+				VCR.use_cassette('player_single_summary') do
+					data = player.summary
+					expect(data.profile['steamid']).to eq '76561198046174695'
+					expect(data.profile['personaname']).to eq 'gravin79'
+					expect(data.profile['realname']).to eq 'GTomasz'
+				end  
+			end
+
+		end
+
+		context 'when response is not successful' do
+		  
+			before do
+			  SteamWebApi.configure do |config|
+			  	config.api_key = 'invalid'
+			  end
+			end
+
+			it 'returns object with empty profile hash and attribute success equals false' do
+			  VCR.use_cassette('player_single_summary_error') do
+			  	data = player.summary
+			  	expect(data.success).to be false
+			  end
+			end
+
+		end
+
+	end
+
+	describe '#friends' do
+
+		context 'when response is successful' do
+		  
+			it 'returns list of friends' do
+				VCR.use_cassette('player_friends') do
+					data = player.friends
+					expect(data.success).to be true
+					expect(data.friends).not_to be_empty
+
+					friend = data.friends.first
+					expect(friend['steamid']).to eq '76561197968589933'
+					expect(friend['relationship']).to eq 'friend'
+					expect(friend['friend_since']).to eq 1397319937     
+				end
+			end
+
+		end
+
+		context 'when response is not successful' do
+		  
+			it 'returns empty list of friends and attribute success equals false' do
+			  VCR.use_cassette('player_friends_error') do
+			  	data = player_non_existing.friends
+			  	expect(data.success).to be false
+			  end
+			end
+
+		end
+
+	end
+
+	describe '#recently_played_games' do
+	  
+		context 'when response is successful' do
+		  
+			it 'returns list of recently played games' do
+				VCR.use_cassette('player_recently_played_games') do
+				  data = player.recently_played_games
+				  expect(data.games).not_to be_empty
+				  expect(data.success).to be true
+				  expect(data.total_count).to eq 4
+
+				  game = data.games.first
+				  expect(game['appid']).to eq 208400
+				  expect(game['name']).to eq 'Avernum: Escape From the Pit'
+				  expect(game['playtime_2weeks']).to eq 2485
+				  expect(game['playtime_forever']).to eq 3617
+				  expect(game['img_icon_url']).to eq '6b931adb3c4af3fc2498dacafc3a104f03682d1a'
+				  expect(game['img_logo_url']).to eq '63992c2df9af7a83c8a4a173675af6e7554164ec'    
+				end
+			end
+
+			context 'when count option is given' do
+			  
+				it 'returns limited list of games' do
+					VCR.use_cassette('player_recently_played_games_with_count') do
+						data = player.recently_played_games(2)
+						expect(data.games.size).to eq 2  
+					end
+				end
+
+			end
+
+		end
+
+		context 'when response is not successful' do
+		  
+			it 'returns empty list of games and attribute success equals false' do
+				VCR.use_cassette('player_recently_played_games_error') do
+					data = player_non_existing.recently_played_games
+					expect(data.success).to be false
+				end
+			end
+
+		end
+
+	end
+
+	describe '#playing_shared_game' do
+	  
+		context 'when response is successful' do
+		  
+			it 'returns the original owner\'s SteamID' do
+				VCR.use_cassette('player_playing_shared_game') do
+				  data = player.playing_shared_game(240)
+				  expect(data.lender_steamid).to eq '0'
+				  expect(data.success).to be true 
+				end
+			end
+
+		end
+
+		context 'when response is not successful' do
+		  
+			it 'returns object with success attribute equals false' do
+			  VCR.use_cassette('player_playing_shared_game_error') do
+			  	data = player_non_existing.playing_shared_game(240)
+			  	expect(data.success).to be false
+			  end
+			end
+
+		end
+
+	end
+
+	describe '.bans' do
+	  
+		context 'when response is successful' do
+		  
+			it 'returns info about users bans' do
+				VCR.use_cassette('player_bans') do
+				  data = SteamWebApi::Player.bans(player.steam_id, player_2.steam_id)
+				  expect(data.players.size).to eq 2
+				  expect(data.success).to be true
+
+				  first_player = data.players.first
+				  expect(first_player['SteamId']).to eq '76561198046174695'
+				  expect(first_player['CommunityBanned']).to be false 
+				  expect(first_player['VACBanned']).to be false 
+				  expect(first_player['NumberOfVACBans']).to eq 0 
+				  expect(first_player['DaysSinceLastBan']).to eq 0 
+				  expect(first_player['EconomyBan']).to eq "none" 
+				end
+			end
+
+		end
+
+		context 'when response is not successful' do
+		  
+			before do
+				SteamWebApi.configure do |config|
+					config.api_key = 'invalid'
+				end  
+			end
+
+			it 'returns object with empty players list and attribute success equals false' do
+				VCR.use_cassette('player_bans_error') do
+					data = SteamWebApi::Player.bans(player.steam_id, player_2.steam_id)
+					expect(data.success).to be false
+				end
+			end
+
+		end
+
+	end
+
+	describe '#bans' do
+	  
+		context 'when response is successful' do
+		  
+			it 'returns info ablout single user bans' do
+			  VCR.use_cassette('player_single_bans') do
+			  	data = player.bans
+			  	expect(data.success).to be true
+			  	expect(data.bans['SteamId']).to eq '76561198046174695' 
+			  	expect(data.bans['CommunityBanned']).to be false 
+			  	expect(data.bans['VACBanned']).to be false 
+			  	expect(data.bans['NumberOfVACBans']).to eq 0 
+			  	expect(data.bans['DaysSinceLastBan']).to eq 0 
+			  	expect(data.bans['EconomyBan']).to eq 'none'
+			  end
+			end
+
+		end
+
+		context 'when response is not successful' do
+		  
+			before do
+				SteamWebApi.configure do |config|
+					config.api_key = 'invalid'
+				end  
+			end
+			
+			it 'returns object with empty bans and attribute success equals false' do
+				VCR.use_cassette('player_single_bans_error') do
+					data = player.bans
+					expect(data.success).to be false
+				end
+			end	
+
+		end
+
+	end
+
+end

data/spec/steam_web_api_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+RSpec.describe SteamWebApi do
+
+	describe '.configure' do
+	  
+		it 'sets api key for application' do
+		  SteamWebApi.configure do |config|
+		  	config.api_key = 'some key'
+		  end
+
+		  expect(SteamWebApi.config.api_key).to eq 'some key'
+		end
+
+	end
+
+
+end

data/steam_web_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steam_web_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "steam_web_api"
+  spec.version       = SteamWebApi::VERSION
+  spec.authors       = ["Olga Grabek"]
+  spec.email         = ["olga.grabek@gmail.com"]
+  spec.summary       = %q{This is a gem that makes trivial interacting with the Steam Web API}
+  spec.description   = %q{This is a gem that makes trivial interacting with the Steam Web API}
+  spec.homepage      = "https://github.com/Olgagr/steam-web-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "byebug", "~> 3.5"
+  spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "dotenv", "~> 1.0"
+
+  spec.add_dependency "faraday", "~> 0.9"
+end