google-gax 0.9.2 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bca7d854ad491092643634181cd7cca66cca02d
-  data.tar.gz: c6b63e094604a04d6f179d6bbb92df604e5af177
+  metadata.gz: 116098acb3407bbd5b01f92e330279b07b13caea
+  data.tar.gz: 24e05d6e466e28d51f895b472666b2b79785bfb2
 SHA512:
-  metadata.gz: 83071cd3e88872792427323becb1649a27f3bc8f7315bbc0a539994abfe028d859df914f1a42d0383855d06431795fb3fcfc84cd1bfda7d5013214a24772e1fb
-  data.tar.gz: 74f02390b60f184b2be9fb6925143e6d79478ff1b09f3eb6e6e39eec286a51614c4cad65fab5f2012fa5f40fe75013098df3048e4212d00f9c57e90f0481fc03
+  metadata.gz: 139d012dfa865a1f7ea219c597f0b0d987d409cdd7a8db2b74b0e8fcbc2a96d9354d669882acb69378ef5461844f34e26905ef8df0069f63d35eb594a087f5f5
+  data.tar.gz: 75abafa5d443696e83494499b361dc0ff92c5b80c714e7fe4e359d9f88ff970f2c47a4d35e62cd43dbaaf9e4ed4486fd66d81127953bdf607fa3d058ca650e36

data/lib/google/gax/errors.rb

@@ -35,7 +35,7 @@ module Google
   module Gax
     # Common base class for exceptions raised by GAX.
     class GaxError < StandardError
-      attr_reader :details
+      attr_reader :status_details
 
       # @param msg [String] describes the error that occurred.
       def initialize(msg)
@@ -43,7 +43,8 @@ module Google
         msg += ", caused by #{$ERROR_INFO}" if $ERROR_INFO
         super(msg)
         @cause = $ERROR_INFO
-        @details = Google::Gax::Grpc.deserialize_error_status_details(@cause)
+        @status_details = \
+          Google::Gax::Grpc.deserialize_error_status_details(@cause)
       end
 
       # cause is a new method introduced in 2.1.0, bring this
@@ -53,6 +54,21 @@ module Google
           @cause
         end
       end
+
+      def code
+        return nil unless cause && cause.respond_to?(:code)
+        cause.code
+      end
+
+      def details
+        return nil unless cause && cause.respond_to?(:details)
+        cause.details
+      end
+
+      def metadata
+        return nil unless cause && cause.respond_to?(:metadata)
+        cause.metadata
+      end
     end
 
     # Indicates an error during automatic GAX retrying.

data/lib/google/gax/version.rb

@@ -29,6 +29,6 @@
 
 module Google
   module Gax
-    VERSION = '0.9.2'.freeze
+    VERSION = '0.10.1'.freeze
   end
 end

data/spec/google/gax/error_spec.rb

@@ -0,0 +1,141 @@
+# Copyright 2017, 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.
+
+require 'google/gax/errors'
+require 'google/protobuf/any_pb'
+require 'spec/fixtures/fixture_pb'
+
+describe Google::Gax::GaxError do
+  describe 'without cause' do
+    it 'presents GRPC::BadStatus values' do
+      error = Google::Gax::GaxError.new('no cause')
+
+      expect(error).to be_an_instance_of(Google::Gax::GaxError)
+      expect(error.message).to eq('GaxError no cause')
+      expect(error.code).to be_nil
+      expect(error.details).to be_nil
+      expect(error.metadata).to be_nil
+      expect(error.status_details).to be_nil
+
+      expect(error.cause).to be_nil
+    end
+  end
+
+  describe 'with cause as RuntimeError' do
+    it 'presents GRPC::BadStatus values' do
+      error = wrapped_error('not allowed')
+
+      expect(error).to be_an_instance_of(Google::Gax::GaxError)
+      expect(error.message).to eq('GaxError not allowed, caused by not allowed')
+      expect(error.code).to be_nil
+      expect(error.details).to be_nil
+      expect(error.metadata).to be_nil
+      expect(error.status_details).to be_nil
+
+      expect(error.cause).to be_an_instance_of(RuntimeError)
+      expect(error.cause.message).to eq('not allowed')
+    end
+  end
+
+  describe 'with cause as GRPC::BadStatus' do
+    it 'presents GRPC::BadStatus values' do
+      error = wrapped_badstatus(3, 'invalid')
+
+      expect(error).to be_an_instance_of(Google::Gax::GaxError)
+      expect(error.message).to eq('GaxError 3:invalid, caused by 3:invalid')
+      expect(error.code).to eq(3)
+      expect(error.details).to eq('invalid')
+      expect(error.metadata).to eq({})
+      expect(error.status_details).to eq(
+        'Could not parse error details due to a ' \
+        'malformed server response trailer.'
+      )
+
+      expect(error.cause).to be_an_instance_of(GRPC::BadStatus)
+      expect(error.cause.message).to eq('3:invalid')
+      expect(error.cause.code).to eq(3)
+      expect(error.cause.details).to eq('invalid')
+      expect(error.cause.metadata).to eq({})
+    end
+  end
+
+  describe 'with cause as GRPC::BadStatus with status_detail' do
+    it 'presents GRPC::BadStatus values' do
+      status_detail = debug_info('hello world')
+      encoded_status_detail = encoded_protobuf(status_detail)
+      metadata = { 'foo' => 'bar',
+                   'grpc-status-details-bin' => encoded_status_detail }
+      error = wrapped_badstatus(1, 'cancelled', metadata)
+
+      expect(error).to be_an_instance_of(Google::Gax::GaxError)
+      expect(error.message).to eq('GaxError 1:cancelled, caused by 1:cancelled')
+      expect(error.code).to eq(1)
+      expect(error.details).to eq('cancelled')
+      expect(error.metadata).to eq(metadata)
+      expect(error.status_details).to eq([status_detail])
+
+      expect(error.cause).to be_an_instance_of(GRPC::BadStatus)
+      expect(error.cause.message).to eq('1:cancelled')
+      expect(error.cause.code).to eq(1)
+      expect(error.cause.details).to eq('cancelled')
+      expect(error.cause.metadata).to eq(metadata)
+    end
+  end
+
+  def wrap_with_gax_error(err)
+    raise err
+  rescue => e
+    raise Google::Gax::GaxError, e.message
+  end
+
+  def wrapped_error(msg)
+    wrap_with_gax_error(RuntimeError.new(msg))
+  rescue => gax_err
+    return gax_err
+  end
+
+  def debug_info(detail)
+    Google::Rpc::DebugInfo.new(detail: detail)
+  end
+
+  def encoded_protobuf(debug_info)
+    any = Google::Protobuf::Any.new
+    any.pack debug_info
+
+    Google::Rpc::Status.encode(
+      Google::Rpc::Status.new(details: [any])
+    )
+  end
+
+  def wrapped_badstatus(status, msg, metadata = {})
+    wrap_with_gax_error(GRPC::BadStatus.new(status, msg, metadata))
+  rescue => gax_err
+    return gax_err
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.1
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2017-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -187,6 +187,7 @@ files:
 - spec/fixtures/fixture_pb.rb
 - spec/google/gax/api_callable_spec.rb
 - spec/google/gax/bundling_spec.rb
+- spec/google/gax/error_spec.rb
 - spec/google/gax/grpc_spec.rb
 - spec/google/gax/operation_spec.rb
 - spec/google/gax/path_template_spec.rb