steam-condenser 0.10.1 → 0.11.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
 :major: 0
-:minor: 10
-:patch: 1
+:minor: 11
+:patch: 0

data/lib/datagram_channel.rb

@@ -1,71 +1,68 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
 require 'ipaddr'
 require 'socket'
 
-require 'byte_buffer'
+require 'stringio_additions'
 
 class DatagramChannel
-  
+
   attr_reader :socket
-  
+
   def self.open
-    return DatagramChannel.new
+    DatagramChannel.new
   end
-  
+
   def close
     @socket.close
   end
-  
+
   def connect(*args)
     if args[0].is_a? IPAddr
       ip_address = args[0].to_s
     elsif args[0].is_a? String
       sockaddr = (Socket.gethostbyname args[0])[3]
       ip_address = "#{sockaddr[0]}.#{sockaddr[1]}.#{sockaddr[2]}.#{sockaddr[3]}"
+    else
+      raise ArgumentError
     end
-    
+
     if args[1].is_a? Numeric
       port_number = args[1]
     else
       port_number = args[1].to_i
     end
-    
+
     @socket.connect ip_address, port_number
-    
-    return self
+
+    self
   end
-  
+
   def configure_blocking(do_block)
   end
-  
-  def read(destination_buffer)
-    if !destination_buffer.is_a? ByteBuffer
-      raise ArgumentError
-    end
-    
-    length = destination_buffer.remaining
-    data = @socket.recv length
-    destination_buffer.put data
-    
-    return data.length
+
+  def read(destination_io)
+    raise ArgumentError unless destination_io.is_a? StringIO
+
+    data = @socket.recv destination_io.remaining
+    length = destination_io.write data
+    destination_io.truncate length
   end
-  
-  def write(source_buffer)
-    if !source_buffer.is_a? ByteBuffer
-      raise ArgumentError
-    end
-    
-    return @socket.send(source_buffer.get, 0)
+
+  def write(source_io)
+    raise ArgumentError unless source_io.is_a? StringIO
+
+    @socket.send(source_io.get, 0)
   end
-  
+
   protected
-  
+
   def initialize
     @socket = UDPSocket.new
-    self.configure_blocking true
+    configure_blocking true
   end
+
 end

data/lib/exceptions/packet_format_exception.rb

@@ -1,10 +1,14 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-require "exceptions/steam_condenser_exception"
+require 'exceptions/steam_condenser_exception'
 
 class PacketFormatException < SteamCondenserException
 
-end
+  def initialize
+    super 'The packet data received doesn\'t match the packet format.'
+  end
+
+end

data/lib/exceptions/rcon_ban_exception.rb

@@ -1,12 +1,14 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2009, Sebastian Staudt
+# Copyright (c) 2009-2010, Sebastian Staudt
+
+require 'exceptions/steam_condenser_exception'
+
+class RCONBanException < SteamCondenserException
 
-class RCONBanException < Exception
-  
   def initialize
     super 'You have been banned from this server.'
   end
-  
-end
+
+end

data/lib/exceptions/rcon_no_auth_exception.rb

@@ -1,12 +1,14 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
+
+require 'exceptions/steam_condenser_exception'
+
+class RCONNoAuthException < SteamCondenserException
 
-class RCONNoAuthException < Exception
-  
   def initialize
-    super "Not authenticated yet."
+    super 'Not authenticated yet.'
   end
-  
-end
+
+end

data/lib/exceptions/timeout_exception.rb

@@ -1,8 +1,14 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
-class TimeoutException < StandardError
-  
-end
+require 'exceptions/steam_condenser_exception'
+
+class TimeoutException < SteamCondenserException
+
+  def initialize
+    super 'The operation timed out.'
+  end
+
+end

data/lib/socket_channel.rb

@@ -1,20 +1,20 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
 require 'ipaddr'
 require 'socket'
 require 'timeout'
 
-require 'byte_buffer'
+require 'stringio_additions'
 
 class SocketChannel
 
   attr_reader :socket
 
   def self.open
-    return SocketChannel.new
+    SocketChannel.new
   end
 
   def close
@@ -27,7 +27,7 @@ class SocketChannel
       @connected = true
     end
 
-    return self
+    self
   end
 
   def initialize
@@ -35,27 +35,21 @@ class SocketChannel
   end
 
   def connected?
-    return @connected
+    @connected
   end
 
   def read(destination_buffer)
-    if !destination_buffer.is_a? ByteBuffer
-      raise ArgumentError
-    end
-
-    length = destination_buffer.remaining
-    data = @socket.recv length
-    destination_buffer.put data
+    raise ArgumentError unless destination_buffer.is_a? StringIO
 
-    return data.length
+    data = @socket.recv destination_buffer.remaining
+    length = destination_buffer.write data
+    destination_buffer.truncate length
   end
 
   def write(source_buffer)
-    if !source_buffer.is_a? ByteBuffer
-      raise ArgumentError
-    end
+    raise ArgumentError unless source_buffer.is_a? StringIO
 
-    return @socket.send(source_buffer.get, 0)
+    @socket.send(source_buffer.get, 0)
   end
 
 end

data/lib/steam/community/cacheable.rb

@@ -30,9 +30,7 @@ module Cacheable
 
     # Returns whether the requested object +id+ is already cached
     def cached?(id)
-      if id.is_a? String
-        id.downcase!
-      end
+      id.downcase! if id.is_a? String
       class_variable_get(:@@cache).key?(id)
     end
 
@@ -59,11 +57,11 @@ module Cacheable
   attr_reader :fetch_time
 
   # Creates a new object for the given +id+, either numeric or
-  # the custom URL specified by the user. If +fetch+ is +true+ (default),
+  # the custom URL specified by the user. If +fetch_now+ is +true+ (default),
   # fetch is used to load data into the object.
   # This method is overridden by Cacheable::ClassMethods#new.
-  def initialize(fetch = true) #:notnew:
-    self.fetch if fetch
+  def initialize(fetch_now = true) #:notnew:
+    fetch if fetch_now
     cache
   end
 
@@ -91,5 +89,5 @@ module Cacheable
   def fetched?
     !@fetch_time.nil?
   end
-    
+
 end

data/lib/steam/community/css/css_map.rb

@@ -0,0 +1,31 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+# CSSMap holds statistical information about maps played by a player in
+# Counter-Strike: Source.
+class CSSMap
+
+  attr_reader :name, :rounds_lost, :rounds_played, :rounds_won,
+              :rounds_won_percentage
+
+  # Creates a new instance of CSSMap based on the assigned map name and XML
+  # data
+  def initialize(map_name, maps_data)
+    @name          = map_name
+
+    @favorite      = (maps_data.elements['favorite'].text == @name)
+    @rounds_played = maps_data.elements["#{@name}_rounds"].text.to_i
+    @rounds_won    = maps_data.elements["#{@name}_wins"].text.to_i
+
+    @rounds_lost = @rounds_played - @rounds_won
+    @rounds_won_percentage = (@rounds_played > 0) ? @rounds_won.to_f / @rounds_played : 0
+  end
+
+  # Returns whether this map is the favorite map of this player
+  def favorite?
+    @favorite
+  end
+
+end

data/lib/steam/community/css/css_stats.rb

@@ -0,0 +1,116 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+require 'steam/community/css/css_map'
+require 'steam/community/css/css_weapon'
+
+# The CSSStats class represents the game statistics for a single user in
+# Counter-Strike: Source
+class CSSStats < GameStats
+
+  MAPS = [ 'cs_assault', 'cs_compound', 'cs_havana', 'cs_italy', 'cs_militia',
+           'cs_office', 'de_aztec', 'de_cbble', 'de_chateau', 'de_dust',
+           'de_dust2', 'de_inferno', 'de_nuke', 'de_piranesi', 'de_port',
+           'de_prodigy', 'de_tides', 'de_train' ]
+
+  WEAPONS = [ 'deagle', 'usp', 'glock', 'p228', 'elite', 'fiveseven', 'awp',
+              'ak47', 'm4a1', 'aug', 'sg552', 'sg550', 'galil', 'famas',
+              'scout', 'g3sg1', 'p90', 'mp5navy', 'tmp', 'mac10', 'ump45',
+              'm3', 'xm1014', 'm249', 'knife', 'grenade' ]
+
+  attr_reader :last_match_stats, :total_stats
+
+  # Creates a CSSStats object by calling the super constructor with the game
+  # name "cs:s"
+  def initialize(steam_id)
+    super steam_id, 'cs:s'
+
+    if public?
+      @last_match_stats = {}
+      @total_stats      = {}
+
+      @last_match_stats[:cost_per_kill]   = @xml_data.elements['stats/lastmatch/costkill'].text.to_f
+      @last_match_stats[:ct_wins]         = @xml_data.elements['stats/lastmatch/ct_wins'].text.to_i
+      @last_match_stats[:damage]          = @xml_data.elements['stats/lastmatch/dmg'].text.to_i
+      @last_match_stats[:deaths]          = @xml_data.elements['stats/lastmatch/deaths'].text.to_i
+      @last_match_stats[:dominations]     = @xml_data.elements['stats/lastmatch/dominations'].text.to_i
+      @last_match_stats[:favorite_weapon] = @xml_data.elements['stats/lastmatch/favwpn'].text
+      @last_match_stats[:kills]           = @xml_data.elements['stats/lastmatch/kills'].text.to_i
+      @last_match_stats[:max_players]     = @xml_data.elements['stats/lastmatch/max_players'].text.to_i
+      @last_match_stats[:money]           = @xml_data.elements['stats/lastmatch/money'].text.to_i
+      @last_match_stats[:revenges]        = @xml_data.elements['stats/lastmatch/revenges'].text.to_i
+      @last_match_stats[:stars]           = @xml_data.elements['stats/lastmatch/stars'].text.to_i
+      @last_match_stats[:t_wins]          = @xml_data.elements['stats/lastmatch/t_wins'].text.to_i
+      @last_match_stats[:wins]            = @xml_data.elements['stats/lastmatch/wins'].text.to_i
+      @total_stats[:blind_kills]          = @xml_data.elements['stats/lifetime/blindkills'].text.to_i
+      @total_stats[:bombs_defused]        = @xml_data.elements['stats/lifetime/bombsdefused'].text.to_i
+      @total_stats[:bombs_planted]        = @xml_data.elements['stats/lifetime/bombsplanted'].text.to_i
+      @total_stats[:damage]               = @xml_data.elements['stats/lifetime/dmg'].text.to_i
+      @total_stats[:deaths]               = @xml_data.elements['stats/summary/deaths'].text.to_i
+      @total_stats[:domination_overkills] = @xml_data.elements['stats/lifetime/dominationoverkills'].text.to_i
+      @total_stats[:dominations]          = @xml_data.elements['stats/lifetime/dominations'].text.to_i
+      @total_stats[:earned_money]         = @xml_data.elements['stats/lifetime/money'].text.to_i
+      @total_stats[:enemy_weapon_kills]   = @xml_data.elements['stats/lifetime/enemywpnkills'].text.to_i
+      @total_stats[:headshots]            = @xml_data.elements['stats/lifetime/headshots'].text.to_i
+      @total_stats[:hits]                 = @xml_data.elements['stats/summary/shotshit'].text.to_i
+      @total_stats[:hostages_rescued]     = @xml_data.elements['stats/lifetime/hostagesrescued'].text.to_i
+      @total_stats[:kills]                = @xml_data.elements['stats/summary/kills'].text.to_i
+      @total_stats[:knife_kills]          = @xml_data.elements['stats/lifetime/knifekills'].text.to_i
+      @total_stats[:logos_sprayed]        = @xml_data.elements['stats/lifetime/decals'].text.to_i
+      @total_stats[:nightvision_damage]   = @xml_data.elements['stats/lifetime/nvgdmg'].text.to_i
+      @total_stats[:pistol_rounds_won]    = @xml_data.elements['stats/lifetime/pistolrounds'].text.to_i
+      @total_stats[:revenges]             = @xml_data.elements['stats/lifetime/revenges'].text.to_i
+      @total_stats[:rounds_played]        = @xml_data.elements['stats/summary/rounds'].text.to_i
+      @total_stats[:rounds_won]           = @xml_data.elements['stats/summary/wins'].text.to_i
+      @total_stats[:seconds_played]       = @xml_data.elements['stats/summary/timeplayed'].text.to_i
+      @total_stats[:shots]                = @xml_data.elements['stats/summary/shots'].text.to_i
+      @total_stats[:stars]                = @xml_data.elements['stats/summary/stars'].text.to_i
+      @total_stats[:weapons_donated]      = @xml_data.elements['stats/lifetime/wpndonated'].text.to_i
+      @total_stats[:windows_broken]       = @xml_data.elements['stats/lifetime/winbroken'].text.to_i
+      @total_stats[:zoomed_sniper_kills]  = @xml_data.elements['stats/lifetime/zsniperkills'].text.to_i
+
+      @last_match_stats[:kdratio] = @last_match_stats[:kills].to_f / @last_match_stats[:deaths]
+      @total_stats[:accuracy]     = @total_stats[:hits].to_f / @total_stats[:shots]
+      @total_stats[:kdratio]      = @total_stats[:kills].to_f / @total_stats[:deaths]
+      @total_stats[:rounds_lost]  = @total_stats[:rounds_played] - @total_stats[:rounds_won]
+    end
+  end
+
+  # Returns a Hash of CSSMap for this user containing all Counter-Strike:
+  # Source maps. If the maps haven't been parsed already, parsing is done now.
+  def map_stats
+    return unless public?
+
+    if @map_stats.nil?
+      @map_stats = {}
+      maps_data = @xml_data.elements['stats/maps']
+
+      MAPS.each do |map_name|
+        @map_stats[map_name] = CSSMap.new(map_name, maps_data)
+      end
+    end
+
+    @map_stats
+  end
+
+  # Returns a Hash of CSSWeapon for this user containing all Counter-Strike:
+  # Source weapons. If the weapons haven't been parsed already, parsing is done
+  # now.
+  def weapon_stats
+    return unless public?
+
+    if @weapon_stats.nil?
+      @weapon_stats = {}
+      weapons_data = @xml_data.elements['stats/weapons']
+
+      WEAPONS.each do |weapon_name|
+        @weapon_stats[weapon_name] = CSSWeapon.new(weapon_name, weapons_data)
+      end
+    end
+
+    @weapon_stats
+  end
+
+end

data/lib/steam/community/css/css_weapon.rb

@@ -0,0 +1,33 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+# CSSWeapon holds statistical information about weapons used by a player in
+# Counter-Strike: Source.
+class CSSWeapon
+
+  attr_reader :accuracy, :hits, :name, :kills, :ksratio, :shots
+
+  # Creates a new instance of CSSWeapon based on the assigned weapon name and
+  # XML data
+  def initialize(weapon_name, weapons_data)
+    @name     = weapon_name
+
+    @favorite = (weapons_data.elements['favorite'].text == @name)
+    @kills    = weapons_data.elements["#{@name}_kills"].text.to_i
+
+    if @name != 'grenade' && @name != 'knife'
+      @hits     = weapons_data.elements["#{@name}_hits"].text.to_i
+      @shots    = weapons_data.elements["#{@name}_shots"].text.to_i
+      @accuracy = (@shots > 0) ? @hits.to_f / @shots : 0
+      @ksratio  = (@shots > 0) ? @kills.to_f / @shots : 0
+    end
+  end
+
+  # Returns whether this weapon is the favorite weapon of this player
+  def favorite?
+    @favorite
+  end
+
+end