Merge pull request #567 from dblock/fix-files-upload-v2-multiple-files

Add support for multiple files in files_upload_v2 method

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-11 15:48:56 UTC using RuboCop version 1.26.1.
+# on 2025-07-19 11:04:04 UTC using RuboCop version 1.26.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -47,17 +47,17 @@ Lint/RedundantCopDisableDirective:
 # Offense count: 13
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 58
+  Max: 67
 
 # Offense count: 6
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 11
+  Max: 15
 
-# Offense count: 15
+# Offense count: 17
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 35
+  Max: 45
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
@@ -67,12 +67,13 @@ Metrics/ParameterLists:
 # Offense count: 3
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 12
+  Max: 17
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: MinSize.
 Performance/CollectionLiteralInLoop:
   Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
     - 'spec/slack/web/api/endpoints/custom/files_spec.rb'
 
 # Offense count: 1
@@ -93,20 +94,20 @@ Performance/StringInclude:
   Exclude:
     - 'lib/tasks/web.rake'
 
-# Offense count: 9
+# Offense count: 10
 # This cop supports safe auto-correction (--auto-correct).
 RSpec/ContextMethod:
   Exclude:
     - 'spec/slack/messages/formatting_spec.rb'
     - 'spec/slack/web/api/mixins/users_spec.rb'
 
-# Offense count: 84
+# Offense count: 86
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 72
+# Offense count: 75
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 18
@@ -117,13 +118,13 @@ RSpec/ExampleLength:
 RSpec/FilePath:
   Enabled: false
 
-# Offense count: 74
+# Offense count: 86
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 97
+# Offense count: 103
 RSpec/MultipleExpectations:
   Max: 5
 
@@ -151,7 +152,7 @@ RSpec/StubbedMock:
     - 'spec/slack/web/api/pagination/cursor_spec.rb'
     - 'spec/slack/web/client_spec.rb'
 
-# Offense count: 2
+# Offense count: 14
 RSpec/SubjectStub:
   Exclude:
     - 'spec/slack/web/api/mixins/conversations_spec.rb'
@@ -232,6 +233,14 @@ Style/OptionalBooleanParameter:
   Exclude:
     - 'spec/support/queue_with_timeout.rb'
 
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
+
 # Offense count: 1
 # This cop supports unsafe auto-correction (--auto-correct-all).
 Style/SlicingWithRange:

CHANGELOG.md

@@ -4,6 +4,7 @@
 * [#559](https://github.com/slack-ruby/slack-ruby-client/pull/559): Enable name-to-id translation of non-public channels - [@eizengan](https://github.com/eizengan).
 * [#560](https://github.com/slack-ruby/slack-ruby-client/pull/560): Name-to-id translation can supply all sensible list options - [@eizengan](https://github.com/eizengan).
 * [#561](https://github.com/slack-ruby/slack-ruby-client/issues/563): Raise InvalidSignature when verifying a request without a signature - [@wesleyjellis](https://github.com/wesleyjellis).
+* [#567](https://github.com/slack-ruby/slack-ruby-client/pull/567): Add support for multiple files in `files_upload_v2` - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 ### 2.6.0 (2025/05/24)

CONTRIBUTING.md

@@ -27,7 +27,7 @@ bundle exec rake
 
 ### Run Examples in Development
 
-Sign up for Slack, create a private Slack team for yourself, then [generate an API token](https://api.slack.com/tutorials/tracks/getting-a-token) for your app and use it for some interactions.
+Sign up for Slack, create a private Slack team for yourself, then [generate an API token](https://api.slack.com/tutorials/tracks/getting-a-token) for your app and use it for some interactions. To get a token you will need to install the app in a workspace, and use the "User OAuth Token" from installed app settings.
 
 Try running the examples in the [examples](examples) directory.
 

README.md

@@ -173,6 +173,8 @@ Upload files with [sequenced API calls](https://api.slack.com/messaging/files#up
 
 This library provides a helper method `files_upload_v2` that wraps the three separate API calls.
 
+Upload a single file.
+
 ```ruby
 client.files_upload_v2(
   # required options
@@ -188,6 +190,19 @@ client.files_upload_v2(
 )
 ```
 
+Upload multiple files.
+
+```ruby
+client.files_upload_v2(
+  files: [
+    { filename: 'report.pdf', content: File.read('/users/me/report.pdf'), title: 'Monthly Report' },
+    { filename: 'data.csv', content: File.read('/users/me/data.csv'), title: 'Raw Data' }
+  ],
+  channels: ['#general'],
+  initial_comment: 'Here are the monthly results!'
+)
+```
+
 You can use a channel ID passed as `channel_id`, a single channel as `channel`, an array of channel IDs as `channels`, or a channel name or names (prefixed with `#`) in `files_upload_v2`. Lookup by name is not supported by the Slack API and this method called invokes `conversations_list` in order to locate the channel ID. This invocation can have a cost if you have many Slack channels and is only recommended when you intend to list channels anyway.
 
 Note: This library includes a `files_upload` method that uses a deprecated endpoint `files.upload` that will [no longer be supported on 3/11/2025](https://api.slack.com/methods/files.upload#markdown).

examples/files_upload_v2/files_upload_v2.rb

@@ -35,3 +35,11 @@
   content: SecureRandom.hex,
   channel_id: channel_id
 ).files.first.permalink_public
+
+client.files_upload_v2(
+  files: [
+    { filename: 'files_upload_v2_to_general_first_file.txt', content: SecureRandom.hex },
+    { filename: 'files_upload_v2_to_general_second_file.txt', content: SecureRandom.hex }
+  ],
+  channels: ['#general']
+).files.each { |file| puts file.permalink_public }

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

@@ -13,6 +13,8 @@ module Files
           #   Name of the file being uploaded.
           # @option params [string] :content
           #   File contents via a POST variable.
+          # @option params [Array<Hash>] :files
+          #   Array of file objects with :filename, :content, and optionally :title, :alt_txt, :snippet_type.
           # @option params [string] :alt_txt
           #   Description of image for screen-reader.
           # @option params [string] :snippet_type
@@ -32,8 +34,16 @@ module Files
           #   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(params = {})
-            %i[filename content].each do |param|
-              raise ArgumentError, "Required argument :#{param} missing" if params[param].nil?
+            files_to_upload = if params[:files] && params[:files].is_a?(Array)
+                                params[:files]
+                              else
+                                [params.slice(:filename, :content, :title, :alt_txt, :snippet_type)]
+                              end
+
+            files_to_upload.each_with_index do |file, index|
+              %i[filename content].each do |param|
+                raise ArgumentError, "Required argument :#{param} missing in file (#{index})" if file[param].nil?
+              end
             end
 
             channel_params = %i[channel channels channel_id].map { |param| params[param] }.compact
@@ -53,31 +63,31 @@ def files_upload_v2(params = {})
               complete_upload_request_params[:channel_id] = params[:channel_id]
             end
 
-            content = params[:content]
-            title = params[:title] || params[:filename]
+            uploaded_files = files_to_upload.map do |file|
+              content = file[:content]
+              title = file[:title] || file[:filename]
 
-            upload_url_request_params = params.slice(:filename, :alt_txt, :snippet_type)
-            upload_url_request_params[:length] = content.bytesize
+              upload_url_request_params = file.slice(:filename, :alt_txt, :snippet_type)
+              upload_url_request_params[:length] = content.bytesize
 
-            # 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]
+              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]
 
-            # Upload the file.
-            ::Faraday::Connection.new(upload_url, options) do |connection|
-              connection.request :multipart
-              connection.request :url_encoded
-              connection.use ::Slack::Web::Faraday::Response::WrapError
-              connection.response :logger, logger if logger
-              connection.adapter adapter
-            end.post do |request|
-              request.body = content
-            end
+              ::Faraday::Connection.new(upload_url, options) do |connection|
+                connection.request :multipart
+                connection.request :url_encoded
+                connection.use ::Slack::Web::Faraday::Response::WrapError
+                connection.response :logger, logger if logger
+                connection.adapter adapter
+              end.post do |request|
+                request.body = content
+              end
 
-            # Complete the upload.
-            complete_upload_request_params[:files] = [{ id: file_id, title: title }].to_json
+              { id: file_id, title: title }
+            end
 
+            complete_upload_request_params[:files] = uploaded_files.to_json
             files_completeUploadExternal(complete_upload_request_params)
           end
         end