google-gax 0.8.9 → 0.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d01554d9585efae173a06f021c95ee26fcc6b043
-  data.tar.gz: 8fcb4ef5ac286b1ce963ccea9d6a2ceb1b727cfa
+  metadata.gz: 9b97f693e0972f255cf0b0ddbbf27a63370afc04
+  data.tar.gz: 852fb0aeeeb4312fae5951bcf4a034466dcb38ee
 SHA512:
-  metadata.gz: f841c39cea967f4d120e4089812bd6aa676d7f0412dc1ff865633a4c322087ec85ee0e1be3e45d621c1cb5a1bfff8bd813281795cb80242a8c73f552ef120449
-  data.tar.gz: 3f98b5a00ca78eff391ea81de5a053e2026b1c235eb2941d2081141ed3080fa574ba29de6684ddad76d993be7d55e1eb1114a21d50575d76aed1b98a85b6c557
+  metadata.gz: 5552ba83b4e65d7889df1fdec4cf3f59d07b96161c5064f7c2344f0eb8299daea86cfddd55e35a1ca01b16dba846d46c34cfe933d15974a0353624862dafc9ca
+  data.tar.gz: 1970759850a9d2ccd7f9655a688b3bf8bbb973442e9ce542dc6b53e21f412c68b3fa0cfe6d20d85f26f06de3e1f552af4ffcd64b659e21235c7f1ca3781a7ad7

data/lib/google/gax/errors.rb

@@ -29,16 +29,21 @@
 
 require 'English'
 
+require 'google/gax/grpc'
+
 module Google
   module Gax
     # Common base class for exceptions raised by GAX.
     class GaxError < StandardError
+      attr_reader :details
+
       # @param msg [String] describes the error that occurred.
       def initialize(msg)
         msg = "GaxError #{msg}"
         msg += ", caused by #{$ERROR_INFO}" if $ERROR_INFO
         super(msg)
         @cause = $ERROR_INFO
+        @details = Google::Gax::Grpc.deserialize_error_status_details(@cause)
       end
 
       # cause is a new method introduced in 2.1.0, bring this

data/lib/google/gax/grpc.rb

@@ -28,8 +28,12 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 require 'grpc'
+require 'grpc/google_rpc_status_utils'
 require 'googleauth'
 require 'google/gax/errors'
+require 'google/protobuf/well_known_types'
+# Required in order to deserialize common error detail proto types
+require 'google/rpc/error_details_pb'
 
 module Google
   module Gax
@@ -43,6 +47,35 @@ module Google
 
       API_ERRORS = [GRPC::BadStatus, GRPC::Cancelled].freeze
 
+      def deserialize_error_status_details(error)
+        return unless error.is_a? GRPC::BadStatus
+        # If error status is malformed, swallow the gRPC error that gets raised.
+        begin
+          details =
+            GRPC::GoogleRpcStatusUtils.extract_google_rpc_status(
+              error.to_status
+            ).details
+        rescue
+          return 'Could not parse error details due to a malformed server '\
+                 'response trailer.'
+        end
+        return if details.nil?
+        details =
+          GRPC::GoogleRpcStatusUtils.extract_google_rpc_status(
+            error.to_status
+          ).details
+        details.map do |any|
+          # If the type of the proto wrapped by the Any instance is not
+          # available, do not deserialize.
+          candidate_class_name = class_case(any.type_name.split('.')).join('::')
+          begin
+            any.unpack(Object.const_get(candidate_class_name))
+          rescue NameError
+            any
+          end
+        end
+      end
+
       # rubocop:disable Metrics/ParameterLists
 
       # Creates a gRPC client stub.
@@ -97,7 +130,7 @@ module Google
         end
       end
 
-      module_function :create_stub
+      module_function :create_stub, :deserialize_error_status_details
 
       def self.verify_params(channel, chan_creds, updater_proc)
         if (channel && chan_creds) ||
@@ -109,7 +142,15 @@ module Google
         end
       end
 
-      private_class_method :verify_params
+      # Capitalize all modules except the message class, which is already
+      # correctly cased
+      def self.class_case(modules)
+        message = modules.pop
+        modules = modules.map(&:capitalize)
+        modules << message
+      end
+
+      private_class_method :verify_params, :class_case
     end
   end
 end

data/lib/google/gax/util.rb

@@ -42,12 +42,21 @@ module Google
     # messages using hashes but does not allow for nested hashes to instantiate
     # nested submessages.
     #
-    # @param hash [Hash] The hash to be converted into a proto message.
+    # @param hash [Hash || Class] The hash to be converted into a proto message.
+    #   If an instance of the proto message class is given, it is returned
+    #   unchanged.
     # @param message_class [Class] The corresponding protobuf message class of
     #   the given hash.
     #
     # @return [Object] An instance of the given message class.
     def to_proto(hash, message_class)
+      return hash if hash.is_a? message_class
+
+      # Sanity check: input must be a Hash
+      unless hash.is_a? Hash
+        raise ArgumentError,
+              "Value #{hash} must be a Hash or a #{message_class.name}"
+      end
       hash = coerce_submessages(hash, message_class)
       message_class.new(hash)
     end

data/lib/google/gax/version.rb

@@ -29,6 +29,6 @@
 
 module Google
   module Gax
-    VERSION = '0.8.9'.freeze
+    VERSION = '0.8.12'.freeze
   end
 end

data/lib/google/gax/version.rb~

@@ -0,0 +1,34 @@
+# Copyright 2016, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Google
+  module Gax
+    VERSION = '0.8.7'.freeze
+  end
+end

data/spec/google/gax/grpc_spec.rb

@@ -114,4 +114,37 @@ describe Google::Gax::Grpc do
       end.to raise_error(ArgumentError)
     end
   end
+  describe '#deserialize_error_status_details' do
+    it 'deserializes a known error type' do
+      expected_error = Google::Rpc::DebugInfo.new(detail: 'shoes are untied')
+
+      any = Google::Protobuf::Any.new
+      any.pack(expected_error)
+      status = Google::Rpc::Status.new(details: [any])
+      encoded = Google::Rpc::Status.encode(status)
+      metadata = {
+        'grpc-status-details-bin' => encoded
+      }
+      error = GRPC::BadStatus.new(1, '', metadata)
+
+      expect(Google::Gax::Grpc.deserialize_error_status_details(error))
+        .to eq [expected_error]
+    end
+    it 'does not deserialize an unknown error type' do
+      expected_error = Random.new.bytes(8)
+
+      any = Google::Protobuf::Any.new(
+        type_url: 'unknown-type', value: expected_error
+      )
+      status = Google::Rpc::Status.new(details: [any])
+      encoded = Google::Rpc::Status.encode(status)
+      metadata = {
+        'grpc-status-details-bin' => encoded
+      }
+      error = GRPC::BadStatus.new(1, '', metadata)
+
+      expect(Google::Gax::Grpc.deserialize_error_status_details(error))
+        .to eq [any]
+    end
+  end
 end

data/spec/google/gax/util_spec.rb

@@ -28,6 +28,7 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 require 'google/gax'
+require 'google/protobuf/any_pb'
 require 'spec/fixtures/fixture_pb'
 
 describe Google::Gax do
@@ -118,5 +119,20 @@ describe Google::Gax do
         Google::Gax.to_proto(user_hash, Google::Protobuf::User)
       end.to raise_error(ArgumentError)
     end
+
+    it 'handles proto messages' do
+      user_message = Google::Protobuf::User.new(
+        name: USER_NAME, type: USER_TYPE
+      )
+      user = Google::Gax.to_proto(user_message, Google::Protobuf::User)
+      expect(user).to eq user_message
+    end
+
+    it 'fails if proto message has unexpected type' do
+      user_message = Google::Protobuf::Any
+      expect do
+        Google::Gax.to_proto(user_message, Google::Protobuf::User)
+      end.to raise_error(ArgumentError)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.8.12
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.6
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +170,7 @@ files:
 - lib/google/gax/settings.rb
 - lib/google/gax/util.rb
 - lib/google/gax/version.rb
+- lib/google/gax/version.rb~
 - lib/google/longrunning/operations_client.rb
 - lib/google/longrunning/operations_client_config.json
 - spec/fixtures/fixture.proto