gcloud 0.12.2 → 0.20.0

data/lib/gcloud/dns.rb

@@ -1,4 +1,4 @@
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2016 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,323 +14,4 @@
 
 
 require "gcloud"
-require "gcloud/dns/project"
-
-module Gcloud
-  ##
-  # 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/gcloud-ruby/#/docs/guides/authentication).
-  #
-  # @param [String] project Identifier for a DNS project. If not present, the
-  #   default project for the credentials is used.
-  # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If file
-  #   path the file must be readable.
-  # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
-  #   set of resources and operations that the connection can access. See [Using
-  #   OAuth 2.0 to Access Google
-  #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-  #
-  #   The default scope is:
-  #
-  #   * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
-  # @param [Integer] retries Number of times to retry requests on server error.
-  #   The default value is `3`. Optional.
-  # @param [Integer] timeout Default timeout to use in requests. Optional.
-  #
-  # @return [Gcloud::Dns::Project]
-  #
-  # @example
-  #   require "gcloud"
-  #
-  #   dns = Gcloud.dns "my-dns-project",
-  #                    "/path/to/keyfile.json"
-  #
-  #   zone = dns.zone "example-com"
-  #
-  def self.dns project = nil, keyfile = nil, scope: nil, retries: nil,
-               timeout: nil
-    project ||= Gcloud::Dns::Project.default_project
-    project = project.to_s # Always cast to a string
-    fail ArgumentError, "project is missing" if project.empty?
-
-    if keyfile.nil?
-      credentials = Gcloud::Dns::Credentials.default scope: scope
-    else
-      credentials = Gcloud::Dns::Credentials.new keyfile, scope: scope
-    end
-
-    Gcloud::Dns::Project.new(
-      Gcloud::Dns::Service.new(
-        project, credentials, retries: retries, timeout: timeout))
-  end
-
-  ##
-  # # 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 gcloud-ruby is to provide an API that is comfortable
-  # to Rubyists. Authentication is handled by {Gcloud#dns}. You can provide the
-  # project and credential information to connect to the Cloud DNS service, or
-  # if you are running on Google Compute Engine this configuration is taken care
-  # of for you. You can read more about the options for connecting in the
-  # [Authentication
-  # Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).
-  #
-  # ## Creating Zones
-  #
-  # To get started with Google Cloud DNS, use your DNS Project to create a new
-  # Zone. The second argument to {Gcloud::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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 {Gcloud::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
-  # {Gcloud::Dns::Zone#add} results in a new Cloud DNS Change instance.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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
-  # gcloud-ruby 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 {Gcloud::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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # zone = dns.zone "example-com"
-  # records = zone.records "www", "A"
-  # records.first.name #=> "www.example.com."
-  # ```
-  #
-  # You can use {Gcloud::Dns::Zone#replace} to update the `ttl` and `data` for a
-  # record.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # zone = dns.zone "example-com"
-  # change = zone.replace "www", "A", 86400, ["5.6.7.8"]
-  # ```
-  #
-  # Or, you can use {Gcloud::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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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
-  # {Gcloud::Dns::Zone#update} with a block. See
-  # {Gcloud::Dns::Zone::Transaction}.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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
-  # {Gcloud::Dns::Zone#update}.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # zone = dns.zone "example-com"
-  # change = zone.import "path/to/db.example.com"
-  # ```
-  #
-  # You can also export to a zone file.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns
-  # 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # dns = gcloud.dns retries: 10, timeout: 120
-  # ```
-  #
-  module Dns
-  end
-end
+require "google/cloud/dns"

data/lib/gcloud/logging.rb

@@ -14,325 +14,4 @@
 
 
 require "gcloud"
-require "gcloud/logging/project"
-
-module Gcloud
-  ##
-  # Creates a new object for connecting to the Stackdriver Logging service.
-  # Each call creates a new connection.
-  #
-  # For more information on connecting to Google Cloud see the [Authentication
-  # Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).
-  #
-  # @param [String] project Project identifier for the Stackdriver Logging
-  #   service.
-  # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If file
-  #   path the file must be readable.
-  # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
-  #   set of resources and operations that the connection can access. See [Using
-  #   OAuth 2.0 to Access Google
-  #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-  #
-  #   The default scope is:
-  #
-  #   * `https://www.googleapis.com/auth/logging.admin`
-  # @param [Integer] retries Number of times to retry requests on server error.
-  #   The default value is `3`. Optional.
-  # @param [Integer] timeout Default timeout to use in requests. Optional.
-  #
-  # @return [Gcloud::Logging::Project]
-  #
-  # @example
-  #   require "gcloud/logging"
-  #
-  #   gcloud = Gcloud.new
-  #   logging = gcloud.logging
-  #   # ...
-  #
-  def self.logging project = nil, keyfile = nil, scope: nil, retries: nil,
-                   timeout: nil
-    project ||= Gcloud::Logging::Project.default_project
-    project = project.to_s # Always cast to a string
-    fail ArgumentError, "project is missing" if project.empty?
-
-    if keyfile.nil?
-      credentials = Gcloud::Logging::Credentials.default scope: scope
-    else
-      credentials = Gcloud::Logging::Credentials.new keyfile, scope: scope
-    end
-
-    Gcloud::Logging::Project.new(
-      Gcloud::Logging::Service.new(
-        project, credentials, retries: retries, timeout: timeout))
-  end
-
-  ##
-  # # Stackdriver Logging
-  #
-  # The Stackdriver Logging service collects and stores logs from applications
-  # and services on the Google Cloud Platform, giving you fine-grained,
-  # programmatic control over your projects' logs. You can use the Stackdriver
-  # Logging API to:
-  #
-  # * [Read and filter log entries](#listing-log-entries)
-  # * [Export your log entries](#exporting-log-entries) to Cloud Storage,
-  #   BigQuery, or Cloud Pub/Sub
-  # * [Create logs-based metrics](#creating-logs-based-metrics) for use in Cloud
-  #   Monitoring
-  # * [Write log entries](#writing-log-entries)
-  #
-  # For general information about Stackdriver Logging, read [Stackdriver Logging
-  # Documentation](https://cloud.google.com/logging/docs/).
-  #
-  # The goal of gcloud-ruby is to provide an API that is comfortable to
-  # Rubyists. Authentication is handled by {Gcloud#logging}. You can provide the
-  # project and credential information to connect to the Stackdriver Logging
-  # service, or if you are running on Google Compute Engine this configuration
-  # is taken care of for you. You can read more about the options for connecting
-  # in the [Authentication
-  # Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).
-  #
-  # ## Listing log entries
-  #
-  # Stackdriver Logging gathers log entries from many services, including Google
-  # App Engine and Google Compute Engine. (See the [List of Log
-  # Types](https://cloud.google.com/logging/docs/view/logs_index).) In addition,
-  # you can write your own log entries to the service.
-  #
-  # {Gcloud::Logging::Project#entries} returns the {Gcloud::Logging::Entry}
-  # records belonging to your project:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  # entries = logging.entries
-  # entries.each do |e|
-  #   puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
-  # end
-  # ```
-  #
-  # You can narrow the results to a single log using an [advanced logs
-  # filter](https://cloud.google.com/logging/docs/view/advanced_filters). A
-  # log is a named collection of entries. Logs can be produced by Google Cloud
-  # Platform services, by third-party services, or by your applications. For
-  # example, the log `compute.googleapis.com/activity_log` is produced by Google
-  # Compute Engine. Logs are simply referenced by name in gcloud-ruby. There is
-  # no `Log` type in gcloud-ruby or `Log` resource in the Stackdriver Logging
-  # API.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  # entries = logging.entries filter: "log:syslog"
-  # entries.each do |e|
-  #   puts "[#{e.timestamp}] #{e.payload.inspect}"
-  # end
-  # ```
-  #
-  # You can also order the log entries by `timestamp`.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  # entries = logging.entries order: "timestamp desc"
-  # entries.each do |e|
-  #   puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
-  # end
-  # ```
-  #
-  # ## Exporting log entries
-  #
-  # Stackdriver Logging lets you export log entries to destinations including
-  # Google Cloud Storage buckets (for long term log storage), Google BigQuery
-  # datasets (for log analysis), and Google Pub/Sub (for streaming to other
-  # applications).
-  #
-  # ### Creating sinks
-  #
-  # A {Gcloud::Logging::Sink} is an object that lets you to specify a set of log
-  # entries to export.
-  #
-  # In addition to the name of the sink and the export destination,
-  # {Gcloud::Logging::Project#create_sink} accepts an [advanced
-  # logs filter](https://cloud.google.com/logging/docs/view/advanced_filters) to
-  # narrow the collection.
-  #
-  # Before creating the sink, ensure that you have granted
-  # `cloud-logs@google.com` permission to write logs to the destination. See
-  # [Permissions for writing exported
-  # logs](https://cloud.google.com/logging/docs/export/configure_export#setting_product_name_short_permissions_for_writing_exported_logs).
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  # storage = gcloud.storage
-  #
-  # bucket = storage.create_bucket "my-logs-bucket"
-  #
-  # # Grant owner permission to Stackdriver Logging service
-  # email = "cloud-logs@google.com"
-  # bucket.acl.add_owner "group-#{email}"
-  #
-  # sink = logging.create_sink "my-sink", "storage.googleapis.com/#{bucket.id}"
-  # ```
-  #
-  # When you create a sink, only new log entries are exported. Stackdriver
-  # Logging does not send previously-ingested log entries to the sink's
-  # destination.
-  #
-  # ### Listing sinks
-  #
-  # You can also list the sinks belonging to your project with
-  # {Gcloud::Logging::Project#sinks}.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  # sinks = logging.sinks
-  # sinks.each do |s|
-  #   puts "#{s.name}: #{s.filter} -> #{s.destination}"
-  # end
-  # ```
-  #
-  # ## Creating logs-based metrics
-  #
-  # You can use log entries in your project as the basis for [Google Cloud
-  # Monitoring](https://cloud.google.com/monitoring/docs) metrics. These metrics
-  # can then be used to produce Cloud Monitoring reports and alerts.
-  #
-  # ### Creating metrics
-  #
-  # A metric is a measured value that can be used to assess a system. Use
-  # {Gcloud::Logging::Project#create_metric} to configure a
-  # {Gcloud::Logging::Metric} based on a collection of log entries matching an
-  # [advanced
-  # logs filter](https://cloud.google.com/logging/docs/view/advanced_filters).
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  # metric = logging.create_metric "errors", "severity>=ERROR"
-  # ```
-  #
-  # ### Listing metrics
-  #
-  # You can also list the metrics belonging to your project with
-  # {Gcloud::Logging::Project#metrics}.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  # metrics = logging.metrics
-  # metrics.each do |m|
-  #   puts "#{m.name}: #{m.filter}"
-  # end
-  # ```
-  #
-  # ## Writing log entries
-  #
-  # An {Gcloud::Logging::Entry} is composed of metadata and a payload. The
-  # payload is traditionally a message string, but in Stackdriver Logging it can
-  # also be a JSON or protocol buffer object. A single log can have entries with
-  # different payload types. In addition to the payload, your argument(s) to
-  # {Gcloud::Logging::Project#write_entries} must also contain a log name and a
-  # resource.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  #
-  # entry = logging.entry
-  # entry.payload = "Job started."
-  # entry.log_name = "my_app_log"
-  # entry.resource.type = "gae_app"
-  # entry.resource.labels[:module_id] = "1"
-  # entry.resource.labels[:version_id] = "20150925t173233"
-  #
-  # logging.write_entries entry
-  # ```
-  #
-  # If you write a collection of log entries, you can provide the log name,
-  # resource, and/or labels hash to be used for all of the entries, and omit
-  # these values from the individual entries.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  #
-  # entry1 = logging.entry
-  # entry1.payload = "Job started."
-  # entry2 = logging.entry
-  # entry2.payload = "Job completed."
-  # labels = { job_size: "large", job_code: "red" }
-  #
-  # resource = logging.resource "gae_app",
-  #                             "module_id" => "1",
-  #                             "version_id" => "20150925t173233"
-  #
-  # logging.write_entries [entry1, entry2],
-  #                       log_name: "my_app_log",
-  #                       resource: resource,
-  #                       labels: labels
-  # ```
-  #
-  # ### Creating a Ruby Logger implementation
-  #
-  # If your environment requires a logger instance that is API-compatible with
-  # Ruby's standard library
-  # [Logger](http://ruby-doc.org/stdlib/libdoc/logger/rdoc), you can use
-  # {Gcloud::Logging::Project#logger} to create one.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging
-  #
-  # resource = logging.resource "gae_app",
-  #                             module_id: "1",
-  #                             version_id: "20150925t173233"
-  #
-  # logger = logging.logger "my_app_log", resource, env: :production
-  # logger.info "Job started."
-  # ```
-  #
-  # ## 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 "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # logging = gcloud.logging retries: 10, timeout: 120
-  # ```
-  #
-  module Logging
-  end
-end
+require "google/cloud/logging"