qwtf_discord_bot 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d474c40842701016d9431def0c11f0802e1e9f760b8cd46906b6c1813165da69
-  data.tar.gz: bbee37ae5f25bbc63395ac866704994c1e6bdbfc7399ea12e7147f44c918c1f6
+  metadata.gz: 53b110507d7aea432897ecfd3ee11c4837df5282b88941163e4fb8dd9b67aa83
+  data.tar.gz: ffe4cefa3aa20ba3f091f157152b083929584a2331be84bb80d20cf3ada2786c
 SHA512:
-  metadata.gz: 3130bb1aa93eac85706b2294f0bf607061bc3ae3f6ad17c76b83dc76fd302d69014aab4448b3f02878fdf878558b21e0a8415c6a79a9157b45b2ad55624a8184
-  data.tar.gz: 998f5873f02adafd23ad4bfded8728b0df7c0a7ca5507a348cf642c2291e1239fd1a61c887d7c025104bdb3f003ce6c1f658db3d85dc73b18541e55d6873d395
+  metadata.gz: f0701391ba3c5b82dfcef5188af67aeb70db9cb97503c449a4940fd9358512ff65f575fdebac353175b95fcbaac7b3f208cadc0f992921e954f6f1ada6830f5c
+  data.tar.gz: a144dbdef8a1f08260501051e3667069a9f821d8718ec7f3f59dad1d8ab6b6a75fc2ae849e5ba0ae6b54f325421262a066ffbba9053deab9cccd8bc8b03d53b5

data/.gitignore

@@ -14,3 +14,4 @@ assets/
 qstat
 *.gem
 *.swp
+config.yaml

data/Gemfile.lock

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

data/README.md

@@ -16,45 +16,55 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
 
 ## Usage
 
-Create a bot on discord.
-
-Edit the `.env.example` file, update with your bot's `client_id` and `token` and save as `.env`.
+- Create a bot on discord.
+- Create a `config.yaml` file containing your bots credentials and server endpoints. E.G.
+
+```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
+```
 
-    $ source .env
+- Set the `QWTF_DISCORD_BOT_CONFIG_FILE` environment variable or default to
+  `config.yaml` in the present working directory
 
+```sh
+$ export QWTF_DISCORD_BOT_CONFIG_FILE="config.yaml"
+```
 
-### List commands
 
-    $ bundle exec exe/qwtf-discord-bot help
 
-There are two features:
+### Commands
 
+There are two modules:
 
-### Server
 
-This responds to `!servers` messages by providing information about your game
-server. Defaults to the hostname command line argument, but will accept a
-hostname from the user. I.E. `!server fortressone.org`
+#### Server
 
-![screenshot of bot responding to !server command](server_screenshot.png)
+    $ qwtf-discord-bot server
 
-```
-Usage:
-  qwtf_discord_bot server
-
-Options:
-  [--endpoints=one two three]
-                               # Default: ["localhost:27500"]
-```
+This responds to discord messages:
+  - `!server`
+  - `!active`
+  - `!all`
 
-E.G.
+![screenshot of bot responding to !server command](server_screenshot.png)
 
-    $ qwtf-discord-bot server --endpoints \
-          sydney.fortressone.org:27500 \
-          sydney.fortressone.org:27501
 
+#### Watcher
 
-### 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
@@ -62,19 +72,6 @@ they haven't been connected for more than ten minutes.
 
 ![screenshot of bot reporting player joining server](watcher_screenshot.png)
 
-```
-Usage:
-  qwtf_discord_bot watcher
-
-Options:
-  [--endpoints=one two three]
-                               # Default: ["localhost:27500"]
-```
-
-E.G.
-
-    $ bundle exec exe/qwtf-discord-bot watcher --endpoints sydney.fortressone.org:27501
-
 
 ## License
 

data/lib/config.rb

@@ -0,0 +1,43 @@
+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
+  end
+
+  def address
+    @config.keys.first
+  end
+
+  def channel_ids
+    channel_ids = []
+
+    @config.values.each do |settings|
+      settings.each do |setting|
+        setting["channel_ids"].each do |channel_id|
+          channel_ids << channel_id
+        end
+      end
+    end
+
+    channel_ids
+  end
+end

data/lib/qwtf_discord_bot.rb

@@ -4,28 +4,20 @@ require 'qwtf_discord_bot/qwtf_discord_bot_watcher'
 require 'discordrb'
 require 'yaml'
 
+require 'config'
 require 'qstat_request'
 require 'player'
 require 'team'
 require 'emoji'
 require 'roster'
-require 'endpoint'
 
 class QwtfDiscordBot # :nodoc:
-  ENV_VARS = %w[
-    QWTF_DISCORD_BOT_TOKEN
-    QWTF_DISCORD_BOT_CLIENT_ID
-  ].freeze
-
-
-  if ENV_VARS.any? { |var| !ENV.key?(var) }
-    raise 'Environment variables not configured'
-  end
-
-  TOKEN = ENV['QWTF_DISCORD_BOT_TOKEN'].strip
-  CLIENT_ID = ENV['QWTF_DISCORD_BOT_CLIENT_ID'].strip
+  CONFIG_FILE = ENV['QWTF_DISCORD_BOT_CONFIG_FILE'] || "#{Dir.pwd}/config.yaml"
 
   def initialize
-    @endpoints = YAML.load_file('config/endpoints.yaml')
+    @config = Config.new(CONFIG_FILE)
+    @token = @config.token
+    @client_id = @config.client_id
+    @endpoints = @config.endpoints
   end
 end

data/lib/qwtf_discord_bot/qwtf_discord_bot_server.rb

@@ -1,8 +1,8 @@
 class QwtfDiscordBotServer < QwtfDiscordBot # :nodoc:
   def run
     bot = Discordrb::Commands::CommandBot.new(
-      token: TOKEN,
-      client_id: CLIENT_ID,
+      token: @token,
+      client_id: @client_id,
       prefix: '!'
     )
 
@@ -27,11 +27,11 @@ class QwtfDiscordBotServer < QwtfDiscordBot # :nodoc:
     end
 
     bot.command :all do |event|
-      @endpoints.each do |endpoint, channel_ids|
-        channel_ids.each do |channel_id|
-          next if event.channel.id != channel_id
+      @endpoints.each do |endpoint|
+        endpoint.channel_ids.each do |channel_id|
+          next unless event.channel.id == channel_id
 
-          qstat_request = QstatRequest.new(endpoint)
+          qstat_request = QstatRequest.new(endpoint.address)
           message = qstat_request.server_summary
           embed = qstat_request.to_embed
 
@@ -48,11 +48,11 @@ class QwtfDiscordBotServer < QwtfDiscordBot # :nodoc:
     end
 
     bot.command :active do |event|
-      @endpoints.each do |endpoint, channel_ids|
-        channel_ids.each do |channel_id|
-          next if event.channel.id != channel_id
+      @endpoints.each do |endpoint|
+        endpoint.channel_ids.each do |channel_id|
+          next unless event.channel.id == channel_id
 
-          qstat_request = QstatRequest.new(endpoint)
+          qstat_request = QstatRequest.new(endpoint.address)
           next if qstat_request.is_empty?
 
           message = qstat_request.server_summary

data/lib/qwtf_discord_bot/qwtf_discord_bot_watcher.rb

@@ -4,13 +4,14 @@ class QwtfDiscordBotWatcher < QwtfDiscordBot
 
   def run
     every(THIRTY_SECONDS) do
-      @endpoints.each do |endpoint, channel_ids|
-        request = QstatRequest.new(endpoint)
+      @endpoints.each do |endpoint|
+        address = endpoint.address
+        request = QstatRequest.new(address)
         next if request.is_empty?
 
         request.player_names.each do |name|
-          unless seen_recently?(endpoint: endpoint, name: name)
-            channel_ids.each do |channel_id|
+          unless seen_recently?(endpoint: address, name: name)
+            endpoint.channel_ids.each do |channel_id|
               report_joined(
                 name: name,
                 channel_id: channel_id,
@@ -19,8 +20,8 @@ class QwtfDiscordBotWatcher < QwtfDiscordBot
             end
           end
 
-          history[endpoint] ||= {}
-          history[endpoint][name] = Time.now
+          history[address] ||= {}
+          history[address][name] = Time.now
         end
       end
     end
@@ -42,7 +43,7 @@ class QwtfDiscordBotWatcher < QwtfDiscordBot
 
   def report_joined(name:, channel_id:, server_summary:)
     Discordrb::API::Channel.create_message(
-      "Bot #{TOKEN}",
+      "Bot #{@token}",
       channel_id,
       "#{name} has joined #{server_summary}"
     )

data/lib/qwtf_discord_bot/version.rb

@@ -1,3 +1,3 @@
 class QwtfDiscordBot
-  VERSION = '3.0.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Sheldon Johnson
@@ -66,7 +66,6 @@ files:
 - bin/rspec
 - bin/setup
 - bin/thor
-- config/endpoints.yaml
 - emoji/blue_demoman.png
 - emoji/blue_engineer.png
 - emoji/blue_hwguy.png
@@ -86,6 +85,7 @@ files:
 - emoji/red_soldier.png
 - emoji/red_spy.png
 - exe/qwtf_discord_bot
+- lib/config.rb
 - lib/emoji.rb
 - lib/player.rb
 - lib/qstat_request.rb

data/config/endpoints.yaml

@@ -1,5 +0,0 @@
----
-# Add each endpoint below the in format
-# "<hostname>:<port>":
-#   - CHANNEL_ID_1
-#   - CHANNEL_ID_2