q2_server_query 0.9.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '022917b6430f59e38a4a624e99d0f6fdb372e283'
+  data.tar.gz: '08203c452d60b077f10a4461013b7e1294c34b36'
+SHA512:
+  metadata.gz: 00c295954871ad600ce376711b143336109d583cd0b3b1a97b24adf81ae17ebdd85844c31a3d9d3840bd7f8f9539f811f9bc11c4346ffca5217449528c147d6d
+  data.tar.gz: 38b691f1791a98de781356d657d70e65fdb2c697d0eb38d929bf9a18475130166ece33963889668b9b52944c9b6276bee9d1e4e31afed6ea175fac828ab24343

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in q2_server_query.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    q2_server_query (0.9.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  q2_server_query!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Feña Agar
+
+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,87 @@
+# Q2ServerQuery
+
+I got tired of finding workarounds to query Q2 Servers by using JS libraries or other language implementations, so I created this simple gem.
+
+**NOTE: This works ONLY with Quake 2 servers, it's not adapted for other protocols, but it might work with game servers that use the same protocol**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'q2_server_query'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install q2_server_query
+
+## Usage
+
+```ruby
+client = Q2ServerQuery::Client.new("your.serverhostname.com (or IP)", server_port)
+client.status
+
+# Using AQ2 Server as example.
+=> {
+ "*Q2Admin"=>"2.0~fa34812",
+ "_admin"=>"some_admin_name",
+ "actionversion"=>"TNG 2.81 2017-08-25 07abb71",
+ "allitem"=>"0",
+ "allweapon"=>"0",
+ "capturelimit"=>"0",
+ "cheats"=>"0",
+ "ctf"=>"0",
+ "deathmatch"=>"1",
+ "dmflags"=>"768",
+ "fraglimit"=>"0",
+ "game"=>"action",
+ "gamedate"=>"Feb 21 2018",
+ "gamedir"=>"action",
+ "gamename"=>"action",
+ "hostname"=>"AQ2 Server",
+ "items"=>"1",
+ "mapname"=>"teamjungle",
+ "maptime"=>"0:00",
+ "matchmode"=>"0",
+ "maxclients"=>"16",
+ "needpass"=>"0",
+ "port"=>"27910",
+ "protocol"=>"34",
+ "q2a_mvd"=>"1.6hau",
+ "roundlimit"=>"10",
+ "roundtimelimit"=>"2",
+ "t1"=>"0",
+ "t2"=>"0",
+ "t3"=>"0",
+ "teamplay"=>"1",
+ "tgren"=>"1",
+ "timelimit"=>"20",
+ "use_3teams"=>"0",
+ "use_tourney"=>"0",
+ "uptime"=>"1+2:24.11",
+ "players"=>[
+    {"frags"=>"99", "ping"=>"99", "name"=>"some_player"},
+    {"frags"=>"99", "ping"=>"99", "name"=>"another_player"}
+ ]
+}
+```
+
+## Development
+
+1. Fork it.
+2. Do your thang.
+3. Push a PR.
+4. Ping me.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elfenars/q2_server_query.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "q2_server_query"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/q2_server_query/client.rb

@@ -0,0 +1,87 @@
+require 'socket'
+require 'timeout'
+
+module Q2ServerQuery
+  class Client
+    attr_accessor :address, :port
+    attr_reader   :socket, :raw_response, :parsed_response, :players_list
+
+    def initialize(address, port)
+      @socket   = UDPSocket.new
+      @timeout  = 2
+      @address  = address
+      @port     = port
+      @msg      = "\xff\xff\xff\xffstatus\x00"
+    end
+
+    def status
+      response = status_query
+      return nil if response.nil?
+
+      @parsed_response = response.first.split("\\")
+      response_header  = @parsed_response.shift[4..8]
+
+      return if response_header != "print"
+
+      build_status(@parsed_response)
+    end
+
+    private
+
+    def build_status(unparsed_info)
+      basic_info       = {}
+      unparsed_players = nil
+
+      loop do
+        key   = unparsed_info.shift
+        value = unparsed_info.shift
+
+        if value.include? "\n"
+          unparsed_players = value.split("\n")
+          value            = unparsed_players.delete_at(0)
+          basic_info[key]  = value
+          break
+        else
+          basic_info[key] = value
+        end
+      end
+
+      @players_list = build_players(unparsed_players)
+
+      basic_info.merge(players: @players_list).with_indifferent_access
+    end
+
+    def build_players(players)
+      list = []
+      players.each do |player|
+        player_info = player.split(" ")
+        h = {
+          frags: player_info.shift,
+          ping:  player_info.shift,
+          name:  player_info.shift.delete('\\"')
+        }
+
+        list.push h
+      end
+
+      list
+    end
+
+    def status_query
+      begin
+        @raw_response = nil
+        socket.send(@msg, 0, address, port)
+
+        Timeout.timeout(@timeout) do
+          @raw_response = socket.recvfrom(1000)
+        end
+
+        socket.close
+      rescue => e
+        puts "-- Error with server #{address}:#{port}. Reason: #{e}"
+      ensure
+        return @raw_response
+      end
+    end
+  end
+end

data/lib/q2_server_query/version.rb

@@ -0,0 +1,3 @@
+module Q2ServerQuery
+  VERSION = "0.9.6"
+end

data/lib/q2_server_query.rb

@@ -0,0 +1,2 @@
+require "q2_server_query/client"
+require "q2_server_query/version"

data/q2_server_query.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "q2_server_query/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "q2_server_query"
+  spec.version       = Q2ServerQuery::VERSION
+  spec.authors       = ["Feña Agar"]
+  spec.email         = ["ferliagno@gmail.com"]
+
+  spec.summary       = %q{Simple gem to do status queries to quake 2 servers.}
+  spec.description   = %q{Simple gem to do status queries to quake 2 servers.}
+  spec.homepage      = "https://github.com/elfenars/q2_server_query"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: q2_server_query
+version: !ruby/object:Gem::Version
+  version: 0.9.6
+platform: ruby
+authors:
+- Feña Agar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple gem to do status queries to quake 2 servers.
+email:
+- ferliagno@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/q2_server_query.rb
+- lib/q2_server_query/client.rb
+- lib/q2_server_query/version.rb
+- q2_server_query.gemspec
+homepage: https://github.com/elfenars/q2_server_query
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Simple gem to do status queries to quake 2 servers.
+test_files: []