google-cloud-pubsub 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5da61231a73b0823ab46134a7e6405ece35e996245f81c3af1c65fef838223f1
-  data.tar.gz: c81dd4e57f758fa03b118b30f98d6c72e3cf01ad851560064191f9666582d2b7
+  metadata.gz: e56f8ca6212ea03d9ede9593222eda8574a047d56e9c60e3149b722eb4951197
+  data.tar.gz: ac2802eb09654de3efb5011fd15d49f3a51a2ae0b794bee78a4b955adf5748d2
 SHA512:
-  metadata.gz: 3836f7e50294bfb38760821cb056be595b0f35b50da70c52b417ee8b6274c8e95f3f320a52fe28c50ba1005ce1f67553ddc1a054e4eea7fa8099b0207600c832
-  data.tar.gz: b5bfb8729b9ac7ad067cb51b2812f777377b7b1737e9e1b4e5198aee2fa7fa856b9e9307314ba087094a417ce634ed22ae1096b945876066c9095809e6239f67
+  metadata.gz: 3dc04aba0cecb3560aa8c667b3e9c79be288f14db5060d9624138f552bfdfe6cdfcc9a3114a977dbeb2918c94527ab166bd111711755796b40b6a672789b6a92
+  data.tar.gz: ae94d8fe7a07afb8a893f3b5ddc102b0b01a4b7649f84c5cda27c6e57dbe535adf8b87c6cc22f0f96af117464efa04997b4db54c6775d5f9fad43d0ea14550e1

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Release History
 
+### 2.9.0 / 2021-10-28
+
+#### Features
+
+* Expand timeout type from Integer to Numeric
+  * feat: Expand timeout type from Integer to Numeric. This is backwards-compatible.
+    * Change timeout from Integer to Numeric in Google::Cloud.pubsub
+    * Change timeout from Integer to Numeric in Google::Cloud#pubsub
+    * Change timeout from Integer to Numeric in Google::Cloud::PubSub.configure
+    * Change timeout from Integer to Numeric in Google::Cloud::PubSub.new
+  * fix: Propagate timeout to client RPC configs.
+
+#### Documentation
+
+* Add documentation for quota_project Configuration attribute
+* Fix documentation for PubSub.configure
+  * Remove retries property that does not exist in code.
+
 ### 2.8.1 / 2021-09-22
 
 #### Bug Fixes

data/lib/google/cloud/pubsub/service.rb

@@ -51,7 +51,7 @@ module Google
           return mocked_subscriber if mocked_subscriber
           @subscriber ||= V1::Subscriber::Client.new do |config|
             config.credentials = credentials if credentials
-            config.timeout = timeout if timeout
+            override_client_config_timeouts config if timeout
             config.endpoint = host if host
             config.lib_name = "gccl"
             config.lib_version = Google::Cloud::PubSub::VERSION
@@ -64,7 +64,7 @@ module Google
           return mocked_publisher if mocked_publisher
           @publisher ||= V1::Publisher::Client.new do |config|
             config.credentials = credentials if credentials
-            config.timeout = timeout if timeout
+            override_client_config_timeouts config if timeout
             config.endpoint = host if host
             config.lib_name = "gccl"
             config.lib_version = Google::Cloud::PubSub::VERSION
@@ -77,7 +77,7 @@ module Google
           return mocked_iam if mocked_iam
           @iam ||= V1::IAMPolicy::Client.new do |config|
             config.credentials = credentials if credentials
-            config.timeout = timeout if timeout
+            override_client_config_timeouts config if timeout
             config.endpoint = host if host
             config.lib_name = "gccl"
             config.lib_version = Google::Cloud::PubSub::VERSION
@@ -90,7 +90,7 @@ module Google
           return mocked_schemas if mocked_schemas
           @schemas ||= V1::SchemaService::Client.new do |config|
             config.credentials = credentials if credentials
-            config.timeout = timeout if timeout
+            override_client_config_timeouts config if timeout
             config.endpoint = host if host
             config.lib_name = "gccl"
             config.lib_version = Google::Cloud::PubSub::VERSION
@@ -461,6 +461,18 @@ module Google
 
         protected
 
+        # Set the timeout in the client config.
+        # Override the default timeout in each individual RPC config as well, since when they are non-nil, these
+        # defaults have precedence over the top-level config.timeout. See Gapic::CallOptions#apply_defaults.
+        def override_client_config_timeouts config
+          config.timeout = timeout
+          rpc_names = config.rpcs.methods - Object.methods
+          rpc_names.each do |rpc_name|
+            rpc = config.rpcs.send rpc_name
+            rpc.timeout = timeout if rpc.respond_to? :timeout=
+          end
+        end
+
         def a_time? obj
           return false unless obj.respond_to? :to_time
           # Rails' String#to_time returns nil if the string doesn't parse.

data/lib/google/cloud/pubsub/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "2.8.1".freeze
+      VERSION = "2.9.0".freeze
     end
 
     Pubsub = PubSub unless const_defined? :Pubsub

data/lib/google/cloud/pubsub.rb

@@ -54,7 +54,7 @@ module Google
       #   The default scope is:
       #
       #   * `https://www.googleapis.com/auth/pubsub`
-      # @param [Integer] timeout Default timeout to use in requests. Optional.
+      # @param [Numeric] timeout Default timeout to use in requests. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] emulator_host Pub/Sub emulator host. Optional.
@@ -121,9 +121,9 @@ module Google
       #   parameter `keyfile` is considered deprecated, but may also be used.)
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
-      # * `retries` - (Integer) Number of times to retry requests on server
-      #   error.
-      # * `timeout` - (Integer) Default timeout to use in requests.
+      # * `quota_project` - (String) The project ID for a project that can be
+      #   used by client libraries for quota and billing purposes.
+      # * `timeout` - (Numeric) Default timeout to use in requests.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
       # * `emulator_host` - (String) Host name of the emulator. Defaults to

data/lib/google-cloud-pubsub.rb

@@ -41,7 +41,7 @@ module Google
     #   The default scope is:
     #
     #   * `https://www.googleapis.com/auth/pubsub`
-    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Numeric] timeout Default timeout to use in requests. Optional.
     #
     # @return [Google::Cloud::PubSub::Project]
     #
@@ -87,7 +87,7 @@ module Google
     #   The default scope is:
     #
     #   * `https://www.googleapis.com/auth/pubsub`
-    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Numeric] timeout Default timeout to use in requests. Optional.
     #
     # @return [Google::Cloud::PubSub::Project]
     #
@@ -133,7 +133,7 @@ Google::Cloud.configure.add_config! :pubsub do |config|
   config.add_alias! :keyfile, :credentials
   config.add_field! :scope, default_scopes, match: [String, Array]
   config.add_field! :quota_project, nil, match: String
-  config.add_field! :timeout, nil, match: Integer
+  config.add_field! :timeout, nil, match: Numeric
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
   config.add_field! :on_error, nil, match: Proc
   config.add_field! :endpoint, "pubsub.googleapis.com", match: String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby