minestat 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb7df47ea2b1dbc9593527397307a00e553ca5f67e7569d9c3d92bf26c971ef
-  data.tar.gz: 6dd403da69ee5878a58e7b1c973b937f57f04f607d86774fb87febd46514db54
+  metadata.gz: b2824d765e8d40dd3a1087567b27a9a04c9df93427b344c8e47346a0a778f5be
+  data.tar.gz: 5974801cb768bc9a67cd789a0296b569c1f9b14442d7124135c3ddbd8d41886b
 SHA512:
-  metadata.gz: 54c7a4cfd1fb9c07e83529f513dcb800dbd2464044389a18c08f22c8bb7435f963fdfc5acacdd174774f9b65a3dec22391f76f1e856499ca48a64f4f5e03cd9e
-  data.tar.gz: ce1ae19de3e86ded84a5205ec38c50218181add5eaf5965e8578102299c7cd51e316a37bd58437abb2aa6f154d6b067644a0a6485fb9c823972572d3ded02a69
+  metadata.gz: fc7bb79f048f5d280405638d416cb74ef8e0da6873074bd6e1b70c8176c913fc5fa59ffb92aaa3673f972225851b533964402cfc76160d1d5caec4bf207c43a2
+  data.tar.gz: 885fb2073958d8a95f121ed7a45e230987520dd0878744650bfe6ec45082a75a1e5dc9d512e76aff6dad965b3a36e493a76e9e5e6bd085bde14d2dd562eb33e6

data/lib/minestat.rb

@@ -20,29 +20,54 @@ require 'json'
 require 'socket'
 require 'timeout'
 
+##
+# Provides a ruby interface for polling Minecraft server status.
 class MineStat
-  VERSION = "2.1.0"    # MineStat version
-  NUM_FIELDS = 6       # number of values expected from server
-  NUM_FIELDS_BETA = 3  # number of values expected from a 1.8b/1.3 server
-  MAX_VARINT_SIZE = 5  # maximum number of bytes a varint can be
-  DEFAULT_PORT = 25565 # default TCP port
-  DEFAULT_TIMEOUT = 5  # default TCP timeout in seconds
+  # MineStat version
+  VERSION = "2.1.1"
+  # Number of values expected from server
+  NUM_FIELDS = 6
+  # Number of values expected from a 1.8b/1.3 server
+  NUM_FIELDS_BETA = 3
+  # Maximum number of bytes a varint can be
+  MAX_VARINT_SIZE = 5
+  # Default TCP port
+  DEFAULT_PORT = 25565
+  # Default TCP timeout in seconds
+  DEFAULT_TIMEOUT = 5
 
+  ##
+  # Stores constants that represent the results of a server ping
   module Retval
+    # The server ping completed successfully
     SUCCESS = 0
+    # The server ping failed due to a connection error
     CONNFAIL = -1
+    # The server ping failed due to a connection time out
     TIMEOUT = -2
+    # The server ping failed for an unknown reason
     UNKNOWN = -3
   end
 
+  ##
+  # Stores constants that represent the different kinds of server
+  # list pings/requests that a Minecraft server might expect when
+  # being polled for status information.
   module Request
+    # Try everything
     NONE = -1
+    # Server versions 1.8b to 1.3
     BETA = 0
+    # Server versions 1.4 to 1.5
     LEGACY = 1
+    # Server version 1.6
     EXTENDED = 2
+    # Server versions 1.7 to latest
     JSON = 3
   end
 
+  ##
+  # 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)
     @address = address # address of server
     @port = port       # TCP port of server
@@ -94,22 +119,25 @@ class MineStat
   end
 
   # Strips message of the day formatting characters
-  def strip_motd(is_json = false)
-    unless is_json
-      @stripped_motd = @motd.gsub(/§./, "")
-    else
+  def strip_motd()
+    unless @motd['text'] == nil
       @stripped_motd = @motd['text']
+    else
+      @stripped_motd = @motd
+    end
+    unless @motd['extra'] == nil
       json_data = @motd['extra']
       unless json_data.nil? || json_data.empty?
         json_data.each do |nested_hash|
           @stripped_motd += nested_hash['text']
         end
       end
-      @stripped_motd = @stripped_motd.gsub(/§./, "")
     end
+    @stripped_motd = @stripped_motd.gsub(/§./, "")
   end
 
-  # Connects to remote server
+  ##
+  # Establishes a connection to the Minecraft server
   def connect()
     begin
       start_time = Time.now
@@ -137,7 +165,7 @@ class MineStat
         return Retval::UNKNOWN
       end
     rescue => exception
-      $stderr.puts exception
+      #$stderr.puts exception
       return Retval::UNKNOWN
     end
 
@@ -174,14 +202,17 @@ class MineStat
     return Retval::SUCCESS
   end
 
-  # 1.8b/1.3
+  ##
   # 1.8 beta through 1.3 servers communicate as follows for a ping request:
   # 1. Client sends \xFE (server list ping)
   # 2. Server responds with:
   #   2a. \xFF (kick packet)
   #   2b. data length
   #   2c. 3 fields delimited by \u00A7 (section symbol)
-  # The 3 fields, in order, are: message of the day, current players, and max players
+  # The 3 fields, in order, are:
+  # * message of the day
+  # * current players
+  # * max players
   def beta_request()
     retval = nil
     begin
@@ -202,7 +233,7 @@ class MineStat
     return retval
   end
 
-  # 1.4/1.5
+  ##
   # 1.4 and 1.5 servers communicate as follows for a ping request:
   # 1. Client sends:
   #   1a. \xFE (server list ping)
@@ -211,8 +242,14 @@ class MineStat
   #   2a. \xFF (kick packet)
   #   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, and max players
+  # The 6 fields, in order, are:
+  # * 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.
   def legacy_request()
@@ -235,7 +272,7 @@ class MineStat
     return retval
   end
 
-  # 1.6
+  ##
   # 1.6 servers communicate as follows for a ping request:
   # 1. Client sends:
   #   1a. \xFE (server list ping)
@@ -252,8 +289,14 @@ class MineStat
   #   2a. \xFF (kick packet)
   #   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, and max players
+  # The 6 fields, in order, are:
+  # * 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.
   def extended_legacy_request()
@@ -283,7 +326,7 @@ class MineStat
     return retval
   end
 
-  # 1.7
+  ##
   # 1.7 to current servers communicate as follows for a ping request:
   # 1. Client sends:
   #   1a. \x00 (handshake packet containing the fields specified below)
@@ -329,7 +372,7 @@ class MineStat
         @protocol = json_data['version']['protocol'].to_i
         @version = json_data['version']['name']
         @motd = json_data['description']
-        strip_motd(true)
+        strip_motd
         @current_players = json_data['players']['online'].to_i
         @max_players = json_data['players']['max'].to_i
         if !@version.empty? && !@motd.empty? && !@current_players.nil? && !@max_players.nil?
@@ -381,5 +424,46 @@ class MineStat
     return vint
   end
 
-  attr_reader :address, :port, :online, :version, :motd, :stripped_motd, :current_players, :max_players, :protocol, :json_data, :latency, :request_type
+  # Returns the Minecraft server IP
+  attr_reader :address
+
+  # Returns the Minecraft server TCP port
+  attr_reader :port
+
+  # Returns a boolean describing whether the server is online or offline
+  attr_reader :online
+
+  # Returns the Minecraft version that the server is running
+  attr_reader :version
+
+  # Returns the full version of the MOTD
+  #
+  # If you just want the MOTD text, use stripped_motd
+  attr_reader :motd
+
+  # Returns just the plain text contained within the MOTD
+  attr_reader :stripped_motd
+
+  # Returns the current player count
+  attr_reader :current_players
+
+  # Returns the maximum player count
+  attr_reader :max_players
+
+  # Returns the SLP (Server List Ping) protocol level
+  #
+  # This is arbitrary and varies by Minecraft version.
+  # However, multiple Minecraft versions can share the same
+  # protocol level
+  attr_reader :protocol
+
+  # Returns the complete JSON response data for queries to Minecraft
+  # servers with a version greater than or equal to 1.7
+  attr_reader :json_data
+
+  # Returns the ping time to the server in ms
+  attr_reader :latency
+
+  # Returns the SLP (Server List Ping) protocol version
+  attr_reader :request_type
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minestat
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Lloyd Dilley
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies: []
 description: MineStat polls Minecraft server data such as version, motd, current players,
   and max players.
@@ -39,8 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Minecraft server status checker