google-cloud-pubsub 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c47519bfe64a6b8c705b8f6d0f3d89453cabf39bec693e5031fca85fd406c5f1
-  data.tar.gz: 438769cf4b54c421b353436f9c1f89fb8c6621bb0dfcb02fe02f9fe7b3f4e239
+  metadata.gz: 0b807c188d7948862efc100d1d0c2bd06eb7495fe9031719e5c80f395093b491
+  data.tar.gz: 955a2d3cd3b3777a938a58e933c6aa8714a62ad21949daf8b7fd7efdfbd64091
 SHA512:
-  metadata.gz: 863a808c566bf8c2667387915ab89643f1e587bf6acf572d8ca2ecd4670a2adc9f47ed4fc2de633f91f345abce0ae03b3f7fe9ddaf11bfb9152b0bc556d61d7a
-  data.tar.gz: 67ccab46b9cdb3c52065e6585f870f49cc0e6892205bde6ec76a314a6570cd00c847d628764e86dbf5088cb4320f5c1ed4bfe68b2f5f6c21938766d410d0f1dc
+  metadata.gz: 7f953960c1f7d30b5de38591d3f5c7c6ad27404ca99b93593ce8e41b772c3a5043731c861a9283bc7c15f1210ccb0aa3be8f50a94e46a73db5b835ab23402f59
+  data.tar.gz: 8e227ff927d181ef32dbcc85fe8dffcb9d66aa80fcc203d13fec166b83a05b92066c10423805269b40f7fd4a05530b1c30163560f4a955678fd704f00ea83f7f

data/AUTHENTICATION.md

@@ -46,6 +46,12 @@ code.
 
 **Credentials** are discovered in the following order:
 
+> [!WARNING]
+> If you accept a credential configuration (JSON file or Hash) from an
+> external source for authentication to Google Cloud, you must validate it before
+> providing it to a Google API client library. Providing an unvalidated credential
+> configuration to Google APIs can compromise the security of your systems and data.
+
 1. Specify credentials in method arguments
 2. Specify credentials in configuration
 3. Discover credentials path in environment variables
@@ -100,11 +106,16 @@ The **Project ID** and the path to the **Credentials JSON** file can be configur
 instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
+require "googleauth"
 require "google/cloud/pubsub"
 
+credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+  json_key_io: ::File.open("/path/to/keyfile.json")
+)
+
 Google::Cloud::PubSub.configure do |config|
   config.project_id  = "my-project-id"
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = credentials
 end
 
 client = Google::Cloud::PubSub.new

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+### 3.1.0 (2025-12-12)
+
+#### Features
+
+* Add skip_lookup to Project#publisher to enable lazy loading ([#32263](https://github.com/googleapis/google-cloud-ruby/issues/32263)) 
+#### Documentation
+
+* Fix overview documentation URL 
+
+### 3.0.3 (2025-11-04)
+
+#### Documentation
+
+* add warning about loading unvalidated credentials ([#32121](https://github.com/googleapis/google-cloud-ruby/issues/32121)) 
+
 ### 3.0.2 (2025-08-12)
 
 #### Bug Fixes

data/OVERVIEW.md

@@ -36,7 +36,7 @@ into Admin Operations and Data Plane Operations.
 * **Data Plane Operations**: For the core functionality of publishing and receiving messages.
 
 To learn more about Pub/Sub, read the [Google Cloud Pub/Sub Overview
-](https://cloud.google.com/pubsub/overview).
+](https://docs.cloud.google.com/pubsub/docs/overview).
 
 ## Admin Operations
 

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

@@ -133,12 +133,17 @@ module Google
         # @param [Hash] async A hash of values to configure the topic's
         #   {AsyncPublisher} that is created when {Publisher#publish_async}
         #   is called. Optional.
+        # @param [Boolean] skip_lookup Optionally create a {Publisher} object
+        #   without verifying the topic resource exists on the Pub/Sub
+        #   service. Calls made on this object will raise errors if the service
+        #   resource does not exist. Default is `false`.
         #
         # @return [Google::Cloud::PubSub::Publisher]
         #
-        def publisher topic_name, project: nil, async: nil
+        def publisher topic_name, project: nil, async: nil, skip_lookup: nil
           ensure_service!
           options = { project: project, async: async }
+          return Publisher.from_name topic_name, service, options if skip_lookup
           grpc = topic_admin.get_topic topic: service.topic_path(topic_name, options)
           Publisher.from_grpc grpc, service, async: async
         end

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

@@ -87,9 +87,56 @@ module Google
         #   `projects/{project_id}/topics/{topic_id}`.
         #
         def name
+          return @resource_name if reference?
           @grpc.name
         end
 
+        ##
+        # Determines whether the publisher object was created with a resource
+        # representation from the Pub/Sub service.
+        #
+        # @return [Boolean] `true` when the publisher was created with a resource
+        #   representation, `false` otherwise.
+        #
+        def reference?
+          @grpc.nil?
+        end
+
+        ##
+        # Determines whether the publisher object was created with a resource
+        # representation from the Pub/Sub service.
+        #
+        # @return [Boolean] `true` when the publisher was created with a resource
+        #   representation, `false` otherwise.
+        #
+        def resource?
+          !@grpc.nil?
+        end
+
+
+        ##
+        # Reloads the publisher with current data from the Pub/Sub service.
+        #
+        # @return [Google::Cloud::PubSub::Publisher] Returns the reloaded
+        #   publisher
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   publisher = pubsub.publisher "my-topic", skip_lookup: true
+        #
+        #   publisher.reload!
+        #
+        def reload!
+          ensure_service!
+          topic_path = service.topic_path name
+          @grpc = service.topic_admin.get_topic topic: topic_path
+          @resource_name = nil
+          self
+        end
+
         ##
         # Publishes one or more messages to the publisher.
         #
@@ -166,7 +213,7 @@ module Google
         #
         def publish data = nil, attributes = nil, ordering_key: nil, compress: nil, compression_bytes_threshold: nil,
                     **extra_attrs, &block
-          ensure_service!
+          ensure_grpc!
           batch = BatchPublisher.new data,
                                      attributes,
                                      ordering_key,
@@ -290,8 +337,7 @@ module Google
         #   publisher.async_publisher.stop!
         #
         def publish_async data = nil, attributes = nil, ordering_key: nil, **extra_attrs, &callback
-          ensure_service!
-
+          ensure_grpc!
           @async_publisher ||= AsyncPublisher.new name, service, **@async_opts
           @async_publisher.publish data, attributes, ordering_key: ordering_key, **extra_attrs, &callback
         end
@@ -351,6 +397,16 @@ module Google
           end
         end
 
+        ##
+        # @private New reference {Publisher} from a topic name without making
+        # a HTTP request.
+        def self.from_name name, service, options = {}
+          name = service.topic_path name, options
+          from_grpc(nil, service, async: options[:async]).tap do |t|
+            t.instance_variable_set :@resource_name, name
+          end
+        end
+
         protected
 
         ##
@@ -364,6 +420,7 @@ module Google
         # Ensures a Google::Cloud::PubSub::V1::Topic object exists.
         def ensure_grpc!
           ensure_service!
+          reload! if reference?
         end
       end
     end

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

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

data/lib/google/cloud/pubsub.rb

@@ -43,9 +43,24 @@ module Google
       # @param [String] project_id Project identifier for the Pub/Sub service
       #   you are connecting to. If not present, the default project for the
       #   credentials is used.
-      # @param [String, Hash, Google::Auth::Credentials] credentials The path to
-      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {PubSub::Credentials})
+      # @param [Google::Auth::Credentials] credentials A Google::Auth::Credentials
+      #   object. (See {PubSub::Credentials})
+      #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+      #     is deprecated. Providing an unvalidated credential configuration to
+      #     Google APIs can compromise the security of your systems and data.
+      #
+      #   @example
+      #
+      #     # The recommended way to provide credentials is to use the `make_creds` method
+      #     # on the appropriate credentials class for your environment.
+      #
+      #     require "googleauth"
+      #
+      #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+      #       json_key_io: ::File.open("/path/to/keyfile.json")
+      #     )
+      #
+      #     pubsub = Google::Cloud::Pubsub.new project_id: "my-project", credentials: credentials
       # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       #   See [Using OAuth 2.0 to Access Google

data/lib/google-cloud-pubsub.rb

@@ -76,10 +76,24 @@ module Google
     # @param [String] project_id Project identifier for the Pub/Sub service you
     #   are connecting to. If not present, the default project for the
     #   credentials is used.
-    # @param [String, Hash, Google::Auth::Credentials] credentials The path to
-    #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-    #   Google::Auth::Credentials object.
-    #   (See {Google::Cloud::PubSub::Credentials})
+    # @param [Google::Auth::Credentials] credentials A Google::Auth::Credentials
+    #   object. (See {Google::Cloud::PubSub::Credentials})
+    #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+    #     is deprecated. Providing an unvalidated credential configuration to
+    #     Google APIs can compromise the security of your systems and data.
+    #
+    #   @example
+    #
+    #     # The recommended way to provide credentials is to use the `make_creds` method
+    #     # on the appropriate credentials class for your environment.
+    #
+    #     require "googleauth"
+    #
+    #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+    #       json_key_io: ::File.open("/path/to/keyfile.json")
+    #     )
+    #
+    #     pubsub = Google::Cloud::Pubsub.new project_id: "my-project", credentials: credentials
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
     #   [Using OAuth 2.0 to Access Google

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Mike Moore