Merge pull request #537 from dblock/2.5.0-connection-options

Refactor pure text connection.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-04 16:47:31 UTC using RuboCop version 1.26.1.
+# on 2025-02-05 16:58:54 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
@@ -188,6 +188,11 @@ Style/GlobalStdStream:
     - 'spec/integration/integration_spec.rb'
     - 'spec/slack/web/client_spec.rb'
 
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
+
 # Offense count: 1
 # This cop supports safe auto-correction (--auto-correct).
 Style/MultilineTernaryOperator:

CHANGELOG.md

@@ -1,11 +1,10 @@
-### 2.4.1 (Next)
+### 2.5.0 (Next)
 
 * [#525](https://github.com/slack-ruby/slack-ruby-client/pull/525): Exclude spec files from gem package - [@amatsuda](https://github.com/amatsuda).
 * [#527](https://github.com/slack-ruby/slack-ruby-client/pull/527): Explicitly require `racc` and `ostruct` - [@dblock](https://github.com/dblock).
 * [#528](https://github.com/slack-ruby/slack-ruby-client/pull/528): Don't treat asterisks in list items as italic in markdown - [@rspeicher](https://github.com/rspeicher).
-* [#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): Added `files_upload_external` - [@gregsaab](https://github.com/gregsaab).
-* [#536](https://github.com/slack-ruby/slack-ruby-client/pull/536): Rename `files_upload_external` to `files_upload_v2` - [@gregsaab](https://github.com/gregsaab).
+* [#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).
 * Your contribution here.
 
 ### 2.4.0 (2024/07/14)

lib/slack-ruby-client.rb

@@ -33,9 +33,8 @@
 require_relative 'slack/web/api/options'
 require_relative 'slack/web/faraday/response/raise_error'
 require_relative 'slack/web/faraday/response/wrap_error'
-require_relative 'slack/web/faraday/connection_options'
+require_relative 'slack/web/faraday/options'
 require_relative 'slack/web/faraday/connection'
-require_relative 'slack/web/faraday/plain_text_connection'
 require_relative 'slack/web/faraday/request'
 require_relative 'slack/web/api/mixins'
 require_relative 'slack/web/api/endpoints'

lib/slack/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Slack
-  VERSION = '2.4.1'
+  VERSION = '2.5.0'
 end

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

@@ -9,33 +9,33 @@ module Files
           # @see https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay
           # @see https://api.slack.com/messaging/files#uploading_files
           #
-          # @option options [string] :filename
+          # @option params [string] :filename
           #   Name of the file being uploaded.
-          # @option options [string] :content
+          # @option params [string] :content
           #   File contents via a POST variable.
-          # @option options [string] :alt_txt
+          # @option params [string] :alt_txt
           #   Description of image for screen-reader.
-          # @option options [string] :snippet_type
+          # @option params [string] :snippet_type
           #   Syntax type of the snippet being uploaded.
-          # @option options [string] :title
+          # @option params [string] :title
           #   Title of file.
-          # @option options [string] :channels
+          # @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 options [string] :initial_comment
+          # @option params [string] :initial_comment
           #   The message text introducing the file in specified channels.
-          # @option options [string] :thread_ts
+          # @option params [string] :thread_ts
           #   Provide another message's ts value to upload this file as a reply.
           #   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(options = {})
+          def files_upload_v2(params = {})
             %i[filename content channels].each do |param|
-              raise ArgumentError, "Required argument :#{param} missing" if options[param].nil?
+              raise ArgumentError, "Required argument :#{param} missing" if params[param].nil?
             end
 
-            content = options[:content]
-            title = options[:title] || options[:filename]
+            content = params[:content]
+            title = params[:title] || params[:filename]
 
-            upload_url_request_params = options.slice(:filename, :alt_txt, :snippet_type)
+            upload_url_request_params = params.slice(:filename, :alt_txt, :snippet_type)
             upload_url_request_params[:length] = content.bytesize
 
             # Get the upload url.
@@ -44,13 +44,18 @@ def files_upload_v2(options = {})
             file_id = get_upload_url_response[:file_id]
 
             # Upload the file.
-            plain_text_connection.post do |request|
-              request.url upload_url
+            ::Faraday::Connection.new(upload_url, options) do |connection|
+              connection.request :multipart
+              connection.request :url_encoded
+              connection.use ::Slack::Web::Faraday::Response::WrapError
+              connection.response :logger, logger if logger
+              connection.adapter adapter
+            end.post do |request|
               request.body = content
             end
 
             # Complete the upload.
-            complete_upload_request_params = options.slice(:channels, :initial_comment, :thread_ts)
+            complete_upload_request_params = params.slice(:channels, :initial_comment, :thread_ts)
             complete_upload_request_params[:files] = [{ id: file_id, title: title }].to_json
 
             files_completeUploadExternal(complete_upload_request_params)

lib/slack/web/client.rb

@@ -3,7 +3,6 @@ module Slack
   module Web
     class Client
       include Faraday::Connection
-      include Faraday::PlainTextConnection
       include Faraday::Request
       include Api::Endpoints
       include Api::Helpers

lib/slack/web/faraday/connection.rb

@@ -3,30 +3,22 @@ module Slack
   module Web
     module Faraday
       module Connection
-        include ConnectionOptions
+        include Slack::Web::Faraday::Options
 
         private
 
-        def options
-          @options ||= begin
-            options = connection_options.dup
-            options[:headers]['Accept'] = 'application/json; charset=utf-8'
-            options
-          end
-        end
-
         def connection
-          @connection ||=
-            ::Faraday::Connection.new(endpoint, options) do |connection|
-              connection.request :multipart
-              connection.request :url_encoded
-              connection.use ::Slack::Web::Faraday::Response::RaiseError
-              connection.response :mashify, mash_class: Slack::Messages::Message
-              connection.response :json, content_type: /\b*$/
-              connection.use ::Slack::Web::Faraday::Response::WrapError
-              connection.response :logger, logger if logger
-              connection.adapter adapter
-            end
+          @connection ||= ::Faraday::Connection.new(endpoint, options) do |connection|
+            connection.headers['Accept'] = 'application/json; charset=utf-8'
+            connection.request :multipart
+            connection.request :url_encoded
+            connection.use ::Slack::Web::Faraday::Response::RaiseError
+            connection.response :mashify, mash_class: Slack::Messages::Message
+            connection.response :json, content_type: /\b*$/
+            connection.use ::Slack::Web::Faraday::Response::WrapError
+            connection.response :logger, logger if logger
+            connection.adapter adapter
+          end
         end
       end
     end

…/slack/web/faraday/connection_options.rb lib/slack/web/faraday/options.rblib/slack/web/faraday/connection_options.rb renamed to lib/slack/web/faraday/options.rb lib/slack/web/faraday/connection_options.rb renamed to lib/slack/web/faraday/options.rb

@@ -2,9 +2,9 @@
 module Slack
   module Web
     module Faraday
-      module ConnectionOptions
-        def connection_options
-          @connection_options ||= begin
+      module Options
+        def options
+          @options ||= begin
             options = { headers: {} }
             options[:headers]['User-Agent'] = user_agent if user_agent
             options[:proxy] = proxy if proxy