qwtf_discord_bot 1.0.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8e58ec71ee8bd2d0b1d3c136ab6e95991d1930e7b574050a56e19c68623045f
-  data.tar.gz: 621bd7f227c1e056330ba8452a28a2f8cd993f5aff308ec9b1f9b6a9e893aa98
+  metadata.gz: 0b27a7b9906ac7f444707b27c3f59accc8df4c91dfd5ce27d1f0db727eb0aba1
+  data.tar.gz: 341f084c7be0fd7a3305028dc6548d9723614e350f1e203e5e18506d0e17b422
 SHA512:
-  metadata.gz: 254f5e3c1a18672d2dd268dfdc9631b6813a33529df05fdabb247cd44401e0fd9e9fff160bfabb4af6105166431eed1610be5c14bdd5000d569bf152362404b6
-  data.tar.gz: b61452080f0bde1a36243814e7de7ae27db688945659d26a430c9a458ae4efffed7d6df7426cc3bbb4eb115a8f39320868d44fc456a32178f044521eab19e8c8
+  metadata.gz: 88d5dbf22c9235b956b0b63635586f157222ab175350af41ff4048221ee1dab5d3a048468e4350ac3419fa6ff566c5b22c62a5ab4834550267bd3ea43e6bf9eb
+  data.tar.gz: b056461ec34f9889d9eac15bdb03ab5e9d29f9250c294616e83e79f818c729fe23707b19b68352294b7c9843656929a60782fd5f38870191e55fdfef918b10d0

data/Gemfile.lock

@@ -1,53 +1,56 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (1.0.6)
-      discordrb
-      thor
+    qwtf_discord_bot (1.0.8)
+      discordrb (~> 3.3)
+      thor (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    discordrb (3.2.1)
-      discordrb-webhooks (~> 3.2.0.1)
+    discordrb (3.3.0)
+      discordrb-webhooks (~> 3.3.0)
+      ffi (>= 1.9.24)
       opus-ruby
       rbnacl (~> 3.4.0)
-      rest-client
+      rest-client (>= 2.1.0.rc1)
       websocket-client-simple (>= 0.3.0)
-    discordrb-webhooks (3.2.0.1)
-      rest-client
+    discordrb-webhooks (3.3.0)
+      rest-client (>= 2.1.0.rc1)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     event_emitter (0.2.6)
-    factory_bot (4.11.0)
-      activesupport (>= 3.0.0)
-    ffi (1.9.25)
+    factory_bot (5.0.2)
+      activesupport (>= 4.2.0)
+    ffi (1.11.1)
+    http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.1.0)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.0)
+    method_source (0.9.2)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2019.0331)
     minitest (5.11.3)
     netrc (0.11.0)
     opus-ruby (1.0.1)
       ffi
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rbnacl (3.4.0)
       ffi
-    rest-client (2.0.2)
+    rest-client (2.1.0.rc1)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
@@ -55,22 +58,22 @@ GEM
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.1)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    thor (0.20.0)
+    rspec-support (3.8.2)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.6)
     websocket (1.2.8)
     websocket-client-simple (0.3.0)
       event_emitter

data/README.md

@@ -25,16 +25,16 @@ Edit the `.env.example` file, update with your bot's `client_id` and `token` and
 
 ### List commands
 
-    $ bundle exec exe/qwtf-discord-bot server help
+    $ bundle exec exe/qwtf-discord-bot help
 
 There are two features:
 
 
 ### Server
 
-This responds to `!server` messages by providing information about your game
+This responds to `!servers` messages by providing information about your game
 server. Defaults to the hostname command line argument, but will accept a
-hostname from the user. I.E. `!server fortressone.ga`
+hostname from the user. I.E. `!server fortressone.org`
 
 ![screenshot of bot responding to !server command](server_screenshot.png)
 
@@ -43,15 +43,15 @@ Usage:
   qwtf_discord_bot server
 
 Options:
-  [--hostname=HOSTNAME]
-                         # Default: localhost
-  [--port=N]
-                         # Default: 27500
+  [--endpoints=one two three]
+                               # Default: ["localhost:27500"]
 ```
 
 E.G.
 
-    $ bundle exec exe/qwtf-discord-bot server --hostname fortressone.ga --port 27501
+    $ qwtf-discord-bot server --endpoints \
+          sydney.fortressone.org:27500 \
+          sydney.fortressone.org:27501
 
 
 ### Watcher
@@ -67,15 +67,13 @@ Usage:
   qwtf_discord_bot watcher
 
 Options:
-  [--hostname=HOSTNAME]
-                         # Default: localhost
-  [--port=N]
-                         # Default: 27500
+  [--endpoints=one two three]
+                               # Default: ["localhost:27500"]
 ```
 
 E.G.
 
-    $ bundle exec exe/qwtf-discord-bot watcher --hostname fortressone.ga --port 27501
+    $ bundle exec exe/qwtf-discord-bot watcher --endpoints sydney.fortressone.org:27501
 
 
 ## License

data/exe/qwtf_discord_bot

@@ -9,22 +9,16 @@ class QwtfDiscordBotExe < Thor
   end
 
   desc 'server', 'Responds to `!server` with server information'
-  method_option :hostname, alias: '-h', default: 'localhost'
-  method_option :port, type: :numeric, alias: '-p', default: 27500
+  method_option :endpoints, type: :array, alias: '-e', default: ['localhost:27500']
   def server
-    hostname = options['hostname']
-    port = options['port']
-    server_bot = QwtfDiscordBotServer.new(hostname: hostname, port: port)
+    server_bot = QwtfDiscordBotServer.new(options[:endpoints])
     server_bot.run
   end
 
   desc 'watcher', 'Watches server and accounces when a player joins'
-  method_option :hostname, alias: '-h', default: 'localhost'
-  method_option :port, type: :numeric, alias: '-p', default: 27500
+  method_option :endpoints, type: :array, alias: '-e', default: ['localhost:27500']
   def watcher
-    hostname = options['hostname']
-    port = options['port']
-    watcher_bot = QwtfDiscordBotWatcher.new(hostname: hostname, port: port)
+    watcher_bot = QwtfDiscordBotWatcher.new(options[:endpoints])
     watcher_bot.run
   end
 end

data/lib/player.rb

@@ -28,7 +28,7 @@ class Player
   end
 
   def team
-    return 'spec' unless valid_score?
+    return 'spec' if !valid_score? || @data['team'].empty?
     @data['team']
   end
 

data/lib/qstat_request.rb

@@ -28,8 +28,8 @@ class QstatRequest
 
   def server_summary
     return "#{@endpoint} isn't responding" unless game_map
-    return "#{@endpoint} | #{game_map} | #{numplayers}/#{maxplayers}" unless has_spectators?
-    "#{@endpoint} | #{game_map} | #{numplayers}/#{maxplayers} players | #{numspectators}/#{maxspectators} spectators" 
+    return "#{name} | #{@endpoint} | #{game_map} | #{numplayers}/#{maxplayers}" unless has_spectators?
+    "#{name} | #{@endpoint} | #{game_map} | #{numplayers}/#{maxplayers} players | #{numspectators}/#{maxspectators} spectators"
   end
 
   def is_empty?
@@ -40,16 +40,16 @@ class QstatRequest
     players.map(&:name)
   end
 
+  def has_players?
+    numplayers && numplayers > 0
+  end
+
   private
 
     def has_spectators?
       numspectators && numspectators > 0
     end
 
-    def has_players?
-      numplayers && numplayers > 0
-    end
-
     def teams
       @teams ||= build_roster
     end
@@ -66,6 +66,10 @@ class QstatRequest
       players.sort_by { |player| player.team.number }.map(&:to_row).join("\n")
     end
 
+    def name
+      data["name"]
+    end
+
     def address
       data["address"]
     end

data/lib/qwtf_discord_bot.rb

@@ -10,19 +10,21 @@ require 'emoji'
 require 'roster'
 
 class QwtfDiscordBot
+  ENV_VARS = [
+    'QWTF_DISCORD_BOT_TOKEN',
+    'QWTF_DISCORD_BOT_CLIENT_ID',
+    'QWTF_DISCORD_BOT_CHANNEL_ID'
+  ]
+
+  if ENV_VARS.any? { |var| !ENV.key?(var) }
+    raise "Environment variables not configured"
+  end
+
   TOKEN = ENV['QWTF_DISCORD_BOT_TOKEN'].strip
   CLIENT_ID = ENV['QWTF_DISCORD_BOT_CLIENT_ID'].strip
   CHANNEL_ID = ENV['QWTF_DISCORD_BOT_CHANNEL_ID'].strip
 
-  def initialize(hostname:, port:)
-    @hostname = hostname
-    @port = port
-  end
-
-  def endpoint
-    @endpoint ||= begin
-                    return @hostname if @port == 27500
-                    [@hostname, @port].join(':')
-                  end
+  def initialize(endpoints)
+    @endpoints = endpoints
   end
 end

data/lib/qwtf_discord_bot/qwtf_discord_bot_server.rb

@@ -1,3 +1,4 @@
+require 'pry'
 class QwtfDiscordBotServer < QwtfDiscordBot
   def run
     bot = Discordrb::Commands::CommandBot.new(
@@ -7,16 +8,49 @@ class QwtfDiscordBotServer < QwtfDiscordBot
     )
 
     bot.command :server do |event, *args|
-      hostname = args.first || endpoint
-      qstat_request = QstatRequest.new(hostname)
-      message = qstat_request.server_summary
-      embed = qstat_request.to_embed
-
-      if embed
-        event.channel.send_embed(message, embed)
+      if args.empty?
+        event.channel.send_message(
+          "Provide a server address e.g. `!server location.fortressone.org` or use `!servers`"
+        )
       else
-        event.channel.send_message(message)
+        endpoint = args.first
+        qstat_request = QstatRequest.new(endpoint)
+        message = qstat_request.server_summary
+        embed = qstat_request.to_embed
+
+        if embed
+          event.channel.send_embed(message, embed)
+        else
+          event.channel.send_message(message)
+        end
+      end
+    end
+
+    bot.command :servers do |event|
+      qstat_requests = @endpoints.map do |endpoint|
+        QstatRequest.new(endpoint)
+      end
+
+      message = qstat_requests.map(&:server_summary).join("\n")
+      event.channel.send_message(message)
+    end
+
+    bot.command :active do |event|
+      qstat_requests = @endpoints.map do |endpoint|
+        QstatRequest.new(endpoint)
       end
+
+      servers_with_players = qstat_requests.select(&:has_players?)
+
+      message = begin
+                  if servers_with_players.empty?
+                    "All ##{event.channel.name} servers are empty."
+                  else
+                    servers_with_players.map(&:server_summary).join("\n")
+                  end
+                end
+
+      event.channel.send_message(message)
     end
 
     bot.run

data/lib/qwtf_discord_bot/qwtf_discord_bot_watcher.rb

@@ -4,15 +4,18 @@ class QwtfDiscordBotWatcher < QwtfDiscordBot
 
   def run
     every(THIRTY_SECONDS) do
-      request = QstatRequest.new(endpoint)
+      @endpoints.each do |endpoint|
+        request = QstatRequest.new(endpoint)
 
-      unless request.is_empty?
-        request.player_names.each do |name|
-          unless seen_recently?(name)
-            report_joined(name: name, server_summary: request.server_summary)
-          end
+        unless request.is_empty?
+          request.player_names.each do |name|
+            unless seen_recently?(endpoint: endpoint, name: name)
+              report_joined(name: name, server_summary: request.server_summary)
+            end
 
-          history[name] = Time.now
+            history[endpoint] ||= {}
+            history[endpoint][name] = Time.now
+          end
         end
       end
     end
@@ -27,8 +30,8 @@ class QwtfDiscordBotWatcher < QwtfDiscordBot
     end
   end
 
-  def seen_recently?(name)
-    last_seen = history[name]
+  def seen_recently?(endpoint:, name:)
+    last_seen = history[endpoint] && history[endpoint][name]
     last_seen && (Time.now - last_seen < TEN_MINUTES)
   end
 

data/lib/qwtf_discord_bot/version.rb

@@ -1,3 +1,3 @@
 class QwtfDiscordBot
-  VERSION = '1.0.8'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/qwtf_discord_bot.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.description   = 'A Discord bot for reporting on QuakeWorld Team ' \
                        'Fortress game servers'
 
-  spec.summary       = 'Works by wrapping the excellent CLI server query tool' \
-                       'qstat. Accepts the !server command from users and ' \
+  spec.summary       = 'Works by wrapping the excellent CLI server query tool ' \
+                       'qstat. Accepts !server, !servers and !active commands ' \
                        'also periodically checks for new players on the ' \
                        'server and reports about them.'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 2.0.0
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-23 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -120,7 +120,7 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Works by wrapping the excellent CLI server query toolqstat. Accepts the !server
-  command from users and also periodically checks for new players on the server and
-  reports about them.
+summary: Works by wrapping the excellent CLI server query tool qstat. Accepts !server,
+  !servers and !active commands also periodically checks for new players on the server
+  and reports about them.
 test_files: []