google-gax 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 116098acb3407bbd5b01f92e330279b07b13caea
-  data.tar.gz: 24e05d6e466e28d51f895b472666b2b79785bfb2
+  metadata.gz: 042b5b8369bf9dd8599b15f142f6608fbd7d2eb2
+  data.tar.gz: 1982637288109d3c84bd27d531f0736a8060ce27
 SHA512:
-  metadata.gz: 139d012dfa865a1f7ea219c597f0b0d987d409cdd7a8db2b74b0e8fcbc2a96d9354d669882acb69378ef5461844f34e26905ef8df0069f63d35eb594a087f5f5
-  data.tar.gz: 75abafa5d443696e83494499b361dc0ff92c5b80c714e7fe4e359d9f88ff970f2c47a4d35e62cd43dbaaf9e4ed4486fd66d81127953bdf607fa3d058ca650e36
+  metadata.gz: f0cd057e35054c328494dab34bad86eeb47b90cbe762489be0e3f37598a52bed9097572d9b77a46ccc587fbdf35148a9e4e66e7a671571754a360063e55c5b6f
+  data.tar.gz: 619f3cea1620d36159a1cc51f15899f4b7c608a6cb4a20044c8472ef9ccb84d0cc4c352d4b6b5e69e187907d9dcdc52720f6c4c8ddd6523b8bd48fc5909456b8

data/Rakefile

@@ -12,4 +12,4 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/lib/google/gax/api_callable.rb

@@ -33,6 +33,8 @@ require 'google/gax/errors'
 require 'google/gax/bundling'
 
 module Google
+  # rubocop:disable Metrics/ModuleLength
+
   module Gax
     # A class to provide the Enumerable interface for page-streaming method.
     # PagedEnumerable assumes that the API call returns a message for a page
@@ -214,10 +216,12 @@ module Google
     #
     # @param func [Proc] used to make a bare rpc call
     # @param settings [CallSettings] provides the settings for this call
+    # @param params_extractor [Proc] extracts routing header params from the
+    #   request
     # @return [Proc] a bound method on a request stub used to make an rpc call
     # @raise [StandardError] if +settings+ has incompatible values,
     #   e.g, if bundling and page_streaming are both configured
-    def create_api_call(func, settings)
+    def create_api_call(func, settings, params_extractor: nil)
       api_caller = proc do |api_call, request|
         api_call.call(request)
       end
@@ -237,6 +241,10 @@ module Google
 
       proc do |request, options = nil|
         this_settings = settings.merge(options)
+        if params_extractor
+          params = params_extractor.call(request)
+          this_settings = with_routing_header(this_settings, params)
+        end
         api_call = if settings.retry_codes?
                      retryable(func, this_settings.retry_options,
                                this_settings.kwargs)
@@ -298,6 +306,20 @@ module Google
       enumerable.method(:start)
     end
 
+    # Create a new CallSettings with the routing metadata from the request
+    # header params merged with the given settings.
+    #
+    # @param settings [CallSettings] the settings for an API call.
+    # @param params [Hash] the request header params.
+    # @return [CallSettings] a new merged settings.
+    def with_routing_header(settings, params)
+      routing_header = params.map { |k, v| "#{k}=#{v}" }.join('&')
+      options = CallOptions.new(
+        kwargs: { 'x-goog-request-params' => routing_header }
+      )
+      settings.merge(options)
+    end
+
     # Creates a proc equivalent to a_func, but that retries on certain
     # exceptions.
     #
@@ -357,8 +379,9 @@ module Google
     end
 
     module_function :create_api_call, :bundleable,
-                    :page_streamable, :retryable, :add_timeout_arg
+                    :page_streamable, :with_routing_header, :retryable,
+                    :add_timeout_arg
     private_class_method :bundleable, :page_streamable,
-                         :retryable, :add_timeout_arg
+                         :with_routing_header, :retryable, :add_timeout_arg
   end
 end

data/lib/google/gax/version.rb

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

data/lib/google/longrunning/operations_client.rb

@@ -108,8 +108,8 @@ module Google
       # @param timeout [Numeric]
       #   The default timeout, in seconds, for calls made through this client.
       def initialize \
-          service_path: SERVICE_ADDRESS,
-          port: DEFAULT_SERVICE_PORT,
+          service_path: self.class::SERVICE_ADDRESS,
+          port: self.class::DEFAULT_SERVICE_PORT,
           channel: nil,
           chan_creds: nil,
           updater_proc: nil,

data/spec/google/gax/api_callable_spec.rb

@@ -199,6 +199,27 @@ describe Google::Gax do
     end
   end
 
+  describe 'with_routing_header' do
+    it 'merges request header params with the existing settings' do
+      settings = CallSettings.new
+      metadata_arg = nil
+      func = proc do |_, metadata: nil, **_deadline|
+        metadata_arg = metadata
+        42
+      end
+      params_extractor = proc do |request|
+        { 'name' => request[:name], 'book.read' => request[:book][:read] }
+      end
+      my_callable = Google::Gax.create_api_call(
+        func, settings, params_extractor: params_extractor
+      )
+      expect(my_callable.call(name: 'foo', book: { read: true })).to eq(42)
+      expect(metadata_arg).to eq(
+        'x-goog-request-params' => 'name=foo&book.read=true'
+      )
+    end
+  end
+
   describe 'retryable' do
     RetryOptions = Google::Gax::RetryOptions
     BackoffSettings = Google::Gax::BackoffSettings

data/spec/google/gax/bundling_spec.rb

@@ -77,7 +77,7 @@ describe Google::Gax do
       it 'composite value with nil' do
         actual =
           Google::Gax.compute_bundle_id(
-            simple_builder('dummy_value'), %w(field1 field2)
+            simple_builder('dummy_value'), %w[field1 field2]
           )
         expect(actual).to eq(['dummy_value', ''])
       end
@@ -86,16 +86,16 @@ describe Google::Gax do
         actual =
           Google::Gax.compute_bundle_id(
             simple_builder('dummy_value', other_value: 'other_value'),
-            %w(field1 field2)
+            %w[field1 field2]
           )
-        expect(actual).to eq(%w(dummy_value other_value))
+        expect(actual).to eq(%w[dummy_value other_value])
       end
 
       it 'simple dotted value' do
         actual =
           Google::Gax.compute_bundle_id(
             outer_builder('dummy_value'),
-            %w(inner.field1)
+            %w[inner.field1]
           )
         expect(actual).to eq(['dummy_value'])
       end
@@ -104,9 +104,9 @@ describe Google::Gax do
         actual =
           Google::Gax.compute_bundle_id(
             outer_builder('dummy_value'),
-            %w(inner.field1 inner.field2 field1)
+            %w[inner.field1 inner.field2 field1]
           )
-        expect(actual).to eq(%w(dummy_value dummy_value dummy_value))
+        expect(actual).to eq(%w[dummy_value dummy_value dummy_value])
       end
 
       it 'should return false for a single missing field value' do
@@ -122,7 +122,7 @@ describe Google::Gax do
         expect(
           Google::Gax.compute_bundle_id(
             simple_builder('dummy_value'),
-            %w(field1 field3)
+            %w[field1 field3]
           )
         ).to eq(['dummy_value', nil])
       end
@@ -287,7 +287,7 @@ describe Google::Gax do
       it 'should group the api_calls by bundle_id' do
         an_elt = 'dummy_message'
         api_call = return_request
-        bundle_ids = %w(id1 id2)
+        bundle_ids = %w[id1 id2]
         threshold = 5
         options =
           Google::Gax::BundleOptions.new(element_count_threshold: threshold)

data/spec/google/gax/operation_spec.rb

@@ -307,7 +307,9 @@ describe Google::Gax::Operation do
       op = create_op(GrpcOp.new(done: false), client: mock_client)
       time_now = Time.now
       allow(Time).to receive(:now) { time_now }
-      expect(op).to receive(:sleep).exactly(3).times { |secs| time_now += secs }
+      expect(op).to(
+        receive(:sleep).exactly(3).times { |secs| time_now += secs }
+      )
       op.wait_until_done!
       expect(to_call).to eq(0)
     end
@@ -324,7 +326,9 @@ describe Google::Gax::Operation do
 
       time_now = Time.now
       allow(Time).to receive(:now) { time_now }
-      expect(op).to receive(:sleep).exactly(3).times { |secs| time_now += secs }
+      expect(op).to(
+        receive(:sleep).exactly(3).times { |secs| time_now += secs }
+      )
 
       op.wait_until_done!
       expect(to_call).to eq(0)

data/spec/google/gax/settings_spec.rb

@@ -36,8 +36,8 @@ A_CONFIG = {
   'interfaces' => {
     SERVICE_NAME => {
       'retry_codes' => {
-        'foo_retry' => %w(code_a code_b),
-        'bar_retry' => %w(code_c)
+        'foo_retry' => %w[code_a code_b],
+        'bar_retry' => %w[code_c]
       },
       'retry_params' => {
         'default' => {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2017-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -140,14 +140,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement