stew 0.5.1 → 0.5.2

data/README.md

@@ -56,17 +56,17 @@ steam_id.friends.each {|friend| puts friend.profile.nickname}
 
 ##### From an App id
 ```ruby
-app = Stew::StoreClient.new.create_app(220240)
+app = Stew::Store::StoreClient.new.create_app(220240)
 ```
 
 ##### From a URL
 ```ruby
-app = Stew::StoreClient.new.create_app("http://store.steampowered.com/app/220240/")
+app = Stew::Store::StoreClient.new.create_app("http://store.steampowered.com/app/220240/")
 ```
 
 ##### From a URL with a region
 ```ruby
-app = Stew::StoreClient.new.create_app("http://store.steampowered.com/app/220240/?cc=uk")
+app = Stew::Store::StoreClient.new.create_app("http://store.steampowered.com/app/220240/?cc=uk")
 ```
 
 All the examples above will create a Stew::Store::App instance for the game Far Cry 3. You can then access data like so:

data/lib/stew.rb

@@ -8,17 +8,20 @@ require 'money'
 
 require "stew/version"
 
-require 'stew/web_client'
-require 'stew/xml_client'
-require 'stew/community_client'
-require 'stew/store_client'
+require 'stew/community/xml_client/xml_client'
+require 'stew/community/xml_client/xml_client_response_profile'
+require 'stew/community/xml_client/xml_client_response_games'
+require 'stew/community/xml_client/xml_client_response_friends'
 
+require 'stew/community/community_client'
 require 'stew/community/steam_id'
 require 'stew/community/profile'
 require 'stew/community/profile_friends'
 require 'stew/community/profile_game'
 require 'stew/community/profile_games'
 
+require 'stew/store/web_client'
+require 'stew/store/store_client'
 require 'stew/store/app'
 require 'stew/store/app_offers'
 require 'stew/store/app_offer'
@@ -28,10 +31,10 @@ module Stew
   Money.assume_from_symbol = true
   
   @config = {
-    :default_community_client => CommunityClient,
-    :default_store_client => StoreClient,
-    :default_xml_client => XmlClient,
-    :default_web_client => WebClient,
+    :default_community_client => Community::CommunityClient,
+    :default_store_client => Store::StoreClient,
+    :default_xml_client => Community::XmlClient,
+    :default_web_client => Store::WebClient,
     :default_region => :us
   }
 

data/lib/stew/community/community_client.rb

@@ -0,0 +1,53 @@
+module Stew
+  module Community
+    # Creation of all profile* objects.
+    # Uses a given or default XmlClient instance to communicate with the Steam API
+    # The main identifier for most methods is the 64-bit steam id
+    # @example Create a Profile
+    #   Stew::CommunityClient.new.profile(76561197992917668) #=> Stew::Community::Profile
+    # 
+    # @example Resolve a Steam Vanity name
+    #   Stew::CommunityClient.steam_id_from_vanity_name('eekon20') #=> 76561197986383225
+    #
+    class CommunityClient
+      COMMUNITY_URL = 'http://steamcommunity.com'
+      DEFAULT_BASE_PATH = 'profiles'
+
+      # @deprecated Use CommunityClient.new.steam_id_from_vanity_name instead
+      def self.steam_id_from_vanity_name(vanity_name)
+        self.new.steam_id_from_vanity_name(vanity_name)
+      end
+   
+      def initialize(opts = {})
+        @xml_client = opts[:client] || Stew.config[:default_xml_client].new(COMMUNITY_URL)
+        @base_path = opts[:base_path] || DEFAULT_BASE_PATH
+      end
+
+      def steam_id_from_vanity_name(vanity_name)
+        response = XmlClientResponseProfile.new(@xml_client.get("/id/#{vanity_name}"))
+        response.profile['steamID64'].to_i
+      end
+
+      def profile(steam_id)
+        response = XmlClientResponseProfile.new(@xml_client.get(path(steam_id)))
+        Community::Profile.new(response.profile)
+      end
+
+      def profile_games(steam_id)
+        response = XmlClientResponseGames.new(@xml_client.get(path(steam_id,'games')))
+        Community::ProfileGames.new(response.games)
+      end
+
+      def profile_friends(steam_id)
+        response = XmlClientResponseFriends.new(@xml_client.get(path(steam_id,'friends')))
+        Community::ProfileFriends.new(response.friends)
+      end
+
+      private
+
+      def path(steam_id,command=nil)
+        "/#{@base_path}/#{steam_id}/#{command}"
+      end
+    end
+  end
+end

data/lib/stew/community/xml_client/xml_client.rb

@@ -0,0 +1,50 @@
+module Stew
+  module Community
+    # Client for accessing the steam community XML api
+    class XmlClient
+      def initialize(uri)
+        @connection = XmlClient.connection(uri)
+      end
+
+      # The Steam community is notorious for responding with error 503
+      # Retries up to 10 times for the same request to compensate for this
+      def get(path)
+        10.times do
+          response = request(path)
+          return XmlClient.parse_response(response.body) unless response.status == 503
+          sleep 0.5
+        end
+        raise ServiceUnavailableError
+      end
+
+      private
+
+      def request(path)
+        @connection.get path do |req|
+          req.params['xml'] = 1
+        end
+      end
+
+      def self.connection(uri)
+        Faraday.new uri do |conn|
+          conn.response :xml,  :content_type => /\bxml$/
+          conn.request :retry
+          conn.use FaradayMiddleware::FollowRedirects
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def self.parse_response(response)
+        raise(ObjectNotFoundError) if response.is_a?(String)
+        raise(ObjectNotFoundError, response['response']['error']) if response.has_key?('response')
+        response
+      end
+
+      # Raised when the Steam community API fails to respond after 10 tries
+      class ServiceUnavailableError < StandardError; end
+
+      # Raised when the reply is malformatted or if nothing is found
+      class ObjectNotFoundError < StandardError; end
+    end
+  end
+end

data/lib/stew/community/xml_client/xml_client_response_friends.rb

@@ -0,0 +1,20 @@
+module Stew
+  module Community
+    # A friends response from the Xml Client
+    class XmlClientResponseFriends
+      def initialize(response)
+        @response = response
+      end
+
+      def friends
+        has_friends? ? @response['friendsList']['friends']['friend'] : []
+      end
+
+      private
+
+      def has_friends?
+        !@response['friendsList']['friends'].nil?
+      end
+    end
+  end
+end

data/lib/stew/community/xml_client/xml_client_response_games.rb

@@ -0,0 +1,20 @@
+module Stew
+  module Community
+    # A games response from the Xml Client
+    class XmlClientResponseGames
+      def initialize(response)
+        @response = response
+      end
+
+      def games
+        has_games? ? @response['gamesList']['games']['game'] : []
+      end
+
+      private
+
+      def has_games?
+        !@response['gamesList']['games'].nil?
+      end
+    end
+  end
+end

data/lib/stew/community/xml_client/xml_client_response_profile.rb

@@ -0,0 +1,14 @@
+module Stew
+  module Community
+    # A profile response from the Xml Client
+    class XmlClientResponseProfile
+      def initialize(response)
+        @response = response
+      end
+
+      def profile
+        @response['profile']
+      end
+    end
+  end
+end

data/lib/stew/store/store_client.rb

@@ -0,0 +1,41 @@
+module Stew
+  module Store
+    # Creation of app objects from URLs or app_ids
+    # 
+    # Can create apps for any steam region. When no region is given, it defaults to the default region in the configuration
+    # 
+    # @example Creation of a Stew::Store::App from a URL
+    #   Stew::StoreClient.new.create_app('http://store.steampowered.com/app/211420') #=> Stew::StoreClient::App
+    # 
+    # @example Creation of a Stew::Store::App from an id
+    #   Stew::StoreClient.new.create_app(211420) #=> Stew::StoreClient::App
+    # 
+    # @example Creation of a Stew::Store::App from a URL with a different region
+    #   Stew::StoreClient.new.create_app('http://store.steampowered.com/app/211420?cc=uk') #=> Stew::StoreClient::App
+    # 
+    # @example Creation of a Stew::Store::App from an id and a region
+    #   Stew::StoreClient.new.app(211420, :uk) #=> Stew::StoreClient::App
+    # 
+    class StoreClient
+      STORE_URL = 'http://store.steampowered.com'
+
+      def initialize(opts = {})
+        @client = opts[:client] || Stew.config[:default_web_client].new(STORE_URL)
+      end
+
+      def create_app(data)
+        return app(data) if data.class == Fixnum
+        return app($1,$2) if data =~ /store.steampowered.com\/app\/([0-9]+)\/?\?cc=([a-zA-Z]{2})/
+        return app($1) if data =~ /store.steampowered.com\/app\/([0-9]+)/
+        raise AppIdNotFoundError
+      end
+
+      def app(app_id,region = Stew.config[:default_region])
+        Store::App.new(@client.get("/app/#{app_id}",:cc => region.to_sym))
+      end
+    end
+
+    # Error used when an app cannot be found
+    class AppIdNotFoundError < StandardError; end
+  end
+end

data/lib/stew/store/web_client.rb

@@ -0,0 +1,31 @@
+module Stew
+  module Store
+    # Client wrapper for performing requests to the Steam Store
+    class WebClient
+      def initialize(uri)
+        @connection = WebClient.connection(uri)
+      end
+
+      def get(path, options={})
+        request(path, options).body
+      end
+
+      private
+
+      def request(path,options={})
+        @connection.get(path) do |request|
+          request.params = options
+        end
+      end
+
+      def self.connection(uri)
+        Faraday.new uri do |conn|
+          conn.headers[:cookie] = "birthtime=365842801"
+          conn.request :retry
+          conn.use FaradayMiddleware::FollowRedirects
+          conn.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/stew/version.rb

@@ -1,3 +1,3 @@
 module Stew
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/spec/fixtures/profiles/friends/76561197994486912.yml

@@ -0,0 +1,5 @@
+---
+friendsList:
+  steamID64: '76561197994486912'
+  steamID: dkmez
+  friends: 

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

@@ -0,0 +1,5 @@
+---
+gamesList:
+  steamID64: '76561197994486912'
+  steamID: dkmez
+  games: 

data/spec/integration/store_integration_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe "Store", :vcr do
 
-  let(:store_client){Stew::StoreClient.new}
+  let(:store_client){Stew::Store::StoreClient.new}
   subject{store_client.app(id)}
 
   describe "Creation of a store app with data" do
@@ -15,7 +15,7 @@ describe "Store", :vcr do
     end
 
     it "sets the score" do
-      subject.score.should eq 85
+      subject.score.should be_a(Integer)
     end
 
     it "sets the release date" do
@@ -62,7 +62,7 @@ describe "Store", :vcr do
     end
 
     it "has a base price" do
-      subject.price.should eq Money.parse("$59.99")
+      subject.price.currency.should eq Money.parse("$59.99").currency
     end
 
     describe "the basic offer" do
@@ -76,24 +76,8 @@ describe "Store", :vcr do
         offer.description.should be_nil
       end
 
-      it "has the correct price" do
-        offer.price.should eq Money.parse("$59.99")
-      end
-    end
-
-    describe "the 4 pack" do
-      let(:offer){subject.offers.entries[1]}
-
-      it "has the correct name" do
-        offer.name.should eq 'Borderlands 2 - 4-Pack'
-      end
-
-      it "has the correct description" do
-        offer.description.should eq "Includes four copies of Borderlands 2 - Send the extra copies to your friends"
-      end
-
-      it "has the correct price" do
-        offer.price.should eq Money.parse("$179.99")
+      it "has the correct currency" do
+        offer.price.currency.should eq Money.parse("$59.99").currency
       end
     end
   end

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

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe "Stew::CommunityClient" do
+  let(:client){double('xml_client')}
+  subject{Stew::Community::CommunityClient.new({:client => client})}
+  let(:id){76561197992917668}
+
+  describe "#steam_id_from_vanity_name" do
+    let(:vanity_name){"foobar"}
+
+    it "calls steam_id_from_vanity_name on a new instance" do
+      Stew::Community::CommunityClient.any_instance.should_receive(:steam_id_from_vanity_name).with(vanity_name)
+      Stew::Community::CommunityClient.steam_id_from_vanity_name(vanity_name)
+    end
+  end
+
+
+  describe ".steam_id_from_vanity_name" do
+    let(:response){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
+    let(:name){"Somename"}
+
+    before :each do
+      client.should_receive(:get).with("/id/#{name}").and_return(response)
+    end
+
+    context "when the vanity name exists" do
+      it "returns the 64-bit id" do
+        subject.steam_id_from_vanity_name(name).should eq id
+      end
+    end
+  end
+
+  describe "setting the base path" do
+    context "when the base path is not set" do
+      let(:results){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
+
+      it "should perform requests to the 'profile'" do
+        client.should_receive(:get).with("/profiles/#{id}/").and_return(results)
+        subject.profile(id)
+      end
+    end
+
+    context "when the base path is set to 'id'" do
+      let(:results){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
+      subject{Stew::Community::CommunityClient.new({:client => client, :base_path => 'id'})}
+
+      it "should perform profile-requests to the 'id'" do
+        client.should_receive(:get).with("/id/#{id}/").and_return(results)
+        subject.profile(id)
+      end
+    end
+  end
+
+  describe ".profile" do
+    let(:results){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
+
+    it "sends the correct message to its client" do
+      client.should_receive(:get).with("/profiles/#{id}/").and_return(results)
+      subject.profile(id)
+    end
+
+    it "creates a profile object" do
+      client.stub(:get).with("/profiles/#{id}/").and_return(results)
+      Stew::Community::Profile.should_receive(:new).with(results['profile'])
+      subject.profile(id)
+    end
+  end
+
+  describe ".profile_games" do
+    let(:results){YAML.load_file("spec/fixtures/profiles/games/#{id}.yml")}
+
+    it "sends the correct message to its client" do
+      client.should_receive(:get).with("/profiles/#{id}/games").and_return(results)
+      subject.profile_games(id)
+    end
+
+    it "creates a ProfileGames object" do
+      client.stub(:get).with("/profiles/#{id}/games").and_return(results)
+      Stew::Community::ProfileGames.should_receive(:new).with(results['gamesList']['games']['game'])
+      subject.profile_games(id)
+    end
+
+    context "when the profile has no games" do
+      let(:id){76561197994486912}
+
+      it "creates an empty ProfileGames instance if the profile has no games" do
+        client.stub(:get).with("/profiles/#{id}/games").and_return(results)
+        profile_games = subject.profile_games(id)
+        profile_games.entries.count.should eq 0
+      end
+    end
+  end
+
+  describe ".profile_friends" do
+    let(:results){YAML.load_file("spec/fixtures/profiles/friends/#{id}.yml")}
+
+    it "sends the correct message to its client" do
+      client.should_receive(:get).with("/profiles/#{id}/friends").and_return(results)
+      subject.profile_friends(id)
+    end
+
+    it "creates a ProfileFriends object" do
+      client.stub(:get).with("/profiles/#{id}/friends").and_return(results)
+      Stew::Community::ProfileFriends.should_receive(:new).with(results['friendsList']['friends']['friend'])
+      subject.profile_friends(id)
+    end
+
+    context "when the profile has no friends" do
+      let(:id){76561197994486912}
+
+      it "creates an empty ProfileFriends instance if the profile has no friends" do
+        client.stub(:get).with("/profiles/#{id}/friends").and_return(results)
+        profile_friends = subject.profile_friends(id)
+        profile_friends.entries.count.should eq 0
+      end
+    end
+  end
+end

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

@@ -56,7 +56,7 @@ describe "Stew::Community::SteamId" do
       end
 
       it "should create a community client with no options" do
-        Stew::CommunityClient.should_receive(:new).with()
+        Stew::Community::CommunityClient.should_receive(:new).with()
         Stew::Community::SteamId.new(id)
       end
     end
@@ -69,7 +69,7 @@ describe "Stew::Community::SteamId" do
       end
 
       it "should create a community client with the base_path option set to 'id'" do
-        Stew::CommunityClient.should_receive(:new).with({:base_path => 'id'})
+        Stew::Community::CommunityClient.should_receive(:new).with({:base_path => 'id'})
         Stew::Community::SteamId.new(id)
       end
     end

data/spec/lib/stew/{xml_client_spec.rb → community/xml_client/xml_client_spec.rb}

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe "Stew::XmlClient" do
+describe "Stew::Community::XmlClient" do
   let(:uri){'http://steamcommunity.com'}
   let(:results){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
   let(:id){76561197992917668}
 
-  subject{Stew::XmlClient.new(uri)}
+  subject{Stew::Community::XmlClient.new(uri)}
 
   describe "#get" do
     context "when no error is found in the reply" do
@@ -15,7 +15,7 @@ describe "Stew::XmlClient" do
         stub_request(:get, "http://steamcommunity.com/profiles/#{id}?xml=1").to_return(File.new("spec/fixtures/profiles/#{id}.txt"))
       end
 
-      it "returns a hash containing the parsed data from the steam community servers" do
+      it "returns the response" do
         subject.get(path).should eq results
       end
     end
@@ -29,7 +29,7 @@ describe "Stew::XmlClient" do
       end
 
       it "throws an ObjectNotFound error" do
-        expect{subject.get(path).should}.to raise_error(Stew::XmlClient::ObjectNotFoundError)
+        expect{subject.get(path).should}.to raise_error(Stew::Community::XmlClient::ObjectNotFoundError)
       end
     end
   end

data/spec/lib/stew/{store_client_spec.rb → store/store_client_spec.rb}

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe "Stew::StoreClient" do
+describe "Stew::Store::StoreClient" do
   let(:client){double('web_client')}
   let(:response){open("spec/fixtures/store/apps/#{id}.txt")}
   let(:region){:us}
-  subject{Stew::StoreClient.new({:client => client})}
+  subject{Stew::Store::StoreClient.new({:client => client})}
 
   describe ".app" do
     let(:id) {211420}
@@ -51,7 +51,7 @@ describe "Stew::StoreClient" do
       let(:url){"sodijfsdf"}
 
       it "raises a Stew::Store::AppIdNotFoundError" do
-        expect{subject.create_app(url)}.to raise_error(Stew::AppIdNotFoundError)
+        expect{subject.create_app(url)}.to raise_error(Stew::Store::AppIdNotFoundError)
       end
     end
   end

data/spec/lib/stew/{web_client_spec.rb → store/web_client_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe "Stew::WebClient", :vcr do
+describe "Stew::Store::WebClient", :vcr do
   let(:uri){'http://store.steampowered.com/'}
 
-  subject{Stew::WebClient.new(uri)}
+  subject{Stew::Store::WebClient.new(uri)}
 
   describe ".get" do
     let(:id){216390}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stew
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -299,25 +299,30 @@ files:
 - README.md
 - Rakefile
 - lib/stew.rb
+- lib/stew/community/community_client.rb
 - lib/stew/community/profile.rb
 - lib/stew/community/profile_friends.rb
 - lib/stew/community/profile_game.rb
 - lib/stew/community/profile_games.rb
 - lib/stew/community/steam_id.rb
-- lib/stew/community_client.rb
+- lib/stew/community/xml_client/xml_client.rb
+- lib/stew/community/xml_client/xml_client_response_friends.rb
+- lib/stew/community/xml_client/xml_client_response_games.rb
+- lib/stew/community/xml_client/xml_client_response_profile.rb
 - lib/stew/store/app.rb
 - lib/stew/store/app_offer.rb
 - lib/stew/store/app_offer_sale.rb
 - lib/stew/store/app_offers.rb
-- lib/stew/store_client.rb
+- lib/stew/store/store_client.rb
+- lib/stew/store/web_client.rb
 - lib/stew/version.rb
-- lib/stew/web_client.rb
-- lib/stew/xml_client.rb
 - spec/fixtures/profiles/4d.txt
 - spec/fixtures/profiles/76561197992917668.txt
 - spec/fixtures/profiles/76561197992917668.yml
 - spec/fixtures/profiles/friends/76561197992917668.yml
+- spec/fixtures/profiles/friends/76561197994486912.yml
 - spec/fixtures/profiles/games/76561197992917668.yml
+- spec/fixtures/profiles/games/76561197994486912.yml
 - spec/fixtures/store/apps/16870.txt
 - spec/fixtures/store/apps/211400_offers_sale.txt
 - spec/fixtures/store/apps/211400_sale.txt
@@ -330,19 +335,19 @@ files:
 - spec/fixtures/store/apps/no_app.txt
 - spec/integration/community_integration_spec.rb
 - spec/integration/store_integration_spec.rb
+- spec/lib/stew/community/community_client_spec.rb
 - spec/lib/stew/community/profile_friends_spec.rb
 - spec/lib/stew/community/profile_game_spec.rb
 - spec/lib/stew/community/profile_games_spec.rb
 - spec/lib/stew/community/profile_spec.rb
 - spec/lib/stew/community/steam_id_spec.rb
-- spec/lib/stew/community_client_spec.rb
+- spec/lib/stew/community/xml_client/xml_client_spec.rb
 - spec/lib/stew/store/app_offer_sale_spec.rb
 - spec/lib/stew/store/app_offer_spec.rb
 - spec/lib/stew/store/app_offers_spec.rb
 - spec/lib/stew/store/app_spec.rb
-- spec/lib/stew/store_client_spec.rb
-- spec/lib/stew/web_client_spec.rb
-- spec/lib/stew/xml_client_spec.rb
+- spec/lib/stew/store/store_client_spec.rb
+- spec/lib/stew/store/web_client_spec.rb
 - spec/lib/stew_spec.rb
 - spec/spec_helper.rb
 - stew.gemspec
@@ -360,7 +365,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4370496576353841969
+      hash: -5319004060931315
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -369,7 +374,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4370496576353841969
+      hash: -5319004060931315
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -381,7 +386,9 @@ test_files:
 - spec/fixtures/profiles/76561197992917668.txt
 - spec/fixtures/profiles/76561197992917668.yml
 - spec/fixtures/profiles/friends/76561197992917668.yml
+- spec/fixtures/profiles/friends/76561197994486912.yml
 - spec/fixtures/profiles/games/76561197992917668.yml
+- spec/fixtures/profiles/games/76561197994486912.yml
 - spec/fixtures/store/apps/16870.txt
 - spec/fixtures/store/apps/211400_offers_sale.txt
 - spec/fixtures/store/apps/211400_sale.txt
@@ -394,19 +401,19 @@ test_files:
 - spec/fixtures/store/apps/no_app.txt
 - spec/integration/community_integration_spec.rb
 - spec/integration/store_integration_spec.rb
+- spec/lib/stew/community/community_client_spec.rb
 - spec/lib/stew/community/profile_friends_spec.rb
 - spec/lib/stew/community/profile_game_spec.rb
 - spec/lib/stew/community/profile_games_spec.rb
 - spec/lib/stew/community/profile_spec.rb
 - spec/lib/stew/community/steam_id_spec.rb
-- spec/lib/stew/community_client_spec.rb
+- spec/lib/stew/community/xml_client/xml_client_spec.rb
 - spec/lib/stew/store/app_offer_sale_spec.rb
 - spec/lib/stew/store/app_offer_spec.rb
 - spec/lib/stew/store/app_offers_spec.rb
 - spec/lib/stew/store/app_spec.rb
-- spec/lib/stew/store_client_spec.rb
-- spec/lib/stew/web_client_spec.rb
-- spec/lib/stew/xml_client_spec.rb
+- spec/lib/stew/store/store_client_spec.rb
+- spec/lib/stew/store/web_client_spec.rb
 - spec/lib/stew_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/stew/community_client.rb

@@ -1,42 +0,0 @@
-module Stew
-  # Creation of all profile* objects.
-  # Uses a given or default XmlClient instance to communicate with the Steam API
-  # The main identifier for most methods is the 64-bit steam id
-  # @example Create a Profile
-  #   Stew::CommunityClient.new.profile(76561197992917668) #=> Stew::Community::Profile
-  # 
-  # @example Resolve a Steam Vanity name
-  #   Stew::CommunityClient.steam_id_from_vanity_name('eekon20') #=> 76561197986383225
-  #
-  class CommunityClient
-    COMMUNITY_URL = 'http://steamcommunity.com'
-    DEFAULT_BASE_PATH = 'profiles'
-
-    def self.steam_id_from_vanity_name(vanity_name)
-      Stew::XmlClient.new(COMMUNITY_URL).get("/id/#{vanity_name}")['profile']['steamID64'].to_i
-    end
- 
-    def initialize(opts = {})
-      @xml_client = opts[:client] || Stew.config[:default_xml_client].new(COMMUNITY_URL)
-      @base_path = opts[:base_path] || DEFAULT_BASE_PATH
-    end
-
-    def profile(steam_id)
-      Community::Profile.new @xml_client.get(path(steam_id))['profile']
-    end
-
-    def profile_games(steam_id)
-      Community::ProfileGames.new @xml_client.get(path(steam_id,'games'))['gamesList']['games']['game']
-    end
-
-    def profile_friends(steam_id)
-      Community::ProfileFriends.new @xml_client.get(path(steam_id,'friends'))['friendsList']['friends']['friend']
-    end
-
-    private
-
-    def path(steam_id,command=nil)
-      "/#{@base_path}/#{steam_id}/#{command}"
-    end
-  end
-end

data/lib/stew/store_client.rb

@@ -1,39 +0,0 @@
-module Stew
-  # Creation of app objects from URLs or app_ids
-  # 
-  # Can create apps for any steam region. When no region is given, it defaults to the default region in the configuration
-  # 
-  # @example Creation of a Stew::Store::App from a URL
-  #   Stew::StoreClient.new.create_app('http://store.steampowered.com/app/211420') #=> Stew::StoreClient::App
-  # 
-  # @example Creation of a Stew::Store::App from an id
-  #   Stew::StoreClient.new.create_app(211420) #=> Stew::StoreClient::App
-  # 
-  # @example Creation of a Stew::Store::App from a URL with a different region
-  #   Stew::StoreClient.new.create_app('http://store.steampowered.com/app/211420?cc=uk') #=> Stew::StoreClient::App
-  # 
-  # @example Creation of a Stew::Store::App from an id and a region
-  #   Stew::StoreClient.new.app(211420, :uk) #=> Stew::StoreClient::App
-  # 
-  class StoreClient
-    STORE_URL = 'http://store.steampowered.com'
-
-    def initialize(opts = {})
-      @client = opts[:client] || Stew.config[:default_web_client].new(STORE_URL)
-    end
-
-    def create_app(data)
-      return app(data) if data.class == Fixnum
-      return app($1,$2) if data =~ /store.steampowered.com\/app\/([0-9]+)\/?\?cc=([a-zA-Z]{2})/
-      return app($1) if data =~ /store.steampowered.com\/app\/([0-9]+)/
-      raise AppIdNotFoundError
-    end
-
-    def app(app_id,region = Stew.config[:default_region])
-      Store::App.new(@client.get("/app/#{app_id}",:cc => region.to_sym))
-    end
-  end
-
-  # Error used when an app cannot be found
-  class AppIdNotFoundError < StandardError; end
-end

data/lib/stew/web_client.rb

@@ -1,30 +0,0 @@
-module Stew
-
-  # Client wrapper for performing requests to the Steam Store
-  class WebClient
-    def initialize(uri)
-      @connection = WebClient.connection(uri)
-    end
-
-    def get(path, options={})
-      request(path, options).body
-    end
-
-    private
-
-    def request(path,options={})
-      @connection.get(path) do |request|
-        request.params = options
-      end
-    end
-
-    def self.connection(uri)
-      Faraday.new uri do |conn|
-        conn.headers[:cookie] = "birthtime=365842801"
-        conn.request :retry
-        conn.use FaradayMiddleware::FollowRedirects
-        conn.adapter Faraday.default_adapter
-      end
-    end
-  end
-end

data/lib/stew/xml_client.rb

@@ -1,49 +0,0 @@
-module Stew
-
-  # Client for accessing the steam community XML api
-  class XmlClient
-    def initialize(uri)
-      @connection = XmlClient.connection(uri)
-    end
-
-    # The Steam community is notorious for responding with error 503
-    # Retries up to 10 times for the same request to compensate for this
-    def get(path)
-      10.times do
-        response = request(path)
-        return XmlClient.parse_response(response.body) unless response.status == 503
-        sleep 0.5
-      end
-      raise ServiceUnavailableError
-    end
-
-    private
-
-    def request(path)
-      @connection.get path do |req|
-        req.params['xml'] = 1
-      end
-    end
-
-    def self.connection(uri)
-      Faraday.new uri do |conn|
-        conn.response :xml,  :content_type => /\bxml$/
-        conn.request :retry
-        conn.use FaradayMiddleware::FollowRedirects
-        conn.adapter Faraday.default_adapter
-      end
-    end
-
-    def self.parse_response(response)
-      raise(ObjectNotFoundError) if response.is_a?(String)
-      raise(ObjectNotFoundError, response['response']['error']) if response.has_key?('response')
-      response
-    end
-
-    # Raised when the Steam community API fails to respond after 10 tries
-    class ServiceUnavailableError < StandardError; end
-
-    # Raised when the reply is malformatted or if nothing is found
-    class ObjectNotFoundError < StandardError; end
-  end
-end

data/spec/lib/stew/community_client_spec.rb

@@ -1,88 +0,0 @@
-require 'spec_helper'
-
-describe "Stew::CommunityClient" do
-  let(:client){double('xml_client')}
-  subject{Stew::CommunityClient.new({:client => client})}
-  let(:id){76561197992917668}
-
-  describe "#steam_id_from_vanity_name" do
-    let(:response){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
-    let(:name){"Somename"}
-
-    before :each do
-      Stew::XmlClient.any_instance.should_receive(:get).with("/id/#{name}").and_return(response)
-    end
-
-    context "when the vanity name exists" do
-      it "returns the 64-bit id" do
-        Stew::CommunityClient.steam_id_from_vanity_name(name).should eq id
-      end
-    end
-  end
-
-  describe "setting the base path" do
-    context "when the base path is not set" do
-      let(:response){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
-
-      it "should perform requests to the 'profile'" do
-        client.should_receive(:get).with("/profiles/#{id}/").and_return(response)
-        subject.profile(id)
-      end
-    end
-
-    context "when the base path is set to 'id'" do
-      let(:response){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
-      subject{Stew::CommunityClient.new({:client => client, :base_path => 'id'})}
-
-      it "should perform profile-requests to the 'id'" do
-        client.should_receive(:get).with("/id/#{id}/").and_return(response)
-        subject.profile(id)
-      end
-    end
-  end
-
-  describe ".profile" do
-    let(:response){YAML.load_file("spec/fixtures/profiles/#{id}.yml")}
-
-    it "sends the correct message to its client" do
-      client.should_receive(:get).with("/profiles/#{id}/").and_return(response)
-      subject.profile(id)
-    end
-
-    it "creates a profile object" do
-      client.stub(:get).with("/profiles/#{id}/").and_return(response)
-      Stew::Community::Profile.should_receive(:new).with(response['profile'])
-      subject.profile(id)
-    end
-  end
-
-  describe ".profile_games" do
-    let(:response){YAML.load_file("spec/fixtures/profiles/games/#{id}.yml")}
-
-    it "sends the correct message to its client" do
-      client.should_receive(:get).with("/profiles/#{id}/games").and_return(response)
-      subject.profile_games(id)
-    end
-
-    it "creates a ProfileGames object" do
-      client.stub(:get).with("/profiles/#{id}/games").and_return(response)
-      Stew::Community::ProfileGames.should_receive(:new).with(response['gamesList']['games']['game'])
-      subject.profile_games(id)
-    end
-  end
-
-  describe ".profile_friends" do
-    let(:response){YAML.load_file("spec/fixtures/profiles/friends/#{id}.yml")}
-
-    it "sends the correct message to its client" do
-      client.should_receive(:get).with("/profiles/#{id}/friends").and_return(response)
-      subject.profile_friends(id)
-    end
-
-    it "returns the value of the ['friendsList']['friends']['friend'] key from the response hash" do
-      client.stub(:get).with("/profiles/#{id}/friends").and_return(response)
-      Stew::Community::ProfileFriends.should_receive(:new).with(response['friendsList']['friends']['friend'])
-      subject.profile_friends(id)
-    end
-  end
-end