stew 0.5.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures/cassette_library/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stew.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Magnus Skog
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Stew
+
+[![Code Climate](https://codeclimate.com/github/mskog/stew.png)](https://codeclimate.com/github/mskog/stew)
+
+##Information
+
+Stew can access both the Steam Community and the Steam Store. The Community library uses the Steam XML API and should be rather stable.
+The Store library accesses the Store pages by parsing the HTML. This should be considered unstable and you have to be prepared for missing data in case the store pages change.
+
+###Steam Community
+The Community part of the API is a work in progress and lacks a lot of the fields expected in for example a Profile.
+You can however still use it to retrieve the games for a profile and such.
+
+####Create a Steam ID
+```ruby
+steam_id = Stew::Community::SteamId.create("http://steamcommunity.com/profiles/76561197992917668")
+```
+
+You can also use the 64 bit ids. This is equivalent to above:
+```ruby
+steam_id = Stew::Community::SteamId.create(76561197992917668)
+```
+
+Finally, you can use vanity names or URLs to create steam_ids like so:
+
+```ruby
+steam_id = Stew::Community::SteamId.create("http://steamcommunity.com/id/eekon20")
+```
+or
+```ruby
+steam_id = Stew::Community::SteamId.create("eekon20")
+```
+
+Once you have created a Steam ID, you can use it to get information like the Profile, Games and Friends
+
+##### Profile
+```ruby
+steam_id.profile.nickname #=> 'Best baunty EU'
+```
+
+##### Games
+```ruby
+steam_id.games.each {|game| puts game.name}
+```
+
+##### Friends
+```ruby
+steam_id.friends.each {|friend| puts friend.profile.nickname}
+```
+
+
+## Store
+**Important! The Store library accesses the Store pages by parsing HTML responses. It will give nil values in case the HTML on the store pages change**
+
+#### Create a Store Application
+
+##### From an App id
+```ruby
+app = Stew::StoreClient.new.create_app(220240)
+```
+
+##### From a URL
+```ruby
+app = Stew::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")
+```
+
+All the examples above will create a Stew::Store::App instance for the game Far Cry 3. You can then access data like so:
+
+```ruby
+app.name #=> "Far Cry 3"
+
+app.score #=> 88 #Metacritic score
+
+app.release_date.to_s #=> "2012-12-04"
+
+app.price #=> Money instance. https://github.com/RubyMoney/money
+
+app.offers #=> AppOffers
+
+app.offers.sale? #=> false
+
+app.indie? #=> false
+
+app.free? #=> false :(
+```
+
+More data is available for apps and app offers. See the code for the specific classes to find out.
+
+## Contribute
+
+Will gladly accept pull requests.
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require "bundler/gem_tasks"
+require 'ci/reporter/rake/rspec'
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec

data/lib/stew.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'faraday_middleware'
+require 'yaml'
+require 'nokogiri'
+require 'money'
+
+require "stew/version"
+
+require 'stew/web_client'
+require 'stew/xml_client'
+require 'stew/community_client'
+require 'stew/store_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/app'
+require 'stew/store/app_offers'
+require 'stew/store/app_offer'
+require 'stew/store/app_offer_sale'
+
+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_region => :us
+  }
+
+  @valid_config_keys = @config.keys
+
+  def self.configure(opts = {})
+    opts.each {|key,value| @config[key] = value if @valid_config_keys.include? key}
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.money(price)
+    if price.include?("€")
+      Money.parse(price[-1,1]+price[0..-2])
+    else
+      Money.parse price
+    end
+  end
+
+  #Base error
+  class StewError < StandardError; end
+end

data/lib/stew/community/profile.rb

@@ -0,0 +1,23 @@
+module Stew
+  module Community
+
+    # Represents the base data for a Steam Profile
+    class Profile
+
+      attr_reader :id
+
+      attr_reader :nickname
+
+      def initialize(hash)
+        set_data(hash)
+      end
+
+      private
+
+      def set_data(data)
+        @id = data['steamID64'].to_i
+        @nickname = data['steamID']
+      end
+    end
+  end
+end

data/lib/stew/community/profile_friends.rb

@@ -0,0 +1,18 @@
+module Stew
+  module Community
+
+    # Represents the friends of a Steam profile
+    # Enumerates a list of Steam Id instances
+    class ProfileFriends
+      include Enumerable
+
+      def initialize(data)
+        @friends = data.map {|friend| SteamId.new(friend)}
+      end
+
+      def each(&block)
+        @friends.each(&block)
+      end
+    end
+  end
+end

data/lib/stew/community/profile_game.rb

@@ -0,0 +1,28 @@
+module Stew
+  module Community
+
+    #Represents a Steam Game owned by a Steam Id
+    class ProfileGame
+      attr_reader :app_id
+
+      attr_reader :name
+
+      attr_reader :logo
+
+      attr_reader :store_link
+
+      attr_reader :hours_last_2_weeks
+
+      attr_reader :hours_on_record
+
+      def initialize(hash)
+        @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
+      end
+    end
+  end
+end

data/lib/stew/community/profile_games.rb

@@ -0,0 +1,17 @@
+module Stew
+  module Community
+
+    #Represents the ProfileGame instances owned by a steam id
+    class ProfileGames
+      include Enumerable
+
+      def initialize(data)
+        @games = Array.new(data.map{|game| ProfileGame.new(game)})
+      end
+
+      def each(&block)
+        @games.each(&block)
+      end
+    end
+  end
+end

data/lib/stew/community/steam_id.rb

@@ -0,0 +1,52 @@
+module Stew
+  module Community
+
+    # The base class for all Steam Ids. Has accessors for the base profile, games and friends of a Steam Id
+    # 
+    # @example Create an instance from a 64-bit steam id
+    #   Stew::Community::SteamId.new(76561197992917668) #=> Stew::Community::SteamId
+    # 
+    # @example Create an instance from a community URL
+    #   Stew::Community::SteamId.create("http://steamcommunity.com/profiles/76561197992917668") #=> Stew::Community::SteamId
+    #   
+    class SteamId
+
+      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)
+      end
+
+      def profile
+        @profile ||= @client.profile @id
+      end
+
+      def games
+        @games ||= @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'})
+      end
+    end
+
+    # Error to be raised when no Steam id is found
+    class SteamIdNotFoundError < StandardError; end
+  end
+end

data/lib/stew/community_client.rb

@@ -0,0 +1,42 @@
+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/app.rb

@@ -0,0 +1,76 @@
+module Stew
+  module Store
+    
+    # An application in the Steam Store
+    # Initialized from the contents of a web request to the Steam store app page
+    class App
+      def initialize(response)
+        @document = Nokogiri::HTML(response)
+      end
+
+      def score
+        score_section[0] && score_from_score_section
+      end
+
+      def name
+        App.content_or_nil @document.at_css("div.apphub_AppName")
+      end
+
+      def release_date
+        node = @document.at_xpath("//b[.='Release Date:']")
+        node && Date.parse(node.next.content)
+      end
+
+      def genres
+        @document.css("div.glance_details").css("a").map {|node| node.content}
+      end
+
+      def developer
+        App.content_or_nil @document.at_xpath("//a[contains(@href, 'developer')]")
+      end
+
+      def publisher
+        App.content_or_nil @document.at_xpath("//a[contains(@href, 'publisher')]")
+      end
+
+      def offers
+        @offers ||= AppOffers.new @document.css("div.game_area_purchase_game")
+      end
+
+      def dlc?
+        @document.at_css("div.game_area_dlc_bubble")
+      end
+
+      def indie?
+        genres.include? 'Indie'
+      end
+
+      def price
+        return nil if free?
+        first_offer_price
+      end
+
+      def free?
+        offers.count == 0
+      end
+
+      private
+
+      def first_offer_price
+        offers.first.price
+      end
+
+      def self.content_or_nil(item)
+        item && item.content
+      end
+
+      def score_section
+        @document.xpath("//div[@id='game_area_metascore']")
+      end
+
+      def score_from_score_section
+        score_section[0].content.gsub(/[^0-9]/,'').to_i
+      end
+    end
+  end
+end