google-cloud-pubsub 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af82f9222001a7e9b8a4648b53370da523629e3950822ec70b2994c7ff1ab69
-  data.tar.gz: c65a361d505e5416be05189668fb62260b91eabb89be8fedc8b4928a9a0724dc
+  metadata.gz: 2d44dfbd212a70cfa64b25b0278a651c84c386414119644b9f92c8a2041c5c6c
+  data.tar.gz: 84b93c12184314f5157b913ae4769ca1d21e0070a3a78490012da5639bcd68cb
 SHA512:
-  metadata.gz: e0fd3399bed14e3ec636a352cefc9c03a34f76ad20adbd12c3c043bdebf23ea75c68b9cab5e0fe0e259911b7a466f8b0e4d0b138ea9cd3244653d13749b38920
-  data.tar.gz: 91243885834f4cb5c3423bc8f6e75383d95cbdb5b09b6a4bd409b701a6c0433838882188a28cf150302cd4ea3fa8c48afc669f7590d9578d67858b246ad77fc7
+  metadata.gz: 2fd9a8b1cfab5e94add3c5433c17ee59a37eabf97aac952a6fdc6c5d5f0618d06ca9063a2ef96c3e2d4355a43a51ff9f2d40cd953cc77a9e2f0e6c615c307428
+  data.tar.gz: daf39d392c2262faf7a2d5cc2db95ce145197c62e158fa4ce6acfa943a8ad6166002c26b4fd7c240dae1d3ddd1919de7ad3ae9018b61ff4d087740285f02ba99

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### 2.3.2 / 2021-02-08
+
+#### Bug Fixes
+
+* Fix project option in Project#topic and Project#subscription
+  * Ensure that project option is used when skip_lookup is false.
+  * Improve documentation of topic_name, subscription_name and snapshot_name.
+
 ### 2.3.1 / 2021-01-13
 
 #### Bug Fixes

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

@@ -44,8 +44,8 @@ module Google
       #
       #   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".
+      # @attr_reader [String] topic_name The name of the topic the messages are published to. The value is a
+      #   fully-qualified topic name in the form `projects/{project_id}/topics/{topic_id}`.
       # @attr_reader [Integer] max_bytes The maximum size of messages to be collected before the batch is published.
       #   Default is 1,000,000 (1MB).
       # @attr_reader [Integer] max_messages The maximum number of messages to be collected before the batch is

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

@@ -75,10 +75,14 @@ module Google
         ##
         # Retrieves topic by name.
         #
-        # @param [String] topic_name Name of a topic.
+        # @param [String] topic_name Name of a topic. The value can be a simple
+        #   topic ID (relative name), in which case the current project ID will
+        #   be supplied, or a fully-qualified topic name in the form
+        #   `projects/{project_id}/topics/{topic_id}`.
         # @param [String] project If the topic belongs to a project other than
         #   the one currently connected to, the alternate project ID can be
-        #   specified here. Optional.
+        #   specified here. Optional. Not used if a fully-qualified topic name
+        #   is provided for `topic_name`.
         # @param [Boolean] skip_lookup Optionally create a {Topic} object
         #   without verifying the topic resource exists on the Pub/Sub service.
         #   Calls made on this object will raise errors if the topic resource
@@ -147,7 +151,7 @@ module Google
           ensure_service!
           options = { project: project }
           return Topic.from_name topic_name, service, options if skip_lookup
-          grpc = service.get_topic topic_name
+          grpc = service.get_topic topic_name, options
           Topic.from_grpc grpc, service, async: async
         rescue Google::Cloud::NotFoundError
           nil
@@ -158,7 +162,16 @@ module Google
         ##
         # Creates a new topic.
         #
-        # @param [String] topic_name Name of a topic.
+        # @param [String] topic_name Name of a topic. Required.
+        #   The value can be a simple topic ID (relative name), in which
+        #   case the current project ID will be supplied, or a fully-qualified
+        #   topic name in the form `projects/{project_id}/topics/{topic_id}`.
+        #
+        #   The topic ID (relative name) must start with a letter, and
+        #   contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+        #   underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+        #   signs (`%`). It must be between 3 and 255 characters in length, and
+        #   it must not start with `goog`.
         # @param [Hash] labels A hash of user-provided labels associated with
         #   the topic. You can use these to organize and group your topics.
         #   Label keys and values can be no longer than 63 characters, can only
@@ -250,10 +263,14 @@ module Google
         ##
         # Retrieves subscription by name.
         #
-        # @param [String] subscription_name Name of a subscription.
+        # @param [String] subscription_name Name of a subscription. The value can
+        #   be a simple subscription ID, in which case the current project ID
+        #   will be supplied, or a fully-qualified subscription name in the form
+        #   `projects/{project_id}/subscriptions/{subscription_id}`.
         # @param [String] project If the subscription belongs to a project other
         #   than the one currently connected to, the alternate project ID can be
-        #   specified here.
+        #   specified here. Not used if a fully-qualified subscription name is
+        #   provided for `subscription_name`.
         # @param [Boolean] skip_lookup Optionally create a {Subscription} object
         #   without verifying the subscription resource exists on the Pub/Sub
         #   service. Calls made on this object will raise errors if the service
@@ -283,7 +300,7 @@ module Google
           ensure_service!
           options = { project: project }
           return Subscription.from_name subscription_name, service, options if skip_lookup
-          grpc = service.get_subscription subscription_name
+          grpc = service.get_subscription subscription_name, options
           Subscription.from_grpc grpc, service
         rescue Google::Cloud::NotFoundError
           nil

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

@@ -58,8 +58,10 @@ module Google
         end
 
         ##
-        # The name of the snapshot. Format is
-        # `projects/{project}/snapshots/{snap}`.
+        # The name of the snapshot.
+        #
+        # @return [String] A fully-qualified snapshot name in the form
+        #   `projects/{project_id}/snapshots/{snapshot_id}`.
         def name
           @grpc.name
         end

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

@@ -77,7 +77,9 @@ module Google
         ##
         # The name of the subscription.
         #
-        # @return [String]
+        # @return [String] A fully-qualified subscription name in the form
+        #   `projects/{project_id}/subscriptions/{subscription_id}`.
+        #
         def name
           return @resource_name if reference?
           @grpc.name
@@ -1064,14 +1066,19 @@ module Google
         # * Any messages published to the subscription's topic following the
         #   successful completion of the `create_snapshot` operation.
         #
-        # @param [String, nil] snapshot_name Name of the new snapshot. If the
-        #   name is not provided, the server will assign a random name
-        #   for this snapshot on the same project as the subscription. The
-        #   format is `projects/{project}/snapshots/{snap}`. The name must start
-        #   with a letter, and contain only letters ([A-Za-z]), numbers
-        #   ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus
-        #   (+) or percent signs (%). It must be between 3 and 255 characters in
-        #   length, and it must not start with "goog". Optional.
+        # @param [String, nil] snapshot_name Name of the new snapshot. Optional.
+        #   If the name is not provided, the server will assign a random name
+        #   for this snapshot on the same project as the subscription.
+        #   The value can be a simple snapshot ID (relative name), in which
+        #   case the current project ID will be supplied, or a fully-qualified
+        #   snapshot name in the form
+        #   `projects/{project_id}/snapshots/{snapshot_id}`.
+        #
+        #   The snapshot ID (relative name) must start with a letter, and
+        #   contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+        #   underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+        #   signs (`%`). It must be between 3 and 255 characters in length, and
+        #   it must not start with `goog`.
         # @param [Hash] labels A hash of user-provided labels associated with
         #   the snapshot. You can use these to organize and group your
         #   snapshots. Label keys and values can be no longer than 63

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

@@ -85,10 +85,10 @@ module Google
         end
 
         ##
-        # The name of the topic in the form of
-        # "/projects/project-identifier/topics/topic-name".
+        # The name of the topic.
         #
-        # @return [String]
+        # @return [String] A fully-qualified topic name in the form
+        #   `projects/{project_id}/topics/{topic_id}`.
         #
         def name
           return @resource_name if reference?
@@ -255,11 +255,17 @@ module Google
         ##
         # Creates a new {Subscription} object on the current Topic.
         #
-        # @param [String] subscription_name Name of the new subscription. Must
-        #   start with a letter, and contain only letters ([A-Za-z]), numbers
-        #   ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus
-        #   (+) or percent signs (%). It must be between 3 and 255 characters in
-        #   length, and it must not start with "goog". Required.
+        # @param [String] subscription_name Name of the new subscription. Required.
+        #   The value can be a simple subscription ID (relative name), in which
+        #   case the current project ID will be supplied, or a fully-qualified
+        #   subscription name in the form
+        #   `projects/{project_id}/subscriptions/{subscription_id}`.
+        #
+        #   The subscription ID (relative name) must start with a letter, and
+        #   contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+        #   underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+        #   signs (`%`). It must be between 3 and 255 characters in length, and
+        #   it must not start with `goog`.
         # @param [Integer] deadline The maximum number of seconds after a
         #   subscriber receives a message before the subscriber should
         #   acknowledge the message.
@@ -415,7 +421,11 @@ module Google
         ##
         # Retrieves subscription by name.
         #
-        # @param [String] subscription_name Name of a subscription.
+        # @param [String] subscription_name Name of a subscription. The value
+        #   can be a simple subscription ID (relative name), in which case the
+        #   current project ID will be supplied, or a fully-qualified
+        #   subscription name in the form
+        #   `projects/{project_id}/subscriptions/{subscription_id}`.
         # @param [Boolean] skip_lookup Optionally create a {Subscription} object
         #   without verifying the subscription resource exists on the Pub/Sub
         #   service. Calls made on this object will raise errors if the service

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -259,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub