gcloud 0.3.1 → 0.4.0

data/lib/gcloud/dns/importer.rb

@@ -0,0 +1,195 @@
+#--
+# 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 "zonefile"
+require "gcloud/dns/record"
+
+module Gcloud
+  module Dns
+    ##
+    # = DNS Importer
+    #
+    # Reads a {DNS zone
+    # file}[https://en.wikipedia.org/wiki/Zone_file] and parses it, creating a
+    # collection of Record instances. The returned records are unsaved,
+    # as they are not yet associated with a Zone. Use Zone#import to add zone
+    # file records to a Zone.
+    #
+    # Because the Google Cloud DNS API only accepts a single resource record for
+    # each +name+ and +type+ combination (with multiple +data+ elements), the
+    # zone file's records are merged as necessary. During this merge, the lowest
+    # +ttl+ of the merged records is used. If none of the merged records have a
+    # +ttl+ value, the zone file's global TTL is used for the record.
+    #
+    # The following record types are supported: A, AAAA, CNAME, MX, NAPTR, NS,
+    # PTR, SOA, SPF, SRV, and TXT.
+    class Importer #:nodoc:
+      ##
+      # Creates a new Importer that immediately parses the provided zone file
+      # data and creates Record instances.
+      #
+      # === Parameters
+      #
+      # +path_or_io+::
+      #   The path to a zone file on the filesystem, or an IO instance from
+      #   which zone file data can be read. (+String+ or +IO+)
+      #
+      def initialize zone, path_or_io
+        @zone = zone
+        @merged_zf_records = {}
+        @records = []
+        @zonefile = create_zonefile path_or_io
+        merge_zonefile_records
+        from_zonefile_records
+        @records.unshift soa_record
+      end
+
+      ##
+      # Returns the Record instances created from the zone file.
+      #
+      # === Parameters
+      #
+      # +options+::
+      #   An optional Hash for controlling additional behavior. (+Hash+)
+      # <code>options[:only]</code>::
+      #   Include only records of this type or types. (+String+ or +Array+)
+      # <code>options[:except]</code>::
+      #   Exclude records of this type or types. (+String+ or +Array+)
+      #
+      # === Returns
+      #
+      # An array of unsaved Record instances.
+      #
+      def records options = {}
+        filtered_records options[:only], options[:except]
+      end
+
+      protected
+
+      def filtered_records only, except
+        ret = @records
+        ret = ret.select { |r| Array(only).include? r.type } if only
+        ret = ret.reject { |r| Array(except).include? r.type } if except
+        ret
+      end
+
+      ##
+      # The zonefile library returns a two-element array in which the first
+      # element is a symbol type (:a, :mx, and so on), and the second element
+      # is an array containing the records of that type. Group the records by
+      # name and type instead.
+      def merge_zonefile_records
+        @zonefile.records.map do |r|
+          type = r.first
+          type = :aaaa if type == :a4
+          r.last.each do |zf_record|
+            name = Connection.fqdn(zf_record[:name], @zonefile.origin)
+            key = [name, type]
+            (@merged_zf_records[key] ||= []) << zf_record
+          end
+        end
+      end
+
+      ##
+      # Convert the grouped records to single array of records, merging records
+      # of the same name and type into a single record with an array of rrdatas.
+      def from_zonefile_records
+        @records = @merged_zf_records.map do |key, zf_records|
+          ttl = ttl_from_zonefile_records zf_records
+          data = zf_records.map do |zf_record|
+            data_from_zonefile_record(key[1], zf_record)
+          end
+          @zone.record key[0], key[1], ttl, data
+        end
+      end
+
+      def soa_record
+        zf_soa = @zonefile.soa
+        ttl = ttl_to_i(zf_soa[:ttl]) || ttl_to_i(@zonefile.ttl)
+        data = data_from_zonefile_record :soa, zf_soa
+        @zone.record zf_soa[:origin], "SOA", ttl, data
+      end
+
+      ##
+      # From a collection of records, take the lowest ttl
+      def ttl_from_zonefile_records zf_records
+        ttls = zf_records.map do |zf_record|
+          ttl_to_i(zf_record[:ttl])
+        end
+        min_ttl = ttls.compact.sort.first
+        min_ttl || ttl_to_i(@zonefile.ttl)
+      end
+
+      # rubocop:disable all
+      # Rubocop's line-length and branch condition restrictions prevent
+      # the most straightforward approach to converting zonefile's records
+      # to our own. So disable rubocop for this operation.
+
+      def data_from_zonefile_record type, zf_record
+        case type.to_s.upcase
+        when "A"
+          "#{zf_record[:host]}"
+        when "AAAA"
+          "#{zf_record[:host]}"
+        when "CNAME"
+          "#{zf_record[:host]}"
+        when "MX"
+          "#{zf_record[:pri]} #{zf_record[:host]}"
+        when "NAPTR"
+          "#{zf_record[:order]} #{zf_record[:preference]} #{zf_record[:flags]} #{zf_record[:service]} #{zf_record[:regexp]} #{zf_record[:replacement]}"
+        when "NS"
+          "#{zf_record[:host]}"
+        when "PTR"
+          "#{zf_record[:host]}"
+        when "SOA"
+          "#{zf_record[:primary]} #{zf_record[:email]} #{zf_record[:serial]} #{zf_record[:refresh]} #{zf_record[:retry]} #{zf_record[:expire]} #{zf_record[:minimumTTL]}"
+        when "SPF"
+          "#{zf_record[:data]}"
+        when "SRV"
+          "#{zf_record[:pri]} #{zf_record[:weight]} #{zf_record[:port]} #{zf_record[:host]}"
+        when "TXT"
+          "#{zf_record[:text]}"
+        else
+          fail ArgumentError, "record type '#{type}' is not supported"
+        end
+      end
+
+      # rubocop:enable all
+
+      MULTIPLIER = { "s" => (1),
+                     "m" => (60),
+                     "h" => (60 * 60),
+                     "d" => (60 * 60 * 24),
+                     "w" => (60 * 60 * 24 * 7) } # :nodoc:
+
+      def ttl_to_i ttl
+        if ttl.respond_to?(:to_int) || ttl.to_s =~ /\A\d+\z/
+          return ttl.to_i
+        elsif (m = /\A(\d+)(w|d|h|m|s)\z/.match ttl)
+          return m[1].to_i * MULTIPLIER[m[2]].to_i
+        end
+        nil
+      end
+
+      def create_zonefile path_or_io # :nodoc:
+        if path_or_io.respond_to? :read
+          Zonefile.new path_or_io.read
+        else
+          Zonefile.from_file path_or_io
+        end
+      end
+    end
+  end
+end

data/lib/gcloud/dns/project.rb

@@ -0,0 +1,291 @@
+#--
+# 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/gce"
+require "gcloud/dns/connection"
+require "gcloud/dns/credentials"
+require "gcloud/dns/zone"
+require "gcloud/dns/errors"
+
+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].
+    #
+    #   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
+      ##
+      # The Connection object.
+      attr_accessor :connection #:nodoc:
+
+      ##
+      # The Google API Client object.
+      attr_accessor :gapi #:nodoc:
+
+      ##
+      # Creates a new Connection instance.
+      #
+      # See Gcloud.dns
+      def initialize project, credentials #:nodoc:
+        project = project.to_s # Always cast to a string
+        fail ArgumentError, "project is missing" if project.empty?
+        @connection = Connection.new project, credentials
+        @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
+        connection.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"]["managedZones"] if @gapi["quota"]
+      end
+
+      ##
+      # Maximum allowed number of data entries per record.
+      def data_per_record
+        reload! if @gapi.nil?
+        @gapi["quota"]["resourceRecordsPerRrset"] if @gapi["quota"]
+      end
+
+      ##
+      # Maximum allowed number of records to add per change.
+      def additions_per_change
+        reload! if @gapi.nil?
+        @gapi["quota"]["rrsetAdditionsPerChange"] if @gapi["quota"]
+      end
+
+      ##
+      # Maximum allowed number of records to delete per change.
+      def deletions_per_change
+        reload! if @gapi.nil?
+        @gapi["quota"]["rrsetDeletionsPerChange"] if @gapi["quota"]
+      end
+
+      ##
+      # Maximum allowed number of records per zone in the project.
+      def records_per_zone
+        reload! if @gapi.nil?
+        @gapi["quota"]["rrsetsPerManagedZone"] 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"]["totalRrdataSizePerChange"] if @gapi["quota"]
+      end
+
+      ##
+      # Default project.
+      def self.default_project #:nodoc:
+        ENV["DNS_PROJECT"] ||
+          ENV["GCLOUD_PROJECT"] ||
+          ENV["GOOGLE_CLOUD_PROJECT"] ||
+          Gcloud::GCE.project_id
+      end
+
+      ##
+      # Retrieves an existing zone by name or id.
+      #
+      # === Parameters
+      #
+      # +zone_id+::
+      #   The name or id of a zone. (+String+ or +Integer+)
+      #
+      # === Returns
+      #
+      # Gcloud::Dns::Zone or +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_connection!
+        resp = connection.get_zone zone_id
+        if resp.success?
+          Zone.from_gapi resp.data, connection
+        else
+          nil
+        end
+      end
+      alias_method :find_zone, :zone
+      alias_method :get_zone, :zone
+
+      ##
+      # Retrieves the list of zones belonging to the project.
+      #
+      # === Parameters
+      #
+      # +options+::
+      #   An optional Hash for controlling additional behavior. (+Hash+)
+      # <code>options[:token]</code>::
+      #   A previously-returned page token representing part of the larger set
+      #   of results to view. (+String+)
+      # <code>options[:max]</code>::
+      #   Maximum number of zones to return. (+Integer+)
+      #
+      # === Returns
+      #
+      # Array of Gcloud::Dns::Zone (Gcloud::Dns::Zone::List)
+      #
+      # === Examples
+      #
+      #   require "gcloud"
+      #
+      #   gcloud = Gcloud.new
+      #   dns = gcloud.dns
+      #   zones = dns.zones
+      #   zones.each do |zone|
+      #     puts zone.name
+      #   end
+      #
+      # If you have a significant number of zones, you may need to paginate
+      # through them: (See Gcloud::Dns::Zone::List)
+      #
+      #   require "gcloud"
+      #
+      #   gcloud = Gcloud.new
+      #   dns = gcloud.dns
+      #   zones = dns.zones
+      #   loop do
+      #     zones.each do |zone|
+      #       puts zone.name
+      #     end
+      #     break unless zones.next?
+      #     zones = zones.next
+      #   end
+      #
+      def zones options = {}
+        ensure_connection!
+        resp = connection.list_zones options
+        if resp.success?
+          Zone::List.from_response resp, connection
+        else
+          fail ApiError.from_response(resp)
+        end
+      end
+      alias_method :find_zones, :zones
+
+      ##
+      # Creates a new zone.
+      #
+      # === Parameters
+      #
+      # +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. (+String+)
+      # +zone_dns+::
+      #   The DNS name of this managed zone, for instance "example.com.".
+      #   (+String+)
+      # +options+::
+      #   An optional Hash for controlling additional behavior. (+Hash+)
+      # <code>options[:description]</code>::
+      #   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.
+      #   (+String+)
+      # <code>options[:name_server_set]</code>::
+      #   A NameServerSet is a set of DNS name servers that all host the same
+      #   ManagedZones. Most users will leave this field unset. (+String+)
+      #
+      # === Returns
+      #
+      # Gcloud::Dns::Zone
+      #
+      # === Examples
+      #
+      #   require "gcloud"
+      #
+      #   gcloud = Gcloud.new
+      #   dns = gcloud.dns
+      #   zone = dns.create_zone "example-com", "example.com."
+      #
+      def create_zone zone_name, zone_dns, options = {}
+        ensure_connection!
+        resp = connection.create_zone zone_name, zone_dns, options
+        if resp.success?
+          Zone.from_gapi resp.data, connection
+        else
+          fail ApiError.from_response(resp)
+        end
+      end
+
+      ##
+      # Reloads the change with updated status from the DNS service.
+      def reload!
+        ensure_connection!
+        resp = connection.get_project
+        if resp.success?
+          @gapi = resp.data
+        else
+          fail ApiError.from_response(resp)
+        end
+      end
+      alias_method :refresh!, :reload!
+
+      protected
+
+      ##
+      # Raise an error unless an active connection is available.
+      def ensure_connection!
+        fail "Must have active connection" unless connection
+      end
+    end
+  end
+end