Merge pull request #540 from dblock/support_channel_id_s

Added support for channel and channel_id, do not require channel.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-08 14:50:37 UTC using RuboCop version 1.26.1.
+# on 2025-02-08 15:52:13 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,27 +47,39 @@ Lint/RedundantCopDisableDirective:
 # Offense count: 13
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 42
+  Max: 58
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 11
 
 # Offense count: 15
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 26
+  Max: 35
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 12
+
+# Offense count: 1
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/files_spec.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+Performance/MapCompact:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
 
 # Offense count: 2
 # This cop supports safe auto-correction (--auto-correct).
@@ -94,7 +106,7 @@ RSpec/ContextMethod:
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 67
+# Offense count: 70
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 18
@@ -105,13 +117,13 @@ RSpec/ExampleLength:
 RSpec/FilePath:
   Enabled: false
 
-# Offense count: 69
+# Offense count: 70
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 94
+# Offense count: 95
 RSpec/MultipleExpectations:
   Max: 5
 
@@ -188,6 +200,12 @@ Style/GlobalStdStream:
     - 'spec/integration/integration_spec.rb'
     - 'spec/slack/web/client_spec.rb'
 
+# Offense count: 1
+# This cop supports unsafe auto-correction (--auto-correct-all).
+Style/MapToHash:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom_specs/files_spec.rb'
+
 # Offense count: 1
 Style/MultilineBlockChain:
   Exclude:

CHANGELOG.md

@@ -6,6 +6,7 @@
 * [#530](https://github.com/slack-ruby/slack-ruby-client/pull/530): Specify dependency on `logger` - [@rwstauner](https://github.com/rwstauner).
 * [#533](https://github.com/slack-ruby/slack-ruby-client/pull/533), [#536](https://github.com/slack-ruby/slack-ruby-client/pull/536): Added `files_upload_v2` - [@gregsaab](https://github.com/gregsaab).
 * [#538](https://github.com/slack-ruby/slack-ruby-client/pull/538): Translate channel names and support an array of channels in `files_upload_v2` - [@dblock](https://github.com/dblock).
+* [#540](https://github.com/slack-ruby/slack-ruby-client/pull/540): Added support for `channel` and `channel_id`, do not require channel in `files_upload_v2` - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 ### 2.4.0 (2024/07/14)

README.md

@@ -178,19 +178,19 @@ This library provides a helper method `files_upload_v2` that wraps the three sep
 ```ruby
 client.files_upload_v2(
   # required options
-  channels: 'C000000,C000001', # comma delimited channel ids, only one channel is required
   filename: 'results.pdf', # this is used for the file title, unless a :title option is provided
   contents: File.read('/users/me/results.pdf'), # the string contents of the file
 
   # optional options
+  channels: ['C000000', 'C000001'], # channel IDs to share the file in (:channel_id, :channel, or :channels are all supported)
   initial_comment: 'Sharing the Q1 results :tada:', # the message that is included with the file share thread
   snippet_type: 'text', # the type of snippet
   title: 'Q1 Results', # sets the title of the file, overriding the filename
   thread_ts: '1738331487.481469' # specifies a thread to add this file to
 )
 ```
 
-You can use all of channel ID, an array of channel IDs, or a channel name (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.
+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).
 

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

@@ -19,6 +19,10 @@ module Files
           #   Syntax type of the snippet being uploaded.
           # @option params [string] :title
           #   Title of file.
+          # @option params [string] :channel_id
+          #   Channel ID where the file will be shared. If not specified the file will be private.
+          # @option params [string] :channel
+          #   Channel where the file will be shared, alias of channel_id. If not specified the file will be private.
           # @option params [string] :channels
           #   Comma-separated string of channel IDs where the file will be shared. If not specified the file will be private.
           # @option params [string] :initial_comment
@@ -28,13 +32,26 @@ 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 channels].each do |param|
+            %i[filename content].each do |param|
               raise ArgumentError, "Required argument :#{param} missing" if params[param].nil?
             end
 
-            channels = Array(params[:channels]).map do |channel|
-              conversations_id(channel: channel)['channel']['id']
-            end.uniq.join(',')
+            channel_params = %i[channel channels channel_id].map { |param| params[param] }.compact
+            raise ArgumentError, 'Only one of :channel, :channels, or :channel_id is required' if channel_params.size > 1
+
+            complete_upload_request_params = params.slice(:initial_comment, :thread_ts)
+
+            if params[:channels]
+              complete_upload_request_params[:channels] = Array(params[:channels]).map do |channel|
+                conversations_id(channel: channel)['channel']['id']
+              end.uniq.join(',')
+            elsif params[:channel]
+              complete_upload_request_params[:channel] = conversations_id(
+                channel: params[:channel]
+              )['channel']['id']
+            elsif params[:channel_id]
+              complete_upload_request_params[:channel_id] = params[:channel_id]
+            end
 
             content = params[:content]
             title = params[:title] || params[:filename]
@@ -59,8 +76,6 @@ def files_upload_v2(params = {})
             end
 
             # Complete the upload.
-            complete_upload_request_params = params.slice(:initial_comment, :thread_ts)
-            complete_upload_request_params[:channels] = channels
             complete_upload_request_params[:files] = [{ id: file_id, title: title }].to_json
 
             files_completeUploadExternal(complete_upload_request_params)