google-cloud-pubsub 2.7.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6636ac65229c0dc438c63fa9aebda474396701364bfbea7e5da460ceea50a26
-  data.tar.gz: a0c0cafbbaf4083c1141d851dc6cecb8cb70bc01df940a139fe21d057aa2fb97
+  metadata.gz: e56f8ca6212ea03d9ede9593222eda8574a047d56e9c60e3149b722eb4951197
+  data.tar.gz: ac2802eb09654de3efb5011fd15d49f3a51a2ae0b794bee78a4b955adf5748d2
 SHA512:
-  metadata.gz: a187e9935196b66d4be65c7cf7b34148de36197f9e2c5e9144ccc9f78652370d7a441b33e14a002133b05aa6565cc38998912277e8896d81178bf5712ce9df8c
-  data.tar.gz: ee801f9d5959f5e2a38ccf13beaac930ca4629c81a268b627a8bacc7ad9ce430581fd690100fa5ef57b4fa5e20e3c5f40d72e905ce2535d978398f03112a48eb
+  metadata.gz: 3dc04aba0cecb3560aa8c667b3e9c79be288f14db5060d9624138f552bfdfe6cdfcc9a3114a977dbeb2918c94527ab166bd111711755796b40b6a672789b6a92
+  data.tar.gz: ae94d8fe7a07afb8a893f3b5ddc102b0b01a4b7649f84c5cda27c6e57dbe535adf8b87c6cc22f0f96af117464efa04997b4db54c6775d5f9fad43d0ea14550e1

data/AUTHENTICATION.md

@@ -96,7 +96,8 @@ client = Google::Cloud::PubSub.new
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Project ID** and the path to the **Credentials JSON** file can be configured
+instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
 require "google/cloud/pubsub"

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # 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
+
+* Change IAM and Schema client metadata hash keys to symbols
+
+#### Documentation
+
+* Fix typo in Emulator guide links
+
+### 2.8.0 / 2021-08-30
+
+#### Features
+
+* Add Pub/Sub topic retention fields
+  * Add retention to Project#create_topic
+  * Add Topic#retention
+  * Add Topic#retention=
+  * Add Subscription#topic_retention
+
+### 2.7.1 / 2021-07-08
+
+#### Documentation
+
+* Update AUTHENTICATION.md in handwritten packages
+
 ### 2.7.0 / 2021-06-15
 
 #### Features

data/OVERVIEW.md

@@ -524,5 +524,5 @@ sub.topic.name #=> "projects/other-project-id/topics/other-topic"
 ## Additional information
 
 Google Cloud Pub/Sub can be configured to use an emulator or to enable gRPC's
-logging. To learn more, see the {file:EMULATOR.md Emulator guide}} and
+logging. To learn more, see the {file:EMULATOR.md Emulator guide} and
 {file:LOGGING.md Logging guide}.

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

@@ -238,6 +238,14 @@ module Google
         #   * `JSON` - JSON encoding.
         #   * `BINARY` - Binary encoding, as defined by the schema type. For some
         #     schema types, binary encoding may not be available.
+        # @param [Numeric] retention Indicates the minimum number of seconds to retain a message
+        #   after it is published to the topic. If this field is set, messages published
+        #   to the topic within the `retention` number of seconds are always available to
+        #   subscribers. For instance, it allows any attached subscription to [seek to a
+        #   timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
+        #   that is up to `retention` number of seconds in the past. If this field is
+        #   not set, message retention is controlled by settings on individual
+        #   subscriptions. Cannot be less than 600 (10 minutes) or more than 604,800 (7 days).
         #
         # @return [Google::Cloud::PubSub::Topic]
         #
@@ -253,14 +261,16 @@ module Google
                          persistence_regions: nil,
                          async: nil,
                          schema_name: nil,
-                         message_encoding: nil
+                         message_encoding: nil,
+                         retention: nil
           ensure_service!
           grpc = service.create_topic topic_name,
                                       labels:              labels,
                                       kms_key_name:        kms_key,
                                       persistence_regions: persistence_regions,
                                       schema_name:         schema_name,
-                                      message_encoding:    message_encoding
+                                      message_encoding:    message_encoding,
+                                      retention:           retention
           Topic.from_grpc grpc, service, async: async
         end
         alias new_topic create_topic

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,11 +77,11 @@ 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
-            config.metadata = { "google-cloud-resource-prefix" => "projects/#{@project}" }
+            config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}" }
           end
         end
         attr_accessor :mocked_iam
@@ -90,11 +90,11 @@ 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
-            config.metadata = { "google-cloud-resource-prefix" => "projects/#{@project}" }
+            config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}" }
           end
         end
         attr_accessor :mocked_schemas
@@ -127,6 +127,7 @@ module Google
                          persistence_regions: nil,
                          schema_name: nil,
                          message_encoding: nil,
+                         retention: nil,
                          options: {}
           if persistence_regions
             message_storage_policy = Google::Cloud::PubSub::V1::MessageStoragePolicy.new(
@@ -145,11 +146,12 @@ module Google
           end
 
           publisher.create_topic \
-            name:                   topic_path(topic_name, options),
-            labels:                 labels,
-            kms_key_name:           kms_key_name,
-            message_storage_policy: message_storage_policy,
-            schema_settings:        schema_settings
+            name:                       topic_path(topic_name, options),
+            labels:                     labels,
+            kms_key_name:               kms_key_name,
+            message_storage_policy:     message_storage_policy,
+            schema_settings:            schema_settings,
+            message_retention_duration: Convert.number_to_duration(retention)
         end
 
         def update_topic topic_obj, *fields
@@ -459,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/subscription.rb

@@ -168,9 +168,8 @@ module Google
         # backlog, from the moment a message is published. If
         # {#retain_acked} is `true`, then this also configures the retention of
         # acknowledged messages, and thus configures how far back in time a
-        # {#seek} can be done. Cannot be more than 604,800 seconds (7 days) or
-        # less than 600 seconds (10 minutes). Default is 604,800 seconds (7
-        # days).
+        # {#seek} can be done. Cannot be less than 600 (10 minutes) or more
+        # than 604,800 (7 days). Default is 604,800 seconds (7 days).
         #
         # Makes an API call to retrieve the retention value when called on a
         # reference object. See {#reference?}.
@@ -195,6 +194,24 @@ module Google
           @resource_name = nil
         end
 
+        ##
+        # Indicates the minimum duration for which a message is retained after
+        # it is published to the subscription's topic. If this field is set,
+        # messages published to the subscription's topic in the last
+        # `topic_message_retention_duration` are always available to subscribers.
+        # Output only. See {Topic#retention}.
+        #
+        # Makes an API call to retrieve the retention value when called on a
+        # reference object. See {#reference?}.
+        #
+        # @return [Numeric, nil] The topic message retention duration in seconds,
+        #   or `nil` if not set.
+        #
+        def topic_retention
+          ensure_grpc!
+          Convert.duration_to_number @grpc.topic_message_retention_duration
+        end
+
         ##
         # Returns the URL locating the endpoint to which messages should be
         # pushed. For example, a Webhook endpoint might use

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

@@ -305,6 +305,43 @@ module Google
           message_encoding.to_s.upcase == "JSON"
         end
 
+        ##
+        # Indicates the minimum number of seconds to retain a message after it is
+        # published to the topic. If this field is set, messages published to the topic
+        # within the `retention` number of seconds are always available to subscribers.
+        # For instance, it allows any attached subscription to [seek to a
+        # timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
+        # that is up to `retention` number of seconds in the past. If this field is
+        # not set, message retention is controlled by settings on individual
+        # subscriptions. Cannot be less than 600 (10 minutes) or more than 604,800 (7 days).
+        # See {#retention=}.
+        #
+        # Makes an API call to retrieve the retention value when called on a
+        # reference object. See {#reference?}.
+        #
+        # @return [Numeric, nil] The message retention duration in seconds, or `nil` if not set.
+        #
+        def retention
+          ensure_grpc!
+          Convert.duration_to_number @grpc.message_retention_duration
+        end
+
+        ##
+        # Sets the message retention duration in seconds. If set to a positive duration
+        # between 600 (10 minutes) and 604,800 (7 days), inclusive, the message retention
+        # duration is changed. If set to `nil`, this clears message retention duration
+        # from the topic. See {#retention}.
+        #
+        # @param [Numeric, nil] new_retention The new message retention duration value.
+        #
+        def retention= new_retention
+          new_retention_duration = Convert.number_to_duration new_retention
+          update_grpc = Google::Cloud::PubSub::V1::Topic.new name: name,
+                                                             message_retention_duration: new_retention_duration
+          @grpc = service.update_topic update_grpc, :message_retention_duration
+          @resource_name = nil
+        end
+
         ##
         # Permanently deletes the topic.
         #

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "2.7.0".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.7.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby