qwtf_discord_bot 4.2.6 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 724d0971cb9732c8095fa84f03c9be9ab7e215515ee9f65dcbe117fa8dc409c5
-  data.tar.gz: 2c81f16c2ed703ec9d3671eb0f0731ffaa34f7590bf1a3241e729aa7bd13bcb5
+  metadata.gz: acbc8b37f3b73372cb4417b810a76a960ee5fd640330587ef97e0b889338be04
+  data.tar.gz: 47cc64ca3ca8cdf90e63a2197ac0b93e703427a26a0e5cf00ee6716938f73d9f
 SHA512:
-  metadata.gz: d314677b730b1fdce5866120c97eb7448bcbab24ea46d2263f5dee35f8dacaec1ec433b4a5303942d80f2429a626673a7d1306956740f1579b3767993fb2181f
-  data.tar.gz: 9499263c0c76de7590a2aacb0956fb7083d04ce378a17497b259b90ef3adbe6eb2c505a1e7077568c48391547e09e493d10c514d14c3d1b8e888619b1d629f0a
+  metadata.gz: 99276bcc5e6a1e53364176301f09da6089f72bdd266cfbb0e1e72e551e2421bd11116504c907db6649b14f3ba8b6bdcc4534b550ee749761e2d1b99df596dbb7
+  data.tar.gz: b1970a9a1465c72d1cdd3ab68f38d967eb8f9ea1d7072ef7da9c660d4b3ee15d5b3943498958e9f564d61e3a59d82455af1a6cd0e713d4a3240eb51b79b6e504

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (4.2.4)
+    qwtf_discord_bot (5.0.4)
       discordrb (~> 3.3)
       redis (~> 4.1)
       thor (~> 0.20)
@@ -9,14 +9,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
     discordrb (3.3.0)
       discordrb-webhooks (~> 3.3.0)
       ffi (>= 1.9.24)
@@ -26,60 +27,61 @@ GEM
       websocket-client-simple (>= 0.3.0)
     discordrb-webhooks (3.3.0)
       rest-client (>= 2.1.0.rc1)
-    domain_name (0.5.20180417)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     event_emitter (0.2.6)
-    factory_bot (5.0.2)
-      activesupport (>= 4.2.0)
-    ffi (1.11.1)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    ffi (1.13.1)
     http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.6.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
-    mime-types (3.2.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    minitest (5.11.3)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
     netrc (0.11.0)
     opus-ruby (1.0.1)
       ffi
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rbnacl (3.4.0)
       ffi
-    redis (4.1.3)
-    rest-client (2.1.0.rc1)
+    redis (4.2.1)
+    rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     websocket (1.2.8)
     websocket-client-simple (0.3.0)
       event_emitter
       websocket
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -95,4 +97,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>`
+  - `!notify <roles>`
+  - `!end`
+
+
 #### 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.6
+5.1.0

data/docker-compose.yml

@@ -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_decorator.rb

@@ -0,0 +1,54 @@
+class EventDecorator
+  def initialize(event)
+    @event = event
+  end
+
+  def channel
+    @event.channel
+  end
+
+  def channel_id
+    @event.channel.id
+  end
+
+  def username
+    user.username
+  end
+
+  def user_id
+    user.id
+  end
+
+  def users
+    server.users
+  end
+
+  def mentions_for(user_ids)
+    find_users(user_ids).map(&:mention)
+  end
+
+  def usernames_for(user_ids)
+    find_users(user_ids).map(&:username)
+  end
+
+  private
+
+  def find_users(user_ids)
+    user_ids.map do |user_id|
+      find_user(user_id)
+    end
+  end
+
+  def find_user(user_id)
+    users.find { |user| user.id == user_id }
+  end
+
+  def server
+    @event.server
+  end
+
+  def user
+    @event.user
+  end
+end
+

data/lib/pug.rb

@@ -0,0 +1,91 @@
+class Pug
+  DEFAULT_MAXPLAYERS = 8
+
+  def self.for(channel_id)
+    new(channel_id)
+  end
+
+  def initialize(channel_id)
+    @channel_id = channel_id
+  end
+
+  def join(user_id)
+    redis.setnx(pug_key, Time.now)
+    redis.sadd(players_key, user_id)
+  end
+
+  def joined_players
+    redis.smembers(players_key).map(&:to_i)
+  end
+
+  def full?
+    joined_player_count >= maxplayers
+  end
+
+  def joined_player_count
+    redis.scard(players_key).to_i
+  end
+
+  def player_slots
+    "#{joined_player_count}/#{maxplayers}"
+  end
+
+  def slots_left
+    maxplayers - joined_player_count
+  end
+
+  def notify_roles=(roles)
+    redis.set(notify_roles_key, roles)
+  end
+
+  def notify_roles
+    redis.get(notify_roles_key) || "@here"
+  end
+
+  def maxplayers=(maxplayers)
+    redis.set(maxplayers_key, maxplayers)
+  end
+
+  def maxplayers
+    (redis.get(maxplayers_key) || DEFAULT_MAXPLAYERS).to_i
+  end
+
+  def active?
+    redis.get(pug_key)
+  end
+
+  def leave(player_id)
+    redis.srem(players_key, player_id)
+  end
+
+  def empty?
+    joined_player_count == 0
+  end
+
+  def end_pug
+    redis.del(pug_key)
+    redis.del(players_key)
+  end
+
+  private
+
+  def maxplayers_key
+    [pug_key, "maxplayers"].join(":")
+  end
+
+  def players_key
+    [pug_key, "players"].join(":")
+  end
+
+  def pug_key
+    ["pug", "channel", @channel_id].join(":")
+  end
+
+  def notify_roles_key
+    [pug_key, "role"].join(":")
+  end
+
+  def redis
+    Redis.current
+  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,147 @@
+require 'pug'
+require 'event_decorator'
+
+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 = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
+
+      pug.join(e.user_id)
+
+      message = if pug.full?
+                  time_to_play_message(
+                    pug.player_slots,
+                    e.mentions_for(pug.joined_players)
+                  )
+                elsif pug.joined_player_count == 1
+                  [
+                    "#{e.username} creates a PUG",
+                    pug.player_slots,
+                    pug.notify_roles
+                  ].join(' | ')
+                elsif pug.slots_left <= 3
+                  [
+                    "#{e.username} joins the PUG",
+                    pug.player_slots,
+                    "#{pug.slots_left} more",
+                    pug.notify_roles
+                  ].join(' | ')
+                else
+                  [
+                    "#{e.username} joins the PUG",
+                    pug.player_slots
+                  ].join(' | ')
+                end
+
+      send_and_log_message(message, e.channel)
+    end
+
+    bot.command :status do |event, *_args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
+
+      message = if pug.active?
+                  [
+                    "#{e.usernames_for(pug.joined_players).join(' ')} joined",
+                    pug.player_slots
+                  ].join(' | ')
+                else
+                  'No PUG has been started. `!join` to create'
+                end
+
+      send_and_log_message(message, e.channel)
+    end
+
+    bot.command :maxplayers do |event, *args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
+      new_maxplayers = args[0]
+
+      message = if new_maxplayers
+                  pug.maxplayers = new_maxplayers
+                  "Max number of players set to #{pug.maxplayers} | #{pug.player_slots} joined"
+                else
+                  "Current max number of players is #{pug.maxplayers} | #{pug.player_slots} joined"
+                end
+
+      send_and_log_message(message, e.channel)
+
+      if pug.full?
+        message = time_to_play_message(
+          pug.player_slots,
+          e.mentions_for(pug.joined_players)
+        )
+
+        send_and_log_message(message, e.channel)
+      end
+    end
+
+    bot.command :leave do |event, *_args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
+
+      pug.leave(e.user_id)
+
+      message = "#{e.username} leaves the PUG | #{pug.player_slots} remain"
+
+      send_and_log_message(message, e.channel)
+
+      if pug.empty?
+        pug.end_pug
+
+        message = 'PUG ended'
+        send_and_log_message(message, e.channel)
+      end
+    end
+
+    bot.command :end do |event, *_args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
+
+      pug.end_pug
+
+      message = 'PUG ended'
+      send_and_log_message(message, e.channel)
+    end
+
+    bot.command :notify do |event, *args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
+      roles = args.join(' ')
+      pug.notify_roles = roles
+
+      message = if roles.empty?
+                  'Notification removed'
+                else
+                  "Notification role set to #{roles}"
+                end
+
+      send_and_log_message(message, e.channel)
+    end
+
+    bot.run
+  end
+
+  private
+
+  def time_to_play_message(player_slots, mentions)
+    ['Time to play!', player_slots, mentions.join(' ')].join(' | ')
+  end
+
+  def send_and_log_message(message, channel)
+    channel.send_message(message)
+    puts message
+  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.6
+  version: 5.1.0
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -104,10 +104,13 @@ files:
 - exe/qwtf_discord_bot
 - lib/emoji.rb
 - lib/endpoint.rb
+- lib/event_decorator.rb
 - lib/player.rb
+- lib/pug.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 +138,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,