game_dig 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5292bd7b7c7bddd3fa91f1081e6b9dbe2497f9036680047e55d14f4e25f5752b
-  data.tar.gz: f51410f39c2b62206bf3e2437e22793116ea04e48d8f24ac00b571b952f61688
+  metadata.gz: 1606417a646f32a9d14cf9c257d469059ec2cee23135750b869e1347224e61bd
+  data.tar.gz: 79f5027b3737ee03265083ada485ce45a4cd1998550076b10bc802116f33a9bd
 SHA512:
-  metadata.gz: c5eb259271be2e071f5f31b6002465c21492c3bb43faa3cd5f3f22426b6d6339fd20a0ffb3ee8cf9b2e06aec9e69c8a6c44c0ddaf3e465c76e8572ac8932e77c
-  data.tar.gz: 8a08df836cec0cdfbff4308d961c3c6e29a6026897a6c815dcd96b6747805ea6582fba323071c899673f8cdcd2f0745252b88ab5074cd17dcf721d3779b7d11f
+  metadata.gz: 8003e414913f228ea043a64904f0a477dac28fb2881086f5ac89bbf6d52d6f3b0c5dc1dd8c2f594d48dbc126fddb4dfa88767d77c0beb965ad907e150fdf3858
+  data.tar.gz: acf5a2889986077010cc105cdf8324d692284fd91db41deaac8e7d1a383c219779d9e8e56c94a08ca6a5713e9286022072185da066e662764a7eb5f8fa800720

data/.gitignore

@@ -12,4 +12,10 @@
 *.gem
 
 # rspec failure tracking
-.rspec_status
+.rspec_status
+
+
+/lib/node/node_modules
+/lib/node/yarn.lock
+/lib/node/package-lock.json
+/playground.rb

data/README.md

@@ -69,8 +69,11 @@ This will just run the gamedig cli and return its result.
     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.
+### Service wrapper (experimental, only did some testing on linux)
+
+Only the following parameters are implemented for the service wrapper: `type, host, protocol` (version 0.1.0)
+
+Behaves the same to the user, but runs a tiny node webservice in the background to avoid startup times when called more than one time.
 
 ```
 your-ruby-app 

data/Rakefile

@@ -19,4 +19,12 @@ task :cli do |t|
   require_relative 'cli/pry'
 end
 
+desc "start service cli to play with the environment"
+task :cli_service do |t|
+  puts
+  puts %{ Starting CLI ... }.red
+  puts
+  require_relative 'cli/pry_service'
+end
+
 RSpec::Core::RakeTask.new(:spec)

data/cli/pry_service.rb

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

data/lib/game_dig/game_dig_helper.rb

@@ -0,0 +1,68 @@
+require 'uri'
+require 'net/http'
+
+class GameDigHelper
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.node_service_running?
+    port_open? '127.0.0.1', 24445
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.stop_node_service
+    begin
+      uri = URI("http://127.0.0.1:24445/exit")
+      res = Net::HTTP.get_response(uri)
+    rescue Errno::ECONNREFUSED => e
+      # will be refused, as /exit closes the server and makes no more response
+    end
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  #
+  # 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
+
+  #----------------------------------------------------------------------------------------------------
+
+  private
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.port_open?(ip, port, seconds = 0.5)
+    # => checks if a port is open or not on a remote host
+    Timeout::timeout(seconds) do
+      begin
+        TCPSocket.new(ip, port).close
+        true
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError
+        false
+      end
+    end
+  rescue Timeout::Error
+    false
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+end

data/lib/game_dig/service.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require 'net/http'
+require 'benchmark'
+
+require_relative 'game_dig_helper'
+
+node_js_app_base_path = File.expand_path(File.dirname(__FILE__) + '/../node/')
+node_js_app_js_path = File.expand_path(node_js_app_base_path + '/gamedig-service.js')
+
+unless Dir.exist?(node_js_app_base_path + '/node_modules')
+  puts "GameDig Service: Install missing dependencies ..."
+  if !!GameDigHelper.which('yarn')
+    `cd "#{node_js_app_base_path}" && yarn install`
+  elsif !!GameDigHelper.which('npm')
+    `cd "#{node_js_app_base_path}" && npm install`
+  else
+    raise "Neither 'yarn' nor 'npm' found!"
+  end
+  puts "done"
+end
+
+
+unless GameDigHelper.node_service_running?
+  node_js_thread = Thread.new do |t|
+    system %Q(cd "#{node_js_app_base_path}" && node ./gamedig-service.js)
+    at_exit do
+      node_js_thread.exit
+    end
+  end
+end
+
+ENV['GAMEDIG_SERVICE'] = 'true'
+
+at_exit do
+  GameDigHelper.stop_node_service
+end
+
+require_relative '../game_dig'

data/lib/game_dig/version.rb

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

data/lib/game_dig.rb

@@ -1,5 +1,9 @@
-require 'mkmf'
-require 'game_dig/version'
+require 'uri'
+require 'net/http'
+require 'json'
+
+require_relative 'game_dig/version'
+require_relative 'game_dig/game_dig_helper'
 require_relative 'custom_errors/game_dig_error'
 require_relative 'custom_errors/game_dig_cli_not_found'
 
@@ -10,6 +14,7 @@ require_relative 'custom_errors/game_dig_cli_not_found'
 module GameDig
 
   DEBUG_MESSAGE_END = 'Q#0 Query was successful'
+  @@node_service_up = false
 
   #----------------------------------------------------------------------------------------------------
 
@@ -25,7 +30,21 @@ module GameDig
   # @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?
+    if ENV['GAMEDIG_SERVICE'] == 'true'
+      perform_service_query(type: type, host: host, port: port, max_attempts: max_attempts, socket_timeout: socket_timeout, attempt_timeout: attempt_timeout, given_port_only: given_port_only, debug: debug, request_rules: request_rules)
+    else
+      perform_cli_query(type: type, host: host, port: port, max_attempts: max_attempts, socket_timeout: socket_timeout, attempt_timeout: attempt_timeout, given_port_only: given_port_only, debug: debug, request_rules: request_rules)
+    end
+  end
+
+  #----------------------------------------------------------------------------------------------------
+
+  private
+
+  #----------------------------------------------------------------------------------------------------
+
+  def self.perform_cli_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 GameDigHelper.cli_installed?
     command = "gamedig --type #{type}"
     command += " --port #{port}" if port
     command += " --maxAttempts #{max_attempts}" if max_attempts
@@ -35,7 +54,6 @@ module GameDig
     command += " --debug #{debug}" if debug
     command += " --requestRules" if request_rules
     command += " #{host}"
-    puts command
     begin
       output = `#{command}`
       json = if debug
@@ -58,27 +76,33 @@ module GameDig
 
   #----------------------------------------------------------------------------------------------------
 
-  private
-
-  #
-  # Check if gamedig cli is installed globally
-  #
-  # @return [Boolean]
-  def self.cli_installed?()
-    !!(which 'gamedig')
+  def self.perform_service_query(type:, host:, port: nil, max_attempts: nil, socket_timeout: nil, attempt_timeout: nil, given_port_only: nil, debug: nil, request_rules: nil)
+    ensure_node_service_is_up
+    hostname = host
+    hostname += ":#{port}" if port
+    uri = URI("http://127.0.0.1:24445/#{type}/#{hostname}")
+    res = Net::HTTP.get_response(uri)
+    res.body
   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)
+  def self.ensure_node_service_is_up
+    max_counter = 100
+    counter = 0
+    unless @@node_service_up
+      loop do
+        counter += 1
+        if GameDigHelper.node_service_running?
+          break
+        elsif counter >= max_counter
+          raise "Node gamedig service did not boot up properly ..."
+          break
+        end
+        sleep 0.1
       end
+      @@node_service_up = true
     end
-    nil
   end
 
   #----------------------------------------------------------------------------------------------------

data/lib/node/gamedig-service.js

@@ -0,0 +1,46 @@
+const Gamedig = require('gamedig');
+const Hapi = require('@hapi/hapi');
+
+const server = Hapi.server({
+    port: 24445,
+    host: 'localhost'
+});
+
+const init = async () => {
+
+    server.route({
+        method: 'GET',
+        path: '/exit',
+        handler: async (request, h) => {
+            server.stop();
+            process.exit(0);
+            return '';
+        }
+    });
+
+    server.route({
+        method: 'GET',
+        path: '/{type}/{ip}',
+        handler: async (request, h) => {
+
+            const { type, ip } = request.params;
+            const [ host, port ] = ip.split(':')
+
+            const serverData = await Gamedig.query({
+                type: type,
+                host,
+                port
+            });
+            return serverData;
+        }
+    });
+
+    await server.start();
+};
+
+process.on('unhandledRejection', (err) => {
+    console.error(err);
+});
+
+init();
+

data/lib/node/package.json

@@ -0,0 +1,9 @@
+{
+  "scripts": {
+    "start": "node ./gamedig-service.js"
+  },
+  "dependencies": {
+    "@hapi/hapi": "^21.1.0",
+    "gamedig": "^4.0.5"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: game_dig
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,11 +97,16 @@ files:
 - bin/console
 - bin/setup
 - cli/pry.rb
+- cli/pry_service.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/game_dig_helper.rb
+- lib/game_dig/service.rb
 - lib/game_dig/version.rb
+- lib/node/gamedig-service.js
+- lib/node/package.json
 homepage: https://github.com/magynhard/ruby-game_dig
 licenses:
 - MIT