lita-discord_oauth 0.1.2.alpha.51 → 0.1.2.alpha.52

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93042e81bb196d3eef785859717aeefe1b33824c
-  data.tar.gz: aeb1ce23ee900334b0084fdb11ec21bba1d06905
+  metadata.gz: 7f951a4406d047cccaf7fb9ae7591e0ed972fc6d
+  data.tar.gz: 681388281dca1c5a79ec6eb617aed9818d41a130
 SHA512:
-  metadata.gz: 571d240338b8d761d9bea62879f60c05e6b1a4b37231a7da291f9d4fa981faccdce18748ecf4746d5cdd60c3f915f1fc4f9c8aefd0f7386ca3e372fdf342e6c2
-  data.tar.gz: cf2597d8b0aeaf19c1effc18f9e0956a1b2b746da4f514d428ee226f4e9a6329b35e0086943188309903599b74746fc560d81c0e65f2be441be6c3950bccb34b
+  metadata.gz: 582348fc7c29b70bd096cab81fc45536405c42d71bf4c64f414e7ea580458dde1ab92160f440d68a4ca9d15ed8adb4ee98313bc18031f34d1a5c3d8d5cd8a67c
+  data.tar.gz: 7a8d990c6a9b053e53d28a5c04ca97f51f9c9ff11324e198a3072f72343f5e55b721185f60c25ae8d85ced9cc1be3d47d7d01cba1dc62ddcfa889be5017ac235

data/lib/lita/handlers/discord_help.rb

@@ -0,0 +1,99 @@
+module Lita
+  # A namespace to hold all subclasses of {Handler}.
+  module Handlers
+    # Provides online help about Lita commands for users.
+    class DiscordHelp < Handler
+      route(/^help\s*(.+)?/, :help, command: true, help: {
+          "help" => t("help.help_value"),
+          t("help.help_command_key") => t("help.help_command_value")
+      })
+
+      # Outputs help information about Lita commands.
+      # @param response [Lita::Response] The response object.
+      # @return [void]
+      def help(response)
+        output = build_help(response)
+        output = filter_help(output, response)
+        response.reply_privately output.join("\n")
+      end
+
+      private
+
+      def table_row(key, value)
+        key_width = 25
+        value_width = 112
+
+        key_text = key.ljust(key_width, ' ')
+
+        value_words = value.split(' ')
+
+        value_text = ''
+        value_line = ''.ljust(key_width + 1, ' ')
+        value_words.each do |word|
+          new_value_line = "#{value_line} #{word}"
+
+          if new_value_line.length > value_width
+            value_text += "#{value_line}\n" + ''.ljust(key_width + 1, ' ')
+            value_line = word
+          else
+            value_line = "#{value_line} #{word}"
+          end
+
+        end
+
+        if value_line.length > 0
+          value_text = "#{value_text}\n" + ''.ljust(key_width + 1, ' ') + "#{value_line}"
+        end
+
+        key_text + value_text
+      end
+
+      # Checks if the user is authorized to at least one of the given groups.
+      def authorized?(user, required_groups)
+        required_groups.nil? || required_groups.any? do |group|
+          robot.auth.user_in_group?(user, group)
+        end
+      end
+
+      # Creates an array of help info for all registered routes.
+      def build_help(response)
+        robot.handlers.map do |handler|
+          next unless handler.respond_to?(:routes)
+
+          handler.routes.map do |route|
+            route.help.map do |command, description|
+              if authorized?(response.user, route.required_groups)
+                help_command(route, command, description)
+              end
+            end
+          end
+        end.flatten.compact
+      end
+
+      # Filters the help output by an optional command.
+      def filter_help(output, response)
+        filter = response.matches[0][0]
+
+        if filter
+          output.select { |line| /(?:@?#{name}[:,]?)?#{filter}/i === line }
+        else
+          output
+        end
+      end
+
+      # Formats an individual command's help message.
+      def help_command(route, command, description)
+        command = "#{name}: #{command}" if route.command?
+
+        table_row(command, description)
+      end
+
+      # The way the bot should be addressed in order to trigger a command.
+      def name
+        robot.config.robot.mention_name || robot.config.robot.name
+      end
+    end
+
+    Lita.register_handler(DiscordHelp)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-discord_oauth
 version: !ruby/object:Gem::Version
-  version: 0.1.2.alpha.51
+  version: 0.1.2.alpha.52
 platform: ruby
 authors:
 - Cas Eliëns
@@ -123,6 +123,7 @@ files:
 - Rakefile
 - lib/lita-discord_oauth.rb
 - lib/lita/adapters/discord_oauth.rb
+- lib/lita/handlers/discord_help.rb
 - lita-discord_oauth.gemspec
 - locales/en.yml
 - spec/lita/adapters/discord_oauth_spec.rb