google-cloud-pubsub 0.26.0 → 2.6.1

data/lib/google-cloud-pubsub.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# 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
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,
@@ -12,14 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 ##
-# This file is here to be autorequired by bundler, so that the .bigquery and
-# #bigquery methods can be available, but the library and all dependencies won't
-# be loaded until required and used.
+# This file is here to be autorequired by bundler, so that the
+# Google::Cloud.pubsub and Google::Cloud#pubsub methods can be available, but
+# the library and all dependencies won't be loaded until required and used.
 
 
 gem "google-cloud-core"
-require "google/cloud"
+require "google/cloud" unless defined? Google::Cloud.new
+require "google/cloud/config"
+require "googleauth"
 
 module Google
   module Cloud
@@ -27,8 +30,8 @@ module Google
     # Creates a new object for connecting to the Pub/Sub service.
     # Each call creates a new connection.
     #
-    # For more information on connecting to Google Cloud see the [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    # For more information on connecting to Google Cloud see the
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
@@ -39,10 +42,8 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/pubsub`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
-    # @return [Google::Cloud::Pubsub::Project]
+    # @return [Google::Cloud::PubSub::Project]
     #
     # @example
     #   require "google/cloud"
@@ -59,23 +60,25 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   pubsub = gcloud.pubsub scope: platform_scope
     #
-    def pubsub scope: nil, timeout: nil, client_config: nil
-      Google::Cloud.pubsub @project, @keyfile, scope: scope,
-                                               timeout: (timeout || @timeout),
-                                               client_config: client_config
+    def pubsub scope: nil, timeout: nil
+      timeout ||= @timeout
+      Google::Cloud.pubsub @project, @keyfile, scope: scope, timeout: timeout
     end
 
     ##
     # Creates a new object for connecting to the Pub/Sub service.
     # Each call creates a new connection.
     #
-    # For more information on connecting to Google Cloud see the [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    # For more information on connecting to Google Cloud see the
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
-    # @param [String] project Project identifier for the Pub/Sub service you are
-    #   connecting to.
-    # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-    #   file path the file must be readable.
+    # @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 [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
@@ -85,10 +88,8 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/pubsub`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     #
-    # @return [Google::Cloud::Pubsub::Project]
+    # @return [Google::Cloud::PubSub::Project]
     #
     # @example
     #   require "google/cloud"
@@ -98,12 +99,42 @@ module Google
     #   topic = pubsub.topic "my-topic"
     #   topic.publish "task completed"
     #
-    def self.pubsub project = nil, keyfile = nil, scope: nil, timeout: nil,
-                    client_config: nil
+    def self.pubsub project_id = nil,
+                    credentials = nil,
+                    scope: nil,
+                    timeout: nil
       require "google/cloud/pubsub"
-      Google::Cloud::Pubsub.new project: project, keyfile: keyfile,
-                                scope: scope, timeout: timeout,
-                                client_config: client_config
+      Google::Cloud::PubSub.new project_id: project_id, credentials: credentials, scope: scope, timeout: timeout
     end
   end
 end
+
+# Set the default pubsub configuration
+Google::Cloud.configure.add_config! :pubsub do |config|
+  default_project = Google::Cloud::Config.deferred do
+    ENV["PUBSUB_PROJECT"]
+  end
+  default_creds = Google::Cloud::Config.deferred do
+    Google::Cloud::Config.credentials_from_env(
+      "PUBSUB_CREDENTIALS", "PUBSUB_CREDENTIALS_JSON", "PUBSUB_KEYFILE", "PUBSUB_KEYFILE_JSON"
+    )
+  end
+  default_emulator = Google::Cloud::Config.deferred do
+    ENV["PUBSUB_EMULATOR_HOST"]
+  end
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/pubsub"
+  ]
+
+  config.add_field! :project_id, default_project, match: String, allow_nil: true
+  config.add_alias! :project, :project_id
+  config.add_field! :credentials, default_creds, match: [String, Hash, Google::Auth::Credentials], allow_nil: true
+  config.add_alias! :keyfile, :credentials
+  config.add_field! :scope, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
+  config.add_field! :timeout, nil, match: Integer
+  config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
+  config.add_field! :on_error, nil, match: Proc
+  config.add_field! :endpoint, "pubsub.googleapis.com", match: String
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,108 +9,122 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-cloud-core
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: google-gax
+  name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: grpc-google-iam-v1
+  name: google-cloud-pubsub-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.8
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.8
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-autotest
+  name: avro
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: autotest-suffix
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -124,19 +138,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -169,16 +197,16 @@ dependencies:
   name: yard-doctest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.13
 description: google-cloud-pubsub is the official library for Google Cloud Pub/Sub.
 email:
 - mike@blowmage.com
@@ -188,36 +216,47 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- AUTHENTICATION.md
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- EMULATOR.md
 - LICENSE
-- README.md
+- LOGGING.md
+- OVERVIEW.md
+- TROUBLESHOOTING.md
 - lib/google-cloud-pubsub.rb
 - lib/google/cloud/pubsub.rb
+- lib/google/cloud/pubsub/async_publisher.rb
+- lib/google/cloud/pubsub/async_publisher/batch.rb
+- lib/google/cloud/pubsub/batch_publisher.rb
+- lib/google/cloud/pubsub/convert.rb
 - lib/google/cloud/pubsub/credentials.rb
+- lib/google/cloud/pubsub/errors.rb
 - lib/google/cloud/pubsub/message.rb
 - lib/google/cloud/pubsub/policy.rb
 - lib/google/cloud/pubsub/project.rb
+- lib/google/cloud/pubsub/publish_result.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/topic/publisher.rb
-- lib/google/cloud/pubsub/v1.rb
-- lib/google/cloud/pubsub/v1/doc/google/protobuf/duration.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/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/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-pubsub
+homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-pubsub
 licenses:
 - Apache-2.0
 metadata: {}
@@ -229,15 +268,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub

data/README.md

@@ -1,69 +0,0 @@
-# google-cloud-pubsub
-
-[Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) ([docs](https://cloud.google.com/pubsub/docs/reference/rest/)) is designed to provide reliable, many-to-many, asynchronous messaging between applications. Publisher applications can send messages to a “topic” and other applications can subscribe to that topic to receive the messages. By decoupling senders and receivers, Google Cloud Pub/Sub allows developers to communicate between independently written applications.
-
-- [google-cloud-pubsub API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-pubsub/latest)
-- [google-cloud-pubsub on RubyGems](https://rubygems.org/gems/[google-cloud-pubsub)
-- [Google Cloud Pub/Sub documentation](https://cloud.google.com/pubsub/docs)
-
-## Quick Start
-
-```sh
-$ gem install google-cloud-pubsub
-```
-
-## Authentication
-
-This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.
-
-Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-pubsub/guides/authentication).
-
-## Example
-
-```ruby
-require "google/cloud/pubsub"
-
-pubsub = Google::Cloud::Pubsub.new(
-  project: "my-project",
-  keyfile: "/path/to/keyfile.json"
-)
-
-# Retrieve a topic
-topic = pubsub.topic "my-topic"
-
-# Publish a new message
-msg = topic.publish "new-message"
-
-# Retrieve a subscription
-sub = pubsub.subscription "my-topic-sub"
-
-# Pull available messages
-msgs = sub.pull
-```
-
-## Supported Ruby Versions
-
-This library is supported on Ruby 2.0+.
-
-## Versioning
-
-This library follows [Semantic Versioning](http://semver.org/).
-
-It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.
-
-## Contributing
-
-Contributions to this library are always welcome and highly encouraged.
-
-See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
-
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
-
-## License
-
-This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
-
-## Support
-
-Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
-Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).