google-gax 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fb40d292b456b41ebc200bcffb22da7e4ca50da
-  data.tar.gz: b9fcf56ab01370e96b5994882ebb920269d40a73
+  metadata.gz: fddb2e602722db6f4c4aa081c4660a6a3291214c
+  data.tar.gz: 6be83a2a050318833068ccef972ae886668a5484
 SHA512:
-  metadata.gz: 721417435023acd011e44287fa6d4cbeabc98b45f411f5d87bdd4a3bc672ea92d991e29957fadfa394d98b4d5696ca88cc55ed837ccbebc7513e934ae1d58cca
-  data.tar.gz: dda6c253c18408035897de6c50724609e03f3d7cfa799c2d246b981ad950c9a5313379da769723ea1f8c55f46192ee70f6d6528973cacf3db44ad7397c860c9d
+  metadata.gz: 7d6f35c2dcc528491d6a58dd6bf32813708995b20317363cc3eea067ae2358ffdb76da2809a4f12cb1968a1c2361c7cc6235a271c63dcb67e315fbff1a1a9de4
+  data.tar.gz: b9e48955378a15a297f967334ed6d7ff629a0a983acfc7e7e61b25bf6e58d87b7340717585aebe70f234973a86b2e86c79fbb1e4fd445f2dea2b010c0a6dfb19

data/lib/google/gax/api_callable.rb

@@ -32,8 +32,6 @@ require 'time'
 require 'google/gax/errors'
 require 'google/gax/bundling'
 
-# rubocop:disable Metrics/ModuleLength
-
 module Google
   module Gax
     # A class to provide the Enumerable interface for page-streaming method.
@@ -246,21 +244,9 @@ module Google
                      add_timeout_arg(func, this_settings.timeout,
                                      this_settings.kwargs)
                    end
-        api_call = catch_errors(api_call, settings.errors)
-        api_caller.call(api_call, request, this_settings)
-      end
-    end
-
-    # Updates a_func to wrap exceptions with GaxError
-    #
-    # @param a_func [Proc]
-    # @param errors [Array<Exception>] Configures the exceptions to wrap.
-    # @return [Proc] A proc that will wrap certain exceptions with GaxError.
-    def catch_errors(a_func, errors)
-      proc do |request|
         begin
-          a_func.call(request)
-        rescue *errors
+          api_caller.call(api_call, request, this_settings)
+        rescue *settings.errors
           raise GaxError, 'RPC failed'
         end
       end
@@ -312,8 +298,6 @@ module Google
       enumerable.method(:start)
     end
 
-    # rubocop:disable Metrics/MethodLength
-
     # Creates a proc equivalent to a_func, but that retries on certain
     # exceptions.
     #
@@ -336,29 +320,24 @@ module Google
         delay = retry_options.backoff_settings.initial_retry_delay_millis
         timeout = (retry_options.backoff_settings.initial_rpc_timeout_millis /
                    MILLIS_PER_SECOND)
-        result = nil
-        now = Time.now
-        deadline = now + total_timeout
-        loop do
-          begin
-            result = add_timeout_arg(a_func, timeout, kwargs).call(request)
-            break
-          rescue => exception
-            unless exception.respond_to?(:code) &&
-                   retry_options.retry_codes.include?(exception.code)
-              raise RetryError, 'Exception occurred in retry method that ' \
-                'was not classified as transient'
-            end
-            sleep(rand(delay) / MILLIS_PER_SECOND)
-            now = Time.now
-            delay = [delay * delay_mult, max_delay].min
-            timeout = [timeout * timeout_mult, max_timeout, deadline - now].min
-            if now >= deadline
-              raise RetryError, 'Retry total timeout exceeded with exception'
-            end
+        deadline = Time.now + total_timeout
+        begin
+          a_func.call(request, deadline: Time.now + timeout, metadata: kwargs)
+        rescue => exception
+          unless exception.respond_to?(:code) &&
+                 retry_options.retry_codes.include?(exception.code)
+            raise RetryError, 'Exception occurred in retry method that ' \
+              'was not classified as transient'
+          end
+          sleep(rand(delay) / MILLIS_PER_SECOND)
+          now = Time.now
+          delay = [delay * delay_mult, max_delay].min
+          timeout = [timeout * timeout_mult, max_timeout, deadline - now].min
+          if now >= deadline
+            raise RetryError, 'Retry total timeout exceeded with exception'
           end
+          retry
         end
-        result
       end
     end
 
@@ -377,9 +356,9 @@ module Google
       end
     end
 
-    module_function :create_api_call, :catch_errors, :bundleable,
+    module_function :create_api_call, :bundleable,
                     :page_streamable, :retryable, :add_timeout_arg
-    private_class_method :catch_errors, :bundleable, :page_streamable,
+    private_class_method :bundleable, :page_streamable,
                          :retryable, :add_timeout_arg
   end
 end

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,7 +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
@@ -42,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.
@@ -50,14 +84,14 @@ module Google
       #
       # @param port [Fixnum] The port on which to connect to the remote host.
       #
-      # @param chan_creds [Grpc::Core::ChannelCredentials]
-      #   A ChannelCredentials object for use with an SSL-enabled Channel.
-      #   If nil, credentials are pulled from a default location.
-      #
       # @param channel [Object]
       #   A Channel object through which to make calls. If nil, a secure
       #   channel is constructed.
       #
+      # @param chan_creds [Grpc::Core::ChannelCredentials]
+      #   A ChannelCredentials object for use with an SSL-enabled Channel.
+      #   If nil, credentials are pulled from a default location.
+      #
       # @param updater_proc [Proc]
       #   A function that transforms the metadata for requests, e.g., to give
       #   OAuth credentials.
@@ -66,32 +100,57 @@ module Google
       #   The OAuth scopes for this service. This parameter is ignored if
       #   a custom metadata_transformer is supplied.
       #
+      # @raise [ArgumentError] if a combination channel, chan_creds, and
+      #    updater_proc are passed.
+      #
       # @yield [address, creds]
       #   the generated gRPC method to create a stub.
       #
       # @return A gRPC client stub.
       def create_stub(service_path,
                       port,
-                      chan_creds: nil,
                       channel: nil,
+                      chan_creds: nil,
                       updater_proc: nil,
                       scopes: nil)
+        verify_params(channel, chan_creds, updater_proc)
         address = "#{service_path}:#{port}"
-        if channel.nil?
-          chan_creds = GRPC::Core::ChannelCredentials.new if chan_creds.nil?
+        if channel
+          yield(address, nil, channel_override: channel)
+        elsif chan_creds
+          yield(address, chan_creds)
+        else
           if updater_proc.nil?
             auth_creds = Google::Auth.get_application_default(scopes)
             updater_proc = auth_creds.updater_proc
           end
           call_creds = GRPC::Core::CallCredentials.new(updater_proc)
-          chan_creds = chan_creds.compose(call_creds)
+          chan_creds = GRPC::Core::ChannelCredentials.new.compose(call_creds)
           yield(address, chan_creds)
-        else
-          yield(address, nil, channel_override: channel)
         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) ||
+           (channel && updater_proc) ||
+           (chan_creds && updater_proc)
+          raise ArgumentError, 'Only one of channel, chan_creds, and ' \
+              'updater_proc should be passed into ' \
+              'Google::Gax::Grpc#create_stub.'
+        end
+      end
+
+      # 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

@@ -30,17 +30,33 @@
 module Google
   # Gax defines Google API extensions
   module Gax
+    # Regex used by gapic to find version files and directories.
+    VERSION_MATCHER = /
+        ([vV]\d+) # Major version eg: v1
+        ([pP]\d+)? # Point release eg: p2
+        (([aA]lpha|[bB]eta)\d*)? # Release level eg: alpha3
+    /x
+
     # Creates an instance of a protobuf message from a hash that may include
     # nested hashes. `google/protobuf` allows for the instantiation of protobuf
     # 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
@@ -83,7 +99,7 @@ module Google
     #
     # @return [Object] The coerced version of the given value.
     def coerce_submessage(val, field_descriptor)
-      if field_descriptor.label == :repeated
+      if (field_descriptor.label == :repeated) && !(map_field? field_descriptor)
         coerce_array(val, field_descriptor)
       else
         coerce(val, field_descriptor)
@@ -101,12 +117,24 @@ module Google
     #
     # @return [Array<Object>] The coerced version of the given values.
     def coerce_array(array, field_descriptor)
-      raise ArgumentError unless array.is_a? Array
+      unless array.is_a? Array
+        raise ArgumentError, 'Value ' + array.to_s + ' must be an array'
+      end
       array.map do |val|
         coerce(val, field_descriptor)
       end
     end
 
+    # Hack to determine if field_descriptor is for a map.
+    #
+    # TODO(geigerj): Remove this once protobuf Ruby supports an official way
+    # to determine if a FieldDescriptor represents a map.
+    # See: https://github.com/google/protobuf/issues/3425
+    def map_field?(field_descriptor)
+      (field_descriptor.label == :repeated) &&
+        (field_descriptor.subtype.name.include? '_MapEntry_')
+    end
+
     # Coerces the value of a field to be acceptable by the instantiation method
     # of the wrapping message.
     #
@@ -118,13 +146,13 @@ module Google
     #
     # @return [Object] The coerced version of the given value.
     def coerce(val, field_descriptor)
-      return val unless val.is_a? Hash
+      return val unless (val.is_a? Hash) && !(map_field? field_descriptor)
       to_proto(val, field_descriptor.subtype.msgclass)
     end
 
     module_function :to_proto, :coerce_submessages, :coerce_submessage,
-                    :coerce_array, :coerce
+                    :coerce_array, :coerce, :map_field?
     private_class_method :coerce_submessages, :coerce_submessage, :coerce_array,
-                         :coerce
+                         :coerce, :map_field?
   end
 end

data/lib/google/gax/version.rb

@@ -29,6 +29,6 @@
 
 module Google
   module Gax
-    VERSION = '0.8.4'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

data/lib/google/longrunning/operations_client.rb

@@ -40,6 +40,7 @@ require "json"
 require "pathname"
 
 require "google/gax"
+require "googleauth"
 
 require "google/longrunning/operations_pb"
 
@@ -48,7 +49,7 @@ module Google
     # Manages long-running operations with an API service.
     #
     # When an API method normally takes long time to complete, it can be designed
-    # to return Operation to the client, and the client can use this
+    # to return {Google::Longrunning::Operation Operation} to the client, and the client can use this
     # interface to receive the real response asynchronously by polling the
     # operation resource, or pass the operation resource to another API (such as
     # Google Cloud Pub/Sub API) to receive the response.  Any API service that
@@ -82,21 +83,24 @@ module Google
       ALL_SCOPES = [
       ].freeze
 
-      # @param service_path [String]
-      #   The domain name of the API remote host.
-      # @param port [Integer]
-      #   The port on which to connect to the remote host.
-      # @param channel [Channel]
-      #   A Channel object through which to make calls.
-      # @param chan_creds [Grpc::ChannelCredentials]
-      #   A ChannelCredentials for the setting up the RPC client.
-      # @param updater_proc [Proc]
-      #   A function that transforms the metadata for requests, e.g., to give
-      #   OAuth credentials.
+      # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+      #   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 `String` will be treated as the path to the keyfile to be used for the construction of
+      #   credentials for this client.
+      #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+      #   credentials for this client.
+      #   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 scopes [Array<String>]
       #   The OAuth scopes for this service. This parameter is ignored if
       #   an updater_proc is supplied.
-      # @param client_config[Hash]
+      # @param client_config [Hash]
       #   A Hash for call options for each method. See
       #   Google::Gax#construct_settings for the structure of
       #   this data. Falls back to the default config if not specified
@@ -109,11 +113,10 @@ module Google
           channel: nil,
           chan_creds: nil,
           updater_proc: nil,
+          credentials: nil,
           scopes: ALL_SCOPES,
           client_config: {},
           timeout: DEFAULT_TIMEOUT,
-          app_name: nil,
-          app_version: nil,
           lib_name: nil,
           lib_version: ""
         # These require statements are intentionally placed here to initialize
@@ -122,9 +125,33 @@ module Google
         require "google/gax/grpc"
         require "google/longrunning/operations_services_pb"
 
+        if channel || chan_creds || updater_proc
+          warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
+            "on 2017/09/08"
+          credentials ||= channel
+          credentials ||= chan_creds
+          credentials ||= updater_proc
+        end
+        if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
+          warn "`service_path` and `port` parameters are deprecated and will be removed"
+        end
 
-        if app_name || app_version
-          warn "`app_name` and `app_version` are no longer being used in the request headers."
+        credentials ||= Google::Auth::Credentials.default(scopes: scopes)
+
+        if credentials.is_a?(String) || credentials.is_a?(Hash)
+          updater_proc = Google::Auth::Credentials.new(credentials).updater_proc
+        end
+        if credentials.is_a?(GRPC::Core::Channel)
+          channel = credentials
+        end
+        if credentials.is_a?(GRPC::Core::ChannelCredentials)
+          chan_creds = credentials
+        end
+        if credentials.is_a?(Proc)
+          updater_proc = credentials
+        end
+        if credentials.is_a?(Google::Auth::Credentials)
+          updater_proc = credentials.updater_proc
         end
 
         google_api_client = "gl-ruby/#{RUBY_VERSION}"
@@ -193,16 +220,17 @@ module Google
       # @example
       #   require "google/longrunning"
       #
-      #   operations_client = Google::Longrunning::OperationsClient.new
+      #   operations_client = Google::Longrunning.new
       #   name = ''
       #   response = operations_client.get_operation(name)
 
       def get_operation \
           name,
           options: nil
-        req = Google::Longrunning::GetOperationRequest.new({
+        req = {
           name: name
-        }.delete_if { |_, v| v.nil? })
+        }.delete_if { |_, v| v.nil? }
+        req = Google::Gax::to_proto(req, Google::Longrunning::GetOperationRequest)
         @get_operation.call(req, options)
       end
 
@@ -234,7 +262,7 @@ module Google
       # @example
       #   require "google/longrunning"
       #
-      #   operations_client = Google::Longrunning::OperationsClient.new
+      #   operations_client = Google::Longrunning.new
       #   name = ''
       #   filter = ''
       #
@@ -256,11 +284,12 @@ module Google
           filter,
           page_size: nil,
           options: nil
-        req = Google::Longrunning::ListOperationsRequest.new({
+        req = {
           name: name,
           filter: filter,
           page_size: page_size
-        }.delete_if { |_, v| v.nil? })
+        }.delete_if { |_, v| v.nil? }
+        req = Google::Gax::to_proto(req, Google::Longrunning::ListOperationsRequest)
         @list_operations.call(req, options)
       end
 
@@ -268,11 +297,11 @@ module Google
       # makes a best effort to cancel the operation, but success is not
       # guaranteed.  If the server doesn't support this method, it returns
       # +google.rpc.Code.UNIMPLEMENTED+.  Clients can use
-      # Operations::GetOperation or
+      # {Google::Longrunning::Operations::GetOperation Operations::GetOperation} or
       # other methods to check whether the cancellation succeeded or whether the
       # operation completed despite cancellation. On successful cancellation,
       # the operation is not deleted; instead, it becomes an operation with
-      # an Operation#error value with a Google::Rpc::Status#code of 1,
+      # an {Google::Longrunning::Operation#error Operation#error} value with a {Google::Rpc::Status#code} of 1,
       # corresponding to +Code.CANCELLED+.
       #
       # @param name [String]
@@ -284,16 +313,17 @@ module Google
       # @example
       #   require "google/longrunning"
       #
-      #   operations_client = Google::Longrunning::OperationsClient.new
+      #   operations_client = Google::Longrunning.new
       #   name = ''
       #   operations_client.cancel_operation(name)
 
       def cancel_operation \
           name,
           options: nil
-        req = Google::Longrunning::CancelOperationRequest.new({
+        req = {
           name: name
-        }.delete_if { |_, v| v.nil? })
+        }.delete_if { |_, v| v.nil? }
+        req = Google::Gax::to_proto(req, Google::Longrunning::CancelOperationRequest)
         @cancel_operation.call(req, options)
         nil
       end
@@ -312,16 +342,17 @@ module Google
       # @example
       #   require "google/longrunning"
       #
-      #   operations_client = Google::Longrunning::OperationsClient.new
+      #   operations_client = Google::Longrunning.new
       #   name = ''
       #   operations_client.delete_operation(name)
 
       def delete_operation \
           name,
           options: nil
-        req = Google::Longrunning::DeleteOperationRequest.new({
+        req = {
           name: name
-        }.delete_if { |_, v| v.nil? })
+        }.delete_if { |_, v| v.nil? }
+        req = Google::Gax::to_proto(req, Google::Longrunning::DeleteOperationRequest)
         @delete_operation.call(req, options)
         nil
       end

data/lib/google/longrunning/operations_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

data/spec/fixtures/fixture.proto

@@ -28,6 +28,7 @@ message User {
   string name = 1;
   UserType type = 2;
   repeated Post posts = 3;
+  map<string, string> map_field = 4;
 }
 
 message Post {

data/spec/fixtures/fixture_pb.rb

@@ -12,6 +12,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :name, :string, 1
     optional :type, :enum, 2, "google.protobuf.User.UserType"
     repeated :posts, :message, 3, "google.protobuf.Post"
+    map :map_field, :string, :string, 4
   end
   add_enum "google.protobuf.User.UserType" do
     value :UNSPECIFIED, 0

data/spec/google/gax/grpc_spec.rb

@@ -0,0 +1,150 @@
+# 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/grpc'
+
+describe Google::Gax::Grpc do
+  describe '#create_stub' do
+    it 'yields constructed channel credentials' do
+      mock = instance_double(GRPC::Core::ChannelCredentials)
+      composed_mock = instance_double(GRPC::Core::ChannelCredentials)
+      default_creds = instance_double(Google::Auth::ServiceAccountCredentials)
+      updater_proc = proc {}
+
+      allow(Google::Auth)
+        .to receive(:get_application_default).and_return(default_creds)
+      allow(default_creds).to receive(:updater_proc).and_return(updater_proc)
+      allow(mock).to receive(:compose).and_return(composed_mock)
+      allow(GRPC::Core::ChannelCredentials).to receive(:new).and_return(mock)
+
+      expect do |blk|
+        Google::Gax::Grpc.create_stub('service', 'port', &blk)
+      end.to yield_with_args('service:port', composed_mock)
+    end
+
+    it 'yields given channel' do
+      mock = instance_double(GRPC::Core::Channel)
+      expect do |blk|
+        Google::Gax::Grpc.create_stub('service', 'port', channel: mock, &blk)
+      end.to yield_with_args('service:port', nil, channel_override: mock)
+    end
+
+    it 'yields given channel credentials' do
+      mock = instance_double(GRPC::Core::ChannelCredentials)
+      expect do |blk|
+        Google::Gax::Grpc.create_stub('service', 'port', chan_creds: mock, &blk)
+      end.to yield_with_args('service:port', mock)
+    end
+
+    it 'yields channel credentials composed of the given updater_proc' do
+      chan_creds = instance_double(GRPC::Core::ChannelCredentials)
+      composed_chan_creds = instance_double(GRPC::Core::ChannelCredentials)
+      call_creds = instance_double(GRPC::Core::CallCredentials)
+      updater_proc = proc {}
+
+      allow(GRPC::Core::CallCredentials)
+        .to receive(:new).with(updater_proc).and_return(call_creds)
+      allow(GRPC::Core::ChannelCredentials)
+        .to receive(:new).and_return(chan_creds)
+      allow(chan_creds)
+        .to receive(:compose).with(call_creds).and_return(composed_chan_creds)
+      expect do |blk|
+        Google::Gax::Grpc.create_stub(
+          'service', 'port', updater_proc: updater_proc, &blk
+        )
+      end.to yield_with_args('service:port', composed_chan_creds)
+    end
+
+    it 'raise an argument error if multiple creds are passed in' do
+      channel = instance_double(GRPC::Core::Channel)
+      chan_creds = instance_double(GRPC::Core::ChannelCredentials)
+      updater_proc = instance_double(Proc)
+
+      expect do |blk|
+        Google::Gax::Grpc.create_stub(
+          'service', 'port', channel: channel, chan_creds: chan_creds, &blk
+        )
+      end.to raise_error(ArgumentError)
+
+      expect do |blk|
+        Google::Gax::Grpc.create_stub(
+          'service', 'port', channel: channel,
+                             updater_proc: updater_proc, &blk
+        )
+      end.to raise_error(ArgumentError)
+
+      expect do |blk|
+        Google::Gax::Grpc.create_stub(
+          'service', 'port', chan_creds: chan_creds,
+                             updater_proc: updater_proc, &blk
+        )
+      end.to raise_error(ArgumentError)
+
+      expect do |blk|
+        Google::Gax::Grpc.create_stub(
+          'service', 'port', channel: channel, chan_creds: chan_creds,
+                             updater_proc: updater_proc, &blk
+        )
+      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
@@ -36,6 +37,10 @@ describe Google::Gax do
     USER_NAME = 'Ernest'.freeze
     USER_TYPE = :ADMINISTRATOR
     POST_TEXT = 'This is a test post.'.freeze
+    MAP = {
+      'key1' => 'val1',
+      'key2' => 'val2'
+    }.freeze
 
     it 'creates a protobuf message from a simple hash' do
       hash = { name: USER_NAME, type: USER_TYPE }
@@ -91,6 +96,20 @@ describe Google::Gax do
       end
     end
 
+    it 'handles maps' do
+      request_hash = {
+        name: USER_NAME,
+        map_field: MAP
+      }
+      user = Google::Gax.to_proto(request_hash, Google::Protobuf::User)
+      expect(user).to be_an_instance_of(Google::Protobuf::User)
+      expect(user.name).to eq(USER_NAME)
+      expect(user.map_field).to be_an_instance_of(Google::Protobuf::Map)
+      user.map_field.each do |k, v|
+        expect(MAP[k]).to eq v
+      end
+    end
+
     it 'fails if a key does not exist in the target message type' do
       user_hash = {
         name: USER_NAME,
@@ -100,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.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -16,42 +16,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -175,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/grpc_spec.rb
 - spec/google/gax/operation_spec.rb
 - spec/google/gax/path_template_spec.rb
 - spec/google/gax/settings_spec.rb