google-cloud-pubsub 2.15.5 → 3.3.0

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

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

data/lib/google/cloud/pubsub.rb

@@ -14,6 +14,7 @@
 
 
 require "google-cloud-pubsub"
+require "google/cloud/pubsub/internal_logger"
 require "google/cloud/pubsub/project"
 require "google/cloud/config"
 require "google/cloud/env"
@@ -43,9 +44,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
@@ -55,13 +71,16 @@ module Google
       #
       #   * `https://www.googleapis.com/auth/pubsub`
       # @param [Numeric] timeout Default timeout to use in requests. Optional.
+      # @param [String] universe_domain A custom universe domain. 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.
       #   If the param is nil, uses the value of the `emulator_host` config.
-      # @param [String] project Alias for the `project_id` argument. Deprecated.
-      # @param [String] keyfile Alias for the `credentials` argument.
-      #   Deprecated.
+      # @param [Logger] logger Optional Logger instance for emitting
+      #   library-level debug logs. If not provided, it will default to
+      #   configure.logger, which defaults to Logger.new STDOUT if not set. To
+      #   enable logging, set environment variable GOOGLE_SDK_RUBY_LOGGING_GEMS
+      #   to "all" or a comma separated list of gem names, including "pubsub".
       #
       # @return [Google::Cloud::PubSub::Project]
       #
@@ -70,41 +89,45 @@ module Google
       #
       #   pubsub = Google::Cloud::PubSub.new
       #
-      #   topic = pubsub.topic "my-topic"
-      #   topic.publish "task completed"
+      #   publisher = pubsub.publisher "my-topic"
+      #   publisher.publish "task completed"
       #
       def self.new project_id: nil,
                    credentials: nil,
                    scope: nil,
                    timeout: nil,
+                   universe_domain: nil,
                    endpoint: nil,
                    emulator_host: nil,
-                   project: nil,
-                   keyfile: nil
-        project_id    ||= (project || default_project_id)
-        scope         ||= configure.scope
-        timeout       ||= configure.timeout
-        endpoint      ||= configure.endpoint
+                   logger: nil
+        project_id ||= default_project_id
+        scope ||= configure.scope
+        timeout ||= configure.timeout
+        endpoint ||= configure.endpoint
+        universe_domain ||= configure.universe_domain
         emulator_host ||= configure.emulator_host
+        logger ||= configure.logger
 
         if emulator_host
-          project_id = project_id.to_s # Always cast to a string
-          raise ArgumentError, "project_id is missing" if project_id.empty?
-
-          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))
-        unless credentials.is_a? Google::Auth::Credentials
-          credentials = PubSub::Credentials.new credentials, scope: scope
+          credentials = :this_channel_is_insecure
+          endpoint = emulator_host
+        else
+          credentials ||= default_credentials scope: scope
+          unless credentials.is_a? Google::Auth::Credentials
+            credentials = PubSub::Credentials.new credentials, scope: scope
+          end
         end
 
         project_id ||= credentials.project_id if credentials.respond_to? :project_id
         project_id = project_id.to_s # Always cast to a string
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        service = PubSub::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        logger = Google::Cloud::PubSub::InternalLogger.new logger
+        service = PubSub::Service.new project_id, credentials,
+                                      host: endpoint,
+                                      timeout: timeout,
+                                      universe_domain: universe_domain,
+                                      logger: logger
         PubSub::Project.new service
       end
 
@@ -113,12 +136,10 @@ module Google
       #
       # The following PubSub configuration parameters are supported:
       #
-      # * `project_id` - (String) Identifier for a PubSub project. (The
-      #   parameter `project` is considered deprecated, but may also be used.)
+      # * `project_id` - (String) Identifier for a PubSub project.
       # * `credentials` - (String, Hash, Google::Auth::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}) (The
-      #   parameter `keyfile` is considered deprecated, but may also be used.)
+      #   Google::Auth::Credentials object. (See {PubSub::Credentials})
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `quota_project` - (String) The project ID for a project that can be
@@ -130,7 +151,7 @@ module Google
       #   `ENV["PUBSUB_EMULATOR_HOST"]`
       # * `on_error` - (Proc) A Proc to be run when an error is encountered
       #   on a background thread. The Proc must take the error object as the
-      #   single argument. (See {Subscriber.on_error}.)
+      #   single argument. (See {MessageListener.on_error}.)
       #
       # @return [Google::Cloud::Config] The configuration object the
       #   Google::Cloud::PubSub library uses.

data/lib/google-cloud-pubsub.rb

@@ -23,6 +23,7 @@ gem "google-cloud-core"
 require "google/cloud" unless defined? Google::Cloud.new
 require "google/cloud/config"
 require "googleauth"
+require "logger"
 
 module Google
   module Cloud
@@ -50,8 +51,9 @@ module Google
     #
     #   gcloud = Google::Cloud.new
     #   pubsub = gcloud.pubsub
-    #   topic = pubsub.topic "my-topic"
-    #   topic.publish "task completed"
+    #   topic_admin = pubsub.topic_admin
+    #   publisher = pubsub.publisher "my-topic"
+    #   publisher.publish "task completed"
     #
     # @example The default scope can be overridden with the `scope` option:
     #   require "google/cloud"
@@ -75,10 +77,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
@@ -96,8 +112,8 @@ module Google
     #
     #   pubsub = Google::Cloud.pubsub
     #
-    #   topic = pubsub.topic "my-topic"
-    #   topic.publish "task completed"
+    #   publisher = pubsub.publisher "my-topic"
+    #   publisher.publish "task completed"
     #
     def self.pubsub project_id = nil,
                     credentials = nil,
@@ -110,7 +126,7 @@ module Google
 end
 
 # Set the default pubsub configuration
-Google::Cloud.configure.add_config! :pubsub do |config|
+Google::Cloud.configure.add_config! :pubsub do |config| # rubocop:disable Metrics/BlockLength
   default_project = Google::Cloud::Config.deferred do
     ENV["PUBSUB_PROJECT"]
   end
@@ -127,6 +143,8 @@ Google::Cloud.configure.add_config! :pubsub do |config|
     "https://www.googleapis.com/auth/pubsub"
   ]
 
+  default_logger = Logger.new $stdout
+
   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
@@ -136,5 +154,7 @@ Google::Cloud.configure.add_config! :pubsub do |config|
   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
+  config.add_field! :endpoint, nil, match: String
+  config.add_field! :universe_domain, nil, match: String
+  config.add_field! :logger, default_logger, match: Logger, allow_nil: true
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 2.15.5
+  version: 3.3.0
 platform: ruby
 authors:
 - Mike Moore
 - Chris Smith
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -17,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: google-cloud-pubsub-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: retriable
   requirement: !ruby/object:Gem::Requirement
@@ -67,160 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: autotest-suffix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: avro
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: google-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.25.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.25.1
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-- !ruby/object:Gem::Dependency
-  name: minitest-autotest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
 description: google-cloud-pubsub is the official library for Google Cloud Pub/Sub.
 email:
 - mike@blowmage.com
@@ -242,6 +87,7 @@ files:
 - lib/google-cloud-pubsub.rb
 - lib/google/cloud/pubsub.rb
 - lib/google/cloud/pubsub/acknowledge_result.rb
+- lib/google/cloud/pubsub/admin_clients.rb
 - lib/google/cloud/pubsub/async_publisher.rb
 - lib/google/cloud/pubsub/async_publisher/batch.rb
 - lib/google/cloud/pubsub/batch_publisher.rb
@@ -249,34 +95,25 @@ files:
 - lib/google/cloud/pubsub/credentials.rb
 - lib/google/cloud/pubsub/errors.rb
 - lib/google/cloud/pubsub/flow_controller.rb
+- lib/google/cloud/pubsub/internal_logger.rb
 - lib/google/cloud/pubsub/message.rb
-- lib/google/cloud/pubsub/policy.rb
+- lib/google/cloud/pubsub/message_listener.rb
+- lib/google/cloud/pubsub/message_listener/enumerator_queue.rb
+- lib/google/cloud/pubsub/message_listener/inventory.rb
+- lib/google/cloud/pubsub/message_listener/sequencer.rb
+- lib/google/cloud/pubsub/message_listener/stream.rb
+- lib/google/cloud/pubsub/message_listener/timed_unary_buffer.rb
 - lib/google/cloud/pubsub/project.rb
 - lib/google/cloud/pubsub/publish_result.rb
+- lib/google/cloud/pubsub/publisher.rb
 - lib/google/cloud/pubsub/received_message.rb
-- lib/google/cloud/pubsub/retry_policy.rb
-- lib/google/cloud/pubsub/schema.rb
-- lib/google/cloud/pubsub/schema/list.rb
 - lib/google/cloud/pubsub/service.rb
-- lib/google/cloud/pubsub/snapshot.rb
-- lib/google/cloud/pubsub/snapshot/list.rb
 - lib/google/cloud/pubsub/subscriber.rb
-- lib/google/cloud/pubsub/subscriber/enumerator_queue.rb
-- lib/google/cloud/pubsub/subscriber/inventory.rb
-- lib/google/cloud/pubsub/subscriber/sequencer.rb
-- lib/google/cloud/pubsub/subscriber/stream.rb
-- lib/google/cloud/pubsub/subscriber/timed_unary_buffer.rb
-- lib/google/cloud/pubsub/subscription.rb
-- lib/google/cloud/pubsub/subscription/list.rb
-- lib/google/cloud/pubsub/subscription/push_config.rb
-- lib/google/cloud/pubsub/topic.rb
-- lib/google/cloud/pubsub/topic/list.rb
 - lib/google/cloud/pubsub/version.rb
 homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-pubsub
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -284,15 +121,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub
 test_files: []