bolt_rb 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9b86799c24b51cbd284c829e2fef0b03c307382763c6a646d89c02490f1adde
-  data.tar.gz: 1e71eee650ed3a747fa7d4742e77e761f24d0725711862e002164e7ce105a98c
+  metadata.gz: 9a65a4b02cee36004cad5c01b6dc37c1dc3eb42cfda3b9b81af3ddabc21a9f07
+  data.tar.gz: d1feff607f8b44eba86e970abc01afd5d3c99ca8af4b41d3da04e74f595d9610
 SHA512:
-  metadata.gz: f85418b52d38d9d0646050250aa3f997fb516670c7b8841d1fb2d8ef060a63ba762d3019d251dd43e27f894a92551646dcee9fcc5ae3fa123a850cd21cd08e78
-  data.tar.gz: 51cab8883e2867dc6d3da33507bf8bfc523f8aee6402bb26613a0c230424d22b65eb5c818906a8a22e1b17d049c3dd3c5009cda5c7f88f68c6a2b0850d810f90
+  metadata.gz: 6658a8b2c099f921d63731ef7ded41c14739054c626e6e2b0b174fc5d6b58664da6bffae33121bbf951b90320947345c6148991ad62b86d22f75cb7de44f29ae
+  data.tar.gz: b7f048fddb725c026b63eff2921d82cd95a7ee906b3346e44bff8ab0479811cac1e9394ed498992e5851ba6c2528e436e6b91e51ac06ab803ece4c9c6bc28ce7

data/README.md

@@ -169,6 +169,26 @@ end
 
 **Available methods:** `view`, `callback_id`, `private_metadata`, `values`, `view_hash`, `response_urls`, `user_id`, `ack`, `say`, `client`
 
+### View Closed
+
+Handle modal close/cancel events (requires `notify_on_close: true` when opening the modal):
+
+```ruby
+class TicketCancelHandler < BoltRb::ViewClosedHandler
+  view_closed 'create_ticket_modal'
+
+  def handle
+    ack
+    # Clean up drafts, cancel in-progress operations, etc.
+    unless is_cleared?
+      # User manually closed (X or Cancel button)
+    end
+  end
+end
+```
+
+**Available methods:** `view`, `callback_id`, `private_metadata`, `is_cleared?`, `user_id`, `ack`, `client`
+
 ## Handler Methods
 
 All handlers have access to:

data/lib/bolt_rb/handlers/view_closed_handler.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module BoltRb
+  module Handlers
+    # Handler for Slack view closed events (modal cancellation/dismissal)
+    #
+    # This handler provides the `view_closed` DSL for matching view_closed payloads.
+    # View closed events are triggered when users close a modal by clicking the X
+    # button or Cancel, but only when the modal was opened with notify_on_close: true.
+    #
+    # @example Basic modal close handler
+    #   class CreateTicketCancelHandler < BoltRb::ViewClosedHandler
+    #     view_closed 'create_ticket_modal'
+    #
+    #     def handle
+    #       ack
+    #       # Clean up any in-progress state
+    #     end
+    #   end
+    #
+    # @example Handler checking if view was cleared programmatically
+    #   class SettingsCloseHandler < BoltRb::ViewClosedHandler
+    #     view_closed 'settings_modal'
+    #
+    #     def handle
+    #       ack
+    #       unless is_cleared?
+    #         # User manually closed, maybe prompt to save draft
+    #       end
+    #     end
+    #   end
+    #
+    # @example Regex-based view matching
+    #   class WizardCancelHandler < BoltRb::ViewClosedHandler
+    #     view_closed /^wizard_step_/
+    #
+    #     def handle
+    #       ack
+    #       # Clean up wizard state for any step
+    #     end
+    #   end
+    class ViewClosedHandler < Base
+      class << self
+        # Configures which callback_id this handler responds to
+        #
+        # @param callback_id [String, Regexp] The callback_id to match (exact string or regex)
+        # @return [void]
+        #
+        # @example Match exact callback_id
+        #   view_closed 'create_ticket_modal'
+        #
+        # @example Match callback_id pattern
+        #   view_closed /^wizard_/
+        def view_closed(callback_id)
+          @matcher_config = {
+            type: :view_closed,
+            callback_id: callback_id
+          }
+        end
+
+        # Determines if this handler matches the given payload
+        #
+        # Checks if the payload is a view_closed type and if the
+        # callback_id matches the configured pattern.
+        #
+        # @param payload [Hash] The incoming Slack view_closed payload
+        # @return [Boolean] true if this handler should process the close event
+        def matches?(payload)
+          return false unless matcher_config
+          return false unless payload['type'] == 'view_closed'
+
+          view_callback_id = payload.dig('view', 'callback_id')
+          return false unless view_callback_id
+
+          if matcher_config[:callback_id].is_a?(Regexp)
+            matcher_config[:callback_id].match?(view_callback_id)
+          else
+            view_callback_id == matcher_config[:callback_id]
+          end
+        end
+      end
+
+      # Returns the view object from the payload
+      #
+      # @return [Hash, nil] The view object containing callback_id, private_metadata, etc.
+      def view
+        payload['view']
+      end
+
+      # Returns the callback_id from the view
+      #
+      # @return [String, nil] The callback_id
+      def callback_id
+        view&.dig('callback_id')
+      end
+
+      # Returns the private_metadata from the view
+      #
+      # Private metadata is a string field you can use to pass data between
+      # the view open and close events. Often used to store IDs for cleanup.
+      #
+      # @return [String, nil] The private_metadata value
+      def private_metadata
+        view&.dig('private_metadata')
+      end
+
+      # Returns whether the view was cleared programmatically
+      #
+      # This is true when the view was dismissed via views.update with a
+      # clear_on_close response, rather than the user clicking X or Cancel.
+      #
+      # @return [Boolean] true if the view was cleared programmatically
+      def is_cleared?
+        payload['is_cleared'] == true
+      end
+
+      # Returns the user ID from the payload
+      #
+      # @return [String, nil] The user ID who closed the modal
+      def user_id
+        payload.dig('user', 'id')
+      end
+    end
+  end
+
+  # Top-level alias for convenience
+  ViewClosedHandler = Handlers::ViewClosedHandler
+end

data/lib/bolt_rb/middleware/logging.rb

@@ -38,6 +38,8 @@ module BoltRb
       # - Slash commands: command
       # - Block actions: type with action_ids
       # - Shortcuts: type with callback_id
+      # - View submissions: view_submission with callback_id
+      # - View closed: view_closed with callback_id
       #
       # @param payload [Hash] The raw Slack payload
       # @return [String] A descriptive event type string
@@ -51,6 +53,10 @@ module BoltRb
           "action:#{action_ids}"
         elsif payload['type'] == 'shortcut' || payload['type'] == 'message_action'
           "shortcut:#{payload['callback_id']}"
+        elsif payload['type'] == 'view_submission'
+          "view_submission:#{payload.dig('view', 'callback_id')}"
+        elsif payload['type'] == 'view_closed'
+          "view_closed:#{payload.dig('view', 'callback_id')}"
         else
           'unknown'
         end

data/lib/bolt_rb/version.rb

@@ -1,4 +1,4 @@
 # lib/bolt_rb/version.rb
 module BoltRb
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/bolt_rb.rb

@@ -71,6 +71,7 @@ require_relative 'bolt_rb/handlers/command_handler'
 require_relative 'bolt_rb/handlers/action_handler'
 require_relative 'bolt_rb/handlers/shortcut_handler'
 require_relative 'bolt_rb/handlers/view_submission_handler'
+require_relative 'bolt_rb/handlers/view_closed_handler'
 require_relative 'bolt_rb/socket_mode/client'
 require_relative 'bolt_rb/testing'
 require_relative 'bolt_rb/app'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jon Whitcraft
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-27 00:00:00.000000000 Z
+date: 2026-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
@@ -113,6 +113,7 @@ files:
 - lib/bolt_rb/handlers/command_handler.rb
 - lib/bolt_rb/handlers/event_handler.rb
 - lib/bolt_rb/handlers/shortcut_handler.rb
+- lib/bolt_rb/handlers/view_closed_handler.rb
 - lib/bolt_rb/handlers/view_submission_handler.rb
 - lib/bolt_rb/middleware/base.rb
 - lib/bolt_rb/middleware/chain.rb