google-cloud-pubsub 1.10.0 → 2.3.0

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

@@ -78,7 +78,7 @@ module Google
         #     end
         #   end
         #
-        #   topic.async_publisher.stop.wait!
+        #   topic.async_publisher.stop!
         #
         def async_publisher
           @async_publisher
@@ -275,7 +275,10 @@ module Google
         #   604,800 seconds (7 days) or less than 600 seconds (10 minutes).
         #   Default is 604,800 seconds (7 days).
         # @param [String] endpoint A URL locating the endpoint to which messages
-        #   should be pushed.
+        #   should be pushed. The parameters `push_config` and `endpoint` should not both be provided.
+        # @param [Google::Cloud::PubSub::Subscription::PushConfig] push_config The configuration for a push delivery
+        #   endpoint that should contain the endpoint, and can contain authentication data (OIDC token authentication).
+        #   The parameters `push_config` and `endpoint` should not both be provided.
         # @param [Hash] labels A hash of user-provided labels associated with
         #   the subscription. You can use these to organize and group your
         #   subscriptions. Label keys and values can be no longer than 63
@@ -306,9 +309,6 @@ module Google
         #   will be retried as soon as possible for healthy subscribers. Retry Policy will be triggered on NACKs or
         #   acknowledgement deadline exceeded events for a given message.
         #
-        #   **EXPERIMENTAL:** This API might be changed in backward-incompatible ways and is not recommended for
-        #   production use. It is not subject to any SLA or deprecation policy.
-        #
         # @return [Google::Cloud::PubSub::Subscription]
         #
         # @example
@@ -320,15 +320,25 @@ module Google
         #   sub = topic.subscribe "my-topic-sub"
         #   sub.name # => "my-topic-sub"
         #
-        # @example Wait 2 minutes for acknowledgement and push all to endpoint:
+        # @example Wait 2 minutes for acknowledgement:
         #   require "google/cloud/pubsub"
         #
         #   pubsub = Google::Cloud::PubSub.new
         #
         #   topic = pubsub.topic "my-topic"
         #   sub = topic.subscribe "my-topic-sub",
-        #                         deadline: 120,
-        #                         endpoint: "https://example.com/push"
+        #                         deadline: 120
+        #
+        # @example Configure a push endpoint:
+        #   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 Configure a Dead Letter Queues policy:
         #   require "google/cloud/pubsub"
@@ -361,19 +371,40 @@ module Google
         #   retry_policy = Google::Cloud::PubSub::RetryPolicy.new minimum_backoff: 5, maximum_backoff: 300
         #   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, filter: nil, dead_letter_topic: nil,
-                      dead_letter_max_delivery_attempts: nil, retry_policy: nil
+        def subscribe subscription_name,
+                      deadline: nil,
+                      retain_acked: false,
+                      retention: nil,
+                      endpoint: nil,
+                      push_config: nil,
+                      labels: 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, filter: filter,
-                      dead_letter_max_delivery_attempts: dead_letter_max_delivery_attempts }
+          if push_config && endpoint
+            raise ArgumentError, "endpoint and push_config were both provided. Please provide only one."
+          end
+          push_config = Google::Cloud::PubSub::Subscription::PushConfig.new endpoint: endpoint if endpoint
+
+          options = {
+            deadline:                          deadline,
+            retain_acked:                      retain_acked,
+            retention:                         retention,
+            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.
             raise ArgumentError, "dead_letter_topic is required with dead_letter_max_delivery_attempts"
           end
+          options[:push_config] = push_config.to_grpc if push_config
           options[:retry_policy] = retry_policy.to_grpc if retry_policy
           grpc = service.create_subscription name, subscription_name, options
           Subscription.from_grpc grpc, service
@@ -590,7 +621,7 @@ module Google
         #   end
         #
         #   # Shut down the publisher when ready to stop publishing messages.
-        #   topic.async_publisher.stop.wait!
+        #   topic.async_publisher.stop!
         #
         # @example A message can be published using a File object:
         #   require "google/cloud/pubsub"
@@ -602,7 +633,7 @@ module Google
         #   topic.publish_async file
         #
         #   # Shut down the publisher when ready to stop publishing messages.
-        #   topic.async_publisher.stop.wait!
+        #   topic.async_publisher.stop!
         #
         # @example Additionally, a message can be published with attributes:
         #   require "google/cloud/pubsub"
@@ -614,7 +645,7 @@ module Google
         #                       foo: :bar, this: :that
         #
         #   # Shut down the publisher when ready to stop publishing messages.
-        #   topic.async_publisher.stop.wait!
+        #   topic.async_publisher.stop!
         #
         # @example Ordered messages are supported using ordering_key:
         #   require "google/cloud/pubsub"
@@ -631,7 +662,7 @@ module Google
         #                       ordering_key: "task-key"
         #
         #   # Shut down the publisher when ready to stop publishing messages.
-        #   topic.async_publisher.stop.wait!
+        #   topic.async_publisher.stop!
         #
         def publish_async data = nil, attributes = nil, ordering_key: nil, **extra_attrs, &callback
           ensure_service!

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "1.10.0".freeze
+      VERSION = "2.3.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.10.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-11-18 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.1.3
+rubygems_version: 3.1.4
 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