gcloud 0.12.2 → 0.20.0

data/lib/gcloud/dns/zone/list.rb

@@ -1,168 +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.
-
-
-require "delegate"
-
-module Gcloud
-  module Dns
-    class Zone
-      ##
-      # Zone::List is a special case Array with additional values.
-      class List < DelegateClass(::Array)
-        ##
-        # If not empty, indicates that there are more zones that match
-        # the request and this value should be passed to continue.
-        attr_accessor :token
-
-        ##
-        # @private Create a new Zone::List with an array of Zone instances.
-        def initialize arr = []
-          super arr
-        end
-
-        ##
-        # Whether there a next page of zones.
-        #
-        # @return [Boolean]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #
-        #   zones = dns.zones
-        #   if zones.next?
-        #     next_zones = zones.next
-        #   end
-        #
-        def next?
-          !token.nil?
-        end
-
-        ##
-        # Retrieve the next page of zones.
-        #
-        # @return [Zone::List]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #
-        #   zones = dns.zones
-        #   if zones.next?
-        #     next_zones = zones.next
-        #   end
-        #
-        def next
-          return nil unless next?
-          ensure_service!
-          gapi = @service.list_zones token: token, max: @max
-          Zone::List.from_gapi gapi, @service, @max
-        end
-
-        ##
-        # Retrieves all zones by repeatedly loading {#next} until {#next?}
-        # returns `false`. Calls the given block once for each zone, which is
-        # passed as the parameter.
-        #
-        # An Enumerator is returned if no block is given.
-        #
-        # This method may make several API calls until all zones are retrieved.
-        # Be sure to use as narrow a search criteria as possible. Please use
-        # with caution.
-        #
-        # @param [Integer] request_limit The upper limit of API requests to make
-        #   to load all zones. Default is no limit.
-        # @yield [zone] The block for accessing each zone.
-        # @yieldparam [Zone] zone The zone object.
-        #
-        # @return [Enumerator]
-        #
-        # @example Iterating each zone by passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zones = dns.zones
-        #
-        #   zones.all do |zone|
-        #     puts zone.name
-        #   end
-        #
-        # @example Using the enumerator by not passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zones = dns.zones
-        #
-        #   all_names = zones.all.map do |zone|
-        #     zone.name
-        #   end
-        #
-        # @example Limit the number of API calls made:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zones = dns.zones
-        #
-        #   zones.all(request_limit: 10) do |zone|
-        #     puts zone.name
-        #   end
-        #
-        def all request_limit: nil
-          request_limit = request_limit.to_i if request_limit
-          unless block_given?
-            return enum_for(:all, request_limit: request_limit)
-          end
-          results = self
-          loop do
-            results.each { |r| yield r }
-            if request_limit
-              request_limit -= 1
-              break if request_limit < 0
-            end
-            break unless results.next?
-            results = results.next
-          end
-        end
-
-        ##
-        # @private New Zones::List from a ListManagedZonesResponse object.
-        def self.from_gapi gapi, conn, max = nil
-          zones = new(Array(gapi.managed_zones).map do |g|
-            Zone.from_gapi g, conn
-          end)
-          zones.instance_variable_set "@token",   gapi.next_page_token
-          zones.instance_variable_set "@service", conn
-          zones.instance_variable_set "@max",     max
-          zones
-        end
-
-        protected
-
-        ##
-        # Raise an error unless an active connection is available.
-        def ensure_service!
-          fail "Must have active connection" unless @service
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/dns/zone/transaction.rb

@@ -1,176 +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 Dns
-    class Zone
-      ##
-      # # DNS Zone Transaction
-      #
-      # This object is used by {Zone#update} when passed a block. These methods
-      # are used to update the records that are sent to the Google Cloud DNS
-      # API.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   dns = gcloud.dns
-      #   zone = dns.zone "example-com"
-      #   zone.update do |tx|
-      #     tx.add     "example.com.", "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 |cname|
-      #       cname.ttl = 86400 # only change the TTL
-      #     end
-      #   end
-      #
-      class Transaction
-        # @private
-        attr_reader :additions, :deletions
-
-        ##
-        # @private Creates a new transaction.
-        def initialize zone
-          @zone = zone
-          @additions = []
-          @deletions = []
-        end
-
-        ##
-        # Adds a record to the Zone.
-        #
-        # @param [String] name The owner of the record. For example:
-        #   `example.com.`.
-        # @param [String] type The identifier of a [supported record
-        #   type](https://cloud.google.com/dns/what-is-cloud-dns).
-        #   For example: `A`, `AAAA`, `CNAME`, `MX`, or `TXT`.
-        # @param [Integer] ttl The number of seconds that the record can be
-        #   cached by resolvers.
-        # @param [String, Array<String>] data The resource record data, as
-        #   determined by `type` and defined in
-        #   [RFC 1035 (section 5)](http://tools.ietf.org/html/rfc1035#section-5)
-        #   and [RFC 1034 (section
-        #   3.6.1)](http://tools.ietf.org/html/rfc1034#section-3.6.1). For
-        #   example: `192.0.2.1` or `example.com.`.
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #   zone.update do |tx|
-        #     tx.add     "example.com.", "A",  86400, "1.2.3.4"
-        #   end
-        #
-        def add name, type, ttl, data
-          @additions += Array(@zone.record(name, type, ttl, data))
-        end
-
-        ##
-        # Removes records from the Zone. The records are looked up before they
-        # are removed.
-        #
-        # @param [String] name The owner of the record. For example:
-        #   `example.com.`.
-        # @param [String] type The identifier of a [supported record
-        #   type](https://cloud.google.com/dns/what-is-cloud-dns).
-        #   For example: `A`, `AAAA`, `CNAME`, `MX`, or `TXT`.
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #   zone.update do |tx|
-        #     tx.remove  "example.com.", "TXT"
-        #   end
-        #
-        def remove name, type
-          @deletions += @zone.records(name, type).all.to_a
-        end
-
-        ##
-        # Replaces existing records on the Zone. Records matching the `name` and
-        # `type` are replaced.
-        #
-        # @param [String] name The owner of the record. For example:
-        #   `example.com.`.
-        # @param [String] type The identifier of a [supported record
-        #   type](https://cloud.google.com/dns/what-is-cloud-dns).
-        #   For example: `A`, `AAAA`, `CNAME`, `MX`, or `TXT`.
-        # @param [Integer] ttl The number of seconds that the record can be
-        #   cached by resolvers.
-        # @param [String, Array<String>] data The resource record data, as
-        #   determined by `type` and defined in
-        #   [RFC 1035 (section 5)](http://tools.ietf.org/html/rfc1035#section-5)
-        #   and [RFC 1034 (section
-        #   3.6.1)](http://tools.ietf.org/html/rfc1034#section-3.6.1). For
-        #   example: `192.0.2.1` or `example.com.`.
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #   zone.update do |tx|
-        #     tx.replace "example.com.", "MX", 86400, ["10 mail1.example.com.",
-        #                                              "20 mail2.example.com."]
-        #   end
-        #
-        def replace name, type, ttl, data
-          remove name, type
-          add name, type, ttl, data
-        end
-
-        ##
-        # Modifies records on the Zone. Records matching the `name` and `type`
-        # are yielded to the block where they can be modified.
-        #
-        # @param [String] name The owner of the record. For example:
-        #   `example.com.`.
-        # @param [String] type The identifier of a [supported record
-        #   type](https://cloud.google.com/dns/what-is-cloud-dns).
-        #   For example: `A`, `AAAA`, `CNAME`, `MX`, or `TXT`.
-        # @yield [record] a block yielding each matching record
-        # @yieldparam [Record] record the record to be modified
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone.update do |tx|
-        #     tx.modify "www.example.com.", "CNAME" do |cname|
-        #       cname.ttl = 86400 # only change the TTL
-        #     end
-        #   end
-        #
-        def modify name, type
-          existing = @zone.records(name, type).all.to_a
-          updated = existing.map(&:dup)
-          updated.each { |r| yield r }
-          @additions += updated
-          @deletions += existing
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/errors.rb

@@ -1,206 +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
-  ##
-  # Base gcloud-ruby exception class.
-  class Error < StandardError
-    # @private Create a new error object from a client error
-    def self.from_error error
-      klass = if error.respond_to? :code
-                grpc_error_class_for error.code
-              elsif error.respond_to? :status_code
-                gapi_error_class_for error.status_code
-              else
-                self
-              end
-      klass.new error.message
-    end
-
-    # @private Identify the subclass for a gRPC error
-    def self.grpc_error_class_for grpc_error_code
-      # The gRPC status code 0 is for a successful response.
-      # So there is no error subclass for a 0 status code, use current class.
-      [self, CanceledError, UnknownError, InvalidArgumentError,
-       DeadlineExceededError, NotFoundError, AlreadyExistsError,
-       PermissionDeniedError, ResourceExhaustedError, FailedPreconditionError,
-       AbortedError, OutOfRangeError, UnimplementedError, InternalError,
-       UnavailableError, DataLossError, UnauthenticatedError
-      ][grpc_error_code] || self
-    end
-
-    # @private Identify the subclass for a Google API Client error
-    def self.gapi_error_class_for http_status_code
-      # The http status codes mapped to their error classes.
-      { 400 => InvalidArgumentError, # FailedPreconditionError/OutOfRangeError
-        401 => UnauthenticatedError,
-        403 => PermissionDeniedError,
-        404 => NotFoundError,
-        409 => AlreadyExistsError, # AbortedError
-        429 => ResourceExhaustedError,
-        499 => CanceledError,
-        500 => InternalError, # UnknownError/DataLossError
-        501 => UnimplementedError,
-        503 => UnavailableError,
-        504 => DeadlineExceededError
-      }[http_status_code] || self
-    end
-  end
-
-  ##
-  # Canceled indicates the operation was cancelled (typically by the caller).
-  class CanceledError < Error
-  end
-
-  ##
-  # Unknown error.  An example of where this error may be returned is
-  # if a Status value received from another address space belongs to
-  # an error-space that is not known in this address space.  Also
-  # errors raised by APIs that do not return enough error information
-  # may be converted to this error.
-  class UnknownError < Error
-  end
-
-  ##
-  # InvalidArgument indicates client specified an invalid argument.
-  # Note that this differs from FailedPrecondition. It indicates arguments
-  # that are problematic regardless of the state of the system
-  # (e.g., a malformed file name).
-  class InvalidArgumentError < Error
-  end
-
-  ##
-  # DeadlineExceeded means operation expired before completion.
-  # For operations that change the state of the system, this error may be
-  # returned even if the operation has completed successfully. For
-  # example, a successful response from a server could have been delayed
-  # long enough for the deadline to expire.
-  class DeadlineExceededError < Error
-  end
-
-  ##
-  # NotFound means some requested entity (e.g., file or directory) was
-  # not found.
-  class NotFoundError < Error
-  end
-
-  ##
-  # AlreadyExists means an attempt to create an entity failed because one
-  # already exists.
-  class AlreadyExistsError < Error
-  end
-
-  ##
-  # PermissionDenied indicates the caller does not have permission to
-  # execute the specified operation. It must not be used for rejections
-  # caused by exhausting some resource (use ResourceExhausted
-  # instead for those errors).  It must not be
-  # used if the caller cannot be identified (use Unauthenticated
-  # instead for those errors).
-  class PermissionDeniedError < Error
-  end
-
-  ##
-  # Unauthenticated indicates the request does not have valid
-  # authentication credentials for the operation.
-  class UnauthenticatedError < Error
-  end
-
-  ##
-  # ResourceExhausted indicates some resource has been exhausted, perhaps
-  # a per-user quota, or perhaps the entire file system is out of space.
-  class ResourceExhaustedError < Error
-  end
-
-  ##
-  # FailedPrecondition indicates operation was rejected because the
-  # system is not in a state required for the operation's execution.
-  # For example, directory to be deleted may be non-empty, an rmdir
-  # operation is applied to a non-directory, etc.
-  #
-  # A litmus test that may help a service implementor in deciding
-  # between FailedPrecondition, Aborted, and Unavailable:
-  #  (a) Use Unavailable if the client can retry just the failing call.
-  #  (b) Use Aborted if the client should retry at a higher-level
-  #      (e.g., restarting a read-modify-write sequence).
-  #  (c) Use FailedPrecondition if the client should not retry until
-  #      the system state has been explicitly fixed.  E.g., if an "rmdir"
-  #      fails because the directory is non-empty, FailedPrecondition
-  #      should be returned since the client should not retry unless
-  #      they have first fixed up the directory by deleting files from it.
-  #  (d) Use FailedPrecondition if the client performs conditional
-  #      REST Get/Update/Delete on a resource and the resource on the
-  #      server does not match the condition. E.g., conflicting
-  #      read-modify-write on the same resource.
-  class FailedPreconditionError < Error
-  end
-
-  ##
-  # Aborted indicates the operation was aborted, typically due to a
-  # concurrency issue like sequencer check failures, transaction aborts,
-  # etc.
-  #
-  # See litmus test above for deciding between FailedPrecondition,
-  # Aborted, and Unavailable.
-  class AbortedError < Error
-  end
-
-  ##
-  # OutOfRange means operation was attempted past the valid range.
-  # E.g., seeking or reading past end of file.
-  #
-  # Unlike InvalidArgument, this error indicates a problem that may
-  # be fixed if the system state changes. For example, a 32-bit file
-  # system will generate InvalidArgument if asked to read at an
-  # offset that is not in the range [0,2^32-1], but it will generate
-  # OutOfRange if asked to read from an offset past the current
-  # file size.
-  #
-  # There is a fair bit of overlap between FailedPrecondition and
-  # OutOfRange.  We recommend using OutOfRange (the more specific
-  # error) when it applies so that callers who are iterating through
-  # a space can easily look for an OutOfRange error to detect when
-  # they are done.
-  class OutOfRangeError < Error
-  end
-
-  ##
-  # Unimplemented indicates operation is not implemented or not
-  # supported/enabled in this service.
-  class UnimplementedError < Error
-  end
-
-  ##
-  # Internal errors.  Means some invariants expected by underlying
-  # system has been broken.  If you see one of these errors,
-  # something is very broken.
-  class InternalError < Error
-  end
-
-  ##
-  # Unavailable indicates the service is currently unavailable.
-  # This is a most likely a transient condition and may be corrected
-  # by retrying with a backoff.
-  #
-  # See litmus test above for deciding between FailedPrecondition,
-  # Aborted, and Unavailable.
-  class UnavailableError < Error
-  end
-
-  ##
-  # DataLoss indicates unrecoverable data loss or corruption.
-  class DataLossError < Error
-  end
-end