google-gax 1.7.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7271bd48161698b84de9f66e337c3742e44b765f75fa1344c2e59b3608359e65
-  data.tar.gz: d2483f6d0f41e82f6655a1d5893712785721b73b7c675772752f457c9de0986e
+  metadata.gz: d88bc62f45f5b407ca80e07483f10611a5eea6d97bb479a079dd1e81fa3f9f8f
+  data.tar.gz: ea0b5d6d2bce892e939be9462fc66e2089a1bef2e689ac6404fd79656d307130
 SHA512:
-  metadata.gz: 8b92de0ba1398fd9d71a7cdd66aa000975677996fefcfdcf4828d12c6fff7194c0b93da9178eaf26d51d924f77dc3b493ad3bffba5011d1e8ea7bfb670d92311
-  data.tar.gz: cf0103edeab0f7e8244b2e008d72974bb7562236281d6eed0ce2466740f48a56a433d934286d9205d89d84382003ace8f55527250cba09b4868b6b57b80b74e1
+  metadata.gz: 1f5267214e8085943be3a2614535f5df7f09c52af65209188cd10d1138a09cc18a32915757f03ab2b1597c1fd7173ab66e9d4b0b1f2a1dd986754cecd47c50c7
+  data.tar.gz: ba0f5165f230e7762001d3baa4749b3185fb879d865e43e67f35cf05afb33773ac70e177d38e5a7bd8f922012cfd3efc99ceb7020b1aaf83fb30e4507d9dc745

data/README.md

@@ -1,8 +1,16 @@
 Google API Extensions for Ruby
 ================================
 
-[![Build Status](https://travis-ci.org/googleapis/gax-ruby.svg?branch=master)](https://travis-ci.org/googleapis/gax-ruby)
-[![Code Coverage](https://img.shields.io/codecov/c/github/googleapis/gax-ruby.svg)](https://codecov.io/github/googleapis/gax-ruby)
+**This gem is officially end-of-life**
+
+The `gax-ruby` gem included common code used by obsolete versions of the Google
+API clients in https://github.com/googleapis/google-cloud-ruby. Up-to-date
+versions of the client libraries no longer use this gem. If your app depends on
+`gax-ruby`, we recommend updating the client library gems that depend on it.
+Modern clients will depend on the `gapic-common` gem instead of `gax-ruby`.
+
+**This gem is officially end-of-life**
+
 [![Gem Version](https://badge.fury.io/rb/google-gax.svg)](https://badge.fury.io/rb/google-gax)
 
 Google API Extensions for Ruby (gax-ruby) is a set of modules which aids the
@@ -21,7 +29,12 @@ provide a more convenient and idiomatic API surface to callers.
 Ruby Versions
 ---------------
 
-gax-ruby is currently tested with Ruby 2.2.4.
+This library requires Ruby 2.4 or later.
+
+In general, this library supports Ruby versions that are considered current and
+supported by Ruby Core (that is, Ruby versions that are either in normal
+maintenance or in security maintenance).
+See https://www.ruby-lang.org/en/downloads/branches/ for further details.
 
 
 Contributing

data/lib/google/gax/path_template.rb

@@ -177,18 +177,16 @@ module Google
               msg = "Value for key #{segment.literal} is not provided"
               raise ArgumentError.new(msg)
             end
-            out.concat(PathTemplate.new(bindings[literal_sym]).segments)
+            out << bindings[literal_sym]
             binding = true
           elsif segment.kind == END_BINDING
             binding = false
           else
             next if binding
-            out << segment
+            out << segment.literal.to_s
           end
         end
-        path = self.class.format_segments(*out)
-        match(path)
-        path
+        out.join('/')
       end
 
       # Matches a fully qualified path template string.

data/lib/google/gax/settings.rb

@@ -511,7 +511,9 @@ module Google
         bundle_descriptor = bundle_descriptors[snake_name]
 
         defaults[snake_name] = CallSettings.new(
-          timeout: timeout,
+          timeout: calc_method_timeout(
+            timeout, method_config, overriding_method
+          ),
           retry_options: merge_retry_options(
             construct_retry(method_config,
                             service_config['retry_codes'],
@@ -533,11 +535,20 @@ module Google
       defaults
     end
 
+    # @private Determine timeout in seconds for the current method.
+    def calc_method_timeout(timeout, method_config, overriding_method)
+      timeout_override = method_config['timeout_millis']
+      if overriding_method && overriding_method.key?('timeout_millis')
+        timeout_override = overriding_method['timeout_millis']
+      end
+      timeout_override ? timeout_override / 1000 : timeout
+    end
+
     module_function :construct_settings, :construct_bundling,
                     :construct_retry, :upper_camel_to_lower_underscore,
-                    :merge_retry_options
+                    :merge_retry_options, :calc_method_timeout
     private_class_method :construct_bundling, :construct_retry,
                          :upper_camel_to_lower_underscore,
-                         :merge_retry_options
+                         :merge_retry_options, :calc_method_timeout
   end
 end

data/lib/google/gax/version.rb

@@ -29,6 +29,6 @@
 
 module Google
   module Gax
-    VERSION = '1.7.0'.freeze
+    VERSION = '1.8.2'.freeze
   end
 end

data/spec/fixtures/fixture.proto

@@ -37,4 +37,15 @@ message User {
 
 message Post {
   string text = 1;
-}
+}
+
+message GoodPagedRequest {
+  string name = 1;
+  int32 page_size = 2;
+  string page_token = 3;
+}
+
+message GoodPagedResponse {
+  repeated User users = 1;
+  string next_page_token = 2;
+}

data/spec/fixtures/fixture_pb.rb

@@ -24,6 +24,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.protobuf.Post" do
     optional :text, :string, 1
   end
+  add_message "google.protobuf.GoodPagedRequest" do
+    optional :name, :string, 1
+    optional :page_size, :int32, 2
+    optional :page_token, :string, 3
+  end
+  add_message "google.protobuf.GoodPagedResponse" do
+    repeated :users, :message, 1, "google.protobuf.User"
+    optional :next_page_token, :string, 2
+  end
 end
 
 module Google
@@ -32,5 +41,7 @@ module Google
     User = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.User").msgclass
     User::UserType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.User.UserType").enummodule
     Post = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.Post").msgclass
+    GoodPagedRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.GoodPagedRequest").msgclass
+    GoodPagedResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.GoodPagedResponse").msgclass
   end
 end

data/spec/google/gax/paged_enumerable_spec.rb

@@ -0,0 +1,103 @@
+# Copyright 2019, Google LLC
+# 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 LLC 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'
+require 'spec/fixtures/fixture_pb'
+
+describe Google::Gax::PagedEnumerable do
+  it 'enumerates all resources' do
+    api_responses = [
+      Google::Protobuf::GoodPagedResponse.new(
+        users: [
+          Google::Protobuf::User.new(name: 'foo'),
+          Google::Protobuf::User.new(name: 'bar')
+        ],
+        next_page_token: 'next'
+      ),
+      Google::Protobuf::GoodPagedResponse.new(
+        users: [
+          Google::Protobuf::User.new(name: 'baz'),
+          Google::Protobuf::User.new(name: 'bif')
+        ]
+      )
+    ]
+    paged_enum = Google::Gax::PagedEnumerable.new(
+      'page_token', 'next_page_token', 'users'
+    )
+    api_call = lambda do |_req, _blk = nil|
+      api_responses.shift
+    end
+    request = Google::Protobuf::GoodPagedRequest.new
+    fake_settings = OpenStruct.new(page_token: nil)
+    paged_enum.start(api_call, request, fake_settings, nil)
+
+    exp_names = []
+    paged_enum.each do |user|
+      exp_names << user.name
+    end
+    expect(exp_names).to eq(%w[foo bar baz bif])
+  end
+
+  it 'enumerates all pages' do
+    api_responses = [
+      Google::Protobuf::GoodPagedResponse.new(
+        users: [
+          Google::Protobuf::User.new(name: 'foo'),
+          Google::Protobuf::User.new(name: 'bar')
+        ],
+        next_page_token: 'next'
+      ),
+      Google::Protobuf::GoodPagedResponse.new(
+        users: [
+          Google::Protobuf::User.new(name: 'baz'),
+          Google::Protobuf::User.new(name: 'bif')
+        ]
+      )
+    ]
+    paged_enum = Google::Gax::PagedEnumerable.new(
+      'page_token', 'next_page_token', 'users'
+    )
+    api_call = lambda do |_req, _blk = nil|
+      api_responses.shift
+    end
+    request = Google::Protobuf::GoodPagedRequest.new
+    fake_settings = OpenStruct.new(page_token: nil)
+    paged_enum.start(api_call, request, fake_settings, nil)
+
+    exp_names = []
+    paged_enum.each_page do |page|
+      exp_page_names = []
+      page.each do |user|
+        exp_page_names << user.name
+      end
+      exp_names << exp_page_names
+    end
+    expect(exp_names).to eq([%w[foo bar], %w[baz bif]])
+  end
+end

data/spec/google/gax/path_template_spec.rb

@@ -141,6 +141,20 @@ describe Google::Gax::PathTemplate do
       want = 'bar/1/2/foo/3'
       expect(template.render(**params)).to eq(want)
     end
+
+    it 'handles path values with spaces' do
+      template = PathTemplate.new('bar/**/foo/*')
+      params = symbolize_keys('$0' => '1 - 2', '$1' => '3')
+      want = 'bar/1 - 2/foo/3'
+      expect(template.render(**params)).to eq(want)
+    end
+
+    it 'handles named path values with spaces' do
+      template = PathTemplate.new('bar/{bif}/foo/{baz}')
+      params = symbolize_keys(bif: '1 - 2', baz: '3/4')
+      want = 'bar/1 - 2/foo/3/4'
+      expect(template.render(**params)).to eq(want)
+    end
   end
 
   describe 'method `to_s`' do

data/spec/google/gax/settings_spec.rb

@@ -63,6 +63,9 @@ A_CONFIG = {
         'SomeHTTPSPageStreamingMethod' => {
           'retry_codes_name' => 'bar_retry',
           'retry_params_name' => 'default'
+        },
+        'TimeoutMethod' => {
+          'timeout_millis' => 10_000
         }
       }
     }
@@ -119,6 +122,9 @@ describe Google::Gax do
     )
     expect(settings.metadata).to match('key' => 'value')
     expect(settings.errors).to match_array([StandardError])
+
+    settings = defaults['timeout_method']
+    expect(settings.timeout).to be(10)
   end
 
   it 'overrides settings' do
@@ -129,6 +135,9 @@ describe Google::Gax do
             'SomeHTTPSPageStreamingMethod' => nil,
             'BundlingMethod' => {
               'bundling' => nil
+            },
+            'TimeoutMethod' => {
+              'timeout_millis' => nil
             }
           }
         }
@@ -149,6 +158,9 @@ describe Google::Gax do
     expect(settings.timeout).to be(30)
     expect(settings.page_descriptor).to be_a(Google::Gax::PageDescriptor)
     expect(settings.retry_options).to be_nil
+
+    settings = defaults['timeout_method']
+    expect(settings.timeout).to be(30)
   end
 
   it 'overrides settings more precisely' do
@@ -174,6 +186,9 @@ describe Google::Gax do
             'BundlingMethod' => {
               'retry_params_name' => 'default',
               'retry_codes_name' => 'baz_retry'
+            },
+            'TimeoutMethod' => {
+              'timeout_millis' => 20_000
             }
           }
         }
@@ -205,5 +220,8 @@ describe Google::Gax do
     expect(settings.retry_options.retry_codes).to match_array(
       [RETRY_DICT['code_c']]
     )
+
+    settings = defaults['timeout_method']
+    expect(settings.timeout).to be(20)
   end
 end

metadata

@@ -1,42 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.2
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: googleapis-common-protos
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.3.9
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -46,17 +54,17 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.3.9
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos
+  name: googleapis-common-protos-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -66,7 +74,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.0.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -76,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rly
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +206,7 @@ files:
 - spec/google/gax/error_spec.rb
 - spec/google/gax/grpc_spec.rb
 - spec/google/gax/operation_spec.rb
+- spec/google/gax/paged_enumerable_spec.rb
 - spec/google/gax/path_template_spec.rb
 - spec/google/gax/settings_spec.rb
 - spec/google/gax/util_spec.rb
@@ -207,7 +216,15 @@ homepage: https://github.com/googleapis/gax-ruby
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message: |
+  *******************************************************************************
+  The google-gax gem is officially end-of-life and will not be updated further.
+
+  If your app uses the google-gax gem, it likely is using obsolete versions of
+  some Google Cloud client library (google-cloud-*) gem that depends on it. We
+  recommend updating any such libraries that depend on google-gax. Modern Google
+  Cloud client libraries will depend on the gapic-common gem instead.
+  *******************************************************************************
 rdoc_options: []
 require_paths:
 - lib
@@ -215,14 +232,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Aids the development of APIs for clients and servers based on GRPC and Google