waylon-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01c6d89ed4d79dba9305c9c83fd597fed10ace104592f7d8ae6ed2f630bb9351
+  data.tar.gz: 83ac891dc983e61f76b5cd366062381b748dcc49c86d6177b4e245c8c29573e0
+SHA512:
+  metadata.gz: bd0fabfda6646c84cb17af27dd55bd8c70ad1c803a257e1e4ed992ce4298563a579705dff33b898519b82ed2123e59ab2259021bbdec320914914a7ee19291f0
+  data.tar.gz: 5b2c06fc2c55256014f35e953465f21c11c6de9390e55c0a504f7fcb08c2fcff1898e583dac97b546b1d1a7c00650014562c2e678aff6832353a3c24f08527b8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.roxanne.yml

@@ -0,0 +1,4 @@
+version: 1.0
+stages:
+  test:
+    image: ruby:3.0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/MixinUsage:
+  Exclude:
+  - "bin/console"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 19
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+  - "**/*_spec.rb"
+  - "*.gemspec"

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-17
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in waylon-core.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,137 @@
+PATH
+  remote: .
+  specs:
+    waylon-core (0.1.0)
+      addressable (~> 2.8)
+      faraday (~> 1.8)
+      i18n (~> 1.8)
+      json (~> 2.6)
+      moneta (~> 1.4)
+      puma (~> 5.5)
+      resque (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+    docile (1.4.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    moneta (1.4.2)
+    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)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    puma (5.5.2)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rainbow (3.0.0)
+    rake (13.0.6)
+    redis (4.5.1)
+    redis-namespace (1.8.1)
+      redis (>= 3.0.4)
+    regexp_parser (2.2.0)
+    resque (2.2.0)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.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
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.23)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.6)
+  simplecov (~> 0.21)
+  waylon-core!
+  yard (~> 0.9, >= 0.9.27)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jonathan Gnagy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Waylon::Core
+
+Waylon is a bot framework in the same vein as [Lita](https://www.lita.io/) built to make creating bots easy and fun. It supports swappable sensory inputs (chat platforms, web endpoints, and more), easy to build Skills, built-in and extensible permissions, and modern JSON logging.
+
+This repo/library is the core of Waylon; it provides the essential pieces of the framework and some working examples.
+
+## Why Waylon
+
+Waylon is built to be scalable and to deliver features missing in other chat frameworks. For instance, it supports self-reporting and discovering plugin features (such as supporting HTML cards, reactions, etc.) to making Skills more powerful and dynamic. Waylon also supports a full, shared caching layer to make scaling simple. It also makes heavy use of Redis for queuing work, meaning zero-downtime upgrades and faster user responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'waylon-core'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install waylon-core
+
+If you're building a plugin for Waylon, you'll only need to require the core:
+
+```ruby
+require "waylon/core"
+```
+
+If you're launching your own bot, require the entire library and plus any additional plugins:
+
+```ruby
+require "waylon"
+```
+
+## Usage
+
+### Demo Mode
+
+Alone, this library isn't super useful for running a bot, but it does include a "demo", local REPL mode for experimenting. To use it, run `rake demo`.
+
+## 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.
+
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jgnagy/waylon-core.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "redis/errors"
+require "resque/tasks"
+require "yard"
+require "waylon/core"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+YARD::Rake::YardocTask.new do |y|
+  y.options = [
+    "--markup", "markdown"
+  ]
+end
+
+task default: %i[spec rubocop yard]
+
+task :demo do
+  require "waylon/rspec/test_server"
+end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "waylon"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+include Waylon
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/waylon/base_component.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Waylon
+  # The base mixin for all core Waylon components
+  # @abstract
+  module BaseComponent
+    def self.included(base)
+      base.send :include, InstanceLoggingMethods
+      base.send :include, InstanceUtilityMethods
+      base.extend ClassLoggingMethods
+      base.extend ClassUtilityMethods
+    end
+
+    # Base class logging methods
+    module ClassLoggingMethods
+      # Simple pass-through for logging through the Waylon Logger
+      # @param message [String] The message to log
+      # @param level [String,Symbol] The log level for this message
+      def log(message, level = :info)
+        ::Waylon::Logger.log(message, level)
+      end
+    end
+
+    # Base Component utility methods
+    module ClassUtilityMethods
+      # The namespace used for this component's storage
+      # @param value [String,nil] Sets this namespace unless set (without setting, returns a sane default)
+      # @return [String] The namespace for this component
+      def component_namespace(value = nil)
+        @namespace ||= value
+        # Either returns the namespace or the stripped down class name
+        @namespace || name.to_s.split("::").last.downcase
+      end
+
+      # Creates namespaced configuration keys for Webhook subclasses
+      # @param (see Config#add_schema)
+      def config(key, default: nil, required: false, type: String)
+        conf = Config.instance
+        config_key = config_key_for(key)
+        conf.add_schema(config_key, default: default, required: required, type: type)
+      end
+
+      # Provides the full Config key given a relative key
+      # @param key [String] The relative key to fully-qualify
+      # @return [String] The fully-qualified Config key
+      def config_key_for(key)
+        "#{config_namespace}.#{key}"
+      end
+
+      # Determines if the current component is fully configured
+      # @return [Boolean]
+      def configured?
+        conf = Config.instance
+        req_confs = conf.schema.select do |k, v|
+          k.match?(/^#{config_namespace}\./) && v[:required]
+        end
+        missing_configs = req_confs.reject { |k, _v| conf.set?(k) }
+        if missing_configs.empty? && conf.valid?
+          true
+        elsif missing_configs.empty?
+          log("Configuration for #{component_namespace} failed validation!", :error)
+          false
+        else
+          missing_configs.each { |k, _v| log("Missing required configuration: #{k}", :error) }
+          false
+        end
+      end
+
+      # Describes features supported by a Sense
+      # @param list [String,Array<String,Symbol>] List of features supported by this BaseComponent
+      def features(list)
+        @features = [*list].map(&:to_sym)
+      end
+
+      # Determine if a BaseComponent subclass supports a feature
+      # @param key [String,Symbol] The feature in question
+      def supports?(key)
+        @features ||= []
+        @features.include?(key.to_sym)
+      end
+    end
+
+    # Base instance logging methods
+    module InstanceLoggingMethods
+      # Instance-level access to logging via the Class log method
+      # @param (see ClassLoggingMethods#log)
+      def log(message, level = :info)
+        self.class.log(message, level)
+      end
+    end
+
+    # Base instance utility methods
+    module InstanceUtilityMethods
+      # Allows caching operations (or retrieving cached versions)
+      # @param [String] key How to store/retrieved the cached value
+      # @param [Integer] expires How long to cache the value
+      def cache(key, expires: 600)
+        cache_key = self.class.config_key_for(key)
+        if !Waylon::Cache.key?(cache_key) && block_given?
+          result = yield
+          Waylon::Cache.store(cache_key, result, expires: expires)
+        elsif !Waylon::Cache.key?(cache_key)
+          return nil
+        end
+        Waylon::Cache.load(cache_key, expires: expires)
+      end
+
+      # A wrapper for access to a namespaced Config key
+      # @param [String] key The key name to lookup
+      def config(key)
+        conf = Config.instance
+        conf[self.class.config_key_for(key)]
+      end
+
+      # A wrapper for accessing the persistent storage
+      # @return [Waylon::Storage] The Storage wrapper class
+      def storage
+        Waylon::Storage
+      end
+
+      alias db storage
+    end
+  end
+end

data/lib/waylon/condition.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Waylon
+  # Abstract route condition superclass
+  # @abstract
+  class Condition
+    attr_reader :action, :help, :mechanism
+
+    # @param mechanism The meat of the condition used to decide if this condition applies
+    # @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)
+      @mechanism = mechanism
+      @action = action
+      @allowed_groups = allowed_groups
+      @help = help
+    end
+
+    # Placeholder for determining if this condition applies to the given input
+    # @param _input [Waylon::Message] The input message
+    def matches?(_input)
+      false
+    end
+
+    # Checks if a user is allowed based on this condition
+    # @param user [Waylon::User] abstract user
+    def permits?(user)
+      return true if allows?(:everyone)
+
+      Logger.log("Checking permissions for #{user.email}", :debug)
+      group_class = user.class.sense.group_class
+      # Check for global admins
+      return true if Config.instance.admins.include?(user.email)
+      # Check for managed admins
+      return true if group_class.new("admins").include?(user)
+
+      permitted = false
+
+      [*@allowed_groups].each do |group|
+        permitted = true if group_class.new(group).include?(user)
+        break if permitted
+      end
+      permitted
+    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
+    def tokens(_input)
+      []
+    end
+
+    private
+
+    # Determines if a group name is among the list of allowed groups for this condition
+    # @note Does not involve determining user group membership, just allows access to the list of allowed groups
+    # @param group [Symbol] A group name to lookup
+    def allows?(group)
+      @allowed_groups ||= []
+      [*@allowed_groups].include?(group.to_sym)
+    end
+  end
+end

data/lib/waylon/conditions/default.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Conditions
+    # A pre-made catch-all condition for denying access
+    class Default < Condition
+      # Overrides normal Condition initialization to force a specific action
+      def initialize(*_args) # rubocop:disable Lint/MissingSuper
+        @mechanism = nil
+        @action = :unknown
+        @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/permission_denied.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Conditions
+    # A pre-made catch-all condition for denying access
+    class PermissionDenied < Condition
+      # Overrides normal Condition initialization to force a specific action
+      def initialize(*_args) # rubocop:disable Lint/MissingSuper
+        @mechanism = nil
+        @action = :denied
+        @allowed_groups = [:everyone]
+        @help = "This action is not allowed"
+      end
+
+      # Matches any input (since the PermissionDenied route, when used, should always function)
+      # @return [Boolean]
+      def matches?(_input)
+        true
+      end
+
+      # Permits any user (since the PermissionDenied 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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Conditions
+    # Routing via Regular Expression
+    class Regex < Condition
+      # Checks if this condition matches the message
+      # @param message [String] The message text
+      # @return [Boolean]
+      def matches?(message)
+        @mechanism =~ message
+      end
+
+      # Provides the regular expression match groups as tokens
+      # @param input [String] The message text
+      # @return [Array<String>] The regular expression match groups
+      def tokens(input)
+        @mechanism.match(input).to_a[1..]
+      end
+    end
+  end
+end