glowstone 1.0.2 → 1.0.3

data/README.md

@@ -27,17 +27,26 @@ Or install it yourself as:
 Glowstone's interface is super simple.  Just instantiate yourself a new server object, like so:
 
 ```ruby
-my_server = Glowstone::Server.new "minecraft.tomheinan.com"
+my_server = Glowstone::Server.new "tomheinan.com"
 ```
 
 ... and Glowstone will whip you up a server object full of all that delicious realtime data you've been craving:
 
 ```ruby
-=> #<Glowstone::Server:0x007ffe250099b8 @host="minecraft.tomheinan.com", @port=25565, @timeout=3, @socket=#<UDPSocket:fd 8>, @motd="Welcome to Arkenfall!", @gamemode="SMP", @version="1.2.5", @plugins=["CraftBukkit on Bukkit 1.2.5-R4.1-MCPC-SNAPSHOT: mod_MinecraftForge ForgeMod", "AdminCmd 6.0.1 (BUILD 01.06.2012 @ 10:41:06)", "WorldEdit 5.3", "ExtraBiomes XL ForgeMod", "WorldGuard 5.5.3", "PermissionsBukkit 1.6"], @map_name="arkenfall", @num_players=1, @max_players=16, @players=["tomheinan"]>
+=> #<Glowstone::Server:0x007f9af2d17768 @host="minecraft.tomheinan.com", @port=25565, @timeout=10, @socket=#<UDPSocket:fd 7>, @motd="Welcome to Arkenfall!", @gamemode="SMP", @version="1.4.7", @plugins=["ThirdRail 1.0.0", "Vault 1.2.22-b277", "AdminCmd 7.2.0 (BUILD 22.01.2013 @ 22:13:34)", "WorldEdit 5.5.1", "TreeAssist 5.0", "WorldGuard 747-e3dfc6a", "PlayerMarkers 0.2.0", "PermissionsBukkit 2.0", "SimpleSpleef 3.4.2"], @map_name="arkenfall", @num_players=1, @max_players=16, @players=["tomheinan"]>
 ```
 
 And that's all there is to it!  No fancy bukkit plugins or server-side scripts required.  If your server object is particularly long-lived and you find yourself wanting to refresh its data, just do `my_server.refresh` and it'll pull down the latest information for you.
 
+### Options and Defaults
+
+```ruby
+Glowstone::Server.new("localhost",
+	:port => 25565,
+	:timeout => 5 # seconds before we give up on the socket connection
+)
+```
+
 ## Troubleshooting
 
 **Help! I'm not receiving any data!**
@@ -45,7 +54,7 @@ And that's all there is to it!  No fancy bukkit plugins or server-side scripts r
 The first thing to do is make sure your server is set up to send it.  Check your `server.properties` file and make sure the `enable-query` flag is set to `true`. Then, make sure your server's firewall allows connections on UDP port `25565`.  If you've changed that value via the `query.port` flag, then you'll also need to specify it when instantiating Glowstone, like so:
 
 ```ruby
-my_server = Glowstone::Server.new("myminecraftserver.com", 12345)
+my_server = Glowstone::Server.new("myminecraftserver.com", :port => 12345)
 ```
 
 ## Contributing

data/lib/glowstone.rb

@@ -4,9 +4,11 @@ require "glowstone/packets"
 
 module Glowstone
 
-	MAGIC_BYTES    = [0xFE, 0xFD]
-	REQUEST_BYTE   = {:challenge => [0x09], :query => [0x00]}
-	CLIENT_ID      = [0x67, 0x6C, 0x6F, 0x77]
-	SOCKET_TIMEOUT = 3 # seconds
+	MAGIC_BYTES  = [0xFE, 0xFD]
+	REQUEST_BYTE = {:challenge => [0x09], :query => [0x00]}
+	CLIENT_ID    = [0x67, 0x6C, 0x6F, 0x77]
+
+	DEFAULT_PORT = 25565
+	DEFAULT_SOCKET_TIMEOUT = 5 # seconds
 
 end

data/lib/glowstone/server.rb

@@ -1,3 +1,4 @@
+require 'resolv'
 require 'socket'
 
 module Glowstone
@@ -8,11 +9,27 @@ module Glowstone
 		attr_accessor :timeout
 		attr_reader :motd, :gamemode, :version, :plugins, :map_name, :num_players, :max_players, :players
 
-		def initialize(host="localhost", port=25565)
-			@host = host
-			@port = port
-			@timeout = SOCKET_TIMEOUT
+		def initialize(host="localhost", options={})
+			
+			# backwards compatibility for old style invocation
+			if options.is_a?(Numeric)
+				options = {:port => options.to_i}
+			end
+
+			# if the host is a srv record, get its info
+			begin
+				resource = Resolv::DNS.new.getresource("_minecraft._tcp.#{host}", Resolv::DNS::Resource::IN::SRV)
+				@host = resource.target.to_s
+				@port = resource.port.to_i
+			rescue
+				@host = host
+				@port = options[:port] ? options[:port].to_i : DEFAULT_PORT
+			end
+
+			# set request timeout
+			@timeout = options[:timeout] ? options[:timeout].to_i : DEFAULT_SOCKET_TIMEOUT
 
+			# create a reusable UDP socket
 			@socket = UDPSocket.new
 			@socket.connect(@host, @port)
 			refresh
@@ -27,7 +44,8 @@ module Glowstone
 			@motd = status.motd.to_s
 			@gamemode = status.gametype.to_s
 			@version = status.version.to_s
-			@plugins = status.plugins.to_s.split(/;\s*/)
+
+			@plugins = status.plugins.to_s.gsub!(/^(craft)?bukkit[^:]*:\s*/i, "").split(/;\s*/)
 			@map_name = status.map_name.to_s
 			@num_players = status.num_players.to_i
 			@max_players = status.max_players.to_i

data/lib/glowstone/version.rb

@@ -1,3 +1,3 @@
 module Glowstone
-	VERSION = "1.0.2"
+	VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glowstone
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-05 00:00:00.000000000 Z
+date: 2013-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata