steam-condenser 0.8.0 → 0.9.0

data/Rakefile

@@ -13,15 +13,18 @@ test_files = Dir.glob(File.join("test", "**", "*.rb"))
 
 # Gem specification
 Jeweler::Tasks.new do |s|
-  s.name = "steam-condenser"
-  s.date = Time.now
-  s.description = s.summary = 'A multi-language library for querying Source, GoldSrc servers and Steam master servers'
   s.authors = ['Sebastian Staudt']
   s.email = 'koraktor@gmail.com'
-  s.homepage = 'http://github.com/koraktor/steam-condenser'
-  
-  s.files = %w(README.md Rakefile LICENSE) + src_files + test_files
+  s.description = 'A multi-language library for querying the Steam Community, Source, GoldSrc servers and Steam master servers'
+  s.date = Time.now
+  s.homepage = 'http://koraktor.github.com/steam-condenser'
+  s.name = s.rubyforge_project = "steam-condenser"
+  s.summary = 'Steam Condenser - A Steam query library'
+
+  s.files = %w(README.md Rakefile LICENSE VERSION.yml) + src_files + test_files
   s.rdoc_options = ["--all", "--inline-source", "--line-numbers", "--charset=utf-8", "--webcvs=http://github.com/koraktor/steam-condenser/source/blob/master/ruby/%s"]
+
+  s.add_dependency('hpricot', '>= 0.6')
 end
 
 # Create a rake task +:rdoc+ to build the documentation
@@ -31,7 +34,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include ["lib/**/*.rb", "test/**/*.rb", "LICENSE", "README.md"]
   rdoc.main = "README.md"
   rdoc.rdoc_dir = "rdoc"
-  rdoc.options = ["--all", "--inline-source", "--line-numbers", "--charset=utf-8", "--webcvs=http://github.com/koraktor/steam-condenser/source/blob/master/ruby/%s"]
+  rdoc.options = ["--all", "--inline-source", "--line-numbers", "--charset=utf-8", "--webcvs=http://github.com/koraktor/steam-condenser/blob/master/ruby/%s"]
 end
 
 # Task for cleaning documentation and package directories

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 9
+:patch: 0

data/lib/byte_buffer.rb

@@ -1,7 +1,7 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008, Sebastian Staudt
+# Copyright (c) 2008-2009, Sebastian Staudt
 
 require "exceptions/buffer_underflow_exception"
 
@@ -11,71 +11,71 @@ class ByteBuffer
   attr_accessor :limit
   attr_reader :position
   protected :initialize
-  
+
   # Creates a new buffer with the given size in bytes
   def self.allocate(length)
     return ByteBuffer.new(0.chr * length)
   end
-  
-  # Creates a new buffer from an existing String  
+
+  # Creates a new buffer from an existing String
   def self.wrap(byte_array)
     return ByteBuffer.new(byte_array.to_s)
   end
-  
-  # 
+
+  #
   def initialize(byte_array)
     if byte_array.is_a? ByteBuffer
       raise Exception.new
     end
-    
+
     @byte_array = byte_array.to_s
     @capacity = @byte_array.length
     @limit = @capacity
     @position = 0
     @mark = -1
   end
-  
+
   def array
     return @byte_array
   end
-  
+
   def clear
     @limit = @capacity
     @position = 0
     @mark = -1
-    
+
     return self
   end
-  
+
   def flip
     @limit = @position
     @position = 0
     @mark = -1
-    
+
     return self
   end
-  
+
   def get(length = nil)
     if length == nil
       length = @limit - @position
     elsif length > self.remaining
       BufferUnderflowException.new
     end
-    
+
     data = @byte_array[@position, length]
     @position += length
-    
+
     return data
   end
-  
+
   def get_byte
     return self.get(1)[0]
   end
-  
+
   def get_float
     return self.get(4).unpack("e")[0]
   end
-  
+
   def get_long
     return self.get(4).unpack("V")[0]
   end
@@ -87,39 +87,39 @@ class ByteBuffer
   def get_signed_long
     return self.get(4).unpack('l')[0]
   end
-  
+
   def get_string
     zero_byte_index = @byte_array.index("\0", @position)
     if zero_byte_index == nil
-      return ""
+      nil
     else
       data_string = self.get(zero_byte_index - @position)
-      @position += 1    
-      return data_string
+      @position += 1
+      data_string
     end
   end
-  
+
   def length
     return @byte_array.length
   end
-  
+
   def remaining
     return @limit - @position
   end
-  
+
   def rewind
     @position = 0
     @mark = -1
-    
+
     return self
   end
-  
+
   def put(source_byte_array)
     new_position = [source_byte_array.length, self.remaining].min
 
     @byte_array[@position, new_position] = source_byte_array
     @position = new_position
-    
+
     return self
   end
 

data/lib/datagram_channel.rb

@@ -1,11 +1,12 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008, Sebastian Staudt
-#
-# $Id$
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require 'ipaddr'
+require 'socket'
 
-require "byte_buffer"
+require 'byte_buffer'
 
 class DatagramChannel
   

data/lib/exceptions/rcon_ban_exception.rb

@@ -0,0 +1,12 @@
+# 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
+
+class RCONBanException < Exception
+  
+  def initialize
+    super 'You have been banned from this server.'
+  end
+  
+end

data/lib/socket_channel.rb

@@ -3,52 +3,59 @@
 #
 # Copyright (c) 2008-2009, Sebastian Staudt
 
-require 'byte_buffer'
+require 'ipaddr'
+require 'socket'
 require 'timeout'
 
+require 'byte_buffer'
+
 class SocketChannel
-  
+
   attr_reader :socket
-  
+
   def self.open
     return SocketChannel.new
   end
-  
+
+  def close
+    @socket.close
+  end
+
   def connect(*args)
     timeout(1) do
       @socket = TCPSocket.new args[0][0][3], args[0][0][1]
       @connected = true
     end
-    
+
     return self
   end
-  
+
   def initialize
     @connected = false
   end
-  
+
   def connected?
     return @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
-    
+
     return data.length
   end
-  
+
   def write(source_buffer)
     if !source_buffer.is_a? ByteBuffer
       raise ArgumentError
     end
-    
+
     return @socket.send(source_buffer.get, 0)
   end
-  
-end
+
+end

data/lib/steam-condenser.rb

@@ -1,3 +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
+
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
+module SteamCondenser
+
+  version = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'VERSION.yml'))
+  VERSION = "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
+
+end

data/lib/steam/community/cacheable.rb

@@ -0,0 +1,95 @@
+# 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
+
+# This module implements caching functionality to be used in any object using a
+# +fetch+ method to fetch data, e.g. using a HTTP download.
+module Cacheable
+
+  def self.included(base) #:nodoc:
+
+    base.extend ClassMethods
+    base.class_eval 'class_variable_set :@@cache, {}'
+    base.class_eval 'class_variable_set :@@cache_ids, {}'
+
+    class << base
+      alias_method :create, :new
+    end
+
+  end
+
+  module ClassMethods
+
+    # Defines wich instance variables should be used to index the cached objects
+    # A call to this method is needed, if you want a class including this module
+    # to really use the cache.
+    def cacheable_with_ids(*ids)
+      class_variable_set(:@@cache_ids, ids)
+    end
+
+    # Returns whether the requested object +id+ is already cached
+    def cached?(id)
+      if id.is_a? String
+        id.downcase!
+      end
+      class_variable_get(:@@cache).key?(id)
+    end
+
+    # Clears the object cache
+    def clear_cache
+      class_variable_set :@@cache, {}
+    end
+
+    # This checks the cache for an existing object. If it exists it is returned.
+    # Otherwise a new object is created.
+    # Overrides the default constructor.
+    def new(id, fetch = true, bypass_cache = false)
+      if cached?(id) and !bypass_cache
+        object = class_variable_get(:@@cache)[id]
+        object.fetch_data if fetch and !object.fetched?
+        object
+      else
+        super(id, fetch)
+      end
+    end
+
+  end
+
+  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),
+  # 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
+    cache
+  end
+
+  # Saves this object in the cache
+  def cache
+    cache     = self.class.class_eval 'class_variable_get :@@cache'
+    cache_ids = self.class.class_eval 'class_variable_get :@@cache_ids'
+
+    cache_ids.each do |cache_id|
+      cache_id_value = instance_variable_get('@' + cache_id.to_s)
+      unless cache_id_value.nil? or cache.key?(cache_id_value)
+        cache[cache_id_value] = self
+      end
+    end
+
+    true
+  end
+
+  # Sets the time this object has been fetched the last time
+  def fetch
+    @fetch_time = Time.now
+  end
+
+  # Returns whether the data for this SteamID has already been fetched
+  def fetched?
+    !@fetch_time.nil?
+  end
+    
+end

data/lib/steam/community/defense_grid/defense_grid_stats.rb

@@ -0,0 +1,124 @@
+# 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
+
+require 'steam/community/game_stats'
+
+# The DefenseGridStats class represents the game statistics for a single user in
+# Defense Grid: The Awakening
+class DefenseGridStats < GameStats
+
+  attr_reader :bronze_medals, :damage_done, :damage_campaign, :damage_challenge,
+              :encountered, :gold_medals, :heat_damage, :interest, :killed,
+              :killed_campaign, :killed_challenge,  :levels_played,
+              :levels_played_campaign, :levels_played_challenge, :levels_won,
+              :levels_won_campaign, :levels_won_challenge, :orbital_laser_fired,
+              :orbital_laser_damage, :resources, :silver_medals, :time_played
+
+  # Creates a DefenseGridStats object by calling the super constructor with the
+  # game name "defensegrid:awakening"
+  def initialize(steam_id)
+    super(steam_id, 'defensegrid:awakening')
+
+    if public?
+      general_data = @xml_data.elements['stats/general']
+
+      @bronze_medals           = general_data.elements['bronze_medals_won/value'].text.to_i
+      @silver_medals           = general_data.elements['silver_medals_won/value'].text.to_i
+      @gold_medals             = general_data.elements['gold_medals_won/value'].text.to_i
+      @levels_played           = general_data.elements['levels_played_total/value'].text.to_i
+      @levels_played_campagin  = general_data.elements['levels_played_campaign/value'].text.to_i
+      @levels_played_challenge = general_data.elements['levels_played_challenge/value'].text.to_i
+      @levels_won              = general_data.elements['levels_won_total/value'].text.to_i
+      @levels_won_campaign     = general_data.elements['levels_won_campaign/value'].text.to_i
+      @levels_won_challenge    = general_data.elements['levels_won_challenge/value'].text.to_i
+      @encountered             = general_data.elements['total_aliens_encountered/value'].text.to_i
+      @killed                  = general_data.elements['total_aliens_killed/value'].text.to_i
+      @killed_campaign         = general_data.elements['total_aliens_killed_campaign/value'].text.to_i
+      @killed_challenge        = general_data.elements['total_aliens_killed_challenge/value'].text.to_i
+      @resources               = general_data.elements['resources_recovered/value'].text.to_i
+      @heat_damage             = general_data.elements['heatdamage/value'].text.to_f
+      @time_played             = general_data.elements['time_played/value'].text.to_f
+      @interest                = general_data.elements['interest_gained/value'].text.to_f
+      @damage                  = general_data.elements['tower_damage_total/value'].text.to_f
+      @damage_campaign         = general_data.elements['tower_damage_total_campaign/value'].text.to_f
+      @damage_challenge        = general_data.elements['tower_damage_total_challenge/value'].text.to_f
+      @orbital_laser_fired     = @xml_data.elements['stats/orbitallaser/fired/value'].text.to_i
+      @orbital_laser_damage    = @xml_data.elements['stats/orbitallaser/damage/value'].text.to_f
+    end
+  end
+
+  # Returns stats about the towers built
+  #
+  # The Hash returned uses the names of the aliens as keys. Every value of the
+  # Hash is an Array containing the number of aliens encountered as the first
+  # element and the number of aliens killed as the second element.
+  def alien_stats
+    return unless public?
+
+    if @alien_stats.nil?
+      alien_data = @xml_data.elements['stats/aliens']
+      @alien_stats = {}
+      aliens = %w{swarmer juggernaut crasher spire grunt bulwark drone manta dart
+                  decoy rumbler seeker turtle walker racer stealth}
+
+      aliens.each do |alien|
+        @alien_stats[alien] = [
+          alien_data.elements["#{alien}/encountered/value"].text.to_i,
+          alien_data.elements["#{alien}/killed/value"].text.to_i
+        ]
+      end
+    end
+
+    @alien_stats
+  end
+
+  # Returns stats about the towers built
+  #
+  # The Hash returned uses the names of the towers as keys. Every value of
+  # the Hash is another Hash using the keys 1 to 3 for different tower levels.
+  # The values of these Hash is an Array containing the number of towers built
+  # as the first element and the damage dealt by this specific tower type as the
+  # second element.
+  #
+  # The Command tower uses the resources gained as second element.
+  # The Temporal tower doesn't have a second element.
+  def tower_stats
+    return unless public?
+
+    if @tower_stats.nil?
+      tower_data = @xml_data.elements['stats/towers']
+      @tower_stats = {}
+      towers = %w{cannon flak gun inferno laser meteor missile tesla}
+
+      towers.each do |tower|
+        @tower_stats[tower] = {}
+        (1..3).each do |i|
+          @tower_stats[tower][i] = [
+            tower_data.elements["#{tower}[@level=#{i}]/built/value"].text.to_i,
+            tower_data.elements["#{tower}[@level=#{i}]/damage/value"].text.to_f
+          ]
+        end
+      end
+
+      @tower_stats['command'] = {}
+      (1..3).each do |i|
+        @tower_stats['command'][i] = [
+          tower_data.elements["command[@level=#{i}]/built/value"].text.to_i,
+          tower_data.elements["command[@level=#{i}]/resource/value"].text.to_f
+        ]
+      end
+
+      @tower_stats['temporal'] = {}
+      (1..3).each do |i|
+        @tower_stats['temporal'][i] = [
+          tower_data.elements["temporal[@level=#{i}]/built/value"].text.to_i,
+        ]
+      end
+    end
+
+    @tower_stats
+  end
+
+end