mc_query 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b2f4ccbe968e103681ebfd6e843e614ccdb94ec36316273674a3b9fd8ac9031
+  data.tar.gz: 88337d11fa1394a7f30ecfe99bda94bbfe54e073e76bc93ba389ddd13fa1c7ef
+SHA512:
+  metadata.gz: 64fdd0b76b5f0f194246c0a9596dcce1dc8cbebe6341563775e7ddb08ea485e90ac283a6cdf1906aa42f135ce1f0cbcbe646ab33628411794f616b4e4615e035
+  data.tar.gz: 17bb53e152eb73df0076970710ad27c22ef4fbdc6f222b01e087dee55fd614ade61b784fd9ff9815bbc133694096ae4e5b58af875af18226c7b0af1c2e2333f3

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mc_query.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Taylor Blau
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# mc-query
+
+MCQuery is a Rubygem that includes ruby bindings to the Minecraft RCON protocol.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mc_query'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mc_query
+
+## Usage
+
+Using `mc_query` is really simple.  Simply stick `require mc_query` at the top of your Ruby file, and then make a query.  Here, I will query the [Overcast Network](http://oc.tc).
+
+```ruby
+require 'mc_query'
+
+mc = MCQuery.new({:ip => 'us.oc.tc'})
+mc.simple_query
+
+# => {
+#      :name => "My Server",
+#      :gametype => "SMP",
+#      :world_name => "world",
+#      :online_players => "0",
+#      :max_players => "150",
+#      :ip => "10.0.0.1",
+#    }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mc_query/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/mc_query.rb

@@ -0,0 +1,5 @@
+require "mc_query/version"
+
+module MCQuery
+  require "mc_query/query"
+end

data/lib/mc_query/connect.rb

@@ -0,0 +1,92 @@
+require 'net/http'
+
+module MCQuery
+  class Query
+    @@MAGIC     = "\xFE\xFD"
+    @@REQUEST   = "#{@@MAGIC}\x00"
+    @@HANDSHAKE = "#{@@MAGIC}\x09"
+
+    def initialize(opts = {})
+      # Merge in the default options
+      opts = {:ip => 'localhost', :port => '25565', :timeout => 8}.merge(opts)
+
+      @ip      = opts[:ip]
+      @port    = opts[:port]
+      @timeout = opts[:timeout]
+
+      # Connect to the server socket (based on the options)
+      @socket = TCPSocket.new(@ip, @port)
+
+      # Generate a session id and store it off
+      @session_id = get_session_id
+    end
+
+    # Public: Do the Minecraft dance (according to the protocol) and
+    #         send back a hash of the result
+    #
+    # Examples
+    #
+    #   simple_query
+    #   # => {
+    #          :name => "My Server",
+    #          :gametype => "SMP",
+    #          :world_name => "world",
+    #          :online_players => "0",
+    #          :max_players => "150",
+    #          :ip => "10.0.0.1",
+    #        }
+    #
+    # Returns the named hash of the data contained in the simple query
+    def simple_query
+      # Store off the challenge key (we'll need this for querying)
+      @challenge = get_challenge_key
+
+      timeout @timeout do
+        query  = @socket.send(encode_data("#{@@REQUEST}#{@session_id}") + @challenge.to_s, 0)
+        buffer = recieve_data
+        parsed = buffer.split("\0", 6)
+        puts parsed
+        {
+            :name           => parsed[0],
+            :gametype       => parsed[1],
+            :world_name     => parsed[2],
+            :online_players => parsed[3],
+            :max_players    => parsed[4],
+            :ip             => parsed[5]
+        }
+      end
+    end
+
+    def get_challenge_key
+      timeout @timeout do
+        # Send the magic bytes, the handshake bytes, and the session id
+        send_data("#{@@HANDSHAKE}#{@session_id}")
+
+        # Get the raw data (splice out the headers, and convert to an int32)
+        raw_key = recieve_data.to_i
+
+        # Pack it as big endian and return it
+        [raw_key].pack("N")
+      end
+    end
+
+    private
+
+    def get_session_id
+      [(rand(32) + 1) & 0x0F0F0F0F].pack("N")
+    end
+
+    def send_data(data)
+      @socket.send(encode_data(data), 0)
+    end
+
+    def encode_data(data)
+      data.force_encoding(Encoding::ASCII_8BIT)
+    end
+
+    def recieve_data
+      # Recieve the data, splicing out the headers
+      @socket.recvfrom(1460)[0][5...-1]
+    end
+  end
+end

data/lib/mc_query/query.rb

@@ -0,0 +1,92 @@
+require 'net/http'
+
+module MCQuery
+  class Query
+    @@MAGIC = "\xFE\xFD"
+    @@REQUEST = "#{@@MAGIC}\x00"
+    @@HANDSHAKE = "#{@@MAGIC}\x09"
+
+    def initialize(opts = {})
+      # Merge in the default options
+      opts = {:ip => 'localhost', :port => '25565', :timeout => 8}.merge(opts)
+
+      @ip = opts[:ip]
+      @port = opts[:port]
+      @timeout = opts[:timeout]
+
+      # Connect to the server socket (based on the options)
+      @socket = UDPSocket.new
+      @socket.connect(@ip, @port)
+
+      # Generate a session id and store it off
+      @session_id = get_session_id
+    end
+
+    # Public: Do the Minecraft dance (according to the protocol) and
+    #         send back a hash of the result
+    #
+    # Examples
+    #
+    #   simple_query
+    #   # => {
+    #          :name => "My Server",
+    #          :gametype => "SMP",
+    #          :world_name => "world",
+    #          :online_players => "0",
+    #          :max_players => "150",
+    #          :ip => "10.0.0.1",
+    #        }
+    #
+    # Returns the named hash of the data contained in the simple query
+    def simple_query
+      # Store off the challenge key (we'll need this for querying)
+      @challenge = get_challenge_key
+
+      timeout @timeout do
+        query = @socket.send(encode_data("#{@@REQUEST}#{@session_id}") + @challenge.to_s, 0)
+        buffer = recieve_data
+        parsed = buffer.split("\0", 6)
+        puts parsed
+        {
+          :name => parsed[0],
+          :gametype => parsed[1],
+          :world_name => parsed[2],
+          :online_players => parsed[3],
+          :max_players => parsed[4],
+          :ip => parsed[5]
+        }
+      end
+    end
+
+    def get_challenge_key
+      timeout @timeout do
+        # Send the magic bytes, the handshake bytes, and the session id
+        send_data("#{@@HANDSHAKE}#{@session_id}")
+
+        # Get the raw data (splice out the headers, and convert to an int32)
+        raw_key = recieve_data.to_i
+
+        # Pack it as big endian and return it
+        [raw_key].pack("N") 
+      end
+    end
+
+    private
+    def get_session_id
+      [(rand(32) + 1) & 0x0F0F0F0F].pack("N")
+    end
+
+    def send_data(data)
+      @socket.send(encode_data(data), 0)
+    end
+
+    def encode_data(data)
+      data.force_encoding(Encoding::ASCII_8BIT)
+    end
+
+    def recieve_data
+      # Recieve the data, splicing out the headers
+      @socket.recvfrom(1460)[0][5...-1]
+    end
+  end
+end

data/lib/mc_query/version.rb

@@ -0,0 +1,3 @@
+module MCQuery
+  VERSION = "0.0.3"
+end

data/mc_query.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mc_query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mc_query"
+  spec.version       = MCQuery::VERSION
+  spec.authors       = ["Taylor Blau"]
+  spec.email         = ["me@ttaylorr.com"]
+  spec.summary       = %q{Ruby bindings to query Minecraft servers based on the RCON protocol.}
+  spec.homepage      = "http://mc.ttaylorr.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: mc_query
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Taylor Blau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- me@ttaylorr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mc_query.rb
+- lib/mc_query/connect.rb
+- lib/mc_query/query.rb
+- lib/mc_query/version.rb
+- mc_query.gemspec
+homepage: http://mc.ttaylorr.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby bindings to query Minecraft servers based on the RCON protocol.
+test_files: []