qwtf_discord_bot 6.1.3 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef8bda609c0735d9ba3ba074c3f53a963c2d2cc7f933af4965ba9fb797b7d151
-  data.tar.gz: de760869c4380aa7d14ec16b7828655b1534c41aa3808a6c26d8f36a5694e7dd
+  metadata.gz: ce51af5b4d0cad9d10f44446ef2191b99188a17a1f5f4c7a460a7b8e64c91a2e
+  data.tar.gz: cbffbf577b7a3f61ea59d6ec18fa2a4a8cecae8dab8e6c9409e0892907bb5aea
 SHA512:
-  metadata.gz: ec8f53ff7b12188bab9059db811c478b7010a105e7d37e626816da5d03003502030515e7ab918b521ec0d6dd7998c1a776be332d8a1fdc1fa2a8935df4fb272b
-  data.tar.gz: 4812904a6c1dd2824f08bd376239760c8506329438c26dae718ac809a123e6201547ad40f77de1bd3cab91781234022f6f914ba4f1abc21eba9c19c6f0e7999b
+  metadata.gz: 8e0a30ef32c41f1c7514ff78c3ac025ad771cdcd56758e86fe88ab4211836a0a01477db6c28ceadd393f55e358e26e97f1efaa41f413226fce666f3679dbac0f
+  data.tar.gz: 335081f9a5318c1a3ad4fc3bd03e97c6f260497f188c55d2783c033c230bc26b74a1ac207300d99601f3560e4834ce614b213bd5bcce8aab728e4928b76b9a62

data/Gemfile

@@ -6,9 +6,11 @@ gem 'bundler'
 gem 'discordrb', '3.4.0'
 gem 'redis'
 gem 'thor'
+gem 'activesupport'
 
 group :development do
   gem 'pry'
+  gem 'dotenv'
 end
 
 group :test do

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (6.1.3)
+    qwtf_discord_bot (6.2.1)
+      activesupport (~> 6.1)
       discordrb (= 3.4.0)
       redis (~> 4.2)
       thor (~> 1.1)
@@ -28,6 +29,7 @@ GEM
       rest-client (>= 2.1.0.rc1)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.6)
     event_emitter (0.2.6)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
@@ -83,8 +85,10 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  activesupport
   bundler
   discordrb (= 3.4.0)
+  dotenv
   factory_bot
   pry
   qwtf_discord_bot!
@@ -93,4 +97,4 @@ DEPENDENCIES
   thor
 
 BUNDLED WITH
-   2.2.8
+   2.2.21

data/README.md

@@ -105,6 +105,7 @@ This responds to discord messages:
   - `!maps`
   - `!map [map_name]`
   - `!choose [n]`
+  - `!shuffle`
   - `!win <team_no>`
   - `!draw`
   - `!notify <@role>`

data/VERSION

@@ -1 +1 @@
-6.1.3
+6.2.1

data/exe/qwtf_discord_bot

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'dotenv/load'
 require 'qwtf_discord_bot'
 require 'thor'
 require 'pry'

data/lib/qwtf_discord_bot/qwtf_discord_bot_pug.rb

@@ -2,6 +2,7 @@
 
 require 'pug'
 require 'event_decorator'
+require 'active_support/core_ext/array/conversions'
 
 class QwtfDiscordBotPug # :nodoc:
   include QwtfDiscordBot
@@ -9,6 +10,29 @@ class QwtfDiscordBotPug # :nodoc:
   MSG_SNIPPET_DELIMITER = ' · '
   TEAM_NAMES = { 1 => "Blue", 2 => "Red" }
   TEN_MINUTES = 10 * 60
+  VALID_MENTION = /<@!?\d+>/
+
+  COMMANDS = <<~MESSAGE
+    `!status` Shows who has joined
+    `!join [@player1] [@player2]` Join PUG. Can also join other players
+    `!leave` Leave PUG
+    `!kick <@player> [@player2]` Kick one or more other players
+    `!team <team_no> [@player1] [@player2]` Join team
+    `!unteam [@player1] [@player2]` Leave team and go to front of queue
+    `!choose [n]` Choose fair teams. Pass number for nth fairest team
+    `!shuffle` Choose random teams.
+    `!win <team_no>` Report winning team
+    `!draw` Report draw
+    `!end` End PUG. Kicks all players
+    `!teamsize <no_of_players>` Set number of players in a team
+    `!addmap <map_name>` Add map to map list
+    `!removemap <map_name>` Remove map from map list
+    `!maps` Show map list
+    `!map [map_name]` Show or set map
+    `!notify <@role>` Set @role for alerts
+  MESSAGE
+
+  HELP = { commands: COMMANDS, footer: "!command <required> [optional]" }
 
   def run
     bot = Discordrb::Commands::CommandBot.new(
@@ -27,19 +51,79 @@ class QwtfDiscordBotPug # :nodoc:
     )
 
     bot.command :help do |event, *args|
-      "Pug commands: `!status`, `!join`, `!team <team_no> [@player1] [@player2]`, `!unteam`, `!leave`, `!kick <@player>`, `!win <team_no>`, `!draw`, `!end`, `!teamsize <no_of_players>`, `!addmap <map_name>`, `!removemap <map_name>`, `!maps`, `!map [map_name]`, `!choose [n]`, `!notify <@role>`"
+      send_embedded_message(
+        description: HELP[:commands],
+        channel: event.channel
+      ) do |embed|
+        embed.footer = Discordrb::Webhooks::EmbedFooter.new(
+          text: HELP[:footer]
+        )
+      end
     end
 
     bot.command :join do |event, *args|
       setup_pug(event) do |e, pug|
-        if pug.joined?(e.user_id)
-          return send_embedded_message(
-            description: "You've already joined",
+        if args.empty?
+          if pug.joined?(e.user_id)
+            return send_embedded_message(
+              description: "You've already joined",
+              channel: e.channel
+            )
+          end
+
+          join_pug(e, pug)
+        else
+          errors = []
+          joiners = []
+
+          args.each do |mention|
+            if !mention.match(VALID_MENTION)
+              errors << "#{mention} isn't a valid mention"
+              next
+            end
+
+            user_id = mention_to_user_id(mention)
+            display_name = e.display_name_for(user_id) || mention
+
+            if pug.joined?(user_id)
+              errors << "#{display_name} is already in this PUG"
+              next
+            end
+
+            pug.join(user_id)
+            joiners << display_name
+          end
+
+          message = ""
+          description = []
+
+          if pug.total_player_count == 0
+            message = "#{pug.notify_roles} PUG started"
+            description << "#{e.display_name} creates a PUG"
+          elsif pug.slots_left.between?(1, 3)
+            message = "#{pug.slots_left} more #{pug.notify_roles}"
+          end
+
+          if joiners.any?
+            description << [
+              joiners.to_sentence,
+              joiners.count == 1 ? "joins" : "join",
+              "the PUG"
+            ].join(" ")
+          end
+
+          description << [
+            pug.total_player_count,
+            pug.maxplayers
+          ].join("/")
+
+          send_embedded_message(
+            message: message,
+            description: [errors, description.join(MSG_SNIPPET_DELIMITER)].join("\n"),
             channel: e.channel
           )
         end
 
-        join_pug(e, pug)
         start_pug(pug, e) if pug.has_exactly_maxplayers?
       end
     end
@@ -66,7 +150,21 @@ class QwtfDiscordBotPug # :nodoc:
                       0
                     end
 
-        message_obj = choose_fair_teams(pug: pug, event: e, iteration: iteration)
+        message_obj = choose_teams(pug: pug, event: e, iteration: iteration)
+        status(pug: pug, event: e, message_obj: message_obj) if message_obj
+      end
+    end
+
+    bot.command :shuffle do |event|
+      setup_pug(event) do |e, pug|
+        if !pug.full?
+          return send_embedded_message(
+            description: "Not enough players, reduce !teamsize",
+            channel: event.channel
+          )
+        end
+
+        message_obj = choose_teams(pug: pug, event: e)
         status(pug: pug, event: e, message_obj: message_obj) if message_obj
       end
     end
@@ -170,56 +268,70 @@ class QwtfDiscordBotPug # :nodoc:
           )
         end
 
-        args.each do |arg|
-          unless arg.match(/<@!\d+>/)
-            send_embedded_message(
-              description: "#{arg} isn't a valid mention",
-              channel: e.channel
-            )
+        errors = []
+        kickees = []
+
+        args.each do |mention|
+          if !mention.match(VALID_MENTION)
+            errors << "#{mention} isn't a valid mention"
             next
           end
 
-          user_id = mention_to_user_id(arg)
-          display_name = e.display_name_for(user_id) || arg
+          user_id = mention_to_user_id(mention)
+          display_name = e.display_name_for(user_id) || mention
 
           unless pug.joined?(user_id)
-            send_embedded_message(
-              description: "#{display_name} isn't in the PUG",
-              channel: e.channel
-            )
+            errors << "#{display_name} isn't in the PUG"
             next
           end
 
           pug.leave(user_id)
 
-          snippets = [
-            "#{display_name} is kicked from the PUG",
-            "#{pug.player_slots} remain"
-          ]
+          kickees << display_name
+        end
 
-          message = "#{pug.slots_left} more #{pug.notify_roles}" if pug.slots_left == 1
+        message = ""
+        description = []
 
-          send_embedded_message(
-            message: message,
-            description: snippets.join(MSG_SNIPPET_DELIMITER),
-            channel: e.channel
-          )
+        if pug.slots_left == 1
+          message = "#{pug.slots_left} more #{pug.notify_roles}"
+        end
 
-          break end_pug(pug, e.channel) if pug.empty?
+        if kickees.any?
+          description << [
+            kickees.to_sentence,
+            kickees.count == 1 ? "is" : "are",
+            "kicked from the PUG"
+          ].join(" ")
         end
+
+        description << [
+          [pug.total_player_count, pug.maxplayers].join("/"),
+          "remain"
+        ].join(" ")
+
+        description = [errors, description.join(MSG_SNIPPET_DELIMITER)].join("\n")
+
+        send_embedded_message(
+          message: message,
+          description: description,
+          channel: e.channel
+        )
+
+        end_pug(pug, e.channel) if pug.empty?
       end
     end
 
     bot.command :team do |event, *args|
       setup_pug(event) do |e, pug|
-        unless args.any?
+        if args.empty?
           return send_embedded_message(
             description: "Which team? E.G. `!team 1`",
             channel: e.channel
           )
         end
 
-        unless ["1", "2"].any?(args.first)
+        if ["1", "2"].none?(args.first)
           return send_embedded_message(
             description: "Choose `!team 1`, `!team 2`, or `!unteam` to leave team",
             channel: e.channel
@@ -249,27 +361,38 @@ class QwtfDiscordBotPug # :nodoc:
             channel: e.channel
           )
         else
+          errors = []
+          teamers = []
+
           args[1..-1].each do |mention|
-            unless mention.match(/<@!\d+>/)
-              send_embedded_message(
-                description: "#{arg} isn't a valid mention",
-                channel: e.channel
-              )
+            if !mention.match(VALID_MENTION)
+              errors << "#{mention} isn't a valid mention"
               next
             end
 
             user_id = mention_to_user_id(mention)
-            display_name = e.display_name_for(user_id) || arg
+            display_name = e.display_name_for(user_id) || mention
             pug.join_team(team_no: team_no, player_id: user_id)
 
-            send_embedded_message(
-              description: [
-                "#{display_name} joins #{TEAM_NAMES[team_no]}",
-                "#{pug.team_player_count(team_no)}/#{pug.teamsize}"
-              ].join(MSG_SNIPPET_DELIMITER),
-              channel: e.channel
-            )
+            teamers << display_name
           end
+
+          description = errors << [
+            [
+              teamers.to_sentence,
+              teamers.count == 1 ? "joins" : "join",
+              TEAM_NAMES[team_no]
+            ].join(" "),
+            [
+              pug.team_player_count(team_no),
+              pug.teamsize
+            ].join("/")
+          ].join(MSG_SNIPPET_DELIMITER)
+
+          send_embedded_message(
+            description: description.join("\n"),
+            channel: e.channel
+          )
         end
 
         start_pug(pug, e) if !pug_already_full && pug.has_exactly_maxplayers?
@@ -280,7 +403,7 @@ class QwtfDiscordBotPug # :nodoc:
       setup_pug(event) do |e, pug|
         user_id = e.user_id
 
-        unless pug.active?
+        if !pug.active?
           return send_embedded_message(
             description: 'No PUG has been started. `!join` to create',
             channel: e.channel
@@ -288,7 +411,7 @@ class QwtfDiscordBotPug # :nodoc:
         end
 
         if args.empty?
-          unless pug.joined?(user_id)
+          if !pug.joined?(user_id)
             return send_embedded_message(
               description: "You aren't in this PUG",
               channel: e.channel
@@ -309,32 +432,38 @@ class QwtfDiscordBotPug # :nodoc:
             channel: e.channel
           )
         else
+          errors = []
+          unteamers = []
+
           args.each do |mention|
-            unless mention.match(/<@!\d+>/)
-              send_embedded_message(
-                description: "#{arg} isn't a valid mention",
-                channel: e.channel
-              )
+            if !mention.match(VALID_MENTION)
+              errors << "#{mention} isn't a valid mention"
               next
             end
 
             user_id = mention_to_user_id(mention)
-            display_name = e.display_name_for(user_id) || arg
+            display_name = e.display_name_for(user_id) || mention
 
-            unless pug.joined?(user_id)
-              return send_embedded_message(
-                description: "#{display_name} isn't in this PUG",
-                channel: e.channel
-              )
+            if !pug.joined?(user_id)
+              errors << "#{display_name} isn't in this PUG"
+              next
             end
 
             pug.unteam(user_id)
 
-            send_embedded_message(
-              description: "#{display_name} leaves team",
-              channel: e.channel
-            )
+            unteamers << display_name
           end
+
+          description = errors << [
+            unteamers.to_sentence,
+            unteamers.count == 1 ? "goes" : "go",
+            "into the queue"
+          ].join(" ")
+
+          send_embedded_message(
+            description: description.join("\n"),
+            channel: e.channel
+          )
         end
       end
     end
@@ -416,7 +545,7 @@ class QwtfDiscordBotPug # :nodoc:
         ).body
 
         send_embedded_message(
-          description: "#{TEAM_NAMES[winning_team_no]} wins game ##{id}. `!choose` again. [Ratings](#{discord_channel_leaderboard_url(e.channel.id)})",
+          description: "#{TEAM_NAMES[winning_team_no]} wins game ##{id}. `!choose` again. [Results](#{discord_channel_leaderboard_url(e.channel.id)})",
           channel: e.channel
         )
       end
@@ -484,7 +613,7 @@ class QwtfDiscordBotPug # :nodoc:
         ).body
 
         send_embedded_message(
-          description: "Match ##{id} drawn. `!choose` again. [Ratings](#{discord_channel_leaderboard_url(e.channel.id)})",
+          description: "Match ##{id} drawn. `!choose` again. [Results](#{discord_channel_leaderboard_url(e.channel.id)})",
           channel: e.channel
         )
       end
@@ -639,7 +768,7 @@ class QwtfDiscordBotPug # :nodoc:
   end
 
   def mention_to_user_id(mention)
-    mention[3..-2].to_i
+    mention[/\d+/].to_i
   end
 
   def join_pug(e, pug)
@@ -647,7 +776,7 @@ class QwtfDiscordBotPug # :nodoc:
 
     if pug.total_player_count == 1
       snippets = ["#{e.display_name} creates a PUG", "#{pug.player_slots} joined"]
-      message = pug.notify_roles
+      message = "#{pug.notify_roles} PUG started"
     else
       snippets = ["#{e.display_name} joins the PUG", "#{pug.player_slots} joined"]
       message = "#{pug.slots_left} more #{pug.notify_roles}" if pug.slots_left.between?(1, 3)
@@ -667,7 +796,7 @@ class QwtfDiscordBotPug # :nodoc:
     nil # stop discordrb printing return value
   end
 
-  def choose_fair_teams(pug:, event:, iteration: 0)
+  def choose_teams(pug:, event:, iteration: nil)
     if !pug.full?
       return send_embedded_message(
         description: "Not enough players, reduce !teamsize",
@@ -676,7 +805,7 @@ class QwtfDiscordBotPug # :nodoc:
     end
 
     message_obj = send_embedded_message(
-      description: "Choosing fair teams...",
+      description: "Choosing teams...",
       channel: event.channel
     )
 
@@ -684,14 +813,34 @@ class QwtfDiscordBotPug # :nodoc:
       channel_id: event.channel.id, players: pug.up_now_players
     )
 
-    teams = combinations[iteration]
+    if iteration
+      teams = combinations[iteration]
 
-    if !teams
-      return send_embedded_message(
-        description: "There are only #{combinations.count} possible combinations",
-        channel: event.channel,
-        message_obj: message_obj
-      ) && nil
+      if !teams
+        return send_embedded_message(
+          description: "There are only #{combinations.count} possible combinations",
+          channel: event.channel,
+          message_obj: message_obj
+        ) && nil
+      end
+    else
+      weighted_combinations = combinations.map.with_index do |combination, index|
+        { weight: 1/(index+1.0), combination: combination }
+      end
+
+      total = weighted_combinations.inject(0) do |sum, wt|
+        sum + wt[:weight]
+      end
+
+      chosen_weighted_team_index = rand(0..total)
+      counter = 0.0
+
+      weighted_combination = weighted_combinations.find do |wt|
+        counter += wt[:weight]
+        chosen_weighted_team_index <= counter
+      end
+
+      teams = weighted_combination[:combination]
     end
 
     pug.destroy_teams
@@ -747,51 +896,17 @@ class QwtfDiscordBotPug # :nodoc:
   end
 
   def start_pug(pug, event)
-    choose_fair_teams(pug: pug, event: event) unless pug.teams.any?
-
-    footer = [
-      pug.game_map,
-      "#{pug.player_slots} joined",
-    ].compact.join(MSG_SNIPPET_DELIMITER)
-
     mentions = pug.players.map do |player_id|
       event.mention_for(player_id)
     end
 
-    mention_line = "Time to play! #{mentions.join(" ")}"
+    mention_line = mentions.join(" ")
 
     send_embedded_message(
       message: mention_line,
-      channel: event.channel
-    ) do |embed|
-      embed.footer = Discordrb::Webhooks::EmbedFooter.new(
-        text: footer
-      )
-
-      if pug.queued_players.any?
-        queue_display_names = pug.queued_players.map do |player_id|
-          event.display_name_for(player_id)
-        end
-
-        embed.add_field(
-          inline: true,
-          name: "Queue",
-          value: queue_display_names.join("\n")
-        )
-      end
-
-      pug.teams.each do |team_no, player_ids|
-        team_mentions = player_ids.map do |player_id|
-          event.display_name_for(player_id)
-        end
-
-        embed.add_field(
-          inline: true,
-          name: team_name(team_no),
-          value: team_mentions.join("\n")
-        )
-      end
-    end
+      channel: event.channel,
+      description: "Time to play. `!choose`, `!shuffle` or `!team` up."
+    )
   end
 
   def end_pug(pug, channel_id)

data/lib/qwtf_discord_bot/qwtf_discord_bot_server.rb

@@ -47,7 +47,7 @@ class QwtfDiscordBotServer
         request = QstatRequest.new(endpoint.address)
 
         if !request.live_server?
-          event.channel.send_message("#{endpoint} isn't responding")
+          event.channel.send_message("#{endpoint.address} isn't responding")
         else
           event.channel.send_embed(nil, request.to_full_embed)
         end

data/qwtf_discord_bot.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'discordrb', '3.4.0'
   spec.add_runtime_dependency 'redis', '~> 4.2'
   spec.add_runtime_dependency 'thor', '~>1.1'
+  spec.add_runtime_dependency 'activesupport', '~>6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 6.1.3
+  version: 6.2.1
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-25 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: A Discord bot for reporting on QuakeWorld Team Fortress game servers
 email:
 - shayolden@hotmail.com
@@ -141,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Works by wrapping the excellent CLI server query tool qstat. Accepts !server,