google-cloud-pubsub 1.9.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfbd62e0e48c406ed08325e5a216f03a0afc4f8319c5ef144fbb6b1fa189e16c
-  data.tar.gz: 31995baf9d81c17e1c867efb5584da5d0be27e1baa3bfa256311e803d43cbfb9
+  metadata.gz: e9e9ee1f9fce40c034c43b3cf0e11b8e52dc5ebdc1c43f6077cfff620b812dd8
+  data.tar.gz: 6d29efc615b2bb5185a013c9dbb72811f130acdcee452343f53c7c6c1881ce3b
 SHA512:
-  metadata.gz: 8d50149459ec7bc696a15785ae7f0d77777d9f95edefb4da0775f9e005c25cd8cfe17d20899649fb17c6fc928eb9e0bbc0baddce26afc773d300c54728b04bd6
-  data.tar.gz: b599664094c01fc88030478e9076ad72a73ceb6bb3aa4b3a64240193694f0d47f6a34bbbd2ab8ce1188c45d6bbd6322d91e91f157362de0a8a6307c002e6084a
+  metadata.gz: '0649f14787b5d7c59e6aa7cfcf7df321b63ac5faeda81c756c793cecf57a8ba31f9691c05816d7088cf40d8c1a80c36134a58b4658d381cfa05cb745687fcf1d'
+  data.tar.gz: a5a82376726956e5dee8dff1e17e64ddf54a2c8100830d15b1c3a17accd9fdc364b8d42051c29a86524a221c7cb14bbf300e3c0ce1f09fde678c2e8cf03fc1b8

data/AUTHENTICATION.md

@@ -76,7 +76,8 @@ The environment variables that google-cloud-pubsub checks for project ID are:
 1. `PUBSUB_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-pubsub checks for credentials are configured on {Google::Cloud::PubSub::V1::Credentials}:
+The environment variables that google-cloud-pubsub checks for credentials
+are configured on {Google::Cloud::PubSub::Credentials}:
 
 1. `PUBSUB_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `PUBSUB_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,58 @@
 # Release History
 
+### 2.2.0 / 2020-11-11
+
+#### Features
+
+* Add Subscription#remove_dead_letter_policy
+
+### 2.1.1 / 2020-10-26
+
+#### Documentation
+
+* Update deprecated attribute name limit to max_outstanding_messages
+
+### 2.1.0 / 2020-09-17
+
+#### Features
+
+* quota_project can be set via library configuration ([#7630](https://www.github.com/googleapis/google-cloud-ruby/issues/7630))
+* Add push_config (PushConfig) param to Topic#subscribe
+  * Make PushConfig constructor public.
+
+#### Documentation
+
+* Update sample code for on_error, at_exit, and concurrency tuning
+
+### 2.0.0 / 2020-08-06
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-pubsub-v1` gem as a dependency.
+The new dependency is a rewritten low-level client, produced by a next-
+generation client code generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-pubsub-v1`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::PubSub::V1` module,
+please review the docs for the new `google-cloud-pubsub-v1` gem. In
+particular:
+
+* Some classes have been renamed, notably the client classes themselves.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
+### 1.10.0 / 2020-07-23
+
+#### Features
+
+* Add Subscription#detach and #detached?
+
 ### 1.9.0 / 2020-07-21
 
 #### Features

data/OVERVIEW.md

@@ -142,7 +142,7 @@ topic.publish_async "task completed" do |result|
   end
 end
 
-topic.async_publisher.stop.wait!
+topic.async_publisher.stop!
 ```
 
 Or multiple messages can be published in batches at the same time by passing a
@@ -174,16 +174,32 @@ pubsub = Google::Cloud::PubSub.new
 
 sub = pubsub.subscription "my-topic-sub"
 
-subscriber = sub.listen do |received_message|
+# Create a subscriber to listen for available messages.
+# By default, this block will be called on 8 concurrent threads
+# but this can be tuned with the `threads` option.
+# The `streams` and `inventory` parameters allow further tuning.
+subscriber = sub.listen threads: { callback: 16 } do |received_message|
   # process message
+  puts "Data: #{received_message.message.data}, published at #{received_message.message.published_at}"
   received_message.acknowledge!
 end
 
+# Handle exceptions from listener
+subscriber.on_error do |exception|
+  puts "Exception: #{exception.class} #{exception.message}"
+end
+
+# Gracefully shut down the subscriber on program exit, blocking until
+# all received messages have been processed or 10 seconds have passed
+at_exit do
+  subscriber.stop!(10)
+end
+
 # Start background threads that will call the block passed to listen.
 subscriber.start
 
-# Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
+# Block, letting processing threads continue in the background
+sleep
 ```
 
 Messages also can be pulled directly in a one-time operation. (See
@@ -235,7 +251,7 @@ end
 subscriber.start
 
 # Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
+subscriber.stop!
 ```
 
 Or, multiple messages can be acknowledged in a single API call: (See
@@ -277,7 +293,7 @@ end
 subscriber.start
 
 # Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
+subscriber.stop!
 ```
 
 The message can also be made available for immediate redelivery:
@@ -299,7 +315,7 @@ end
 subscriber.start
 
 # Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
+subscriber.stop!
 ```
 
 Multiple messages can be delayed or made available for immediate redelivery:
@@ -353,7 +369,7 @@ topic.publish_async "task completed",
                     ordering_key: "task-key"
 
 # Shut down the publisher when ready to stop publishing messages.
-topic.async_publisher.stop.wait!
+topic.async_publisher.stop!
 ```
 
 ### Handling errors with Ordered Keys
@@ -395,7 +411,7 @@ end
 subscriber.start
 
 # Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
+subscriber.stop!
 ```
 
 ## Minimizing API calls before receiving and acknowledging messages
@@ -425,7 +441,7 @@ end
 subscriber.start
 
 # Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
+subscriber.stop!
 ```
 
 Skipping API calls may be used to avoid `Google::Cloud::PermissionDeniedError`
@@ -464,54 +480,6 @@ sub.acknowledge received_messages
 sub.seek snapshot
 ```
 
-## Listening for Messages
-
-A subscriber object can be created using `listen`, which streams messages from
-the backend and processes them as they are received. (See
-{Google::Cloud::PubSub::Subscription#listen Subscription#listen} and
-{Google::Cloud::PubSub::Subscriber Subscriber})
-
-```ruby
-require "google/cloud/pubsub"
-
-pubsub = Google::Cloud::PubSub.new
-
-sub = pubsub.subscription "my-topic-sub"
-
-subscriber = sub.listen do |received_message|
-  # process message
-  received_message.acknowledge!
-end
-
-# Start background threads that will call the block passed to listen.
-subscriber.start
-
-# Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
-```
-
-The subscriber object can be configured to control the number of concurrent
-streams to open, the number of received messages to be collected, and the number
-of threads each stream opens for concurrent calls made to handle the received
-messages.
-
-```ruby
-require "google/cloud/pubsub"
-
-pubsub = Google::Cloud::PubSub.new
-
-sub = pubsub.subscription "my-topic-sub"
-
-subscriber = sub.listen threads: { callback: 16 } do |received_message|
-  # store the message somewhere before acknowledging
-  store_in_backend received_message.data # takes a few seconds
-  received_message.acknowledge!
-end
-
-# Start background threads that will call the block passed to listen.
-subscriber.start
-```
-
 ## Working Across Projects
 
 All calls to the Pub/Sub service use the same project and credentials provided

data/lib/google-cloud-pubsub.rb

@@ -42,8 +42,6 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/pubsub`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::PubSub::Project]
     #
@@ -62,9 +60,9 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   pubsub = gcloud.pubsub scope: platform_scope
     #
-    def pubsub scope: nil, timeout: nil, client_config: nil
+    def pubsub scope: nil, timeout: nil
       timeout ||= @timeout
-      Google::Cloud.pubsub @project, @keyfile, scope: scope, timeout: timeout, client_config: client_config
+      Google::Cloud.pubsub @project, @keyfile, scope: scope, timeout: timeout
     end
 
     ##
@@ -90,8 +88,6 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/pubsub`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
     # @return [Google::Cloud::PubSub::Project]
     #
@@ -103,11 +99,12 @@ module Google
     #   topic = pubsub.topic "my-topic"
     #   topic.publish "task completed"
     #
-    def self.pubsub project_id = nil, credentials = nil, scope: nil,
-                    timeout: nil, client_config: nil
+    def self.pubsub project_id = nil,
+                    credentials = nil,
+                    scope: nil,
+                    timeout: nil
       require "google/cloud/pubsub"
-      Google::Cloud::PubSub.new project_id: project_id, credentials: credentials,
-                                scope: scope, timeout: timeout, client_config: client_config
+      Google::Cloud::PubSub.new project_id: project_id, credentials: credentials, scope: scope, timeout: timeout
     end
   end
 end
@@ -125,15 +122,19 @@ Google::Cloud.configure.add_config! :pubsub do |config|
   default_emulator = Google::Cloud::Config.deferred do
     ENV["PUBSUB_EMULATOR_HOST"]
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/pubsub"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
   config.add_field! :credentials, default_creds, match: [String, Hash, Google::Auth::Credentials], allow_nil: true
   config.add_alias! :keyfile, :credentials
-  config.add_field! :scope, nil, match: [String, Array]
+  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! :client_config, nil, match: Hash
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
   config.add_field! :on_error, nil, match: Proc
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :endpoint, "pubsub.googleapis.com", match: String
 end

data/lib/google/cloud/pubsub.rb

@@ -57,8 +57,6 @@ module Google
       #
       #   * `https://www.googleapis.com/auth/pubsub`
       # @param [Integer] timeout Default timeout to use in requests. Optional.
-      # @param [Hash] client_config A hash of values to override the default
-      #   behavior of the API client. 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.
@@ -77,12 +75,17 @@ module Google
       #   topic = pubsub.topic "my-topic"
       #   topic.publish "task completed"
       #
-      def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil, client_config: nil, endpoint: nil,
-                   emulator_host: nil, project: nil, keyfile: nil
+      def self.new project_id: nil,
+                   credentials: nil,
+                   scope: nil,
+                   timeout: nil,
+                   endpoint: nil,
+                   emulator_host: nil,
+                   project: nil,
+                   keyfile: nil
         project_id    ||= (project || default_project_id)
         scope         ||= configure.scope
         timeout       ||= configure.timeout
-        client_config ||= configure.client_config
         endpoint      ||= configure.endpoint
         emulator_host ||= configure.emulator_host
 
@@ -90,11 +93,8 @@ module Google
           project_id = project_id.to_s # Always cast to a string
           raise ArgumentError, "project_id is missing" if project_id.empty?
 
-          return PubSub::Project.new(
-            PubSub::Service.new(
-              project_id, :this_channel_is_insecure, host: emulator_host, timeout: timeout, client_config: client_config
-            )
-          )
+          service = PubSub::Service.new project_id, :this_channel_is_insecure, host: emulator_host, timeout: timeout
+          return PubSub::Project.new service
         end
 
         credentials ||= (keyfile || default_credentials(scope: scope))
@@ -106,11 +106,8 @@ module Google
         project_id = project_id.to_s # Always cast to a string
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        PubSub::Project.new(
-          PubSub::Service.new(
-            project_id, credentials, timeout: timeout, host: endpoint, client_config: client_config
-          )
-        )
+        service = PubSub::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        PubSub::Project.new service
       end
 
       # rubocop:enable Metrics/AbcSize
@@ -131,8 +128,6 @@ module Google
       # * `retries` - (Integer) Number of times to retry requests on server
       #   error.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `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
@@ -167,7 +162,9 @@ module Google
       end
     end
 
-    ## Legacy namespace
+    ## Legacy veneer namespace
     Pubsub = PubSub unless const_defined? :Pubsub
   end
+  ## Legacy generated client namespace
+  Pubsub = Cloud::PubSub unless const_defined? :Pubsub
 end

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

@@ -42,7 +42,7 @@ module Google
       #     end
       #   end
       #
-      #   topic.async_publisher.stop.wait!
+      #   topic.async_publisher.stop!
       #
       # @attr_reader [String] topic_name The name of the topic the messages are published to. In the form of
       #   "/projects/project-identifier/topics/topic-name".
@@ -374,8 +374,7 @@ module Google
 
         PUBLISH_RETRY_ERRORS = [
           GRPC::Cancelled, GRPC::DeadlineExceeded, GRPC::Internal,
-          GRPC::ResourceExhausted, GRPC::Unauthenticated, GRPC::Unavailable,
-          GRPC::Core::CallError
+          GRPC::ResourceExhausted, GRPC::Unauthenticated, GRPC::Unavailable
         ].freeze
 
         def publish_batch_error_retryable? error

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

@@ -14,7 +14,7 @@
 
 
 require "googleauth"
-require "google/cloud/pubsub/v1/credentials.rb"
+require "google/cloud/pubsub/v1/publisher/credentials.rb"
 
 module Google
   module Cloud
@@ -38,7 +38,7 @@ module Google
       #
       #   pubsub.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::PubSub::V1::Credentials
+      class Credentials < Google::Cloud::PubSub::V1::Publisher::Credentials
       end
     end
 

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

@@ -50,7 +50,7 @@ module Google
       #   subscriber.start
       #
       #   # Shut down the subscriber when ready to stop receiving messages.
-      #   subscriber.stop.wait!
+      #   subscriber.stop!
       #
       class Message
         ##

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

@@ -141,7 +141,7 @@ module Google
         #     end
         #   end
         #
-        #   topic.async_publisher.stop.wait!
+        #   topic.async_publisher.stop!
         #
         def topic topic_name, project: nil, skip_lookup: nil, async: nil
           ensure_service!

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

@@ -39,7 +39,7 @@ module Google
       #   subscriber.start
       #
       #   # Shut down the subscriber when ready to stop receiving messages.
-      #   subscriber.stop.wait!
+      #   subscriber.stop!
       #
       class ReceivedMessage
         ##
@@ -177,7 +177,7 @@ module Google
         #   subscriber.start
         #
         #   # Shut down the subscriber when ready to stop receiving messages.
-        #   subscriber.stop.wait!
+        #   subscriber.stop!
         #
         def acknowledge!
           ensure_subscription!
@@ -214,7 +214,7 @@ module Google
         #   subscriber.start
         #
         #   # Shut down the subscriber when ready to stop receiving messages.
-        #   subscriber.stop.wait!
+        #   subscriber.stop!
         #
         def modify_ack_deadline! new_deadline
           ensure_subscription!
@@ -244,7 +244,7 @@ module Google
         #   subscriber.start
         #
         #   # Shut down the subscriber when ready to stop receiving messages.
-        #   subscriber.stop.wait!
+        #   subscriber.stop!
         #
         def reject!
           modify_ack_deadline! 0