google-cloud-dns 0.29.1 → 0.29.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0971937836d18a9ee0a094eca937f703c15860557d91a74055260760d9a61323'
-  data.tar.gz: d8b8cddbc8c64ee8b35f15b0c35d138a0c4736ad425cba292e3c413a23f93df3
+  metadata.gz: 2430409168fd2bee1be6c69ef0de57e35d2c473a8f9d996995dc3952a01ab37e
+  data.tar.gz: 6d86dc2b9aec7ec841218bf80de1bc7f2b23f2ae0e5fe00f7c3b496b41f4818a
 SHA512:
-  metadata.gz: fb3ec64cb29effee7cd231802a146c32d5efee7f53d2844d7504fed499c88b5be68e0220c107bd67c05c7e04e8cad447522e3e0c3828f71d70bfa12c03e55b15
-  data.tar.gz: f56b92802b027a524c91ed7b9cd57bd50e0fb44b6eff4e96778f7b5d7025e8df1c0f48e084b7cded334aca1595642db1955758e278eefffa7c0efe03085e95fc
+  metadata.gz: 3de53cc5f31703f9afc7b38ef31b3bc7252821b374ab4a3554d3379a4ca5d5a385b92e74033c6ed7281dc90727c125b7421666897e38c20753c4e645d6ae1918
+  data.tar.gz: 11e1ea1862bfb949da948d96480b66ff51eedc0212165b9bf0ffc09fe9d2db74a3ad638deb88fb69ed3c5be83842c266dfc3b6640684c4417040a5aded596697

data/.yardopts

@@ -2,7 +2,15 @@
 --title=Google Cloud DNS
 --markup markdown
 --markup-provider redcarpet
+--main OVERVIEW.md
 
 ./lib/**/*.rb
 -
-README.md
+OVERVIEW.md
+AUTHENTICATION.md
+LOGGING.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/README.md

@@ -2,7 +2,7 @@
 
 [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 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)
 
@@ -16,7 +16,7 @@ $ gem install google-cloud-dns
 
 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/guides/authentication).
+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
 
@@ -42,7 +42,7 @@ 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/).
+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.
 
@@ -63,9 +63,9 @@ Google::Apis.logger = my_logger
 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
+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.
 
@@ -73,21 +73,31 @@ about the Ruby support schedule.
 
 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.
+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.
+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](../CODE_OF_CONDUCT.md) for more information.
+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](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).
+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).

data/lib/google-cloud-dns.rb

@@ -29,8 +29,8 @@ module Google
     # Creates a new object for connecting to the DNS 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
@@ -73,8 +73,8 @@ module Google
     # Creates a new `Project` instance connected to the DNS 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_id Identifier for a DNS project. If not present,
     #   the default project for the credentials is used.

data/lib/google/cloud/dns.rb

@@ -30,275 +30,7 @@ module Google
     # 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
-    # [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
-    #
-    # ## 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
-    # ```
-    #
-    # ## 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
-    # ```
+    # See {file:OVERVIEW.md Google Cloud DNS Overview}.
     #
     module Dns
       ##
@@ -306,8 +38,7 @@ module Google
       # 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).
+      # {file:AUTHENTICATION.md Authentication Guide}.
       #
       # @param [String] project_id Identifier for a DNS project. If not present,
       #   the default project for the credentials is used.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Dns
-      VERSION = "0.29.1".freeze
+      VERSION = "0.29.2".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.1
+  version: 0.29.2
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -197,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-dns is the official library for Google Cloud DNS.
 email:
 - mike@blowmage.com