steam-condenser 0.11.1 → 0.11.2

data/README.md

@@ -9,13 +9,15 @@ Currently it is implemented in Java, PHP and Ruby.
 
 * Linux, MacOS X or Windows
 * Ruby 1.8.6 or newer
-* [Ruby BZ2 module](http://www.rubyforge.org/projects/bz2)
+
+  The following gems are required:
+  * `bzip2-ruby` (for Source servers sending compressed responses)
 
 ## License
 
 This code is free software; you can redistribute it and/or modify it under the
-terms of the new BSD License. A copy of this license can be found in the LICENSE
-file.
+terms of the new BSD License. A copy of this license can be found in the
+included LICENSE file.
 
 ## Credits
 
@@ -29,4 +31,5 @@ file.
 * [Google group](http://groups.google.com/group/steam-condenser)
 * [Ohloh profile](http://www.ohloh.net/projects/steam-condenser)
 
-Follow Steam Condenser on Twitter [@steamcondenser](http://twitter.com/steamcondenser).
+Follow Steam Condenser on Twitter
+[@steamcondenser](http://twitter.com/steamcondenser).

data/Rakefile

@@ -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-2009, Sebastian Staudt
+# Copyright (c) 2008-2010, Sebastian Staudt
 
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
@@ -23,13 +23,15 @@ Jeweler::Tasks.new do |s|
 
   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('bzip2-ruby', '>= 0.2')
 end
 
 # Create a rake task +:rdoc+ to build the documentation
 desc "Building docs"
 Rake::RDocTask.new do |rdoc|
   rdoc.title = "Steam Condenser documentation"
-  rdoc.rdoc_files.include ["lib/**/*.rb", "test/**/*.rb", "LICENSE", "README.md"]
+  rdoc.rdoc_files.include ["lib/**/*.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/blob/master/ruby/%s"]

data/VERSION.yml

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

data/lib/steam-condenser.rb

@@ -1,16 +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
-
-require 'yaml'
-
-libdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+# Copyright (c) 2009-2010, Sebastian Staudt
 
 module SteamCondenser
 
-  version = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'VERSION.yml'))
-  VERSION = "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
+  require 'steam-condenser/community'
+  require 'steam-condenser/servers'
+  require 'steam-condenser/version'
 
 end

data/lib/steam-condenser/community.rb

@@ -0,0 +1,16 @@
+# 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
+
+module SteamCondenser
+
+  require 'steam-condenser/version'
+
+  module Community
+
+    require 'steam/community/steam_id'
+
+  end
+
+end

data/lib/steam-condenser/servers.rb

@@ -0,0 +1,18 @@
+# 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
+
+module SteamCondenser
+
+  require 'steam-condenser/version'
+
+  module Servers
+
+    require 'steam/servers/goldsrc_server'
+    require 'steam/servers/master_server'
+    require 'steam/servers/source_server'
+
+  end
+
+end

data/lib/steam-condenser/version.rb

@@ -0,0 +1,13 @@
+# 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 'yaml'
+
+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/game_achievement.rb

@@ -1,26 +1,30 @@
 # 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
 
 # The GameAchievement class represents a specific achievement for a single game
 # and for a single user
 class GameAchievement
 
-  attr_reader :app_id, :name, :steam_id
-  
-  # Creates the achievement with the given name for the given user and game and
-  # marks it as already done if set to true
-  def initialize(steam_id, app_id, name, done)
-    @app_id   = app_id
-    @done     = done
-    @name     = name
-    @steam_id = steam_id
+  attr_reader :app_id, :name, :steam_id64, :timestamp
+
+  # Creates the achievement with the given name for the given user and game
+  # and achievement data
+  def initialize(steam_id64, app_id, achievement_data)
+    @app_id     = app_id
+    @name       = achievement_data.elements['name'].text
+    @steam_id64 = steam_id64
+    @unlocked   = (achievement_data.attributes['closed'].to_i == 1)
+
+    if @unlocked && !achievement_data.elements['unlockTimestamp'].nil?
+      @timestamp  = Time.at(achievement_data.elements['unlockTimestamp'].text.to_i)
+    end
   end
-  
-  # Returns whether this achievement has been done by its owner
-  def done?
-    @done
+
+  # Returns whether this achievement has been unlocked by its owner
+  def unlocked?
+    @unlocked
   end
-  
+
 end

data/lib/steam/community/game_stats.rb

@@ -59,11 +59,11 @@ class GameStats
 
     @privacy_state = @xml_data.elements['privacyState'].text
     if public?
-      @app_id             = @xml_data.elements['game/gameLink'].text.match(/http:\/\/store.steampowered.com\/app\/([1-9][0-9]+)/)[1]
-      @custom_url         = @xml_data.elements['player/customURL'].text if @custom_url.nil?
-      @game_name          = @xml_data.elements['game/gameName'].text
-      @hours_played       = @xml_data.elements['stats/hoursPlayed'].text
-      @steam_id64         = @xml_data.elements['player/steamID64'].text.to_i if @steam_id64.nil?
+      @app_id       = @xml_data.elements['game/gameLink'].text.match(/http:\/\/store.steampowered.com\/app\/([1-9][0-9]+)/)[1]
+      @custom_url   = @xml_data.elements['player/customURL'].text if @custom_url.nil?
+      @game_name    = @xml_data.elements['game/gameName'].text
+      @hours_played = @xml_data.elements['stats/hoursPlayed'].text
+      @steam_id64   = @xml_data.elements['player/steamID64'].text.to_i if @steam_id64.nil?
     end
   end
 
@@ -74,11 +74,11 @@ class GameStats
 
     if @achievements.nil?
       @achievements = Array.new
-      @xml_data.elements.each('achievements/achievement') do |achievement|
-        @achievements << GameAchievement.new(@steam_id, @app_id, achievement.elements['name'].text, (achievement.attributes['closed'].to_i == 1))
+      @xml_data.elements.each('achievements/achievement') do |achievement_data|
+        @achievements << GameAchievement.new(@steam_id64, @app_id, achievement_data)
       end
 
-      @achievements_done = @achievements.reject{ |a| !a.done? }.size
+      @achievements_done = @achievements.reject{ |a| !a.unlocked? }.size
     end
 
     @achievements
@@ -92,7 +92,7 @@ class GameStats
   end
 
   # Returns a float value representing the percentage of achievements done by
-  # this player.
+  # this player. If achievements haven't been parsed yet, parsing is done now.
   def achievements_percentage
     achievements_done.to_f / @achievements.size
   end

data/lib/steam/packets/rcon/rcon_exec_response.rb

@@ -12,7 +12,7 @@ class RCONExecResponse < RCONPacket
   end
 
   def response
-    @content_data.data[0..-3]
+    @content_data.string[0..-3]
   end
 
 end

data/lib/steam/packets/rcon/rcon_goldsrc_request.rb

@@ -12,7 +12,7 @@ class RCONGoldSrcRequest < SteamPacket
   end
 
   def to_s
-    [0xFFFFFFFF, @content_data.data].pack('Va*')
+    [0xFFFFFFFF, @content_data.string].pack('Va*')
   end
 
 end

data/lib/steam/packets/rcon/rcon_goldsrc_response.rb

@@ -12,7 +12,7 @@ class RCONGoldSrcResponse < SteamPacket
   end
 
   def response
-    @content_data.data[0..-3]
+    @content_data.string[0..-3]
   end
 
 end

data/lib/steam/packets/rcon/rcon_packet.rb

@@ -24,7 +24,7 @@ class RCONPacket < SteamPacket
   end
 
   def bytes
-    [@content_data.length + 8, @request_id, @header_data, @content_data.data].pack('V3a*')
+    [@content_data.length + 8, @request_id, @header_data, @content_data.string].pack('V3a*')
   end
 
 end

data/lib/steam/packets/rcon/rcon_packet_factory.rb

@@ -20,7 +20,7 @@ class RCONPacketFactory < SteamPacketFactory
     byte_buffer.long
     request_id = byte_buffer.long
     header = byte_buffer.long
-    data = byte_buffer.string
+    data = byte_buffer.cstring
 
     case header
       when RCONPacket::SERVERDATA_AUTH_RESPONSE then

data/lib/steam/packets/request_with_challenge.rb

@@ -8,7 +8,7 @@ module RequestWithChallenge
 
   # Returns a packed version of the request
   def to_s
-    [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.data.to_i].pack('c5l')
+    [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.string.to_i].pack('c5l')
   end
 
 end

data/lib/steam/packets/s2a_info2_packet.rb

@@ -14,10 +14,10 @@ class S2A_INFO2_Packet < S2A_INFO_BasePacket
     super SteamPacket::S2A_INFO2_HEADER, data
 
     @protocol_version = @content_data.byte
-    @server_name = @content_data.string
-    @map_name = @content_data.string
-    @game_directory = @content_data.string
-    @game_description = @content_data.string
+    @server_name = @content_data.cstring
+    @map_name = @content_data.cstring
+    @game_directory = @content_data.cstring
+    @game_description = @content_data.cstring
     @app_id = @content_data.short
     @number_of_players = @content_data.byte
     @max_players = @content_data.byte
@@ -26,7 +26,7 @@ class S2A_INFO2_Packet < S2A_INFO_BasePacket
     @operating_system = @content_data.byte.chr
     @password_needed = @content_data.byte == 1
     @secure = @content_data.byte == 1
-    @game_version = @content_data.string
+    @game_version = @content_data.cstring
     extra_data_flag = @content_data.byte
 
     @server_port = @content_data.short unless extra_data_flag & 0x80 == 0
@@ -37,10 +37,10 @@ class S2A_INFO2_Packet < S2A_INFO_BasePacket
 
     unless extra_data_flag & 0x40 == 0
       @tv_port = @content_data.short
-      @tv_name = @content_data.string
+      @tv_name = @content_data.cstring
     end
 
-    @server_tags = @content_data.string unless extra_data_flag & 0x20 == 0
+    @server_tags = @content_data.cstring unless extra_data_flag & 0x20 == 0
 
     generate_info_hash
   end

data/lib/steam/packets/s2a_info_detailed_packet.rb

@@ -15,11 +15,11 @@ class S2A_INFO_DETAILED_Packet < S2A_INFO_BasePacket
   def initialize(data)
     super SteamPacket::S2A_INFO_DETAILED_HEADER, data
 
-    @game_ip = @content_data.string
-    @server_name = @content_data.string
-    @map_name = @content_data.string
-    @game_directory = @content_data.string
-    @game_description = @content_data.string
+    @game_ip = @content_data.cstring
+    @server_name = @content_data.cstring
+    @map_name = @content_data.cstring
+    @game_directory = @content_data.cstring
+    @game_description = @content_data.cstring
     @number_of_players = @content_data.byte
     @max_players = @content_data.byte
     @network_version = @content_data.byte
@@ -30,8 +30,8 @@ class S2A_INFO_DETAILED_Packet < S2A_INFO_BasePacket
 
     if @is_mod
       @mod_info = {}
-      @mod_info['url_info'] = @content_data.string
-      @mod_info['url_dl'] = @content_data.string
+      @mod_info['url_info'] = @content_data.cstring
+      @mod_info['url_dl'] = @content_data.cstring
       @content_data.byte
       if @content_data.remaining == 12
         @mod_info['mod_version'] = @content_data.long

data/lib/steam/packets/s2a_player_packet.rb

@@ -22,7 +22,7 @@ class S2A_PLAYER_Packet < SteamPacket
     @player_hash = {}
 
     while @content_data.remaining > 0
-      player_data = @content_data.byte, @content_data.string, @content_data.signed_long, @content_data.float
+      player_data = @content_data.byte, @content_data.cstring, @content_data.signed_long, @content_data.float
       @player_hash[player_data[1]] = SteamPlayer.new(*player_data[0..3])
     end
   end

data/lib/steam/packets/s2a_rules_packet.rb

@@ -22,8 +22,8 @@ class S2A_RULES_Packet < SteamPacket
     @rules_hash = {}
 
     rules_count.times do
-      rule  = @content_data.string
-      value = @content_data.string
+      rule  = @content_data.cstring
+      value = @content_data.cstring
 
       # This is a workaround for servers sending corrupt replies
       break if rule.empty? or value.empty?

data/lib/steam/packets/steam_packet.rb

@@ -34,7 +34,7 @@ class SteamPacket
 
   # Returns a packed string representing the packet's data
   def to_s
-    [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.data].pack('c5a*')
+    [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.string].pack('c5a*')
   end
 
 end

data/lib/steam/servers/master_server.rb

@@ -8,7 +8,7 @@ require 'steam/sockets/master_server_socket'
 
 class MasterServer
 
-  GOLDSRC_MASTER_SERVER = 'hl1master.steampowered.com', 27013
+  GOLDSRC_MASTER_SERVER = 'hl1master.steampowered.com', 27010
   SOURCE_MASTER_SERVER = 'hl2master.steampowered.com', 27011
 
   REGION_US_EAST_COAST = 0x00

data/lib/stringio_additions.rb

@@ -7,8 +7,6 @@ require 'stringio'
 
 class StringIO
 
-  alias_method :data, :string
-
   def self.allocate(size)
     new "\0" * size
   end
@@ -41,7 +39,7 @@ class StringIO
     read(4).unpack('l')[0]
   end
 
-  def string
+  def cstring
     gets("\0")[0..-2]
   end
 

data/test/datagram_channel_tests.rb

@@ -33,7 +33,7 @@ class DatagramChannelTests < Test::Unit::TestCase
     channel.close
     socket.close
 
-    received = buffer.data
+    received = buffer.string
 
     assert_equal(string, sent)
     assert_equal(string, received)

data/test/socket_channel_tests.rb

@@ -34,7 +34,7 @@ class SocketChannelTests < Test::Unit::TestCase
     channel.close
     socket.close
 
-    received = buffer.data
+    received = buffer.string
 
     assert_equal(string, sent)
     assert_equal(string, received)

data/test/stringio_additions_tests.rb

@@ -13,7 +13,7 @@ class StringIOAdditionsTests < Test::Unit::TestCase
 
   def test_allocate
     buffer = StringIO.allocate(10)
-    assert_equal("\0" * 10, buffer.data)
+    assert_equal("\0" * 10, buffer.string)
   end
 
   def test_byte
@@ -48,17 +48,17 @@ class StringIOAdditionsTests < Test::Unit::TestCase
 
   def test_string
     buffer = StringIO.new("test\0test")
-    assert_equal('test', buffer.string)
+    assert_equal('test', buffer.cstring)
     assert_equal(4, buffer.remaining)
   end
 
   def test_put
     buffer = StringIO.new('te')
     buffer.write('st')
-    assert_equal('st', buffer.data)
+    assert_equal('st', buffer.string)
     buffer = StringIO.allocate(4)
     buffer.write('test')
-    assert_equal('test', buffer.data)
+    assert_equal('test', buffer.string)
   end
 
   def test_rewind
@@ -71,7 +71,7 @@ class StringIOAdditionsTests < Test::Unit::TestCase
   def test_wrap
     string = 'test'
     buffer = StringIO.new(string)
-    assert_equal(string, buffer.data)
+    assert_equal(string, buffer.string)
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: steam-condenser
 version: !ruby/object:Gem::Version 
-  hash: 49
+  hash: 55
   prerelease: false
   segments: 
   - 0
   - 11
-  - 1
-  version: 0.11.1
+  - 2
+  version: 0.11.2
 platform: ruby
 authors: 
 - Sebastian Staudt
@@ -15,10 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-05 00:00:00 +02:00
+date: 2010-09-08 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bzip2-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  type: :runtime
+  version_requirements: *id001
 description: A multi-language library for querying the Steam Community, Source, GoldSrc servers and Steam master servers
 email: koraktor@gmail.com
 executables: []
@@ -41,6 +55,9 @@ files:
 - lib/exceptions/timeout_exception.rb
 - lib/socket_channel.rb
 - lib/steam-condenser.rb
+- lib/steam-condenser/community.rb
+- lib/steam-condenser/servers.rb
+- lib/steam-condenser/version.rb
 - lib/steam/community/cacheable.rb
 - lib/steam/community/css/css_map.rb
 - lib/steam/community/css/css_stats.rb