gapic-common 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2760df5ba60e10af0fcea12a09d984b020d5dde80a2969cef159272a1e766731
-  data.tar.gz: ad50bd4473dbf92bd8f31cdcaa0ab87bb08d53c359fc45f7b4f335bac0bcc56c
+  metadata.gz: 0c3c4ee7ceef8f5caf7cf84304f6601ed730abd75089f3d7e5305bf2efaefed7
+  data.tar.gz: 424864e640f307cbfc00829fdcdcfd83899032b4babd9eabf5cbfdbf827b3da2
 SHA512:
-  metadata.gz: ffd0f60edffb9a9d57113d13d46300d7da0102291d10977f5e900baf482a9c2822180a75460e0079e457dca861cd0bc9af15cc80694021de5c1ab9ad23b2c7a3
-  data.tar.gz: ed5d777bdb4ae4359b3fb6b1ee1b12e751541b565b08fdeacc4f698caeac878b7a3a540b2004bf63b7bb8a063da51620e7892ac5bcae98234ff969e804456cc7
+  metadata.gz: fd2c71656a97d36f9f92f64c56cde7e6f9d8b63afa9602c12bbc0f9f8bfcf775e24729893839fc498de2e0629e592fcc56890d614d8ed8c0989c11d3dc11872c
+  data.tar.gz: c6bb5cdef2186ba06191504fcf5d04ae8aac41820d03da16695d9d4e1a891ff5bdad8338598c339c5963ae9ef6816c457d15a28f26e92e4cc72b91b6a3d39d1a

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Release History
 
+### 0.12.0 (2022-09-15)
+
+#### Features
+
+* Support numeric_enums in the ClientStub ([#817](https://github.com/googleapis/gapic-generator-ruby/issues/817)) 
+* parse details information from REST errors  ([#815](https://github.com/googleapis/gapic-generator-ruby/issues/815)) 
+* send protobuf version in headers ([#816](https://github.com/googleapis/gapic-generator-ruby/issues/816)) 
+
+#### Bug Fixes
+
+* rewrap certain grpc errors ([#810](https://github.com/googleapis/gapic-generator-ruby/issues/810)) 
+  This will rewrap some GRPC::Unavailable errors that were caused by authentication failing as Gapic::GRPC::AuthorizationError which inherits from ::GRPC::Unauthenticated
+
+### 0.11.1 (2022-08-03)
+
+#### Bug Fixes
+
+* error code of 0 is not an error, body template field can be nil ([#805](https://github.com/googleapis/gapic-generator-ruby/issues/805)) 
+
 ### 0.11.0 (2022-07-27)
 
 #### Features

data/lib/gapic/call_options/retry_policy.rb

@@ -132,7 +132,7 @@ module Gapic
       private
 
       def retry? error
-        error.is_a?(GRPC::BadStatus) && retry_codes.include?(error.code)
+        error.is_a?(::GRPC::BadStatus) && retry_codes.include?(error.code)
       end
 
       def delay!

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.11.0".freeze
+    VERSION = "0.12.0".freeze
   end
 end

data/lib/gapic/generic_lro/operation.rb

@@ -140,7 +140,8 @@ module Gapic
       # @return [Boolean] Whether an error has been returned.
       #
       def error?
-        done? && (!err.nil? || !error_code.nil?)
+        no_error_code = error_code.nil? || error_code.zero?
+        done? && !(err.nil? && no_error_code)
       end
 
       ##

data/lib/gapic/grpc/errors.rb

@@ -0,0 +1,60 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "googleauth"
+require "gapic/common/error"
+
+module Gapic
+  module GRPC
+    ##
+    # An error class to represent the Authorization Error.
+    # The GRPC layer wraps auth plugin errors in ::GRPC::Unavailable.
+    # This class rewraps those GRPC layer errors, presenting a correct status code.
+    #
+    class AuthorizationError < ::GRPC::Unauthenticated
+    end
+
+    ##
+    # An error class that represents Deadline Exceeded error with an optional
+    # retry root cause.
+    #
+    # The GRPC layer throws ::GRPC::DeadlineExceeded without any context.
+    # If the deadline was exceeded while retrying another exception (e.g.
+    # ::GRPC::Unavailable), that exception could be useful for understanding
+    # the readon for the timeout.
+    #
+    # This exception rewraps ::GRPC::DeadlineExceeded, adding an exception
+    # that was being retried until the deadline was exceeded (if any) as a
+    # `root_cause` attribute.
+    #
+    # @!attribute [r] root_cause
+    #   @return [Object, nil] The exception that was being retried
+    #     when the DeadlineExceeded error occured.
+    #
+    class DeadlineExceededError < ::GRPC::DeadlineExceeded
+      attr_reader :root_cause
+
+      ##
+      # @param message [String] The error message.
+      #
+      # @param root_cause [Object, nil] The exception that was being retried
+      #   when the DeadlineExceeded error occured.
+      #
+      def initialize message, root_cause: nil
+        super message
+        @root_cause = root_cause
+      end
+    end
+  end
+end

data/lib/gapic/grpc/service_stub/rpc_call.rb

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require "gapic/call_options"
+require "grpc/errors"
 
 module Gapic
   class ServiceStub
@@ -45,7 +46,7 @@ module Gapic
       #
       # @yield [response, operation] Access the response along with the RPC operation.
       # @yieldparam response [Object] The response object.
-      # @yieldparam operation [GRPC::ActiveCall::Operation] The RPC operation for the response.
+      # @yieldparam operation [::GRPC::ActiveCall::Operation] The RPC operation for the response.
       #
       # @return [Object] The response object.
       #
@@ -55,7 +56,7 @@ module Gapic
       #   require "gapic"
       #   require "gapic/grpc"
       #
-      #   echo_channel = GRPC::Core::Channel.new(
+      #   echo_channel = ::GRPC::Core::Channel.new(
       #     "localhost:7469", nil, :this_channel_is_insecure
       #   )
       #   echo_stub = Gapic::ServiceStub.new(
@@ -73,7 +74,7 @@ module Gapic
       #   require "gapic"
       #   require "gapic/grpc"
       #
-      #   echo_channel = GRPC::Core::Channel.new(
+      #   echo_channel = ::GRPC::Core::Channel.new(
       #     "localhost:7469", nil, :this_channel_is_insecure
       #   )
       #   echo_stub = Gapic::ServiceStub.new(
@@ -85,7 +86,7 @@ module Gapic
       #   request = Google::Showcase::V1beta1::EchoRequest.new
       #   options = Gapic::CallOptions.new(
       #     retry_policy = {
-      #       retry_codes: [GRPC::Core::StatusCodes::UNAVAILABLE]
+      #       retry_codes: [::GRPC::Core::StatusCodes::UNAVAILABLE]
       #     }
       #   )
       #   response = echo_call.call request, options: options
@@ -96,7 +97,7 @@ module Gapic
       #   require "gapic"
       #   require "gapic/grpc"
       #
-      #   echo_channel = GRPC::Core::Channel.new(
+      #   echo_channel = ::GRPC::Core::Channel.new(
       #     "localhost:7469", nil, :this_channel_is_insecure
       #   )
       #   echo_stub = Gapic::ServiceStub.new(
@@ -116,13 +117,23 @@ module Gapic
         deadline = calculate_deadline options
         metadata = options.metadata
 
+        retried_exception = nil
         begin
           operation = stub_method.call request, deadline: deadline, metadata: metadata, return_op: true
           response = operation.execute
           yield response, operation if block_given?
           response
+        rescue ::GRPC::DeadlineExceeded => e
+          raise Gapic::GRPC::DeadlineExceededError.new e.message, root_cause: retried_exception
         rescue StandardError => e
-          retry if check_retry?(deadline) && options.retry_policy.call(e)
+          if e.is_a?(::GRPC::Unavailable) && /Signet::AuthorizationError/ =~ e.message
+            e = Gapic::GRPC::AuthorizationError.new e.message.gsub(%r{^\d+:}, "")
+          end
+
+          if check_retry?(deadline) && options.retry_policy.call(e)
+            retried_exception = e
+            retry
+          end
 
           raise e
         end

data/lib/gapic/grpc/service_stub.rb

@@ -34,20 +34,20 @@ module Gapic
     # @param grpc_stub_class [Class] gRPC stub class to create a new instance of.
     # @param endpoint [String] The endpoint of the API.
     # @param credentials [Google::Auth::Credentials, Signet::OAuth2::Client, String, Hash, Proc,
-    #   GRPC::Core::Channel, GRPC::Core::ChannelCredentials] Provides the means for authenticating requests made by
+    #   ::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] Provides the means for authenticating requests made by
     #   the client. This parameter can be many types:
     #
     #   * A `Google::Auth::Credentials` uses a the properties of its represented keyfile for authenticating requests
     #     made by this client.
     #   * A `Signet::OAuth2::Client` object used to apply the OAuth credentials.
-    #   * A `GRPC::Core::Channel` will be used to make calls through.
-    #   * A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials should
-    #     already be composed with a `GRPC::Core::CallCredentials` object.
+    #   * A `::GRPC::Core::Channel` will be used to make calls through.
+    #   * A `::GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials should
+    #     already be composed with a `::GRPC::Core::CallCredentials` object.
     #   * A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for
     #     requests, generally, to give OAuth credentials.
     # @param channel_args [Hash] The channel arguments. (This argument is ignored when `credentials` is
-    #     provided as a `GRPC::Core::Channel`.)
-    # @param interceptors [Array<GRPC::ClientInterceptor>] An array of {GRPC::ClientInterceptor} objects that will
+    #     provided as a `::GRPC::Core::Channel`.)
+    # @param interceptors [Array<::GRPC::ClientInterceptor>] An array of {::GRPC::ClientInterceptor} objects that will
     #   be used for intercepting calls before they are executed Interceptors are an EXPERIMENTAL API.
     #
     def initialize grpc_stub_class, endpoint:, credentials:, channel_args: nil, interceptors: nil
@@ -59,10 +59,10 @@ module Gapic
       interceptors = Array interceptors
 
       @grpc_stub = case credentials
-                   when GRPC::Core::Channel
+                   when ::GRPC::Core::Channel
                      grpc_stub_class.new endpoint, nil, channel_override: credentials,
                                                         interceptors:     interceptors
-                   when GRPC::Core::ChannelCredentials, Symbol
+                   when ::GRPC::Core::ChannelCredentials, Symbol
                      grpc_stub_class.new endpoint, credentials, channel_args: channel_args,
                                                                 interceptors: interceptors
                    else
@@ -70,8 +70,8 @@ module Gapic
                      updater_proc ||= credentials if credentials.is_a? Proc
                      raise ArgumentError, "invalid credentials (#{credentials.class})" if updater_proc.nil?
 
-                     call_creds = GRPC::Core::CallCredentials.new updater_proc
-                     chan_creds = GRPC::Core::ChannelCredentials.new.compose call_creds
+                     call_creds = ::GRPC::Core::CallCredentials.new updater_proc
+                     chan_creds = ::GRPC::Core::ChannelCredentials.new.compose call_creds
                      grpc_stub_class.new endpoint, chan_creds, channel_args: channel_args,
                                                                interceptors: interceptors
                    end
@@ -88,7 +88,7 @@ module Gapic
     #
     # @yield [response, operation] Access the response along with the RPC operation.
     # @yieldparam response [Object] The response object.
-    # @yieldparam operation [GRPC::ActiveCall::Operation] The RPC operation for the response.
+    # @yieldparam operation [::GRPC::ActiveCall::Operation] The RPC operation for the response.
     #
     # @return [Object] The response object.
     #
@@ -98,7 +98,7 @@ module Gapic
     #   require "gapic"
     #   require "gapic/grpc"
     #
-    #   echo_channel = GRPC::Core::Channel.new(
+    #   echo_channel = ::GRPC::Core::Channel.new(
     #     "localhost:7469", nil, :this_channel_is_insecure
     #   )
     #   echo_stub = Gapic::ServiceStub.new(
@@ -115,7 +115,7 @@ module Gapic
     #   require "gapic"
     #   require "gapic/grpc"
     #
-    #   echo_channel = GRPC::Core::Channel.new(
+    #   echo_channel = ::GRPC::Core::Channel.new(
     #     "localhost:7469", nil, :this_channel_is_insecure
     #   )
     #   echo_stub = Gapic::ServiceStub.new(
@@ -126,7 +126,7 @@ module Gapic
     #   request = Google::Showcase::V1beta1::EchoRequest.new
     #   options = Gapic::CallOptions.new(
     #     retry_policy = {
-    #       retry_codes: [GRPC::Core::StatusCodes::UNAVAILABLE]
+    #       retry_codes: [::GRPC::Core::StatusCodes::UNAVAILABLE]
     #     }
     #   )
     #   response = echo_stub.call_rpc :echo, request
@@ -138,7 +138,7 @@ module Gapic
     #   require "gapic"
     #   require "gapic/grpc"
     #
-    #   echo_channel = GRPC::Core::Channel.new(
+    #   echo_channel = ::GRPC::Core::Channel.new(
     #     "localhost:7469", nil, :this_channel_is_insecure
     #   )
     #   echo_stub = Gapic::ServiceStub.new(

data/lib/gapic/grpc.rb

@@ -13,5 +13,6 @@
 # limitations under the License.
 
 require "grpc"
+require "gapic/grpc/errors"
 require "gapic/grpc/service_stub"
 require "gapic/grpc/status_details"

data/lib/gapic/headers.rb

@@ -25,7 +25,7 @@ module Gapic
     # @param lib_version [String] The client library version.
     # @param gax_version [String] The Gapic version. Defaults to `Gapic::Common::VERSION`.
     # @param gapic_version [String] The Gapic version.
-    # @param grpc_version [String] The GRPC version. Defaults to `GRPC::VERSION`.
+    # @param grpc_version [String] The GRPC version. Defaults to `::GRPC::VERSION`.
     # @param rest_version [String] The Rest Library (Faraday) version. Defaults to `Faraday::VERSION`.
     # @param transports_version_send [Array] Which transports to send versions for.
     #   Allowed values to contain are:
@@ -33,13 +33,14 @@ module Gapic
     #     `:rest` to send the REST library version (if defined)
     #   Defaults to `[:grpc]`
     def self.x_goog_api_client ruby_version: nil, lib_name: nil, lib_version: nil, gax_version: nil,
-                               gapic_version: nil, grpc_version: nil, rest_version: nil,
+                               gapic_version: nil, grpc_version: nil, rest_version: nil, protobuf_version: nil,
                                transports_version_send: [:grpc]
 
       ruby_version ||= ::RUBY_VERSION
       gax_version  ||= ::Gapic::Common::VERSION
       grpc_version ||= ::GRPC::VERSION if defined? ::GRPC::VERSION
-      rest_version ||= ::Faraday::VERSION if defined? ::Faraday
+      rest_version ||= ::Faraday::VERSION if defined? ::Faraday::VERSION
+      protobuf_version ||= Gem.loaded_specs["google-protobuf"].version.to_s if Gem.loaded_specs.key? "google-protobuf"
 
       x_goog_api_client_header = ["gl-ruby/#{ruby_version}"]
       x_goog_api_client_header << "#{lib_name}/#{lib_version}" if lib_name
@@ -47,6 +48,7 @@ module Gapic
       x_goog_api_client_header << "gapic/#{gapic_version}" if gapic_version
       x_goog_api_client_header << "grpc/#{grpc_version}" if grpc_version && transports_version_send.include?(:grpc)
       x_goog_api_client_header << "rest/#{rest_version}" if rest_version && transports_version_send.include?(:rest)
+      x_goog_api_client_header << "pb/#{protobuf_version}" if protobuf_version
       x_goog_api_client_header.join " ".freeze
     end
   end

data/lib/gapic/paged_enumerable.rb

@@ -53,7 +53,7 @@ module Gapic
     # @param method_name [Symbol] The RPC method name.
     # @param request [Object] The request object.
     # @param response [Object] The response object.
-    # @param operation [GRPC::ActiveCall::Operation] The RPC operation for the response.
+    # @param operation [::GRPC::ActiveCall::Operation] The RPC operation for the response.
     # @param options [Gapic::CallOptions] The options for making the RPC call.
     # @param format_resource [Proc] A Proc object to format the resource object. The Proc should accept response as an
     #   argument, and return a formatted resource object. Optional.
@@ -195,7 +195,7 @@ module Gapic
     # @attribute [r] response
     #   @return [Object] the response object for the page.
     # @attribute [r] operation
-    #   @return [GRPC::ActiveCall::Operation] the RPC operation for the page.
+    #   @return [::GRPC::ActiveCall::Operation] the RPC operation for the page.
     class Page
       include Enumerable
       attr_reader :response
@@ -205,7 +205,7 @@ module Gapic
       # @private
       # @param response [Object] The response object for the page.
       # @param resource_field [String] The name of the field in response which holds the resources.
-      # @param operation [GRPC::ActiveCall::Operation] the RPC operation for the page.
+      # @param operation [::GRPC::ActiveCall::Operation] the RPC operation for the page.
       # @param format_resource [Proc] A Proc object to format the resource object. The Proc should accept response as an
       #   argument, and return a formatted resource object. Optional.
       #

data/lib/gapic/rest/client_stub.rb

@@ -32,15 +32,17 @@ module Gapic
       # @param credentials [Google::Auth::Credentials]
       #   Credentials to send with calls in form of a googleauth credentials object.
       #   (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+      # @param numeric_enums [Boolean] Whether to signal the server to JSON-encode enums as ints
       #
       # @yield [Faraday::Connection]
       #
-      def initialize endpoint:, credentials:
+      def initialize endpoint:, credentials:, numeric_enums: false
         @endpoint = endpoint
         @endpoint = "https://#{endpoint}" unless /^https?:/.match? endpoint
         @endpoint = @endpoint.sub %r{/$}, ""
 
         @credentials = credentials
+        @numeric_enums = numeric_enums
 
         @connection = Faraday.new url: @endpoint do |conn|
           conn.headers = { "Content-Type" => "application/json" }
@@ -58,8 +60,8 @@ module Gapic
       #
       # @param uri [String] uri to send this request to
       # @param params [Hash] query string parameters for the request
-      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
-      #   Currently only timeout and headers are supported.
+      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
+      #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
       def make_get_request uri:, params: {}, options: {}
         make_http_request :get, uri: uri, body: nil, params: params, options: options
@@ -70,8 +72,8 @@ module Gapic
       #
       # @param uri [String] uri to send this request to
       # @param params [Hash] query string parameters for the request
-      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
-      #   Currently only timeout and headers are supported.
+      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
+      #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
       def make_delete_request uri:, params: {}, options: {}
         make_http_request :delete, uri: uri, body: nil, params: params, options: options
@@ -83,8 +85,8 @@ module Gapic
       # @param uri [String] uri to send this request to
       # @param body [String] a body to send with the request, nil for requests without a body
       # @param params [Hash] query string parameters for the request
-      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
-      #   Currently only timeout and headers are supported.
+      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
+      #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
       def make_patch_request uri:, body:, params: {}, options: {}
         make_http_request :patch, uri: uri, body: body, params: params, options: options
@@ -96,8 +98,8 @@ module Gapic
       # @param uri [String] uri to send this request to
       # @param body [String] a body to send with the request, nil for requests without a body
       # @param params [Hash] query string parameters for the request
-      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
-      #   Currently only timeout and headers are supported.
+      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
+      #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
       def make_post_request uri:, body: nil, params: {}, options: {}
         make_http_request :post, uri: uri, body: body, params: params, options: options
@@ -109,8 +111,8 @@ module Gapic
       # @param uri [String] uri to send this request to
       # @param body [String] a body to send with the request, nil for requests without a body
       # @param params [Hash] query string parameters for the request
-      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
-      #   Currently only timeout and headers are supported.
+      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
+      #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
       def make_put_request uri:, body: nil, params: {}, options: {}
         make_http_request :put, uri: uri, body: body, params: params, options: options
@@ -123,10 +125,14 @@ module Gapic
       # @param uri [String] uri to send this request to
       # @param body [String, nil] a body to send with the request, nil for requests without a body
       # @param params [Hash] query string parameters for the request
-      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
-      #   Currently only timeout and headers are supported.
+      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
+      #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
       def make_http_request verb, uri:, body:, params:, options:
+        if @numeric_enums && (!params.key?("$alt") || params["$alt"] == "json")
+          params = params.merge({ "$alt" => "json;enum-encoding=int" })
+        end
+        options = ::Gapic::CallOptions.new(**options.to_h) unless options.is_a? ::Gapic::CallOptions
         @connection.send verb, uri do |req|
           req.params = params if params.any?
           req.body = body unless body.nil?

data/lib/gapic/rest/error.rb

@@ -19,16 +19,30 @@ module Gapic
   module Rest
     # Gapic REST exception class
     class Error < ::Gapic::Common::Error
-      # @return [Integer] the http status code for the error
+      # @return [Integer, nil] the http status code for the error
       attr_reader :status_code
+      # @return [Object, nil] the text representation of status as parsed from the response body
+      attr_reader :status
+      # @return [Object, nil] the details as parsed from the response body
+      attr_reader :details
+      # @return [Object, nil] the headers of the REST error
+      attr_reader :headers
+      # The Cloud error wrapper expect to see a `header` property
+      alias header headers
 
       ##
       # @param message [String, nil] error message
       # @param status_code [Integer, nil] HTTP status code of this error
+      # @param status [String, nil] The text representation of status as parsed from the response body
+      # @param details [Object, nil] Details data of this error
+      # @param headers [Object, nil] Http headers data of this error
       #
-      def initialize message, status_code
-        @status_code = status_code
+      def initialize message, status_code, status: nil, details: nil, headers: nil
         super message
+        @status_code = status_code
+        @status = status
+        @details = details
+        @headers = headers
       end
 
       class << self
@@ -37,36 +51,85 @@ module Gapic
         # it tries to parse and set a detailed message and an error code from
         # from the Google Cloud's response body
         #
+        # @param err [Faraday::Error] the Faraday error to wrap
+        #
+        # @return [ Gapic::Rest::Error]
         def wrap_faraday_error err
           message = err.message
           status_code = err.response_status
+          status = nil
+          details = nil
+          headers = err.response_headers
 
           if err.response_body
-            msg, code = try_parse_from_body err.response_body
+            msg, code, status, details = try_parse_from_body err.response_body
             message = "An error has occurred when making a REST request: #{msg}" unless msg.nil?
             status_code = code unless code.nil?
           end
 
-          Gapic::Rest::Error.new message, status_code
+          Gapic::Rest::Error.new message, status_code, status: status, details: details, headers: headers
         end
 
         private
 
         ##
+        # @private
         # Tries to get the error information from the JSON bodies
         #
         # @param body_str [String]
-        # @return [Array(String, String)]
+        # @return [Array(String, String, String, String)]
         def try_parse_from_body body_str
           body = JSON.parse body_str
-          return [nil, nil] unless body && body["error"].is_a?(Hash)
 
-          message = body["error"]["message"]
-          code = body["error"]["code"]
+          unless body.is_a?(::Hash) && body&.key?("error") && body["error"].is_a?(::Hash)
+            return [nil, nil, nil, nil]
+          end
+          error = body["error"]
+
+          message = error["message"] if error.key? "message"
+          code = error["code"] if error.key? "code"
+          status = error["status"] if error.key? "status"
+
+          details = parse_details error["details"] if error.key? "details"
 
-          [message, code]
+          [message, code, status, details]
         rescue JSON::ParserError
-          [nil, nil]
+          [nil, nil, nil, nil]
+        end
+
+        ##
+        # @private
+        # Parses the details data, trying to extract the Protobuf.Any objects
+        # from it, if it's an array of hashes. Otherwise returns it as is.
+        #
+        # @param details [Object, nil] the details object
+        #
+        # @return [Object, nil]
+        def parse_details details
+          # For rest errors details will contain json representations of `Protobuf.Any`
+          # decoded into hashes. If it's not an array, of its elements are not hashes,
+          # it's some other case
+          return details unless details.is_a? ::Array
+
+          details.map do |detail_instance|
+            next detail_instance unless detail_instance.is_a? ::Hash
+            # Next, parse detail_instance into a Proto message.
+            # There are three possible issues for the JSON->Any->message parsing
+            # - json decoding fails
+            # - the json belongs to a proto message type we don't know about
+            # - any unpacking fails
+            # If we hit any of these three issues we'll just return the original hash
+            begin
+              any = ::Google::Protobuf::Any.decode_json detail_instance.to_json
+              klass = ::Google::Protobuf::DescriptorPool.generated_pool.lookup(any.type_name)&.msgclass
+              next detail_instance if klass.nil?
+              unpack = any.unpack klass
+              next detail_instance if unpack.nil?
+              unpack
+            rescue ::Google::Protobuf::ParseError
+              detail_instance
+            end
+          end.compact
         end
       end
     end

data/lib/gapic/rest/grpc_transcoder.rb

@@ -108,12 +108,9 @@ module Gapic
           uri_values = bind_uri_values! http_binding, request_hash
           next if uri_values.any? { |_, value| value.nil? }
 
-          if http_binding.body && http_binding.body != "*"
-            # Note that the body template can only point to a top-level field,
-            # so there is no need to split the path.
-            body_binding_camel = camel_name_for http_binding.body
-            next unless request_hash.key? body_binding_camel
-          end
+          # Note that the body template can only point to a top-level field,
+          # so there is no need to split the path.
+          next if http_binding.body && http_binding.body != "*" && !(request.respond_to? http_binding.body.to_sym)
 
           method = http_binding.method
           uri = expand_template http_binding.template, uri_values
@@ -182,9 +179,15 @@ module Gapic
           #
           # The `request_hash_without_uri` at this point was mutated to delete these fields.
           #
-          # Note that the body template can only point to a top-level field
-          request_hash_without_uri.delete camel_name_for body_template
-          body = request.send(body_template.to_sym).to_json(emit_defaults: true)
+          # Note 1: body template can only point to a top-level field.
+          # Note 2: The field that body template points to can be null, in which case
+          # an empty string should be sent. E.g. `Compute.Projects.SetUsageExportBucket`.
+          request_body_field = request.send body_template.to_sym if request.respond_to? body_template.to_sym
+          if request_body_field
+            request_hash_without_uri.delete camel_name_for body_template
+            body = request_body_field.to_json emit_defaults: true
+          end
+
           query_params = build_query_params request_hash_without_uri
         else
           query_params = build_query_params request_hash_without_uri

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -297,6 +297,7 @@ files:
 - lib/gapic/generic_lro/base_operation.rb
 - lib/gapic/generic_lro/operation.rb
 - lib/gapic/grpc.rb
+- lib/gapic/grpc/errors.rb
 - lib/gapic/grpc/service_stub.rb
 - lib/gapic/grpc/service_stub/rpc_call.rb
 - lib/gapic/grpc/status_details.rb