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 15:30:56 UTC using RuboCop version 1.26.1.
+# on 2025-02-08 15:48:35 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,7 +47,7 @@ Lint/RedundantCopDisableDirective:
 # Offense count: 13
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 62
+  Max: 61
 
 # Offense count: 6
 # Configuration parameters: IgnoredMethods.
@@ -57,7 +57,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 15
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 39
+  Max: 37
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
@@ -69,6 +69,12 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   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:
@@ -100,7 +106,7 @@ RSpec/ContextMethod:
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 67
+# Offense count: 69
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 18
@@ -136,11 +142,6 @@ RSpec/NamedSubject:
 RSpec/NestedGroups:
   Max: 6
 
-# Offense count: 2
-RSpec/RepeatedExample:
-  Exclude:
-    - 'spec/slack/web/api/endpoints/custom_specs/files_spec.rb'
-
 # Offense count: 5
 RSpec/StubbedMock:
   Exclude:
@@ -199,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:

README.md

@@ -178,11 +178,11 @@ This library provides a helper method `files_upload_v2` that wraps the three sep
 ```ruby
 client.files_upload_v2(
   # required options
-  channels: ['C000000', 'C000001'], # channel IDs, one is required (:channel_id, :channel, or :channels are all supported)
   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

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

@@ -53,8 +53,6 @@ def files_upload_v2(params = {})
               complete_upload_request_params[:channel] = conversations_id(
                 channel: params[:channel]
               )['channel']['id']
-            else
-              raise ArgumentError, 'At least one of :channel, :channels, or :channel_id is required'
             end
 
             content = params[:content]

spec/fixtures/slack/web/files_upload_v2.yml

@@ -26,23 +26,34 @@
     end
   end
 
-  it 'requires at least one of :channel, :channels, or :channel_id' do
-    expect do
-      client.files_upload_v2(filename: 'test.txt', content: 'Test File Contents')
-    end.to raise_error ArgumentError, 'At least one of :channel, :channels, or :channel_id is required'
+  context 'without a channel', vcr: { cassette_name: 'web/files_upload_v2' } do
+    it 'completes the upload' do
+      expect(client.files_upload_v2(
+        filename: 'test.txt',
+        content: 'Test File Contents'
+      ).files.size).to eq 1
+    end
   end
 
-  it 'requires only one of :channel or :channels' do
-    expect do
-      client.files_upload_v2(filename: 'test.txt', content: 'Test File Contents', channels: 'C08AZ76CA4V',
-                             channel_id: 'C08AZ76CA4V')
-    end.to raise_error ArgumentError, 'Only one of :channel, :channels, or :channel_id is required'
+  %i[channel channels channel_id].permutation(2).map(&:sort).uniq.each do |permutation|
+    it "requires only one of #{permutation.join(' or ')}" do
+      expect do
+        client.files_upload_v2({
+          filename: 'test.txt',
+          content: 'Test File Contents'
+        }.merge(permutation.map { |arg| [arg, 'C08AZ76CA4V'] }.to_h))
+      end.to raise_error ArgumentError, 'Only one of :channel, :channels, or :channel_id is required'
+    end
   end
 
   it 'requires only one of :channels, or :channel_id' do
     expect do
-      client.files_upload_v2(filename: 'test.txt', content: 'Test File Contents', channels: 'C08AZ76CA4V',
-                             channel_id: 'C08AZ76CA4V')
+      client.files_upload_v2(
+        filename: 'test.txt',
+        content: 'Test File Contents',
+        channels: 'C08AZ76CA4V',
+        channel_id: 'C08AZ76CA4V'
+      )
     end.to raise_error ArgumentError, 'Only one of :channel, :channels, or :channel_id is required'
   end