qwtf_discord_bot 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17b3a605955a7c65f2b562ede207f81a65710cb8b25bd50a182ef87e7859b71d
-  data.tar.gz: 3a4d2102cf31c211a5183bcb960a74b143477a6237935eb9e4aa93b82b74a608
+  metadata.gz: af5a91eea63cee06b63358f91be5473c89aaac89dbbd8bbb06141b7ba3b0d7dd
+  data.tar.gz: '0815fbb7ba17b9232561f9fa10581c883fcf9ac8f41a4427949ecd32e4f3bebb'
 SHA512:
-  metadata.gz: 57b2ba74202f630c0a304195f281a8e51ebff62d6ac6cd908854d0665c95dd74bf831944ad5c4bd425d73219dc68a2390eaddfcd3c15495a742ab7e5c006c591
-  data.tar.gz: d23e6b6479b6cd7548696fbf1135e65c5ffd0a9fb85e576ed2cedfef3d649bfba0d9e4d8e074d9a4cefa76b3fb16f4a1ad9b1fddf577f46b7a4b64b22eb5db9d
+  metadata.gz: 235a0377e67ea4d2289f4dee19d08c7f7ee58b43c4218653c461dc4f859c17d803498ed30c7daa13bce64c35468905697d31b7f15260a5afa169ff654f40767d
+  data.tar.gz: f9378c160a7acebab7f648349e17021cbb8a31975a3e4cd713fe13fea9dd912d4471e6c119801d1ffe44ffa49e13b9b643e7a1419ece9b02ecd89eea843bd067

data/.gitignore

@@ -12,3 +12,4 @@
 assets/
 .env
 qstat
+*.gem

data/Gemfile.lock

@@ -1,13 +1,19 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (0.2.0)
+    qwtf_discord_bot (0.2.2)
+      activesupport
       discordrb
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
+    activesupport (5.2.0)
+      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)
@@ -17,22 +23,21 @@ GEM
       websocket-client-simple (>= 0.3.0)
     discordrb-webhooks (3.2.0.1)
       rest-client
-    domain_name (0.5.20170404)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     event_emitter (0.2.6)
     ffi (1.9.25)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    method_source (0.9.0)
+    i18n (1.0.1)
+      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
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
     rake (10.5.0)
     rbnacl (3.4.0)
       ffi
@@ -54,10 +59,13 @@ 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)
-    websocket (1.2.5)
+    websocket (1.2.8)
     websocket-client-simple (0.3.0)
       event_emitter
       websocket
@@ -67,11 +75,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  pry
   qwtf_discord_bot!
   rake (~> 10.0)
   rspec (~> 3.0)
-  thor
+  thor (~> 0)
 
 BUNDLED WITH
    1.16.2

data/README.md

@@ -1,38 +1,30 @@
 # QwtfDiscordBot
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/qwtf_discord_bot`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Discord bot for checking the status of QuakeWorld Team Fortress servers
 
-TODO: Delete this and the text above, and describe your gem
+![screenshot of bot](screenshot.png)
 
-## Installation
-
-Add this line to your application's Gemfile:
 
-```ruby
-gem 'qwtf_discord_bot'
-```
+## Dependencies
 
-And then execute:
+  - Ruby >= 2.5.0
+  - [qstat](https://github.com/multiplay/qstat) version with JSON support.  Tested with commit [2ab78bd5c30fbd47b2bdd4a6279296d66424b37e](https://github.com/multiplay/qstat/tree/2ab78bd5c30fbd47b2bdd4a6279296d66424b37e). Should be added to `$PATH`.
 
-    $ bundle
 
-Or install it yourself as:
+## Installation
 
     $ gem install qwtf_discord_bot
 
-## Usage
-
-    $ bundle exec exe\qwtf-discord-bot server
 
-## Development
+## Usage
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Create a bot on discord.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Edit the `.env.example` file, update with your bot's `client_id` and `token` and save as `.env`. Then:
 
-## Contributing
+    $ source .env
+    $ bundle exec exe\qwtf-discord-bot server
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/qwtf_discord_bot.
 
 ## License
 

data/exe/qwtf_discord_bot

@@ -1,6 +1,24 @@
 #!/usr/bin/env ruby
 
 require 'qwtf_discord_bot'
-require 'qwtf_discord_bot/cli'
+require "thor"
 
-QwtfDiscordBot::CLI.start
+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

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 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 name
-			@data["name"]
-		end
-
-		def short_class
-			skin.split("_").last
-		end
-
-		def skin
-			@data["skin"]
-		end
+  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

data/lib/qstat_request.rb

@@ -1,38 +1,38 @@
 class QstatRequest
-	def initialize(hostname)
-		@result = JSON.parse(%x[qstat -json -P -qws #{hostname}]).first
-	end
+  def initialize(hostname)
+    @result = JSON.parse(%x[qstat -json -P -qws #{hostname}]).first
+  end
 
-	def output
-		<<~HEREDOC
+  def output
+    <<~HEREDOC
       **#{address} | #{map} | #{numplayers}/#{maxplayers}**
       #{player_table}
-		HEREDOC
-	end
+    HEREDOC
+  end
 
-	def address
-		@result["address"]
-	end
+  def address
+    @result["address"]
+  end
 
-	def map
-		@result["map"]
-	end
+  def map
+    @result["map"]
+  end
 
-	def numplayers
-		@result["numplayers"]
-	end
+  def numplayers
+    @result["numplayers"]
+  end
 
-	def maxplayers
-		@result["maxplayers"]
-	end
+  def maxplayers
+    @result["maxplayers"]
+  end
 
-	def player_table
-		players.sort_by { |player| player.team.number }.map(&:to_row).join("\n")
-	end
+  def player_table
+    players.sort_by { |player| player.team.number }.map(&:to_row).join("\n")
+  end
 
-	def players
-		@result["players"].map do |player_data|
-			Player.new(player_data)
-		end
-	end
+  def players
+    @result["players"].map do |player_data|
+      Player.new(player_data)
+    end
+  end
 end

data/lib/qwtf_discord_bot.rb

@@ -1,23 +1,82 @@
 require "qwtf_discord_bot/version"
 require "discordrb"
+require 'active_support/core_ext/string'
 
 require "qstat_request"
 require "player"
 require "team"
 require "emoji"
 
-module QwtfDiscordBot
-  raise "DISCORD_QSTAT_BOT_TOKEN environment variable not set" unless ENV["DISCORD_QSTAT_BOT_TOKEN"]
-
-  TOKEN = ENV["DISCORD_QSTAT_BOT_TOKEN"].strip
-  CLIENT_ID = ENV["DISCORD_CLIENT_ID"].strip
+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"
 
-  bot = Discordrb::Commands::CommandBot.new token: TOKEN, client_id: CLIENT_ID, prefix: "!"
+  class Server
+    def initialize
+      @bot ||= Discordrb::Commands::CommandBot.new(
+        token: TOKEN,
+        client_id: CLIENT_ID,
+        prefix: "!"
+      )
+
+      @bot.command :server do |event|
+        QstatRequest.new(HOSTNAME).output
+      end
+    end
 
-  bot.command :server do |event|
-    QstatRequest.new(HOSTNAME).output
+    def run
+      @bot.run
+    end
   end
 
-  bot.run
+  class Watcher
+    THIRTY_SECONDS = 30
+    TEN_MINUTES = 10 * 60
+
+    def initialize
+      @history = {}
+    end
+
+    def run
+      every(THIRTY_SECONDS) do
+        request = QstatRequest.new(HOSTNAME)
+        player_names = request.players.map(&:name)
+        numplayers = request.numplayers
+
+        player_names.each do |name|
+          report_joined(name, numplayers) unless seen_recently?(name)
+          @history[name] = Time.now
+        end
+      end
+    end
+
+    private
+
+      def report_joined(name, numplayers)
+        number_of_other_players = numplayers - 1
+
+        Discordrb::API::Channel.create_message(
+          "Bot #{TOKEN}",
+          CHANNEL_ID,
+          "**#{name}** has joined **#{number_of_other_players}** " \
+          "#{"other player".pluralize(number_of_other_players)} on **#{HOSTNAME}**"
+        )
+      end
+
+      def seen_recently?(name)
+        last_seen = @history[name]
+        last_seen && (Time.now - last_seen < TEN_MINUTES)
+      end
+
+      def every(n)
+        loop do
+          before = Time.now
+          yield
+          interval = n-(Time.now-before)
+          sleep(interval) if interval > 0
+        end
+      end
+  end
 end

data/lib/qwtf_discord_bot/cli.rb

@@ -1,10 +1,22 @@
-require 'thor'
-
-module QwtfDiscordBot
-	class CLI < Thor
-		desc "server", "Runs the qwtf-discord-bot"
-		def server
-			QwtfDiscordBot::Server.run
-		end
-	end
-end
+#!/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

data/lib/qwtf_discord_bot/version.rb

@@ -1,3 +1,3 @@
-module QwtfDiscordBot
-  VERSION = "0.2.2"
+class QwtfDiscordBot
+  VERSION = "0.3.0"
 end

data/qwtf_discord_bot.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "qwtf_discord_bot/version"
@@ -9,19 +8,27 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Sheldon Johnson"]
   spec.email         = ["shayolden@hotmail.com"]
 
-  spec.description   = %q{A discord bot for checking the status of qwtf servers}
-  spec.summary       = %q{A discord bot for checking the status of qwtf 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.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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "discordrb"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "thor", '~> 0'
   spec.add_development_dependency "bundler", "~> 1.16"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: A discord bot for checking the status of qwtf servers
+description: A Discord bot for reporting on QuakeWorld Team Fortress game servers
 email:
 - shayolden@hotmail.com
 executables:
@@ -106,9 +120,8 @@ files:
 - lib/qwtf_discord_bot/cli.rb
 - lib/qwtf_discord_bot/version.rb
 - lib/team.rb
-- qwtf_discord_bot-0.2.0.gem
-- qwtf_discord_bot-0.2.1.gem
 - qwtf_discord_bot.gemspec
+- screenshot.png
 homepage: https://github.com/drzel/qwtf_discord_bot.git
 licenses:
 - MIT
@@ -132,5 +145,7 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: A discord bot for checking the status of qwtf servers
+summary: Works by wrapping the excellent CLI server query toolqstat. Accepts the !server
+  command from users and also periodically checks for new players on the server and
+  reports about them.
 test_files: []