gcloud 0.12.2 → 0.20.0

data/lib/gcloud/dns/project.rb

@@ -1,247 +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 "gcloud/errors"
-require "gcloud/gce"
-require "gcloud/dns/service"
-require "gcloud/dns/credentials"
-require "gcloud/dns/zone"
-
-module Gcloud
-  module Dns
-    ##
-    # # Project
-    #
-    # The project is a top level container for resources including Cloud DNS
-    # ManagedZones. Projects can be created only in the [Google Developers
-    # Console](https://console.developers.google.com).
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   dns = gcloud.dns
-    #   zone = dns.zone "example-com"
-    #   zone.records.each do |record|
-    #     puts record.name
-    #   end
-    #
-    # See {Gcloud#dns}
-    class Project
-      ##
-      # @private The Service object.
-      attr_accessor :service
-
-      ##
-      # @private The Google API Client object.
-      attr_accessor :gapi
-
-      ##
-      # @private Creates a new Service instance.
-      #
-      # See {Gcloud.dns}
-      def initialize service
-        @service = service
-        @gapi = nil
-      end
-
-      ##
-      # The unique ID string for the current project.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new "my-todo-project", "/path/to/keyfile.json"
-      #   dns = gcloud.dns
-      #
-      #   dns.project #=> "my-todo-project"
-      #
-      def project
-        service.project
-      end
-      alias_method :id, :project
-
-      ##
-      # The project number.
-      def number
-        reload! if @gapi.nil?
-        @gapi.number
-      end
-
-      ##
-      # Maximum allowed number of zones in the project.
-      def zones_quota
-        reload! if @gapi.nil?
-        @gapi.quota.managed_zones if @gapi.quota
-      end
-
-      ##
-      # Maximum allowed number of data entries per record.
-      def data_per_record
-        reload! if @gapi.nil?
-        @gapi.quota.resource_records_per_rrset if @gapi.quota
-      end
-
-      ##
-      # Maximum allowed number of records to add per change.
-      def additions_per_change
-        reload! if @gapi.nil?
-        @gapi.quota.rrset_additions_per_change if @gapi.quota
-      end
-
-      ##
-      # Maximum allowed number of records to delete per change.
-      def deletions_per_change
-        reload! if @gapi.nil?
-        @gapi.quota.rrset_deletions_per_change if @gapi.quota
-      end
-
-      ##
-      # Maximum allowed number of records per zone in the project.
-      def records_per_zone
-        reload! if @gapi.nil?
-        @gapi.quota.rrsets_per_managed_zone if @gapi.quota
-      end
-
-      ##
-      # Maximum allowed total bytes size for all the data in one change.
-      def total_data_per_change
-        reload! if @gapi.nil?
-        @gapi.quota.total_rrdata_size_per_change if @gapi.quota
-      end
-
-      ##
-      # @private Default project.
-      def self.default_project
-        ENV["DNS_PROJECT"] ||
-          ENV["GCLOUD_PROJECT"] ||
-          ENV["GOOGLE_CLOUD_PROJECT"] ||
-          Gcloud::GCE.project_id
-      end
-
-      ##
-      # Retrieves an existing zone by name or id.
-      #
-      # @param [String, Integer] zone_id The name or id of a zone.
-      #
-      # @return [Gcloud::Dns::Zone, nil] Returns `nil` if the zone does not
-      #   exist.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   dns = gcloud.dns
-      #   zone = dns.zone "example-com"
-      #   puts zone.name
-      #
-      def zone zone_id
-        ensure_service!
-        gapi = service.get_zone zone_id
-        Zone.from_gapi gapi, service
-      rescue Gcloud::NotFoundError
-        nil
-      end
-      alias_method :find_zone, :zone
-      alias_method :get_zone, :zone
-
-      ##
-      # Retrieves the list of zones belonging to the project.
-      #
-      # @param [String] token A previously-returned page token representing part
-      #   of the larger set of results to view.
-      # @param [Integer] max Maximum number of zones to return.
-      #
-      # @return [Array<Gcloud::Dns::Zone>] (See {Gcloud::Dns::Zone::List})
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   dns = gcloud.dns
-      #   zones = dns.zones
-      #   zones.each do |zone|
-      #     puts zone.name
-      #   end
-      #
-      # @example Retrieve all zones: (See {Zone::List#all})
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   dns = gcloud.dns
-      #   zones = dns.zones
-      #   zones.all do |zone|
-      #     puts zone.name
-      #   end
-      #
-      def zones token: nil, max: nil
-        ensure_service!
-        gapi = service.list_zones token: token, max: max
-        Zone::List.from_gapi gapi, service, max
-      end
-      alias_method :find_zones, :zones
-
-      ##
-      # Creates a new zone.
-      #
-      # @param [String] zone_name User assigned name for this resource. Must be
-      #   unique within the project. The name must be 1-32 characters long, must
-      #   begin with a letter, end with a letter or digit, and only contain
-      #   lowercase letters, digits or dashes.
-      # @param [String] zone_dns The DNS name of this managed zone, for instance
-      #   "example.com.".
-      # @param [String] description A string of at most 1024 characters
-      #   associated with this resource for the user's convenience. Has no
-      #   effect on the managed zone's function.
-      # @param [String] name_server_set A NameServerSet is a set of DNS name
-      #   servers that all host the same ManagedZones. Most users will leave
-      #   this field unset.
-      #
-      # @return [Gcloud::Dns::Zone]
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   dns = gcloud.dns
-      #   zone = dns.create_zone "example-com", "example.com."
-      #
-      def create_zone zone_name, zone_dns, description: nil,
-                      name_server_set: nil
-        ensure_service!
-        gapi = service.create_zone zone_name, zone_dns,
-                                   description: description,
-                                   name_server_set: name_server_set
-        Zone.from_gapi gapi, service
-      end
-
-      ##
-      # Reloads the change with updated status from the DNS service.
-      def reload!
-        ensure_service!
-        @gapi = service.get_project
-      end
-      alias_method :refresh!, :reload!
-
-      protected
-
-      ##
-      # Raise an error unless an active connection is available.
-      def ensure_service!
-        fail "Must have active connection" unless service
-      end
-    end
-  end
-end

data/lib/gcloud/dns/record.rb

@@ -1,170 +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 "gcloud/dns/record/list"
-
-module Gcloud
-  module Dns
-    ##
-    # # DNS Record
-    #
-    # Represents a set of DNS resource records (RRs) for a given
-    # {Gcloud::Dns::Record#name} and {Gcloud::Dns::Record#type} in a
-    # {Gcloud::Dns::Zone}. Since it is a value object, a newly created Record
-    # instance is transient until it is added to a Zone with
-    # {Gcloud::Dns::Zone#update}. Note that {Gcloud::Dns::Zone#add} and the
-    # {Gcloud::Dns::Zone#update} block parameter can be used instead of
-    # {Gcloud::Dns::Zone#record} or `Record.new` to create new records.
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   dns = gcloud.dns
-    #   zone = dns.zone "example-com"
-    #
-    #   zone.records.count #=> 2
-    #   record = zone.record "example.com.", "A", 86400, "1.2.3.4"
-    #   zone.records.count #=> 2
-    #   change = zone.update record
-    #   zone.records.count #=> 3
-    #
-    class Record
-      ##
-      # The owner of the record. For example: `example.com.`.
-      #
-      # @return [String]
-      #
-      attr_accessor :name
-
-      ##
-      # The identifier of a [supported record type
-      # ](https://cloud.google.com/dns/what-is-cloud-dns#supported_record_types)
-      # . For example: `A`, `AAAA`, `CNAME`, `MX`, or `TXT`.
-      #
-      # @return [String]
-      #
-      attr_accessor :type
-
-      ##
-      # The number of seconds that the record can be cached by resolvers.
-      #
-      # @return [Integer]
-      #
-      attr_accessor :ttl
-
-      ##
-      # The array of 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: ["10 mail.example.com.", "20 mail2.example.com."].
-      #
-      # @return [Array<String>]
-      #
-      attr_accessor :data
-
-      ##
-      # Creates a Record value object.
-      #
-      # @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: ["10 mail.example.com.", "20 mail2.example.com."].
-      #
-      def initialize name, type, ttl, data
-        fail ArgumentError, "name is required" unless name
-        fail ArgumentError, "type is required" unless type
-        fail ArgumentError, "ttl is required" unless ttl
-        fail ArgumentError, "data is required" unless data
-        @name = name.to_s
-        @type = type.to_s.upcase
-        @ttl = Integer(ttl)
-        @data = Array(data)
-      end
-
-      ##
-      # @private Returns an array of strings in the zone file format, one
-      # for each element in the record's data array.
-      def to_zonefile_records
-        data.map do |rrdata|
-          "#{name} #{ttl} IN #{type} #{rrdata}"
-        end
-      end
-
-      ##
-      # Returns a deep copy of the record. Useful for updating records, since
-      # the original, unmodified record must be passed for deletion when using
-      # {Gcloud::Dns::Zone#update}.
-      #
-      def dup
-        other = super
-        other.data = data.map(&:dup)
-        other
-      end
-
-      ##
-      # @private New Record from a Google API Client object.
-      def self.from_gapi gapi
-        new gapi.name, gapi.type, gapi.ttl, gapi.rrdatas
-      end
-
-      ##
-      # @private Convert the record object to a Google API hash.
-      def to_gapi
-        Google::Apis::DnsV1::ResourceRecordSet.new(
-          kind: "dns#resourceRecordSet",
-          name: name,
-          rrdatas: data,
-          ttl: ttl,
-          type: type
-        )
-      end
-
-      # @private
-      def hash
-        [name, type, ttl, data].hash
-      end
-
-      # @private
-      def eql? other
-        return false unless other.is_a? self.class
-        name == other.name && type == other.type &&
-          ttl == other.ttl && data == other.data
-      end
-
-      # @private
-      def == other
-        self.eql? other
-      end
-
-      # @private
-      def <=> other
-        return nil unless other.is_a? self.class
-        [name, type, ttl, data] <=>
-          [other.name, other.type, other.ttl, other.data]
-      end
-    end
-  end
-end

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

@@ -1,174 +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 Record
-      ##
-      # Record::List is a special case Array with additional values.
-      class List < DelegateClass(::Array)
-        ##
-        # If not empty, indicates that there are more records that match
-        # the request and this value should be passed to continue.
-        attr_accessor :token
-
-        ##
-        # @private Create a new Record::List with an array of Record instances.
-        def initialize arr = []
-          super arr
-        end
-
-        ##
-        # Whether there a next page of records.
-        #
-        # @return [Boolean]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #
-        #   records = zone.records "example.com."
-        #   if records.next?
-        #     next_records = records.next
-        #   end
-        #
-        def next?
-          !token.nil?
-        end
-
-        ##
-        # Retrieve the next page of records.
-        #
-        # @return [Record::List]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #
-        #   records = zone.records "example.com."
-        #   if records.next?
-        #     next_records = records.next
-        #   end
-        #
-        def next
-          return nil unless next?
-          ensure_zone!
-          @zone.records @name, @type, token: token, max: @max
-        end
-
-        ##
-        # Retrieves all records by repeatedly loading {#next} until {#next?}
-        # returns `false`. Calls the given block once for each record, which is
-        # passed as the parameter.
-        #
-        # An Enumerator is returned if no block is given.
-        #
-        # This method may make several API calls until all records 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 records. Default is no limit.
-        # @yield [record] The block for accessing each record.
-        # @yieldparam [Record] record The record object.
-        #
-        # @return [Enumerator]
-        #
-        # @example Iterating each record by passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #   records = zone.records "example.com."
-        #
-        #   records.all do |record|
-        #     puts record.name
-        #   end
-        #
-        # @example Using the enumerator by not passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #   records = zone.records "example.com."
-        #
-        #   all_names = records.all.map do |record|
-        #     record.name
-        #   end
-        #
-        # @example Limit the number of API calls made:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   dns = gcloud.dns
-        #   zone = dns.zone "example-com"
-        #   records = zone.records "example.com."
-        #
-        #   records.all(request_limit: 10) do |record|
-        #     puts record.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 Records::List from a response object.
-        def self.from_gapi gapi, zone, name = nil, type = nil, max = nil
-          records = new(Array(gapi.rrsets).map do |g|
-            Record.from_gapi g
-          end)
-          records.instance_variable_set "@token", gapi.next_page_token
-          records.instance_variable_set "@zone",  zone
-          records.instance_variable_set "@name",  name
-          records.instance_variable_set "@type",  type
-          records.instance_variable_set "@max",   max
-          records
-        end
-
-        protected
-
-        ##
-        # Raise an error unless an active connection is available.
-        def ensure_zone!
-          fail "Must have active connection" unless @zone
-        end
-      end
-    end
-  end
-end