stew 0.5.3 → 0.6.0

data/spec/fixtures/profiles/games/76561197994486912.json

@@ -0,0 +1,5 @@
+{
+  "response": {
+    "game_count": 0
+  }
+}

data/spec/fixtures/profiles/vanity/Phucked.json

@@ -0,0 +1,6 @@
+{
+  "response": {
+    "steamid": "76561198013177911",
+    "success": 1
+  }
+}

data/spec/integration/community_web_api_integration_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "Community Access through the Web API", :vcr do
+  describe "Creation of a steam profile with data" do
+    subject{Stew::Community::SteamId.new(76561197992917668)}
+
+    describe "profile" do
+      it "sets the nickname" do
+        subject.profile.nickname.should eq 'MrCheese'
+      end
+    end
+
+    describe "games" do
+      it "creates games" do
+        subject.games.collect(&:name).include?('Shank').should be_true
+        subject.games.collect(&:app_id).include?(17460).should be_true
+      end
+    end
+
+    describe "friends" do
+      it "creates friends" do
+        subject.friends.collect(&:id).include?(76561197972211787).should be_true
+      end
+    end
+  end
+
+  describe "Attempted creation of a non-existing Steam ID" do
+    it "raises a Stew::XmlClient::ObjectNotFoundError" do
+      expect{Stew::Community::SteamId.new("www.google.com/nisse")}.to raise_error(Stew::Community::SteamIdNotFoundError)
+    end
+  end
+end

data/spec/lib/stew/community/profile_friends_spec.rb

@@ -2,37 +2,16 @@ require 'spec_helper'
 
 describe "Stew::Community::ProfileFriends" do
   let(:id){76561197992917668}
-  let(:response){YAML.load_file('spec/fixtures/profiles/friends/76561197992917668.yml')['friendsList']['friends']['friend']}
+  let(:response){JSON.parse(IO.read('spec/fixtures/profiles/friends/76561197992917668.json'))['friendslist']['friends']}
 
   let(:subject){Stew::Community::ProfileFriends.new(response)}
 
   describe ".entries" do
     it "sets the friends" do
       response.each do |friend|
-        Stew::Community::SteamId.should_receive(:new).with(friend)
+        Stew::Community::SteamId.should_receive(:new).with(friend['steamid'])
       end
-      subject.entries.count.should eq 30
+      subject.entries.count.should eq 32
     end
   end
-
-  describe ".each" do
-    let(:subject){Stew::Community::ProfileFriends.new(response)}
-
-    it "invokes the given block for each object returned by the friends method" do
-      friend1 = double(:name => 'Half-Life 2')
-      friend2 = double(:name => 'Shank')
-      friends = [friend1,friend2]
-
-      friend1.should_receive(:name)
-      friend2.should_receive(:name)
-      subject.instance_eval do
-        @friends = friends
-      end
-
-      subject.each do |friend|
-        friend.name
-      end
-    end
-  end
-
 end

data/spec/lib/stew/community/profile_game_spec.rb

@@ -1,37 +1,45 @@
 require 'spec_helper'
 
 describe "Stew::Community::ProfileGame" do
-  let(:response){YAML.load_file('spec/fixtures/profiles/games/76561197992917668.yml')}
+  let(:response){JSON.parse(IO.read('spec/fixtures/profiles/games/76561197992917668.json'))}
   let(:subject){Stew::Community::ProfileGames.new(76561197992917668)}
 
   describe ".initialize" do
     before :each do
-      data = YAML.load_file('spec/fixtures/profiles/games/76561197992917668.yml')
-      @profile_game = Stew::Community::ProfileGame.new(data['gamesList']['games']['game'].first)
+      data = JSON.parse(IO.read('spec/fixtures/profiles/games/76561197992917668.json'))
+      @profile_game = Stew::Community::ProfileGame.new(data['response']['games'].first)
     end
 
     it "sets the app id" do
-      @profile_game.app_id.should eq 211420
+      @profile_game.app_id.should eq 17460
     end
 
     it "sets the name" do
-      @profile_game.name.should eq "Dark Souls: Prepare to Die Edition"
+      @profile_game.name.should eq "Mass Effect"
     end
 
     it "sets the logo url" do
-      @profile_game.logo.should eq "http://media.steampowered.com/steamcommunity/public/images/apps/211420/d293c8e38f56de2c7097b2c7a975caca49029a8b.jpg"
+      @profile_game.logo.should eq "http://media.steampowered.com/steamcommunity/public/images/apps/17460/7501ea5009533fa5c017ec1f4b94725d67ad4936.jpg"
     end
 
-    it "sets the store link" do
-      @profile_game.store_link.should eq "http://steamcommunity.com/app/211420"
+    it "sets the icon url" do
+      @profile_game.icon.should eq "http://media.steampowered.com/steamcommunity/public/images/apps/17460/57be81f70afa48c65437df93d75ba167a29687bc.jpg"
     end
 
-    it "sets the hours_last_2_weeks" do
-      @profile_game.hours_last_2_weeks.should eq 16.9
+    it "sets the store url" do
+      @profile_game.store_url.should eq "http://store.steampowered.com/app/17460"
     end
 
-    it "sets the hours_on_record" do
-      @profile_game.hours_on_record.should eq 16.9
+    it "sets the community url" do
+      @profile_game.community_url.should eq "http://steamcommunity.com/app/17460"
+    end
+
+    it "sets the playertime_2weeks" do
+      @profile_game.playtime_2weeks.should eq 0
+    end
+
+    it "sets the playertime_forever" do
+      @profile_game.playtime_forever.should eq 3173
     end
   end
 end

data/spec/lib/stew/community/profile_games_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Stew::Community::ProfileGames" do
   let(:id){76561197992917668}
-  let(:response){YAML.load_file('spec/fixtures/profiles/games/76561197992917668.yml')['gamesList']['games']['game']}
+  let(:response){JSON.parse(IO.read('spec/fixtures/profiles/games/76561197992917668.json'))['response']['games']}
 
   let(:subject){Stew::Community::ProfileGames.new(response)}
 
@@ -11,7 +11,7 @@ describe "Stew::Community::ProfileGames" do
       response.each do |game|
         Stew::Community::ProfileGame.should_receive(:new).with(game)
       end
-      subject.entries.count.should eq 102
+      subject.entries.count.should eq 106
     end
   end
 
@@ -32,5 +32,4 @@ describe "Stew::Community::ProfileGames" do
       end
     end
   end
-
 end

data/spec/lib/stew/community/profile_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 
 describe "Stew::Community::Profile" do
   let(:id){76561197992917668}
-  let(:response){YAML.load_file('spec/fixtures/profiles/76561197992917668.yml')['profile']}
+  let(:response){YAML.load_file('spec/fixtures/profiles/76561197992917668.json')['response']['players'].first}
   
   subject{Stew::Community::Profile.new(response)}
 
   describe "attributes" do
     it "sets the id" do
-     subject.id.should eq id
+      subject.id.should eq id
     end
 
     it "sets the nickname" do

data/spec/lib/stew/community/steam_id_resolver_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Stew::Community::SteamIdResolver do
+  let(:client){double}
+  subject{Stew::Community::SteamIdResolver.new(client)}
+
+  describe ".initialize" do
+    context "when given a client" do
+      let(:client){double}
+
+      it "sets the client" do
+        Stew::Community::SteamIdResolver.new(client).client.should eq client
+      end
+    end
+
+    context "with no client given" do
+      it "creates a new default client" do
+        Stew::Community::WebApiClient.should_receive(:new)
+        Stew::Community::SteamIdResolver.new
+      end
+    end
+  end
+
+  describe ".steam_id" do
+    context "when the given data is a number" do
+      let(:data){"12345"}
+      let(:expected_steam_id){12345}
+
+      it "returns the number" do
+        subject.steam_id(data).should eq expected_steam_id
+      end
+    end
+
+    context "when the given data is a vanity name" do
+      let(:data){'foobar20'}
+      let(:expected_steam_id){12345}
+
+      it "resolves the vanity name and sets the id" do
+        client.should_receive(:vanity_url_to_steam_id).with(data).and_return(expected_steam_id)
+        subject.steam_id(data).should eq expected_steam_id
+      end
+    end
+
+    context "when the given data is a vanity url" do
+      let(:data){'steamcommunity.com/id/foobar20'}
+      let(:expected_steam_id){12345}
+
+      it "resolves the vanity url and sets the id" do
+        client.should_receive(:vanity_url_to_steam_id).with(data).and_return(expected_steam_id)
+        subject.steam_id(data).should eq expected_steam_id
+      end
+    end
+
+    context "when the given data is a steamcommunity url" do
+      let(:data){'steamcommunity.com/profiles/12345'}
+      let(:expected_steam_id){12345}
+
+      it "extracts the id from the url and sets the id" do
+        subject.steam_id(data).should eq expected_steam_id
+      end
+    end
+
+    context "when the given data is a steamcommunity url with extra at the end" do
+      let(:data){'steamcommunity.com/profiles/12345/friends'}
+      let(:expected_steam_id){12345}
+
+      it "extracts the id from the url and sets the id" do
+        subject.steam_id(data).should eq expected_steam_id
+      end
+    end
+
+    context "when no steam id can be found or resolved from the string" do
+      let(:data){'foobar'}
+      let(:expected_steam_id){12345}
+
+      it "raises a Stew::Community::SteamIdNotFoundError" do
+        client.should_receive(:vanity_url_to_steam_id).with(data).and_return(nil)
+        expect{subject.steam_id(data)}.to raise_error(Stew::Community::SteamIdNotFoundError)
+      end
+    end
+  end
+end

data/spec/lib/stew/community/steam_id_spec.rb

@@ -2,113 +2,52 @@ require 'spec_helper'
 
 describe "Stew::Community::SteamId" do
   let(:id){76561197992917668}
-  let(:community_client){double('community_client')}
+  let(:steam_id){12345}
+  let(:client){double('client')}
+  let(:resolver){double}
 
-  subject{Stew::Community::SteamId.new(id,{:client => community_client})}
+  subject{Stew::Community::SteamId.new(id, client: client)}
 
-  describe "#create" do
-    context "when the parameter is an integer" do
-      it "creates a steam_id with the given integer as id" do
-        Stew::Community::SteamId.create(id).id.should eq id
-      end
-    end
-
-    context "when the parameter is a steamcommunity url" do
-      let(:url){"http://steamcommunity.com/profiles/#{id}"}
-
-      it "creates a steam_id with the id in the given string as id" do
-        Stew::Community::SteamId.create(url).id.should eq id
-      end
-    end
-
-    context "when the parameter is a vanity url" do
-      let(:name){"somename"}
-      let(:url){"http://steamcommunity.com/id/#{name}"}
-
-      it "creates a steamid with the vanity name as first parameter" do
-        Stew::Community::SteamId.should_receive(:new).with(name)
-        Stew::Community::SteamId.create(url)
-      end
-    end
-
-    context "when the parameter is a vanity name" do
-      let(:name){"somename"}
-
-      it "creates a steamid with the vanity name as first parameter" do
-        Stew::Community::SteamId.should_receive(:new).with(name)
-        Stew::Community::SteamId.create(name)
-
-      end
-    end
-
-    context "when the parameter is a url that cannot be matched" do
-      it "raises a SteamIdNotFound error" do
-        expect{Stew::Community::SteamId.create('sdfsdf/dsfsdf/com')}.to raise_error(Stew::Community::SteamIdNotFoundError)
-      end
-    end
+  before :each do
+    Stew::Community::SteamIdResolver.stub(:new).and_return(resolver)
+    resolver.stub(:steam_id) {id}
   end
 
   describe ".initialize" do
-
-    context "when the id is a number" do
-      it "sets the id" do
-        subject.id.should eq id
-      end
-
-      it "should create a community client with no options" do
-        Stew::Community::CommunityClient.should_receive(:new).with()
-        Stew::Community::SteamId.new(id)
-      end
-    end
-
-    context "when the id is a vanity name" do
-      let(:id){"foobar20"}
-
-      it "sets the id" do
-        subject.id.should eq id
-      end
-
-      it "should create a community client with the base_path option set to 'id'" do
-        Stew::Community::CommunityClient.should_receive(:new).with({:base_path => 'id'})
-        Stew::Community::SteamId.new(id)
-      end
+    it "uses an instance of SteamIdResolver to get the id" do
+      resolver.should_receive(:steam_id).with(id).and_return(id)
+      subject.id.should eq id
     end
   end
 
   describe ".profile" do
-    it "calls profile on the community_client" do
-      community_client.should_receive(:profile).with(id)
-      subject.profile
-    end
+    let(:data){double}
 
-    it "only calls profile on the community_client once" do
-      community_client.should_receive(:profile).with(id).once.and_return(double('profile'))
+    it "returns a steam profile from the data received from the community client" do
+      client.should_receive(:profile).with(id).once.and_return(data)
+      Stew::Community::Profile.should_receive(:new).with(data).once.and_return(double)
       subject.profile
       subject.profile
     end
   end
 
   describe ".games" do
-    it "calls profile_games on the community_client" do
-      community_client.should_receive(:profile_games).with(id)
-      subject.games
-    end
+    let(:data){double}
 
-    it "only calls games on the community_client once" do
-      community_client.should_receive(:profile_games).with(id).once.and_return(double('profile_games'))
+    it "returns the games from the data received from the community client" do
+      client.should_receive(:profile_games).with(id).once.and_return(data)
+      Stew::Community::ProfileGames.should_receive(:new).with(data).once.and_return(double)
       subject.games
       subject.games
     end
   end
 
   describe ".friends" do
-    it "calls profile_friends on the community_client" do
-      community_client.should_receive(:profile_friends).with(id)
-      subject.friends
-    end
+    let(:data){double}
 
-    it "only calls friends on the community_client once" do
-      community_client.should_receive(:profile_friends).with(id).once.and_return(double('profile_friends'))
+    it "returns the friends from the data received from the community client" do
+      client.should_receive(:profile_friends).with(id).once.and_return(data)
+      Stew::Community::ProfileFriends.should_receive(:new).with(data).once.and_return(double)
       subject.friends
       subject.friends
     end

data/spec/lib/stew/community/web_api_client_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe "Stew::Community::WebApiClient" do
+  let(:client){double('xml_client')}
+  let(:response){JSON.parse(IO.read("spec/fixtures/profiles/#{steam_id}.json"))}
+  let(:steam_id){76561197992917668}
+  subject{Stew::Community::WebApiClient.new(client)}
+
+
+  describe ".vanity_url_to_steam_id" do
+    let(:response){JSON.parse(IO.read("spec/fixtures/profiles/vanity/#{vanity_name}.json"))}
+
+    context "when given a name" do
+      let(:vanity_name){'Phucked'}
+
+      it "sends the 'get' message to its client with the correct parameters" do
+        expected_argument = "/ISteamUser/ResolveVanityURL/v0001/?key=#{STEAM_API_KEY}&vanityurl=#{vanity_name}"
+        client.should_receive(:get).with(expected_argument).and_return(response)
+        subject.vanity_url_to_steam_id(vanity_name).should eq 76561198013177911
+      end
+    end
+
+    context "when given a url" do
+      let(:vanity_name){'Phucked'}
+      let(:vanity_url){"http://steamcommunity.com/id/#{vanity_name}"}
+
+      it "sends the 'get' message to its client with the correct parameters" do
+        expected_argument = "/ISteamUser/ResolveVanityURL/v0001/?key=#{STEAM_API_KEY}&vanityurl=#{vanity_name}"
+        client.should_receive(:get).with(expected_argument).and_return(response)
+        subject.vanity_url_to_steam_id(vanity_url).should eq 76561198013177911
+      end
+    end
+  end
+
+  describe ".profile" do
+    let(:response){JSON.parse(IO.read("spec/fixtures/profiles/#{steam_id}.json"))}
+    it "sends the 'get' message to its client with the correct parameters" do
+      expected_argument = "/ISteamUser/GetPlayerSummaries/v0002/?key=#{STEAM_API_KEY}&steamids=#{steam_id}"
+      client.should_receive(:get).with(expected_argument).and_return(response)
+      subject.profile(steam_id)['steamid'].to_i.should eq steam_id
+    end
+  end
+
+  describe ".profile_games" do
+    let(:response){JSON.parse(IO.read("spec/fixtures/profiles/games/#{steam_id}.json"))}
+    it "sends the 'get' message to its client with the correct parameters" do
+      expected_argument = "/IPlayerService/GetOwnedGames/v0001/?key=#{STEAM_API_KEY}&steamid=#{steam_id}&include_appinfo=1"
+      client.should_receive(:get).with(expected_argument).and_return(response)
+      subject.profile_games(steam_id).count.should eq 106
+    end
+  end
+
+  describe ".profile_friends" do
+    let(:response){JSON.parse(IO.read("spec/fixtures/profiles/friends/#{steam_id}.json"))}
+    it "sends the 'get' message to its client with the correct parameters" do
+      expected_argument = "/ISteamUser/GetFriendList/v0001/?key=#{STEAM_API_KEY}&steamid=#{steam_id}&relationship=friend"
+      client.should_receive(:get).with(expected_argument).and_return(response)
+      subject.profile_friends(steam_id).count.should eq 32
+    end
+  end
+end