game_dig 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5292bd7b7c7bddd3fa91f1081e6b9dbe2497f9036680047e55d14f4e25f5752b
+  data.tar.gz: f51410f39c2b62206bf3e2437e22793116ea04e48d8f24ac00b571b952f61688
+SHA512:
+  metadata.gz: c5eb259271be2e071f5f31b6002465c21492c3bb43faa3cd5f3f22426b6d6339fd20a0ffb3ee8cf9b2e06aec9e69c8a6c44c0ddaf3e465c76e8572ac8932e77c
+  data.tar.gz: 8a08df836cec0cdfbff4308d961c3c6e29a6026897a6c815dcd96b6747805ea6582fba323071c899673f8cdcd2f0745252b88ab5074cd17dcf721d3779b7d11f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+/.idea/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at game_dig.gemspec@mail.magynhard.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Matthäus J. N. Beyrle
+
+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,110 @@
+# GameDig for Ruby
+![Gem](https://img.shields.io/gem/v/game_dig?color=default&style=plastic&logo=ruby&logoColor=red)
+![Gem](https://img.shields.io/gem/dt/game_dig?color=blue&style=plastic)
+[![License: MIT](https://img.shields.io/badge/License-MIT-gold.svg?style=plastic&logo=mit)](LICENSE)
+
+> Ruby wrapper gem for [node-gamedig](https://github.com/gamedig/node-gamedig).
+
+Providing support to use the node cli or running a tiny webservice for faster responses.
+
+
+
+
+
+# Contents
+
+* [Installation](#installation)
+* [Usage examples](#usage)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+
+
+
+
+<a name="installation"></a>
+## Installation
+### Prerequisites
+NodeJS or a compatible alternative is installed.
+
+Then install the gamedig package with your favourite package manager globally, e.g. here with npm or yarn:
+
+#### yarn
+```
+    yarn global add gamedig
+```
+
+#### npm
+```
+    npm install -g gamedig
+```
+
+### Gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'game_dig'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install game_dig
+    
+
+<a name="usage"></a>
+## Usage examples
+
+You can use the basic cli wrapper or the tiny webservice instance.
+
+### CLI wrapper
+
+This will just run the gamedig cli and return its result.
+```ruby
+    require 'game_dig'
+    data = GameDig.query(type: 'minecraft', host: 'my-server.example.com')
+    p data
+```
+
+### Service wrapper (not implemented yet!)
+Behaves the same to the user, but runs a tiny node webservice in the background to avoid startup times.
+
+```
+your-ruby-app 
+    --------> ruby-game_dig 
+        --------> tiny node instance in a separate thread using gamedig node module
+<----------------    
+```
+
+It needs only about half of the query time, but might be not as stable as it involves much more complexity. (about 10ms vs 20ms)
+
+```ruby
+    require 'game_dig/service'
+    data = GameDig.query(type: 'minecraft', host: 'my-server.example.com')
+    p data
+```
+
+<a name="documentation"></a>
+## Documentation
+Check out the doc at RubyDoc:<br>
+https://www.rubydoc.info/gems/game_dig
+
+
+As this library is only a wrapper, checkout the original node-gamedig documentation:<br>
+https://github.com/gamedig/node-gamedig
+
+
+
+
+
+
+<a name="contributing"></a>
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/ruby-game_dig. 
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require "json"
+require "colorize"
+
+#
+# run default task to see tasks to build and publish gem
+#
+task :default do
+  system 'rake --tasks'
+end
+
+desc "start cli to play with the environment"
+task :cli do |t|
+  puts
+  puts %{ Starting CLI ... }.red
+  puts
+  require_relative 'cli/pry'
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "game_dig"
+
+# 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/cli/pry.rb

@@ -0,0 +1,5 @@
+
+require_relative '../lib/game_dig'
+
+require 'pry'
+binding.pry

data/game_dig.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'game_dig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "game_dig"
+  spec.version       = GameDig::VERSION
+  spec.authors       = ["Matthäus Beyrle"]
+  spec.email         = ["game_dig.gemspec@mail.magynhard.de"]
+
+  spec.summary       = %q{Ruby wrapper gem for node-gamedig}
+  spec.homepage      = "https://github.com/magynhard/ruby-game_dig"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.14'
+  spec.add_development_dependency 'rake',     '>= 10.0'
+  spec.add_development_dependency 'rspec',    '>= 3.0'
+
+  spec.add_development_dependency 'colorize', '0.8.1'
+  spec.add_development_dependency 'pry',      '0.14.1'
+end

data/lib/custom_errors/game_dig_cli_not_found.rb

@@ -0,0 +1,2 @@
+class GameDigCliNotFound < StandardError
+end

data/lib/custom_errors/game_dig_error.rb

@@ -0,0 +1,2 @@
+class GameDigError < StandardError
+end

data/lib/game_dig/version.rb

@@ -0,0 +1,3 @@
+module GameDig
+  VERSION = '0.0.1'.freeze
+end

data/lib/game_dig.rb

@@ -0,0 +1,86 @@
+require 'mkmf'
+require 'game_dig/version'
+require_relative 'custom_errors/game_dig_error'
+require_relative 'custom_errors/game_dig_cli_not_found'
+
+#
+# GameDig
+#
+
+module GameDig
+
+  DEBUG_MESSAGE_END = 'Q#0 Query was successful'
+
+  #----------------------------------------------------------------------------------------------------
+
+  # Query a server for insight data
+  #
+  # @param [String] type
+  # @param [String] host
+  # @param [Number] port
+  # @param [Number] max_attempts
+  # @param [Number] socket_timeout
+  # @param [Number] attempt_timeout
+  # @param [Boolean] given_port_only
+  # @param [Boolean] debug
+  # @param [Boolean] request_rules
+  def self.query(type:, host:, port: nil, max_attempts: nil, socket_timeout: nil, attempt_timeout: nil, given_port_only: nil, debug: nil, request_rules: nil)
+    throw GameDigCliNotFound unless cli_installed?
+    command = "gamedig --type #{type}"
+    command += " --port #{port}" if port
+    command += " --maxAttempts #{max_attempts}" if max_attempts
+    command += " --socketTimeout #{socket_timeout}" if socket_timeout
+    command += " --attemptTimeout #{attempt_timeout}" if attempt_timeout
+    command += " --givenPortOnly" if given_port_only
+    command += " --debug #{debug}" if debug
+    command += " --requestRules" if request_rules
+    command += " #{host}"
+    puts command
+    begin
+      output = `#{command}`
+      json = if debug
+               output.split(DEBUG_MESSAGE_END).last
+             else
+               output
+             end
+      response = JSON.parse json
+      if debug
+        response['debug'] = output[0...(output.index(DEBUG_MESSAGE_END)+DEBUG_MESSAGE_END.size)]
+      end
+      if response['error']
+        raise GameDigError.new response['error']
+      end
+      response
+    rescue => e
+      raise e
+    end
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  private
+
+  #
+  # Check if gamedig cli is installed globally
+  #
+  # @return [Boolean]
+  def self.cli_installed?()
+    !!(which 'gamedig')
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.which(cmd)
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.each do |ext|
+        exe = File.join(path, "#{cmd}#{ext}")
+        return exe if File.executable?(exe) && !File.directory?(exe)
+      end
+    end
+    nil
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: game_dig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthäus Beyrle
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description:
+email:
+- game_dig.gemspec@mail.magynhard.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cli/pry.rb
+- game_dig.gemspec
+- lib/custom_errors/game_dig_cli_not_found.rb
+- lib/custom_errors/game_dig_error.rb
+- lib/game_dig.rb
+- lib/game_dig/version.rb
+homepage: https://github.com/magynhard/ruby-game_dig
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby wrapper gem for node-gamedig
+test_files: []