qwtf_discord_bot 5.0.4 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 221bf82bea89d889a6976f8da2e7391387ffd1c5c7c1daada602b81770e2a5ca
-  data.tar.gz: f2efd10fa6e911ab45036b9c0e070d76285e1f80508f6d7c0d5925018e6fc1a7
+  metadata.gz: acbc8b37f3b73372cb4417b810a76a960ee5fd640330587ef97e0b889338be04
+  data.tar.gz: 47cc64ca3ca8cdf90e63a2197ac0b93e703427a26a0e5cf00ee6716938f73d9f
 SHA512:
-  metadata.gz: 3e2f38fd0f1565fa6caad12727e8eb75555b8efd9f75d2067fed5cabe6d79427d133c32a6f96b564c3ae0b9ebf3bf1bd094bb39e4800df559444518c2bd6637a
-  data.tar.gz: ab0ef6dbb87be255cb098768455f219fdfc14c94e6d51ceca54c9504959f9923feee52fcf6bc55f23bd4886855f554707c6ed564022d5f653ef022211f4311cb
+  metadata.gz: 99276bcc5e6a1e53364176301f09da6089f72bdd266cfbb0e1e72e551e2421bd11116504c907db6649b14f3ba8b6bdcc4534b550ee749761e2d1b99df596dbb7
+  data.tar.gz: b1970a9a1465c72d1cdd3ab68f38d967eb8f9ea1d7072ef7da9c660d4b3ee15d5b3943498958e9f564d61e3a59d82455af1a6cd0e713d4a3240eb51b79b6e504

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (4.2.6)
+    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

data/README.md

@@ -90,8 +90,8 @@ This responds to discord messages:
   - `!leave`
   - `!status`
   - `!maxplayers <no_of_players>`
-  - `!leave`
-  - `!role`
+  - `!notify <roles>`
+  - `!end`
 
 
 #### Watcher

data/VERSION

@@ -1 +1 @@
-5.0.4
+5.1.0

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/qwtf_discord_bot_pug.rb

@@ -1,4 +1,5 @@
-require 'event_wrapper'
+require 'pug'
+require 'event_decorator'
 
 class QwtfDiscordBotPug
   include QwtfDiscordBot
@@ -13,114 +14,121 @@ class QwtfDiscordBotPug
       prefix: '!'
     )
 
-    bot.command :join do |event, *args|
-      e = EventWrapper.new(event)
+    bot.command :join do |event, *_args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
 
-      redis.setnx(e.pug_key, Time.now)
-      redis.sadd(e.players_key, e.user_id)
+      pug.join(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)
+      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",
-                    e.player_slots,
-                    e.role,
-                  ].join(" | ")
-                elsif e.slots_left <= 3
+                    pug.player_slots,
+                    pug.notify_roles
+                  ].join(' | ')
+                elsif pug.slots_left <= 3
                   [
                     "#{e.username} joins the PUG",
-                    e.player_slots,
-                    "#{e.slots_left} more",
-                    e.role,
-                  ].join(" | ")
+                    pug.player_slots,
+                    "#{pug.slots_left} more",
+                    pug.notify_roles
+                  ].join(' | ')
                 else
                   [
                     "#{e.username} joins the PUG",
-                    e.player_slots,
-                  ].join(" | ")
+                    pug.player_slots
+                  ].join(' | ')
                 end
 
-      send_and_log_message(message, event)
+      send_and_log_message(message, e.channel)
     end
 
-    bot.command :status do |event, *args|
-      e = EventWrapper.new(event)
-      usernames = joined_users(e).map(&:username)
+    bot.command :status do |event, *_args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
 
-      message = if e.pug_active?
+      message = if pug.active?
                   [
-                    "#{usernames.join(", ")} joined",
-                    e.player_slots
-                  ].join(" | ")
+                    "#{e.usernames_for(pug.joined_players).join(' ')} joined",
+                    pug.player_slots
+                  ].join(' | ')
                 else
-                  "No PUG has been started. `!join` to create"
+                  'No PUG has been started. `!join` to create'
                 end
 
-      send_and_log_message(message, event)
+      send_and_log_message(message, e.channel)
     end
 
     bot.command :maxplayers do |event, *args|
-      e = EventWrapper.new(event)
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
       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
+                  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, event)
+      send_and_log_message(message, e.channel)
 
-      if e.joined_player_count >= e.maxplayers
-        mentions = joined_users(e).map do |user|
-          user.mention
-        end
+      if pug.full?
+        message = time_to_play_message(
+          pug.player_slots,
+          e.mentions_for(pug.joined_players)
+        )
 
-        message = "Time to play! #{mentions.join(" ")}"
-        send_and_log_message(message, event)
+        send_and_log_message(message, e.channel)
       end
     end
 
-    bot.command :leave do |event, *args|
-      e = EventWrapper.new(event)
+    bot.command :leave do |event, *_args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
 
-      redis.srem(e.players_key, e.user_id)
+      pug.leave(e.user_id)
 
-      message = "#{e.username} leaves the PUG | #{e.player_slots}"
+      message = "#{e.username} leaves the PUG | #{pug.player_slots} remain"
 
-      send_and_log_message(message, event)
+      send_and_log_message(message, e.channel)
 
-      if e.joined_player_count == 0
-        redis.del(e.pug_key)
+      if pug.empty?
+        pug.end_pug
 
-        message = "PUG ended"
-        send_and_log_message(message, event)
+        message = 'PUG ended'
+        send_and_log_message(message, e.channel)
       end
     end
 
-    bot.command :end do |event, *args|
-      e = EventWrapper.new(event)
+    bot.command :end do |event, *_args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
 
-      redis.del(e.pug_key)
-      redis.del(e.players_key)
+      pug.end_pug
 
-      message = "PUG ended"
-      send_and_log_message(message, event)
+      message = 'PUG ended'
+      send_and_log_message(message, e.channel)
     end
 
-    bot.command :role do |event, *args|
-      e = EventWrapper.new(event)
-      role = args[0]
+    bot.command :notify do |event, *args|
+      e = EventDecorator.new(event)
+      pug = Pug.for(e.channel_id)
+      roles = args.join(' ')
+      pug.notify_roles = roles
 
-      redis.set(e.role_key, role)
+      message = if roles.empty?
+                  'Notification removed'
+                else
+                  "Notification role set to #{roles}"
+                end
 
-      message = "Notification role set to #{role}"
-      send_and_log_message(message, event)
+      send_and_log_message(message, e.channel)
     end
 
     bot.run
@@ -128,16 +136,12 @@ class QwtfDiscordBotPug
 
   private
 
-  def send_and_log_message(message, event)
-    event.channel.send_message(message)
-    puts message
+  def time_to_play_message(player_slots, mentions)
+    ['Time to play!', player_slots, mentions.join(' ')].join(' | ')
   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
+  def send_and_log_message(message, channel)
+    channel.send_message(message)
+    puts message
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 5.1.0
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-23 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -104,8 +104,9 @@ files:
 - exe/qwtf_discord_bot
 - lib/emoji.rb
 - lib/endpoint.rb
-- lib/event_wrapper.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

data/lib/event_wrapper.rb

@@ -1,62 +0,0 @@
-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