kag-gather 1.4.8 → 1.4.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2E4YWM4ODA4OGM2NGZjZGU3ZjAwNWY1ZGNhOWJiNWFlYjI3OWZlNw==
+    ODk3YzJkM2M2ODRhMzQzM2FhMjQzZmI0NGYxZjZlY2Y5OTg3MzY2OQ==
   data.tar.gz: !binary |-
-    ZjA5M2QzZmY0OWNjZjA0N2YzYTUyNDNiODg5MGZlMzdjOTJhYTRhYw==
+    OWNlNDk0MDFhY2QwMTkzMTM4YWRlNjM5NTUzZmY5MTNjM2UwNzQ2ZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjExZGRjMzY2ZTFjN2M2YjUxMjdiMTg2Y2JlODg5ZGMxY2M2OWZiMjQwZmIy
-    NjEyMTgwYWViNmU3NWExNzFlYTMxZjdhOWYzNWVhMjBmNTAxNGUxNGIzYTEz
-    ODM0Yzk3N2IzYzc0MjUzNDg3MWFjMDA2OTIxYTdmZDdkNTZmZGQ=
+    ZGQ4NGY5ZWFiMjQ1NWE5MmVjOGM4ZGRiNzU1N2M1YzMwOTk5YTU1NTA2NWNh
+    NzI2ZDNkYjRmYjZjNzY4MjUxNTAwYzc5MzExYmNlN2U3YWJjMmZmNWU2YjJm
+    N2VmNTk0ZmNkMTFhZGFmZTQ4OGViOWQwZDIwYzg1MzVlYzNiZmI=
   data.tar.gz: !binary |-
-    YWNmMDk1ZDMxN2M0MWU5MjNlYjllN2ViOGZhY2I2MDJhNGU2OTg1ZmY5MDVl
-    ZjA5YmNhYjE0NGNlNzQ5MmI0MWQ3NjJjMzE3NTIzODlkNjVmOWZhZDEzYzM1
-    NzdiN2E4MDZkOWYxZDEyZDVmN2M4ZTk3OGVhNTQ0ZDUwNWYwMzY=
+    YWQyMzEwNjg0NTc5Mjk0MzRhNjk2ZjM0Nzc3ZDVhYmNlZTdlNWJkMGIwMjk5
+    MWQ0NzdiMDRjNDRmYTI2NGIwMGM1YzczZWQ4OTdhZmI4ZGY5MzdiZGEzOTFm
+    ZTc3MjQ3MDE4ZjdiYmYyM2RjMTIzZDk2ZmFmMDlhMTEyY2FhOWU=

data/lib/commands/help.rb

@@ -12,12 +12,14 @@ module Cinch
       include Cinch::Commands
       include KAG::Common
 
-      command :help, {command: :string},
+      command :h, {command: :string},
         summary:     %{Displays help information for the COMMAND},
+        method: :help,
         description: %{Finds the COMMAND and prints the usage and description for the COMMAND.}
 
-      command :help, {},
+      command :h, {},
         summary: "Lists available commands",
+        method: :help,
         description: %{If no COMMAND argument is given, then all commands will be listed.}
 
       #
@@ -47,7 +49,7 @@ module Cinch
             # print the description of the first command
             desc = found.first.description.to_s
             msg = "\x0302#{msg.join(", ")}\x0314"+(desc != "" ? " - #{desc}" : " - #{found.first.summary.to_s}")
-            User(m.user.nick).send(msg)
+            m.user.send(msg)
           end
         else
           msg = []
@@ -55,7 +57,7 @@ module Cinch
             #msg << "\x0302#{cmd.usage}\x0314: #{cmd.summary}" unless (cmd.admin and !is_admin(m.user))
             msg << "!"+cmd.usage
           end
-          User(m.user.nick).send(msg.join ", ")
+          m.user.send(msg.join ", ")
         end
       end
 

data/lib/kag/bans/report.rb

@@ -157,7 +157,7 @@ module KAG
             puts e.backtrace
           end
         else
-          user.send "You must first AUTH on the IRC server via Q before you can use this bot."
+          user.send _h("command_not_authed")
           KAG::Config.data.add_action(user)
         end
       end

data/lib/kag/bot/bot.rb

@@ -7,6 +7,7 @@ require 'kag/bans/plugin'
 require 'kag/irc/plugin'
 require 'kag/bot/plugin'
 require 'kag/user/plugin'
+require 'kag/help/plugin'
 require 'commands/help'
 
 module KAG
@@ -30,7 +31,8 @@ module KAG
               KAG::Gather::Plugin,
               KAG::Bans::Plugin,
               KAG::IRC::Plugin,
-              KAG::User::Plugin
+              KAG::User::Plugin,
+              KAG::Help::Plugin
             ]
             if config[:sasl]
               c.sasl.username = config[:sasl][:username]

data/lib/kag/common.rb

@@ -1,3 +1,4 @@
+require 'kag/help/book'
 
 module KAG
   module Common
@@ -30,5 +31,17 @@ module KAG
       o = (KAG::Config.instance[:owners] or [])
       o.include?(user.authname)
     end
+
+    def _h(key,params = {})
+      if KAG::Help::Book.instance.key?(key.to_sym)
+        text = KAG::Help::Book.instance[key.to_sym].to_s
+        params.each do |k,v|
+          text.gsub!("[[+"+k.to_s+"]]",v)
+        end
+        text
+      else
+        ""
+      end
+    end
   end
 end

data/lib/kag/gather/plugin.rb

@@ -68,6 +68,7 @@ module KAG
             if match.needs_sub?
               placement = match.sub_in(m.user)
               if placement
+                placement[:channel_msg] = placement[:channel_msg].gsub("[[+user]]",m.user.authname)
                 reply m,placement[:channel_msg]
                 m.user.send placement[:private_msg]
               end

data/lib/kag/gather/team.rb

@@ -54,7 +54,7 @@ module KAG
           sub[:cls] = self.teammates[user.authname.to_sym]
           sub[:team] = self.clone
           sub[:msg] = "Sub needed at #{self.match.server[:ip]} for #{sub[:team][:name]}, #{sub[:cls]} Class! Type !sub to claim it!"
-          sub[:channel_msg] = "#{user.authname} is now subbing in for #{self[:name]} at #{self.match.server[:key]}. Subs still needed: #{self.match[:subs_needed].length}"
+          sub[:channel_msg] = "[[+user]] is now subbing in for #{self[:name]} at #{self.match.server[:key]}. Subs still needed: #{self.match[:subs_needed].length}"
           sub[:private_msg] = "Please #{self.match.server.text_join} | #{sub[:cls]} on the #{self[:name]} Team"
           self.players.delete(user.authname.to_sym)
           self.teammates.delete(user.authname.to_sym)

data/lib/kag/help/book.rb

@@ -0,0 +1,41 @@
+module KAG
+  module Help
+    class Book < Hash
+      include Singleton
+
+      def initialize(hash=nil)
+        super
+        self.merge!(self._load)
+      end
+
+      def _load
+        unless File.exists?("config/help.json")
+          File.open("config/help.json","w") {|f| f.write("{}") }
+        end
+        f = ::IO.read("config/help.json")
+        if f and !f.empty?
+          SymbolTable.new(JSON.parse(f))
+        else
+          SymbolTable.new
+        end
+      end
+
+      def reload
+        puts "Reloading help file..."
+        self.merge!(self._load)
+      end
+
+      # Sets the value of the given +key+ to +val+.
+      def store(key, val)
+        super(key,val)
+        self.save
+      end
+
+      def save
+        File.open("config/help.json","w") do |f|
+          f.write(self.to_json)
+        end
+      end
+    end
+  end
+end

data/lib/kag/help/plugin.rb

@@ -0,0 +1,28 @@
+require 'cinch'
+require 'kag/common'
+require 'commands/help'
+
+module KAG
+  module Help
+    class Plugin
+      include Cinch::Plugin
+      include Cinch::Commands
+      include KAG::Common
+
+      command :help,{},
+        summary: "Get general help on KAG Gather",
+        admin: true
+      def help(m)
+        if m.user.authed?
+          m.user.send(_h("general_help",{
+            :nick => m.user.nick
+          }))
+        else
+          m.user.send(_h("general_not_authed",{
+            :nick => m.user.nick
+          }))
+        end
+      end
+    end
+  end
+end

data/lib/kag/irc/plugin.rb

@@ -23,6 +23,16 @@ module KAG
         end
       end
 
+      command :authed,{},
+        summary: "Tell if you are authed"
+      def authed(m)
+        if m.user.authed?
+          reply m,"#{m.user.nick} is authed."
+        else
+          reply m,"#{m.user.nick} is not yet authed. Please type !help to get help with authenticating."
+        end
+      end
+
       command :authname,{nick: :string},
         summary: "Get the AUTH name of a user",
         admin: true

data/lib/kag/version.rb

@@ -1,5 +1,5 @@
 module KAG
-  VERSION = '1.4.8'
+  VERSION = '1.4.9'
   def self.version
     VERSION
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kag-gather
 version: !ruby/object:Gem::Version
-  version: 1.4.8
+  version: 1.4.9
 platform: ruby
 authors:
 - Shaun McCormick
@@ -131,6 +131,8 @@ files:
 - lib/kag/gather/plugin.rb
 - lib/kag/gather/queue.rb
 - lib/kag/gather/team.rb
+- lib/kag/help/book.rb
+- lib/kag/help/plugin.rb
 - lib/kag/irc/plugin.rb
 - lib/kag/server.rb
 - lib/kag/user/plugin.rb