id_for enhancements

- avoid unintentional parameter forwarding via limit -> id_limit
- switch to keyword parameters
- deduce error text instead of using argument
- enum_method_options -> options

Author: eizengan

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

@@ -12,22 +12,21 @@ module Conversations
           #
           # @option options [channel] :channel
           #   Channel to get ID for, prefixed with #.
-          # @option options [integer] :limit
+          # @option options [integer] :id_limit
           #   The page size used for conversations_list calls required to find the channel's ID
           def conversations_id(options = {})
             name = options[:channel]
-            limit = options.fetch(:limit, conversations_id_page_size)
+            limit = options.fetch(:id_limit, conversations_id_page_size)
 
             raise ArgumentError, 'Required arguments :channel missing' if name.nil?
 
             id_for(
-              :channel,
-              name,
-              '#',
-              :conversations_list,
-              :channels,
-              'channel_not_found',
-              enum_method_options: { limit: limit }
+              key: :channel,
+              name: name,
+              prefix: '#',
+              enum_method: :conversations_list,
+              list_method: :channels,
+              options: { limit: limit }
             )
           end
         end

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

@@ -6,15 +6,16 @@ module Mixins
         module Ids
           private
 
-          def id_for(key, name, prefix, enum_method, list_method, not_found_error, enum_method_options: {}) # rubocop:disable Metrics/ParameterLists
+          def id_for(key:, name:, prefix:, enum_method:, list_method:, options: {})
             return { 'ok' => true, key.to_s => { 'id' => name } } unless name[0] == prefix
 
-            public_send(enum_method, **enum_method_options) do |list|
+            public_send(enum_method, **options) do |list|
               list.public_send(list_method).each do |li|
                 return Slack::Messages::Message.new('ok' => true, key.to_s => { 'id' => li.id }) if li.name == name[1..-1]
               end
             end
 
+            not_found_error = "#{key}_not_found"
             raise Slack::Web::Api::Errors::SlackError, not_found_error
           end
         end

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

@@ -12,22 +12,21 @@ module Users
           #
           # @option options [user] :user
           #   User to get ID for, prefixed with '@'.
-          # @option options [integer] :limit
+          # @option options [integer] :id_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)
+            limit = options.fetch(:id_limit, users_id_page_size)
 
             raise ArgumentError, 'Required arguments :user missing' if name.nil?
 
             id_for(
-              :user,
-              name,
-              '@',
-              :users_list,
-              :members,
-              'user_not_found',
-              enum_method_options: { limit: limit }
+              key: :user,
+              name: name,
+              prefix: '@',
+              enum_method: :users_list,
+              list_method: :members,
+              options: { limit: limit }
             )
           end
         end

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

@@ -40,7 +40,7 @@
 
     it 'forwards a provided limit to the underlying conversations_list calls' do
       expect(conversations).to receive(:conversations_list).with(limit: 1234)
-      conversations.conversations_id(channel: '#general', limit: 1234)
+      conversations.conversations_id(channel: '#general', id_limit: 1234)
     end
 
     it 'fails with an exception' do

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

@@ -37,7 +37,7 @@
 
     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)
+      users.users_id(user: '@aws', id_limit: 1234)
     end
 
     it 'fails with an exception' do