Merge pull request #544 from dblock/fix-resolve-name

Fix: do not attempt to resolve channel name for APIs that support it.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-09 15:51:54 UTC using RuboCop version 1.26.1.
+# on 2025-02-11 15:48:56 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
@@ -100,13 +100,13 @@ RSpec/ContextMethod:
     - 'spec/slack/messages/formatting_spec.rb'
     - 'spec/slack/web/api/mixins/users_spec.rb'
 
-# Offense count: 83
+# Offense count: 84
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 70
+# Offense count: 72
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 18
@@ -117,13 +117,13 @@ RSpec/ExampleLength:
 RSpec/FilePath:
   Enabled: false
 
-# Offense count: 70
+# Offense count: 74
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 95
+# Offense count: 97
 RSpec/MultipleExpectations:
   Max: 5
 
@@ -142,11 +142,12 @@ RSpec/NamedSubject:
 RSpec/NestedGroups:
   Max: 6
 
-# Offense count: 5
+# Offense count: 6
 RSpec/StubbedMock:
   Exclude:
     - 'spec/slack/real_time/client_spec.rb'
     - 'spec/slack/real_time/event_handlers/event_handlers_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom/conversations_spec.rb'
     - 'spec/slack/web/api/pagination/cursor_spec.rb'
     - 'spec/slack/web/client_spec.rb'
 

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### 2.5.1 (Next)
 
 * [#542](https://github.com/slack-ruby/slack-ruby-client/pull/542): Add support for ruby 3.4 - [@dblock](https://github.com/dblock).
+* [#544](https://github.com/slack-ruby/slack-ruby-client/pull/544): Fix: do not resolve channel name for `chat_postMessage` - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 ### 2.5.0 (2025/02/09)

README.md

@@ -614,15 +614,15 @@ The `verify!` call may raise `Slack::Events::Request::MissingSigningSecret`, `Sl
 
 ### Message Handling
 
-All text in Slack uses the same [system of Formatting and escaping](https://api.slack.com/docs/formatting): chat messages, direct messages, file comments, etc. [Slack::Messages::Formatting](lib/slack/messages/formatting.rb) provides convenience methods to format and parse messages.
+All text in Slack uses the same [system of formatting and escaping](https://api.slack.com/docs/formatting): chat messages, direct messages, file comments, etc. [Slack::Messages::Formatting](lib/slack/messages/formatting.rb) provides convenience methods to format and parse messages.
 
 #### Formatting Messages
 
-`Slack::Messages::Formatting` provides a number of methods for Formatting objects that you can then embed in outgoing messages.
+`Slack::Messages::Formatting` provides a number of methods for formatting objects that you can then embed in outgoing messages.
 
 ##### Date and Time Formatting
 
-You can embed a pre-formatted date in a message as a string like any other text, but using Slack's date Formatting allows you to display dates based on user preferences for dates and times, incorporating users' local time zones, and optionally using relative values like "yesterday", "today", or "tomorrow" when appropriate.
+You can embed a pre-formatted date in a message as a string like any other text, but using Slack's date formatting allows you to display dates based on user preferences for dates and times, incorporating users' local time zones, and optionally using relative values like "yesterday", "today", or "tomorrow" when appropriate.
 
 ```ruby
 date = Time.now
@@ -667,7 +667,7 @@ Slack::Messages::Formatting.user_link(user_id)
 
 ##### URL Formatting
 
-Slack will automatically parse fully qualified URLs in messages, but you need special Formatting to embed a link with different text.
+Slack will automatically parse fully qualified URLs in messages, but you need special formatting to embed a link with different text.
 
 ```ruby
 text = 'party time'
@@ -678,7 +678,7 @@ Slack::Messages::Formatting.url_link(text, url)
 
 ##### Markdown Formatting
 
-Slack uses a mishmash of regular markdown Formatting with its own syntax. Some features like headings aren't supported and will be left as-is, but others like bold, strikethrough, and links are converted.
+Slack uses a mishmash of regular markdown formatting with its own syntax. Some features like headings aren't supported and will be left as-is, but others like bold, strikethrough, and links are converted.
 
 ```ruby
 text = """

lib/slack/web/api/endpoints/chat.rb

@@ -173,7 +173,6 @@ def chat_postEphemeral(options = {})
           def chat_postMessage(options = {})
             raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
             raise ArgumentError, 'At least one of :attachments, :blocks, :text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil?
-            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             options = encode_options_as_json(options, %i[attachments blocks metadata])
             post('chat.postMessage', options)
           end

lib/slack/web/api/templates/method.erb

@@ -48,7 +48,7 @@ module Slack
 <% end %>
 <% if data['group'] == 'groups' && data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
-<% elsif data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
+<% elsif data['args']['channel'] && ['Can be an encoded ID, or a name.', 'encoded ID or channel name'].none? { |desc| data['args']['channel']['desc'].include?(desc) } %>
             options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
 <% end %>
 <% if data['args']['user'] %>

spec/slack/web/api/endpoints/custom/chat_spec.rb

@@ -92,6 +92,18 @@
   end
 
   context 'chat_postMessage' do
+    it 'does not convert channel name to channel ID' do
+      expect(client).not_to receive(:conversations_id)
+      expect(client).to receive(:post).with(
+        'chat.postMessage',
+        {
+          channel: '#channel',
+          text: 'text'
+        }
+      )
+      client.chat_postMessage(channel: '#channel', text: 'text')
+    end
+
     it 'automatically converts attachments and blocks into JSON' do
       expect(client).to receive(:post).with(
         'chat.postMessage',

spec/slack/web/api/endpoints/custom/conversations_spec.rb

@@ -10,4 +10,19 @@
       expect(json.channel.name).to eq 'mpdm-dblock--rubybot--player1-1'
     end
   end
+
+  context 'list' do
+    it 'resolves channel and includes all arguments into http requests' do
+      expect(client).to receive(:conversations_list).and_yield(
+        Slack::Messages::Message.new(
+          'channels' => [{
+            'id' => 'CDEADBEEF',
+            'name' => 'general'
+          }]
+        )
+      )
+      expect(client).to receive(:post).with('conversations.history', { channel: 'CDEADBEEF', limit: 10 })
+      client.conversations_history(channel: '#general', limit: 10)
+    end
+  end
 end