chat_sdk-slack 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e7d8fc2f1b7131a6077f09cf438093c889cacbd14e714ce5c755e431b06100e
-  data.tar.gz: bd5d7332ecdd4ee0a703653672199eea4895c97b1dbdee6415bcf1af565c41f1
+  metadata.gz: 1110d3c38cf19a4274fab211b64f496c6fc0fdc9461375a6c55b87711e3395c3
+  data.tar.gz: b78730c7b156b9f2ae0c4b548fe671b062fa12cb7ee31de6993a9e28caca553b
 SHA512:
-  metadata.gz: 6562ff69a5097cbfd41951eb0bd1a23cd44b2a9d8b0e37757d273cb8efaf782342b6a6bc9e8fcd744c3e17e692aa09c0d9f1bc3cf1fbdfdaae07ca60113b0d20
-  data.tar.gz: f6fb9463be08054efcc0f94c95f6f50e94b787db295cbe667011d9a7f73203ebc4edbca9221d2dae5a4e6e703276d2f02cd5bd11ed1289d68c37bccb807d4b68
+  metadata.gz: f44439e7c4fe05bac0c9b4d886af0fa01e3a49171712220e82649dca86e3b8f8d7d4277a614d6c9a9c3f3df82694deb3661bc11200b0036934ae5878b0222195
+  data.tar.gz: d845dbde4c82f06e22658e563294ab69b2067dea31f931d2229baf12c6d13230355bf3dad2e731084996789292181139617cbbeef23b798cc7d1975bda6f1466

data/lib/chat_sdk/slack/adapter.rb

@@ -222,6 +222,22 @@ module ChatSDK
         # This is a no-op but the capability is declared for streaming support
       end
 
+      # Slack-specific: receive real-time events via Socket Mode WebSocket.
+      # Requires the optional 'faye-websocket' gem and an app-level token (xapp-*).
+      # Not part of the base adapter contract.
+      #
+      # Usage:
+      #   adapter.start_socket_mode(app_token: "xapp-...") do |event|
+      #     # event is a ChatSDK::Events::* instance
+      #   end
+      def start_socket_mode(app_token: nil, &block)
+        app_token ||= ENV["SLACK_APP_TOKEN"]
+        raise ChatSDK::ConfigurationError, "Slack app_token required for socket mode" unless app_token
+
+        socket = SocketMode.new(app_token: app_token, bot_client: @client)
+        socket.start(&block)
+      end
+
       def mention(user_id)
         "<@#{user_id}>"
       end

data/lib/chat_sdk/slack/socket_mode.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ChatSDK
+  module Slack
+    # Implements Slack Socket Mode: receives events over a WebSocket instead of
+    # incoming HTTP webhooks. Useful for local development, firewalled environments,
+    # or any setup that cannot expose a public URL.
+    #
+    # Requires the optional `faye-websocket` gem and an app-level token (xapp-*).
+    #
+    # Usage:
+    #   adapter.start_socket_mode(app_token: "xapp-...") do |event|
+    #     # event is a ChatSDK::Events::* instance
+    #   end
+    class SocketMode
+      PING_INTERVAL = 30
+
+      attr_reader :app_token, :bot_client
+
+      def initialize(app_token:, bot_client:)
+        @app_token = app_token
+        @bot_client = bot_client
+        @running = false
+      end
+
+      def start(&block)
+        raise ArgumentError, "start requires a block" unless block
+
+        load_websocket_driver!
+
+        @running = true
+        while @running
+          url = obtain_websocket_url
+          run_connection(url, &block)
+        end
+      end
+
+      def stop
+        @running = false
+        @ws&.close
+      end
+
+      private
+
+      def load_websocket_driver!
+        require "faye/websocket"
+      rescue LoadError
+        raise ChatSDK::ConfigurationError,
+          "Slack Socket Mode requires the 'faye-websocket' gem. " \
+          "Add gem 'faye-websocket' to your Gemfile."
+      end
+
+      def obtain_websocket_url
+        # apps.connections.open must be called with the app-level token, not the bot token
+        app_client = ::Slack::Web::Client.new(token: @app_token)
+        response = app_client.apps_connections_open
+        response["url"]
+      end
+
+      def run_connection(url, &block)
+        EM.run do
+          @ws = Faye::WebSocket::Client.new(url, nil, ping: PING_INTERVAL)
+
+          @ws.on :message do |ws_event|
+            handle_message(ws_event, &block)
+          end
+
+          @ws.on :close do |_event|
+            @ws = nil
+            EM.stop
+          end
+        end
+      rescue
+        # Let transient errors trigger a reconnect rather than crashing the loop
+        raise unless @running
+      end
+
+      def handle_message(ws_event, &block)
+        data = JSON.parse(ws_event.data)
+
+        # Acknowledge the envelope so Slack doesn't retry
+        acknowledge(data["envelope_id"]) if data["envelope_id"]
+
+        payload = data["payload"]
+        return unless payload
+
+        # Socket Mode wraps Events API payloads in an envelope. The inner payload
+        # matches the same structure our EventParser already handles from webhooks.
+        #
+        # Envelope types:
+        #   "events_api"       -> payload is an event_callback body
+        #   "interactive"      -> payload is a block_actions / view_submission body
+        #   "slash_commands"    -> payload is a slash command body
+        events = EventParser.parse(payload)
+        events.each { |event| block.call(event) }
+      rescue JSON::ParserError
+        # Ignore malformed frames (e.g. pong/control frames)
+      end
+
+      def acknowledge(envelope_id)
+        return unless envelope_id && @ws
+
+        @ws.send(JSON.generate({envelope_id: envelope_id}))
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chat_sdk-slack
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Quentin Rousseau
@@ -49,6 +49,7 @@ files:
 - lib/chat_sdk/slack/block_kit_renderer.rb
 - lib/chat_sdk/slack/event_parser.rb
 - lib/chat_sdk/slack/modal_renderer.rb
+- lib/chat_sdk/slack/socket_mode.rb
 homepage: https://github.com/rootlyhq/chat-sdk
 licenses:
 - MIT