steam-condenser 1.3.6 → 1.3.7

data/pkg/steam-condenser-1.3.6/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false
+end

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

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    steam-condenser (1.3.6)
+      multi_json (~> 1.7.2)
+      multi_xml (~> 0.5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    metaclass (0.0.1)
+    mime-types (1.23)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.3)
+    multi_xml (0.5.5)
+    rake (10.0.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    shoulda-context (1.1.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+    yard (0.8.6.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  coveralls
+  mocha (~> 0.13.0)
+  rake (~> 10.0.1)
+  shoulda-context (~> 1.1.1)
+  steam-condenser!
+  yard (~> 0.8.0)

data/pkg/steam-condenser-1.3.6/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2008-2013, 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.3.6/README.md

@@ -0,0 +1,75 @@
+Steam Condenser
+===============
+
+[![Gem Version](https://badge.fury.io/rb/steam-condenser.png)](http://badge.fury.io/rb/steam-condenser)
+[![Build Status](https://secure.travis-ci.org/koraktor/steam-condenser-ruby.png)](http://travis-ci.org/koraktor/steam-condenser-ruby)
+[![Dependency Status](https://gemnasium.com/koraktor/steam-condenser-ruby.png)](https://gemnasium.com/koraktor/steam-condenser-ruby)
+[![Code Climate](https://codeclimate.com/github/koraktor/steam-condenser-ruby.png)](https://codeclimate.com/github/koraktor/steam-condenser-ruby)
+[![Coverage Status](https://coveralls.io/repos/koraktor/steam-condenser-ruby/badge.png?branch=master)](https://coveralls.io/r/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
+
+* Ruby 1.8.7 or newer (and compatible Ruby VMs)
+* Any operating system able to run such a VM
+
+The following gems are required:
+
+* `bzip2-ruby` (for Source servers sending compressed responses)
+* `multi_json` (for the Web API features)
+* `multi_xml` (for the Steam Community features)
+
+## Installation
+
+To install Steam Condenser as a Ruby gem use the following command:
+
+```bash
+$ gem install steam-condenser
+```
+
+If you're projet dependencies are managed by [Bundler](http://gembundler.com)
+add this to your `Gemfile`:
+
+```ruby
+gem 'steam-condenser'
+```
+
+## Usage
+
+To start using Steam Condenser requiring the base file is usually enough:
+
+```ruby
+require '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
+* "withgod" – noname(at)withgod.jp
+* John Amicangelo - amicangelo.j(at)husky.neu.edu
+* Eric Litak – elitak(at)gmail.com
+
+## See Also
+
+* [Steam Condenser home](http://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 Google Plus+ via
+[+Steam Condenser](https://plus.google.com/b/109400543549250623875/109400543549250623875)
+or on Twitter via [@steamcondenser](https://twitter.com/steamcondenser).

data/pkg/steam-condenser-1.3.6/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.6/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.6/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.6/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.6/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.6/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.6/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.6/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