steam_community 0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Marty Zalega [http://github.com/evilmarty]
+
+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.rdoc

@@ -0,0 +1,27 @@
+==Steam
+
+A ruby library to access the Steam Community. Lookup player profile information such as games, achievements and friends.
+
+==Installation
+
+  git clone git://github.com/evilmarty/steam.git
+  
+==Usage
+
+To get player by name:
+
+  player = Steam::Profile.find 'player name'
+  
+Or if you know the steam id of the player
+
+  player = Steam::Profile.find :id => 1234567890
+
+
+==To Do
+
+* Make into gem.
+* Support logging into profile to fetch private information.
+* Write tests :-p
+
+
+This library is in no way affiliated with Valve Software or Steam.

data/lib/steam.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'active_support/inflector'
+require 'httparty'
+
+module Steam
+  autoload :Base, File.join(File.dirname(__FILE__), 'steam', 'base.rb')
+  autoload :Profile, File.join(File.dirname(__FILE__), 'steam', 'profile.rb')
+  autoload :Game, File.join(File.dirname(__FILE__), 'steam', 'game.rb')
+  autoload :Achievement, File.join(File.dirname(__FILE__), 'steam', 'achievement.rb')
+end

data/lib/steam/achievement.rb

@@ -0,0 +1,42 @@
+module Steam
+  class Achievement < Base
+    include HTTParty
+    base_uri 'http://steamcommunity.com'
+    default_params :xml => 1
+    format :xml
+    
+    attr_reader :game
+    
+    def completed?
+      @closed == '1'
+    end
+    
+    def unlocked_at
+      Time.at @unlock_timestamp if @unlock_timestamp
+    end
+    
+    def to_s
+      name
+    end
+    
+    class << self
+      def find_all game, options = {}
+        data = get game.stats_link, options
+        
+        if data['playerstats'] && data['playerstats']['achievements'] && data['playerstats']['achievements']['achievement']
+          data['playerstats']['achievements']['achievement'].map do |achievement_data|
+            new game, achievement_data
+          end
+        else
+          []
+        end
+      end
+    end
+    
+  private
+    def initialize game, data
+      @game = game
+      build_attributes data
+    end
+  end
+end

data/lib/steam/base.rb

@@ -0,0 +1,59 @@
+module Steam
+  class Base
+    def attribute_names
+      @attribute_names
+    end
+    
+    def attributes
+      attribute_names.inject({}) do |attributes, name|
+        attributes.merge name => instance_variable_get("@#{name}")
+      end
+    end
+    
+    def inspect
+      inspected_attributes = if @built_attributes
+        attributes.map do |key, value|
+          " #{key}=#{value.inspect}"
+        end.join
+      else
+        ''
+      end
+      
+      "#<#{self.class.name}:#{__id__}#{inspected_attributes}>"
+    end
+    
+  private
+    def build_attributes attributes
+      return if @built_attributes
+      
+      @attribute_names ||= []
+      
+      attributes.each_pair do |key, value|
+        next if value.is_a?(Hash) or value.is_a?(Array)
+        
+        key = key.underscore
+        
+        @attribute_names << key unless @attribute_names.include? key
+        set_attribute key, value
+        
+        unless respond_to? key
+          instance_eval <<-EOT
+            def #{key}
+              @#{key}
+            end
+          EOT
+        end
+      end
+      
+      @built_attributes = true
+    end
+    
+    def set_attribute name, value
+      if respond_to? "#{name}="
+        send "#{name}=", value
+      elsif @attribute_names.include? name
+        instance_variable_set "@#{name}", value
+      end
+    end
+  end
+end

data/lib/steam/game.rb

@@ -0,0 +1,53 @@
+module Steam
+  class Game < Base
+    include HTTParty
+    base_uri 'http://steamcommunity.com'
+    default_params :xml => 1
+    format :xml
+    
+    attr_reader :profile, :id, :name
+    
+    def has_achievements?
+      !@stats_link.nil?
+    end
+    
+    def achievements reload = false
+      return [] unless has_achievements?
+      
+      if reload or @achievements.nil?
+        @achievements = Achievement.find_all self, @request_options
+      end
+      
+      @achievements
+    end
+    
+    def to_s
+      name
+    end
+    
+    class << self
+      def find_all profile, options = {}
+        base_uri profile.url
+        data = get '/games', options
+        
+        if data['gamesList'] && data['gamesList']['games'] && data['gamesList']['games']['game']
+          data['gamesList']['games']['game'].map do |game_data|
+            new profile, game_data, options
+          end
+        else
+          []
+        end
+      end
+    end
+    
+  private
+    def initialize profile, data, request_options
+      @profile = profile
+      @id = data.delete 'appID'
+      @name = data.delete 'name'
+      @request_options = request_options
+      
+      build_attributes data
+    end
+  end
+end

data/lib/steam/profile.rb

@@ -0,0 +1,168 @@
+module Steam
+  class InvalidLogin < Exception; end
+  
+  class ProfileNotFound < Exception
+    attr_reader :id
+    
+    def initialize id
+      @id = id
+      @message = "Steam profile for '#{@id}' not found"
+    end
+    
+    def to_s
+      @message
+    end
+  end
+  
+  class Profile < Base
+    CUSTOM_URL_URI = 'http://steamcommunity.com/id'
+    PROFILE_URI = 'http://steamcommunity.com/profiles'
+    LOGIN_URL = 'https://steamcommunity.com/'
+    
+    VISIBILITY_STATES = [nil, :private, :friends, :public]
+    DEFAULT_AVATAR_SIZE = :icon
+    
+    include HTTParty
+    base_uri CUSTOM_URL_URI
+    default_params :xml => 1
+    format :xml
+    
+    attr_reader :id, :steam_id, :friends
+    
+    def logged_in?
+      !@steam_login.nil?
+    end
+    
+    def online?
+      @online_state == 'online'
+    end
+    
+    def banned?
+      @vac_banned == '1'
+    end
+    
+    def private?
+      @privacy_state == 'private'
+    end
+    
+    def limited_account?
+      @is_limited_account == '1'
+    end
+    
+    def loaded?
+      @loaded
+    end
+    
+    def visibility
+      VISIBILITY_STATES[@visibility_state]
+    end
+    
+    def avatar size = DEFAULT_AVATAR_SIZE
+      unless respond_to? "avatar_#{size}"
+        size = DEFAULT_AVATAR_SIZE
+      end
+      
+      send "avatar_#{size}"
+    end
+    
+    def url
+      @custom_url ? "#{CUSTOM_URL_URI}/#{custom_url}" : "#{PROFILE_URI}/#{steam_id}"
+    end
+    
+    def games reload = false
+      if reload or @games.nil?
+        @games = Game.find_all self, :cookies => cookies
+      end
+      
+      @games
+    end
+    
+    def reload!
+      @loaded = false
+      
+      profile = unless custom_url.blank?
+        self.class.find custom_url
+      else
+        self.class.find :id => steam_id
+      end
+      
+      @built_attributes = false
+      build_attributes profile.attributes
+    end
+    
+    def to_s
+      @id
+    end
+    
+    def == profile
+      steam_id == profile.steam_id
+    end
+    
+    class << self
+      def find id, options = {}
+        if id.is_a? Hash
+          options = id
+          id = options.delete :id
+          base_uri PROFILE_URI
+        else
+          base_uri CUSTOM_URL_URI
+        end
+        
+        data = get("/#{id}", options)['profile']
+        
+        unless data.nil?
+          new(data)
+        else
+          raise ProfileNotFound.new(id)
+        end
+      end
+      
+      def login username, password
+        request = HTTParty::Request.new Net::HTTP::Post, LOGIN_URL, :body => {:steamAccountName => username, :steamPassword => password, :action => 'doLogin'}, :format => :html
+        response = request.perform
+        
+        cookies = HTTParty::CookieHash.new
+        cookies.add_cookies request.options[:headers]['Cookie'] if request.options[:headers] && request.options[:headers]['Cookie']
+        
+        if cookies.has_key? :steamLogin
+          find(username, :cookies => cookies).tap do |profile|
+            profile.send :steam_login=, cookies[:steamLogin]
+          end
+        else
+          raise InvalidLogin.new("Invalid login for '#{username}'")
+        end
+      end
+    end
+    
+  private
+    def initialize data
+      @id = data.delete 'steamID'
+      @steam_id = data.delete 'steamID64'
+      
+      build_attributes data
+      
+      @friends = []
+      if !data['friends'].nil? and !data['friends']['friend'].nil?
+        data['friends']['friend'].each do |friend_data|
+          @friends << self.class.new(friend_data).tap do |friend|
+            friend.send :loaded=, false
+          end
+        end
+      end
+      
+      @loaded = true
+    end
+    
+    def loaded= value
+      @loaded = value
+    end
+    
+    def steam_login= value
+      @steam_login = value
+    end
+    
+    def cookies
+      @steam_login ? {'steamLogin' => @steam_login} : {}
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join('..', 'lib', 'steam.rb')

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: steam_community
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Marty Zalega
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-05 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id002
+description: Lookup steam player profile information such as games, achievements and friends.
+email: evil.marty@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/steam/achievement.rb
+- lib/steam/base.rb
+- lib/steam/game.rb
+- lib/steam/profile.rb
+- lib/steam.rb
+- LICENSE
+- rails/init.rb
+- README.rdoc
+has_rdoc: true
+homepage: https://github.com/evilmarty/steam
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Lookup steam player profile information such as games, achievements and friends.
+test_files: []
+