qwtf_discord_bot 4.2.5 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdf030f78e4914930fa35ba81799674c650bad803bd0584af577403cf29c2261
-  data.tar.gz: 5a438d661bf43ff93d930c91404034c2428714d8737addc1f7f1af94c7f7a40b
+  metadata.gz: 221bf82bea89d889a6976f8da2e7391387ffd1c5c7c1daada602b81770e2a5ca
+  data.tar.gz: f2efd10fa6e911ab45036b9c0e070d76285e1f80508f6d7c0d5925018e6fc1a7
 SHA512:
-  metadata.gz: 4b46ae60ca254852e8ead219ad24984caf61851c3326d68a70282cd01d0a16bc122c1592c6f72a7bd9d43e114caf56272aae0bebb430304f774e3e2f6e329868
-  data.tar.gz: 9487202134ac84b146381fbd8b07e29ed014b45badd3fe6faeefa079d58e4073195b08ab3067344b4c8d81451f97d9899ec37162e680eb5469b0a90b5c167d3c
+  metadata.gz: 3e2f38fd0f1565fa6caad12727e8eb75555b8efd9f75d2067fed5cabe6d79427d133c32a6f96b564c3ae0b9ebf3bf1bd094bb39e4800df559444518c2bd6637a
+  data.tar.gz: ab0ef6dbb87be255cb098768455f219fdfc14c94e6d51ceca54c9504959f9923feee52fcf6bc55f23bd4886855f554707c6ed564022d5f653ef022211f4311cb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (4.2.4)
+    qwtf_discord_bot (4.2.6)
       discordrb (~> 3.3)
       redis (~> 4.1)
       thor (~> 0.20)
@@ -95,4 +95,4 @@ DEPENDENCIES
   thor
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -66,7 +66,7 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
 
 ### Commands
 
-There are two modules:
+There are three modules:
 
 
 #### Server
@@ -81,6 +81,19 @@ 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`
+  - `!role`
+
+
 #### Watcher
 
     qwtf-discord-bot watcher
@@ -99,6 +112,12 @@ Build:
     gem build qwtf_discrd_bot.gemspec
 
 
+Install:
+
+ 
+    gem install --local qwtf_discord_bot-$(cat VERSION).gem
+
+
 Push:
 
     gem push qwtf_discord_bot-$(cat VERSION).gem
@@ -129,6 +148,14 @@ Only discord-bot watcher:
       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
+
+
 Build:
 
     docker build --tag=discord-bot .
@@ -140,6 +167,19 @@ Push:
     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
+```
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -1 +1 @@
-4.2.5
+5.0.4

data/docker-compose.yml

@@ -5,7 +5,7 @@ services:
     image: redis:alpine
     restart: always
   discord-command-bot:
-    image: discord-bot:latest
+    image: fortressone/discord-bot:latest
     command: server
     restart: always
     depends_on:
@@ -15,7 +15,7 @@ services:
         source: "/home/ubuntu/.config/qwtf_discord_bot/config.yaml"
         target: /discord-bot/config.yaml
   discord-watcher-bot:
-    image: discord-bot:latest
+    image: fortressone/discord-bot:latest
     command: watcher
     restart: always
     depends_on:
@@ -26,3 +26,15 @@ services:
       - type: bind
         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,62 @@
+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
+
+  def pug_active?
+    redis.get(pug_key)
+  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,143 @@
+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 = if e.pug_active?
+                  [
+                    "#{usernames.join(", ")} joined",
+                    e.player_slots
+                  ].join(" | ")
+                else
+                  "No PUG has been started. `!join` to create"
+                end
+
+      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,6 +3,7 @@ class QwtfDiscordBotServer
     bot = Discordrb::Commands::CommandBot.new(
       token: QwtfDiscordBot.config.token,
       client_id: QwtfDiscordBot.config.client_id,
+      help_command: false,
       prefix: '!'
     )
 

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,7 +49,7 @@ class QwtfDiscordBotWatcher
   end
 
   def report_joined(name:, channel_id:, server_summary:)
-    message = "#{name} has joined #{server_summary}"
+    message = "#{name} joins #{server_summary}"
 
     Discordrb::API::Channel.create_message(
       "Bot #{QwtfDiscordBot.config.token}",
@@ -61,10 +59,4 @@ class QwtfDiscordBotWatcher
 
     puts message
   end
-
-  private
-
-  def redis
-    @redis ||= Redis.new
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 4.2.5
+  version: 5.0.4
 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,