qwtf_discord_bot 4.2.3 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53c052ce01f40e7761bfc20b8697e25685e0babdd3bdd0a329a4474df163539
-  data.tar.gz: 9bb3000c5ee85114e0051c40a598c29fe98569cda483975bdcc7b6e321f7d4e0
+  metadata.gz: 452714fe7a833e8c33d3825de55e52be1716f30fecd8c80df2705aa35df37bc7
+  data.tar.gz: bafc402721ac62475747ffe255b7f09f851672fff58ec05e89051d765282ce5b
 SHA512:
-  metadata.gz: c3769891475fa12c53f8959b2eb2c14b008b79cc4ea7816a41be9a09d183a581c30603822fa4095893acbf5114df628cfe0f144a115c2017258f2db9d94962f5
-  data.tar.gz: 79ce5d9e0f2a77064e26794433c4a0b2d321af89d9b93f7562acfe1d14ba8e25bda36089a8a295111a268daa8d3ad571590c3e489236934ce269324f278547e6
+  metadata.gz: 17a594fdf8f231e4b067496cf59b9fdb777231ac9585c4df93df061948580100c5235bc4e7e31281a4606d22e6ca490e863aa13f2783b66292b73b599cca2bbc
+  data.tar.gz: 8fb14f30321620378acb31553bbfb89c0432b4ab58b4f69c7f27a294db94ff26686851e819b3cb74c2125ac6c2a8b5c509204eb90f70155c2af41e869960cae7

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (4.1.0)
+    qwtf_discord_bot (4.2.6)
       discordrb (~> 3.3)
-      redis
+      redis (~> 4.1)
       thor (~> 0.20)
 
 GEM
@@ -90,8 +90,9 @@ DEPENDENCIES
   factory_bot
   pry
   qwtf_discord_bot!
+  redis
   rspec
   thor
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -11,7 +11,7 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
 
 ## Installation
 
-    $ gem install qwtf_discord_bot
+    gem install qwtf_discord_bot
 
 
 ## Usage
@@ -20,60 +20,58 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
 - Create a `~/.config/qwtf_discord_bot/config.yaml` file containing your bots
   credentials and server endpoints
 
-```yaml
----
-token: "dhjksahdkjhhur43hu4hu5b4b5k34j12b4kj3b4kjb4j32kb4kjb4kb3k2b"
-client_id: "873298379487294398"
-endpoints:
-  - "sydney.fortressone.org":
-    - channel_ids:
-      - 832749832749873298
-      - 798437748937298448
-  - "sydney.fortressone.org:27501":
-    - channel_ids:
-      - 590204247224745986
-  - "dallas.fortressone.org":
-    - channel_ids:
-      - 480928490328409328
-emojis:
-  red:
-    scout: "<:scout_red:424097703127941130>"
-    sniper: "<:sniper_red:424097704076115978>"
-    soldier: "<:soldier_red:424097704197619712>"
-    demoman: "<:demoman_red:424097687739301919>"
-    medic: "<:medic_red:424097695418941451>"
-    pyro: "<:pyro_red:424097704403271691>"
-    hwguy: "<:hwguy_red:424097694030757889>"
-    spy: "<:spy_red:424097704138899466>"
-    engineer: "<:engineer_red:424097694680612864>"
-  blue:
-    scout: "<:scout_blue:456062063983460353>"
-    sniper: "<:sniper_blue:456062061953417216>"
-    soldier: "<:soldier_blue:456062062997536801>"
-    demoman: "<:demoman_blue:456061938636554240>"
-    medic: "<:medic_blue:456062056710537217>"
-    pyro: "<:pyro_blue:456062062460928010>"
-    hwguy: "<:hwguy_blue:456062063190736926>"
-    spy: "<:spy_blue:456062062032846849>"
-    engineer: "<:engineer_blue:456062031125020683>"
-```
-
-- Use  the `QWTF_DISCORD_BOT_CONFIG_FILE` environment variable or default to
-  specify an alternative file
-
-```sh
-$ export QWTF_DISCORD_BOT_CONFIG_FILE="config.yaml"
-```
+  ```yaml
+  ---
+  token: "dhjksahdkjhhur43hu4hu5b4b5k34j12b4kj3b4kjb4j32kb4kjb4kb3k2b"
+  client_id: "873298379487294398"
+  endpoints:
+    - "sydney.fortressone.org":
+      - channel_ids:
+        - 832749832749873298
+        - 798437748937298448
+    - "sydney.fortressone.org:27501":
+      - channel_ids:
+        - 590204247224745986
+    - "dallas.fortressone.org":
+      - channel_ids:
+        - 480928490328409328
+  emojis:
+    red:
+      scout: "<:scout_red:424097703127941130>"
+      sniper: "<:sniper_red:424097704076115978>"
+      soldier: "<:soldier_red:424097704197619712>"
+      demoman: "<:demoman_red:424097687739301919>"
+      medic: "<:medic_red:424097695418941451>"
+      pyro: "<:pyro_red:424097704403271691>"
+      hwguy: "<:hwguy_red:424097694030757889>"
+      spy: "<:spy_red:424097704138899466>"
+      engineer: "<:engineer_red:424097694680612864>"
+    blue:
+      scout: "<:scout_blue:456062063983460353>"
+      sniper: "<:sniper_blue:456062061953417216>"
+      soldier: "<:soldier_blue:456062062997536801>"
+      demoman: "<:demoman_blue:456061938636554240>"
+      medic: "<:medic_blue:456062056710537217>"
+      pyro: "<:pyro_blue:456062062460928010>"
+      hwguy: "<:hwguy_blue:456062063190736926>"
+      spy: "<:spy_blue:456062062032846849>"
+      engineer: "<:engineer_blue:456062031125020683>"
+  ```
+
+- Use  the `QWTF_DISCORD_BOT_CONFIG_FILE` environment variable to specify an
+  alternative config file path
+
+      export QWTF_DISCORD_BOT_CONFIG_FILE="config.yaml"
 
 
 ### Commands
 
-There are two modules:
+There are three modules:
 
 
 #### Server
 
-    $ qwtf-discord-bot server
+    qwtf-discord-bot server
 
 This responds to discord messages:
   - `!server`
@@ -83,9 +81,21 @@ This responds to discord messages:
 ![screenshot of bot responding to !server command](server_screenshot.png)
 
 
+#### Pug
+
+    qwtf-discord-bot pug
+
+This responds to discord messages:
+  - `!join`
+  - `!leave`
+  - `!status`
+  - `!maxplayers <no_of_players>`
+  - `!leave`
+
+
 #### Watcher
 
-    $ qwtf-discord-bot watcher
+    qwtf-discord-bot watcher
 
 This watches the game server and announces if anyone has joined the server. It
 polls the server once every 30 seconds and will only report a player joining if
@@ -94,47 +104,78 @@ they haven't been connected for more than ten minutes.
 ![screenshot of bot reporting player joining server](watcher_screenshot.png)
 
 
-## Docker
+## Gem
 
 Build:
 
-```sh
-docker build --tag=discord-bot .
-```
+    gem build qwtf_discrd_bot.gemspec
+
+
+Install:
+
+ 
+    gem install --local qwtf_discord_bot-$(cat VERSION).gem
+
 
 Push:
 
-```sh
-docker tag discord-bot fortressone/discord-bot:latest
-docker push fortressone/discord-bot:latest
-```
+    gem push qwtf_discord_bot-$(cat VERSION).gem
+
+
+## Docker
 
 Run:
 
 Assuming a `./config.yaml` file exists:
 
-Server:
+    docker-compose up
 
-```sh
-docker run -it \
-  --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
-  --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
-  discord-bot server
-```
 
-Watcher:
+Only discord-bot server:
+
+    docker run -it \
+      --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
+      --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
+      discord-bot server
+
+
+Only discord-bot watcher:
+
+    docker run -it \
+      --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
+      --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
+      discord-bot watcher
+
+
+Only discord-bot pug:
+
+    docker run -it \
+      --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
+      --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
+      discord-bot pug
 
-```sh
-docker run -it \
-  --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
-  --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
-  discord-bot watcher
-```
 
-Both:
+Build:
+
+    docker build --tag=discord-bot .
+
+
+Push:
 
-```sh
-docker-compose up
+    docker tag discord-bot fortressone/discord-bot:latest
+    docker push fortressone/discord-bot:latest
+
+
+Create AWS instance:
+
+```
+docker-machine create \
+  --driver amazonec2 \
+  --amazonec2-access-key <AWS_ACCESS_KEY> \
+  --amazonec2-secret-key <AWS_SECRET_KEY> \
+  --amazonec2-root-size 30 \
+  --amazonec2-region ap-southeast-2 \
+  discord-bot
 ```
 
 

data/VERSION

@@ -1 +1 @@
-4.2.3
+5.0.2

data/docker-compose.yml

@@ -12,7 +12,7 @@ services:
       - redis
     volumes:
       - type: bind
-        source: ./config.yaml
+        source: "/home/ubuntu/.config/qwtf_discord_bot/config.yaml"
         target: /discord-bot/config.yaml
   discord-watcher-bot:
     image: fortressone/discord-bot:latest
@@ -24,5 +24,17 @@ services:
       - REDIS_URL=redis://redis
     volumes:
       - type: bind
-        source: ./config.yaml
+        source: "/home/ubuntu/.config/qwtf_discord_bot/config.yaml"
+        target: /discord-bot/config.yaml
+  discord-pug-bot:
+    image: fortressone/discord-bot:latest
+    command: pug
+    restart: always
+    depends_on:
+      - redis
+    environment:
+      - REDIS_URL=redis://redis
+    volumes:
+      - type: bind
+        source: "/home/ubuntu/.config/qwtf_discord_bot/config.yaml"
         target: /discord-bot/config.yaml

data/exe/qwtf_discord_bot

@@ -2,6 +2,7 @@
 
 require 'qwtf_discord_bot'
 require 'thor'
+require 'pry'
 
 class QwtfDiscordBotExe < Thor
   def self.exit_on_failure?
@@ -14,6 +15,12 @@ class QwtfDiscordBotExe < Thor
     server_bot.run
   end
 
+  desc 'pug', 'Start, join, leave, record pick-up games.'
+  def pug
+    pug_bot = QwtfDiscordBotPug.new
+    pug_bot.run
+  end
+
   desc 'watcher', 'Watches servers and accounces when a player joins'
   def watcher
     watcher_bot = QwtfDiscordBotWatcher.new

data/lib/event_wrapper.rb

@@ -0,0 +1,58 @@
+class EventWrapper
+  include QwtfDiscordBot
+
+  DEFAULT_MAXPLAYERS = 8
+
+  def initialize(event)
+    @event = event
+  end
+
+  def user_id
+    @event.user.id
+  end
+
+  def username
+    @event.user.username
+  end
+
+  def maxplayers_key
+    [pug_key, "maxplayers"].join(":")
+  end
+
+  def maxplayers
+    redis.setnx(maxplayers_key, DEFAULT_MAXPLAYERS)
+    redis.get(maxplayers_key).to_i
+  end
+
+  def joined_player_count
+    redis.scard(players_key).to_i
+  end
+
+  def slots_left
+    maxplayers - joined_player_count
+  end
+
+  def pug_key
+    ["pug", "channel", @event.channel.id].join(":")
+  end
+
+  def players_key
+    [pug_key, "players"].join(":")
+  end
+
+  def player_slots
+    "#{joined_player_count}/#{maxplayers}"
+  end
+
+  def users
+    @event.server.users
+  end
+
+  def role_key
+    [pug_key, "role"].join(":")
+  end
+
+  def role
+    redis.get(role_key) || "@here"
+  end
+end

data/lib/qwtf_discord_bot.rb

@@ -1,9 +1,11 @@
 require 'qwtf_discord_bot/version'
 require 'qwtf_discord_bot/qwtf_discord_bot_server'
+require 'qwtf_discord_bot/qwtf_discord_bot_pug'
 require 'qwtf_discord_bot/qwtf_discord_bot_watcher'
 require 'qwtf_discord_bot/config'
 require 'discordrb'
 require 'yaml'
+require 'redis'
 
 require 'qstat_request'
 require 'player'
@@ -12,9 +14,17 @@ require 'emoji'
 require 'roster'
 
 module QwtfDiscordBot # :nodoc:
-  CONFIG_FILE = ENV['QWTF_DISCORD_BOT_CONFIG_FILE'] || "#{Dir.pwd}/config.yaml"
-
   def self.config
-    @config ||= Config.new(CONFIG_FILE)
+    @config ||= Config.new(config_file)
+  end
+
+  def self.config_file
+    return ENV['QWTF_DISCORD_BOT_CONFIG_FILE'] if ENV['QWTF_DISCORD_BOT_CONFIG_FILE']
+    return "#{Dir.pwd}/config.yaml" if FileTest.exist?("#{Dir.pwd}/config.yaml")
+    "#{Dir.home}/.config/qwtf_discord_bot/config.yaml"
+  end
+
+  def redis
+    Redis.current
   end
 end

data/lib/qwtf_discord_bot/qwtf_discord_bot_pug.rb

@@ -0,0 +1,139 @@
+require 'event_wrapper'
+
+class QwtfDiscordBotPug
+  include QwtfDiscordBot
+
+  FOUR_HOURS = 4 * 60 * 60
+
+  def run
+    bot = Discordrb::Commands::CommandBot.new(
+      token: QwtfDiscordBot.config.token,
+      client_id: QwtfDiscordBot.config.client_id,
+      help_command: false,
+      prefix: '!'
+    )
+
+    bot.command :join do |event, *args|
+      e = EventWrapper.new(event)
+
+      redis.setnx(e.pug_key, Time.now)
+      redis.sadd(e.players_key, e.user_id)
+
+      message = if e.joined_player_count == e.maxplayers
+                  mentions = joined_users(e).map do |user|
+                    user.mention
+                  end
+                  "Time to play! #{mentions.join(" ")}"
+                elsif (e.joined_player_count == 1)
+                  [
+                    "#{e.username} creates a PUG",
+                    e.player_slots,
+                    e.role,
+                  ].join(" | ")
+                elsif e.slots_left <= 3
+                  [
+                    "#{e.username} joins the PUG",
+                    e.player_slots,
+                    "#{e.slots_left} more",
+                    e.role,
+                  ].join(" | ")
+                else
+                  [
+                    "#{e.username} joins the PUG",
+                    e.player_slots,
+                  ].join(" | ")
+                end
+
+      send_and_log_message(message, event)
+    end
+
+    bot.command :status do |event, *args|
+      e = EventWrapper.new(event)
+      usernames = joined_users(e).map(&:username)
+
+      message = [
+        "#{usernames.join(", ")} joined",
+        e.player_slots
+      ].join(" | ")
+
+      send_and_log_message(message, event)
+    end
+
+    bot.command :maxplayers do |event, *args|
+      e = EventWrapper.new(event)
+      new_maxplayers = args[0]
+
+      message = if new_maxplayers
+        redis.set(e.maxplayers_key, new_maxplayers)
+        "Max number of players set to #{e.maxplayers} | #{e.player_slots}"
+      else
+        "Current max number of players is #{e.maxplayers} | #{e.player_slots}"
+      end
+
+      send_and_log_message(message, event)
+
+      if e.joined_player_count >= e.maxplayers
+        mentions = joined_users(e).map do |user|
+          user.mention
+        end
+
+        message = "Time to play! #{mentions.join(" ")}"
+        send_and_log_message(message, event)
+      end
+    end
+
+    bot.command :leave do |event, *args|
+      e = EventWrapper.new(event)
+
+      redis.srem(e.players_key, e.user_id)
+
+      message = "#{e.username} leaves the PUG | #{e.player_slots}"
+
+      send_and_log_message(message, event)
+
+      if e.joined_player_count == 0
+        redis.del(e.pug_key)
+
+        message = "PUG ended"
+        send_and_log_message(message, event)
+      end
+    end
+
+    bot.command :end do |event, *args|
+      e = EventWrapper.new(event)
+
+      redis.del(e.pug_key)
+      redis.del(e.players_key)
+
+      message = "PUG ended"
+      send_and_log_message(message, event)
+    end
+
+    bot.command :role do |event, *args|
+      e = EventWrapper.new(event)
+      role = args[0]
+
+      redis.set(e.role_key, role)
+
+      message = "Notification role set to #{role}"
+      send_and_log_message(message, event)
+    end
+
+    bot.run
+  end
+
+  private
+
+  def send_and_log_message(message, event)
+    event.channel.send_message(message)
+    puts message
+  end
+
+  def joined_users(event)
+    redis.smembers(event.players_key).map do |user_id|
+      event.users.find do |user|
+        user.id.to_s == user_id
+      end
+    end
+  end
+end

data/lib/qwtf_discord_bot/qwtf_discord_bot_server.rb

@@ -3,15 +3,16 @@ class QwtfDiscordBotServer
     bot = Discordrb::Commands::CommandBot.new(
       token: QwtfDiscordBot.config.token,
       client_id: QwtfDiscordBot.config.client_id,
+      help_command: false,
       prefix: '!'
     )
 
     bot.command :server do |event, *args|
       if args.empty?
-        event.channel.send_message(
-          'Provide a server address e.g. `!server sydney.fortressone.org` ' \
-          'or use `!active` or `!all`'
-        )
+        message = 'Provide a server address e.g. `!server ' \
+          'sydney.fortressone.org` or use `!active` or `!all`'
+        event.channel.send_message(message)
+        puts message
       else
         endpoint = args.first
         qstat_response = QstatRequest.new(endpoint)
@@ -20,10 +21,13 @@ class QwtfDiscordBotServer
 
         if embed
           event.channel.send_embed(message, embed)
+          puts message
         else
           event.channel.send_message(message)
+          puts message
         end
       end
+
     end
 
     bot.command :all do |event|
@@ -34,9 +38,9 @@ class QwtfDiscordBotServer
       end
 
       if endpoints_for_this_channel.empty?
-        event.channel.send_message(
-          'There are no servers associated with this channel'
-        )
+        message = 'There are no servers associated with this channel'
+        event.channel.send_message(message)
+        puts message
       else
         endpoints_for_this_channel.each do |endpoint|
           qstat_request = QstatRequest.new(endpoint.address)
@@ -45,8 +49,10 @@ class QwtfDiscordBotServer
 
           if embed
             event.channel.send_embed(message, embed)
+            puts message
           else
             event.channel.send_message(message)
+            puts message
           end
         end
       end
@@ -62,9 +68,9 @@ class QwtfDiscordBotServer
       end
 
       if endpoints_for_this_channel.empty?
-        event.channel.send_message(
-          'There are no servers associated with this channel'
-        )
+        message = 'There are no servers associated with this channel'
+        event.channel.send_message(message)
+        puts message
       else
         qstat_requests = endpoints_for_this_channel.map do |endpoint|
           QstatRequest.new(endpoint.address)
@@ -75,7 +81,9 @@ class QwtfDiscordBotServer
         end
 
         if servers_with_players.empty?
-          event.channel.send_message("All ##{event.channel.name} servers are empty")
+          message = "All ##{event.channel.name} servers are empty"
+          event.channel.send_message(message)
+          puts message
         else
           servers_with_players.each do |server|
             message = server.server_summary
@@ -83,13 +91,14 @@ class QwtfDiscordBotServer
 
             if embed
               event.channel.send_embed(message, embed)
+              puts message
             else
               event.channel.send_message(message)
+              puts message
             end
           end
         end
       end
-
       return nil
     end
 

data/lib/qwtf_discord_bot/qwtf_discord_bot_watcher.rb

@@ -1,5 +1,3 @@
-require "redis"
-
 class QwtfDiscordBotWatcher
   include QwtfDiscordBot
 
@@ -14,7 +12,7 @@ class QwtfDiscordBotWatcher
         next if request.is_empty?
 
         request.player_names.each do |name|
-          redis_key = "#{address}:#{name}"
+          redis_key = ["watcher", address, name].join(":")
 
           unless seen_recently?(redis_key)
             endpoint.channel_ids.each do |channel_id|
@@ -51,16 +49,14 @@ class QwtfDiscordBotWatcher
   end
 
   def report_joined(name:, channel_id:, server_summary:)
+    message = "#{name} joins #{server_summary}"
+
     Discordrb::API::Channel.create_message(
       "Bot #{QwtfDiscordBot.config.token}",
       channel_id,
-      "#{name} has joined #{server_summary}"
+      message
     )
-  end
-
-  private
 
-  def redis
-    @redis ||= Redis.new
+    puts message
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 5.0.2
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -104,10 +104,12 @@ files:
 - exe/qwtf_discord_bot
 - lib/emoji.rb
 - lib/endpoint.rb
+- lib/event_wrapper.rb
 - lib/player.rb
 - lib/qstat_request.rb
 - lib/qwtf_discord_bot.rb
 - lib/qwtf_discord_bot/config.rb
+- lib/qwtf_discord_bot/qwtf_discord_bot_pug.rb
 - lib/qwtf_discord_bot/qwtf_discord_bot_server.rb
 - lib/qwtf_discord_bot/qwtf_discord_bot_watcher.rb
 - lib/qwtf_discord_bot/version.rb
@@ -135,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Works by wrapping the excellent CLI server query tool qstat. Accepts !server,