google-cloud-pubsub 2.23.0 → 3.0.0

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

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

data/lib/google/cloud/pubsub.rb

@@ -59,9 +59,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 +68,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 +77,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 +89,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 +111,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 +126,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"
@@ -96,8 +97,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 2.23.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Mike Moore
@@ -87,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
@@ -95,27 +96,18 @@ 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:

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

data/lib/google/cloud/pubsub/schema/list.rb

@@ -1,180 +0,0 @@
-# Copyright 2021 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 "delegate"
-
-module Google
-  module Cloud
-    module PubSub
-      class Schema
-        ##
-        # Schema::List is a special case Array with additional values.
-        class List < DelegateClass(::Array)
-          ##
-          # If not empty, indicates that there are more schemas
-          # that match the request and this value should be passed to
-          # the next {Google::Cloud::PubSub::Project#schemas} to continue.
-          attr_accessor :token
-
-          ##
-          # @private Create a new Schema::List with an array of values.
-          def initialize arr = []
-            @prefix = nil
-            @token = nil
-            @view = nil
-            @max = nil
-            super arr
-          end
-
-          ##
-          # Whether there a next page of schemas.
-          #
-          # @return [Boolean]
-          #
-          # @example
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   schemas = pubsub.schemas
-          #   if schemas.next?
-          #     next_schemas = schemas.next
-          #   end
-          #
-          def next?
-            !token.nil?
-          end
-
-          ##
-          # Retrieve the next page of schemas.
-          #
-          # @return [Schema::List]
-          #
-          # @example
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   schemas = pubsub.schemas
-          #   if schemas.next?
-          #     next_schemas = schemas.next
-          #   end
-          #
-          def next
-            return nil unless next?
-            ensure_service!
-            next_schemas
-          end
-
-          ##
-          # Retrieves remaining results by repeatedly invoking {#next} until
-          # {#next?} returns `false`. Calls the given block once for each
-          # result, which is passed as the argument to the block.
-          #
-          # An Enumerator is returned if no block is given.
-          #
-          # This method will make repeated API calls until all remaining results
-          # are retrieved. (Unlike `#each`, for example, which merely iterates
-          # over the results returned by a single API call.) Use with caution.
-          #
-          # @param [Integer] request_limit The upper limit of API requests to
-          #   make to load all schemas. Default is no limit.
-          # @yield [schema] The block for accessing each schema.
-          # @yieldparam [Schema] schema The schema object.
-          #
-          # @return [Enumerator]
-          #
-          # @example Iterating each schema by passing a block:
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   schemas = pubsub.schemas
-          #   schemas.all do |schema|
-          #     puts schema.name
-          #   end
-          #
-          # @example Using the enumerator by not passing a block:
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   schemas = pubsub.schemas
-          #   all_names = schemas.all.map do |schema|
-          #     schema.name
-          #   end
-          #
-          # @example Limit the number of API calls made:
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   schemas = pubsub.schemas
-          #   schemas.all(request_limit: 10) do |schema|
-          #     puts schema.name
-          #   end
-          #
-          def all request_limit: nil, &block
-            request_limit = request_limit.to_i if request_limit
-            return enum_for :all, request_limit: request_limit unless block_given?
-            results = self
-            loop do
-              results.each(&block)
-              if request_limit
-                request_limit -= 1
-                break if request_limit.negative?
-              end
-              break unless results.next?
-              results = results.next
-            end
-          end
-
-          ##
-          # @private New Schemas::List from a
-          # Google::Cloud::PubSub::V1::ListSchemasRequest object.
-          def self.from_grpc grpc_list, service, view, max = nil
-            subs = new(Array(grpc_list.schemas).map do |grpc|
-              Schema.from_grpc grpc, service
-            end)
-            token = grpc_list.next_page_token
-            token = nil if token == "".freeze
-            subs.instance_variable_set :@token,   token
-            subs.instance_variable_set :@service, service
-            subs.instance_variable_set :@view,    view
-            subs.instance_variable_set :@max,     max
-            subs
-          end
-
-          protected
-
-          ##
-          # @private Raise an error unless an active connection to the service
-          # is available.
-          def ensure_service!
-            raise "Must have active connection to service" unless @service
-          end
-
-          def next_schemas
-            options = { prefix: @prefix, token: @token, max: @max }
-            grpc = @service.list_schemas @view, options
-            self.class.from_grpc grpc, @service, @view, @max
-          end
-        end
-      end
-    end
-
-    Pubsub = PubSub unless const_defined? :Pubsub
-  end
-end