steam-condenser 1.3.5 → 1.3.6

data/lib/steam/community/steam_id.rb

@@ -169,11 +169,11 @@ class SteamId
   def self.steam_id_to_community_id(steam_id)
     if steam_id == 'STEAM_ID_LAN' || steam_id == 'BOT'
       raise SteamCondenserError, "Cannot convert SteamID \"#{steam_id}\" to a community ID."
-    elsif steam_id =~ /^STEAM_[0-1]:[0-1]:[0-9]+$/
-      steam_id = steam_id[8..-1].split(':').map! { |s| s.to_i }
+    elsif steam_id =~ /^STEAM_[0-1]:([0-1]:[0-9]+)$/
+      steam_id = $1.split(':').map! { |s| s.to_i }
       steam_id[0] + steam_id[1] * 2 + 76561197960265728
-    elsif steam_id =~ /\[U:[0-1]:[0-9]+\]/
-      steam_id = steam_id[3..-2].split(':').map! { |s| s.to_i }
+    elsif steam_id =~ /^\[U:([0-1]:[0-9]+)\]$/
+      steam_id = $1.split(':').map { |s| s.to_i }
       steam_id[0] + steam_id[1] + 76561197960265727
     else
       raise SteamCondenserError, "SteamID \"#{steam_id}\" doesn't have the correct format."
@@ -305,9 +305,8 @@ class SteamId
   # @see #initialize
   def fetch_friends
     friends_data = parse "#{base_url}/friends?xml=1"
-    @friends = []
-    friends_data['friends']['friend'].each do |friend|
-      @friends << SteamId.new(friend.to_i, false)
+    @friends = friends_data['friends']['friend'].map do |friend|
+      SteamId.new friend.to_i, false
     end
   end
 
@@ -449,8 +448,7 @@ class SteamId
   # @return [Fixnum] The number of minutes this user played the given game in
   #         the last two weeks
   def recent_playtime(id)
-    game = find_game id
-    @recent_playtimes[game.app_id]
+    @recent_playtimes[find_game(id).app_id]
   end
 
   # Returns the total time in minutes this user has played this game
@@ -460,8 +458,7 @@ class SteamId
   # @return [Fixnum] The total number of minutes this user played the given
   #         game
   def total_playtime(id)
-    game = find_game id
-    @total_playtimes[game.app_id]
+    @total_playtimes[find_game(id).app_id]
   end
 
   private

data/lib/steam/community/web_api.rb

@@ -18,6 +18,8 @@ module WebApi
 
   @@api_key = nil
 
+  @@secure = true
+
   # Returns the Steam Web API key currently used by Steam Condenser
   #
   # @return [String] The currently active Steam Web API key
@@ -39,6 +41,13 @@ module WebApi
     @@api_key = api_key
   end
 
+  # Sets whether HTTPS should be used for the communication with the Web API
+  #
+  # @param [Boolean] secure Whether to use HTTPS
+  def self.secure=(secure)
+    @@secure = !!secure
+  end
+
   # Returns a raw list of interfaces and their methods that are available in
   # Steam's Web API
   #
@@ -63,8 +72,8 @@ module WebApi
   #        HTTP GET
   # @raise [WebApiError] if the request to Steam's Web API fails
   # @return [String] The raw JSON data replied to the request
-  def self.json(interface, method, version = 1, params = nil)
-    get(:json, interface, method, version, params)
+  def self.json(interface, method, version = 1, params = {})
+    get :json, interface, method, version, params
   end
 
   # Fetches JSON data from Steam Web API using the specified interface, method
@@ -79,8 +88,8 @@ module WebApi
   #        HTTP GET
   # @raise [WebApiError] if the request to Steam's Web API fails
   # @return [Hash<Symbol, Object>] The JSON data replied to the request
-  def self.json!(interface, method, version = 1, params = nil)
-    data = json(interface, method, version, params)
+  def self.json!(interface, method, version = 1, params = {})
+    data = json interface, method, version, params
     result = MultiJson.load(data, { :symbolize_keys => true })[:result]
 
     status = result[:status]
@@ -105,20 +114,16 @@ module WebApi
   #        HTTP GET
   # @raise [WebApiError] if the request to Steam's Web API fails
   # @return [String] The data as replied by the Web API in the desired format
-  def self.get(format, interface, method, version = 1, params = nil)
+  def self.get(format, interface, method, version = 1, params = {})
     version = version.to_s.rjust(4, '0')
-    url = "http://api.steampowered.com/#{interface}/#{method}/v#{version}/"
-    params = {} unless params.is_a?(Hash)
-    params[:format] = format
-    params[:key] = WebApi.api_key
-
-    unless params.nil? && params.empty?
-      url += '?' + params.map { |k,v| "#{k}=#{v}" }.join('&')
-    end
+    params = { :format => format, :key => WebApi.api_key }.merge params
+    protocol = @@secure ? 'https' : 'http'
+    url = "#{protocol}://api.steampowered.com/#{interface}/#{method}/v#{version}/" +
+          '?' + params.map { |k,v| "#{k}=#{v}" }.join('&')
 
     begin
       puts "Querying Steam Web API: #{url.gsub(@@api_key, 'SECRET')}" if $DEBUG
-      open(url, { :proxy => true }).read
+      open(url, { 'Content-Type' => 'application/x-www-form-urlencoded' ,:proxy => true }).read
     rescue OpenURI::HTTPError
       status = $!.io.status[0]
       status = [status, ''] unless status.is_a? Array

data/lib/steam/packets/s2a_info2_packet.rb

@@ -30,20 +30,22 @@ class S2A_INFO2_Packet
   def initialize(data)
     super S2A_INFO2_HEADER, data
 
-    info[:protocol_version] = @content_data.byte
-    info[:server_name] = @content_data.cstring
-    info[:map_name] = @content_data.cstring
-    info[:game_directory] = @content_data.cstring
-    info[:game_description] = @content_data.cstring
-    info[:app_id] = @content_data.short
-    info[:number_of_players] = @content_data.byte
-    info[:max_players] = @content_data.byte
-    info[:number_of_bots] = @content_data.byte
-    info[:dedicated] = @content_data.byte.chr
-    info[:operating_system] = @content_data.byte.chr
-    info[:password_needed] = @content_data.byte == 1
-    info[:secure] = @content_data.byte == 1
-    info[:game_version] = @content_data.cstring
+    info.merge!({
+      :protocol_version => @content_data.byte,
+      :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,
+      :number_of_bots => @content_data.byte,
+      :dedicated => @content_data.byte.chr,
+      :operating_system => @content_data.byte.chr,
+      :password_needed => @content_data.byte == 1,
+      :secure => @content_data.byte == 1,
+      :game_version => @content_data.cstring
+    })
 
     if @content_data.remaining > 0
       extra_data_flag = @content_data.byte

data/lib/steam/packets/s2a_info_detailed_packet.rb

@@ -24,29 +24,34 @@ class S2A_INFO_DETAILED_Packet
   def initialize(data)
     super S2A_INFO_DETAILED_HEADER, data
 
-    info[:game_ip] = @content_data.cstring
-    info[:server_name] = @content_data.cstring
-    info[:map_name] = @content_data.cstring
-    info[:game_directory] = @content_data.cstring
-    info[:game_description] = @content_data.cstring
-    info[:number_of_players] = @content_data.byte
-    info[:max_players] = @content_data.byte
-    info[:network_version] = @content_data.byte
-    info[:dedicated] = @content_data.byte.chr
-    info[:operating_system] = @content_data.byte.chr
-    info[:password_needed] = @content_data.byte == 1
-    info[:is_mod] = @content_data.byte == 1
+    info.merge!({
+      :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,
+      :dedicated => @content_data.byte.chr,
+      :operating_system => @content_data.byte.chr,
+      :password_needed => @content_data.byte == 1,
+      :is_mod => @content_data.byte == 1
+    })
 
     if info[:is_mod]
-      info[:mod_info] = {}
-      info[:mod_info][:url_info] = @content_data.cstring
-      info[:mod_info][:url_dl] = @content_data.cstring
+      info[:mod_info] = {
+        :url_info => @content_data.cstring,
+        :url_dl => @content_data.cstring
+      }
       @content_data.byte
       if @content_data.remaining == 12
-        info[:mod_info][:mod_version] = @content_data.long
-        info[:mod_info][:mod_size] = @content_data.long
-        info[:mod_info][:sv_only] = @content_data.byte == 1
-        info[:mod_info][:cl_dll] = @content_data.byte == 1
+        info[:mod_info].merge!({
+          :mod_version => @content_data.long,
+          :mod_size => @content_data.long,
+          :sv_only => @content_data.byte == 1,
+          :cl_dll => @content_data.byte == 1,
+        })
         info[:secure] = @content_data.byte == 1
         info[:number_of_bots] = @content_data.byte
       end

data/lib/steam/packets/steam_packet_factory.rb

@@ -1,9 +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-2011, Sebastian Staudt
+# Copyright (c) 2008-2013, Sebastian Staudt
 
-require 'bzip2-ruby'
 require 'zlib'
 
 require 'errors/packet_format_error'
@@ -95,6 +94,12 @@ module SteamPacketFactory
     packet_data = split_packets.join ''
 
     if is_compressed
+      begin
+        require 'bzip2-ruby'
+      rescue LoadError
+        raise SteamCondenserError, 'The "bzip2-ruby" gem is not installed. Please install it, if you want to query Source servers sending compressed packets.'
+      end
+
       packet_data = Bzip2.decompress packet_data
 
       unless Zlib.crc32(packet_data) == packet_checksum

data/lib/steam/servers/game_server.rb

@@ -279,8 +279,9 @@ module GameServer
 
     players.each do |player|
       player_data = GameServer.split_player_status(attributes, player)
-      if @player_hash.key? player_data[:name]
-        @player_hash[player_data[:name]].add_info player_data
+      player_name = player_data[:name]
+      if @player_hash.key? player_name
+        @player_hash[player_name].add_info player_data
       end
     end
   end

data/lib/steam/servers/master_server.rb

@@ -26,7 +26,7 @@ class MasterServer
   @@retries = 3
 
   # The master server address to query for GoldSrc game servers
-  GOLDSRC_MASTER_SERVER = 'hl1master.steampowered.com', 27010
+  GOLDSRC_MASTER_SERVER = 'hl1master.steampowered.com', 27011
 
   # The master server address to query for Source game servers
   SOURCE_MASTER_SERVER = 'hl2master.steampowered.com', 27011

data/lib/steam/sockets/source_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-2013, Sebastian Staudt
 
 require 'core_ext/stringio'
 require 'errors/timeout_error'
@@ -26,6 +26,7 @@ class SourceSocket
   def reply
     receive_packet 1400
     is_compressed = false
+    packet_checksum = 0
 
     if @buffer.long == 0xFFFFFFFE
       split_packets = []
@@ -46,22 +47,16 @@ class SourceSocket
 
         puts "Received packet #{packet_number} of #{packet_count} for request ##{request_id}" if $DEBUG
 
+        bytes_read = 0
         if split_packets.size < packet_count
           begin
             bytes_read = receive_packet
           rescue SteamCondenser::TimeoutError
-            bytes_read = 0
           end
-        else
-          bytes_read = 0
         end
       end while bytes_read > 0 && @buffer.long == 0xFFFFFFFE
 
-      if is_compressed
-        packet = SteamPacketFactory.reassemble_packet(split_packets, true, packet_checksum)
-      else
-        packet = SteamPacketFactory.reassemble_packet(split_packets)
-      end
+      packet = SteamPacketFactory.reassemble_packet(split_packets, is_compressed, packet_checksum)
     else
       packet = SteamPacketFactory.packet_from_data(@buffer.get)
     end

data/pkg/steam-condenser-1.3.5/Gemfile

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

data/pkg/steam-condenser-1.3.5/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.3)
+    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.5/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.5/README.md

@@ -0,0 +1,70 @@
+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](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).