Extend id_for page size config to users_id

Author: eizengan

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 * [#549](https://github.com/slack-ruby/slack-ruby-client/pull/549): Add group ID formatting support for message mentions - [@n0h0](https://github.com/n0h0).
 * [#553](https://github.com/slack-ruby/slack-ruby-client/pull/553): Use `secure_compare` during signature verification - [@hieuk09](https://github.com/hieuk09).
-* [#555](https://github.com/slack-ruby/slack-ruby-client/pull/555): Make page size in resolving conversation IDs configurable - [@eizengan](https://github.com/eizengan).
+* [#555](https://github.com/slack-ruby/slack-ruby-client/pull/555): Make page size in resolving IDs configurable - [@eizengan](https://github.com/eizengan).
 * Your contribution here.
 
 ### 2.5.2 (2025/02/19)

README.md

@@ -294,6 +294,7 @@ timeout                      | Optional open/read timeout in seconds.
 open_timeout                 | Optional connection open timeout in seconds.
 default_page_size            | Optional page size for paginated requests, default is _100_.
 conversations_id_page_size   | Optional page size for conversations_list requests made when calculating conversation id from a conversation name, default is _equal to default_page_size_.
+users_id_page_size           | Optional page size for users_list requests made when calculating user id from a user name, default is _equal to default_page_size_.
 default_max_retries          | Optional number of retries for paginated requests, default is _100_.
 adapter                      | Optional HTTP adapter to use, defaults to `Faraday.default_adapter`.
 

lib/slack/web/api/mixins/users.id.rb

@@ -12,11 +12,23 @@ module Users
           #
           # @option options [user] :user
           #   User to get ID for, prefixed with '@'.
+          # @option options [integer] :limit
+          #   The page size used for users_list calls required to find the user's ID
           def users_id(options = {})
             name = options[:user]
+            limit = options.fetch(:limit, users_id_page_size)
+
             raise ArgumentError, 'Required arguments :user missing' if name.nil?
 
-            id_for :user, name, '@', :users_list, :members, 'user_not_found'
+            id_for(
+              :user,
+              name,
+              '@',
+              :users_list,
+              :members,
+              'user_not_found',
+              enum_method_options: { limit: limit }
+            )
           end
         end
       end

lib/slack/web/config.rb

@@ -16,6 +16,7 @@ module Config
         open_timeout
         default_page_size
         conversations_id_page_size
+        users_id_page_size
         default_max_retries
         adapter
       ].freeze
@@ -34,6 +35,7 @@ def reset
         self.open_timeout = nil
         self.default_page_size = 100
         self.conversations_id_page_size = default_page_size
+        self.users_id_page_size = default_page_size
         self.default_max_retries = 100
         self.adapter = ::Faraday.default_adapter
       end

spec/slack/web/api/mixins/users_spec.rb

@@ -13,6 +13,7 @@
   end
 
   before do
+    allow(users).to receive(:users_id_page_size).and_return(100)
     allow(users).to receive(:users_list).and_yield(
       Slack::Messages::Message.new(
         'members' => [{
@@ -33,6 +34,11 @@
       expect(users.users_id(user: '@aws')).to eq('ok' => true, 'user' => { 'id' => 'UDEADBEEF' })
     end
 
+    it 'forwards a provided limit to the underlying users_list calls' do
+      expect(users).to receive(:users_list).with(limit: 1234)
+      users.users_id(user: '@aws', limit: 1234)
+    end
+
     it 'fails with an exception' do
       expect { users.users_id(user: '@foo') }.to(
         raise_error(Slack::Web::Api::Errors::SlackError, 'user_not_found')