waylon-core 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf4a171a8420b5e982d54cf24b991a7ae667f3aa93f08b361d10ac28d9726207
-  data.tar.gz: 63982b47f1c05134c4fa5c69d07c4e05e8a1d748c245a4d7bd0695dabe4171c5
+  metadata.gz: 443bc0d5a5a87010e8c006d2882631ef323ed5c06ed343e6ca1f5cb080042c33
+  data.tar.gz: 10812a5cd59babb662a9ef73f0c68146c2e736605f383047e08150375057c78a
 SHA512:
-  metadata.gz: 17a2baf807fd68312c76da6d9d1ca328ed5e5fec065711a7b8ce14a7d86850843d3ce2f6cfa3d4ea26f3c3ce30f329796427deeb98dcd6df77ec181da0afaf3f
-  data.tar.gz: 3edb93a7e82655d44d553687493d11a0a7559b6ae318ffb92051d481872c882baa2c6191a88e96ddd3936df278844e1caee97837f15523fd2158275d0a84eb03
+  metadata.gz: a2a5f869c3bec9cac04882f15b6d5241468d88bdc2c6d3c205f6db920041f6837c719dbf21812fb450d4a1024819391cbbf184aece064a3eeebea2ef2d8dde22
+  data.tar.gz: de895fbc4f2718a3c5f016f3f76fbe6d2abcfa22885a2a0bfc84968c937a60403e7b8b2394e6e911bf170c05d6d075daa97588420eced57978b7dad157570991

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/.ruby-version

@@ -1 +1 @@
-3.1.0
+3.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waylon-core (0.1.2)
+    waylon-core (0.1.5)
       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)
+    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)
-      multipart-post (>= 1.2, < 3)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     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)
+    multipart-post (2.2.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.5.8)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    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 (2.2.3.1)
+    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.5.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.24.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.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.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      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.7.0)
+    rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -109,22 +108,21 @@ 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)
+    yard (0.9.28)
       webrick (~> 1.7.0)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.3)
@@ -138,4 +136,4 @@ DEPENDENCIES
   yard (~> 0.9, >= 0.9.27)
 
 BUNDLED WITH
-   2.3.4
+   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/bin/console

@@ -2,7 +2,12 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "waylon"
+require "waylon/core"
+require "waylon/skills/default"
+require "waylon/skills/diagnostics"
+require "waylon/skills/fun"
+require "waylon/skills/groups"
+require "waylon/skills/help"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/waylon/base_component.rb

@@ -46,7 +46,7 @@ module Waylon
         @namespace || name.to_s.split("::").last.downcase
       end
 
-      # Creates namespaced configuration keys for Webhook subclasses
+      # Creates namespaced configuration keys for BaseComponent subclasses
       # @param (see Config#add_schema)
       def config(key, default: nil, required: false, type: String)
         conf = Config.instance

data/lib/waylon/condition.rb

@@ -66,7 +66,10 @@ module Waylon
     # @param message [Waylon::Message] The received message
     # @return [Boolean]
     def properly_mentions?(message)
-      (mention_only? && message.to_bot?) || (!mention_only? && !message.to_bot?)
+      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

data/lib/waylon/conditions/regex.rb

@@ -18,6 +18,9 @@ module Waylon
         @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]] }

data/lib/waylon/config.rb

@@ -41,7 +41,7 @@ module Waylon
       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

@@ -49,3 +49,4 @@ require "waylon/routes/black_hole"
 require "waylon/routes/default"
 require "waylon/routes/permission_denied"
 require "waylon/webhook"
+require "waylon/webhook_registry"

data/lib/waylon/logger.rb

@@ -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

@@ -30,6 +30,7 @@ module Waylon
     end
 
     def to_bot?
+      # private? || mentions_bot?
       true
     end
   end

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/services/ping.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Services
+    # A Ping Service for monitoring
+    class Ping < Sinatra::Base
+      configure do
+        set :protection, except: :http_origin
+        set :logging, ::Waylon::Logger
+      end
+
+      before do
+        content_type "application/json"
+        halt 403 unless request.get? || request.options?
+      end
+
+      after do
+        headers "Access-Control-Allow-Methods" => %w[OPTIONS GET] if request.options?
+      end
+
+      get "/" do
+        { status: :ok }.to_json
+      end
+
+      options "/" do
+        halt 200
+      end
+    end
+  end
+end

data/lib/waylon/skills/diagnostics.rb

@@ -27,8 +27,10 @@ module Waylon
         response << "  - *Test Result:* #{state ? "Success" : "Error"}"
         response << "  - *Read time:* #{read_time}s"
         response << "  - *Write time:* #{write_time}s"
-        response << "*Queue Monitoring:*"
-        response << "  - Failed jobs: #{Resque::Failure.count}"
+        if Resque.redis.connected?
+          response << "*Queue Monitoring:*"
+          response << "  - Failed jobs: #{Resque::Failure.count}"
+        end
 
         reply response.join("\n")
       end

data/lib/waylon/skills/groups.rb

@@ -146,7 +146,13 @@ module Waylon
       private
 
       def all_group_keys
-        db.adapter.backend.keys("groups.*")
+        if db.adapter.instance_of?(Moneta::Adapters::Redis)
+          db.adapter.backend.keys("groups.*")
+        else
+          groups = []
+          db.each_key { |key| groups << key if key.start_with?("groups.") }
+          groups
+        end
       end
 
       def found_user(user_string)

data/lib/waylon/version.rb

@@ -6,7 +6,7 @@ module Waylon
     VERSION = [
       0, # Major
       1, # Minor
-      2  # Patch
+      5  # Patch
     ].join(".")
   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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waylon-core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Jonathan Gnagy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -246,7 +246,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/waylon.rb
 - lib/waylon/base_component.rb
 - lib/waylon/condition.rb
 - lib/waylon/conditions/black_hole.rb
@@ -276,6 +275,7 @@ 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
@@ -286,6 +286,8 @@ files:
 - 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
@@ -295,7 +297,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
@@ -310,8 +312,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Core library for the Waylon bot framework
 test_files: []

data/lib/waylon.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "waylon/core"
-require "waylon/skills/default"
-require "waylon/skills/diagnostics"
-require "waylon/skills/fun"
-require "waylon/skills/groups"
-require "waylon/skills/help"