waylon-core 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0381c0f70f922e5958355430bef0ec1c8fd5d966b77b032f866fa9ecdcd3dd18'
-  data.tar.gz: 13b63cef7b5e7575b5d564d43cb599bd326e0b9ed499be5df1b08a1c191fc073
+  metadata.gz: bb29b523a0f093d01b8a9abdf5cd23d54b2815ae0430b81f8e670680959d02f6
+  data.tar.gz: 4c79ff418934e61e9063db9568d2397409117afd2a7519d9b4c9348233991667
 SHA512:
-  metadata.gz: bf835c89b14aa09e591fd8ca11b7c27065d0ad8262c2248ca261d897f320c0c5128d15154454407c32d35021dead332bcfb0597507e337dd7ee9de186bea2f1f
-  data.tar.gz: 2eb7a29a02dcc44c85ed8dd0c74999299dae4ed1bb2736d6d076e9c1885ea80b96ffdc71288f730fe68de5c2487e23183d6adf0239f23112bec2cf9cf2e006ed
+  metadata.gz: 505ad2082ae04e37478e03637b13952d81d8c26c9e8107eeded3b4247ae25f776f7d1d7d4a4fd0739edd670ba74256e33adbd22c6f46957f528c820ef371bfce
+  data.tar.gz: a9c1b1de874c75d7d909a83904e46360236334f652dae8ad059d5adf8b405315030245420dba3a8e159b21d99d221a502d30cfe439f2b2b77411ff06261af695

data/.roxanne.yml

@@ -1,4 +1,8 @@
 version: 1.0
 stages:
   test:
-    image: ruby:3.0
+    image: ruby:3.1
+  release:
+    image: ruby:3.1
+    only:
+    - main

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.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waylon-core (0.1.1)
+    waylon-core (0.1.4)
       addressable (~> 2.8)
       faraday (~> 1.8)
       i18n (~> 1.8)
@@ -16,10 +16,10 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (1.9.3)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -35,72 +35,71 @@ GEM
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.2)
+    faraday-multipart (1.0.3)
       multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.1)
-    moneta (1.4.2)
+    json (2.6.2)
+    moneta (1.5.1)
     mono_logger (1.1.1)
     multi_json (1.15.0)
     multipart-post (2.1.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.5.8)
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    puma (5.5.2)
+    public_suffix (4.0.7)
+    puma (5.6.4)
       nio4r (~> 2.0)
     rack (2.2.3)
-    rack-protection (2.1.0)
+    rack-protection (2.2.0)
       rack
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    redis (4.5.1)
-    redis-namespace (1.8.1)
+    redis (4.6.0)
+    redis-namespace (1.8.2)
       redis (>= 3.0.4)
-    regexp_parser (2.2.0)
-    resque (2.2.0)
+    regexp_parser (2.4.0)
+    resque (2.2.1)
       mono_logger (~> 1.0)
       multi_json (~> 1.0)
       redis-namespace (~> 1.6)
       sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.23.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.6.0)
+    rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -109,25 +108,24 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    sinatra (2.1.0)
+    simplecov_json_formatter (0.1.4)
+    sinatra (2.2.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.0)
       tilt (~> 2.0)
     tilt (2.0.10)
     unicode-display_width (2.1.0)
-    vegas (0.1.11)
-      rack (>= 1.0.0)
     webrick (1.7.0)
     yard (0.9.27)
       webrick (~> 1.7.0)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.2)
+  bundler (~> 2.3)
   rake (~> 13.0)
   rspec (~> 3.10)
   rubocop (~> 1.23)
@@ -138,4 +136,4 @@ DEPENDENCIES
   yard (~> 0.9, >= 0.9.27)
 
 BUNDLED WITH
-   2.2.32
+   2.3.10

data/README.md

@@ -44,7 +44,7 @@ Alone, this library isn't super useful for running a bot, but it does include a
 
 ## Development
 
-Waylon's development pipeline makes heavy use of [RSpec](https://rspec.info/) for testing (and [SimpleCov](https://github.com/simplecov-ruby/simplecov) for reporting on coverage), [Rubocop](https://rubocop.org/) for linting/format checking, [YARD](https://yardoc.org/) for documentation, and [Travis CI](https://www.travis-ci.com/) for CI. Most of this is built-in and will work out-of-the-box for GitHub PRs.
+Waylon's development pipeline makes heavy use of [RSpec](https://rspec.info/) for testing (and [SimpleCov](https://github.com/simplecov-ruby/simplecov) for reporting on coverage), [Rubocop](https://rubocop.org/) for linting/format checking, [YARD](https://yardoc.org/) for documentation, and [RoxanneCI](https://github.com/apps/roxanneci) for CI. Most of this is built-in and will work out-of-the-box for GitHub PRs.
 
 To get started locally, after checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests and linting. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

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,16 @@ 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)
+      return true unless mention_only?
+
+      message.to_bot?
+      # (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,14 @@ module Waylon
       def tokens(input)
         @mechanism.match(input).to_a[1..]
       end
+
+      # Provides the _named_ regular expression match groups as a hash
+      # @param input [String] The message text
+      # @return [Hash<Symbol,String>] The named regular expression match groups
+      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,15 +32,16 @@ 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)
-        self[conf_key] = ENV[env_key]
+        self[conf_key] = ENV.fetch(env_key, nil)
       end
       true
     end

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,12 @@ 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"
+require "waylon/webhook_registry"

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
@@ -19,12 +19,18 @@ module Waylon
     # Provides an easy way to access the underlying logger
     # @return [Logger] The Logger instance
     def self.logger
-      return @logger if @logger
+      @logger ||= json_logger
+    end
+
+    def self.logger=(logger)
+      @logger = logger
+    end
 
-      @logger = ::Logger.new($stderr)
-      @logger.level = level
-      @logger.progname = "Waylon"
-      @logger.formatter = proc do |severity, datetime, progname, msg|
+    def self.json_logger
+      a_logger = ::Logger.new($stderr)
+      a_logger.level = level
+      a_logger.progname = "Waylon"
+      a_logger.formatter = proc do |severity, datetime, progname, msg|
         json_data = JSON.dump(
           ts: datetime,
           severity: severity.ljust(5).to_s,
@@ -35,7 +41,8 @@ module Waylon
         )
         "#{json_data}\n"
       end
-      @logger
+
+      a_logger
     end
   end
 end

data/lib/waylon/message.rb

@@ -9,9 +9,29 @@ 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?
+      # private? || mentions_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_server.rb

@@ -41,7 +41,10 @@ end
 Waylon::RSpec::TestChannel.find_or_create("random")
 
 # Load demo skills here
+require "waylon/skills/diagnostics"
 require "waylon/skills/fun"
+require "waylon/skills/groups"
+require "waylon/skills/help"
 
 # Handle demo chat REPL
 def adminuser
@@ -101,7 +104,7 @@ def handle_input(body, from: this_user, privately: true)
   else
     message_count = Waylon::RSpec::TestSense.sent_messages.size
 
-    Waylon::RSpec::TestSense.process(msg_details(body, from, privately))
+    Waylon::RSpec::TestSense.perform(msg_details(body, from, privately))
     Waylon::RSpec::TestWorker.handle(Waylon::RSpec::TestSense.fake_queue)
     result = Waylon::RSpec::TestSense.sent_messages[message_count..].join("\n")
     puts("(@#{Waylon::RSpec::TestUser.whoami.handle}) >> #{result}")

data/lib/waylon/rspec/test_user.rb

@@ -147,8 +147,8 @@ module Waylon
       # @api private
       # @return [String] A generated email address
       def self.email_from_name(name)
-        if ENV["USER_EMAIL"] && name == "homer.simpson"
-          ENV["USER_EMAIL"]
+        if ENV.fetch("USER_EMAIL", nil) && name == "homer.simpson"
+          ENV.fetch("USER_EMAIL", nil)
         else
           "#{name.downcase.gsub(/[\s_-]/, ".")}@example.com"
         end

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