minestat 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 289592d2813eb1246b9a3033ce10a219513bf0c9cb792951051bdf6f97b20598
-  data.tar.gz: beee739e9c19250fb6663e9561e065dfbcbae817442afe07ca3a21911e5f975a
+  metadata.gz: affbc3d1ec0778e630ea341dbd8afcf5f79a907f2da08554703f4b52d6f7f553
+  data.tar.gz: c65a8af83bc4c81695892c3447480ccde9fc731bab00e28ac7700012b7203341
 SHA512:
-  metadata.gz: ad094493fac2c5b788c7ed86bdcc1e5296715d410cfe435491101fa56aae2bda6cd81644a88ce8caf183e6ae13072e559a073a4a4b42f9a51b0dfe261a46b378
-  data.tar.gz: a757852cab9404fe9937a9a4f9fb7bac2effccd3317173d2abf0bc200a87dea5a6576e382c878be9d15f31b2489298197fafa6f5c1b4eaa1aff75d90f6ab6c16
+  metadata.gz: 62da41df1030d258d4f72ac64c9d4e8f882372e43c2a342712e48b75e016634076ac4537a928e5631ed61448df1e35210e697e0c9dd1023032079e9b6bfb0d54
+  data.tar.gz: f442d1bbe7a625d5ae7eb665da4caf6612465abbb83e031a1ea010e6aa3f7aa0b41c8b74da15f2e06a987702ac440091dd3495701864c2682d0a5b72cf492281

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.0"
+  VERSION = "2.2.2"
   # Number of values expected from server
   NUM_FIELDS = 6
   # Number of values expected from a 1.8b/1.3 server
@@ -32,7 +33,7 @@ class MineStat
   # Maximum number of bytes a varint can be
   MAX_VARINT_SIZE = 5
   # Default TCP port
-  DEFAULT_PORT = 25565
+  DEFAULT_TCP_PORT = 25565
   # Bedrock/Pocket Edition default UDP port
   DEFAULT_BEDROCK_PORT = 19132
   # Default TCP/UDP timeout in seconds
@@ -79,7 +80,7 @@ class MineStat
 
   ##
   # Instantiate an instance of MineStat and poll the specified server for information
-  def initialize(address, port = DEFAULT_PORT, timeout = DEFAULT_TIMEOUT, request_type = Request::NONE)
+  def initialize(address, port = DEFAULT_TCP_PORT, timeout = DEFAULT_TIMEOUT, request_type = Request::NONE)
     @address = address    # address of server
     @port = port          # TCP/UDP port of server
     @online               # online or offline?
@@ -91,10 +92,16 @@ 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
 
     case request_type
       when Request::BETA
@@ -108,7 +115,7 @@ class MineStat
       when Request::BEDROCK
         retval = bedrock_request()
       else
-        # Attempt various SLP ping requests in a particular order. If the
+        # Attempt various ping requests in a particular order. If the
         # connection fails, there is no reason to continue with subsequent
         # requests. Attempts should continue in the event of a timeout
         # however since it may be due to an issue during the handshake.
@@ -127,14 +134,23 @@ class MineStat
         unless retval == Retval::CONNFAIL
           retval = json_request()
         end
-        # Bedrock
-        unless retval == Retval::CONNFAIL
+        # Bedrock/Pocket Edition
+        unless retval == Retval::SUCCESS || retval == Retval::CONNFAIL
           retval = bedrock_request()
         end
     end
+    set_connection_status(retval)
     @online = false unless retval == Retval::SUCCESS
   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
   def strip_motd()
     unless @motd['text'] == nil
@@ -159,7 +175,7 @@ class MineStat
   def connect()
     begin
       if @request_type == Request::BEDROCK || @request_type == "Bedrock/Pocket Edition"
-        @port = DEFAULT_BEDROCK_PORT if @port == DEFAULT_PORT && @request_type == Request::NONE
+        @port = DEFAULT_BEDROCK_PORT if @port == DEFAULT_TCP_PORT && @try_all
         start_time = Time.now
         @server = UDPSocket.new
         @server.connect(@address, @port)
@@ -260,9 +276,9 @@ class MineStat
   #   2b. data length
   #   2c. 3 fields delimited by \u00A7 (section symbol)
   # The 3 fields, in order, are:
-  # * message of the day
-  # * current players
-  # * max players
+  #   * message of the day
+  #   * current players
+  #   * max players
   def beta_request()
     retval = nil
     begin
@@ -293,12 +309,12 @@ class MineStat
   #   2b. data length
   #   2c. 6 fields delimited by \x00 (null)
   # The 6 fields, in order, are:
-  # * the section symbol and 1
-  # * protocol version
-  # * server version
-  # * message of the day
-  # * current players
-  # * max players
+  #   * the section symbol and 1
+  #   * protocol version
+  #   * server version
+  #   * message of the day
+  #   * current players
+  #   * max players
   #
   # The protocol version corresponds with the server version and can be the
   # same for different server versions.
@@ -340,12 +356,12 @@ class MineStat
   #   2b. data length
   #   2c. 6 fields delimited by \x00 (null)
   # The 6 fields, in order, are:
-  # * the section symbol and 1
-  # * protocol version
-  # * server version
-  # * message of the day
-  # * current players
-  # * max players
+  #   * the section symbol and 1
+  #   * protocol version
+  #   * server version
+  #   * message of the day
+  #   * current players
+  #   * max players
   #
   # The protocol version corresponds with the server version and can be the
   # same for different server versions.
@@ -425,6 +441,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
@@ -486,20 +507,21 @@ class MineStat
   #   2b. current time as a long
   #   2c. server GUID as a long
   #   2d. 16-bit magic number
-  #   2e. server ID as a string
+  #   2e. server ID string length
+  #   2f. server ID as a string
   # The fields from the pong response, in order, are:
-  # * edition
-  # * MotD line 1
-  # * protocol version
-  # * version name
-  # * current player count
-  # * maximum player count
-  # * unique server ID
-  # * MotD line 2
-  # * game mode as a string
-  # * game mode as a numeric
-  # * IPv4 port number
-  # * IPv6 port number
+  #   * edition
+  #   * MotD line 1
+  #   * protocol version
+  #   * version name
+  #   * current player count
+  #   * maximum player count
+  #   * unique server ID
+  #   * MotD line 2
+  #   * game mode as a string
+  #   * game mode as a numeric
+  #   * IPv4 port number
+  #   * IPv6 port number
   def bedrock_request()
     retval = nil
     begin
@@ -554,7 +576,7 @@ class MineStat
   # Returns the maximum player count
   attr_reader :max_players
 
-  # Returns the SLP (Server List Ping) protocol level
+  # Returns the protocol level
   #
   # This is arbitrary and varies by Minecraft version.
   # However, multiple Minecraft versions can share the same
@@ -565,9 +587,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 SLP (Server List Ping) protocol version
+  # 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.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Lloyd Dilley
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-01 00:00:00.000000000 Z
+date: 2022-11-12 00:00:00.000000000 Z
 dependencies: []
 description: MineStat polls Minecraft server data such as version, motd, current players,
   and max players.
@@ -23,7 +23,7 @@ homepage: https://github.com/FragLand/minestat
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -38,8 +38,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.2.5
+signing_key: 
 specification_version: 4
 summary: Minecraft server status checker
 test_files: []