add a Slack::Web::Api::Helpers:Files module that has files_upload_v2

Author: gregsaab

lib/slack-ruby-client.rb

@@ -37,6 +37,7 @@
 require_relative 'slack/web/faraday/request'
 require_relative 'slack/web/api/mixins'
 require_relative 'slack/web/api/endpoints'
+require_relative 'slack/web/api/helpers'
 require_relative 'slack/web/pagination/cursor'
 require_relative 'slack/web/client'
 

lib/slack/web/api/helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'helpers/files'
+
+module Slack
+  module Web
+    module Api
+      module Helpers
+        include Files
+      end
+    end
+  end
+end

lib/slack/web/api/helpers/files.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Helpers
+        module Files
+          #
+          # Uses Slack APIs new sequential file upload flow. This replaces the files.upload method
+          # @see https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay
+          # @see https://api.slack.com/messaging/files#uploading_files
+          #
+          # @option options [string] :filename
+          #   Name of the file being uploaded.
+          # @option options [string] :content
+          #   File contents via a POST variable.
+          # @option options [string] :alt_txt
+          #   Description of image for screen-reader.
+          # @option options [string] :snippet_type
+          #   Syntax type of the snippet being uploaded.
+          # @option options [string] :title
+          #   Title of file.
+          # @option options [string] :channels
+          #   Comma-separated string of channel IDs where the file will be shared. If not specified the file will be private.
+          # @option options [string] :initial_comment
+          #   The message text introducing the file in specified channels.
+          # @option options [string] :thread_ts
+          #   Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead. Also make sure to provide only one channel when using 'thread_ts'.
+          def files_upload_v2(options = {})
+            %i[filename content channels].each do |param|
+              raise ArgumentError, "Required argument :#{param} missing" if options[param].nil?
+            end
+
+            content = options[:content]
+            title = options[:title] || options[:filename]
+
+            upload_url_request_params = options.slice(:filename, :alt_txt, :snippet_type)
+            upload_url_request_params[:length] = content.bytesize
+
+            # 1. get the upload url
+            get_upload_url_response = files_getUploadURLExternal(upload_url_request_params)
+            upload_url = get_upload_url_response[:upload_url]
+            file_id = get_upload_url_response[:file_id]
+
+            # 2. upload the file
+            post(upload_url, content)
+
+            # 3. complete the upload
+            complete_upload_request_params = options.slice(:channels, :initial_comment, :thread_ts)
+            complete_upload_request_params[:files] = [{ id: file_id, title: title }].to_json
+
+            files_completeUploadExternal(complete_upload_request_params)
+          end
+        end
+      end
+    end
+  end
+end

lib/slack/web/client.rb

@@ -5,6 +5,7 @@ class Client
       include Faraday::Connection
       include Faraday::Request
       include Api::Endpoints
+      include Api::Helpers
       include Api::Options
 
       attr_accessor(*Config::ATTRIBUTES)