Merge pull request #29 from ombulabs/feature/slack-bot

Add slack bot to allow for puzzle suggestions

Author: ABizzinotto

Gemfile

@@ -44,6 +44,9 @@ gem "thruster", require: false
 # Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
 # gem "image_processing", "~> 1.2"
 
+gem "slack-ruby-block-kit", ">= 0.24.0"
+gem "slack-ruby-client", ">= 2.4.0"
+
 # auth gems
 gem "omniauth"
 gem "omniauth-google-oauth2"

Gemfile.lock

@@ -77,6 +77,7 @@ GEM
     ast (2.4.2)
     base64 (0.3.0)
     bcrypt_pbkdf (1.1.1)
+    bcrypt_pbkdf (1.1.1-arm64-darwin)
     benchmark (0.4.1)
     bigdecimal (3.2.1)
     bindex (0.8.1)
@@ -125,6 +126,11 @@ GEM
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
+    faraday-mashify (1.0.0)
+      faraday (~> 2.0)
+      hashie
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
     ffi (1.17.1-aarch64-linux-gnu)
@@ -137,6 +143,8 @@ GEM
     fugit (1.11.1)
       et-orbi (~> 1, >= 1.2.11)
       raabro (~> 1.4)
+    gli (2.22.2)
+      ostruct
     globalid (1.2.1)
       activesupport (>= 6.1)
     hashie (5.0.0)
@@ -193,6 +201,7 @@ GEM
     msgpack (1.8.0)
     multi_xml (0.7.2)
       bigdecimal (~> 3.1)
+    multipart-post (2.4.1)
     mutex_m (0.3.0)
     net-http (0.6.0)
       uri
@@ -375,6 +384,15 @@ GEM
       rufus-scheduler (~> 3.2)
       sidekiq (>= 6, < 8)
       tilt (>= 1.4.0, < 3)
+    slack-ruby-block-kit (0.26.0)
+      zeitwerk (~> 2.6)
+    slack-ruby-client (2.6.0)
+      faraday (>= 2.0)
+      faraday-mashify
+      faraday-multipart
+      gli
+      hashie
+      logger
     snaky_hash (2.0.3)
       hashie (>= 0.1.0, < 6)
       version_gem (>= 1.1.8, < 3)
@@ -473,6 +491,8 @@ DEPENDENCIES
   selenium-webdriver
   sidekiq
   sidekiq-scheduler
+  slack-ruby-block-kit (>= 0.24.0)
+  slack-ruby-client (>= 2.4.0)
   solid_cable
   solid_cache
   solid_queue

README.md

@@ -14,7 +14,7 @@ Get Daily Puzzles delivered to your preferred server channel with a "Is it Ruby
 # Set Up
 ```
   git clone git@github.com:ombulabs/ruby-or-rails.git
-  cd reads
+  cd ruby-or-rails
   ./bin/setup
 ```
 Check the .env.sample file for information on what environment variables you will need.

app/controllers/slack/application_controller.rb

@@ -0,0 +1,47 @@
+class Slack::ApplicationController < ApplicationController
+  skip_before_action :verify_authenticity_token
+  before_action :valid_slack_request?
+
+  private
+
+  def valid_slack_request?
+    @verified ||= verify_slack_signature
+  end
+
+  def verify_slack_signature
+    timestamp = request.headers["X-Slack-Request-Timestamp"]
+    signature = request.headers["X-Slack-Signature"]
+
+    if Time.now.to_i - timestamp.to_i > 300
+      @verified = false
+      return
+    end
+
+    base_string = "v0:#{timestamp}:#{request.raw_post}"
+    my_signature = "v0=" + OpenSSL::HMAC.hexdigest(
+      "SHA256",
+      ENV["SLACK_SIGNING_SECRET"],
+      base_string
+    )
+
+    ActiveSupport::SecurityUtils.secure_compare(signature, my_signature)
+  end
+
+  def slack_client
+    @slack_client ||= SlackClient::Client.instance
+  end
+
+  def open_view(view, trigger_id:)
+    slack_client = SlackClient::Client.instance
+    slack_client.views_open view: view, trigger_id: trigger_id
+  rescue Slack::Web::Api::Errors::SlackError => e
+    Rails.logger.error "Failed to open Slack modal: #{e.message} #{e.response_metadata}"
+    head :unprocessable_entity
+  end
+
+  def send_message(message, channel_id:)
+    SlackClient::Client.instance.chat_postMessage(channel: channel_id, blocks: message)
+  rescue Slack::Web::Api::Errors::SlackError
+    head :unprocessable_entity
+  end
+end

app/controllers/slack/commands_controller.rb

@@ -0,0 +1,6 @@
+class Slack::CommandsController < Slack::ApplicationController
+  def new_puzzle
+    view  = SlackClient::Views::PuzzleForm.new.create
+    open_view(view, trigger_id: params[:trigger_id])
+  end
+end

app/controllers/slack/puzzles_controller.rb

@@ -0,0 +1,22 @@
+class Slack::PuzzlesController < Slack::ApplicationController
+  def create
+    payload = JSON.parse(params[:payload])
+    user_id = payload["user"]["id"]
+    values = payload["view"]["state"]["values"]
+    question = values.dig("question", "question", "value")
+    answer = values.dig("answer", "answer", "selected_option", "value")
+    explanation = values.dig("explanation", "explanation", "value")
+    link = values.dig("link", "link", "value")
+    puzzle = Puzzle.new(question:, answer:, explanation:, link:, status: :pending, suggested_by: user_id)
+
+    if puzzle.save
+      view = SlackClient::Views::Success.new.create
+      notification_message = SlackClient::Messages::NewPuzzleNotification.new(puzzle).create
+      send_message(notification_message, channel_id: ENV.fetch("SHIELD_NOTIFICATIONS_CHANNEL", nil))
+    else
+      view = SlackClient::Views::Failure.new.create
+    end
+
+    render json: { response_action: "update", view: view }, status: :ok
+  end
+end

app/lib/slack_client/client.rb

@@ -0,0 +1,36 @@
+require "singleton"
+
+module SlackClient
+  # This class is a wrapper around the Slack::Web::Client class that allows us to use the
+  # singleton pattern to create a single instance of the Slack client.
+  # This is useful because we can reuse the same client instance across the application,
+  # which can help reduce the number of connections to the Slack API.
+  #
+  # Example:
+  # slack_client = SlackClient::Client.instance
+  #
+  class Client
+    include Singleton
+
+    def initialize
+      @slack_client = Slack::Web::Client.new(token: ENV["SLACK_TOKEN"])
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      if @slack_client.respond_to?(method)
+        @slack_client.send(method, *args, &block)
+      else
+        super
+      end
+    rescue Slack::Web::Api::Errors::SlackError => e
+      Rails.logger.error "Failed to complete Slack request: #{e.message} #{e.response_metadata}"
+      raise
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @slack_client.respond_to?(method) || super
+    end
+  end
+end

app/lib/slack_client/messages/new_puzzle_notification.rb

@@ -0,0 +1,36 @@
+module SlackClient
+  module Messages
+    class NewPuzzleNotification
+      def initialize(puzzle, shield_group_id: ENV["SHIELD_GROUP_ID"])
+        @puzzle = puzzle
+        @shield_group_id = shield_group_id
+      end
+
+      def create
+        Slack::BlockKit.blocks do |block|
+          block.section do |section|
+            section.mrkdwn text: "*New Puzzle Suggestion!*\n\n"
+          end
+          block.section do |section|
+            section.mrkdwn text: body_text
+          end
+        end.as_json
+      end
+
+      private
+
+      def body_text
+        <<~TEXT
+          Hey <!subteam^#{@shield_group_id}>!
+
+          <@#{@puzzle.suggested_by}> has submitted a new suggestion for a puzzle:
+
+          Question:
+          #{@puzzle.question}
+
+          Check out the <#{ENV.fetch('APP_URL', nil)}|admin panel> for more details.
+        TEXT
+      end
+    end
+  end
+end

app/lib/slack_client/views/failure.rb

@@ -0,0 +1,16 @@
+module SlackClient
+  module Views
+    class Failure
+      def create
+        blocks = Slack::BlockKit.blocks do |block|
+          block.section do |section|
+            section.plain_text text: ":blob-no: Sorry, I could not register the puzzle suggestion."
+          end
+        end
+        Slack::BlockKit.modal blocks: blocks, title: "Uh oh..." do |modal|
+          modal.close text: "Close"
+        end.as_json
+      end
+    end
+  end
+end

app/lib/slack_client/views/puzzle_form.rb

@@ -0,0 +1,33 @@
+module SlackClient
+  module Views
+    class PuzzleForm
+      def create
+        blocks = Slack::BlockKit.blocks do |blocks|
+          blocks.input label: "What is the Puzzle question?", block_id: "question" do |input|
+            input.plain_text_input action_id: "question", multiline: true
+          end
+
+          blocks.input label: "Answer", block_id: "answer" do |input|
+            input.radio_buttons action_id: "answer" do |radio_button|
+              radio_button.option text: "Ruby", value: "ruby"
+              radio_button.option text: "Rails", value: "rails"
+            end
+          end
+
+          blocks.input label: "Explanation", block_id: "explanation" do |input|
+            input.plain_text_input action_id: "explanation", multiline: true
+          end
+
+          blocks.input label: "Link to documentation", block_id: "link", optional: true do |input|
+            input.plain_text_input action_id: "link"
+          end
+        end
+
+        Slack::BlockKit.modal blocks: blocks, external_id: "puzzle_form", title: "Suggest a Puzzle" do |modal|
+          modal.submit text: "Submit"
+          modal.close text: "Close"
+        end.as_json
+      end
+    end
+  end
+end