google-cloud-pubsub 0.32.1 → 0.32.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48356ab57faedf9942a2ad5d402c6f71297bc5a05f3b39e5479deb3f3be58546
-  data.tar.gz: a7e64b049fb79b6bc0adcc619ca98de9a7234c16be32c5e3a8dd601267df065b
+  metadata.gz: 02df7490b94ade13d3c63495002c52b2d207eea1c607a3043b2610a0f4bc285f
+  data.tar.gz: 1386f2606152b290a445e1d7e9869da0d7cfc2d59bb3b9b2baf720a229a45e2a
 SHA512:
-  metadata.gz: e2b484c364e220f79e2ae876614947731fa54a008703ce70ba9a78bea5462c20a2a05d236296cc3f44ebd0ef1b7a9408d7036016722eed922520a2bad3749065
-  data.tar.gz: bdca017d6084369de21feec4a31ed23c224b5526048d4f3f01a3d05559b5db5477fe71768080f15d0fa42cfaf3f7c26bec2b04bcd7b2d6af5c46a1380ea27f60
+  metadata.gz: 99ff80e29fa39ae47633ab1dcfd82a141825833cbb38329ee8b827fdb17006fd80e988c71075cdcd563a04336283f8ba7b2e9dc6d3d50346abf36d217d6cc654
+  data.tar.gz: 891c467d54a0355228b3108d096b4e220702c1ec4bfb393f83b5e2c878c616d378999e442ba80948fed1af4cc91c64bd431e757cc1b415368901cbb6836c6208

data/AUTHENTICATION.md

@@ -0,0 +1,178 @@
+# Authentication
+
+In general, the google-cloud-pubsub library uses [Service
+Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+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
+keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
+the account (or the JSON itself) in environment variables. Additionally, Cloud
+SDK credentials can also be discovered automatically, but this is only
+recommended during development.
+
+## Project and Credential Lookup
+
+The google-cloud-pubsub library aims to make authentication as simple as
+possible, and provides several mechanisms to configure your system without
+providing **Project ID** and **Service Account Credentials** directly in code.
+
+**Project ID** is discovered in the following order:
+
+1. Specify project ID in method arguments
+2. Specify project ID in configuration
+3. Discover project ID in environment variables
+4. Discover GCE project ID
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCE credentials
+
+### Google Cloud Platform environments
+
+While running on Google Cloud Platform environments such as Google Compute
+Engine, Google App Engine and Google Kubernetes Engine, no extra work is needed.
+The **Project ID** and **Credentials** and are discovered automatically. Code
+should be written as if already authenticated. Just be sure when you [set up the
+GCE instance][gce-how-to], you add the correct scopes for the APIs you want to
+access. For example:
+
+  * **All APIs**
+    * `https://www.googleapis.com/auth/cloud-platform`
+    * `https://www.googleapis.com/auth/cloud-platform.read-only`
+  * **BigQuery**
+    * `https://www.googleapis.com/auth/bigquery`
+    * `https://www.googleapis.com/auth/bigquery.insertdata`
+  * **Compute Engine**
+    * `https://www.googleapis.com/auth/compute`
+  * **Datastore**
+    * `https://www.googleapis.com/auth/datastore`
+    * `https://www.googleapis.com/auth/userinfo.email`
+  * **DNS**
+    * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
+  * **Pub/Sub**
+    * `https://www.googleapis.com/auth/pubsub`
+  * **Storage**
+    * `https://www.googleapis.com/auth/devstorage.full_control`
+    * `https://www.googleapis.com/auth/devstorage.read_only`
+    * `https://www.googleapis.com/auth/devstorage.read_write`
+
+### Environment Variables
+
+The **Project ID** and **Credentials JSON** can be placed in environment
+variables instead of declaring them directly in code. Each service has its own
+environment variable, allowing for different service accounts to be used for
+different services. (See the READMEs for the individual service gems for
+details.) The path to the **Credentials JSON** file can be stored in the
+environment variable, or the **Credentials JSON** itself can be stored for
+environments such as Docker containers where writing files is difficult or not
+encouraged.
+
+The environment variables that Pub/Sub checks for project ID are:
+
+1. `PUBSUB_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that Pub/Sub checks for credentials are configured on {Google::Cloud::Pubsub::V1::Credentials}:
+
+1. `PUBSUB_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `PUBSUB_KEYFILE` - Path to JSON file, or JSON contents
+3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/pubsub"
+
+ENV["PUBSUB_PROJECT"]     = "my-project-id"
+ENV["PUBSUB_CREDENTIALS"] = "path/to/keyfile.json"
+
+pubsub = Google::Cloud::Pubsub.new
+```
+
+### Configuration
+
+The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+
+```ruby
+require "google/cloud/pubsub"
+
+Google::Cloud::Pubsub.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+pubsub = Google::Cloud::Pubsub.new
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+3. Write code as if already authenticated.
+
+**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
+[dev-console]: https://console.cloud.google.com/project
+
+[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
+
+[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
+[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
+[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
+
+## Creating a Service Account
+
+Google Cloud requires a **Project ID** and **Service Account Credentials** to
+connect to the APIs. You will use the **Project ID** and **JSON key file** to
+connect to most services with google-cloud-pubsub.
+
+If you are not running this client on Google Compute Engine, you need a Google
+Developers service account.
+
+1. Visit the [Google Developers Console][dev-console].
+1. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. From
+   here, you will enable the APIs that your application requires.
+
+   ![Enable the APIs that your application requires][enable-apis]
+
+   *Note: You may need to enable billing in order to use these services.*
+
+1. Select **Credentials** from the side navigation.
+
+   You should see a screen like one of the following.
+
+   ![Create a new service account][create-new-service-account]
+
+   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
+
+   Find the "Add credentials" drop down and select "Service account" to be
+   guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, and click "Generate
+   new JSON key":
+
+   ![Re-use an existing service account][reuse-service-account]
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.
+
+## Troubleshooting
+
+If you're having trouble authenticating you can ask for help by following the
+{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/CHANGELOG.md

@@ -0,0 +1,161 @@
+# Release History
+
+### 0.32.2 / 2018-09-12
+
+* Add missing documentation files to package.
+
+### 0.32.1 / 2018-09-10
+
+* Fix issue where client_config was not being used on publisher API calls.
+* Update documentation.
+
+### 0.32.0 / 2018-08-14
+
+* Updated Subscriber implementation
+  * Revised shutdown mechanics
+    * Fixes stop and wait! would hanging indefinitely.
+    * Reduce the number of GRPC warnings printed.
+  * Added error callbacks to the API
+    *  Use error handler to be notified when unhandled errors
+       occur on a subscriber's stream thread.
+* Documentation updates.
+
+### 0.31.1 / 2018-08-14
+
+* Fix bug in AsyncUnaryPusher,
+  * The modify_ack_deadline requests were malformed.
+
+### 0.31.0 / 2018-06-12
+
+* Switch Subscriber to use unary RPC calls for ack/modack.
+* Reduce number of String objects that are garbage collected.
+* Documentation updates.
+
+### 0.30.2 / 2018-04-02
+
+* Subscriber stability enhancements.
+* Subscriber performance enhancements.
+
+### 0.30.1 / 2018-03-08
+
+* Fix Subscriber thread leak.
+
+### 0.30.0 / 2018-02-27
+
+* Support Shared Configuration.
+* Fix issue with IAM Policy not refreshing properly.
+
+### 0.29.0 / 2017-12-19
+
+* Update Subscriber's receipt of received messages.
+* Refactor Subscriber implementation to fix some threading bugs.
+* Update google-gax dependency to 1.0.
+
+### 0.28.1 / 2017-11-21
+
+* Remove warning when connecting to Pub/Sub Emulator.
+
+### 0.28.0 / 2017-11-14
+
+* Add `Google::Cloud::Pubsub::Credentials` class.
+* Rename constructor arguments to `project_id` and `credentials`.
+  (The previous arguments `project` and `keyfile` are still supported.)
+* Document `Google::Auth::Credentials` as `credentials` value.
+* Update generated low level GAPIC code.
+* Updated `google-gax` (`grpc`, `google-protobuf`), `googleauth` dependencies.
+
+### 0.27.2 / 2017-10-18
+
+* Update documentation
+
+### 0.27.1 / 2017-10-11
+
+* Add keepalive to gRPC connections.
+* Update Subscriber Streaming Messages error handling
+* Fix link in README
+
+### 0.27.0 / 2017-08-10
+
+This is a major release that offers new functionality. It adds the ability to asynchronously publish batches of messages when a threshold is met (batch message count, total batch size, batch age). It also adds the ability to receive and acknowledge messages via multiple streams.
+
+* Publishing Messages Asynchronously
+  * `Topic#publish_async` and `AsyncPublisher` added
+  * `AsyncPublisher` can be stopped
+  * `PublishResult` object is yielded from `Topic#publish_async`
+* Subscriber Streaming Messages
+  * `Subscription#listen` changed to return a `Subscriber` object
+  * `Subscriber` can open multiple streams to pull messages
+  * `Subscriber` must be started to begin streaming messages
+  * `Subscriber` can be stopped
+  * `Subscriber`'s received messages are leased until acknowledged or rejected
+* Other Additions
+  * `ReceivedMessage#reject!` method added (aliased as `nack!` and `ignore!`)
+  * `Message#published_at` attribute was added
+* Removals
+  * `Project#publish` method has been removed
+  * `Project#subscribe` method has been removed
+  * `Project#topic` method argument `autocreate` was removed
+  * `Subscription#pull` method argument `autoack` was removed
+  * `Subscription#wait_for_messages` method argument `autoack` was removed
+
+### 0.26.0 / 2017-07-11
+
+* Update GAPIC configuration to exclude `UNAVAILABLE` errors from automatic retry.
+* Update initialization to raise a better error if project ID is not specified.
+
+### 0.25.0 / 2017-06-01
+
+* Add Snapshot and Subscription#seek.
+* Add Subscription#retain_acked and Subscription#retention.
+* Update gem spec homepage links.
+* Remove memoization of Policy.
+* Remove force parameter from Subscription#policy and Topic#policy.
+* Remove Policy#deep_dup.
+* Configure gRPC max_send_message_length and max_receive_message_length
+to accommodate max message size > 4 MB.
+
+### 0.24.0 / 2017-03-31
+
+* Updated documentation
+* Updated retry configuration for pull requests
+* Automatic retry on `UNAVAILABLE` errors
+
+### 0.23.2 / 2017-03-03
+
+* No public API changes.
+* Update GRPC header value sent to the Pub/Sub API.
+
+### 0.23.1 / 2017-03-01
+
+* No public API changes.
+* Update GRPC header value sent to the Pub/Sub API.
+* Low level API adds new Protobuf types and GAPIC methods.
+
+### 0.23.0 / 2017-02-21
+
+* Add emulator_host parameter
+* Fix GRPC retry bug
+* The client_config data structure has replaced retry_codes/retry_codes_def with retry_codes
+* Update GRPC/Protobuf/GAX dependencies
+
+### 0.22.0 / 2017-01-26
+
+* Change class names in low-level API (GAPIC)
+* Change method parameters in low-level API (GAPIC)
+* Add LICENSE to package.
+
+### 0.21.0 / 2016-10-20
+
+* New service constructor Google::Cloud::Pubsub.new
+* New constructor argument client_config
+
+### 0.20.1 / 2016-09-02
+
+* Fix an issue with the GRPC client and forked sub-processes
+
+### 0.20.0 / 2016-08-26
+
+This gem contains the Google Cloud Pub/Sub service implementation for the `google-cloud` gem. The `google-cloud` gem replaces the old `gcloud` gem. Legacy code can continue to use the `gcloud` gem.
+
+* Namespace is now `Google::Cloud`
+* The `google-cloud` gem is now an umbrella package for individual gems

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.2.0, available at
+[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,188 @@
+# Contributing to Google Cloud Pub/Sub
+
+1. **Sign one of the contributor license agreements below.**
+2. Fork the repo, develop and test your code changes.
+3. Send a pull request.
+
+## Contributor License Agreements
+
+Before we can accept your pull requests you'll need to sign a Contributor
+License Agreement (CLA):
+
+- **If you are an individual writing original source code** and **you own the
+  intellectual property**, then you'll need to sign an [individual
+  CLA](https://developers.google.com/open-source/cla/individual).
+- **If you work for a company that wants to allow you to contribute your work**,
+  then you'll need to sign a [corporate
+  CLA](https://developers.google.com/open-source/cla/corporate).
+
+You can sign these electronically (just scroll to the bottom). After that, we'll
+be able to accept your pull requests.
+
+## Setup
+
+In order to use the google-cloud-pubsub console and run the project's tests,
+there is a small amount of setup:
+
+1. Install Ruby. google-cloud-pubsub requires Ruby 2.3+. You may choose to
+   manage your Ruby and gem installations with [RVM](https://rvm.io/),
+   [rbenv](https://github.com/rbenv/rbenv), or
+   [chruby](https://github.com/postmodern/chruby).
+
+2. Install [Bundler](http://bundler.io/).
+
+   ```sh
+   $ gem install bundler
+   ```
+
+3. Install the top-level project dependencies.
+
+   ```sh
+   $ bundle install
+   ```
+
+4. Install the Pub/Sub dependencies.
+
+   ```sh
+   $ cd google-cloud-pubsub/
+   $ bundle exec rake bundleupdate
+   ```
+
+## Console
+
+In order to run code interactively, you can automatically load
+google-cloud-pubsub and its dependencies in IRB. This requires that your
+developer environment has already been configured by following the steps
+described in the {file:AUTHENTICATION.md Authentication Guide}. An IRB console
+can be created with:
+
+```sh
+$ cd google-cloud-pubsub/
+$ bundle exec rake console
+```
+
+## Pub/Sub Tests
+
+Tests are very important part of google-cloud-pubsub. All contributions
+should include tests that ensure the contributed code behaves as expected.
+
+To run the unit tests, documentation tests, and code style checks together for a
+package:
+
+``` sh
+$ cd google-cloud-pubsub/
+$ bundle exec rake ci
+```
+
+To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
+its handy alias, `rake ci:a`.
+
+### Pub/Sub Unit Tests
+
+
+The project uses the [minitest](https://github.com/seattlerb/minitest) library,
+including [specs](https://github.com/seattlerb/minitest#specs),
+[mocks](https://github.com/seattlerb/minitest#mocks) and
+[minitest-autotest](https://github.com/seattlerb/minitest-autotest).
+
+To run the Pub/Sub unit tests:
+
+``` sh
+$ cd google-cloud-pubsub/
+$ bundle exec rake test
+```
+
+### Pub/Sub Documentation Tests
+
+The project tests the code examples in the gem's
+[YARD](https://github.com/lsegal/yard)-based documentation.
+
+The example testing functions in a way that is very similar to unit testing, and
+in fact the library providing it,
+[yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
+project's unit test library, [minitest](https://github.com/seattlerb/minitest).
+
+To run the Pub/Sub documentation tests:
+
+``` sh
+$ cd google-cloud-pubsub/
+$ bundle exec rake doctest
+```
+
+If you add, remove or modify documentation examples when working on a pull
+request, you may need to update the setup for the tests. The stubs and mocks
+required to run the tests are located in `support/doctest_helper.rb`. Please
+note that much of the setup is matched by the title of the
+[`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
+If you alter an example's title, you may encounter breaking tests.
+
+### Pub/Sub Acceptance Tests
+
+The Pub/Sub acceptance tests interact with the live service API. Follow the
+instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+the Pub/Sub API. Occasionally, some API features may not yet be generally
+available, making it difficult for some contributors to successfully run the
+entire acceptance test suite. However, please ensure that you do successfully
+run acceptance tests for any code areas covered by your pull request.
+
+To run the acceptance tests, first create and configure a project in the Google
+Developers Console, as described in the {file:AUTHENTICATION.md Authentication
+guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
+the KEYFILE location on your system.
+
+Before you can run the Pub/Sub acceptance tests, you must first create indexes
+used in the tests.
+
+#### Running the Pub/Sub acceptance tests
+
+To run the Pub/Sub acceptance tests:
+
+``` sh
+$ cd google-cloud-pubsub/
+$ bundle exec rake acceptance[\\{my-project-id},\\{/path/to/keyfile.json}]
+```
+
+Or, if you prefer you can store the values in the `GCLOUD_TEST_PROJECT` and
+`GCLOUD_TEST_KEYFILE` environment variables:
+
+``` sh
+$ cd google-cloud-pubsub/
+$ export GCLOUD_TEST_PROJECT=\\{my-project-id}
+$ export GCLOUD_TEST_KEYFILE=\\{/path/to/keyfile.json}
+$ bundle exec rake acceptance
+```
+
+If you want to use a different project and credentials for acceptance tests, you
+can use the more specific `PUBSUB_TEST_PROJECT`  and `PUBSUB_TEST_KEYFILE`
+environment variables:
+
+``` sh
+$ cd google-cloud-pubsub/
+$ export PUBSUB_TEST_PROJECT=\\{my-project-id}
+$ export PUBSUB_TEST_KEYFILE=\\{/path/to/keyfile.json}
+$ bundle exec rake acceptance
+```
+
+## Coding Style
+
+Please follow the established coding style in the library. The style is is
+largely based on [The Ruby Style
+Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
+on seattle-style:
+
+* Avoid parenthesis when possible, including in method definitions.
+* Always use double quotes strings. ([Option
+  B](https://github.com/bbatsov/ruby-style-guide#strings))
+
+You can check your code against these rules by running Rubocop like so:
+
+```sh
+$ cd google-cloud-pubsub/
+$ bundle exec rake rubocop
+```
+
+## Code of Conduct
+
+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
+{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.

data/EMULATOR.md

@@ -0,0 +1,37 @@
+# Google Cloud Pub/Sub Emulator
+
+To develop and test your application locally, you can use the [Google Cloud
+Pub/Sub Emulator](https://cloud.google.com/pubsub/emulator), which provides
+[local emulation](https://cloud.google.com/sdk/gcloud/reference/beta/emulators/)
+of the production Google Cloud Pub/Sub environment. You can start the Google
+Cloud Pub/Sub emulator using the `gcloud` command-line tool.
+
+To configure your ruby code to use the emulator, set the `PUBSUB_EMULATOR_HOST`
+environment variable to the host and port where the emulator is running. The
+value can be set as an environment variable in the shell running the ruby code,
+or can be set directly in the ruby code as shown below.
+
+```ruby
+require "google/cloud/pubsub"
+
+# Make Pub/Sub use the emulator
+ENV["PUBSUB_EMULATOR_HOST"] = "localhost:8918"
+
+pubsub = Google::Cloud::Pubsub.new "emulator-project-id"
+
+# Get a topic in the current project
+my_topic = pubsub.new_topic "my-topic"
+my_topic.name #=> "projects/emulator-project-id/topics/my-topic"
+```
+
+Or by providing the `emulator_host` argument:
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new emulator_host: "localhost:8918"
+
+# Get a topic in the current project
+my_topic = pubsub.new_topic "my-topic"
+my_topic.name #=> "projects/emulator-project-id/topics/my-topic"
+```

data/LOGGING.md

@@ -0,0 +1,32 @@
+# Enabling gRPC Logging
+
+To enable logging for this library, set the logger for the underlying
+[gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
+that you set may be a Ruby stdlib
+[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+shown below, or a
+[`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
+that will write logs to [Stackdriver
+Logging](https://cloud.google.com/logging/). See
+[grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC
+[spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb)
+for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```

data/OVERVIEW.md

@@ -0,0 +1,435 @@
+# Google Cloud Pub/Sub
+
+Google Cloud Pub/Sub 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.
+
+The goal of google-cloud is to provide an API that is comfortable to Rubyists.
+Your authentication credentials are detected automatically in Google Cloud
+Platform environments such as Google Compute Engine, Google App Engine and
+Google Kubernetes Engine. In other environments you can configure authentication
+easily, either directly in your code or via environment variables. Read more
+about the options for connecting in the {file:AUTHENTICATION.md Authentication
+Guide}.
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+topic = pubsub.topic "my-topic"
+topic.publish "task completed"
+```
+
+To learn more about Pub/Sub, read the [Google Cloud Pub/Sub Overview
+](https://cloud.google.com/pubsub/overview).
+
+## Retrieving Topics
+
+A Topic is a named resource to which messages are sent by publishers. A Topic is
+found by its name. (See {Google::Cloud::Pubsub::Project#topic Project#topic})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+topic = pubsub.topic "my-topic"
+```
+
+## Creating a Topic
+
+A Topic is created from a Project. (See
+{Google::Cloud::Pubsub::Project#create_topic Project#create_topic})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+topic = pubsub.create_topic "my-topic"
+```
+
+## Retrieving Subscriptions
+
+A Subscription is a named resource representing the stream of messages from a
+single, specific Topic, to be delivered to the subscribing application. A
+Subscription is found by its name. (See
+{Google::Cloud::Pubsub::Topic#subscription Topic#subscription})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+topic = pubsub.topic "my-topic"
+subscription = topic.subscription "my-topic-subscription"
+puts subscription.name
+```
+
+## Creating a Subscription
+
+A Subscription is created from a Topic. (See
+{Google::Cloud::Pubsub::Topic#subscribe Topic#subscribe})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+topic = pubsub.topic "my-topic"
+sub = topic.subscribe "my-topic-sub"
+puts sub.name # => "my-topic-sub"
+```
+
+The subscription can be created that specifies the number of seconds to wait to
+be acknowledged as well as an endpoint URL to push the messages to:
+
+```ruby
+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"
+```
+
+## Publishing Messages
+
+Messages are published to a topic. Any message published to a topic without a
+subscription will be lost. Ensure the topic has a subscription before
+publishing. (See {Google::Cloud::Pubsub::Topic#publish Topic#publish})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+topic = pubsub.topic "my-topic"
+msg = topic.publish "task completed"
+```
+
+Messages can also be published with attributes:
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+topic = pubsub.topic "my-topic"
+msg = topic.publish "task completed",
+                    foo: :bar,
+                    this: :that
+```
+
+Messages can also be published in batches asynchronously using `publish_async`.
+(See {Google::Cloud::Pubsub::Topic#publish_async Topic#publish_async} and
+{Google::Cloud::Pubsub::AsyncPublisher AsyncPublisher})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+topic = pubsub.topic "my-topic"
+topic.publish_async "task completed" do |result|
+  if result.succeeded?
+    log_publish_success result.data
+  else
+    log_publish_failure result.data, result.error
+  end
+end
+
+topic.async_publisher.stop.wait!
+```
+
+Or multiple messages can be published in batches at the same time by passing a
+block to `publish`. (See {Google::Cloud::Pubsub::BatchPublisher BatchPublisher})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+topic = pubsub.topic "my-topic"
+msgs = topic.publish do |batch|
+  batch.publish "task 1 completed", foo: :bar
+  batch.publish "task 2 completed", foo: :baz
+  batch.publish "task 3 completed", foo: :bif
+end
+```
+
+## Receiving messages
+
+Messages can be streamed from a subscription with a subscriber object that is
+created using `listen`. (See {Google::Cloud::Pubsub::Subscription#listen
+Subscription#listen} and {Google::Cloud::Pubsub::Subscriber Subscriber})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+
+subscriber = sub.listen do |received_message|
+  # process message
+  received_message.acknowledge!
+end
+
+# Start background threads that will call the block passed to listen.
+subscriber.start
+
+# Shut down the subscriber when ready to stop receiving messages.
+subscriber.stop.wait!
+```
+
+Messages also can be pulled directly in a one-time operation. (See
+{Google::Cloud::Pubsub::Subscription#pull Subscription#pull})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+received_messages = sub.pull
+```
+
+A maximum number of messages to pull can be specified:
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+received_messages = sub.pull max: 10
+```
+
+## Acknowledging a Message
+
+Messages that are received can be acknowledged in Pub/Sub, marking the message
+to be removed so it cannot be pulled again.
+
+A Message that can be acknowledged is called a ReceivedMessage. ReceivedMessages
+can be acknowledged one at a time: (See
+{Google::Cloud::Pubsub::ReceivedMessage#acknowledge!
+ReceivedMessage#acknowledge!})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+
+subscriber = sub.listen do |received_message|
+  # process message
+  received_message.acknowledge!
+end
+
+# Start background threads that will call the block passed to listen.
+subscriber.start
+
+# Shut down the subscriber when ready to stop receiving messages.
+subscriber.stop.wait!
+```
+
+Or, multiple messages can be acknowledged in a single API call: (See
+{Google::Cloud::Pubsub::Subscription#acknowledge Subscription#acknowledge})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+received_messages = sub.pull
+sub.acknowledge received_messages
+```
+
+## Modifying a Deadline
+
+A message must be acknowledged after it is pulled, or Pub/Sub will mark the
+message for redelivery. The message acknowledgement deadline can delayed if more
+time is needed. This will allow more time to process the message before the
+message is marked for redelivery. (See
+{Google::Cloud::Pubsub::ReceivedMessage#delay! ReceivedMessage#delay!})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+subscriber = sub.listen do |received_message|
+  puts received_message.message.data
+
+  # Delay for 2 minutes
+  received_message.delay! 120
+end
+
+# Start background threads that will call the block passed to listen.
+subscriber.start
+
+# Shut down the subscriber when ready to stop receiving messages.
+subscriber.stop.wait!
+```
+
+The message can also be made available for immediate redelivery:
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+subscriber = sub.listen do |received_message|
+  puts received_message.message.data
+
+  # Mark for redelivery
+  received_message.reject!
+end
+
+# Start background threads that will call the block passed to listen.
+subscriber.start
+
+# Shut down the subscriber when ready to stop receiving messages.
+subscriber.stop.wait!
+```
+
+Multiple messages can be delayed or made available for immediate redelivery:
+(See {Google::Cloud::Pubsub::Subscription#delay Subscription#delay})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+received_messages = sub.pull
+sub.delay 120, received_messages
+```
+
+## Creating a snapshot and using seek
+
+You can create a snapshot to retain the existing backlog on a subscription. The
+snapshot will hold the messages in the subscription's backlog that are
+unacknowledged upon the successful completion of the `create_snapshot`
+operation.
+
+Later, you can use `seek` to reset the subscription's backlog to the snapshot.
+
+(See {Google::Cloud::Pubsub::Subscription#create_snapshot
+Subscription#create_snapshot} and {Google::Cloud::Pubsub::Subscription#seek
+Subscription#seek})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+
+snapshot = sub.create_snapshot
+
+received_messages = sub.pull
+sub.acknowledge received_messages
+
+sub.seek snapshot
+```
+
+## Listening for Messages
+
+A subscriber object can be created using `listen`, which streams messages from
+the backend and processes them as they are received. (See
+{Google::Cloud::Pubsub::Subscription#listen Subscription#listen} and
+{Google::Cloud::Pubsub::Subscriber Subscriber})
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+
+subscriber = sub.listen do |received_message|
+  # process message
+  received_message.acknowledge!
+end
+
+# Start background threads that will call the block passed to listen.
+subscriber.start
+
+# Shut down the subscriber when ready to stop receiving messages.
+subscriber.stop.wait!
+```
+
+The subscriber object can be configured to control the number of concurrent
+streams to open, the number of received messages to be collected, and the number
+of threads each stream opens for concurrent calls made to handle the received
+messages.
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new
+
+sub = pubsub.subscription "my-topic-sub"
+
+subscriber = sub.listen threads: { callback: 16 } do |received_message|
+  # store the message somewhere before acknowledging
+  store_in_backend received_message.data # takes a few seconds
+  received_message.acknowledge!
+end
+
+# Start background threads that will call the block passed to listen.
+subscriber.start
+```
+
+## Working Across Projects
+
+All calls to the Pub/Sub service use the same project and credentials provided
+to the {Google::Cloud::Pubsub.new Pubsub.new} method. However, it is common to
+reference topics or subscriptions in other projects, which can be achieved by
+using the `project` option. The main credentials must have permissions to the
+topics and subscriptions in other projects.
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new # my-project
+
+# Get a topic in the current project
+my_topic = pubsub.topic "my-topic"
+my_topic.name #=> "projects/my-project/topics/my-topic"
+# Get a topic in another project
+other_topic = pubsub.topic "other-topic", project: "other-project-id"
+other_topic.name #=> "projects/other-project-id/topics/other-topic"
+```
+
+It is possible to create a subscription in the current project that pulls
+from a topic in another project:
+
+```ruby
+require "google/cloud/pubsub"
+
+pubsub = Google::Cloud::Pubsub.new # my-project
+
+# Get a topic in another project
+topic = pubsub.topic "other-topic", project: "other-project-id"
+# Create a subscription in the current project that pulls from
+# the topic in another project
+sub = topic.subscribe "my-sub"
+sub.name #=> "projects/my-project/subscriptions/my-sub"
+sub.topic.name #=> "projects/other-project-id/topics/other-topic"
+```
+
+## Additional information
+
+Google Cloud Pub/Sub can be configured to use an emulator or to enable gRPC's
+logging. To learn more, see the {file:EMULATOR.md Emulator guide} and
+{file:LOGGING.md Logging guide}.

data/TROUBLESHOOTING.md

@@ -0,0 +1,37 @@
+# Troubleshooting
+
+## Where can I get more help?
+
+### Ask the Community
+
+If you have a question about how to use a Google Cloud client library in your
+project or are stuck in the Developer's console and don't know where to turn,
+it's possible your questions have already been addressed by the community.
+
+First, check out the appropriate tags on StackOverflow:
+  - [`google-cloud-platform+ruby+pubsub`][so-ruby]
+
+Next, try searching through the issues on GitHub:
+
+  - [`api:pubsub` issues][gh-search-ruby]
+
+Still nothing?
+
+### Ask the Developers
+
+If you're experiencing a bug with the code, or have an idea for how it can be
+improved, *please* create a new issue on GitHub so we can talk about it.
+
+  - [New issue][gh-ruby]
+
+Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
+can use the "ruby" channel for general Ruby questions, or use the
+"google-cloud-ruby" channel if you have questions about this gem in particular.
+
+[so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+pubsub
+
+[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+pubsub%22
+
+[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+
+[slack-ruby]: https://gcp-slack.appspot.com/

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Pubsub
-      VERSION = "0.32.1".freeze
+      VERSION = "0.32.2".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.32.1
+  version: 0.32.2
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -216,8 +216,15 @@ 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

data/README.md

@@ -1,117 +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/latest/file.AUTHENTICATION).
-
-## Example
-
-```ruby
-require "google/cloud/pubsub"
-
-pubsub = Google::Cloud::Pubsub.new(
-  project_id: "my-project",
-  credentials: "/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"
-
-# Create a subscriber to listen for available messages
-subscriber = sub.listen do |received_message|
-  # process message
-  received_message.acknowledge!
-end
-
-# Start background threads that will call the block passed to listen.
-subscriber.start
-
-# Shut down the subscriber when ready to stop receiving messages.
-subscriber.stop.wait!
-```
-
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
-
-```ruby
-require "logger"
-
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
-end
-```
-
-## Supported Ruby Versions
-
-This library is supported on Ruby 2.3+.
-
-Google provides official support for Ruby versions that are actively supported
-by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
-security maintenance, and not end of life. Currently, this means Ruby 2.3 and
-later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
-
-## 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/google-cloud-pubsub/latest/file.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](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-pubsub/latest/file.CODE_OF_CONDUCT)
-for more information.
-
-## License
-
-This library is licensed under Apache 2.0. Full license text is available in
-[LICENSE](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-pubsub/latest/file.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).