qwtf_discord_bot 4.0.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f51528b3135169de08585ed80d5de3a0c72b29ace36dc27696eccd72cdf7971
-  data.tar.gz: 1d43f1c94aa6cbc50ad8071fad509d92b131d308dd0555122535700414364554
+  metadata.gz: a70ca5bf16d72a2a0ccfc6127011016b1c1e18c3a4212d202dcf5a071b69e194
+  data.tar.gz: 055defe76720adc62871dd2c43d342a1161f6698a429c8b6f4ebdd47e9dfc42e
 SHA512:
-  metadata.gz: 498504896c72c0285f2a72d6a9a4e9e3bcf2fe7779ded8d10b8a368aa0c418e4a142f8e13b68f4a566e88ca729da5fdba89871808d70398ef609fe1632db0a86
-  data.tar.gz: f79cdd367a7759560193a506a893cb1641e8bed9d466e03e12ed1e84d842e031e0c108f073982304b1ababdaec1b72add8d77e8bf2c397a0f518607a43834026
+  metadata.gz: 754aedabdd94d65c98a224201aff9794cffcd68fb2ad4f8f22346475a09e68e371ee957c338bbbf6a775af744ce73d1fd0b7cd7bcf06e46178dcde3a3c6b8e9c
+  data.tar.gz: a414d546bdf7523df42ce3bd3d7a184050a2c2d80143743d23aed52f17298d54acad363d1791a63818df5d696879ad8ec2c691dec0ee400a07d58156ffbe81b7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (4.0.3)
+    qwtf_discord_bot (4.1.0)
       discordrb (~> 3.3)
       thor (~> 0.20)
 

data/README.md

@@ -16,8 +16,9 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
 
 ## Usage
 
-- Create a bot on discord.
-- Create a `config.yaml` file containing your bots credentials and server endpoints. E.G.
+- Create a bot on discord
+- Create a `~/.config/qwtf_discord_bot/config.yaml` file containing your bots
+  credentials and server endpoints
 
 ```yaml
 ---
@@ -34,17 +35,37 @@ endpoints:
   - "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>"
 ```
 
-- Set the `QWTF_DISCORD_BOT_CONFIG_FILE` environment variable or default to
-  `config.yaml` in the present working directory
+- 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"
 ```
 
 
-
 ### Commands
 
 There are two modules:
@@ -95,13 +116,19 @@ Assuming a `./config.yaml` file exists:
 Server:
 
 ```sh
-docker run -it --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml 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
 ```
 
 Watcher:
 
 ```sh
-docker run -it --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml 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
 ```
 
 Both:

data/docker-compose.yml

@@ -7,7 +7,7 @@ services:
     restart: always
     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
@@ -15,5 +15,5 @@ services:
     restart: always
     volumes:
       - type: bind
-        source: ./config.yaml
+        source: /home/ubuntu/.config/qwtf_discord_bot/config.yaml
         target: /discord-bot/config.yaml

data/lib/emoji.rb

@@ -1,30 +1,6 @@
 class Emoji
-  LOOKUP = {
-    '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>'
-    }
-  }.freeze
-
   def self.for(team:, player_class:)
-    LOOKUP[team] && LOOKUP[team][player_class]
+    emojis = QwtfDiscordBot.config.emojis
+    emojis[team] && emojis[team][player_class]
   end
 end

data/lib/{config.rb → endpoint.rb}

@@ -1,23 +1,3 @@
-class Config
-  def initialize(config)
-    @config = YAML.load_file(config)
-  end
-
-  def token
-    @token ||= @config["token"]
-  end
-
-  def client_id
-    @client_id ||= @config["client_id"]
-  end
-
-  def endpoints
-    @endpoints ||= @config["endpoints"].map do |endpoint|
-      Endpoint.new(endpoint)
-    end
-  end
-end
-
 class Endpoint
   def initialize(config)
     @config = config

data/lib/qwtf_discord_bot.rb

@@ -1,23 +1,20 @@
 require 'qwtf_discord_bot/version'
 require 'qwtf_discord_bot/qwtf_discord_bot_server'
 require 'qwtf_discord_bot/qwtf_discord_bot_watcher'
+require 'qwtf_discord_bot/config'
 require 'discordrb'
 require 'yaml'
 
-require 'config'
 require 'qstat_request'
 require 'player'
 require 'team'
 require 'emoji'
 require 'roster'
 
-class QwtfDiscordBot # :nodoc:
+module QwtfDiscordBot # :nodoc:
   CONFIG_FILE = ENV['QWTF_DISCORD_BOT_CONFIG_FILE'] || "#{Dir.pwd}/config.yaml"
 
-  def initialize
-    @config = Config.new(CONFIG_FILE)
-    @token = @config.token
-    @client_id = @config.client_id
-    @endpoints = @config.endpoints
+  def self.config
+    @config ||= Config.new(CONFIG_FILE)
   end
 end

data/lib/qwtf_discord_bot/config.rb

@@ -0,0 +1,25 @@
+require 'endpoint'
+
+class Config
+  def initialize(config)
+    @config = YAML.load_file(config)
+  end
+
+  def token
+    @token ||= @config["token"]
+  end
+
+  def client_id
+    @client_id ||= @config["client_id"]
+  end
+
+  def endpoints
+    @endpoints ||= @config["endpoints"].map do |endpoint|
+      Endpoint.new(endpoint)
+    end
+  end
+
+  def emojis
+    @emojis ||= @config["emojis"]
+  end
+end

data/lib/qwtf_discord_bot/qwtf_discord_bot_server.rb

@@ -1,8 +1,8 @@
-class QwtfDiscordBotServer < QwtfDiscordBot # :nodoc:
+class QwtfDiscordBotServer
   def run
     bot = Discordrb::Commands::CommandBot.new(
-      token: @token,
-      client_id: @client_id,
+      token: QwtfDiscordBot.config.token,
+      client_id: QwtfDiscordBot.config.client_id,
       prefix: '!'
     )
 
@@ -27,7 +27,7 @@ class QwtfDiscordBotServer < QwtfDiscordBot # :nodoc:
     end
 
     bot.command :all do |event|
-      endpoints_for_this_channel = @endpoints.select do |endpoint|
+      endpoints_for_this_channel = QwtfDiscordBot.config.endpoints.select do |endpoint|
         endpoint.channel_ids.any? do |channel_id|
           event.channel.id == channel_id
         end
@@ -55,7 +55,7 @@ class QwtfDiscordBotServer < QwtfDiscordBot # :nodoc:
     end
 
     bot.command :active do |event|
-      endpoints_for_this_channel = @endpoints.select do |endpoint|
+      endpoints_for_this_channel = QwtfDiscordBot.config.endpoints.select do |endpoint|
         endpoint.channel_ids.any? do |channel_id|
           event.channel.id == channel_id
         end

data/lib/qwtf_discord_bot/qwtf_discord_bot_watcher.rb

@@ -1,10 +1,12 @@
-class QwtfDiscordBotWatcher < QwtfDiscordBot
+class QwtfDiscordBotWatcher
+  include QwtfDiscordBot
+
   THIRTY_SECONDS = 30
   TEN_MINUTES = 10 * 60
 
   def run
     every(THIRTY_SECONDS) do
-      @endpoints.each do |endpoint|
+      QwtfDiscordBot.config.endpoints.each do |endpoint|
         address = endpoint.address
         request = QstatRequest.new(address)
         next if request.is_empty?
@@ -43,7 +45,7 @@ class QwtfDiscordBotWatcher < QwtfDiscordBot
 
   def report_joined(name:, channel_id:, server_summary:)
     Discordrb::API::Channel.create_message(
-      "Bot #{@token}",
+      "Bot #{QwtfDiscordBot.config.token}",
       channel_id,
       "#{name} has joined #{server_summary}"
     )

data/lib/qwtf_discord_bot/version.rb

@@ -1,3 +1,3 @@
-class QwtfDiscordBot
-  VERSION = '4.0.3'.freeze
+module QwtfDiscordBot
+  VERSION = '4.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.1.0
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -86,11 +86,12 @@ files:
 - emoji/red_soldier.png
 - emoji/red_spy.png
 - exe/qwtf_discord_bot
-- lib/config.rb
 - lib/emoji.rb
+- lib/endpoint.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_server.rb
 - lib/qwtf_discord_bot/qwtf_discord_bot_watcher.rb
 - lib/qwtf_discord_bot/version.rb