minestat 2.2.1 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e0acf4a379eb97f4145d734b8f7d3b82b9b5f57d
-  data.tar.gz: 8fe0222fc8892a44eea98917e87eaad75f0fd8d3
+SHA256:
+  metadata.gz: 1aae005889c4dfd2940d4fe464195aceb82380a03437603bbfc984a036a79b91
+  data.tar.gz: bb333f2e25d3dd899b26e357bfeffffa8411055832f5c6b36eee850c6912314f
 SHA512:
-  metadata.gz: 071fd966c47fd93d01087a4c85d20ca2ca56c05cec1d22c8aeff824602c900f085d7c877e37b0dfe25d3105f74dab2a52d2fa1f19b8706d3a31d16bbb96a7af8
-  data.tar.gz: 4846ca755878fd8d81bddd5634916e83955b142ea587cb81c3ba55a629f04129a2eacdc11f7fa68d9b6d77f5ab8ed141628d330a7e33a5e2fc82e46d61b625ab
+  metadata.gz: 98d83d61c188baffac40427684cc7e93d1e77db3a4acf1e58c55e6f0cba39d2e48a57b7ae53562aa0041c47ca60fdd6abb360e0caae820e30b13e7164b1819ae
+  data.tar.gz: 8ccb0e3159c32175ec677b37dc15960532bedf2bb238ea185f7f01c4ee02e4a3245d166889abaa36bbf1f6e152f0ee477dbb4bd72022093b6b09c50847174a52

data/lib/minestat.rb

@@ -16,6 +16,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
+require 'base64'
 require 'json'
 require 'socket'
 require 'timeout'
@@ -24,7 +25,7 @@ require 'timeout'
 # Provides a ruby interface for polling Minecraft server status.
 class MineStat
   # MineStat version
-  VERSION = "2.2.1"
+  VERSION = "2.2.3"
   # Number of values expected from server
   NUM_FIELDS = 6
   # Number of values expected from a 1.8b/1.3 server
@@ -91,10 +92,13 @@ class MineStat
     @max_players          # maximum player capacity
     @protocol             # protocol level
     @json_data            # JSON data for 1.7 queries
+    @favicon_b64          # base64-encoded favicon possibly contained in JSON 1.7 responses
+    @favicon              # decoded favicon data
     @latency              # ping time to server in milliseconds
     @timeout = timeout    # TCP/UDP timeout
     @server               # server socket
-    @request_type         # Protocol version
+    @request_type         # protocol version
+    @connection_status    # status of connection ("Success", "Fail", "Timeout", or "Unknown")
     @try_all = false      # try all protocols?
 
     @try_all = true if request_type == Request::NONE
@@ -131,11 +135,19 @@ class MineStat
           retval = json_request()
         end
         # Bedrock/Pocket Edition
-        unless retval == Retval::CONNFAIL
+        unless @online || retval == Retval::SUCCESS || retval == Retval::CONNFAIL
           retval = bedrock_request()
         end
     end
-    @online = false unless retval == Retval::SUCCESS
+    set_connection_status(retval) unless @online
+  end
+
+  # Sets connection status
+  def set_connection_status(retval)
+    @connection_status = "Success" if retval == Retval::SUCCESS
+    @connection_status = "Fail" if retval == Retval::CONNFAIL
+    @connection_status = "Timeout" if retval == Retval::TIMEOUT
+    @connection_status = "Unknown" if retval == Retval::UNKNOWN
   end
 
   # Strips message of the day formatting characters
@@ -273,7 +285,6 @@ class MineStat
         retval = connect()
         return retval unless retval == Retval::SUCCESS
         # Perform handshake and acquire data
-        @request_type = "SLP 1.8b/1.3 (beta)"
         @server.write("\xFE")
         retval = parse_data("\u00A7", true) # section symbol
       end
@@ -283,6 +294,10 @@ class MineStat
       $stderr.puts exception
       return Retval::UNKNOWN
     end
+    if retval == Retval::SUCCESS
+      @request_type = "SLP 1.8b/1.3 (beta)"
+      set_connection_status(retval)
+    end
     return retval
   end
 
@@ -312,7 +327,6 @@ class MineStat
         retval = connect()
         return retval unless retval == Retval::SUCCESS
         # Perform handshake and acquire data
-        @request_type = "SLP 1.4/1.5 (legacy)"
         @server.write("\xFE\x01")
         retval = parse_data("\x00") # null
       end
@@ -322,6 +336,10 @@ class MineStat
       $stderr.puts exception
       return Retval::UNKNOWN
     end
+    if retval == Retval::SUCCESS
+      @request_type = "SLP 1.4/1.5 (legacy)"
+      set_connection_status(retval)
+    end
     return retval
   end
 
@@ -359,7 +377,6 @@ class MineStat
         retval = connect()
         return retval unless retval == Retval::SUCCESS
         # Perform handshake and acquire data
-        @request_type = "SLP 1.6 (extended legacy)"
         @server.write("\xFE\x01\xFA")
         @server.write("\x00\x0B") # 11 (length of "MC|PingHost")
         @server.write('MC|PingHost'.encode('UTF-16BE').force_encoding('ASCII-8BIT'))
@@ -376,6 +393,10 @@ class MineStat
       $stderr.puts exception
       return Retval::UNKNOWN
     end
+    if retval == Retval::SUCCESS
+      @request_type = "SLP 1.6 (extended legacy)"
+      set_connection_status(retval)
+    end
     return retval
   end
 
@@ -402,7 +423,6 @@ class MineStat
         retval = connect()
         return retval unless retval == Retval::SUCCESS
         # Perform handshake
-        @request_type = "SLP 1.7 (JSON)"
         payload = "\x00\x00"
         payload += [@address.length].pack('c') << @address
         payload += [@port].pack('n')
@@ -428,6 +448,11 @@ class MineStat
         strip_motd
         @current_players = json_data['players']['online'].to_i
         @max_players = json_data['players']['max'].to_i
+        @favicon_b64 = json_data['favicon']
+        if !@favicon_b64.nil? && !@favicon_b64.empty?
+          @favicon_b64 = favicon_b64.split("base64,")[1]
+          @favicon = Base64.decode64(favicon_b64)
+        end
         if !@version.empty? && !@motd.empty? && !@current_players.nil? && !@max_players.nil?
           @online = true
         else
@@ -442,6 +467,10 @@ class MineStat
       $stderr.puts exception
       return Retval::UNKNOWN
     end
+    if retval == Retval::SUCCESS
+      @request_type = "SLP 1.7 (JSON)"
+      set_connection_status(retval)
+    end
     return retval
   end
 
@@ -508,7 +537,6 @@ class MineStat
     retval = nil
     begin
       Timeout::timeout(@timeout) do
-        @request_type = "Bedrock/Pocket Edition"
         retval = connect()
         return retval unless retval == Retval::SUCCESS
         # Perform handshake and acquire data
@@ -526,6 +554,10 @@ class MineStat
       $stderr.puts exception
       return Retval::UNKNOWN
     end
+    if retval == Retval::SUCCESS
+      @request_type = "Bedrock/Pocket Edition"
+      set_connection_status(retval)
+    end
     return retval
   end
 
@@ -569,12 +601,21 @@ class MineStat
   # servers with a version greater than or equal to 1.7
   attr_reader :json_data
 
+  # Returns the base64-encoded favicon from JSON 1.7 queries
+  attr_reader :favicon_b64
+
+  # Returns the decoded favicon from JSON 1.7 queries
+  attr_reader :favicon
+
   # Returns the ping time to the server in ms
   attr_reader :latency
 
   # Returns the protocol version
   attr_reader :request_type
 
+  # Returns the connection status
+  attr_reader :connection_status
+
   # Returns whether or not all ping protocols should be attempted
   attr_reader :try_all
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minestat
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.3
 platform: ruby
 authors:
 - Lloyd Dilley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies: []
 description: MineStat polls Minecraft server data such as version, motd, current players,
   and max players.
@@ -38,8 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Minecraft server status checker