gcloud 0.12.2 → 0.20.0

data/OVERVIEW.md

@@ -1,259 +0,0 @@
-# Getting started
-
-The gcloud-ruby library is installable through rubygems:
-
-```sh
-$ gem install gcloud
-```
-
-The gcloud-ruby library aims to make authentication as simple as possible. Google Cloud requires a **Project ID** and **Service Account Credentials** to connect to the APIs. You can learn more about various options for connection on the [Authentication Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).
-
-# BigQuery
-
-[Google Cloud BigQuery](https://cloud.google.com/bigquery/) ([docs](https://cloud.google.com/bigquery/docs)) enables super-fast, SQL-like queries against append-only tables, using the processing power of Google's infrastructure. Simply move your data into BigQuery and let it handle the hard work. You can control access to both the project and your data based on your business needs, such as giving others the ability to view or query your data.
-
-See the {Gcloud::Bigquery gcloud-ruby BigQuery API documentation} to learn how to connect to Cloud BigQuery using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-bigquery = gcloud.bigquery
-
-# Create a new table to archive todos
-dataset = bigquery.dataset "my-todo-archive"
-table = dataset.create_table "todos",
-          name: "Todos Archive",
-          description: "Archive for completed TODO records"
-
-# Load data into the table
-file = File.open "/archive/todos/completed-todos.csv"
-load_job = table.load file
-
-# Run a query for the number of completed todos by owner
-count_sql = "SELECT owner, COUNT(*) AS complete_count FROM todos GROUP BY owner"
-data = bigquery.query count_sql
-data.each do |row|
-  puts row["name"]
-end
-```
-
-# Datastore
-
-[Google Cloud Datastore](https://cloud.google.com/datastore/) ([docs](https://cloud.google.com/datastore/docs)) is a fully managed, schemaless database for storing non-relational data. Cloud Datastore automatically scales with your users and supports ACID transactions, high availability of reads and writes, strong consistency for reads and ancestor queries, and eventual consistency for all other queries.
-
-Follow the [activation instructions](https://cloud.google.com/datastore/docs/activate) to use the Google Cloud Datastore API with your project.
-
-See the {Gcloud::Bigquery gcloud-ruby Datastore API documentation} to learn how to interact with the Cloud Datastore using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-datastore = gcloud.datastore
-
-# Create a new task to demo datastore
-task = datastore.entity "Task", "sampleTask" do |t|
-  t["type"] = "Personal"
-  t["done"] = false
-  t["priority"] = 4
-  t["description"] = "Learn Cloud Datastore"
-end
-
-# Save the new task
-datastore.save task
-
-# Run a query for all completed tasks
-query = datastore.query("Task").
-  where("done", "=", false)
-tasks = datastore.run query
-```
-
-# 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).
-
-See the {Gcloud::Dns gcloud-ruby DNS API documentation} to learn how to connect to Cloud DNS using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-dns = gcloud.dns
-
-# 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
-
-```
-
-# Logging
-
-[Stackdriver Logging](https://cloud.google.com/logging/) collects and stores logs from applications and services on the Google Cloud Platform, giving you fine-grained, programmatic control over your projects' logs. With this API you can do the following:
-
-* Read and filter log entries
-* Export your log entries to Cloud Storage,
-  BigQuery, or Cloud Pub/Sub
-* Create logs-based metrics for use in Cloud
-  Monitoring
-* Write log entries
-
-See the {Gcloud::Logging gcloud-ruby Logging API documentation} to learn how to connect to Cloud Loging using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-logging = gcloud.logging
-
-# List all log entries
-logging.entries.each do |e|
-  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
-end
-
-# List only entries from a single log
-entries = logging.entries filter: "log:syslog"
-
-# Write a log entry
-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
-```
-
-# Pub/Sub
-
-[Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) ([docs](https://cloud.google.com/pubsub/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.
-
-See the {Gcloud::Pubsub gcloud-ruby Pub/Sub API documentation} to learn how to connect to Cloud Pub/Sub using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-pubsub = gcloud.pubsub
-
-# Retrieve a topic
-topic = pubsub.topic "my-topic"
-
-# Publish a new message
-msg = topic.publish "new-message"
-
-# Retrieve a subscription
-sub = pubsub.subscription "my-topic-sub"
-
-# Pull available messages
-msgs = sub.pull
-```
-
-# Resource Manager
-
-[Google Cloud Resource Manager](https://cloud.google.com/resource-manager/) ([docs](https://cloud.google.com/resource-manager/reference/rest/)) provides methods that you can use to programmatically manage your projects in the Google Cloud Platform. You may be familiar with managing projects in the [Developers Console](https://developers.google.com/console/help/new/). With this API you can do the following:
-
-* Get a list of all projects associated with an account
-* Create new projects
-* Update existing projects
-* Delete projects
-* Undelete, or recover, projects that you don't want to delete
-
-See the {Gcloud::ResourceManager gcloud-ruby Resource Manager API documentation} to learn how to connect to Cloud Resource Manager using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-resource_manager = gcloud.resource_manager
-
-# List all projects
-resource_manager.projects.each do |project|
-  puts projects.project_id
-end
-
-# Label a project as production
-project = resource_manager.project "tokyo-rain-123"
-project.update do |p|
-  p.labels["env"] = "production"
-end
-
-# List only projects with the "production" label
-projects = resource_manager.projects filter: "labels.env:production"
-```
-
-# Storage
-
-[Google Cloud Storage](https://cloud.google.com/storage/) ([docs](https://cloud.google.com/storage/docs/json_api/)) allows you to store data on Google infrastructure with very high reliability, performance and availability, and can be used to distribute large data objects to users via direct download.
-
-See the {Gcloud::Storage gcloud-ruby Storage API documentation} to learn how to connect to Cloud Storage using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-storage = gcloud.storage
-
-bucket = storage.bucket "task-attachments"
-
-file = bucket.file "path/to/my-file.ext"
-
-# Download the file to the local file system
-file.download "/tasks/attachments/#{file.name}"
-
-# Copy the file to a backup bucket
-backup = storage.bucket "task-attachment-backups"
-file.copy backup, file.name
-```
-
-# Translate
-
-[Google Translate](https://cloud.google.com/translate/) ([docs](https://cloud.google.com/translate/docs)) provides a simple, programmatic interface for translating an arbitrary string into any supported language. It is highly responsive, so websites and applications can integrate with Translate API for fast, dynamic translation of source text. Language detection is also available in cases where the source language is unknown.
-
-See the {Gcloud::Translate gcloud-ruby Translate API documentation} to learn how to connect to Google Translate using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-translate = gcloud.translate
-
-translation = translate.translate "Hello world!", to: "la"
-
-puts translation #=> Salve mundi!
-
-translation.from #=> "en"
-translation.origin #=> "Hello world!"
-translation.to #=> "la"
-translation.text #=> "Salve mundi!"
-```
-
-# Vision
-
-[Google Cloud Vision](https://cloud.google.com/vision/) ([docs](https://cloud.google.com/vision/docs)) allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
-
-See the {Gcloud::Vision gcloud-ruby Cloud Vision API documentation} to learn how to connect to Google Cloud Vision using this library.
-
-```ruby
-require "gcloud"
-
-gcloud = Gcloud.new
-vision = gcloud.vision
-
-image = vision.image "path/to/landmark.jpg"
-
-landmark = image.landmark
-landmark.description #=> "Mount Rushmore"
-```
-

data/lib/gcloud/backoff.rb

@@ -1,150 +0,0 @@
-# Copyright 2014 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.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Gcloud
-  ##
-  # @private
-  # Backoff allows users to control how Google API calls are retried.
-  # If an API call fails the response will be checked to see if the
-  # call can be retried. If the response matches the criteria, then it
-  # will be retried with an incremental backoff. This means that an
-  # increasing delay will be added between each retried call. The first
-  # retry will be delayed one second, the second retry will be delayed
-  # two seconds, and so on.
-  #
-  # @example
-  #   require "gcloud/backoff"
-  #
-  #   Gcloud::Backoff.retries = 5 # Set a maximum of five retries per call
-  #
-  class Backoff
-    class << self
-      ##
-      # The number of times a retriable API call should be retried.
-      #
-      # The default value is `3`.
-      attr_reader :retries
-      def retries= new_retries
-        @retries = new_retries
-      end
-
-      ##
-      # The GRPC Status Codes that should be retried.
-      #
-      # The default values are `14`.
-      attr_accessor :grpc_codes
-
-      ##
-      # The HTTP Status Codes that should be retried.
-      #
-      # The default values are `500` and `503`.
-      attr_accessor :http_codes
-
-      ##
-      # The Google API error reasons that should be retried.
-      #
-      # The default values are `rateLimitExceeded` and
-      # `userRateLimitExceeded`.
-      attr_accessor :reasons
-
-      ##
-      # The code to run when a backoff is handled.
-      # This must be a Proc and must take the number of
-      # retries as an argument.
-      #
-      # Note: This method is undocumented and may change.
-      attr_accessor :backoff # :nodoc:
-    end
-    # Set the default values
-    self.retries = 3
-    self.grpc_codes = [14]
-    self.http_codes = [500, 503]
-    self.reasons = %w(rateLimitExceeded userRateLimitExceeded)
-    self.backoff = ->(retries) { sleep retries.to_i }
-
-    ##
-    # @private
-    # Creates a new Backoff object to catch common errors when calling
-    # the Google API and handle the error by retrying the call.
-    #
-    #   Gcloud::Backoff.new(options).execute_gapi do
-    #     client.execute api_method: service.things.insert,
-    #                    parameters: { thing: @thing },
-    #                    body_object: { name: thing_name }
-    #   end
-    def initialize options = {}
-      @retries    = (options[:retries]    || Backoff.retries).to_i
-      @grpc_codes = (options[:grpc_codes] || Backoff.grpc_codes).to_a
-      @http_codes = (options[:http_codes] || Backoff.http_codes).to_a
-      @reasons    = (options[:reasons]    || Backoff.reasons).to_a
-      @backoff    =  options[:backoff]    || Backoff.backoff
-    end
-
-    # @private
-    def execute_gapi
-      current_retries = 0
-      loop do
-        result = yield
-        return result unless result.is_a? Google::APIClient::Result
-        break result if result.success? || !retry?(result, current_retries)
-        current_retries += 1
-        @backoff.call current_retries
-      end
-    end
-
-    # @private
-    def execute_grpc
-      current_retries = 0
-      loop do
-        begin
-          return yield
-        rescue GRPC::BadStatus => e
-          raise e unless @grpc_codes.include?(e.code) &&
-                         (current_retries < @retries)
-          current_retries += 1
-          @backoff.call current_retries
-        end
-      end
-    end
-
-    protected
-
-    # @private
-    def retry? result, current_retries #:nodoc:
-      if current_retries < @retries
-        return true if retry_http_code? result
-        return true if retry_error_reason? result
-      end
-      false
-    end
-
-    # @private
-    def retry_http_code? result #:nodoc:
-      @http_codes.include? result.response.status
-    end
-
-    # @private
-    def retry_error_reason? result
-      if result.data &&
-         result.data["error"] &&
-         result.data["error"]["errors"]
-        Array(result.data["error"]["errors"]).each do |error|
-          return true if error["reason"] && @reasons.include?(error["reason"])
-        end
-      end
-      false
-    end
-  end
-end

data/lib/gcloud/bigquery/copy_job.rb

@@ -1,97 +0,0 @@
-# Copyright 2015 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.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Gcloud
-  module Bigquery
-    ##
-    # # CopyJob
-    #
-    # A {Job} subclass representing a copy operation that may be performed on a
-    # {Table}. A CopyJob instance is created when you call {Table#copy}.
-    #
-    # @see https://cloud.google.com/bigquery/docs/tables#copyingtable Copying an
-    #   Existing Table
-    # @see https://cloud.google.com/bigquery/docs/reference/v2/jobs Jobs API
-    #   reference
-    #
-    class CopyJob < Job
-      ##
-      # The table from which data is copied. This is the table on
-      # which {Table#copy} was called. Returns a {Table} instance.
-      def source
-        table = @gapi.configuration.copy.source_table
-        return nil unless table
-        retrieve_table table.project_id,
-                       table.dataset_id,
-                       table.table_id
-      end
-
-      ##
-      # The table to which data is copied. Returns a {Table} instance.
-      def destination
-        table = @gapi.configuration.copy.destination_table
-        return nil unless table
-        retrieve_table table.project_id,
-                       table.dataset_id,
-                       table.table_id
-      end
-
-      ##
-      # Checks if the create disposition for the job is `CREATE_IF_NEEDED`,
-      # which provides the following behavior: If the table does not exist,
-      # the copy operation creates the table. This is the default.
-      def create_if_needed?
-        disp = @gapi.configuration.copy.create_disposition
-        disp == "CREATE_IF_NEEDED"
-      end
-
-      ##
-      # Checks if the create disposition for the job is `CREATE_NEVER`, which
-      # provides the following behavior: The table must already exist; if it
-      # does not, an error is returned in the job result.
-      def create_never?
-        disp = @gapi.configuration.copy.create_disposition
-        disp == "CREATE_NEVER"
-      end
-
-      ##
-      # Checks if the write disposition for the job is `WRITE_TRUNCATE`, which
-      # provides the following behavior: If the table already exists, the copy
-      # operation overwrites the table data.
-      def write_truncate?
-        disp = @gapi.configuration.copy.write_disposition
-        disp == "WRITE_TRUNCATE"
-      end
-
-      ##
-      # Checks if the write disposition for the job is `WRITE_APPEND`, which
-      # provides the following behavior: If the table already exists, the copy
-      # operation appends the data to the table.
-      def write_append?
-        disp = @gapi.configuration.copy.write_disposition
-        disp == "WRITE_APPEND"
-      end
-
-      ##
-      # Checks if the write disposition for the job is `WRITE_EMPTY`, which
-      # provides the following behavior: If the table already exists and
-      # contains data, the job will have an error. This is the default.
-      def write_empty?
-        disp = @gapi.configuration.copy.write_disposition
-        disp == "WRITE_EMPTY"
-      end
-    end
-  end
-end