microsoft_kiota_faraday 0.23.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0c0c510b70a06940555374f95a4fa8390e439b8219f0c0e2c80305386ec6ae
-  data.tar.gz: ec465be8e91057f9f39e4fe91af9636facb5574ef1c10d130be24d119c650bda
+  metadata.gz: 4a68a845f0887c47484b1e228b72cd33f3cfc8fcffdcfb6f7e3594deba1030ed
+  data.tar.gz: '03395094f438a7bfc4f4711c65b1dafc73587eac817395677ea2e3dc4f9db2bf'
 SHA512:
-  metadata.gz: 36dd13115681ee764d725e0dc955dcc9c9d99d9aa99af434fb4b57a0f022ad999c3d070b4e8365b9c6bcd84a254e8ba9e8d95aefe54ccb58d25b1b5868fdcd61
-  data.tar.gz: 13782fcf9a3e7e0afe85b563d7fe3a59e2826267f1af84e0b04e908bc8d8301b02d8b4dc15505e4e8f57d67e7c0cd1b9008d05e5d886fd5e6bc35d48b77c8fc6
+  metadata.gz: dac37551824aa2f994cd6e2fff4c3cf0cc07c1e461f6204eb62c807c96e00413da6200271e926536fa92e86ee919496d71f5e47cfa93bc2e58b287bc14901aa8
+  data.tar.gz: 4063ca45152405abccb8fa823f4fbc2173bd4950ab33bc164521ce0110df4b67fd9cb0bfbfc1046f1fc92591fe07baf0e165b623d556477adde53a54034e5fc0

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
@@ -140,23 +141,28 @@ module MicrosoftKiotaFaraday
       return if status_code < 400
 
       error_factory = errors_mapping[status_code.to_s] unless errors_mapping.nil?
-      error_factory = errors_mapping['4XX'] unless !error_factory.nil? || errors_mapping.nil? || status_code > 500
-      unless !error_factory.nil? || errors_mapping.nil? || status_code < 500 || status_code > 600
+      error_factory = errors_mapping['4XX'] unless !error_factory.nil? || errors_mapping.nil? || status_code >= 500
+      unless !error_factory.nil? || errors_mapping.nil? || status_code < 500 || status_code >= 600
         error_factory = errors_mapping['5XX']
       end
-      unless !error_factory.nil? || errors_mapping.nil? || status_code < 400 || status_code > 600
+      unless !error_factory.nil? || errors_mapping.nil? || status_code < 400 || status_code >= 600
         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)
@@ -180,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?
@@ -213,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.23.0' # x-release-please-version
+  VERSION = '0.24.1' # 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.23.0
+  version: 0.24.1
 platform: ruby
 authors:
 - Microsoft Corporation
@@ -35,14 +35,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.1
 - !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/