google-cloud-pubsub 1.7.0 → 2.0.0

data/lib/google/cloud/pubsub/subscriber/stream.rb

@@ -271,9 +271,8 @@ module Google
             stop
           rescue GRPC::Cancelled, GRPC::DeadlineExceeded, GRPC::Internal,
                  GRPC::ResourceExhausted, GRPC::Unauthenticated,
-                 GRPC::Unavailable, GRPC::Core::CallError
+                 GRPC::Unavailable
             # Restart the stream with an incremental back for a retriable error.
-            # Also when GRPC raises the internal CallError.
 
             retry
           rescue RestartStream
@@ -364,6 +363,8 @@ module Google
               req.modify_deadline_ack_ids += @inventory.ack_ids
               req.modify_deadline_seconds += @inventory.ack_ids.map { @subscriber.deadline }
               req.client_id = @subscriber.service.client_id
+              req.max_outstanding_messages = @inventory.limit
+              req.max_outstanding_bytes = @inventory.bytesize
             end
           end
 

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

@@ -323,7 +323,7 @@ module Google
         # If {#expires_in=} is not set, a *default* value of of 31 days will be
         # used. The minimum allowed value is 1 day.
         #
-        # Makes an API call to retrieve the labels value when called on a
+        # Makes an API call to retrieve the value when called on a
         # reference object. See {#reference?}.
         #
         # @return [Numeric, nil] The expiration duration, or `nil` if unset.
@@ -346,13 +346,25 @@ module Google
         #   to unset.
         #
         def expires_in= ttl
-          new_expiration_policy = Google::Pubsub::V1::ExpirationPolicy.new ttl: Convert.number_to_duration(ttl)
+          new_expiration_policy = Google::Cloud::PubSub::V1::ExpirationPolicy.new ttl: Convert.number_to_duration(ttl)
 
           update_grpc = Google::Cloud::PubSub::V1::Subscription.new name: name, expiration_policy: new_expiration_policy
           @grpc = service.update_subscription update_grpc, :expiration_policy
           @resource_name = nil
         end
 
+        ##
+        # An expression written in the Cloud Pub/Sub filter language. If non-empty, then only {Message} instances whose
+        # `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are
+        # filtered out.
+        #
+        # @return [String] The frozen filter string.
+        #
+        def filter
+          ensure_grpc!
+          @grpc.filter.freeze
+        end
+
         ##
         # Returns the {Topic} to which dead letter messages should be published if a dead letter policy is configured,
         # otherwise `nil`. Dead lettering is done on a best effort basis. The same message might be dead lettered
@@ -554,7 +566,7 @@ module Google
         #
         # See {Topic#publish_async}, {#listen}, and {Message#ordering_key}.
         #
-        # Makes an API call to retrieve the retain_acked value when called on a
+        # Makes an API call to retrieve the enable_message_ordering value when called on a
         # reference object. See {#reference?}.
         #
         # @return [Boolean]
@@ -564,6 +576,35 @@ module Google
           @grpc.enable_message_ordering
         end
 
+        ##
+        # Whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their
+        # topic and don't retain any backlog. {#pull} and {#listen} (pull and streaming pull) operations will raise
+        # `FAILED_PRECONDITION`. If the subscription is a push subscription (see {#push_config}), pushes to the endpoint
+        # will not be made. The default value is `false`.
+        #
+        # See {Topic#subscribe} and {#detach}.
+        #
+        # Makes an API call to retrieve the value when called on a
+        # reference object. See {#reference?}.
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   sub = pubsub.subscription "my-topic-sub"
+        #   sub.detach
+        #
+        #   # sleep 120
+        #   sub.detached? #=> true
+        #
+        def detached?
+          ensure_grpc!
+          @grpc.detached
+        end
+
         ##
         # Determines whether the subscription exists in the Pub/Sub service.
         #
@@ -611,6 +652,32 @@ module Google
           true
         end
 
+        ##
+        # Detaches a subscription from its topic. All messages retained in the subscription are dropped. Detached
+        # subscriptions don't receive messages from their topic and don't retain any backlog. Subsequent {#pull} and
+        # {#listen} (pull and streaming pull) operations will raise `FAILED_PRECONDITION`. If the subscription is a push
+        # subscription (see {#push_config}), pushes to the endpoint will stop. It may take a few minutes for the
+        # subscription's detached state to be reflected in subsequent calls to {#detached?}.
+        #
+        # @return [Boolean] Returns `true` if the detach operation was successful.
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   sub = pubsub.subscription "my-topic-sub"
+        #   sub.detach
+        #
+        #   # sleep 120
+        #   sub.detached? #=> true
+        #
+        def detach
+          ensure_service!
+          service.detach_subscription name
+          true
+        end
+
         ##
         # Pulls messages from the server. Returns an empty list if there are no
         # messages available in the backlog. Raises an ApiError with status

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

@@ -286,6 +286,9 @@ module Google
         #   Managing Labels](https://cloud.google.com/pubsub/docs/labels).
         # @param [Boolean] message_ordering Whether to enable message ordering
         #   on the subscription.
+        # @param [String] filter An expression written in the Cloud Pub/Sub filter language. If non-empty, then only
+        #   {Message} instances whose `attributes` field matches the filter are delivered on this subscription. If
+        #   empty, then no messages are filtered out. Optional.
         # @param [Topic] dead_letter_topic The {Topic} to which dead letter messages for the subscription should be
         #   published. Dead lettering is done on a best effort basis. The same message might be dead lettered multiple
         #   times. The Cloud Pub/Sub service account associated with the enclosing subscription's parent project (i.e.,
@@ -359,12 +362,13 @@ module Google
         #   sub = topic.subscribe "my-topic-sub", retry_policy: retry_policy
         #
         def subscribe subscription_name, deadline: nil, retain_acked: false, retention: nil, endpoint: nil, labels: nil,
-                      message_ordering: nil, dead_letter_topic: nil, dead_letter_max_delivery_attempts: nil,
-                      retry_policy: nil
+                      message_ordering: nil, filter: nil, dead_letter_topic: nil,
+                      dead_letter_max_delivery_attempts: nil, retry_policy: nil
           ensure_service!
           options = { deadline: deadline, retain_acked: retain_acked, retention: retention, endpoint: endpoint,
-                      labels: labels, message_ordering: message_ordering,
+                      labels: labels, message_ordering: message_ordering, filter: filter,
                       dead_letter_max_delivery_attempts: dead_letter_max_delivery_attempts }
+
           options[:dead_letter_topic_name] = dead_letter_topic.name if dead_letter_topic
           if options[:dead_letter_max_delivery_attempts] && !options[:dead_letter_topic_name]
             # Service error message "3:Invalid resource name given (name=)." does not identify param.

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -31,82 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: google-gax
+  name: google-cloud-pubsub-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: googleapis-common-protos
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: googleapis-common-protos-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: grpc-google-iam-v1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.9
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
@@ -293,24 +239,7 @@ files:
 - 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/v1.rb
-- lib/google/cloud/pubsub/v1/credentials.rb
-- lib/google/cloud/pubsub/v1/doc/google/iam/v1/iam_policy.rb
-- lib/google/cloud/pubsub/v1/doc/google/iam/v1/options.rb
-- lib/google/cloud/pubsub/v1/doc/google/iam/v1/policy.rb
-- lib/google/cloud/pubsub/v1/doc/google/protobuf/duration.rb
-- lib/google/cloud/pubsub/v1/doc/google/protobuf/empty.rb
-- lib/google/cloud/pubsub/v1/doc/google/protobuf/field_mask.rb
-- lib/google/cloud/pubsub/v1/doc/google/protobuf/timestamp.rb
-- lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb
-- lib/google/cloud/pubsub/v1/doc/google/type/expr.rb
-- lib/google/cloud/pubsub/v1/publisher_client.rb
-- lib/google/cloud/pubsub/v1/publisher_client_config.json
-- lib/google/cloud/pubsub/v1/subscriber_client.rb
-- lib/google/cloud/pubsub/v1/subscriber_client_config.json
 - lib/google/cloud/pubsub/version.rb
-- lib/google/pubsub/v1/pubsub_pb.rb
-- lib/google/pubsub/v1/pubsub_services_pb.rb
 homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-pubsub
 licenses:
 - Apache-2.0
@@ -330,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub

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

@@ -1,17 +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 "google/cloud/pubsub/v1/publisher_client"
-require "google/cloud/pubsub/v1/subscriber_client"

data/lib/google/cloud/pubsub/v1/credentials.rb

@@ -1,41 +0,0 @@
-# Copyright 2020 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 "googleauth"
-
-module Google
-  module Cloud
-    module PubSub
-      module V1
-        class Credentials < Google::Auth::Credentials
-          SCOPE = ["https://www.googleapis.com/auth/pubsub"].freeze
-          PATH_ENV_VARS = %w(PUBSUB_CREDENTIALS
-                             PUBSUB_KEYFILE
-                             GOOGLE_CLOUD_CREDENTIALS
-                             GOOGLE_CLOUD_KEYFILE
-                             GCLOUD_KEYFILE)
-          JSON_ENV_VARS = %w(PUBSUB_CREDENTIALS_JSON
-                             PUBSUB_KEYFILE_JSON
-                             GOOGLE_CLOUD_CREDENTIALS_JSON
-                             GOOGLE_CLOUD_KEYFILE_JSON
-                             GCLOUD_KEYFILE_JSON)
-          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
-        end
-      end
-    end
-
-    Pubsub = PubSub unless const_defined? :Pubsub
-  end
-end

data/lib/google/cloud/pubsub/v1/doc/google/iam/v1/iam_policy.rb

@@ -1,21 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Iam
-    module V1
-    end
-  end
-end

data/lib/google/cloud/pubsub/v1/doc/google/iam/v1/options.rb

@@ -1,21 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Iam
-    module V1
-    end
-  end
-end

data/lib/google/cloud/pubsub/v1/doc/google/iam/v1/policy.rb

@@ -1,21 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Iam
-    module V1
-    end
-  end
-end

data/lib/google/cloud/pubsub/v1/doc/google/protobuf/duration.rb

@@ -1,91 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Protobuf
-    # A Duration represents a signed, fixed-length span of time represented
-    # as a count of seconds and fractions of seconds at nanosecond
-    # resolution. It is independent of any calendar and concepts like "day"
-    # or "month". It is related to Timestamp in that the difference between
-    # two Timestamp values is a Duration and it can be added or subtracted
-    # from a Timestamp. Range is approximately +-10,000 years.
-    #
-    # = Examples
-    #
-    # Example 1: Compute Duration from two Timestamps in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Timestamp end = ...;
-    #     Duration duration = ...;
-    #
-    #     duration.seconds = end.seconds - start.seconds;
-    #     duration.nanos = end.nanos - start.nanos;
-    #
-    #     if (duration.seconds < 0 && duration.nanos > 0) {
-    #       duration.seconds += 1;
-    #       duration.nanos -= 1000000000;
-    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
-    #       duration.seconds -= 1;
-    #       duration.nanos += 1000000000;
-    #     }
-    #
-    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Duration duration = ...;
-    #     Timestamp end = ...;
-    #
-    #     end.seconds = start.seconds + duration.seconds;
-    #     end.nanos = start.nanos + duration.nanos;
-    #
-    #     if (end.nanos < 0) {
-    #       end.seconds -= 1;
-    #       end.nanos += 1000000000;
-    #     } else if (end.nanos >= 1000000000) {
-    #       end.seconds += 1;
-    #       end.nanos -= 1000000000;
-    #     }
-    #
-    # Example 3: Compute Duration from datetime.timedelta in Python.
-    #
-    #     td = datetime.timedelta(days=3, minutes=10)
-    #     duration = Duration()
-    #     duration.FromTimedelta(td)
-    #
-    # = JSON Mapping
-    #
-    # In JSON format, the Duration type is encoded as a string rather than an
-    # object, where the string ends in the suffix "s" (indicating seconds) and
-    # is preceded by the number of seconds, with nanoseconds expressed as
-    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
-    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
-    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
-    # microsecond should be expressed in JSON format as "3.000001s".
-    # @!attribute [rw] seconds
-    #   @return [Integer]
-    #     Signed seconds of the span of time. Must be from -315,576,000,000
-    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
-    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-    # @!attribute [rw] nanos
-    #   @return [Integer]
-    #     Signed fractions of a second at nanosecond resolution of the span
-    #     of time. Durations less than one second are represented with a 0
-    #     `seconds` field and a positive or negative `nanos` field. For durations
-    #     of one second or more, a non-zero value for the `nanos` field must be
-    #     of the same sign as the `seconds` field. Must be from -999,999,999
-    #     to +999,999,999 inclusive.
-    class Duration; end
-  end
-end