google-gax 0.8.5 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 798b058e269c1439eae63e4902b7558b5be005c0
-  data.tar.gz: 3ee51d01d9addb3d2edb034efb196478fcf0c4ae
+  metadata.gz: 716e8277e7cc5439a3f53c73c6cde2a8299ece01
+  data.tar.gz: ddb28ab9299ec05325ca30cdd40d13b5791d03f1
 SHA512:
-  metadata.gz: 84f4d99c7830db006033237c1f92f3de3b7d8dc4a43e4357b182f0cfabc52df76e6c7d3f0863ce6b89307221c31c3a50cf39573d116e8b4e78d28e42e4a11fb3
-  data.tar.gz: 95ab0e0670ba6eeb51cc6a2a98ba93f4beda3246be5ac43a9e6b3b344aedb9a369d6d01ccb32710f56ac34797a1f22d2d7ecb28f9beb221753f2af8d636c3835
+  metadata.gz: 7b39b230f9fe8cd4eb4ce9a37f1b5290a2f616e05fa0a646b56287ae9a56f0543687a987db3fa1ec0996cbece43f67cb0cd957d68167c80e8f7b3faa1b035550
+  data.tar.gz: b74ca9b64dcf91794360de8b7055f10f4a70cce756629298fb75273b2e73004c362609b07067e30eeab5765365dde23ddded22775898d4f70d8fe8da68f9ede8

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/util.rb

@@ -90,7 +90,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)
@@ -108,12 +108,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.
     #
@@ -125,13 +137,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.5'.freeze
+    VERSION = '0.8.7'.freeze
   end
 end

data/lib/google/longrunning/operations_client.rb

@@ -48,7 +48,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
@@ -80,19 +80,28 @@ module Google
       # The scopes needed to make gRPC calls to all of the methods defined in
       # this service.
       ALL_SCOPES = [
+        "https://www.googleapis.com/auth/cloud-platform",
       ].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::Gax::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::Gax::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.
@@ -109,6 +118,7 @@ module Google
           channel: nil,
           chan_creds: nil,
           updater_proc: nil,
+          credentials: nil,
           scopes: ALL_SCOPES,
           client_config: {},
           timeout: DEFAULT_TIMEOUT,
@@ -122,11 +132,35 @@ 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 app_name || app_version
           warn "`app_name` and `app_version` are no longer being used in the request headers."
         end
 
+        credentials ||= Google::Gax::Credentials.default(scope: scopes)
+
+        if credentials.is_a?(String) || credentials.is_a?(Hash)
+          updater_proc = Google::Gax::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::Gax::Credentials)
+          updater_proc = credentials.updater_proc
+        end
+
         google_api_client = "gl-ruby/#{RUBY_VERSION}"
         google_api_client << " #{lib_name}/#{lib_version}" if lib_name
         google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
@@ -193,16 +227,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 +269,7 @@ module Google
       # @example
       #   require "google/longrunning"
       #
-      #   operations_client = Google::Longrunning::OperationsClient.new
+      #   operations_client = Google::Longrunning.new
       #   name = ''
       #   filter = ''
       #
@@ -256,11 +291,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 +304,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 +320,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 +349,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/util_spec.rb

@@ -36,6 +36,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 +95,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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.7
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2017-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth