steam-condenser 0.8.0

data/LICENSE

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

@@ -0,0 +1,30 @@
+Steam Condenser
+===============
+
+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
+* [Ruby BZ2 module](http://www.rubyforge.org/projects/bz2)
+
+## 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.
+
+## Credits
+
+* Sebastian Staudt -- koraktor(at)gmail.com
+
+## See Also
+
+* [Steam Condenser home](http://koraktor.github.com/steam-condenser)
+* [Documentation](http://www.rdoc.info/projects/koraktor/steam-condenser)
+* [GitHub project page](http://github.com/koraktor/steam-condenser)
+* [Google group](http://groups.google.com/group/steam-condenser)
+* [Ohloh profile](http://www.ohloh.net/projects/steam-condenser)

data/Rakefile

@@ -0,0 +1,42 @@
+# 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
+
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rubygems'
+require 'jeweler'
+
+src_files = Dir.glob(File.join("lib", "**", "*.rb"))
+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.rdoc_options = ["--all", "--inline-source", "--line-numbers", "--charset=utf-8", "--webcvs=http://github.com/koraktor/steam-condenser/source/blob/master/ruby/%s"]
+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.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"]
+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/lib/abstract_class.rb

@@ -0,0 +1,40 @@
+# 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$
+
+# This module is used to mimic the behavior of abstract classes known from other
+# object-oriented programming languages
+module AbstractClass
+  
+  # If this module is included in a class:
+  # * protect the constructor of the class
+  # * make sure every derived class has a constructor calling the super
+  #   constructor 
+  def self.included(klass)
+    klass.module_eval do
+      
+      class << self 
+        protected :new
+
+        # Each derived class gets a constructor calling the super constructor
+        def inherited(klass)
+          klass.module_eval do
+            
+            # The constructor for derived classes, simply calling the super
+            # constructor
+            def self.new(*args)
+              super
+            end
+            
+          end
+        end
+        
+      end
+      
+    end
+  end
+ 
+end

data/lib/byte_buffer.rb

@@ -0,0 +1,126 @@
+# 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
+
+require "exceptions/buffer_underflow_exception"
+
+# The ByteBuffer class derived from Java's java.nio.ByteBuffer
+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  
+  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
+
+  def get_short
+    return self.get(2).unpack("v")[0]
+  end
+
+  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 ""
+    else
+      data_string = self.get(zero_byte_index - @position)
+      @position += 1    
+      return 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
+
+end

data/lib/datagram_channel.rb

@@ -0,0 +1,70 @@
+# 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$
+
+require "byte_buffer"
+
+class DatagramChannel
+  
+  attr_reader :socket
+  
+  def self.open
+    return DatagramChannel.new
+  end
+  
+  def close
+    @socket.close
+  end
+  
+  def connect(*args)
+    if args[0].is_a? IPAddr
+      ip_address = args[0].to_s
+    elsif args[0].is_a? String
+      sockaddr = (Socket.gethostbyname args[0])[3]
+      ip_address = "#{sockaddr[0]}.#{sockaddr[1]}.#{sockaddr[2]}.#{sockaddr[3]}"
+    end
+    
+    if args[1].is_a? Numeric
+      port_number = args[1]
+    else
+      port_number = args[1].to_i
+    end
+    
+    @socket.connect ip_address, port_number
+    
+    return self
+  end
+  
+  def configure_blocking(do_block)
+  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
+  
+  protected
+  
+  def initialize
+    @socket = UDPSocket.new
+    self.configure_blocking true
+  end
+end

data/lib/exceptions/buffer_underflow_exception.rb

@@ -0,0 +1,10 @@
+# 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$
+
+class BufferUnderflowException < Exception
+  
+end

data/lib/exceptions/packet_format_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) 2008, Sebastian Staudt
+#
+# $Id$
+
+require "exceptions/steam_condenser_exception"
+
+class PacketFormatException < SteamCondenserException
+
+end

data/lib/exceptions/rcon_no_auth_exception.rb

@@ -0,0 +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) 2008, Sebastian Staudt
+#
+# $Id$
+
+class RCONNoAuthException < Exception
+  
+  def initialize
+    super "Not authenticated yet."
+  end
+  
+end

data/lib/exceptions/steam_condenser_exception.rb

@@ -0,0 +1,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-2009, Sebastian Staudt
+
+class SteamCondenserException < StandardError
+  
+end

data/lib/exceptions/timeout_exception.rb

@@ -0,0 +1,10 @@
+# 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
+#
+# $Id$
+
+class TimeoutException < StandardError
+  
+end

data/lib/socket_channel.rb

@@ -0,0 +1,54 @@
+# 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
+
+require 'byte_buffer'
+require 'timeout'
+
+class SocketChannel
+  
+  attr_reader :socket
+  
+  def self.open
+    return SocketChannel.new
+  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