waylon-core 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0381c0f70f922e5958355430bef0ec1c8fd5d966b77b032f866fa9ecdcd3dd18'
-  data.tar.gz: 13b63cef7b5e7575b5d564d43cb599bd326e0b9ed499be5df1b08a1c191fc073
+  metadata.gz: bf4a171a8420b5e982d54cf24b991a7ae667f3aa93f08b361d10ac28d9726207
+  data.tar.gz: 63982b47f1c05134c4fa5c69d07c4e05e8a1d748c245a4d7bd0695dabe4171c5
 SHA512:
-  metadata.gz: bf835c89b14aa09e591fd8ca11b7c27065d0ad8262c2248ca261d897f320c0c5128d15154454407c32d35021dead332bcfb0597507e337dd7ee9de186bea2f1f
-  data.tar.gz: 2eb7a29a02dcc44c85ed8dd0c74999299dae4ed1bb2736d6d076e9c1885ea80b96ffdc71288f730fe68de5c2487e23183d6adf0239f23112bec2cf9cf2e006ed
+  metadata.gz: 17a2baf807fd68312c76da6d9d1ca328ed5e5fec065711a7b8ce14a7d86850843d3ce2f6cfa3d4ea26f3c3ce30f329796427deeb98dcd6df77ec181da0afaf3f
+  data.tar.gz: 3edb93a7e82655d44d553687493d11a0a7559b6ae318ffb92051d481872c882baa2c6191a88e96ddd3936df278844e1caee97837f15523fd2158275d0a84eb03

data/.rubocop.yml

@@ -21,7 +21,10 @@ Gemspec/RequireMFA:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 19
+  Max: 19.5
+
+Metrics/ClassLength:
+  Max: 200
 
 Metrics/CyclomaticComplexity:
   Max: 9
@@ -32,7 +35,11 @@ Metrics/PerceivedComplexity:
 Metrics/MethodLength:
   Max: 20
 
+Metrics/ParameterLists:
+  Max: 6
+
 Metrics/BlockLength:
   Exclude:
   - "**/*_spec.rb"
   - "*.gemspec"
+  - "lib/waylon/rspec/matchers/**/*.rb"

data/.ruby-version

@@ -1 +1 @@
-3.0.3
+3.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waylon-core (0.1.1)
+    waylon-core (0.1.2)
       addressable (~> 2.8)
       faraday (~> 1.8)
       i18n (~> 1.8)
@@ -17,7 +17,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
     faraday (1.9.3)
       faraday-em_http (~> 1.0)
@@ -53,7 +53,7 @@ GEM
       ruby2_keywords (~> 0.0.1)
     nio4r (2.5.8)
     parallel (1.21.0)
-    parser (3.0.3.2)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     puma (5.5.2)
@@ -87,20 +87,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.23.0)
+    rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.6.0)
+    rubocop-rspec (2.7.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -127,7 +127,7 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
-  bundler (~> 2.2)
+  bundler (~> 2.3)
   rake (~> 13.0)
   rspec (~> 3.10)
   rubocop (~> 1.23)
@@ -138,4 +138,4 @@ DEPENDENCIES
   yard (~> 0.9, >= 0.9.27)
 
 BUNDLED WITH
-   2.2.32
+   2.3.4

data/lib/waylon/condition.rb

@@ -10,19 +10,37 @@ module Waylon
     # @param action [Symbol] The method to call if the condition matches
     # @param allowed_groups [Array<Symbol>] The group names allowed to use this action
     # @param help [String] Optional help text to describe usage for this action
-    def initialize(mechanism, action, allowed_groups, help = nil)
+    # @param mention_only [Boolean] Only applies to messages that directly mention (or IM) this bot
+    # rubocop:disable Style/OptionalBooleanParameter
+    def initialize(mechanism, action, allowed_groups, help = nil, mention_only = true)
       @mechanism = mechanism
       @action = action
       @allowed_groups = allowed_groups
       @help = help
+      @mention_only = mention_only
     end
+    # rubocop:enable Style/OptionalBooleanParameter
 
     # Placeholder for determining if this condition applies to the given input
     # @param _input [Waylon::Message] The input message
+    # @return [Boolean]
     def matches?(_input)
       false
     end
 
+    # Is this condition only valid for Messages that directly mention the bot?
+    # @return [Boolean]
+    def mention_only?
+      @mention_only
+    end
+
+    # Placeholder for optionally providing _named_ tokens
+    # @param _input [String] The message content
+    # @return [Hash<String,Object>]
+    def named_tokens(_input)
+      {}
+    end
+
     # Checks if a user is allowed based on this condition
     # @param user [Waylon::User] abstract user
     def permits?(user)
@@ -44,6 +62,13 @@ module Waylon
       permitted
     end
 
+    # Determines of a message complies with the {#mention_only?} setting for this condition
+    # @param message [Waylon::Message] The received message
+    # @return [Boolean]
+    def properly_mentions?(message)
+      (mention_only? && message.to_bot?) || (!mention_only? && !message.to_bot?)
+    end
+
     # Tokens is used to provide details about the message input to the action
     # @param _input [String] The message content as text
     # @return [Array<String>] The tokens extracted from the input message

data/lib/waylon/conditions/black_hole.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Conditions
+    # A pre-made catch-all condition for ignoring messages
+    class BlackHole < Condition
+      # Overrides normal Condition initialization to force a specific action
+      def initialize(*_args) # rubocop:disable Lint/MissingSuper
+        @mechanism = nil
+        @action = :ignore
+        @allowed_groups = [:everyone]
+        @help = ""
+      end
+
+      # Matches any input (since the Default route, when used, should always function)
+      # @return [Boolean]
+      def matches?(_input)
+        true
+      end
+
+      # Permits any user (since the Default route, when used, should always function)
+      # @return [Boolean]
+      def permits?(_user)
+        true
+      end
+
+      # Just provides back all input as a single token
+      # @return [Array<String>]
+      def tokens(input)
+        [input]
+      end
+    end
+  end
+end

data/lib/waylon/conditions/regex.rb

@@ -17,6 +17,11 @@ module Waylon
       def tokens(input)
         @mechanism.match(input).to_a[1..]
       end
+
+      def named_tokens(input)
+        match_data = @mechanism.match(input)
+        match_data.names.to_h { |n| [n.to_sym, match_data[n]] }
+      end
     end
   end
 end

data/lib/waylon/config.rb

@@ -23,7 +23,7 @@ module Waylon
       true
     end
 
-    # A list of emails specified via the CONF_GLOBAL_ADMINS environment variable
+    # A list of emails specified via the GLOBAL_ADMINS environment variable
     # @return [Array<String>] a list of emails
     def admins
       admin_emails = self["global.admins"]
@@ -32,11 +32,12 @@ module Waylon
 
     # Load in the config from env variables
     # @return [Boolean] Was the configuration loaded?
-    def load_env
+    def load_env # rubocop:disable Metrics/AbcSize
       @schema ||= {}
       self["global.log.level"] = ENV.fetch("LOG_LEVEL", "info")
       self["global.redis.host"] = ENV.fetch("REDIS_HOST", "redis")
       self["global.redis.port"] = ENV.fetch("REDIS_PORT", "6379")
+      self["global.admins"] = ENV.fetch("GLOBAL_ADMINS", "")
       ENV.keys.grep(/CONF_/).each do |env_key|
         conf_key = env_key.downcase.split("_")[1..].join(".")
         ::Waylon::Logger.log("Attempting to set #{conf_key} from #{env_key}", :debug)

data/lib/waylon/core.rb

@@ -2,6 +2,7 @@
 
 # Standard Library dependencies
 require "base64"
+require "benchmark"
 require "digest"
 require "English"
 require "fileutils"
@@ -21,6 +22,7 @@ require "i18n"
 require "json"
 require "moneta"
 require "resque"
+require "sinatra"
 
 # Internal requirements
 require "waylon/version"
@@ -39,8 +41,11 @@ require "waylon/sense"
 require "waylon/skill_registry"
 require "waylon/skill"
 require "waylon/user"
+require "waylon/conditions/black_hole"
 require "waylon/conditions/default"
 require "waylon/conditions/permission_denied"
 require "waylon/conditions/regex"
+require "waylon/routes/black_hole"
 require "waylon/routes/default"
 require "waylon/routes/permission_denied"
+require "waylon/webhook"

data/lib/waylon/group.rb

@@ -30,7 +30,7 @@ module Waylon
       return false unless include?(user)
 
       users = members
-      users.delete(user)
+      users.delete(user.email.downcase)
       storage.store(key, users)
       true
     end

data/lib/waylon/logger.rb

@@ -6,7 +6,7 @@ module Waylon
     # The log level as defined in the global Config singleton
     # @return [String] The current log level
     def self.level
-      Config.instance["global.log.level"]
+      Config.instance["global.log.level"] || "info"
     end
 
     # Abstraction for sending logs to the logger at some level

data/lib/waylon/message.rb

@@ -9,9 +9,28 @@ module Waylon
       nil
     end
 
+    # Message body
+    def body
+      nil
+    end
+
     # Message channel (meant to be overwritten by mixing classes)
     def channel
       nil
     end
+
+    # Does the Message mention the bot (meant to be overwritten by mixing classes)
+    def mentions_bot?
+      nil
+    end
+
+    # Is the Message a private/direct Message?
+    def private?
+      false
+    end
+
+    def to_bot?
+      true
+    end
   end
 end

data/lib/waylon/route.rb

@@ -23,7 +23,7 @@ module Waylon
       @priority = priority
     end
 
-    delegate %i[action help matches? permits? tokens] => :@condition
+    delegate %i[action help matches? mention_only? named_tokens permits? properly_mentions? tokens] => :@condition
 
     private
 

data/lib/waylon/routes/black_hole.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Routes
+    # The route for unroutable events
+    class BlackHole < Route
+      def initialize(
+        name: "black_hole",
+        destination: Skills::Default,
+        condition: Conditions::BlackHole.new,
+        priority: 0
+      )
+        super
+      end
+    end
+  end
+end

data/lib/waylon/rspec/matchers/route_matcher.rb

@@ -36,6 +36,13 @@ module Waylon
           chain :to do |method_name|
             @method_name = method_name
           end
+
+          description do
+            result = "route \"#{expected}\""
+            result += " to action \"#{@method_name}\"" if @method_name
+            result += " while a member of \"#{@group}\"" if @group
+            result
+          end
         end
       end
     end

data/lib/waylon/rspec/skill.rb

@@ -63,7 +63,7 @@ module Waylon
           msg_details[:channel_id] = channel ? channel.id : chatroom.id
         end
 
-        TestSense.process(msg_details)
+        TestSense.perform(msg_details)
         TestWorker.handle(TestSense.fake_queue)
       end
     end

data/lib/waylon/rspec/test_message.rb

@@ -51,6 +51,8 @@ module Waylon
         details[:text]
       end
 
+      alias body text
+
       # Lazily provides the details for TestMessages
       # @api private
       # @return [Hash] The details for this TestMessage instance

data/lib/waylon/rspec/test_sense.rb

@@ -22,14 +22,14 @@ module Waylon
       end
 
       # Overrides the Sense.enqueue class method to avoid Resque
-      def self.enqueue(route, request_id, body)
+      def self.enqueue(route, request)
         details = {
           "sense" => self,
-          "message" => request_id,
-          "tokens" => route.tokens(body.strip)
+          "request" => request,
+          "route" => route.name
         }
 
-        fake_queue.push [route.destination, route.action, details]
+        fake_queue.push [route.destination, details]
       end
 
       # Allows access to the fake version of Resque
@@ -50,15 +50,10 @@ module Waylon
         @message_list ||= []
       end
 
-      # Receives incoming message details and places work on a queue to be performed by a Skill
-      # @param message_details [Hash] The details necessary for creating a TestMessage
-      # @return [void]
-      def self.process(message_details)
-        message_list << message_details
-        message_id = message_list.size - 1
-        msg = message_class.new(message_id)
-        route = SkillRegistry.instance.route(msg) || SkillRegistry.instance.default_route
-        enqueue(route, msg.id, msg.text)
+      # Provides a way to use an initial request to reconstitute a Sense-specific Message
+      # @return [Waylon::Message]
+      def self.message_from_request(request)
+        message_class.new(message_list.size - 1, request)
       end
 
       # Emulates reactions by sending a message with the reaction type
@@ -66,7 +61,7 @@ module Waylon
       # @param type [Symbol,String] The type of reaction to send
       # @return [void]
       def self.react(request, type)
-        msg = message_class.new(request)
+        msg = message_from_request(request)
         msg.channel.post_message(":#{type}:")
       end
 
@@ -81,10 +76,21 @@ module Waylon
       # @param text [String] The message content to send in response to the request
       # @return [void]
       def self.reply(request, text)
-        msg = message_class.new(request)
+        msg = message_from_request(request)
         msg.channel.post_message(text)
       end
 
+      # Receives incoming message details and places work on a queue to be performed by a Skill
+      # @param message_details [Hash] The details necessary for creating a TestMessage
+      # @return [void]
+      def self.run(message_details)
+        message_list << message_details
+        message_id = message_list.size - 1
+        msg = message_class.new(message_id)
+        route = SkillRegistry.route(msg) || SkillRegistry.instance.default_route(msg)
+        enqueue(route, message_details)
+      end
+
       # Provides all message text sent _by_ Waylon
       # @return [Array<String>]
       def self.sent_messages

data/lib/waylon/rspec/test_worker.rb

@@ -7,8 +7,8 @@ module Waylon
       # Instructs the worker to grab an item off the Queue and run it
       # @param queue [Queue] The queue that contains work to be done
       def self.handle(queue)
-        skill, action, details = queue.pop
-        skill.perform(action, details)
+        skill, details = queue.pop
+        skill.perform(details)
       end
     end
   end

data/lib/waylon/sense.rb

@@ -20,17 +20,16 @@ module Waylon
 
     # The connection between Senses and Skills happens here, via a Route and a Hash of details
     # @param route [Route] route The matching Route from the SkillRegistry
-    # @param request_id [String] The ID (from the messaging platform) of the request
-    # @param body [String] Message content for the Skill
+    # @param request [String] The request message (or its ID) from the messaging platform
     # @api private
-    def self.enqueue(route, request_id, body)
+    def self.enqueue(route, request)
       details = {
         "sense" => self,
-        "message" => request_id,
-        "tokens" => route.tokens(body.strip)
+        "request" => request,
+        "route" => route.name
       }
 
-      Resque.enqueue route.destination, route.action, details
+      Resque.enqueue route.destination, details
     end
 
     # Provides a simple mechanism for referencing the Group subclass provided by this Sense

data/lib/waylon/sense_registry.rb

@@ -5,6 +5,8 @@ module Waylon
   class SenseRegistry
     include Singleton
 
+    attr_reader :senses
+
     # A convenience wrapper around the singleton instance #register method
     # @param (see #register)
     # @return (see #register)

data/lib/waylon/skill.rb

@@ -5,7 +5,7 @@ module Waylon
   class Skill
     include BaseComponent
 
-    attr_reader :sense, :tokens, :request
+    attr_reader :sense, :tokens, :request, :route
 
     # Config namespace for config keys
     # @return [String] The namespace for config keys
@@ -14,32 +14,31 @@ module Waylon
     end
 
     # Resque uses this to execute the Skill. Just defers to the `action` subclass method
-    # @param action [Symbol,String] The method on the Skill subclass to call
     # @param details [Hash] Input details about the message for running a Skill action
-    def self.perform(action, details)
-      new(details["sense"], details["tokens"], details["message"], details["meta"])
-        .send(action.to_sym)
+    def self.perform(details)
+      skill = new(details["sense"], details["route"], details["request"], details["meta"])
+      skill.send(skill.route.action.to_sym)
     end
 
     # Redis/Resque queue name
     # @api private
     # @return [Symbol]
     def self.queue
-      :senses
+      :skills
     end
 
     # Adds skills to the SkillRegistry
     # @param condition [Condition,Regexp] The condition that determines if this route applies
     # @param action [Symbol,String] The method on the Skill subclass to call
     # @param allowed_groups [Symbol,Array<Symbol>] The group or list of groups allowed to use this
-    # @param help [String] A description of how to use the skill
-    def self.route(condition, action, allowed_groups: :everyone, help: nil, name: nil)
+    # @param help [String,Hash] A description of how to use the skill
+    def self.route(condition, action, allowed_groups: :everyone, help: nil, name: nil, mention_only: true)
       name ||= "#{to_s.split("::").last.downcase}##{action}"
       real_cond = case condition
                   when Condition
                     condition
                   when Regexp
-                    Conditions::Regex.new(condition, action, allowed_groups, help)
+                    Conditions::Regex.new(condition, action, allowed_groups, help, mention_only)
                   else
                     log("Unknown condition for route for #{name}##{action}", :warn)
                     nil
@@ -48,13 +47,13 @@ module Waylon
     end
 
     # @param sense [Class,String] Class (or Class name) of the source Sense
-    # @param tokens [Array<String>] Tokenized message content for use in the Skill
-    # @param request [String,Integer] Reference to the request from the Sense provider (usually an ID)
+    # @param request [String,Integer] Reference to the request from the Sense provider (usually ID or message itself)
     # @param meta [Hash] Optional meta data that can be passed along from a Sense for use in Skills
-    def initialize(sense, tokens, request, meta)
+    def initialize(sense, route, request, meta)
       @sense   = sense.is_a?(Class) ? sense : Module.const_get(sense)
-      @tokens  = tokens || []
+      @route   = SkillRegistry.find_by_name(route)
       @request = request
+      @tokens  = @route.tokens(message.body) || []
       @meta    = meta
     end
 
@@ -62,7 +61,6 @@ module Waylon
     # @return [String]
     def acknowledgement
       responses = [
-        "I'll get back to you in just a sec.",
         "You got it!",
         "As you wish.",
         "Certainly!",
@@ -73,11 +71,10 @@ module Waylon
         "Of course!",
         "I'd be delighted!",
         "Right away!",
-        "Gladly",
+        "Gladly!",
         "All right.",
         "I'm all over it.",
         "I'm on it!",
-        "Let me see what I can do.",
         "Will do!"
       ]
       responses.sample
@@ -97,7 +94,8 @@ module Waylon
         sense: @sense,
         message: @request,
         tokens: @tokens,
-        meta: @meta
+        meta: @meta,
+        route: route.name
       }
     end
 
@@ -111,7 +109,11 @@ module Waylon
     # Provides a wrapped message for responding to the received Sense
     # @return [Waylon::Message]
     def message
-      sense.message_class.new(request)
+      sense.message_from_request(request)
+    end
+
+    def named_tokens
+      @named_tokens ||= @route.named_tokens(message.body) || {}
     end
 
     # Defers to the Sense to react to a message
@@ -124,9 +126,40 @@ module Waylon
     end
 
     # Defers to the Sense to determine how to reply to a message
-    # @param [String] text The reply text
-    def reply(text)
-      sense.reply(request, text)
+    # @param text [String] The reply text
+    def reply(text, private: false)
+      if private && sense.supports?(:private_messages)
+        sense.private_reply(request, text)
+      else
+        log("Unable to send private message for Sense #{sense.name}, replying instead", :debug) if private
+        sense.reply(request, text)
+      end
+    end
+
+    # Defers to the Sense to determine how to reply to a message with rich content
+    # @param blocks [String] The reply blocks
+    def reply_with_blocks(blocks, private: false)
+      unless sense.supports?(:blocks)
+        log("Unable to use blocks with Sense #{sense.name}")
+        return false
+      end
+      if private
+        sense.private_reply_with_blocks(request, blocks)
+      else
+        log("Unable to send private message for Sense #{sense.name}, replying instead", :debug) if private
+        sense.reply_with_blocks(request, blocks)
+      end
+    end
+
+    # Defers to the Sense to do threaded replies if it can, otherwise it falls back to normal replies
+    # @param text [String] The reply text
+    def threaded_reply(text)
+      if sense.supports?(:threads)
+        sense.threaded_reply(request, text)
+      else
+        log("Unable to reply in theads for Sense #{sense.name}, replying instead", :debug)
+        sense.reply(request, text)
+      end
     end
   end
 end