google-cloud-pubsub 2.23.0 → 3.0.0

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

@@ -1,205 +0,0 @@
-# Copyright 2017 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"
-require "google/cloud/pubsub/snapshot/list"
-require "google/cloud/pubsub/v1"
-
-module Google
-  module Cloud
-    module PubSub
-      ##
-      # # Snapshot
-      #
-      # A named resource created from a subscription to retain a stream of
-      # messages from a topic. A snapshot is guaranteed to retain:
-      #
-      # * The existing backlog on the subscription. More precisely, this is
-      #   defined as the messages in the subscription's backlog that are
-      #   unacknowledged upon the successful completion of the
-      #   `create_snapshot` operation; as well as:
-      # * Any messages published to the subscription's topic following the
-      #   successful completion of the `create_snapshot` operation.
-      #
-      # @example
-      #   require "google/cloud/pubsub"
-      #
-      #   pubsub = Google::Cloud::PubSub.new
-      #   sub = pubsub.subscription "my-sub"
-      #
-      #   snapshot = sub.create_snapshot "my-snapshot"
-      #   snapshot.name #=> "projects/my-project/snapshots/my-snapshot"
-      #
-      class Snapshot
-        ##
-        # @private The Service object.
-        attr_accessor :service
-
-        ##
-        # @private The gRPC Google::Cloud::PubSub::V1::Snapshot object.
-        attr_accessor :grpc
-
-        ##
-        # @private Create an empty {Snapshot} object.
-        def initialize
-          @service = nil
-          @grpc = Google::Cloud::PubSub::V1::Snapshot.new
-        end
-
-        ##
-        # 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
-
-        ##
-        # The {Topic} from which this snapshot is retaining messages.
-        #
-        # @return [Topic]
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   sub = pubsub.subscription "my-sub"
-        #
-        #   snapshot = sub.create_snapshot "my-snapshot"
-        #   snapshot.topic.name #=> "projects/my-project/topics/my-topic"
-        #
-        def topic
-          Topic.from_name @grpc.topic, service
-        end
-
-        ##
-        # The snapshot is guaranteed to exist up until this time.
-        # A newly-created snapshot expires no later than 7 days from the time of
-        # its creation. Its exact lifetime is determined at creation by the
-        # existing backlog in the source subscription. Specifically, the
-        # lifetime of the snapshot is 7 days - (age of oldest unacked message in
-        # the subscription). For example, consider a subscription whose oldest
-        # unacked message is 3 days old. If a snapshot is created from this
-        # subscription, the snapshot -- which will always capture this 3-day-old
-        # backlog as long as the snapshot exists -- will expire in 4 days.
-        #
-        # @return [Time] The time until which the snapshot is guaranteed to
-        #   exist.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   sub = pubsub.subscription "my-sub"
-        #
-        #   snapshot = sub.create_snapshot "my-snapshot"
-        #   snapshot.topic.name #=> "projects/my-project/topics/my-topic"
-        #   snapshot.expiration_time
-        #
-        def expiration_time
-          self.class.timestamp_from_grpc @grpc.expire_time
-        end
-
-        ##
-        # A hash of user-provided labels associated with this snapshot.
-        # Labels can be used to organize and group snapshots.See [Creating and
-        # Managing Labels](https://cloud.google.com/pubsub/docs/labels).
-        #
-        # The returned hash is frozen and changes are not allowed. Use
-        # {#labels=} to update the labels for this snapshot.
-        #
-        # @return [Hash] The frozen labels hash.
-        #
-        def labels
-          @grpc.labels.to_h.freeze
-        end
-
-        ##
-        # Sets the hash of user-provided labels associated with this
-        # snapshot. Labels can be used to organize and group snapshots.
-        # Label keys and values can be no longer than 63 characters, can only
-        # contain lowercase letters, numeric characters, underscores and dashes.
-        # International characters are allowed. Label values are optional. Label
-        # keys must start with a letter and each label in the list must have a
-        # different key. See [Creating and Managing
-        # Labels](https://cloud.google.com/pubsub/docs/labels).
-        #
-        # @param [Hash] new_labels The new labels hash.
-        #
-        def labels= new_labels
-          raise ArgumentError, "Value must be a Hash" if new_labels.nil?
-          labels_map = Google::Protobuf::Map.new :string, :string
-          Hash(new_labels).each { |k, v| labels_map[String(k)] = String(v) }
-          update_grpc = @grpc.dup
-          update_grpc.labels = labels_map
-          @grpc = service.update_snapshot update_grpc, :labels
-        end
-
-        ##
-        # Removes an existing snapshot. All messages retained in the snapshot
-        # are immediately dropped. After a snapshot is deleted, a new one may be
-        # created with the same name, but the new one has no association with
-        # the old snapshot or its subscription, unless the same subscription is
-        # specified.
-        #
-        # @return [Boolean] Returns `true` if the snapshot was deleted.
-        #
-        # @example
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   pubsub.snapshots.each do |snapshot|
-        #     snapshot.delete
-        #   end
-        #
-        def delete
-          ensure_service!
-          service.delete_snapshot name
-          true
-        end
-
-        ##
-        # @private New Snapshot from a Google::Cloud::PubSub::V1::Snapshot
-        # object.
-        def self.from_grpc grpc, service
-          new.tap do |f|
-            f.grpc = grpc
-            f.service = service
-          end
-        end
-
-        ##
-        # @private Get a Time object from a Google::Protobuf::Timestamp object.
-        def self.timestamp_from_grpc grpc_timestamp
-          return nil if grpc_timestamp.nil?
-          Time.at grpc_timestamp.seconds, Rational(grpc_timestamp.nanos, 1000)
-        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
-      end
-    end
-
-    Pubsub = PubSub unless const_defined? :Pubsub
-  end
-end

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

@@ -1,205 +0,0 @@
-# Copyright 2015 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 Subscription
-        ##
-        # Subscription::List is a special case Array with additional values.
-        class List < DelegateClass(::Array)
-          ##
-          # If not empty, indicates that there are more subscriptions
-          # that match the request and this value should be passed to
-          # the next {Google::Cloud::PubSub::Topic#subscriptions} to continue.
-          attr_accessor :token
-
-          ##
-          # @private Create a new Subscription::List with an array of values.
-          def initialize arr = []
-            @topic = nil
-            @prefix = nil
-            @token = nil
-            @max = nil
-            super arr
-          end
-
-          ##
-          # Whether there a next page of subscriptions.
-          #
-          # @return [Boolean]
-          #
-          # @example
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   subscriptions = pubsub.subscriptions
-          #   if subscriptions.next?
-          #     next_subscriptions = subscriptions.next
-          #   end
-          #
-          def next?
-            !token.nil?
-          end
-
-          ##
-          # Retrieve the next page of subscriptions.
-          #
-          # @return [Subscription::List]
-          #
-          # @example
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   subscriptions = pubsub.subscriptions
-          #   if subscriptions.next?
-          #     next_subscriptions = subscriptions.next
-          #   end
-          #
-          def next
-            return nil unless next?
-            ensure_service!
-            if @topic
-              next_topic_subscriptions
-            else
-              next_subscriptions
-            end
-          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 subscriptions. Default is no limit.
-          # @yield [subscription] The block for accessing each subscription.
-          # @yieldparam [Subscription] subscription The subscription object.
-          #
-          # @return [Enumerator]
-          #
-          # @example Iterating each subscription by passing a block:
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   subscriptions = pubsub.subscriptions
-          #   subscriptions.all do |subscription|
-          #     puts subscription.name
-          #   end
-          #
-          # @example Using the enumerator by not passing a block:
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   subscriptions = pubsub.subscriptions
-          #   all_names = subscriptions.all.map do |subscription|
-          #     subscription.name
-          #   end
-          #
-          # @example Limit the number of API calls made:
-          #   require "google/cloud/pubsub"
-          #
-          #   pubsub = Google::Cloud::PubSub.new
-          #
-          #   subscriptions = pubsub.subscriptions
-          #   subscriptions.all(request_limit: 10) do |subscription|
-          #     puts subscription.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 Subscriptions::List from a
-          # Google::Cloud::PubSub::V1::ListSubscriptionsRequest object.
-          def self.from_grpc grpc_list, service, max = nil
-            subs = new(Array(grpc_list.subscriptions).map do |grpc|
-              Subscription.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 :@max,     max
-            subs
-          end
-
-          ##
-          # @private New Subscriptions::List from a
-          # Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse object.
-          def self.from_topic_grpc grpc_list, service, topic, max = nil
-            subs = new(Array(grpc_list.subscriptions).map do |grpc|
-              Subscription.from_name 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 :@topic,   topic
-            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_subscriptions
-            options = { prefix: @prefix, token: @token, max: @max }
-            grpc = @service.list_subscriptions options
-            self.class.from_grpc grpc, @service, @max
-          end
-
-          def next_topic_subscriptions
-            options = { token: @token, max: @max }
-            grpc = @service.list_topics_subscriptions @topic, options
-            self.class.from_topic_grpc grpc, @service, @topic, @max
-          end
-        end
-      end
-    end
-
-    Pubsub = PubSub unless const_defined? :Pubsub
-  end
-end

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

@@ -1,268 +0,0 @@
-# Copyright 2019 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/pubsub/v1/pubsub_pb"
-
-module Google
-  module Cloud
-    module PubSub
-      class Subscription
-        ##
-        # Configuration for a push delivery endpoint.
-        #
-        # @example Create a push config:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   topic = pubsub.topic "my-topic"
-        #
-        #   push_config = Google::Cloud::PubSub::Subscription::PushConfig.new endpoint: "http://example.net/callback"
-        #   push_config.set_oidc_token "service-account@example.net", "audience-header-value"
-        #
-        #   sub = topic.subscribe "my-subscription", push_config: push_config
-        #
-        # @example Read a push config:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #
-        #   sub = pubsub.subscription "my-topic-sub"
-        #   sub.push_config.endpoint #=> "http://example.com/callback"
-        #   sub.push_config.authentication.email #=> "user@example.com"
-        #   sub.push_config.authentication.audience #=> "client-12345"
-        #
-        # @example Update a push config:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::PubSub.new
-        #   sub = pubsub.subscription "my-subscription"
-        #
-        #   sub.push_config do |pc|
-        #     pc.endpoint = "http://example.net/callback"
-        #     pc.set_oidc_token "user@example.net", "client-67890"
-        #   end
-        #
-        class PushConfig
-          ##
-          # Creates a new push configuration.
-          #
-          # @param [String] endpoint A URL locating the endpoint to which messages should be pushed. For
-          #   example, a Webhook endpoint might use `https://example.com/push`.
-          # @param [String] email The service account email to be used for generating the OIDC token.
-          #   The caller must have the `iam.serviceAccounts.actAs` permission for the service account.
-          # @param [String] audience The audience to be used when generating OIDC token. The audience claim identifies
-          #   the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having
-          #   multiple values (array) for the audience field is not supported. More info about the OIDC JWT token
-          #   audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the `endpoint`
-          #   URL will be used.
-          #
-          def initialize endpoint: nil, email: nil, audience: nil
-            @grpc = Google::Cloud::PubSub::V1::PushConfig.new
-
-            self.endpoint = endpoint unless endpoint.nil?
-
-            raise ArgumentError, "audience provided without email. Authentication is invalid" if audience && !email
-
-            set_oidc_token email, audience if email
-          end
-
-          ##
-          # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use
-          # `https://example.com/push`.
-          #
-          # @return [String]
-          def endpoint
-            @grpc.push_endpoint
-          end
-
-          ##
-          # Sets the URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might
-          # use `https://example.com/push`.
-          #
-          # @param [String, nil] new_endpoint New URL value
-          def endpoint= new_endpoint
-            @grpc.push_endpoint = String new_endpoint
-          end
-
-          ##
-          # The authentication method used by push endpoints to verify the source of push requests.
-          #
-          # @return [OidcToken, nil] An OIDC JWT token if specified, `nil`
-          #   otherwise.
-          def authentication
-            return nil unless @grpc.authentication_method == :oidc_token
-
-            OidcToken.from_grpc @grpc.oidc_token
-          end
-
-          ##
-          # Sets the authentication method used by push endpoints to verify the source of push requests.
-          #
-          # @param [OidcToken, nil] new_auth An authentication value.
-          def authentication= new_auth
-            if new_auth.nil?
-              @grpc.oidc_token = nil
-            else
-              raise ArgumentError unless new_auth.is_a? OidcToken
-
-              @grpc.oidc_token = new_auth.to_grpc
-            end
-          end
-
-          ##
-          # Checks whether authentication is an {OidcToken}.
-          #
-          # @return [Boolean]
-          def oidc_token?
-            authentication.is_a? OidcToken
-          end
-
-          ##
-          # Sets the authentication method to use an {OidcToken}.
-          #
-          # @param [String] email Service account email.
-          # @param [String] audience Audience to be used.
-          def set_oidc_token email, audience
-            oidc_token = OidcToken.new.tap do |token|
-              token.email = email
-              token.audience = audience
-            end
-            self.authentication = oidc_token
-          end
-
-          ##
-          # The format of the pushed message. This attribute indicates the version of the data expected by the endpoint.
-          # This controls the shape of the pushed message (i.e., its fields and metadata). The endpoint version is based
-          # on the version of the Pub/Sub API.
-          #
-          # If not present during the Subscription creation, it will default to the version of the API used to make such
-          # call.
-          #
-          # The possible values for this attribute are:
-          #
-          # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub
-          #   API.
-          # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub
-          #   API.
-          #
-          # @return [String]
-          def version
-            @grpc.attributes["x-goog-version"]
-          end
-
-          ##
-          # Sets the format of the pushed message.
-          #
-          # The possible values for this attribute are:
-          #
-          # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub
-          #   API.
-          # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub
-          #   API.
-          #
-          # @param [String, nil] new_version The new version value.
-          def version= new_version
-            if new_version.nil?
-              @grpc.attributes.delete "x-goog-version"
-            else
-              @grpc.attributes["x-goog-version"] = new_version
-            end
-          end
-
-          ##
-          # @private
-          def to_grpc
-            @grpc
-          end
-
-          ##
-          # @private
-          def self.from_grpc grpc
-            new.tap do |pc|
-              pc.instance_variable_set :@grpc, grpc.dup if grpc
-            end
-          end
-
-          ##
-          # Contains information needed for generating an [OpenID Connect
-          # token](https://developers.google.com/identity/protocols/OpenIDConnect).
-          class OidcToken
-            ##
-            # @private
-            def initialize
-              @grpc = Google::Cloud::PubSub::V1::PushConfig::OidcToken.new
-            end
-
-            ##
-            # The service account email to be used for generating the OIDC token. The caller must have the
-            # `iam.serviceAccounts.actAs` permission for the service account.
-            #
-            # @return [String]
-            def email
-              @grpc.service_account_email
-            end
-
-            ##
-            # Sets the service account email to be used for generating the OIDC token. The caller must have the
-            # `iam.serviceAccounts.actAs` permission for the service account.
-            #
-            # @param [String] new_email New service account email value.
-            def email= new_email
-              @grpc.service_account_email = new_email
-            end
-
-            ##
-            # The audience to be used when generating OIDC token. The audience claim identifies the recipients that
-            # the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values
-            # (array) for the audience field is not supported. More info about the OIDC JWT token audience here:
-            # https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the `endpoint` URL will be used.
-            #
-            # @return [String]
-            def audience
-              @grpc.audience
-            end
-
-            ##
-            # Sets the audience to be used when generating OIDC token. The audience claim identifies the recipients that
-            # the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values
-            # (array) for the audience field is not supported. More info about the OIDC JWT token audience here:
-            # https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the `endpoint` URL will be used.
-            #
-            # @param [String] new_audience New audience value.
-            def audience= new_audience
-              @grpc.audience = new_audience
-            end
-
-            ##
-            # @private
-            def to_grpc
-              @grpc
-            end
-
-            ##
-            # @private
-            def self.from_grpc grpc
-              grpc ||= Google::Cloud::PubSub::V1::PushConfig::OidcToken.new
-
-              new.tap do |pc|
-                pc.instance_variable_set :@grpc, grpc.dup
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end