qwtf_discord_bot 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0989489e22f9720bb4d8e94a84a931f51127dd610b6abf9c6ed93b32353f93cb'
-  data.tar.gz: 5791e08db5e473dc20aaaf47f26c426d5201f83d7e389f680bb85c75f74cc60b
+  metadata.gz: 62157a5a72751b294e2ee10e08455e2ae86b617f4f04ab4654c4e85a0bc57391
+  data.tar.gz: 815994275f732832081c1d9ed36f75ca1063eda17d16875d6823756f306aecca
 SHA512:
-  metadata.gz: 70d31f2b3fc3da34587b57bfe3241963f1d4b4f77a0e53dc244f044f3b323d343bd86ef89b326fd161e0d1311a55b9dac6abc7afd04364a3991bd8691fa319f6
-  data.tar.gz: 1dcfe209e62ab29c3fcb812751d5664c54aaad1540fe89506d705e3b4e19befc1b195b18b00ede875e47bee4caa6bb36ae6faee592a95202298dcda17135014e
+  metadata.gz: 933a0d807334cceafa97c3f9f48e00554483c04057c042c4fd74b7e2a676778340e8349ff2959a0a3a5641adf9329ccea0aa382e22737b31a119a71ce2a9c55c
+  data.tar.gz: 9f6a616d96d8e5173e2f896ec0de689315ac468e08a8c82a5fc85b202ed619325aa267b3b5212a6bde48b1a357004014e2ad0a798c8e407ef5eac92da15f9039

data/Gemfile

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

data/Gemfile.lock

@@ -1,14 +1,11 @@
 PATH
   remote: .
   specs:
-    qwtf_discord_bot (0.3.3)
-      discordrb
-      thor (~> 0)
+    qwtf_discord_bot (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
     discordrb (3.2.1)
       discordrb-webhooks (~> 3.2.0.1)
       opus-ruby
@@ -29,26 +26,12 @@ GEM
     netrc (0.11.0)
     opus-ruby (1.0.1)
       ffi
-    rake (10.5.0)
     rbnacl (3.4.0)
       ffi
     rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
     thor (0.20.0)
     unf (0.1.4)
       unf_ext
@@ -62,10 +45,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler
+  discordrb
   qwtf_discord_bot!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  thor
 
 BUNDLED WITH
    1.16.2

data/README.md

@@ -2,8 +2,6 @@
 
 A Discord bot for checking the status of QuakeWorld Team Fortress servers
 
-![screenshot of bot](screenshot.png)
-
 
 ## Dependencies
 
@@ -35,9 +33,9 @@ There are two features:
 ### Server
 
 This responds to `!server` messages by providing information about your game
-server. E.G.
+server.
 
-    $ bundle exec exe/qwtf-discord-bot server --hostname fortressone.ga --port 27501
+![screenshot of bot responding to !server command](server_screenshot.png)
 
 ```
 Usage:
@@ -50,14 +48,18 @@ Options:
                          # Default: 27500
 ```
 
+E.G.
+
+    $ bundle exec exe/qwtf-discord-bot server --hostname fortressone.ga --port 27501
+
 
 ### 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.
+they haven't been connected for more than ten minutes.
 
-    $ bundle exec exe/qwtf-discord-bot watcher --hostname fortressone.ga --port 27501
+![screenshot of bot reporting player joining server](watcher_screenshot.png)
 
 ```
 Usage:
@@ -70,6 +72,11 @@ Options:
                          # Default: 27500
 ```
 
+E.G.
+
+    $ bundle exec exe/qwtf-discord-bot watcher --hostname fortressone.ga --port 27501
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/qwtf_discord_bot

@@ -14,7 +14,7 @@ class QwtfDiscordBotExe < Thor
   def server
     hostname = options['hostname']
     port = options['port']
-    server_bot = QwtfDiscordBot::Server.new(hostname: hostname, port: port)
+    server_bot = QwtfDiscordBotServer.new(hostname: hostname, port: port)
     server_bot.run
   end
 
@@ -24,7 +24,7 @@ class QwtfDiscordBotExe < Thor
   def watcher
     hostname = options['hostname']
     port = options['port']
-    watcher_bot = QwtfDiscordBot::Watcher.new(hostname: hostname, port: port)
+    watcher_bot = QwtfDiscordBotWatcher.new(hostname: hostname, port: port)
     watcher_bot.run
   end
 end

data/lib/emoji.rb

@@ -24,17 +24,7 @@ class Emoji
     }
   }.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]
+  def self.for(team:, player_class:)
+    LOOKUP[team] && LOOKUP[team][player_class]
   end
 end

data/lib/player.rb

@@ -34,7 +34,7 @@ class Player
   private
 
   def emoji
-    Emoji.new(self).to_s
+    Emoji.for(team: team.to_s, player_class: player_class)
   end
 
   def short_class

data/lib/qwtf_discord_bot/version.rb

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

data/lib/qwtf_discord_bot.rb

@@ -11,101 +11,84 @@ class QwtfDiscordBot
   CLIENT_ID = ENV['QWTF_DISCORD_BOT_CLIENT_ID'].strip
   CHANNEL_ID = ENV['QWTF_DISCORD_BOT_CHANNEL_ID'].strip
 
-  class Server
-    def initialize(hostname:, port:)
-      @hostname = hostname
-      @port = port
-    end
+  def initialize(hostname:, port:)
+    @hostname = hostname
+    @port = port
+  end
 
-    def run
-      bot = Discordrb::Commands::CommandBot.new(
-        token: TOKEN,
-        client_id: CLIENT_ID,
-        prefix: '!'
-      )
+  def endpoint
+    return @hostname if @port == 27500
+    [@hostname, @port].join(':')
+  end
+end
 
-      bot.command :server do |_event|
-        QstatRequest.new(endpoint).output
-      end
+class QwtfDiscordBotServer < QwtfDiscordBot
+  def run
+    bot = Discordrb::Commands::CommandBot.new(
+      token: TOKEN,
+      client_id: CLIENT_ID,
+      prefix: '!'
+    )
 
-      bot.run
+    bot.command :server do |_event|
+      QstatRequest.new(endpoint).output
     end
 
-    private
-
-    def endpoint
-      @endpoint ||= if @port == 27500
-                      @hostname
-                    else
-                      "#{@hostname}:#{@port}"
-                    end
-    end
+    bot.run
   end
+end
 
-  class Watcher
-    THIRTY_SECONDS = 30
-    TEN_MINUTES = 10 * 60
-
-    def initialize(hostname:, port:)
-      @hostname = hostname
-      @port = port
-      @history = {}
-    end
-
-    def run
-      every(THIRTY_SECONDS) do
-        request = QstatRequest.new(endpoint)
-        numplayers = request.numplayers
-        maxplayers = request.maxplayers
-        map = request.map
-
-        if request.players
-          player_names = request.players.map(&:name)
-
-          player_names.each do |name|
-            unless seen_recently?(name)
-              report_joined(name: name,
-                            map: map,
-                            numplayers: numplayers,
-                            maxplayers: maxplayers)
-            end
-
-            @history[name] = Time.now
+class QwtfDiscordBotWatcher < QwtfDiscordBot
+  THIRTY_SECONDS = 30
+  TEN_MINUTES = 10 * 60
+
+  def run
+    every(THIRTY_SECONDS) do
+      request = QstatRequest.new(endpoint)
+      numplayers = request.numplayers
+      maxplayers = request.maxplayers
+      map = request.map
+
+      if request.players
+        player_names = request.players.map(&:name)
+
+        player_names.each do |name|
+          unless seen_recently?(name)
+            report_joined(name: name,
+                          map: map,
+                          numplayers: numplayers,
+                          maxplayers: maxplayers)
           end
+
+          history[name] = Time.now
         end
       end
     end
+  end
 
-    private
-
-    def endpoint
-      @endpoint ||= if @port == 27500
-                      @hostname
-                    else
-                      "#{@hostname}:#{@port}"
-                    end
+  def every(n_seconds)
+    loop do
+      before = Time.now
+      yield
+      interval = n_seconds - (Time.now - before)
+      sleep(interval) if interval > 0
     end
+  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 seen_recently?(name)
+    last_seen = history[name]
+    last_seen && (Time.now - last_seen < TEN_MINUTES)
+  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_seconds)
-      loop do
-        before = Time.now
-        yield
-        interval = n_seconds - (Time.now - before)
-        sleep(interval) if interval > 0
-      end
-    end
+  def history
+    @history ||= {}
   end
 end

data/qwtf_discord_bot.gemspec

@@ -26,11 +26,4 @@ Gem::Specification.new do |spec|
   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 'thor', '~> 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,85 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: qwtf_discord_bot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Sheldon Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: discordrb
-  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
-    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: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+date: 2018-08-11 00:00:00.000000000 Z
+dependencies: []
 description: A Discord bot for reporting on QuakeWorld Team Fortress game servers
 email:
 - shayolden@hotmail.com
@@ -125,7 +55,8 @@ files:
 - lib/qwtf_discord_bot/version.rb
 - lib/team.rb
 - qwtf_discord_bot.gemspec
-- screenshot.png
+- server_screenshot.png
+- watcher_screenshot.png
 homepage: https://github.com/drzel/qwtf_discord_bot.git
 licenses:
 - MIT