finch-api 0.1.0.pre.alpha.29 → 0.1.0.pre.alpha.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c13a4af631ebb4f8780ba93cd0678bae144e736eada662e057b3d3c05bdc4d2
-  data.tar.gz: 357f7b8c96ddc548b5337a47dae1bf906d97773a096753752109b054d881a612
+  metadata.gz: '09a37472c2df0d1dda90339c4e6c91ab84b13007ab33b2f96828bcd3a4beb90c'
+  data.tar.gz: 79e5d17efe0478abfef1df54478f1b154700a79b938396fb1f27aa3d672447b4
 SHA512:
-  metadata.gz: 0fb55a12f59529e6c8ee96d440131da38c3d0f1e814a8213a5fb8af64ee4f293fd12e107658b3e24b92dda68d9a7ae386b4f6e43ffe8667cceb292fb70ae8152
-  data.tar.gz: e9a162190490a8d62cea6a1250bd3c775268c0b68e94e56cfbab6ddbac9a31c8355091c98358a8b43d9a996a43c20807ee583f07f360e7745213a3accd157f95
+  metadata.gz: 96672459bc49fafd47b0bdf320c37e7a77bd20f9b53a7bffe5146804fee610d5a8bb4b759245d05103d060df64f334183dd6c60367201ed9c810c59d5dfece82
+  data.tar.gz: 8d1def0d1e9d14743cc3624d05f31c4fbe40207ae94a43651a127fca304a5ab8421b4dc2fcfaffd484d7c3de3d914fe5c344abad3df6c237eca7acc977f98691

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## 0.1.0-alpha.31 (2025-10-27)
+
+Full Changelog: [v0.1.0-alpha.30...v0.1.0-alpha.31](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.30...v0.1.0-alpha.31)
+
+### Features
+
+* **api:** api update ([2c193f3](https://github.com/Finch-API/finch-api-ruby/commit/2c193f3efeec2a63a845a399a8ed678a95e14dd9))
+* **api:** api update ([a463808](https://github.com/Finch-API/finch-api-ruby/commit/a4638080bfdd91ed19083a7cf3f43b1cee5a8568))
+* **api:** api update ([4e526be](https://github.com/Finch-API/finch-api-ruby/commit/4e526befab7e3cc48a0b13cd869ff81df27f9469))
+* **api:** api update ([78a45f9](https://github.com/Finch-API/finch-api-ruby/commit/78a45f95a0ad4dbed56b70c66427c9158933383e))
+* **api:** api update ([61d827e](https://github.com/Finch-API/finch-api-ruby/commit/61d827e756ba40a17532ac75694370b666eed062))
+* **api:** api update ([0d1e8ba](https://github.com/Finch-API/finch-api-ruby/commit/0d1e8baa59306512f78750f4c5bfef9f2d66e0e6))
+* **api:** api update ([31c3661](https://github.com/Finch-API/finch-api-ruby/commit/31c3661fa11d6f74224e9c0af9b5dcee877183ee))
+* **api:** api update ([ab22783](https://github.com/Finch-API/finch-api-ruby/commit/ab2278377aae4058398fa1540df2a16f5cbaf704))
+* **api:** api update ([66b8a64](https://github.com/Finch-API/finch-api-ruby/commit/66b8a6446d12b5222a2408af0de686b94afff297))
+* expose response headers for both streams and errors ([45672bb](https://github.com/Finch-API/finch-api-ruby/commit/45672bb5a1b70d8fc1ea4acf2fa89044284d7fab))
+* handle thread interrupts in the core HTTP client ([97627a2](https://github.com/Finch-API/finch-api-ruby/commit/97627a28d523f0554075ca469e94aae6cc111def))
+
+
+### Bug Fixes
+
+* absolutely qualified uris should always override the default ([96b3cd9](https://github.com/Finch-API/finch-api-ruby/commit/96b3cd9ab133c0bb0b30cc151c9c1e3e1493d97e))
+* always send `filename=...` for multipart requests where a file is expected ([ee2e0ed](https://github.com/Finch-API/finch-api-ruby/commit/ee2e0ed334b365dbc89ec602402310695d48922b))
+* coroutine leaks from connection pool ([ed8c82c](https://github.com/Finch-API/finch-api-ruby/commit/ed8c82c1de78c5416bf2704b2c7208289d5526d6))
+* **internal:** use null byte as file separator in the fast formatting script ([8387c75](https://github.com/Finch-API/finch-api-ruby/commit/8387c751006f4e9832bbfcd87fc22a0e10c1e7cf))
+* shorten multipart boundary sep to less than RFC specificed max length ([df686c5](https://github.com/Finch-API/finch-api-ruby/commit/df686c5b25b82c9f4f44966e087812be37007fbf))
+* should not reuse buffers for `IO.copy_stream` interop ([8ad8c9d](https://github.com/Finch-API/finch-api-ruby/commit/8ad8c9dc1429b38df047ac7a17ebf33eafe84a10))
+
+
+### Performance Improvements
+
+* faster code formatting ([69f9d97](https://github.com/Finch-API/finch-api-ruby/commit/69f9d97f9f857b3b9912e733cb37d8e9ca41af3a))
+
+
+### Chores
+
+* allow fast-format to use bsd sed as well ([b7c6223](https://github.com/Finch-API/finch-api-ruby/commit/b7c6223003113460bef7064164ae2590940c984b))
+* do not install brew dependencies in ./scripts/bootstrap by default ([6faa93e](https://github.com/Finch-API/finch-api-ruby/commit/6faa93ee15839976d987e97701c988940e2a134e))
+* ignore linter error for tests having large collections ([d3f05ab](https://github.com/Finch-API/finch-api-ruby/commit/d3f05ab04c2a228488f57933ea8643913bfa6260))
+
+## 0.1.0-alpha.30 (2025-09-08)
+
+Full Changelog: [v0.1.0-alpha.29...v0.1.0-alpha.30](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.29...v0.1.0-alpha.30)
+
+### Features
+
+* **api:** api update ([a67b714](https://github.com/Finch-API/finch-api-ruby/commit/a67b7140a175c5091a52ef82b90860b39a74075f))
+* **api:** make client id, client secret optional again ([d1b769f](https://github.com/Finch-API/finch-api-ruby/commit/d1b769f81ce16d27fe940f647c19d6f6e4b1b2b4))
+
 ## 0.1.0-alpha.29 (2025-08-24)
 
 Full Changelog: [v0.1.0-alpha.28...v0.1.0-alpha.29](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.28...v0.1.0-alpha.29)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "finch-api", "~> 0.1.0.pre.alpha.29"
+gem "finch-api", "~> 0.1.0.pre.alpha.31"
 ```
 
 <!-- x-release-please-end -->

data/lib/finch_api/errors.rb

@@ -40,6 +40,9 @@ module FinchAPI
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module FinchAPI
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module FinchAPI
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module FinchAPI
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module FinchAPI
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module FinchAPI
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,21 +125,24 @@ module FinchAPI
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
       #
       # @return [self]
-      def self.for(url:, status:, body:, request:, response:, message: nil)
-        kwargs = {
-          url: url,
-          status: status,
-          body: body,
-          request: request,
-          response: response,
-          message: message
-        }
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case status
         in 400
@@ -162,15 +174,17 @@ module FinchAPI
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/finch_api/file_part.rb

@@ -38,18 +38,21 @@ module FinchAPI
     def to_yaml(*a) = read.to_yaml(*a)
 
     # @param content [Pathname, StringIO, IO, String]
-    # @param filename [String, nil]
+    # @param filename [Pathname, String, nil]
     # @param content_type [String, nil]
     def initialize(content, filename: nil, content_type: nil)
-      @content = content
+      @content_type = content_type
       @filename =
-        case content
-        in Pathname
-          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
         else
-          filename.nil? ? nil : ::File.basename(filename)
+          filename
         end
-      @content_type = content_type
     end
   end
 end

data/lib/finch_api/internal/individuals_page.rb

@@ -63,7 +63,7 @@ module FinchAPI
       #
       # @param client [FinchAPI::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/finch_api/internal/page.rb

@@ -63,7 +63,7 @@ module FinchAPI
       #
       # @param client [FinchAPI::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/finch_api/internal/responses_page.rb

@@ -51,7 +51,7 @@ module FinchAPI
       #
       # @param client [FinchAPI::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Array<Object>]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/finch_api/internal/single_page.rb

@@ -48,7 +48,7 @@ module FinchAPI
       #
       # @param client [FinchAPI::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Array<Object>]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/finch_api/internal/transport/base_client.rb

@@ -47,7 +47,7 @@ module FinchAPI
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module FinchAPI
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -378,6 +378,7 @@ module FinchAPI
           rescue FinchAPI::Errors::APIConnectionError => e
             status = e
           end
+          headers = FinchAPI::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -390,7 +391,7 @@ module FinchAPI
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -399,9 +400,9 @@ module FinchAPI
             )
           in FinchAPI::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              FinchAPI::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              FinchAPI::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -409,6 +410,7 @@ module FinchAPI
             raise FinchAPI::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -485,19 +487,21 @@ module FinchAPI
             send_retry_header: send_retry_header
           )
 
-          decoded = FinchAPI::Internal::Util.decode_content(response, stream: stream)
+          headers = FinchAPI::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = FinchAPI::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = FinchAPI::Internal::Util.dig(decoded, unwrap)
             FinchAPI::Internal::Type::Converter.coerce(model, unwrapped)

data/lib/finch_api/internal/transport/pooled_net_requester.rb

@@ -128,37 +128,47 @@ module FinchAPI
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
-          eof = false
           finished = false
-          closing = nil
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
-            with_pool(url, deadline: deadline) do |conn|
-              next if finished
-
-              req, closing = self.class.build_request(request) do
-                self.class.calibrate_socket_timeout(conn, deadline)
-              end
-
-              self.class.calibrate_socket_timeout(conn, deadline)
-              unless conn.started?
-                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
-                conn.start
-              end
+            next if finished
 
-              self.class.calibrate_socket_timeout(conn, deadline)
-              conn.request(req) do |rsp|
-                y << [conn, req, rsp]
-                break if finished
+            with_pool(url, deadline: deadline) do |conn|
+              eof = false
+              closing = nil
+              ::Thread.handle_interrupt(Object => :never) do
+                ::Thread.handle_interrupt(Object => :immediate) do
+                  req, closing = self.class.build_request(request) do
+                    self.class.calibrate_socket_timeout(conn, deadline)
+                  end
 
-                rsp.read_body do |bytes|
-                  y << bytes.force_encoding(Encoding::BINARY)
-                  break if finished
+                  self.class.calibrate_socket_timeout(conn, deadline)
+                  unless conn.started?
+                    conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                    conn.start
+                  end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
+                  conn.request(req) do |rsp|
+                    y << [req, rsp]
+                    break if finished
+
+                    rsp.read_body do |bytes|
+                      y << bytes.force_encoding(Encoding::BINARY)
+                      break if finished
+
+                      self.class.calibrate_socket_timeout(conn, deadline)
+                    end
+                    eof = true
+                  end
+                end
+              ensure
+                begin
+                  conn.finish if !eof && conn&.started?
+                ensure
+                  closing&.call
                 end
-                eof = true
               end
             end
           rescue Timeout::Error
@@ -168,17 +178,10 @@ module FinchAPI
           end
           # rubocop:enable Metrics/BlockLength
 
-          conn, _, response = enum.next
+          _, response = enum.next
           body = FinchAPI::Internal::Util.fused_enum(enum, external: true) do
             finished = true
-            tap do
-              enum.next
-            rescue StopIteration
-              nil
-            end
-          ensure
-            conn.finish if !eof && conn&.started?
-            closing&.call
+            loop { enum.next }
           end
           [Integer(response.code), response, body]
         end

data/lib/finch_api/internal/type/base_page.rb

@@ -39,7 +39,7 @@ module FinchAPI
         #
         # @param client [FinchAPI::Internal::Transport::BaseClient]
         # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client

data/lib/finch_api/internal/type/file_input.rb

@@ -82,17 +82,20 @@ module FinchAPI
           #
           # @return [Pathname, StringIO, IO, String, Object]
           def dump(value, state:)
-            # rubocop:disable Lint/DuplicateBranch
             case value
+            in StringIO | String
+              # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2
+              # while not required, a filename is recommended, and in practice many servers do expect this
+              FinchAPI::FilePart.new(value, filename: "upload")
             in IO
               state[:can_retry] = false
+              value.to_path.nil? ? FinchAPI::FilePart.new(value, filename: "upload") : value
             in FinchAPI::FilePart if value.content.is_a?(IO)
               state[:can_retry] = false
+              value
             else
+              value
             end
-            # rubocop:enable Lint/DuplicateBranch
-
-            value
           end
 
           # @api private

data/lib/finch_api/internal/util.rb

@@ -346,8 +346,9 @@ module FinchAPI
           base_path, base_query = lhs.fetch_values(:path, :query)
           slashed = base_path.end_with?("/") ? base_path : "#{base_path}/"
 
-          parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query)
-          override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path)
+          merged = {**parse_uri(rhs.fetch(:path)), **rhs.except(:path, :query)}
+          parsed_path, parsed_query = merged.fetch_values(:path, :query)
+          override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path)
 
           joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override)
           query = deep_merge(
@@ -473,10 +474,9 @@ module FinchAPI
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
-            buf = String.new
             y.define_singleton_method(:write) do
-              self << buf.replace(_1)
-              buf.bytesize
+              self << _1.dup
+              _1.bytesize
             end
 
             blk.call(y)
@@ -566,7 +566,8 @@ module FinchAPI
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
-          boundary = SecureRandom.urlsafe_base64(60)
+          # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
+          boundary = SecureRandom.urlsafe_base64(46)
 
           closing = []
           strio = writable_enum do |y|
@@ -647,7 +648,7 @@ module FinchAPI
         #
         # Assumes each chunk in stream has `Encoding::BINARY`.
         #
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #

data/lib/finch_api/models/access_token_create_params.rb

@@ -7,23 +7,23 @@ module FinchAPI
       extend FinchAPI::Internal::Type::RequestParameters::Converter
       include FinchAPI::Internal::Type::RequestParameters
 
+      # @!attribute code
+      #   The authorization code received from the authorization server
+      #
+      #   @return [String]
+      required :code, String
+
       # @!attribute client_id
       #   The client ID for your application
       #
-      #   @return [String]
-      required :client_id, String
+      #   @return [String, nil]
+      optional :client_id, String
 
       # @!attribute client_secret
       #   The client secret for your application
       #
-      #   @return [String]
-      required :client_secret, String
-
-      # @!attribute code
-      #   The authorization code received from the authorization server
-      #
-      #   @return [String]
-      required :code, String
+      #   @return [String, nil]
+      optional :client_secret, String
 
       # @!attribute redirect_uri
       #   The redirect URI used in the authorization request (optional)
@@ -31,13 +31,13 @@ module FinchAPI
       #   @return [String, nil]
       optional :redirect_uri, String
 
-      # @!method initialize(client_id:, client_secret:, code:, redirect_uri: nil, request_options: {})
+      # @!method initialize(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
+      #   @param code [String] The authorization code received from the authorization server
+      #
       #   @param client_id [String] The client ID for your application
       #
       #   @param client_secret [String] The client secret for your application
       #
-      #   @param code [String] The authorization code received from the authorization server
-      #
       #   @param redirect_uri [String] The redirect URI used in the authorization request (optional)
       #
       #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]