steam-condenser 1.3.5 → 1.3.6

data/pkg/steam-condenser-1.3.5/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-2012, 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/steam/community/cacheable.rb', '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.3.5/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

data/pkg/steam-condenser-1.3.5/lib/errors/packet_format_error.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) 2008-2011, Sebastian Staudt
+
+require 'errors/steam_condenser_error'
+
+# This error class indicates a problem when parsing packet data from the
+# responses received from a game or master server
+#
+# @author Sebastian Staudt
+class PacketFormatError < SteamCondenserError
+end

data/pkg/steam-condenser-1.3.5/lib/errors/rcon_ban_error.rb

@@ -0,0 +1,22 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2009-2011, Sebastian Staudt
+
+require 'errors/steam_condenser_error'
+
+# This error class indicates that the IP address your accessing the game server
+# from has been banned by the server
+#
+# You or the server operator will have to unban your IP address on the server.
+#
+# @author Sebastian Staudt
+# @see GameServer#rcon_auth
+class RCONBanError < SteamCondenserError
+
+  # Creates a new `RCONBanError` instance
+  def initialize
+    super 'You have been banned from this server.'
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/errors/rcon_no_auth_error.rb

@@ -0,0 +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) 2008-2011, Sebastian Staudt
+
+require 'errors/steam_condenser_error'
+
+# This error class indicates that you have not authenticated yet with the game
+# server you're trying to send commands via RCON
+#
+# @author Sebastian Staudt
+# @see GameServer#rcon_auth
+# @see GameServer#rcon_exec
+class RCONNoAuthError < SteamCondenserError
+
+  # Creates a new `RCONNoAuthError` instance
+  def initialize
+    super 'Not authenticated yet.'
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/errors/steam_condenser_error.rb

@@ -0,0 +1,26 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2013, Sebastian Staudt
+
+# This error class is used as a base class for all errors related to Steam
+# Condenser's operation
+#
+# @author Sebastian Staudt
+class SteamCondenserError < StandardError
+
+  # Returns the exception that caused this error
+  #
+  # @return [Exception] The exception that caused this error
+  attr_reader :cause
+
+  # Creates a new `SteamCondenserError` instance
+  #
+  # @param [String] message The message to attach to the error
+  # @param [Exception] cause The exception that caused this error
+  def initialize(message, cause = nil)
+    super message
+    @cause = cause
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/errors/timeout_error.rb

@@ -0,0 +1,28 @@
+# 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 'errors/steam_condenser_error'
+
+module SteamCondenser
+
+  # This error class indicates that an operation could not be finished within a
+  # reasonable amount of time
+  #
+  # This usually indicates that a server could not be contacted because of
+  # network problems.
+  #
+  # @author Sebastian Staudt
+  # @note {SteamSocket.timeout=} allows to set a custom timeout for socket
+  #       operations
+  class TimeoutError < SteamCondenserError
+
+    # Creates a new `TimeoutError` instance
+    def initialize
+      super 'The operation timed out.'
+    end
+
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/errors/web_api_error.rb

@@ -0,0 +1,57 @@
+# 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
+
+require 'errors/steam_condenser_error'
+
+# This error is raised when a Steam Web API request or a related action fails.
+# This can have various reasons like an invalid Web API key or a broken
+# request.
+#
+# @author Sebastian Staudt
+# @see WebApi
+class WebApiError < SteamCondenserError
+
+  # Creates a new `WebApiError` with an error message according to the given
+  # `cause`. If this cause is `:status_bad` (which will origin from the Web API
+  # itself) or `:http_error` the details about this failed request will be
+  # taken from `status_code` and `status_message`.
+  #
+  # @param [:http_error, :invalid_key, :status_bad, :unauthorized] cause A
+  #        symbolic name for the problem which caused this error:
+  #
+  #        * `:http_error`: An error during the HTTP request itself will result
+  #           in an error with this reason.
+  #        * `:invalid_key`: This occurs when trying to set a Web API key that
+  #           isn't valid, i.e. a 128 bit integer in a hexadecimal string.
+  #        * `:status_bad`: This is caused by a successful request that fails
+  #          for some Web API internal reason (e.g. an invalid argument).
+  #          Details about this failed request will be taken from `status_code`
+  #          and `status_message`.
+  #        * `:unauthorized`: This happens when a Steam Web API request is
+  #          rejected as unauthorized. This most likely means that you did not
+  #          specify a valid Web API key using {WebApi.api_key=}. A Web API key
+  #          can be obtained from http://steamcommunity.com/dev/apikey.
+  #
+  #        Other undefined reasons will cause a generic error message.
+  # @param [Fixnum] status_code The HTTP status code returned by the Web API
+  # @param [String] status_message The status message returned in the response
+  def initialize(cause, status_code = nil, status_message = '')
+    case cause
+      when :http_error then
+        message = "The Web API request has failed due to an HTTP error: #{status_message} (status code: #{status_code})."
+      when :invalid_key then
+        message = 'This is not a valid Steam Web API key.'
+      when :status_bad then
+        message = "The Web API request failed with the following error: #{status_message} (status code: #{status_code})."
+      when :unauthorized then
+        message = 'Your Web API request has been rejected. You most likely did not specify a valid Web API key.'
+      else
+        message = 'An unexpected error occured while executing a Web API request.'
+    end
+
+    super message
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam-condenser.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) 2009-2011, Sebastian Staudt
+
+# This module is used as a wrapper around Steam Condenser's classes
+#
+# It does not provide any own functionality, but this file is used as an entry
+# point when using the gem (i.e. +require 'steam-condenser').
+#
+# @author Sebastian Staudt
+module SteamCondenser
+
+  require 'steam-condenser/community'
+  require 'steam-condenser/servers'
+  require 'steam-condenser/version'
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam-condenser/community.rb

@@ -0,0 +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) 2010-2011, Sebastian Staudt
+
+module SteamCondenser
+
+  require 'steam-condenser/version'
+
+  # This module is used as a wrapper around Steam Condenser's Steam Community
+  # classes
+  #
+  # It does not provide any own functionality, but this file is used to easily
+  # require classes to interact with the Steam Community
+  #
+  # @author Sebastian Staudt
+  module Community
+
+    require 'steam/community/steam_id'
+    require 'steam/community/web_api'
+
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam-condenser/servers.rb

@@ -0,0 +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) 2010-2011, Sebastian Staudt
+
+module SteamCondenser
+
+  require 'steam-condenser/version'
+
+  # This module is used as a wrapper around Steam Condenser's server classes
+  #
+  # It does not provide any own functionality, but this file is used to easily
+  # require classes to interact with servers
+  #
+  # @author Sebastian Staudt
+  module Servers
+
+    require 'steam/servers/goldsrc_server'
+    require 'steam/servers/master_server'
+    require 'steam/servers/source_server'
+
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam-condenser/version.rb

@@ -0,0 +1,11 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2013, Sebastian Staudt
+
+module SteamCondenser
+
+  # The current version of Steam Condenser
+  VERSION = '1.3.5'
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam/community/alien_swarm/alien_swarm_mission.rb

@@ -0,0 +1,119 @@
+# 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
+
+# This class holds statistical information about missions played by a player in
+# Alien Swarm
+#
+# @author Sebastian Staudt
+class AlienSwarmMission
+
+  # Returns the avarage damage taken by the player while playing a round in
+  # this mission
+  #
+  # @return [Float] The average damage taken by the player
+  attr_reader :avg_damage_taken
+
+  # Returns the avarage damage dealt by the player to team mates while playing
+  # a round in this mission
+  #
+  # @return [Float] The average damage dealt by the player to team mates
+  attr_reader :avg_friendly_fire
+
+  # Returns the avarage number of aliens killed by the player while playing a
+  # round in this mission
+  #
+  # @return [Float] The avarage number of aliens killed by the player
+  attr_reader :avg_kills
+
+  # Returns the highest difficulty the player has beat this mission in
+  #
+  # @return [String] The highest difficulty the player has beat this mission in
+  attr_reader :best_difficulty
+
+  # Returns the total damage taken by the player in this mission
+  #
+  # @return [Fixnum] The total damage taken by the player
+  attr_reader :damage_taken
+
+  # Returns the total damage dealt by the player to team mates in this mission
+  #
+  # @return [Fixnum] The total damage dealt by the player to team mates
+  attr_reader :friendly_fire
+
+  # Returns the number of successful rounds the player played in this mission
+  #
+  # @return [Fixnum] The number of successful rounds of this mission
+  attr_reader :games_successful
+
+  # Returns the URL to a image displaying the mission
+  #
+  # @return [String] The URL of the mission's image
+  attr_reader :img
+
+  # Returns the total number of aliens killed by the player in this mission
+  #
+  # @return [Fixnum] The total number of aliens killed by the player
+  attr_reader :kills
+
+  # Returns the file name of the mission's map
+  #
+  # @return [String] The file name of the mission's map
+  attr_reader :map_name
+
+  # Returns the name of the mission
+  #
+  # @return [String] The name of the mission
+  attr_reader :name
+
+  # Returns various statistics about the times needed to accomplish this
+  # mission
+  #
+  # This includes the best times for each difficulty, the average time and the
+  # total time spent in this mission.
+  #
+  # @return [Hash<Symbol, String>] Various time statistics about this mission
+  attr_reader :time
+
+  # Returns the number of games played in this mission
+  #
+  # @return [Fixnum] The number of games played in this mission
+  attr_reader :total_games
+
+  # Returns the percentage of successful games played in this mission
+  #
+  # @return [Float] The percentage of successful games played in this mission
+  attr_reader :total_games_percentage
+
+  # Creates a new mission instance of based on the given XML data
+  #
+  # @param [String] map_name The name of the mission's map
+  # @param [Hash<String, Object>] mission_data The data representing this
+  #        mission
+  def initialize(map_name, mission_data)
+    @avg_damage_taken       = mission_data['damagetakenavg'].to_f
+    @avg_friendly_fire      = mission_data['friendlyfireavg'].to_f
+    @avg_kills              = mission_data['killsavg'].to_f
+    @best_difficulty        = mission_data['bestdifficulty']
+    @damage_taken           = mission_data['damagetaken'].to_i
+    @friendly_fire          = mission_data['friendlyfire'].to_i
+    @games_successful       = mission_data['gamessuccess'].to_i
+    @img                    = AlienSwarmStats::BASE_URL + mission_data['image']
+    @kills                  = mission_data['kills'].to_i
+    @map_name               = map_name
+    @name                   = mission_data['name']
+    @total_games            = mission_data['gamestotal'].to_i
+    @total_games_percentage = mission_data['gamestotalpct'].to_f
+
+    @time = {}
+    @time[:average] = mission_data['avgtime']
+    @time[:brutal]  = mission_data['brutaltime']
+    @time[:easy]    = mission_data['easytime']
+    @time[:hard]    = mission_data['hardtime']
+    @time[:insane]  = mission_data['insanetime']
+    @time[:normal]  = mission_data['normaltime']
+    @time[:total]   = mission_data['totaltime']
+  end
+
+end