google-cloud-dns 0.29.2 → 0.29.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2430409168fd2bee1be6c69ef0de57e35d2c473a8f9d996995dc3952a01ab37e
-  data.tar.gz: 6d86dc2b9aec7ec841218bf80de1bc7f2b23f2ae0e5fe00f7c3b496b41f4818a
+  metadata.gz: be4b25685e3ae6cefb7c36cded81c5a6ae3f71e284add2a9f93d73b4ddeb6457
+  data.tar.gz: a6f41e044cbcaecc6f4828e79f0605c69823e3e4fa9bbb3df4f4784450cdc4a3
 SHA512:
-  metadata.gz: 3de53cc5f31703f9afc7b38ef31b3bc7252821b374ab4a3554d3379a4ca5d5a385b92e74033c6ed7281dc90727c125b7421666897e38c20753c4e645d6ae1918
-  data.tar.gz: 11e1ea1862bfb949da948d96480b66ff51eedc0212165b9bf0ffc09fe9d2db74a3ad638deb88fb69ed3c5be83842c266dfc3b6640684c4417040a5aded596697
+  metadata.gz: 830b6ed9e1fab0cf7d67df07434495caf2d64b7a4a4e89aa252f6f926da0526f4ccd54d8ed009851ccb0a771f11264ac51c80ca3f039b9b17a8e2e67ff2d8c91
+  data.tar.gz: e1f92e514ee988222889c046dd495a47b62459b18ff1e1b31683a131526cc542f844117aaf8e61bcca77cdf9ec1d93cffae5e5e959406e210401b54da976c395

data/AUTHENTICATION.md

@@ -0,0 +1,180 @@
+# Authentication
+
+In general, the google-cloud-dns 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-dns 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 DNS checks for project ID are:
+
+1. `DNS_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that DNS checks for credentials are configured on
+{Google::Cloud::Dns::Credentials}:
+
+1. `DNS_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `DNS_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/dns"
+
+ENV["DNS_PROJECT"]     = "my-project-id"
+ENV["DNS_CREDENTIALS"] = "path/to/keyfile.json"
+
+dns = Google::Cloud::Dns.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/dns"
+
+Google::Cloud::Dns.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+dns = Google::Cloud::Dns.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-dns.
+
+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,69 @@
+# Release History
+
+### 0.29.3 / 2018-09-12
+
+* Add missing documentation files to package.
+
+### 0.29.2 / 2018-09-10
+
+* Update documentation.
+
+### 0.29.1 / 2018-08-21
+
+* Reduce memory usage.
+* Update documentation.
+
+### 0.29.0 / 2018-06-22
+
+* Updated dependencies.
+
+### 0.28.0 / 2018-02-27
+
+* Add Shared Configuration.
+* Update Google API Client dependency.
+
+### 0.27.0 / 2017-11-14
+
+* Add `Google::Cloud::Dns::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.
+* Updated `google-api-client`, `googleauth` dependencies.
+
+### 0.26.0 / 2017-09-28
+
+* Update Google API Client dependency to 0.14.x.
+
+### 0.25.0 / 2017-06-27
+
+* Upgrade dependency on Google API Client.
+* Update gem spec homepage links.
+* Update tests.
+
+### 0.24.0 / 2017-04-05
+
+* Upgrade dependency on Google API Client
+
+### 0.23.0 / 2017-03-31
+
+* Updated documentation
+
+### 0.22.0 / 2017-03-03
+
+* Updated documentation and code examples.
+* Dependency on Google API Client has been updated to 0.10.x.
+
+### 0.21.0 / 2016-10-20
+
+* New service constructor Google::Cloud::Dns.new
+
+### 0.20.1 / 2016-09-02
+
+* Fix for timeout on uploads.
+
+### 0.20.0 / 2016-08-26
+
+This gem contains the Google Cloud DNS 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 DNS
+
+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-dns console and run the project's tests,
+there is a small amount of setup:
+
+1. Install Ruby. google-cloud-dns 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 DNS dependencies.
+
+   ```sh
+   $ cd google-cloud-dns/
+   $ bundle exec rake bundleupdate
+   ```
+
+## Console
+
+In order to run code interactively, you can automatically load
+google-cloud-dns 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-dns/
+$ bundle exec rake console
+```
+
+## DNS Tests
+
+Tests are very important part of google-cloud-dns. 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-dns/
+$ bundle exec rake ci
+```
+
+To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
+its handy alias, `rake ci:a`.
+
+### DNS 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 DNS unit tests:
+
+``` sh
+$ cd google-cloud-dns/
+$ bundle exec rake test
+```
+
+### DNS 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 DNS documentation tests:
+
+``` sh
+$ cd google-cloud-dns/
+$ 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.
+
+### DNS Acceptance Tests
+
+The DNS acceptance tests interact with the live service API. Follow the
+instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+the DNS 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 DNS acceptance tests, you must first create indexes
+used in the tests.
+
+#### Running the DNS acceptance tests
+
+To run the DNS acceptance tests:
+
+``` sh
+$ cd google-cloud-dns/
+$ 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-dns/
+$ 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 `DNS_TEST_PROJECT`  and `DNS_TEST_KEYFILE`
+environment variables:
+
+``` sh
+$ cd google-cloud-dns/
+$ export DNS_TEST_PROJECT=\\{my-project-id}
+$ export DNS_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-dns/
+$ 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/LOGGING.md

@@ -0,0 +1,27 @@
+# Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [Google
+API
+Client](https://github.com/google/google-api-ruby-client/blob/master/README.md#logging)
+library. The logger that you set may be a Ruby stdlib
+[`Logger`](https://ruby-doc.org/stdlib-2.4.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/).
+
+If you do not set the logger explicitly and your application is running in a
+Rails environment, it will default to `Rails.logger`. Otherwise, if you do not
+set the logger and you are not using Rails, logging is disabled by default.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+my_logger = Logger.new $stderr
+my_logger.level = Logger::WARN
+
+# Set the Google API Client logger
+Google::Apis.logger = my_logger
+```

data/OVERVIEW.md

@@ -0,0 +1,254 @@
+# Google Cloud DNS
+
+Google Cloud DNS is a high-performance, resilient, global DNS service that
+provides a cost-effective way to make your applications and services
+available to your users. This programmable, authoritative DNS service can
+be used to easily publish and manage DNS records using the same
+infrastructure relied upon by Google. To learn more, read [What is Google
+Cloud DNS?](https://cloud.google.com/dns/what-is-cloud-dns).
+
+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}.
+
+## Creating Zones
+
+To get started with Google Cloud DNS, use your DNS Project to create a new
+Zone. The second argument to {Google::Cloud::Dns::Project#create_zone}
+must be a unique domain name for which you can [verify
+ownership](https://www.google.com/webmasters/verification/home).
+Substitute a domain name of your own (ending with a dot to signify that it
+is [fully
+qualified](https://en.wikipedia.org/wiki/Fully_qualified_domain_name)) as
+you follow along with these examples.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.create_zone "example-com", "example.com."
+puts zone.id # unique identifier defined by the server
+```
+
+For more information, see [Managing
+Zones](https://cloud.google.com/dns/zones/).
+
+## Listing Zones
+
+You can retrieve all the zones in your project.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zones = dns.zones
+zones.each do |zone|
+  puts "#{zone.name} - #{zone.dns}"
+end
+```
+
+You can also retrieve a single zone by either name or id.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+```
+
+## Listing Records
+
+When you create a zone, the Cloud DNS service automatically creates two
+Record instances for it, providing configuration for Cloud DNS
+nameservers. Let's take a look at these records.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+records = zone.records
+records.count #=> 2
+records.map &:type #=> ["NS", "SOA"]
+zone.records.first.data.count #=> 4
+zone.records.first.data #=> ["ns-cloud-d1.googledomains.com.", ...]
+```
+
+Note that {Google::Cloud::Dns::Record#data} returns an array. The Cloud
+DNS service only allows the zone to have one Record instance for each name
+and type combination. It supports multiple "resource records" (in this
+case, the four nameserver addresses) via this `data` collection.
+
+## Managing Records
+
+You can easily add your own records to the zone. Each call to
+{Google::Cloud::Dns::Zone#add} results in a new Cloud DNS Change instance.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+change = zone.add "www", "A", 86400, ["1.2.3.4"]
+change.additions.map &:type #=> ["A", "SOA"]
+change.deletions.map &:type #=> ["SOA"]
+```
+
+Whenever you change the set of records belonging to a zone, the zone's
+start of authority (SOA) record should be updated with a higher serial
+number. The google-cloud library automates this update for you, deleting
+the old SOA record and adding an updated one, as shown in the example
+above. You can disable or modify this behavior, of course. See
+{Google::Cloud::Dns::Zone#update} for details.
+
+You can retrieve records by name and type. The name argument can be a
+subdomain (e.g., `www`) fragment for convenience, but notice that the
+retrieved record's domain name is always fully-qualified.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+records = zone.records "www", "A"
+records.first.name #=> "www.example.com."
+```
+
+You can use {Google::Cloud::Dns::Zone#replace} to update the `ttl` and
+`data` for a record.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+change = zone.replace "www", "A", 86400, ["5.6.7.8"]
+```
+
+Or, you can use {Google::Cloud::Dns::Zone#modify} to update just the `ttl`
+or `data`, without the risk of inadvertently changing values that you wish
+to leave unchanged.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+change = zone.modify "www", "A" do |r|
+  r.ttl = 3600 # change only the TTL
+end
+```
+
+You can also delete records by name and type.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+change = zone.remove "www", "A"
+record = change.deletions.first
+```
+
+The best way to add, remove, and update multiple records in a single
+[transaction](https://cloud.google.com/dns/records) is to call
+{Google::Cloud::Dns::Zone#update} with a block. See
+{Google::Cloud::Dns::Zone::Transaction}.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+change = zone.update do |tx|
+  tx.add     "www", "A",  86400, "1.2.3.4"
+  tx.remove  "example.com.", "TXT"
+  tx.replace "example.com.", "MX", 86400, ["10 mail1.example.com.",
+                                           "20 mail2.example.com."]
+  tx.modify "www.example.com.", "CNAME" do |r|
+    r.ttl = 86400 # only change the TTL
+  end
+end
+```
+
+Finally, you can add and delete records by reference, using
+{Google::Cloud::Dns::Zone#update}.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+to_add = zone.record "www", "AAAA", 86400, ["2607:f8b0:400a:801::1005"]
+to_delete = zone.records "www", "A"
+change = zone.update to_add, to_delete
+```
+
+## Listing Changes
+
+Because the transactions you execute against your zone do not always
+complete immediately, you can retrieve and inspect changes.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+changes = zone.changes
+changes.each do |change|
+  puts "#{change.id} - #{change.started_at} - #{change.status}"
+end
+```
+
+## Importing and exporting zone files
+
+You can import from a zone file. Because the Cloud DNS service only allows
+the zone to have one Record instance for each name and type combination,
+lines may be merged as needed into records with multiple `data` values.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+change = zone.import "path/to/db.example.com"
+```
+
+You can also export to a zone file.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new
+zone = dns.zone "example-com"
+
+zone.export "path/to/db.example.com"
+```
+
+## Configuring retries and timeout
+
+You can configure how many times API requests may be automatically
+retried. When an API request fails, the response will be inspected to see
+if the request meets criteria indicating that it may succeed on retry,
+such as `500` and `503` status codes or a specific internal error code
+such as `rateLimitExceeded`. If it meets the criteria, the request will be
+retried after a delay. If another error occurs, the delay will be
+increased before a subsequent attempt, until the `retries` limit is
+reached.
+
+You can also set the request `timeout` value in seconds.
+
+```ruby
+require "google/cloud/dns"
+
+dns = Google::Cloud::Dns.new retries: 10, timeout: 120
+```
+
+## Additional information
+
+Google Cloud DNS can be configured to use logging. To learn more, see the
+{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+dns`][so-ruby]
+
+Next, try searching through the issues on GitHub:
+
+  - [`api:dns` 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+dns
+
+[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+dns%22
+
+[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+
+[slack-ruby]: https://gcp-slack.appspot.com/

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Dns
-      VERSION = "0.29.2".freeze
+      VERSION = "0.29.3".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dns
 version: !ruby/object:Gem::Version
-  version: 0.29.2
+  version: 0.29.3
 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,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- AUTHENTICATION.md
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE
-- README.md
+- LOGGING.md
+- OVERVIEW.md
+- TROUBLESHOOTING.md
 - lib/google-cloud-dns.rb
 - lib/google/cloud/dns.rb
 - lib/google/cloud/dns/change.rb

data/README.md

@@ -1,103 +0,0 @@
-# google-cloud-dns
-
-[Google Cloud DNS](https://cloud.google.com/dns/) ([docs](https://cloud.google.com/dns/docs)) is a high-performance, resilient, global DNS service that provides a cost-effective way to make your applications and services available to your users. This programmable, authoritative DNS service can be used to easily publish and manage DNS records using the same infrastructure relied upon by Google. To learn more, read [What is Google Cloud DNS?](https://cloud.google.com/dns/what-is-cloud-dns).
-
-- [google-cloud-dns API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-dns/latest)
-- [google-cloud-dns on RubyGems](https://rubygems.org/gems/google-cloud-dns)
-- [Google Cloud DNS documentation](https://cloud.google.com/dns/docs)
-
-## Quick Start
-
-```sh
-$ gem install google-cloud-dns
-```
-
-## 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-dns/latest/file.AUTHENTICATION).
-
-## Example
-
-```ruby
-require "google/cloud/dns"
-
-dns = Google::Cloud::Dns.new
-
-# Retrieve a zone
-zone = dns.zone "example-com"
-
-# Update records in the zone
-change = zone.update do |tx|
-  tx.add     "www", "A",  86400, "1.2.3.4"
-  tx.remove  "example.com.", "TXT"
-  tx.replace "example.com.", "MX", 86400, ["10 mail1.example.com.",
-                                           "20 mail2.example.com."]
-  tx.modify "www.example.com.", "CNAME" do |r|
-    r.ttl = 86400 # only change the TTL
-  end
-end
-```
-
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [Google API Client](https://github.com/google/google-api-ruby-client/blob/master/README.md#logging) library. The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.4.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/).
-
-If you do not set the logger explicitly and your application is running in a Rails environment, it will default to `Rails.logger`. Otherwise, if you do not set the logger and you are not using Rails, logging is disabled by default.
-
-Configuring a Ruby stdlib logger:
-
-```ruby
-require "logger"
-
-my_logger = Logger.new $stderr
-my_logger.level = Logger::WARN
-
-# Set the Google API Client logger
-Google::Apis.logger = my_logger
-```
-
-## 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-dns/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-dns/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-dns/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).