stew 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: 477197e65d28b16f161bb00fda87456f4c8dd060
-  data.tar.gz: cc4b12947017d09abe8709ce409f7bcd29a13b95
-!binary "U0hBNTEy":
-  metadata.gz: a906dfe2d3fd1b5f153d8ff917d4d607928a53c743fee15a7b0525592f0eaa1db3654e331783e25359efdf19de3291c5f20c12643f282266a2acf5cac819de4d
-  data.tar.gz: 225ef1f2c16bd40c24ed9e0d8573ed5f33ceb224dbed1b0485aba612429dd3d157c5c6030c7aca9980fd123ab7506a2774e3e100e7109fe478c9d4a3f4236d08
+SHA1:
+  metadata.gz: 5166e1a3081ff40e7ca4827980ccc913b3429540
+  data.tar.gz: 5584edb934679444c212d2f1bf74bd5f84f8dfdc
+SHA512:
+  metadata.gz: 00dfa4a38b304d64d3bd270e2e5ce73efb0158201df457b07debe73538d1e24da3475db4ec27a14e3f3abb60f88e1260f85a89b458a2eb1dbc56fa1b5cb4e31a
+  data.tar.gz: 7cd14ea29660021199471306c78df32d1f4a26a66461bd472223aae68aca5c7c1541c6aa356a7c503acb59a0a8e70eb02d6d3b29cc79f97bc3dcef8482deb7dc

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+spec/config.yml
 Gemfile.lock
 InstalledFiles
 _yardoc

data/lib/stew.rb

@@ -8,12 +8,9 @@ require 'money'
 
 require "stew/version"
 
-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_resolver'
+require 'stew/community/web_client'
+require 'stew/community/web_api_client'
 require 'stew/community/steam_id'
 require 'stew/community/profile'
 require 'stew/community/profile_friends'
@@ -34,11 +31,11 @@ module Stew
   Money.assume_from_symbol = true
   
   @config = {
-    :default_community_client => Community::CommunityClient,
+    :default_community_client => Community::WebApiClient,
     :default_store_client => Store::StoreClient,
-    :default_xml_client => Community::XmlClient,
     :default_web_client => Store::WebClient,
-    :default_region => :us
+    :default_region => :us,
+    :steam_api_key => nil
   }
 
   @valid_config_keys = @config.keys

data/lib/stew/community/profile.rb

@@ -15,8 +15,8 @@ module Stew
       private
 
       def set_data(data)
-        @id = data['steamID64'].to_i
-        @nickname = data['steamID']
+        @id = data['steamid'].to_i
+        @nickname = data['personaname']
       end
     end
   end

data/lib/stew/community/profile_friends.rb

@@ -7,7 +7,7 @@ module Stew
       include Enumerable
 
       def initialize(data)
-        @friends = data.map {|friend| SteamId.new(friend)}
+        @friends = data.map {|friend| SteamId.new(friend['steamid'])}
       end
 
       def each(&block)

data/lib/stew/community/profile_game.rb

@@ -11,17 +11,34 @@ module Stew
 
       attr_reader :store_link
 
-      attr_reader :hours_last_2_weeks
+      attr_reader :playtime_2weeks
 
-      attr_reader :hours_on_record
+      attr_reader :playtime_forever
 
       def initialize(hash)
-        @app_id = hash['appID'].to_i
+        @app_id = hash['appid'].to_i
         @name = hash['name']
         @logo = hash['logo']
-        @store_link = hash['storeLink']
-        @hours_last_2_weeks = hash['hoursLast2Weeks'].to_f
-        @hours_on_record = hash['hoursOnRecord'].to_f
+        @playtime_2weeks = hash['playtime_2weeks'].to_i
+        @playtime_forever = hash['playtime_forever'].to_i
+        @img_logo_url = hash['img_logo_url']
+        @img_icon_url = hash['img_icon_url']
+      end
+
+      def store_url
+        "http://store.steampowered.com/app/#{@app_id}"
+      end
+
+      def community_url
+        "http://steamcommunity.com/app/#{@app_id}"
+      end
+
+      def icon
+        "http://media.steampowered.com/steamcommunity/public/images/apps/#{@app_id}/#{@img_icon_url}.jpg"
+      end
+
+      def logo
+        "http://media.steampowered.com/steamcommunity/public/images/apps/#{@app_id}/#{@img_logo_url}.jpg"
       end
     end
   end

data/lib/stew/community/steam_id.rb

@@ -13,36 +13,21 @@ module Stew
 
       attr_reader :id
 
-      def self.create(data)
-        return self.new($1.to_i) if data =~ /steamcommunity.com\/profiles\/([0-9]+)/
-        return self.new($1) if data =~ /steamcommunity.com\/id\/([a-zA-Z0-9]+)/
-        return self.new(data) if data.to_s.match /^[0-9A-Za-z]+$/
-        raise SteamIdNotFoundError
-      end
-
-      def initialize(steam_id,opts={})
-        @id = steam_id
-        @client = opts[:client] || self.class.client_with_options(steam_id)
+      def initialize(data,opts={})
+        @client = opts[:client] || Stew.config[:default_community_client].new
+        @id = SteamIdResolver.new(@client).steam_id(data)
       end
 
       def profile
-        @profile ||= @client.profile @id
+        @profile ||= Profile.new(@client.profile(@id))
       end
 
       def games
-        @games ||= @client.profile_games @id
+        @games ||= ProfileGames.new @client.profile_games(@id)
       end
 
       def friends
-        @friends ||= @client.profile_friends @id
-      end
-
-      private
-
-      def self.client_with_options(steam_id)
-        klass = Stew.config[:default_community_client]
-        return klass.new if steam_id.to_s.match /^[0-9]+$/
-        return klass.new({:base_path => 'id'})
+        @friends ||= ProfileFriends.new @client.profile_friends(@id)
       end
     end
 

data/lib/stew/community/steam_id_resolver.rb

@@ -0,0 +1,34 @@
+module Stew
+  module Community
+
+    #Resolves steam ids from numbers, urls and vanity names
+    class SteamIdResolver
+      attr_reader :client
+
+      def initialize(client = Stew.config[:default_community_client].new)
+        @client = client
+      end
+
+      def steam_id(data)
+        data_string = data.to_s
+        return data.to_i if /^[0-9]+$/ === data_string
+
+        matches = (/steamcommunity.com\/(id|profiles|)\/([a-z0-9]+)/i).match(data_string)
+        steam_id = steam_id_from_matches(data,matches)
+        return steam_id unless steam_id.nil?
+        raise Stew::Community::SteamIdNotFoundError
+      end
+
+    private
+      def steam_id_from_matches(data, matches)
+        if matches.nil?
+          return @client.vanity_url_to_steam_id(data) unless data.include?('/')
+        elsif matches[1] != 'profiles'
+          return @client.vanity_url_to_steam_id(data)
+        else
+          return matches[2].to_i
+        end
+      end
+    end
+  end
+end

data/lib/stew/community/web_api_client.rb

@@ -0,0 +1,29 @@
+module Stew
+  module Community
+    class WebApiClient
+      BASE_URI = 'http://api.steampowered.com'
+
+      def initialize(client = WebClient.new(BASE_URI), opts={})
+        @api_key = opts[:steam_api_key] || Stew.config[:steam_api_key]
+        @client = client
+      end
+
+      def vanity_url_to_steam_id(vanity_url)
+        vanity_name = vanity_url.split('/').last
+        @client.get("/ISteamUser/ResolveVanityURL/v0001/?key=#{@api_key}&vanityurl=#{vanity_name}")['response']['steamid'].to_i
+      end
+
+      def profile(steam_id)
+        @client.get("/ISteamUser/GetPlayerSummaries/v0002/?key=#{@api_key}&steamids=#{steam_id}")['response']['players'].first
+      end
+
+      def profile_games(steam_id)
+        @client.get("/IPlayerService/GetOwnedGames/v0001/?key=#{@api_key}&steamid=#{steam_id}&include_appinfo=1")['response']['games']
+      end
+
+      def profile_friends(steam_id)
+        @client.get("/ISteamUser/GetFriendList/v0001/?key=#{@api_key}&steamid=#{steam_id}&relationship=friend")['friendslist']['friends']
+      end
+    end
+  end
+end

data/lib/stew/community/web_client.rb

@@ -0,0 +1,29 @@
+module Stew
+  module Community
+    class WebClient
+      def initialize(uri)
+        @connection = self.class.connection(uri)
+      end
+
+      def get(uri)
+        request(uri).body
+      end
+
+      private
+
+      def request(path)
+        @connection.get path
+      end
+
+      def self.connection(uri)
+        Faraday.new uri do |conn|
+          conn.request :json
+          conn.request :retry
+          conn.response :json,  :content_type => /\bjson$/
+          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.3"
+  VERSION = "0.6.0"
 end

data/spec/config.yml.example

@@ -0,0 +1 @@
+steam_api_key: YOUR STEAM API KEY

data/spec/fixtures/profiles/76561197992917668.json

@@ -0,0 +1,24 @@
+{
+  "response": {
+    "players": [
+      {
+        "steamid": "76561197992917668",
+        "communityvisibilitystate": 3,
+        "profilestate": 1,
+        "personaname": "MrCheese",
+        "lastlogoff": 1366670468,
+        "profileurl": "http://steamcommunity.com/profiles/76561197992917668/",
+        "avatar": "http://media.steampowered.com/steamcommunity/public/images/avatars/3f/3fa6fcddcca7825ee0a77f4f4b8f4e10543a13cd.jpg",
+        "avatarmedium": "http://media.steampowered.com/steamcommunity/public/images/avatars/3f/3fa6fcddcca7825ee0a77f4f4b8f4e10543a13cd_medium.jpg",
+        "avatarfull": "http://media.steampowered.com/steamcommunity/public/images/avatars/3f/3fa6fcddcca7825ee0a77f4f4b8f4e10543a13cd_full.jpg",
+        "personastate": 0,
+        "primaryclanid": "103582791429591238",
+        "timecreated": 1190821006,
+        "loccountrycode": "SE",
+        "locstatecode": "27",
+        "loccityid": 43726
+      }
+    ]
+    
+  }
+}

data/spec/fixtures/profiles/friends/76561197992917668.json

@@ -0,0 +1,167 @@
+{
+    "friendslist": {
+        "friends": [
+            {
+                "steamid": "76561197960889223",
+                "relationship": "friend",
+                "friend_since": 1359412028
+            },
+            {
+                "steamid": "76561197965950613",
+                "relationship": "friend",
+                "friend_since": 0
+            },
+            {
+                "steamid": "76561197967840183",
+                "relationship": "friend",
+                "friend_since": 1268471108
+            },
+            {
+                "steamid": "76561197969785267",
+                "relationship": "friend",
+                "friend_since": 1305879987
+            },
+            {
+                "steamid": "76561197970357192",
+                "relationship": "friend",
+                "friend_since": 1298409788
+            },
+            {
+                "steamid": "76561197971313256",
+                "relationship": "friend",
+                "friend_since": 1275244941
+            },
+            {
+                "steamid": "76561197972211787",
+                "relationship": "friend",
+                "friend_since": 1274393267
+            },
+            {
+                "steamid": "76561197973308537",
+                "relationship": "friend",
+                "friend_since": 0
+            },
+            {
+                "steamid": "76561197984753904",
+                "relationship": "friend",
+                "friend_since": 0
+            },
+            {
+                "steamid": "76561197986383225",
+                "relationship": "friend",
+                "friend_since": 1275316731
+            },
+            {
+                "steamid": "76561197989970207",
+                "relationship": "friend",
+                "friend_since": 1355787283
+            },
+            {
+                "steamid": "76561197990381282",
+                "relationship": "friend",
+                "friend_since": 1355816720
+            },
+            {
+                "steamid": "76561197992896557",
+                "relationship": "friend",
+                "friend_since": 0
+            },
+            {
+                "steamid": "76561197993006661",
+                "relationship": "friend",
+                "friend_since": 1313313231
+            },
+            {
+                "steamid": "76561197993202125",
+                "relationship": "friend",
+                "friend_since": 1314895927
+            },
+            {
+                "steamid": "76561197993600452",
+                "relationship": "friend",
+                "friend_since": 1298573833
+            },
+            {
+                "steamid": "76561197994132576",
+                "relationship": "friend",
+                "friend_since": 1261943962
+            },
+            {
+                "steamid": "76561197996738173",
+                "relationship": "friend",
+                "friend_since": 1280061358
+            },
+            {
+                "steamid": "76561197997794911",
+                "relationship": "friend",
+                "friend_since": 1297707551
+            },
+            {
+                "steamid": "76561197999278598",
+                "relationship": "friend",
+                "friend_since": 1280579010
+            },
+            {
+                "steamid": "76561197999580320",
+                "relationship": "friend",
+                "friend_since": 1317242856
+            },
+            {
+                "steamid": "76561198005505133",
+                "relationship": "friend",
+                "friend_since": 1299011024
+            },
+            {
+                "steamid": "76561198005611690",
+                "relationship": "friend",
+                "friend_since": 1280131917
+            },
+            {
+                "steamid": "76561198005665154",
+                "relationship": "friend",
+                "friend_since": 1310909994
+            },
+            {
+                "steamid": "76561198006604638",
+                "relationship": "friend",
+                "friend_since": 1314895928
+            },
+            {
+                "steamid": "76561198009417084",
+                "relationship": "friend",
+                "friend_since": 1322376998
+            },
+            {
+                "steamid": "76561198011470861",
+                "relationship": "friend",
+                "friend_since": 1332093028
+            },
+            {
+                "steamid": "76561198013177911",
+                "relationship": "friend",
+                "friend_since": 1358963405
+            },
+            {
+                "steamid": "76561198038197496",
+                "relationship": "friend",
+                "friend_since": 1297818296
+            },
+            {
+                "steamid": "76561198038245915",
+                "relationship": "friend",
+                "friend_since": 1302029464
+            },
+            {
+                "steamid": "76561198052700918",
+                "relationship": "friend",
+                "friend_since": 1322508339
+            },
+            {
+                "steamid": "76561198067660255",
+                "relationship": "friend",
+                "friend_since": 1345894791
+            }
+        ]
+        
+    }
+}