gamespy_query 0.2.0pre2 → 0.2.0pre3

data/lib/gamespy_query/base.rb

@@ -13,7 +13,7 @@ module GamespyQuery
   module Tools
     STR_EMPTY = ""
     CHAR_N = "\n"
-  
+
     module_function
     # Provides access to the logger object
     # Will use ActionController::Base.logger if available
@@ -76,9 +76,9 @@ STR
     # Integer / Float actually String Regex
     RX_S = /\A\-?0[0-9]+.*\Z/
 
-    # Clean value, convert if possible
+    # Convert data type and strip tags
     # @param [String] value String to convert
-    def clean(value) # TODO: Force String, Integer, Float etc?
+    def convert_type(value) # TODO: Force String, Integer, Float etc?
       case value
         when STR_X0
           nil
@@ -99,25 +99,18 @@ STR
       number
     end
 
+    STR_UTF8 = 'UTF-8'
+
     # Convert string to UTF-8, stripping out all invalid/undefined characters
     # @param [String] str String to convert
     def encode_string(str)
       #Tools.debug {"Getting string #{str}"}
-      _encode_string str
-    end
-
-    if RUBY_PLATFORM =~ /mswin32/
-      # Get UTF-8 string from string
-      # @param [String] str
-      def _encode_string(str)
-        System::Text::Encoding.UTF8.GetString(System::Array.of(System::Byte).new(str.bytes.to_a)).to_s # #  begin; System::Text::Encoding.USASCII.GetString(reply[0]).to_s; rescue nil, Exception => e; Tools.log_exception(e); reply[0].map {|e| e.chr}.join; end
-      end
-    else
-      # Get UTF-8 string from string
-      # @param [String] str
-      def _encode_string(str)
-        #(str + '  ').encode("US-ASCII", invalid: :replace, undef: :replace)[0..-3]
-        str.bytes.to_a.pack("U*")
+      #System::Text::Encoding.UTF8.GetString(System::Array.of(System::Byte).new(str.bytes.to_a)).to_s # #  begin; System::Text::Encoding.USASCII.GetString(reply[0]).to_s; rescue nil, Exception => e; Tools.log_exception(e); reply[0].map {|e| e.chr}.join; end
+      begin
+        str.bytes.to_a.pack('C*').force_encoding(STR_UTF8)
+      rescue nil, Exception => e
+        Tools.log_exception e
+        str.encode("UTF-8", invalid: :replace, undef: :replace)
       end
     end
   end

data/lib/gamespy_query/master.rb

@@ -1,8 +1,12 @@
 module GamespyQuery
   # Provides access to the Gamespy Master browser
   class Master < Base
+    # TODO: gslist.exe output encoding seems to be a problem.
+    # not been able to find a solution yet to get unicode instead of garbelled characters
+    # If impossible, perhaps should try custom implementation of master query
+
     PARAMS = [:hostname, :gamever, :gametype, :gamemode, :numplayers, :maxplayers, :password, :equalModRequired, :mission, :mapname,
-              :mod, :signatures, :verifysignatures, :gamestate, :dedicated, :platform, :sv_battleeye, :language, :difficulty]
+              :mod, :signatures, :verifysignatures, :gamestate, :dedicated, :platform, :sv_battleye, :language, :difficulty]
 
     RX_ADDR_LINE = /^[\s\t]*([\d\.]+)[\s\t:]*(\d+)[\s\t]*(.*)$/
 
@@ -13,6 +17,14 @@ module GamespyQuery
         "\\\\"
     end
 
+    path = defined?(Rails) ? File.join(Rails.root, "config") : File.join(Dir.pwd, "config")
+    DEFAULT_GEOIP_PATH = case RUBY_PLATFORM
+                  when /-mingw32$/, /-mswin32$/
+                    path.gsub("/", "\\")
+                  else
+                    path
+                end
+
     # Geo settings
     attr_reader :geo
 
@@ -22,8 +34,8 @@ module GamespyQuery
     # Initializes the instance
     # @param [String] geo Geo string
     # @param [String] game Game string
-    def initialize(geo = nil, game = "arma2oapc")
-      @geo, @game = geo, game
+    def initialize(geo = nil, game = "arma2oapc", geoip_path = nil)
+      @geo, @game, @geoip_path = geo, game, geoip_path
     end
 
     # Convert the master browser data to hash
@@ -118,20 +130,7 @@ module GamespyQuery
 
     # Get geoip_path
     def geoip_path
-      return File.join(Dir.pwd, "config") unless defined?(Rails)
-
-      case RUBY_PLATFORM
-        when /-mingw32$/, /-mswin32$/
-          File.join(Rails.root, "config").gsub("/", "\\")
-        else
-          File.join(Rails.root, "config")
-      end
+      @geoip_path || DEFAULT_GEOIP_PATH
     end
   end
 end
-
-if $0 == __FILE__
-  master = GamespyQuery::Master.new
-  r = master.read
-  puts r
-end

data/lib/gamespy_query/parser.rb

@@ -30,13 +30,13 @@ module GamespyQuery
     #   - Array, packetDATA ordered already by packetID
     def initialize(packets)
       @packets = case packets
-      when Hash
-        packets.keys.sort.map{|key| packets[key] }
-      when Array
-        packets
-      else
-        raise UnsupportedFormat, "Unsupported format: #{packets.class}"
-      end
+                   when Hash
+                     packets.keys.sort.map{|key| packets[key] }
+                   when Array
+                     packets
+                   else
+                     raise UnsupportedFormat, "Unsupported format: #{packets.class}"
+                 end
     end
 
     # Parse game and player data to hash
@@ -48,7 +48,7 @@ module GamespyQuery
       data[:game] = {} # Key: InfoKey, Value: InfoValue
       data[:players] = {} # Key: InfoType, Value: Array of Values
       player_info = false
-      player_data = "".encode "ASCII-8BIT"
+      player_data = ""
 
       # Parse the packets
       @packets.each do |packet|
@@ -70,12 +70,12 @@ module GamespyQuery
           else
             # GameData-only
             data[:game].merge!(parse_game_data(packet))
-          end         
+          end
         end
       end
 
       # Parse player_data
-      data[:players] = parse_player_data(player_data)
+      data[:players] = parse_player_data(encode_string player_data)
 
       data
     end
@@ -168,7 +168,7 @@ module GamespyQuery
             player_data[player_data.keys[i]] << encode_string(entry.sub(STR_X0, STR_EMPTY))
             str.sub!(entry, STR_EMPTY)
           end
-          
+
           # Search for SIX string to overwrite last entry
           new_player_data = []
           overwrite = false
@@ -177,7 +177,6 @@ module GamespyQuery
               overwrite = true # tag so that the next entry will overwrite the latest entry
               next # ignore
             else
-              info = clean(info) if [2,3].include?(i) # Apply data_type conversion for Score and Deaths
               if overwrite
                 new_player_data[-1] = info # Overwrite latest entry
                 overwrite = false # done the overwrite

data/lib/gamespy_query/socket.rb

@@ -5,83 +5,6 @@ require 'yaml'
 require 'socket'
 
 module GamespyQuery
-  # Provides socket functionality on multiple platforms
-  # TODO
-  module MultiSocket
-    # Create socket
-    def create_socket(*params)
-      Tools.debug {"Creating socket #{params}"}
-      _create_socket(*params)
-    end
-
-    # Write socket
-    def socket_send(*params)
-      Tools.debug {"Sending socket #{params}"}
-      _socket_send(*params)
-    end
-
-    # Read socket
-    def socket_receive(*params)
-      Tools.debug {"Receiving socket #{params}"}
-      _socket_receive(*params)
-    end
-
-    # Close socket
-    def socket_close(*params)
-      Tools.debug {"Closing socket #{params}"}
-      @s.close
-    end
-
-    if RUBY_PLATFORM =~ /mswin32/
-      include System::Net
-      include System::Net::Sockets
-
-      # Create socket
-      def _create_socket(host, port)
-        @ip_end_point = IPEndPoint.new(IPAddress.Any, 0)
-        @s = UdpClient.new
-        @s.client.receive_timeout = DEFAULT_TIMEOUT * 1000
-        @s.connect(host, port.to_i)
-      end
-
-      # Write socket
-      def _socket_send(packet)
-        @s.Send(packet, packet.length)
-      end
-
-      # Read socket
-      def _socket_receive
-        @s.Receive(@ip_end_point)
-      end
-
-    else
-
-      # Create socket
-      def _create_socket(host, port)
-        @s = UDPSocket.new
-        @s.connect(host, port)
-      end
-
-      # Write socket
-      def _socket_send(packet)
-        @s.puts(packet)
-      end
-
-      # Read socket
-      def _socket_receive
-        begin
-          Timeout::timeout(DEFAULT_TIMEOUT) do
-            @s.recvfrom(RECEIVE_SIZE)
-          end
-        rescue Timeout::Error
-          raise TimeoutError, "TimeOut on #{self}"
-        ensure
-          @s.close
-        end
-      end
-    end
-  end
-
   # Provides direct connection functionality to gamespy enabled game servers
   # This query contains up to 7x more information than the gamespy master browser query
   # For example, player lists with info (teams, scores, deaths) are only available by using direct connection
@@ -117,6 +40,8 @@ module GamespyQuery
     RX_CHALLENGE2 = /[^0-9\-]/si
     RX_SPLITNUM = /^splitnum\x00(.)/i
 
+    PLATFORM_IR = /-mswin32/
+
     # TODO: Support pings
     # TODO: Handle .NET native sockets
     STATE_INIT, STATE_SENT_CHALLENGE, STATE_RECEIVED_CHALLENGE, STATE_SENT_CHALLENGE_RESPONSE, STATE_RECEIVE_DATA, STATE_READY = 0, 1, 2, 3, 4, 5
@@ -170,15 +95,11 @@ module GamespyQuery
           else
             raise NotInWriteState, "NotInWriteState, #{self}"
         end
-      rescue NotInWriteState => e
-        r = false
-        self.failed = true
-        close unless closed?
-      rescue => e
-        Tools.log_exception e
+      rescue nil, Exception => e
         self.failed = true
         r = nil
         close unless closed?
+        raise e
       end
 
 =begin
@@ -192,6 +113,31 @@ module GamespyQuery
       r
     end
 
+    # Temp Workaround for IO.select issue on IR
+    def _read_non_block
+      if RUBY_PLATFORM =~ PLATFORM_IR
+        time_end = Time.now + DEFAULT_TIMEOUT
+        success = false
+        until success || Time.now >= time_end
+          begin
+            d = self.recvfrom_nonblock(RECEIVE_SIZE)
+            success = d
+          rescue SocketError
+
+          rescue nil, Exception => e
+            Tools.log_exception(e)
+          end
+        end
+        if success
+          success
+        else
+          raise TimeOutError, "The read operation has timedout"
+        end
+      else
+        self.recvfrom_nonblock(RECEIVE_SIZE)
+      end
+    end
+
     # Handle the read state
     def handle_read
       # Tools.debug {"Read: #{self.inspect}, #{self.state}"}
@@ -200,14 +146,14 @@ module GamespyQuery
       begin
         case self.state
           when STATE_SENT_CHALLENGE
-            data = self.recvfrom_nonblock(RECEIVE_SIZE)
+            data = _read_non_block
             Tools.debug {"Read (1): #{self.inspect}: #{data}"}
 
             handle_challenge data[0]
 
             self.state = STATE_RECEIVED_CHALLENGE
           when STATE_SENT_CHALLENGE_RESPONSE, STATE_RECEIVE_DATA
-            data = self.recvfrom_nonblock(RECEIVE_SIZE)
+            data = _read_non_block
             Tools.debug {"Read (3,4): #{self.inspect}: #{data}"}
             self.state = STATE_RECEIVE_DATA
 
@@ -227,16 +173,11 @@ module GamespyQuery
           else
             raise NotInReadState, "NotInReadState, #{self}"
         end
-      rescue NotInReadState => e
-        r = false
-        self.failed = true
-        close unless closed?
-      rescue => e
-        # TODO: Simply raise the exception?
-        Tools.log_exception(e)
+      rescue nil, Exception => e
         self.failed = true
         r = nil
         close unless closed?
+        raise e
       end
       r
     end
@@ -290,6 +231,7 @@ module GamespyQuery
     # @param [String] reply Reply from server
     def sync reply = self.fetch
       game_data, key = {}, nil
+      Tools.debug {"DATA: #{reply.inspect}"}
       return game_data if reply.nil? || reply.empty?
 
       parser = Parser.new(reply)
@@ -305,18 +247,19 @@ module GamespyQuery
 
     # Fetch all packets from socket
     def fetch
+      Tools.debug {"FUCK ME"}
       pings = []
       r = self.data
       begin
-        until valid?
+        until valid? || failed
           if handle_state
-            if IO.select(nil, [self], nil, DEFAULT_TIMEOUT)
+            if RUBY_PLATFORM =~ PLATFORM_IR || IO.select(nil, [self], nil, DEFAULT_TIMEOUT)
               handle_write
             else
               raise TimeOutError, "TimeOut during write, #{self}"
             end
           else
-            if IO.select([self], nil, nil, DEFAULT_TIMEOUT)
+            if RUBY_PLATFORM =~ PLATFORM_IR || IO.select([self], nil, nil, DEFAULT_TIMEOUT)
               handle_read
             else
               raise TimeOutError, "TimeOut during read, #{self}"
@@ -341,4 +284,83 @@ module GamespyQuery
       r
     end
   end
+
+  # Provides socket functionality on multiple platforms
+  # TODO
+=begin
+  module MultiSocket
+    # Create socket
+    def create_socket(*params)
+      Tools.debug {"Creating socket #{params}"}
+      _create_socket(*params)
+    end
+
+    # Write socket
+    def socket_send(*params)
+      Tools.debug {"Sending socket #{params}"}
+      _socket_send(*params)
+    end
+
+    # Read socket
+    def socket_receive(*params)
+      Tools.debug {"Receiving socket #{params}"}
+      _socket_receive(*params)
+    end
+
+    # Close socket
+    def socket_close(*params)
+      Tools.debug {"Closing socket #{params}"}
+      @s.close
+    end
+
+    if RUBY_PLATFORM =~ /mswin32/
+      include System::Net
+      include System::Net::Sockets
+
+      # Create socket
+      def _create_socket(host, port)
+        @ip_end_point = IPEndPoint.new(IPAddress.Any, 0)
+        @s = UdpClient.new
+        @s.client.receive_timeout = DEFAULT_TIMEOUT * 1000
+        @s.connect(host, port.to_i)
+      end
+
+      # Write socket
+      def _socket_send(packet)
+        @s.Send(packet, packet.length)
+      end
+
+      # Read socket
+      def _socket_receive
+        @s.Receive(@ip_end_point)
+      end
+
+    else
+
+      # Create socket
+      def _create_socket(host, port)
+        @s = UDPSocket.new
+        @s.connect(host, port)
+      end
+
+      # Write socket
+      def _socket_send(packet)
+        @s.puts(packet)
+      end
+
+      # Read socket
+      def _socket_receive
+        begin
+          Timeout::timeout(DEFAULT_TIMEOUT) do
+            @s.recvfrom(RECEIVE_SIZE)
+          end
+        rescue Timeout::Error
+          raise TimeoutError, "TimeOut on #{self}"
+        ensure
+          @s.close
+        end
+      end
+    end
+  end
+=end
 end

data/lib/gamespy_query/socket_master.rb

@@ -54,10 +54,10 @@ module GamespyQuery
           Tools.debug {"Sockets: #{queue.size}, AddrsLeft: #{@addrs.size}, ReadReady: #{"#{ready[0].size} / #{read_sockets.size}, WriteReady: #{ready[1].size} / #{write_sockets.size}, ExcReady: #{ready[2].size} / #{queue.size}" unless ready.nil?}"}
 
           # Read
-          ready[0].each { |s| queue.delete(s) unless s.handle_read() }
+          ready[0].each { |s| begin; s.handle_read(); rescue nil, Exception => e; queue.delete(s); end }
 
           # Write
-          ready[1].each { |s| queue.delete(s) unless s.handle_write() }
+          ready[1].each { |s| begin; s.handle_write(); rescue nil, Exception => e; queue.delete(s); end }
 
           # Exceptions
           #ready[2].each { |s| queue.delete(s) unless s.handle_exc }
@@ -104,21 +104,3 @@ module GamespyQuery
     end
   end
 end
-
-if $0 == __FILE__
-  require_relative 'master'
-  srv = File.open(ARGV[0] || "servers.txt") { |f| f.read }
-  master = GamespyQuery::Master.new
-  addrs = master.get_server_list srv
-
-  time_start = Time.now
-  sm = GamespyQuery::SocketMaster.new(addrs)
-  sockets = sm.process!
-  time_taken = Time.now - time_start
-
-  cool = sockets.count {|v| v.valid? }
-  dude = sockets.size - cool
-
-  puts "Success: #{cool}, Failed: #{dude}"
-  puts "Took: #{time_taken}s"
-end

data/lib/gamespy_query/version.rb

@@ -1,4 +1,4 @@
 module GamespyQuery
   # Version of the library
-  VERSION = "0.2.0pre2"
+  VERSION = "0.2.0pre3"
 end

data/lib/gamespy_query.rb

@@ -22,19 +22,3 @@ module GamespyQuery
     "GamespyQuery version #{VERSION}"
   end
 end
-
-
-if $0 == __FILE__
-  host, port = if ARGV.size > 1
-                 ARGV
-               else
-                 ARGV[0].split(":")
-               end
-  time_start = Time.now
-  g = GamespyQuery::Socket.new("#{host}:#{port}")
-  r = g.sync
-  time_taken = Time.now - time_start
-  puts "Took: #{time_taken}s"
-  exit unless r
-  puts r.to_yaml
-end

data/test/units/base_test.rb

@@ -19,8 +19,8 @@ context "Funcs" do
       # TODO: This method doesnt do anything atm
       asserts("strip_tags") { topic.strip_tags "test" }.equals "test"
 
-      asserts("clean integer") { topic.clean "1" }.equals 1
-      asserts("clean float") { topic.clean "1.5" }.equals 1.5
+      asserts("convert integer") { topic.convert_type "1" }.equals 1
+      asserts("convert float") { topic.convert_type "1.5" }.equals 1.5
 
       asserts("encode_string") { topic.encode_string("test encoding").encoding }.equals Encoding.find("UTF-8")
 

data/test/units/parser_test.rb

@@ -16,8 +16,8 @@ context "Parser" do
       setup { topic[:game] }
       denies("Game data") { topic }.empty
 
-      asserts("gamever") { topic["gamever"] }.equals "1.59.79548"
-      asserts("sv_battleye") { topic["sv_battleye"] }.equals "1"
+      asserts("gamever") { topic[:gamever] }.equals "1.59.79548"
+      asserts("sv_battleye") { topic[:sv_battleye] }.equals "1"
     end
 
     context "Players data" do
@@ -32,15 +32,15 @@ context "Parser" do
       context "First element" do
         asserts("Name") { topic[:names][0] }.equals "Skilllos"
         asserts("Team") { topic[:teams][0] }.equals ""
-        asserts("Score") { topic[:scores][0] }.equals 371
-        asserts("Deaths") { topic[:deaths][0] }.equals 24
+        asserts("Score") { topic[:scores][0] }.equals "371"
+        asserts("Deaths") { topic[:deaths][0] }.equals "24"
       end
 
       context "Tenth element" do
         asserts("Name") { topic[:names][10] }.equals "DrHat"
         asserts("Team") { topic[:teams][10] }.equals ""
-        asserts("Score") { topic[:scores][10] }.equals 37
-        asserts("Deaths") { topic[:deaths][10] }.equals 8
+        asserts("Score") { topic[:scores][10] }.equals "37"
+        asserts("Deaths") { topic[:deaths][10] }.equals "8"
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gamespy_query
 version: !ruby/object:Gem::Version
-  version: 0.2.0pre2
+  version: 0.2.0pre3
   prerelease: 5
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-09 00:00:00.000000000 Z
+date: 2012-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
-  requirement: &15149120 !ruby/object:Gem::Requirement
+  requirement: &10524320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15149120
+  version_requirements: *10524320
 - !ruby/object:Gem::Dependency
   name: riot
-  requirement: &15148220 !ruby/object:Gem::Requirement
+  requirement: &10523880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15148220
+  version_requirements: *10523880
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &15147420 !ruby/object:Gem::Requirement
+  requirement: &10523420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15147420
+  version_requirements: *10523420
 description: ''
 email:
 - sb@dev-heaven.net