waylon-core 0.1.1 → 0.1.4

data/lib/waylon/skills/help.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Skills
+    # A Skill for providing help
+    class Help < Skill
+      # Ask for some help.
+      # Defaults to all things a user has access to, but allows specifying either a Skill name or a Skill and Route
+      route(
+        /^help(?<skill_clause>\s+(?<skill>\w+)(?<action_clause>#(?<action>\w+)|\s+(?<action>\w+))?)?$/i,
+        :help,
+        help: {
+          usage: "help [skill [action]]",
+          description: "Allows asking for help, either for all skills or for a particular skill or action"
+        }
+      )
+
+      # Responds to "help" requests
+      def help
+        skill = named_tokens[:skill]
+        action = named_tokens[:action]
+
+        react :book
+
+        immediate_responses = [
+          "I'll send you a DM to go over that with you.",
+          "I'll DM you the details.",
+          "Look for a private message with those details.",
+          "You should have a private message with that information shortly."
+        ]
+
+        # Only send this if you aren't already in a DM
+        threaded_reply "#{acknowledgement} #{immediate_responses.sample}" unless message.private?
+
+        if sense.supports?(:blocks)
+          reply_with_blocks(help_blocks(skill, action), private: true)
+        else
+          reply(help_text(skill, action), private: true)
+        end
+      end
+
+      def help_text(skill = nil, action = nil) # rubocop:disable Metrics/AbcSize
+        allowed_routes = SkillRegistry.instance.help(message.author)
+        resp = []
+        if skill
+          if action
+            resp << "## Help for #{skill}##{action}:"
+            this_route = allowed_routes[skill].find do |r|
+              r[:name].to_s == "#{skill}##{action}"
+            end
+            return "I couldn't find #{action} on #{skill}..." unless this_route
+
+            resp << build_help_text(this_route)
+          else
+            resp << "## Help for #{skill}:\n"
+            routes = allowed_routes[skill]
+            (routes || []).each { |r| resp << build_help_text(r) }
+          end
+        else
+          help_text_for_all(allowed_routes)
+        end
+      end
+
+      def help_blocks(skill = nil, action = nil) # rubocop:disable Metrics/AbcSize
+        allowed_routes = SkillRegistry.instance.help(message.author)
+        if skill
+          if action
+            this_route = allowed_routes[skill].find do |r|
+              r[:name].to_s == "#{skill}##{action}"
+            end
+
+            return not_found_block(skill, action) unless this_route
+
+            [build_header_block(skill, action), build_help_block(this_route)]
+          else
+            routes = allowed_routes[skill]
+            return not_found_block(skill, nil) unless routes
+
+            resp = [build_header_block(skill, nil)]
+            routes.each { |r| resp << build_help_block(r) }
+            resp
+          end
+        else
+          allowed_routes = SkillRegistry.instance.help(message.author)
+          help_blocks_for_all(allowed_routes)
+        end
+      end
+
+      def help_blocks_for_all(routes)
+        resp = [
+          { type: "header", text: { type: "plain_text", text: "All known actions:", emoji: true } }
+        ]
+
+        routes.each do |k, v|
+          resp += [
+            { type: "divider" },
+            {
+              type: "section",
+              text: {
+                type: "mrkdwn",
+                text: "*Actions for '#{k}':*"
+              }
+            }
+          ]
+          v.each { |r| resp << build_help_block(r) }
+        end
+        resp
+      end
+
+      def help_text_for_all(routes)
+        resp = []
+        resp << "*All known actions:*\n"
+        routes.each do |k, v|
+          resp << "* *#{k}*:"
+          v.each do |r|
+            resp << build_help_text(r)
+          end
+          resp << " --- "
+        end
+        resp.join("\n")
+      end
+
+      def build_header_block(skill, action)
+        text = if action
+                 "Help for #{skill}##{action}:"
+               else
+                 "Help for #{skill}:"
+               end
+        { type: "header", text: { type: "plain_text", text: text, emoji: true } }
+      end
+
+      def build_help_block(this_route)
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "  *#{this_route[:name]}*\n#{build_help_text(this_route)}"
+          }
+        }
+      end
+
+      def build_help_text(this_route)
+        route_help_text = []
+        case this_route[:help]
+        when String
+          route_help_text << "    *Usage:* #{this_route[:help]}"
+        when Hash
+          route_help_text << "    *Usage:* #{this_route.dig(:help, :usage)}"
+          if this_route.dig(:help, :description)
+            route_help_text << "\n    *Description:* #{this_route.dig(:help, :description)}"
+          end
+        end
+        route_help_text.join
+      end
+
+      def not_found_block(skill, action)
+        sentence = if action
+                     "I couldn't find any '#{action}' action on the '#{skill}' skill..."
+                   else
+                     "I couldn't find any routes related to a '#{skill}' skill..."
+                   end
+        [
+          {
+            type: "section",
+            text: {
+              type: "mrkdwn",
+              text: sentence
+            }
+          }
+        ]
+      end
+    end
+  end
+end

data/lib/waylon/user.rb

@@ -18,6 +18,11 @@ module Waylon
         raise NotImplementedError, "find_by_handle isn't implemented"
       end
 
+      # This should be overridden by subclasses to provide a mechanism for looking up Users based on mention strings
+      def from_mention(_mention_string)
+        raise NotImplementedError, "from_mention isn't implemented"
+      end
+
       # Provides a simple mechanism for referencing User subclass's Sense
       # @return [Class] A Sense subclass
       def sense

data/lib/waylon/version.rb

@@ -6,7 +6,7 @@ module Waylon
     VERSION = [
       0, # Major
       1, # Minor
-      1  # Patch
+      4  # Patch
     ].join(".")
   end
 end

data/lib/waylon/webhook.rb

@@ -21,7 +21,7 @@ module Waylon
     # @return [Class] The name of the corresponding Sense class
     def sense_class
       last = self.class.name.split("::").last
-      Module.const_get("Senses::#{last}")
+      Module.const_get("Waylon::Senses::#{last}")
     end
 
     # This must be implemented on every Webhook to provide a mechanism to ensure received payloads are legit
@@ -38,36 +38,35 @@ module Waylon
     end
 
     before do
-      content_type "application/json"
-
-      begin
-        unless request.get? || request.options?
-          request.body.rewind
-          @parsed_body = JSON.parse(request.body.read, symbolize_names: true)
-        end
-      rescue StandardError => e
-        halt(400, { error: "Request must be JSON: #{e.message}" }.to_json)
+      unless request.get? || request.options?
+        request.body.rewind
+        @parsed_body = JSON.parse(request.body.read, symbolize_names: true)
       end
+    rescue StandardError => e
+      content_type "application/json"
+      halt(400, { error: "Request must be JSON: #{e.message}" }.to_json)
     end
 
     after do
       request.options? && headers("Access-Control-Allow-Methods" => @allowed_types || %w[OPTIONS POST])
     end
 
-    post "/" do
-      begin
-        request.body.rewind
-        verify request.body.read, request.env
-        enqueue @parsed_body
-      rescue StandardError => e
-        halt(422, { error: "Unprocessable entity: #{e.message}" }.to_json)
-      end
-
-      { status: :ok }.to_json
-    end
-
-    options "/" do
-      halt 200
-    end
+    ## Example incoming webhook
+    #
+    # post "/" do
+    #   begin
+    #     request.body.rewind
+    #     verify request.body.read, request.env
+    #     enqueue @parsed_body
+    #   rescue StandardError => e
+    #     halt(422, { error: "Unprocessable entity: #{e.message}" }.to_json)
+    #   end
+    #
+    #   { status: :ok }.to_json
+    # end
+    #
+    # options "/" do
+    #   halt 200
+    # end
   end
 end

data/lib/waylon/webhook_registry.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Waylon
+  # Registry of Webhook subclasses known to Waylon
+  class WebhookRegistry
+    include Singleton
+
+    attr_reader :webhooks
+
+    # A convenience wrapper around the singleton instance #register method
+    # @param (see #register)
+    # @return (see #register)
+    def self.register(name, class_name)
+      instance.register(name, class_name)
+    end
+
+    # Add the provided Webhook class to the registry under `name`
+    # @param name [String] The name of the Webhook in the registry
+    # @param class_name [Class] The Webhook subclass to add
+    # @return [Class] The Webhook subclass
+    def register(name, class_name)
+      @webhooks ||= {}
+      @webhooks[name.to_s] = class_name
+    end
+
+    # Provides a Hash version of this registry
+    # @return [Hash]
+    def to_hash
+      (@webhooks || {}).transform_keys { |k| "/hooks/#{k}" }
+    end
+  end
+end

data/lib/waylon.rb

@@ -2,4 +2,7 @@
 
 require "waylon/core"
 require "waylon/skills/default"
+require "waylon/skills/diagnostics"
 require "waylon/skills/fun"
+require "waylon/skills/groups"
+require "waylon/skills/help"

data/scripts/release.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+gem install bundler -v '~> 2.3'
+bundle install
+rm -rf pkg/*.gem
+bundle exec rake build
+bundle exec gem push pkg/*.gem

data/scripts/test.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
 
-gem install bundler -v '~> 2.2'
+gem install bundler -v '~> 2.3'
 bundle install
 bundle exec rake

data/waylon-core.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "puma", "~> 5.5"
   spec.add_dependency "resque", "~> 2.2"
 
-  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rubocop", "~> 1.23"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waylon-core
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Jonathan Gnagy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -249,6 +249,7 @@ files:
 - lib/waylon.rb
 - lib/waylon/base_component.rb
 - lib/waylon/condition.rb
+- lib/waylon/conditions/black_hole.rb
 - lib/waylon/conditions/default.rb
 - lib/waylon/conditions/permission_denied.rb
 - lib/waylon/conditions/regex.rb
@@ -261,6 +262,7 @@ files:
 - lib/waylon/logger.rb
 - lib/waylon/message.rb
 - lib/waylon/route.rb
+- lib/waylon/routes/black_hole.rb
 - lib/waylon/routes/default.rb
 - lib/waylon/routes/permission_denied.rb
 - lib/waylon/rspec.rb
@@ -274,13 +276,19 @@ files:
 - lib/waylon/rspec/test_worker.rb
 - lib/waylon/sense.rb
 - lib/waylon/sense_registry.rb
+- lib/waylon/services/ping.rb
 - lib/waylon/skill.rb
 - lib/waylon/skill_registry.rb
 - lib/waylon/skills/default.rb
+- lib/waylon/skills/diagnostics.rb
 - lib/waylon/skills/fun.rb
+- lib/waylon/skills/groups.rb
+- lib/waylon/skills/help.rb
 - lib/waylon/user.rb
 - lib/waylon/version.rb
 - lib/waylon/webhook.rb
+- lib/waylon/webhook_registry.rb
+- scripts/release.sh
 - scripts/test.sh
 - waylon-core.gemspec
 homepage: https://github.com/jgnagy/waylon-core
@@ -290,7 +298,7 @@ metadata:
   homepage_uri: https://github.com/jgnagy/waylon-core
   source_code_uri: https://github.com/jgnagy/waylon-core
   changelog_uri: https://github.com/jgnagy/waylon-core/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -305,8 +313,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Core library for the Waylon bot framework
 test_files: []