steam-condenser 1.2.0 → 1.2.1

data/lib/steam/community/game_leaderboard.rb

@@ -141,12 +141,12 @@ class GameLeaderboard
   #         leaderboard
   def entry_range(first, last)
     if last < first
-      raise SteamCondenserException,
+      raise SteamCondenserError,
         'First entry must be prior to last entry for leaderboard entry lookup.'
     end
 
     if (last - first) > 5000
-      raise SteamCondenserException,
+      raise SteamCondenserError,
         'Leaderboard entry lookup is currently limited to a maximum of 5001 entries per request.'
     end
 

data/lib/steam/community/game_stats.rb

@@ -109,7 +109,7 @@ class GameStats
 
     @privacy_state = @xml_data['privacyState']
     if public?
-      app_id        = @xml_data['game']['gameLink'].match(/http:\/\/store.steampowered.com\/app\/([1-9][0-9]+)/)[1].to_i
+      app_id        = @xml_data['game']['gameLink'].match(/http:\/\/+store\.steampowered\.com\/+app\/+([1-9][0-9]*)/)[1].to_i
       @game         = SteamGame.new app_id, @xml_data['game']
       @hours_played = @xml_data['stats']['hoursPlayed'] unless @xml_data['stats']['hoursPlayed'].nil?
     end

data/lib/steam/community/portal2/portal2_inventory.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) 2011, Sebastian Staudt
+# Copyright (c) 2011-2012, Sebastian Staudt
 
 require 'steam/community/game_inventory'
 require 'steam/community/portal2/portal2_item'
@@ -9,15 +9,17 @@ require 'steam/community/portal2/portal2_item'
 # Represents the inventory (a.k.a. Robot Enrichment) of a Portal 2 player
 #
 # @author Sebastian Staudt
-class Portal2Inventory
+class Portal2Inventory < GameInventory
 
-  include Cacheable
-  cacheable_with_ids :steam_id64
-
-  include GameInventory
-
-  # The Steam Application ID of Portal 2
-  @@app_id = 620
+  # Creates a new inventory object for the given SteamID64 in Portal 2 (App ID
+  # 620)
+  #
+  # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
+  #        inventory for
+  # @macro cacheable
+  def initialize(steam_id64)
+    super 620, steam_id64
+  end
 
   # The class representing Portal 2 items
   @@item_class = Portal2Item

data/lib/steam/community/steam_game.rb

@@ -175,8 +175,6 @@ class SteamGame
       @short_name = game_data['gameFriendlyName'].downcase
       @short_name = @app_id if @short_name == @app_id.to_s
     end
-
-    super()
   end
 
 end

data/lib/steam/community/steam_group.rb

@@ -35,17 +35,14 @@ class SteamGroup
   #
   # @param [String, Fixnum] id The custom URL of the group specified by the
   #        group admin or the 64bit group ID
-  # @param [Boolean] fetch if `true` the groups's data is loaded into the
-  #        object
-  def initialize(id, fetch = true)
+  # @macro cacheable
+  def initialize(id)
     if id.is_a? Numeric
       @group_id64 = id
     else
       @custom_url = id.downcase
     end
     @members = []
-
-    super fetch
   end
 
   # Returns the base URL for this group's page
@@ -77,8 +74,6 @@ class SteamGroup
     begin
       total_pages = fetch_page(page += 1)
     end while page < total_pages
-
-    super
   end
 
   # Returns the number of members this group has

data/lib/steam/community/steam_id.rb

@@ -200,16 +200,13 @@ class SteamId
   #
   # @param [String, Fixnum] id The custom URL of the Steam ID specified by the
   #        user or the 64bit SteamID
-  # @param [Boolean] fetch if `true` the Steam ID's data is loaded into the
-  #        object
-  def initialize(id, fetch = true)
+  # @macro cacheable
+  def initialize(id)
     if id.is_a? Numeric
       @steam_id64 = id
     else
       @custom_url = id.downcase
     end
-
-    super fetch
   end
 
   # Returns whether the owner of this SteamID is VAC banned
@@ -305,8 +302,6 @@ class SteamId
       raise $! if $!.is_a? SteamCondenserError
       raise SteamCondenserError, 'XML data could not be parsed.', $!.backtrace
     end
-
-    super
   end
 
   # Fetches the friends of this user

data/lib/steam/community/tf2/tf2_beta_inventory.rb

@@ -1,21 +1,24 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2011, Sebastian Staudt
+# Copyright (c) 2011-2012, Sebastian Staudt
 
 require 'steam/community/game_inventory'
 require 'steam/community/tf2/tf2_item'
 
 # Represents the inventory (aka. Backpack) of a player of the public Team
 # Fortress 2 beta
-class TF2BetaInventory
+class TF2BetaInventory < GameInventory
 
-  include Cacheable
-  cacheable_with_ids :steam_id64
-
-  include GameInventory
-
-  @@app_id = 520
+  # Creates a new inventory object for the given SteamID64 in the Team Fortress
+  # 2 beta (App ID 520)
+  #
+  # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
+  #        inventory for
+  # @macro cacheable
+  def initialize(steam_id64)
+    super 520, steam_id64
+  end
 
   @@item_class = TF2Item
 

data/lib/steam/community/tf2/tf2_inventory.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) 2010-2011, Sebastian Staudt
+# Copyright (c) 2010-2012, Sebastian Staudt
 
 require 'steam/community/game_inventory'
 require 'steam/community/tf2/tf2_item'
@@ -9,15 +9,17 @@ require 'steam/community/tf2/tf2_item'
 # Represents the inventory (aka. Backpack) of a Team Fortress 2 player
 #
 # @author Sebastian Staudt
-class TF2Inventory
+class TF2Inventory < GameInventory
 
-  include Cacheable
-  cacheable_with_ids :steam_id64
-
-  include GameInventory
-
-  # The Steam Application ID of Team Fortress 2
-  @@app_id = 440
+  # Creates a new inventory object for the given SteamID64 in Team Fortress 2
+  # (App ID 440)
+  #
+  # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
+  #        inventory for
+  # @macro cacheable
+  def initialize(steam_id64)
+    super 440, steam_id64
+  end
 
   # The class representing Team Fortress 2 items
   @@item_class = TF2Item

data/lib/steam/community/xml_data.rb

@@ -1,14 +1,21 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2011, Sebastian Staudt
+# Copyright (c) 2011-2012, Sebastian Staudt
 
 require 'open-uri'
 
 require 'multi_xml'
 
+# This class provides basic functionality to parse XML data
+#
+# @author Sebastian Staudt
 module XMLData
 
+  # Parse the given URL as XML data using `multi_xml`
+  #
+  # @param [String] url The URL to parse
+  # @return [Hash<String, Object>] The data parsed from the XML document
   def parse(url)
     data = open(url, { :proxy => true })
     @xml_data = MultiXml.parse(data).values.first

data/lib/steam/packets/a2s_player_packet.rb

@@ -22,7 +22,7 @@ class A2S_PLAYER_Packet
 
   # Creates a new A2S_PLAYER request object including the challenge number
   #
-  # @param [Numeric] challenge_number The challenge number received from the
+  # @param [Numeric] challenge_number The challenge number received from the
   #        server
   def initialize(challenge_number = -1)
     super A2S_PLAYER_HEADER, challenge_number

data/lib/steam/packets/a2s_rules_packet.rb

@@ -23,7 +23,7 @@ class A2S_RULES_Packet
 
   # Creates a new A2S_RULES request object including the challenge number
   #
-  # @param [Numeric] challenge_number The challenge number received from the
+  # @param [Numeric] challenge_number The challenge number received from the
   #        server
   def initialize(challenge_number = -1)
     super A2S_RULES_HEADER, challenge_number

data/lib/steam/servers/master_server.rb

@@ -61,7 +61,7 @@ class MasterServer
   # Sets the number of consecutive requests that may fail, before getting
   # the server list is cancelled (default: 3)
   #
-  # @param [Fixnum] The number of allowed retries
+  # @param [Fixnum] retries The number of allowed retries
   def self.retries=(retries)
     @@retries = retries
   end
@@ -156,7 +156,8 @@ class MasterServer
   #
   # This can be used to check server versions externally.
   #
-  # @param [Hash<Symbol, Object>] The data to send with the heartbeat request
+  # @param [Hash<Symbol, Object>] data The data to send with the heartbeat
+  #        request
   # @raise [SteamCondenserError] if heartbeat data is missing the
   #        challenge number or the reply cannot be parsed
   # @return [Array<SteamPacket>] Zero or more reply packets from the server.

data/lib/steam/sockets/rcon_socket.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-2011, Sebastian Staudt
+# Copyright (c) 2008-2012, Sebastian Staudt
 
 require 'ipaddr'
 require 'socket'
@@ -35,7 +35,6 @@ class RCONSocket
 
     @ip     = ip
     @port   = port
-    @socket = nil
   end
 
   # Closes the underlying TCP socket if it exists

data/pkg/steam-condenser-1.2.0/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/pkg/steam-condenser-1.2.0/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    steam-condenser (1.2.0)
+      bzip2-ruby (~> 0.2.7)
+      multi_json (~> 1.3.1)
+      multi_xml (~> 0.5.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bzip2-ruby (0.2.7)
+    metaclass (0.0.1)
+    mocha (0.12.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    shoulda-context (1.0.0)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 0.12.0)
+  rake (~> 0.9.2)
+  shoulda-context (~> 1.0.0)
+  steam-condenser!
+  yard (~> 0.8.0)

data/pkg/steam-condenser-1.2.0/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2008-2012, Sebastian Staudt
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of the author nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/pkg/steam-condenser-1.2.0/README.md

@@ -0,0 +1,47 @@
+Steam Condenser [![Build Status](https://secure.travis-ci.org/koraktor/steam-condenser-ruby.png)](http://travis-ci.org/koraktor/steam-condenser-ruby)
+===============
+
+The Steam Condenser is a multi-language library for querying the Steam
+Community, Source and GoldSrc game servers as well as the Steam master servers.
+Currently it is implemented in Java, PHP and Ruby.
+
+## Requirements
+
+* Linux, MacOS X or Windows
+* Ruby 1.8.6 or newer
+
+The following gems are required:
+
+* `bzip2-ruby` (for Source servers sending compressed responses)
+* `json` (for the Web API features)
+
+## Installation
+
+To install Steam Condenser as a Ruby gem use the following command:
+
+    gem install steam-condenser
+
+## 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
+included LICENSE file.
+
+## Credits
+
+* Sebastian Staudt – koraktor(at)gmail.com
+* DeFirence – defirence(at)defirence.za.net
+* Mike Połtyn – mike(at)railslove.com
+* Sam Kinard – snkinard(at)gmail.com
+
+## See Also
+
+* [Steam Condenser home](https://koraktor.de/steam-condenser)
+* [Documentation](http://rubydoc.info/gems/steam-condenser)
+* [GitHub project page](https://github.com/koraktor/steam-condenser)
+* [Wiki](https://github.com/koraktor/steam-condenser/wiki)
+* [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).

data/pkg/steam-condenser-1.2.0/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+#
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2011, Sebastian Staudt
+
+require 'rake/testtask'
+require 'rubygems/package_task'
+
+task :default => :test
+
+Gem::PackageTask.new Gem::Specification.load 'steam-condenser.gemspec' do |pkg|
+end
+
+# Rake task for running the test suite
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.test_files = Dir.glob 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+# Check if YARD is installed
+begin
+  require 'yard'
+
+  # Create a rake task +:doc+ to build the documentation using YARD
+  YARD::Rake::YardocTask.new do |yardoc|
+    yardoc.name    = 'doc'
+    yardoc.files   = [ 'lib/**/*.rb', 'LICENSE', 'README.md' ]
+    yardoc.options = [ '--private', '--title', 'Metior — API Documentation' ]
+  end
+rescue LoadError
+  # Create a rake task +:doc+ to show that YARD is not installed
+  desc 'Generate YARD Documentation (not available)'
+  task :doc do
+    $stderr.puts 'You need YARD to build the documentation. Install it using `gem install yard`.'
+  end
+end
+
+# Task for cleaning documentation and package directories
+desc 'Clean documentation and package directories'
+task :clean do
+  FileUtils.rm_rf 'doc'
+  FileUtils.rm_rf 'pkg'
+end

data/pkg/steam-condenser-1.2.0/lib/core_ext/stringio.rb

@@ -0,0 +1,91 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'stringio'
+
+# This extends the `StringIO` class from Ruby's standard library. It adds some
+# methods to handle byte-wise input from a `StringIO` object.
+#
+# @author Sebastian Staudt
+class StringIO
+
+  # Creates a new instance of `StringIO` with the given size and fills it with
+  # zero-bytes.
+  #
+  # @param [Fixnum] size The size the new instance should have
+  # @return [StringIO] A new `StringIO` instance with the given size, filled
+  #         with zero-bytes
+  def self.alloc(size)
+    new "\0" * size
+  end
+
+  # Reads a single byte from the current position of the byte stream
+  #
+  # @return [Fixnum] The numeric value of the byte at the current position
+  def byte
+    read(1)[0].ord
+  end
+
+  # Reads a floating-point integer (32 bit) from the current position of the
+  # byte stream
+  #
+  # @return [Float] The floating-point integer read from the byte stream
+  def float
+    read(4).unpack('e')[0]
+  end
+
+  # Reads the whole remaining content of the byte stream from the current
+  # position to the end
+  #
+  # @return [String] The remainder of the byte stream starting from the current
+  #         position of the byte stream
+  def get
+    read remaining
+  end
+
+  # Reads an unsigned long integer (32 bit) from the current position of the
+  # byte stream
+  #
+  # @return [Fixnum] The unsigned long integer read from the byte stream
+  def long
+    read(4).unpack('V')[0]
+  end
+
+  # Returns the remaining number of bytes from the current position to the end
+  # of the byte stream
+  #
+  # @return [Fixnum] The number of bytes until the end of the stream
+  def remaining
+    size - pos
+  end
+
+  # Reads an unsigned short integer (16 bit) from the current position of the
+  # byte stream
+  #
+  # @return [Fixnum] The unsigned short integer read from the byte stream
+  def short
+    read(2).unpack('v')[0]
+  end
+
+  # Reads a signed long integer (32 bit) from the current position of the byte
+  # stream
+  #
+  # @return [Fixnum] The signed long integer read from the byte stream
+  def signed_long
+    read(4).unpack('l')[0]
+  end
+
+  # Reads a zero-byte terminated string from the current position of the byte
+  # stream
+  #
+  # This reads the stream up until the first occurance of a zero-byte or the
+  # end of the stream. The zero-byte is not included in the returned string.
+  #
+  # @return [String] The zero-byte terminated string read from the byte stream
+  def cstring
+    gets("\0")[0..-2]
+  end
+
+end