waylon-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 909809c1f1e6121fb84667fb922a54cf22cbd801191ab646c9c9db5305c87e60
+  data.tar.gz: d776dd6a040f8278862e8df2c176254acac8a2695e4965e8c06c3b56daef57e0
+SHA512:
+  metadata.gz: 56e572e2fbc880b4ce64f5a61ba888712282e54334705b07d8ecb671d8064fd5b2c217b7f789979bbc1e64ec09ca204b01e301b0b5c1d22766f74a6997c19661
+  data.tar.gz: 5bfeadf428a8bc725c058955a5c0ca4987af49940d7c6523a02b8644e197ff495289f81aa8ea9fd9ef03d2126fa3431ec7ff9db46c5c2db2607f527bf4d33499

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Rackup testing in this repo
+*.ru
+
+# rspec failure tracking
+.rspec_status

data/.roxanne.yml

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

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-01-06
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,157 @@
+PATH
+  remote: .
+  specs:
+    waylon-slack (0.1.0)
+      slack-ruby-client (~> 1.0)
+      waylon-core (~> 0.1)
+
+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.5.0)
+    docile (1.4.0)
+    faraday (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      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-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)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    gli (2.21.0)
+    hashie (5.0.0)
+    i18n (1.9.1)
+      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.1.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    puma (5.6.1)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rainbow (3.1.1)
+    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.2)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.25.0)
+      parallel (~> 1.10)
+      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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.8.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)
+    slack-ruby-client (1.0.0)
+      faraday (>= 1.0)
+      faraday_middleware
+      gli
+      hashie
+      websocket-driver
+    tilt (2.0.10)
+    unicode-display_width (2.1.0)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    waylon-core (0.1.3)
+      addressable (~> 2.8)
+      faraday (~> 1.8)
+      i18n (~> 1.8)
+      json (~> 2.6)
+      moneta (~> 1.4)
+      puma (~> 5.5)
+      resque (~> 2.2)
+    webrick (1.7.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  bundler (~> 2.3)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.23)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.6)
+  simplecov (~> 0.21)
+  waylon-slack!
+  yard (~> 0.9, >= 0.9.27)
+
+BUNDLED WITH
+   2.3.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 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,55 @@
+# Waylon::Slack
+
+The Slack _Sense_ for the [Waylon](https://github.com/jgnagy/waylon-core) Bot Framework. This allows Waylon to interact with Slack via the Slack [Web API](https://api.slack.com/web) and [Events API](https://api.slack.com/events) (for sending and receiving messages, respectively).
+
+## Installation
+
+Add this line to your bot's Gemfile:
+
+```ruby
+gem 'waylon-slack'
+```
+
+Or, if your bot is itself a gem, add this to your .gemspec:
+
+```ruby
+spec.add_dependency "waylon-slack", "~> 0.1"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself via:
+
+    $ gem install waylon-slack
+
+## Usage
+
+You'll need both your webhook server and your workers to have a line like this:
+
+```ruby
+# right after 'require "waylon"'...
+require "waylon/slack"
+```
+
+That should get it working in your bot. You'll also need to ensure that these environment variables are properly defined based on your bot's [Slack app setup](https://api.slack.com/authentication/basics):
+
+```sh
+SLACK_OAUTH_TOKEN="xoxb-..."
+SLACK_SIGNING_SECRET="..."
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jgnagy/waylon-slack.
+
+## 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,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
+require "resque/tasks"
+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]

data/bin/console

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "waylon"
+config = Waylon::Config.instance
+config.load_env
+
+Waylon::Cache = Moneta.new(:Cookie)
+Waylon::Storage = Moneta.new(:LRUHash)
+
+require "waylon/slack"
+
+# 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/senses/slack.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Senses
+    # The Waylon Sense for interacting with Slack via the Events API
+    class Slack < Waylon::Sense
+      features %i[blocks private_messages reactions threads]
+
+      # Provides easy access to the Slack Web Client for interacting with the Slack API
+      # @return [Slack::Web::Client]
+      def self.client
+        @client ||= ::Slack::Web::Client.new
+      end
+
+      # Takes an incoming request from a webhook and converts it to a usable Waylon Message
+      # @param request [Hash,Waylon::Message]
+      # @return [Waylon::Message]
+      def self.message_from_request(request)
+        return request if request.is_a?(message_class)
+
+        if request["type"] == "event_callback" && %w[app_mention message].include?(request.dig("event", "type"))
+          # These are typical chat messages
+          message_class.new(request["event_id"], request["event"])
+        elsif request["type"] == "event_callback"
+          log("Support for events of type #{request.dig("event", "type")} not yet implemented")
+        end
+      end
+
+      # "At-mention" for Slack.
+      # @param user [Waylon::User] The User to mention
+      # @return [String]
+      def self.mention(user)
+        "<@#{user.handle}>"
+      end
+
+      # Provides a simple means to privately reply to the author of a Message
+      # @param request [Hash,Waylon::Message]
+      # @param text [String] Reply contents
+      # @return [void]
+      def self.private_reply(request, text)
+        message = message_from_request(request)
+        message.author.dm(text: text)
+      end
+
+      # Provides a simple means to privately reply to the author of a Message using Blocks
+      # @param request [Hash,Waylon::Message]
+      # @param blocks [Array] Blocks data to reply with
+      # @return [void]
+      def self.private_reply_with_blocks(request, blocks)
+        message = message_from_request(request)
+        message.author.dm(blocks: blocks)
+      end
+
+      # Allows reacting to a request via the Sense's own mechanism
+      # @param request [Hash,Waylon::Message]
+      # @param reaction [String]
+      # @return [void]
+      def self.react(request, reaction)
+        message = message_from_request(request)
+        message.react(reaction)
+      end
+
+      # Reply to a Message in a Channel with some text
+      # @param request [Hash,Waylon::Message]
+      # @param text [String] Reply contents
+      # @return [void]
+      def self.reply(request, text)
+        message = message_from_request(request)
+        message.channel.post(text: text)
+      end
+
+      # Reply to a Message in a Channel with some blocks
+      # @param request [Hash,Waylon::Message]
+      # @param blocks [Array] Blocks to reply with
+      # @return [void]
+      def self.reply_with_blocks(request, blocks)
+        message = message_from_request(request)
+        message.channel.post(blocks: blocks)
+      end
+
+      # Executed by Resque, this is how this Sense determines what to do with an incoming request
+      # @param received_web_content [Hash] The parsed web request content from the Webhook
+      # @return [void]
+      def self.run(received_web_content)
+        log("Received request of type #{received_web_content["type"]}", :debug)
+        message = message_from_request(received_web_content)
+        unless message
+          log("Unable to handle request")
+          return
+        end
+
+        if message.author == Waylon::Slack::User.whoami
+          log("Ignoring my own message...", :debug)
+          return
+        end
+
+        log("Responding to message from bot '#{message.author.handle}'") if message.author.bot?
+
+        route = Waylon::SkillRegistry.route(message) || SkillRegistry.instance.default_route(message)
+        enqueue(route, received_web_content)
+      end
+
+      # Reply to a Message in a Thread with some text
+      # @param request [Hash,Waylon::Message]
+      # @param text [String] Reply contents
+      # @return [void]
+      def self.threaded_reply(request, text)
+        message = message_from_request(request)
+        message.channel.post(text: text, thread: message.thread_parent)
+      end
+
+      # Required by the Waylon framework, this provides the Sense's own Message class
+      # @return [Class]
+      def self.message_class
+        Waylon::Slack::Message
+      end
+
+      # Required by the Waylon framework, this provides the Sense's own User class
+      # @return [Class]
+      def self.user_class
+        Waylon::Slack::User
+      end
+
+      # Automatically informs Waylon about this Sense
+      SenseRegistry.register(:slack, self)
+    end
+  end
+end

data/lib/waylon/slack/channel.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Slack
+    # A representation of Slack channels for Waylon
+    class Channel
+      attr_reader :id
+
+      # Allows finding a channel based on its channel name
+      # @raise [Slack::Web::Api::Errors::ChannelNotFound] When the channel doesn't exist
+      # @return [Channel]
+      def self.from_name(name)
+        name = name.start_with?("#") ? name : "##{name}"
+        raw = sense.client.conversations_info(channel: name)
+        new(raw["channel"]["id"], data: raw["channel"])
+      end
+
+      # Provides direct access to the Sense class
+      # @return [Class]
+      def self.sense
+        ::Waylon::Senses::Slack
+      end
+
+      def initialize(id = nil, data: {})
+        raise "Must provide ID or details" unless id || !data.empty?
+
+        @id = id || data["id"]
+        # @data should never be accessed directly... always use the wrapper instance method
+        @data = data
+      end
+
+      # Is channel archived (meaning no further messages are possible)?
+      # @return [Boolean]
+      def archived?
+        data["is_archived"].dup
+      end
+
+      # Provides lazy, cached access to the Channel's internal details
+      # @return [Hash]
+      def data
+        if !@data || @data.empty?
+          # Only cache channel info for 5 min
+          sense.cache("channels.#{id}", expires: 300) do
+            raw_data = sense.client.conversations_info(channel: id)
+            @data = raw_data["channel"]
+          end
+        else
+          @data
+        end
+      end
+
+      # Is this the "main" channel for this team?
+      # @return [Boolean]
+      def general?
+        data["is_general"].dup
+      end
+
+      # Lists channel members
+      # @return [Array<User>] channel members
+      def members
+        # Only cache channel member ids for 5 min
+        ids = sense.cache("channels.#{id}.member_ids", expires: 300) do
+          member_ids = []
+          sense.client.conversations_members(channel: id) do |raw|
+            member_ids += raw["members"]
+          end
+          member_ids.sort.uniq
+        end
+        ids.map { |m| User.new(m) }
+      end
+
+      # Is this bot a member of the channel?
+      # @return [Boolean]
+      def member?
+        data["is_member"]
+      end
+
+      # The proper channel name
+      # @return [String]
+      def name
+        "##{data["name"]}"
+      end
+
+      # Posts a message to a channel
+      # @param text [String] Message text or fallback text for blocks
+      # @param attachments [Array<Hash>] Old-style message attachments
+      # @param blocks [Array<Hash>] New-style block method of sending complex messages
+      # @param thread [Integer] The message timestamp for the thread id
+      # @return [void]
+      def post(text: nil, attachments: nil, blocks: nil, thread: nil)
+        options = { channel: id }
+        options[:text] = text if text
+        options[:attachments] = attachments if attachments
+        options[:blocks] = blocks if blocks
+        options[:thread_ts] = thread if thread
+        sense.client.chat_postMessage(options)
+      end
+
+      # Is this a private channel? (meaning a direct message, NOT private in the Slack sense)
+      # @return [Boolean]
+      def private?
+        data["is_im"].dup
+      end
+
+      # An instance-level helper to access the class-level method
+      # @return [Class]
+      def sense
+        self.class.sense
+      end
+
+      # Provides access to the Channel's topic
+      # @return [String]
+      def topic
+        data.dig("topic", "value").dup
+      end
+    end
+  end
+end

data/lib/waylon/slack/message.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Slack
+    # A representation of Slack messages for Waylon
+    class Message
+      include Waylon::Message
+
+      attr_reader :id, :data
+
+      def initialize(id, data = {})
+        @id = id
+        @data = data
+      end
+
+      # The User that authored this Message
+      # @return [User]
+      def author
+        User.new(data["user"])
+      end
+
+      # The Channel where this Message was sent
+      # @return [Channel]
+      def channel
+        Channel.new(data["channel"])
+      end
+
+      # Does the message text mention the bot?
+      # @return [Boolean]
+      def mentions_bot?
+        me = User.whoami
+        reg = /(,\s+)?\s*@#{me.id},?\s*/
+        ::Slack::Messages::Formatting.unescape(data["text"]) =~ reg ? true : false
+      end
+
+      # Is this Message a reply in a thread?
+      # @return [Boolean]
+      def part_of_thread?
+        thread_ts && thread_ts != ts
+      end
+
+      # Is this a private Message / direct Message?
+      # @return [Boolean]
+      def private_message?
+        channel.private?
+      end
+
+      alias private? private_message?
+
+      # Uses the Sense's Web Client to add a reaction to a Message
+      # @param reaction [String,Symbol] The reaction to add (not wrapped in ":")
+      # @return [void]
+      def react(reaction)
+        sense.client.reactions_add(channel: channel.id, name: reaction, timestamp: ts)
+      end
+
+      # Easy access to the Sense class
+      # @return [Class]
+      def sense
+        ::Waylon::Senses::Slack
+      end
+
+      # The unescaped contents of the Message
+      # @return [String]
+      def text
+        me = User.whoami
+        reg = /(,\s+)?\s*@#{me.id},?\s*/
+        ::Slack::Messages::Formatting.unescape(data["text"]).gsub(reg, "")
+      end
+
+      alias body text
+
+      # The TS value of the parent of this Message's thread, or its own TS if it is the parent
+      # @return [String]
+      def thread_parent
+        thread_ts || ts
+      end
+
+      # The TS value of the parent of this Message's thread, if it exists
+      # @return [String,nil]
+      def thread_ts
+        data["thread_ts"].dup
+      end
+
+      # Does this Message either directly mention or is it directly to this bot?
+      # @return [Boolean]
+      def to_bot?
+        data["type"] == "app_mention" || private_message?
+      end
+
+      # This Message's own TS value (which should not be used for threading if it itself is a thread reply)
+      # @return [String]
+      def ts
+        data["ts"].dup
+      end
+    end
+  end
+end

data/lib/waylon/slack/user.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Slack
+    # A representation of Slack users for Waylon
+    class User
+      include Waylon::User
+
+      # Find a Slack User based on their IM handle
+      # @param handle [String]
+      # @return [User]
+      def self.find_by_handle(handle)
+        real_handle = handle.start_with?("@") ? handle : "@#{handle}"
+        from_response(sense.client.users_info(user: real_handle))
+      end
+
+      # Find a Slack User based on their email address
+      # @param email [String]
+      # @return [User]
+      # @note Not recommended as it requires an additional scope on the OAuth token
+      def self.find_by_email(email)
+        from_response(sense.client.users_lookupByEmail(email))
+      end
+
+      # Find a Slack User based on the text provided by Slack from a mention of that User
+      # @param mention_string [String]
+      # @return [User]
+      def self.from_mention(mention_string)
+        from_response(sense.client.users_info(user: mention_string[1..]))
+      end
+
+      # Provide a Slask User based on a Web API response
+      # @param response [Hash] The response from a Web API request
+      # @return [User]
+      def self.from_response(response)
+        raise "Failed Request" unless response && response["ok"]
+
+        new(data: response["user"])
+      end
+
+      # Allows easy access to the Sense class
+      # @return [Class]
+      def self.sense
+        ::Waylon::Senses::Slack
+      end
+
+      # A convenient way use the Slack API to figure out the bot's own info
+      # @return [User]
+      def self.whoami
+        response = sense.cache("whoami") { sense.client.auth_test }
+        new(response["user_id"])
+      end
+
+      def initialize(id = nil, data: {})
+        raise "Must provide ID or details" unless id || !data.empty?
+
+        @id = id || data["id"]
+        @data = data
+      end
+
+      # Provides lazy, cached access to the User's internal details
+      # @return [Hash]
+      def data
+        if !@data || @data.empty?
+          sense.cache("users.#{id}") do
+            raw_data = sense.client.users_info(user: id)
+            @data = raw_data["user"]
+          end
+        else
+          @data
+        end
+      end
+
+      # Is this user a bot?
+      # @return [Boolean]
+      def bot?
+        data["is_bot"]
+      end
+
+      # Posts a direct (private) message to a user
+      # @param text [String] Message text or fallback text for blocks
+      # @param attachments [Array<Hash>] Old-style message attachments
+      # @param blocks [Array<Hash>] New-style block method of sending complex messages
+      # @param thread [Integer] The message timestamp for the thread id
+      # @return [void]
+      def dm(text: nil, attachments: nil, blocks: nil, thread: nil)
+        options = { channel: id } # Sends a message to the user's ID
+        options[:text] = text if text
+        options[:attachments] = attachments if attachments
+        options[:blocks] = blocks if blocks
+        options[:thread_ts] = thread if thread
+        sense.client.chat_postMessage(options)
+      end
+
+      # The User's email address
+      # @return [String]
+      def email
+        profile["email"]
+      end
+
+      # The User's username/chat handle
+      # @return [String]
+      def handle
+        bot? ? data["real_name"] : data["name"]
+      end
+
+      # The User's profile information
+      # @return [Slack::Messages::Message]
+      def profile
+        data["profile"]
+      end
+
+      # Easy access to the Sense class
+      # @return [Class]
+      def sense
+        self.class.sense
+      end
+
+      # The User's current Status (comes from cache so can be outdated)
+      # @return [String]
+      def status
+        profile["status_text"]
+      end
+
+      # The User's Slack team ID
+      # @return [String]
+      def team
+        data["team_id"]
+      end
+
+      # The User's time zone
+      # @return [String]
+      def tz
+        data["tz"]
+      end
+    end
+  end
+end

data/lib/waylon/slack/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Slack
+    VERSION = "0.1.0"
+  end
+end

data/lib/waylon/slack.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "waylon/core"
+require "slack-ruby-client"
+
+::Slack.configure do |conf|
+  conf.token = ENV["SLACK_OAUTH_TOKEN"]
+  conf.logger = Waylon::Logger.logger
+end
+
+::Slack::Web::Client.configure do |conf|
+  conf.user_agent = "Waylon/#{Waylon::Core::VERSION}"
+  conf.logger = Waylon::Logger.logger
+end
+
+require_relative "slack/version"
+require_relative "slack/user"
+require_relative "slack/channel"
+require_relative "slack/message"
+require_relative "senses/slack"
+require_relative "webhooks/slack"

data/lib/waylon/webhooks/slack.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Waylon
+  module Webhooks
+    # Webhook for the Slack Sense for Waylon
+    class Slack < Waylon::Webhook
+      before do
+        content_type "application/json"
+      end
+
+      post "/" do
+        request.body.rewind
+        verify(request) unless ENV.fetch("LOCAL_MODE", false)
+        if @parsed_body.is_a?(Hash) && @parsed_body[:type] == "url_verification"
+          { challenge: @parsed_body[:challenge] }.to_json
+        else
+          enqueue(@parsed_body)
+          { status: :ok }.to_json
+        end
+      rescue ::Slack::Events::Request::InvalidSignature, ::Slack::Events::Request::TimestampExpired
+        halt(403, { error: "Unable to authenticate request" }.to_json)
+      rescue StandardError => e
+        log("Encountered #{e.message}", :warn)
+        halt(422, { error: "Unprocessable entity: #{e.message}" }.to_json)
+      end
+
+      options "/" do
+        halt 200
+      end
+
+      # Used to verify incoming Slack requests
+      def verify(incoming_request)
+        slack_request = ::Slack::Events::Request.new(incoming_request)
+        slack_request.verify!
+      end
+
+      # Automatically informs Waylon about this Webhook
+      Waylon::WebhookRegistry.register(:slack, self)
+    end
+  end
+end

data/scripts/test.sh

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

data/waylon-slack.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/waylon/slack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "waylon-slack"
+  spec.version       = Waylon::Slack::VERSION
+  spec.authors       = ["Jonathan Gnagy"]
+  spec.email         = ["jonathan.gnagy@gmail.com"]
+
+  spec.summary       = "Slack Sense for the Waylon Bot Framework"
+  spec.description   = "Full Slack integration for the Waylon Bot Framework"
+  spec.homepage      = "https://github.com/jgnagy/waylon-slack"
+  spec.license       = "MIT"
+  spec.required_ruby_version = "~> 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jgnagy/waylon-slack"
+  spec.metadata["changelog_uri"] = "https://github.com/jgnagy/waylon-slack/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "slack-ruby-client", "~> 1.0"
+  spec.add_dependency "waylon-core", "~> 0.1"
+
+  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"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.6"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "yard", "~> 0.9", ">= 0.9.27"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: waylon-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Gnagy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: waylon-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+description: Full Slack integration for the Waylon Bot Framework
+email:
+- jonathan.gnagy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".roxanne.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/waylon/senses/slack.rb
+- lib/waylon/slack.rb
+- lib/waylon/slack/channel.rb
+- lib/waylon/slack/message.rb
+- lib/waylon/slack/user.rb
+- lib/waylon/slack/version.rb
+- lib/waylon/webhooks/slack.rb
+- scripts/test.sh
+- waylon-slack.gemspec
+homepage: https://github.com/jgnagy/waylon-slack
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jgnagy/waylon-slack
+  source_code_uri: https://github.com/jgnagy/waylon-slack
+  changelog_uri: https://github.com/jgnagy/waylon-slack/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Slack Sense for the Waylon Bot Framework
+test_files: []