qwtf_discord_bot 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7f38a56cd0deee24b921ec3d9c0c002da8936cf10681197c2663eba97fcb66d
-  data.tar.gz: 2827cd8f642c3339e0e3f2baed06fe6c722d6fcdbc1e691f933b930967679c98
+  metadata.gz: '0989489e22f9720bb4d8e94a84a931f51127dd610b6abf9c6ed93b32353f93cb'
+  data.tar.gz: 5791e08db5e473dc20aaaf47f26c426d5201f83d7e389f680bb85c75f74cc60b
 SHA512:
-  metadata.gz: 69d996e55938128e7ce0504854425f9c5e2691de450ded94c786b12fdaf7621c7e502caf67031cc0a6f2694aee3aa1d819614dbf309f03f4e3ad84a72a293d8b
-  data.tar.gz: 751965e1f052fa0f443c1828de268d986342401f5075466d7760004f8bc6e2e9608dd09f1fd9cab35cb1b439d5bfb0e4fb872ea2b4a57ab8eff1a1b651c145c1
+  metadata.gz: 70d31f2b3fc3da34587b57bfe3241963f1d4b4f77a0e53dc244f044f3b323d343bd86ef89b326fd161e0d1311a55b9dac6abc7afd04364a3991bd8691fa319f6
+  data.tar.gz: 1dcfe209e62ab29c3fcb812751d5664c54aaad1540fe89506d705e3b4e19befc1b195b18b00ede875e47bee4caa6bb36ae6faee592a95202298dcda17135014e

data/.env.example

@@ -0,0 +1,3 @@
+export QWTF_DISCORD_BOT_TOKEN="lsadASDakslndasDsaNDKSamDSAMDLKASmDK.asmLDKASMDksaKMDasLKMD"
+export QWTF_DISCORD_BOT_CLIENT_ID="370341285576923743"
+export QWTF_DISCORD_BOT_CHANNEL_ID="120378917238730177"

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in qwtf_discord_bot.gemspec
 gemspec

data/Gemfile.lock

@@ -1,20 +1,13 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (0.3.2)
-      activesupport
+    qwtf_discord_bot (0.3.3)
       discordrb
       thor (~> 0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     discordrb (3.2.1)
       discordrb-webhooks (~> 3.2.0.1)
@@ -30,12 +23,9 @@ GEM
     ffi (1.9.25)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.1.0)
-      concurrent-ruby (~> 1.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    minitest (5.11.3)
     netrc (0.11.0)
     opus-ruby (1.0.1)
       ffi
@@ -60,9 +50,6 @@ GEM
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
     thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)

data/README.md

@@ -20,12 +20,56 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
 
 Create a bot on discord.
 
-Edit the `.env.example` file, update with your bot's `client_id` and `token` and save as `.env`. Then:
+Edit the `.env.example` file, update with your bot's `client_id` and `token` and save as `.env`.
 
     $ source .env
-    $ bundle exec exe\qwtf-discord-bot server
 
 
+### List commands
+
+    $ bundle exec exe/qwtf-discord-bot server help
+
+There are two features:
+
+
+### Server
+
+This responds to `!server` messages by providing information about your game
+server. E.G.
+
+    $ bundle exec exe/qwtf-discord-bot server --hostname fortressone.ga --port 27501
+
+```
+Usage:
+  qwtf_discord_bot server
+
+Options:
+  [--hostname=HOSTNAME]
+                         # Default: localhost
+  [--port=N]
+                         # Default: 27500
+```
+
+
+### 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
+they haven't been connected for more than ten minutes. E.G.
+
+    $ bundle exec exe/qwtf-discord-bot watcher --hostname fortressone.ga --port 27501
+
+```
+Usage:
+  qwtf_discord_bot watcher
+
+Options:
+  [--hostname=HOSTNAME]
+                         # Default: localhost
+  [--port=N]
+                         # Default: 27500
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "qwtf_discord_bot"
+require 'bundler/setup'
+require 'qwtf_discord_bot'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "qwtf_discord_bot"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/exe/qwtf_discord_bot

@@ -1,24 +1,32 @@
-#!/usr/bin/env ruby
-
-require 'qwtf_discord_bot'
-require "thor"
-
-class QwtfDiscordBotExe < Thor
-  def self.exit_on_failure?
-    true
-  end
-  
-  desc "server", "Runs the qwtf-discord-bot server"
-  def server
-    server_bot = QwtfDiscordBot::Server.new
-    server_bot.run
-  end
-
-  desc "watcher", "Runs the qwtf-discord-bot watcher"
-  def watcher
-    watcher_bot = QwtfDiscordBot::Watcher.new
-    watcher_bot.run
-  end
-end
-
-QwtfDiscordBotExe.start
+#!/usr/bin/env ruby
+
+require 'qwtf_discord_bot'
+require 'thor'
+
+class QwtfDiscordBotExe < Thor
+  def self.exit_on_failure?
+    true
+  end
+
+  desc 'server', 'Responds to `!server` with server information'
+  method_option :hostname, alias: '-h', default: 'localhost'
+  method_option :port, type: :numeric, alias: '-p', default: 27500
+  def server
+    hostname = options['hostname']
+    port = options['port']
+    server_bot = QwtfDiscordBot::Server.new(hostname: hostname, port: port)
+    server_bot.run
+  end
+
+  desc 'watcher', 'Watches server and accounces when a player joins'
+  method_option :hostname, alias: '-h', default: 'localhost'
+  method_option :port, type: :numeric, alias: '-p', default: 27500
+  def watcher
+    hostname = options['hostname']
+    port = options['port']
+    watcher_bot = QwtfDiscordBot::Watcher.new(hostname: hostname, port: port)
+    watcher_bot.run
+  end
+end
+
+QwtfDiscordBotExe.start

data/lib/emoji.rb

@@ -1,41 +1,40 @@
-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>"
-		}
-	} 
-
-	def initialize(player)
-		@player = player
-	end
-
-	def to_s
-		id || ""
-
-	end
-
-	private
-
-		def id
-			@id ||= LOOKUP[@player.team.to_s] && LOOKUP[@player.team.to_s][@player.player_class]
-		end
-end
+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 initialize(player)
+    @player = player
+  end
+
+  def to_s
+    id || ''
+  end
+
+  private
+
+  def id
+    @id ||= LOOKUP[@player.team.to_s] && LOOKUP[@player.team.to_s][@player.player_class]
+  end
+end

data/lib/player.rb

@@ -1,47 +1,47 @@
-class Player
-  PLAYER_CLASSES = {
-    "sco" => "scout",
-    "sni" => "sniper",
-    "sol" => "soldier",
-    "dem" => "demoman",
-    "med" => "medic",
-    "pyr" => "pyro",
-    "hwg" => "hwguy",
-    "spy" => "spy",
-    "eng" => "engineer"
-  }
-
-  def initialize(data)
-    @data = data
-  end
-
-  def name
-    @data["name"]
-  end
-
-  def to_row
-    "#{emoji}#{name}"
-  end
-
-  def team
-    @team ||= Team.new(@data["team"].to_sym)
-  end
-
-  def player_class
-    PLAYER_CLASSES[short_class]
-  end
-
-  private
-
-    def emoji
-      Emoji.new(self).to_s
-    end
-
-    def short_class
-      skin.split("_").last
-    end
-
-    def skin
-      @data["skin"]
-    end
-end
+class Player
+  PLAYER_CLASSES = {
+    'sco' => 'scout',
+    'sni' => 'sniper',
+    'sol' => 'soldier',
+    'dem' => 'demoman',
+    'med' => 'medic',
+    'pyr' => 'pyro',
+    'hwg' => 'hwguy',
+    'spy' => 'spy',
+    'eng' => 'engineer'
+  }.freeze
+
+  def initialize(data)
+    @data = data
+  end
+
+  def name
+    @data['name']
+  end
+
+  def to_row
+    "#{emoji}#{name}"
+  end
+
+  def team
+    @team ||= Team.new(@data['team'].to_sym)
+  end
+
+  def player_class
+    PLAYER_CLASSES[short_class]
+  end
+
+  private
+
+  def emoji
+    Emoji.new(self).to_s
+  end
+
+  def short_class
+    skin.split('_').last
+  end
+
+  def skin
+    @data['skin']
+  end
+end

data/lib/qstat_request.rb

@@ -1,6 +1,6 @@
 class QstatRequest
-  def initialize(hostname)
-    @result = JSON.parse(%x[qstat -json -P -qws #{hostname}]).first
+  def initialize(endpoint)
+    @result = JSON.parse(%x[qstat -json -P -qws #{endpoint}]).first
   end
 
   def output

data/lib/qwtf_discord_bot/version.rb

@@ -1,3 +1,3 @@
 class QwtfDiscordBot
-  VERSION = "0.3.3"
+  VERSION = '0.4.0'.freeze
 end

data/lib/qwtf_discord_bot.rb

@@ -1,32 +1,44 @@
-require "qwtf_discord_bot/version"
-require "discordrb"
+require 'qwtf_discord_bot/version'
+require 'discordrb'
 
-require "qstat_request"
-require "player"
-require "team"
-require "emoji"
+require 'qstat_request'
+require 'player'
+require 'team'
+require 'emoji'
 
 class QwtfDiscordBot
-  TOKEN = ENV["QWTF_DISCORD_BOT_TOKEN"].strip
-  CLIENT_ID = ENV["QWTF_DISCORD_BOT_CLIENT_ID"].strip
-  CHANNEL_ID = ENV["QWTF_DISCORD_BOT_CHANNEL_ID"].strip
-  HOSTNAME = "fortressone.ga"
+  TOKEN = ENV['QWTF_DISCORD_BOT_TOKEN'].strip
+  CLIENT_ID = ENV['QWTF_DISCORD_BOT_CLIENT_ID'].strip
+  CHANNEL_ID = ENV['QWTF_DISCORD_BOT_CHANNEL_ID'].strip
 
   class Server
-    def initialize
-      @bot ||= Discordrb::Commands::CommandBot.new(
+    def initialize(hostname:, port:)
+      @hostname = hostname
+      @port = port
+    end
+
+    def run
+      bot = Discordrb::Commands::CommandBot.new(
         token: TOKEN,
         client_id: CLIENT_ID,
-        prefix: "!"
+        prefix: '!'
       )
 
-      @bot.command :server do |event|
-        QstatRequest.new(HOSTNAME).output
+      bot.command :server do |_event|
+        QstatRequest.new(endpoint).output
       end
+
+      bot.run
     end
 
-    def run
-      @bot.run
+    private
+
+    def endpoint
+      @endpoint ||= if @port == 27500
+                      @hostname
+                    else
+                      "#{@hostname}:#{@port}"
+                    end
     end
   end
 
@@ -34,13 +46,15 @@ class QwtfDiscordBot
     THIRTY_SECONDS = 30
     TEN_MINUTES = 10 * 60
 
-    def initialize
+    def initialize(hostname:, port:)
+      @hostname = hostname
+      @port = port
       @history = {}
     end
 
     def run
       every(THIRTY_SECONDS) do
-        request = QstatRequest.new(HOSTNAME)
+        request = QstatRequest.new(endpoint)
         numplayers = request.numplayers
         maxplayers = request.maxplayers
         map = request.map
@@ -64,26 +78,34 @@ class QwtfDiscordBot
 
     private
 
-      def report_joined(name:, map:, numplayers:, maxplayers:)
-        Discordrb::API::Channel.create_message(
-          "Bot #{TOKEN}",
-          CHANNEL_ID,
-          "**#{name}** has joined **#{HOSTNAME} | #{map} | #{numplayers}/#{maxplayers}**"
-        )
-      end
+    def endpoint
+      @endpoint ||= if @port == 27500
+                      @hostname
+                    else
+                      "#{@hostname}:#{@port}"
+                    end
+    end
 
-      def seen_recently?(name)
-        last_seen = @history[name]
-        last_seen && (Time.now - last_seen < TEN_MINUTES)
-      end
+    def report_joined(name:, map:, numplayers:, maxplayers:)
+      Discordrb::API::Channel.create_message(
+        "Bot #{TOKEN}",
+        CHANNEL_ID,
+        "**#{name}** has joined **#{endpoint} | #{map} | #{numplayers}/#{maxplayers}**"
+      )
+    end
 
-      def every(n)
-        loop do
-          before = Time.now
-          yield
-          interval = n-(Time.now-before)
-          sleep(interval) if interval > 0
-        end
+    def seen_recently?(name)
+      last_seen = @history[name]
+      last_seen && (Time.now - last_seen < TEN_MINUTES)
+    end
+
+    def every(n_seconds)
+      loop do
+        before = Time.now
+        yield
+        interval = n_seconds - (Time.now - before)
+        sleep(interval) if interval > 0
       end
+    end
   end
 end

data/lib/team.rb

@@ -1,13 +1,13 @@
-class Team
-	attr_accessor :number
-
-	TEAMS = { spec: 0, blue: 1, red: 2, yell: 3, gren: 4 }
-
-	def initialize(sym)
-		@number = TEAMS[sym] || 0
-	end
-
-	def to_s
-		TEAMS.key(@number).to_s
-	end
-end
+class Team
+  attr_accessor :number
+
+  TEAMS = { spec: 0, blue: 1, red: 2, yell: 3, gren: 4 }.freeze
+
+  def initialize(sym)
+    @number = TEAMS[sym] || 0
+  end
+
+  def to_s
+    TEAMS.key(@number).to_s
+  end
+end

data/qwtf_discord_bot.gemspec

@@ -1,36 +1,36 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "qwtf_discord_bot/version"
+require 'qwtf_discord_bot/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "qwtf_discord_bot"
+  spec.name          = 'qwtf_discord_bot'
   spec.version       = QwtfDiscordBot::VERSION
-  spec.authors       = ["Sheldon Johnson"]
-  spec.email         = ["shayolden@hotmail.com"]
+  spec.authors       = ['Sheldon Johnson']
+  spec.email         = ['shayolden@hotmail.com']
 
-  spec.description   = "A Discord bot for reporting on QuakeWorld Team " \
-                       "Fortress game servers"
+  spec.description   = 'A Discord bot for reporting on QuakeWorld Team ' \
+                       'Fortress game servers'
 
-  spec.summary       = "Works by wrapping the excellent CLI server query tool" \
-                       "qstat. Accepts the !server command from users and " \
-                       "also periodically checks for new players on the " \
-                       "server and reports about them."
+  spec.summary       = 'Works by wrapping the excellent CLI server query tool' \
+                       'qstat. Accepts the !server command from users and ' \
+                       'also periodically checks for new players on the ' \
+                       'server and reports about them.'
 
-  spec.homepage      = "https://github.com/drzel/qwtf_discord_bot.git"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/drzel/qwtf_discord_bot.git'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "discordrb"
-  spec.add_dependency "thor", '~> 0'
+  spec.add_dependency 'discordrb'
+  spec.add_dependency 'thor', '~> 0'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -88,6 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -98,12 +99,29 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- emoji/blue_demoman.png
+- emoji/blue_engineer.png
+- emoji/blue_hwguy.png
+- emoji/blue_medic.png
+- emoji/blue_pyro.png
+- emoji/blue_scout.png
+- emoji/blue_sniper.png
+- emoji/blue_soldier.png
+- emoji/blue_spy.png
+- emoji/red_demoman.png
+- emoji/red_engineer.png
+- emoji/red_hwguy.png
+- emoji/red_medic.png
+- emoji/red_pyro.png
+- emoji/red_scout.png
+- emoji/red_sniper.png
+- emoji/red_soldier.png
+- emoji/red_spy.png
 - exe/qwtf_discord_bot
 - lib/emoji.rb
 - lib/player.rb
 - lib/qstat_request.rb
 - lib/qwtf_discord_bot.rb
-- lib/qwtf_discord_bot/cli.rb
 - lib/qwtf_discord_bot/version.rb
 - lib/team.rb
 - qwtf_discord_bot.gemspec

data/lib/qwtf_discord_bot/cli.rb

@@ -1,22 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'qwtf_discord_bot'
-require "thor"
-
-class QwtfDiscordBot < Thor
-  def self.exit_on_failure?
-    true
-  end
-  
-  desc "server", "Runs the qwtf-discord-bot server"
-  def server
-    QwtfDiscordBot::Server.run
-  end
-
-  desc "watcher", "Runs the qwtf-discord-bot watcher"
-  def watcher
-    QwtfDiscordBot::Watcher.run
-  end
-end
-
-QwtfDiscordBot.start