google-cloud-pubsub 2.19.0 → 3.0.3

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "2.19.0".freeze
+      VERSION = "3.0.3".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
@@ -59,9 +74,6 @@ module Google
       #   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 universe_domain [String] A custom universe domain. Optional.
       #
       # @return [Google::Cloud::PubSub::Project]
@@ -71,8 +83,8 @@ 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,
@@ -80,10 +92,8 @@ module Google
                    timeout: nil,
                    universe_domain: nil,
                    endpoint: nil,
-                   emulator_host: nil,
-                   project: nil,
-                   keyfile: nil
-        project_id ||= project || default_project_id
+                   emulator_host: nil
+        project_id ||= default_project_id
         scope ||= configure.scope
         timeout ||= configure.timeout
         endpoint ||= configure.endpoint
@@ -94,7 +104,7 @@ module Google
           credentials = :this_channel_is_insecure
           endpoint = emulator_host
         else
-          credentials ||= keyfile || default_credentials(scope: scope)
+          credentials ||= default_credentials scope: scope
           unless credentials.is_a? Google::Auth::Credentials
             credentials = PubSub::Credentials.new credentials, scope: scope
           end
@@ -116,12 +126,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
@@ -133,7 +141,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

@@ -50,8 +50,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 +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
@@ -96,8 +111,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,

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 3.0.3
 platform: ruby
 authors:
 - Mike Moore
 - Chris Smith
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -17,48 +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.20'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.20'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: retriable
   requirement: !ruby/object:Gem::Requirement
@@ -94,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
@@ -102,33 +96,23 @@ files:
 - lib/google/cloud/pubsub/errors.rb
 - lib/google/cloud/pubsub/flow_controller.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
@@ -136,15 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub
 test_files: []

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

@@ -1,188 +0,0 @@
-# Copyright 2016 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "google/cloud/errors"
-
-module Google
-  module Cloud
-    module PubSub
-      ##
-      # # Policy
-      #
-      # Represents a Cloud IAM Policy for the Pub/Sub service.
-      #
-      # A common pattern for updating a resource's metadata, such as its Policy,
-      # is to read the current data from the service, update the data locally,
-      # and then send the modified data for writing. This pattern may result in
-      # a conflict if two or more processes attempt the sequence simultaneously.
-      # IAM solves this problem with the {Google::Cloud::PubSub::Policy#etag}
-      # property, which is used to verify whether the policy has changed since
-      # the last request. When you make a request to with an `etag` value, Cloud
-      # IAM compares the `etag` value in the request with the existing `etag`
-      # value associated with the policy. It writes the policy only if the
-      # `etag` values match.
-      #
-      # When you update a policy, first read the policy (and its current `etag`)
-      # from the service, then modify the policy locally, and then write the
-      # modified policy to the service. See
-      # {Google::Cloud::PubSub::Topic#policy} and
-      # {Google::Cloud::PubSub::Topic#policy=}.
-      #
-      # @see https://cloud.google.com/iam/docs/managing-policies Managing
-      #   policies
-      # @see https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#iampolicy
-      #   google.iam.v1.IAMPolicy
-      #
-      # @attr [String] etag Used to verify whether the policy has changed since
-      #   the last request. The policy will be written only if the `etag` values
-      #   match.
-      # @attr [Hash{String => Array<String>}] roles The bindings that associate
-      #   roles with an array of members. See [Understanding
-      #   Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-      #   listing of primitive and curated roles.
-      #   See [Binding](https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#binding)
-      #   for a listing of values and patterns for members.
-      #
-      # @example
-      #   require "google/cloud/pubsub"
-      #
-      #   pubsub = Google::Cloud::PubSub.new
-      #   topic = pubsub.topic "my-topic"
-      #
-      #   topic.policy do |p|
-      #     p.remove "roles/owner", "user:owner@example.com"
-      #     p.add "roles/owner", "user:newowner@example.com"
-      #     p.roles["roles/viewer"] = ["allUsers"]
-      #   end
-      #
-      class Policy
-        attr_reader :etag
-        attr_reader :roles
-
-        ##
-        # @private Creates a Policy object.
-        def initialize etag, roles
-          @etag = etag
-          @roles = roles
-        end
-
-        ##
-        # Convenience method for adding a member to a binding on this policy.
-        # See [Understanding
-        # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-        # listing of primitive and curated roles.
-        # See [Binding](https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#binding)
-        # for a listing of values and patterns for members.
-        #
-        # @param [String] role_name A Cloud IAM role, such as
-        #   `"roles/pubsub.admin"`.
-        # @param [String] member A Cloud IAM identity, such as
-        #   `"user:owner@example.com"`.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "my-topic"
-        #
-        #   topic.policy do |p|
-        #     p.add "roles/owner", "user:newowner@example.com"
-        #   end
-        #
-        def add role_name, member
-          role(role_name) << member
-        end
-
-        ##
-        # Convenience method for removing a member from a binding on this
-        # policy. See [Understanding
-        # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-        # listing of primitive and curated roles. See
-        # [Binding](https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#binding)
-        # for a listing of values and patterns for members.
-        #
-        # @param [String] role_name A Cloud IAM role, such as
-        #   `"roles/pubsub.admin"`.
-        # @param [String] member A Cloud IAM identity, such as
-        #   `"user:owner@example.com"`.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "my-topic"
-        #
-        #   topic.policy do |p|
-        #     p.remove "roles/owner", "user:owner@example.com"
-        #   end
-        #
-        def remove role_name, member
-          role(role_name).delete member
-        end
-
-        ##
-        # Convenience method returning the array of members bound to a role in
-        # this policy, or an empty array if no value is present for the role in
-        # {#roles}. See [Understanding
-        # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-        # listing of primitive and curated roles. See
-        # [Binding](https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#binding)
-        # for a listing of values and patterns for members.
-        #
-        # @return [Array<String>] The members strings, or an empty array.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "my-topic"
-        #
-        #   topic.policy do |p|
-        #     p.role("roles/viewer") << "user:viewer@example.com"
-        #   end
-        #
-        def role role_name
-          roles[role_name] ||= []
-        end
-
-        ##
-        # @private Convert the Policy to a Google::Iam::V1::Policy object.
-        def to_grpc
-          Google::Iam::V1::Policy.new(
-            etag:     etag,
-            bindings: roles.keys.map do |role_name|
-              next if roles[role_name].empty?
-              Google::Iam::V1::Binding.new(
-                role:    role_name,
-                members: roles[role_name]
-              )
-            end.compact
-          )
-        end
-
-        ##
-        # @private New Policy from a Google::Iam::V1::Policy object.
-        def self.from_grpc grpc
-          roles = grpc.bindings.each_with_object({}) do |binding, memo|
-            memo[binding.role] = binding.members.to_a
-          end
-          new grpc.etag, roles
-        end
-      end
-    end
-
-    Pubsub = PubSub unless const_defined? :Pubsub
-  end
-end

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

@@ -1,88 +0,0 @@
-# Copyright 2016 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "google/cloud/errors"
-
-module Google
-  module Cloud
-    module PubSub
-      ##
-      # # RetryPolicy
-      #
-      # An immutable Retry Policy value object that specifies how Cloud Pub/Sub retries message delivery.
-      #
-      # Retry delay will be exponential based on provided minimum and maximum backoffs. (See [Exponential
-      # backoff](https://en.wikipedia.org/wiki/Exponential_backoff).)
-      #
-      # Retry Policy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
-      #
-      # Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not
-      # match the configuration. That is, delay can be more or less than configured backoff.
-      #
-      # @attr [Numeric] minimum_backoff The minimum delay between consecutive deliveries of a given message. Value
-      #   should be between 0 and 600 seconds. The default value is 10 seconds.
-      # @attr [Numeric] maximum_backoff The maximum delay between consecutive deliveries of a given message. Value
-      #   should be between 0 and 600 seconds. The default value is 600 seconds.
-      #
-      # @example
-      #   require "google/cloud/pubsub"
-      #
-      #   pubsub = Google::Cloud::PubSub.new
-      #
-      #   sub = pubsub.subscription "my-topic-sub"
-      #
-      #   sub.retry_policy = Google::Cloud::PubSub::RetryPolicy.new minimum_backoff: 5, maximum_backoff: 300
-      #
-      #   sub.retry_policy.minimum_backoff #=> 5
-      #   sub.retry_policy.maximum_backoff #=> 300
-      #
-      class RetryPolicy
-        attr_reader :minimum_backoff
-        attr_reader :maximum_backoff
-
-        ##
-        # Creates a new, immutable RetryPolicy value object.
-        #
-        # @attr [Numeric, nil] minimum_backoff The minimum delay between consecutive deliveries of a given message.
-        #   Value should be between 0 and 600 seconds. If `nil` is provided, the default value is 10 seconds.
-        # @attr [Numeric, nil] maximum_backoff The maximum delay between consecutive deliveries of a given message.
-        #   Value should be between 0 and 600 seconds. If `nil` is provided, the default value is 600 seconds.
-        #
-        def initialize minimum_backoff: nil, maximum_backoff: nil
-          @minimum_backoff = minimum_backoff
-          @maximum_backoff = maximum_backoff
-        end
-
-        ##
-        # @private Convert the RetryPolicy to a Google::Cloud::PubSub::V1::RetryPolicy object.
-        def to_grpc
-          Google::Cloud::PubSub::V1::RetryPolicy.new(
-            minimum_backoff: Convert.number_to_duration(minimum_backoff),
-            maximum_backoff: Convert.number_to_duration(maximum_backoff)
-          )
-        end
-
-        ##
-        # @private New RetryPolicy from a Google::Cloud::PubSub::V1::RetryPolicy object.
-        def self.from_grpc grpc
-          new(
-            minimum_backoff: Convert.duration_to_number(grpc.minimum_backoff),
-            maximum_backoff: Convert.duration_to_number(grpc.maximum_backoff)
-          )
-        end
-      end
-    end
-  end
-end