microsoft_kiota_faraday 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9b4001f18252450bece3bdd2402460aa13dfcaa480220610fec1756170f8f5
-  data.tar.gz: 813405b22fe8212b4660cd9daabc6cd504f26ab0d723e167e0eebebb8a71c74f
+  metadata.gz: 9f13843ff9f2f3f96d01e15c535e94acc80a1e50fdecfa4d28aa4d284c77360a
+  data.tar.gz: d9f9bc30acbeed92f0205606869140c5a1e0f46f1af4bb2f509511ebdd7543bc
 SHA512:
-  metadata.gz: 21b89a9527fbcece787d3c90ad4f64bfe4be8ae57774367025be7bfec531ca23ccb96163a9bd4279655a7366b1a3c3e6ffdb8831194b90cbf557f72e35f6da26
-  data.tar.gz: 8a0e5a5c0c7ccaefbf1fa0d7eb638c73ae2894cdc422098ee59f64e868167155d8e793b910633729a825dcc0ebc00e02c39a0c35892b2da90fc8e4049aadc8fe
+  metadata.gz: e0311088fbe4f243bff7346a99cd947680d45817ac1782c9560954d20ecf745a7cda971083a38ab77c04152895bb7d5e89c614a3bea06ed61d0d7a413e3388d7
+  data.tar.gz: 0f55d1082cfb81d2046a9c85a2631a6204b4a7f3ff348db64de3088fd5e6e8c9c34821aeea02e15a4ebc76d7bf0ae74725d2056056baa7db323ec9f9d018bbd9

data/Gemfile

@@ -2,6 +2,8 @@
 
 source 'https://rubygems.org'
 
+ruby '>= 3.3.0'
+
 gem 'microsoft_kiota_abstractions', path: '../abstractions'
 
 gemspec

data/lib/microsoft_kiota_faraday/faraday_request_adapter.rb

@@ -5,6 +5,7 @@ require 'faraday'
 require 'net/http'
 require 'stringio'
 require_relative 'kiota_client_factory'
+require_relative 'request_body'
 require_relative 'middleware/response_handler_option'
 
 module MicrosoftKiotaFaraday
@@ -148,38 +149,27 @@ module MicrosoftKiotaFaraday
         error_factory = errors_mapping['XXX']
       end
       if error_factory.nil?
-        raise MicrosoftKiotaAbstractions::ApiError,
-              "The server returned an unexpected status code and no error factory is registered for this code:#{status_code}"
+        raise MicrosoftKiotaAbstractions::ApiError.new(
+          "The server returned an unexpected status code and no error factory is registered for this code:#{status_code}",
+          response_status_code: status_code, response_headers: response.headers
+        )
       end
 
       root_node = get_root_parse_node(response)
       error = root_node.get_object_value(error_factory) unless root_node.nil?
-      raise error unless error.nil?
+      if error.nil?
+        raise MicrosoftKiotaAbstractions::ApiError.new("The server returned an unexpected status code:#{status_code}",
+                                                       response_status_code: status_code, response_headers: response.headers)
+      end
 
-      raise MicrosoftKiotaAbstractions::ApiError, "The server returned an unexpected status code:#{status_code}"
+      raise add_response_details(error, response)
     end
 
     def get_request_from_request_info(request_info)
       set_base_url_for_request_information(request_info)
       case request_info.http_method
-      when :GET
-        request = @client.build_request(:get)
-      when :POST
-        request = @client.build_request(:post)
-      when :PATCH
-        request = @client.build_request(:patch)
-      when :DELETE
-        request = @client.build_request(:delete)
-      when :OPTIONS
-        request = @client.build_request(:options)
-      when :CONNECT
-        request = @client.build_request(:connect)
-      when :PUT
-        request = @client.build_request(:put)
-      when :TRACE
-        request = @client.build_request(:trace)
-      when :HEAD
-        request = @client.build_request(:head)
+      when :GET, :POST, :PATCH, :DELETE, :OPTIONS, :CONNECT, :PUT, :TRACE, :HEAD, :QUERY
+        request = @client.build_request(request_info.http_method.downcase)
       else
         raise StandardError, 'unsupported http method'
       end
@@ -196,8 +186,7 @@ module MicrosoftKiotaFaraday
                                end
         end
       end
-      request.body = request_info.content unless request_info.content.nil? || request_info.content.empty?
-      # TODO: the json serialization writer returns a string at the moment, change to body_stream when this is fixed
+      RequestBody.apply(request, request_info.content)
       request_options = request_info.get_request_options
       if !request_options.nil? && !request_options.empty?
         request.options = Faraday::RequestOptions.new if request.options.nil?
@@ -229,5 +218,14 @@ module MicrosoftKiotaFaraday
     def set_base_url_for_request_information(request_info)
       request_info.path_parameters['baseurl'] = @base_url
     end
+
+    # an error the factory built learns the response details only once it is deserialized
+    def add_response_details(error, response)
+      return error unless error.is_a?(MicrosoftKiotaAbstractions::ApiError)
+
+      error.response_status_code = response.status
+      error.response_headers = response.headers
+      error
+    end
   end
 end

data/lib/microsoft_kiota_faraday/request_body.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MicrosoftKiotaFaraday
+  # Faraday sends an IO body as a Net::HTTP body_stream, which needs its length up front, so a
+  # stream is passed through and measured rather than read into memory.
+  module RequestBody
+    FRAMING_HEADERS = %w[Content-Length Transfer-Encoding].freeze
+
+    module_function
+
+    def apply(request, content)
+      # the request owns its framing, so whatever the caller sent is dropped and then set from the
+      # body that is actually written, which leaves every early return below safe
+      FRAMING_HEADERS.each { |header| request.headers.delete(header) }
+      return if content.nil?
+
+      unless content.respond_to?(:read)
+        request.body = content unless content.respond_to?(:empty?) && content.empty?
+        return
+      end
+
+      length = stream_length(content)
+      return if length&.zero?
+
+      if length.nil?
+        request.headers['Transfer-Encoding'] = 'chunked'
+      else
+        request.headers['Content-Length'] = length.to_s
+      end
+      request.body = content
+    end
+
+    # a stream that cannot report a size, such as a pipe or $stdin, is sent chunked instead
+    def stream_length(content)
+      return nil unless content.respond_to?(:size) && content.respond_to?(:pos)
+
+      size = content.size
+      # a stream can be positioned past its end, which leaves nothing to send rather than a
+      # negative number of bytes
+      size.nil? ? nil : [size - content.pos, 0].max
+    rescue StandardError
+      nil
+    end
+  end
+end

data/lib/microsoft_kiota_faraday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MicrosoftKiotaFaraday
-  VERSION = '0.22.0' # x-release-please-version
+  VERSION = '0.24.0' # x-release-please-version
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microsoft_kiota_faraday
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Microsoft Corporation
@@ -35,14 +35,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.24.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ files:
 - lib/microsoft_kiota_faraday/middleware/response_handler_option.rb
 - lib/microsoft_kiota_faraday/middleware/user_agent_handler.rb
 - lib/microsoft_kiota_faraday/middleware/user_agent_option.rb
+- lib/microsoft_kiota_faraday/request_body.rb
 - lib/microsoft_kiota_faraday/version.rb
 - microsoft_kiota_faraday.gemspec
 homepage: https://learn.microsoft.com/openapi/kiota/