google-cloud-dns 0.20.0

data/lib/google/cloud/dns/change/list.rb

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

data/lib/google/cloud/dns/credentials.rb

@@ -0,0 +1,31 @@
+# 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 "google/cloud/credentials"
+
+module Google
+  module Cloud
+    module Dns
+      ##
+      # @private Represents the Oauth2 signing logic for DNS.
+      class Credentials < Google::Cloud::Credentials
+        SCOPE = ["https://www.googleapis.com/auth/ndev.clouddns.readwrite"]
+        PATH_ENV_VARS = %w(DNS_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
+        JSON_ENV_VARS = %w(DNS_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON
+                           GCLOUD_KEYFILE_JSON)
+      end
+    end
+  end
+end

data/lib/google/cloud/dns/importer.rb

@@ -0,0 +1,186 @@
+# 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 "google/cloud/dns/record"
+
+module Google
+  module Cloud
+    module Dns
+      ##
+      # @private
+      # # 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
+        ##
+        # Creates a new Importer that immediately parses the provided zone file
+        # data and creates Record instances.
+        #
+        # @param [String, IO] path_or_io The path to a zone file on the
+        #   filesystem, or an IO instance from which zone file data can be read.
+        #
+        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.
+        #
+        # @param [String, Array<String>] only Include only records of this type
+        #   or types.
+        # @param [String, Array<String>] except Exclude records of this type or
+        #   types.
+        #
+        # @return [Array<Record>] An array of unsaved {Record} instances
+        #
+        def records only: nil, except: nil
+          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
+
+        protected
+
+        ##
+        # 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 = Service.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
+end

data/lib/google/cloud/dns/project.rb

@@ -0,0 +1,251 @@
+# 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 "google/cloud/errors"
+require "google/cloud/core/gce"
+require "google/cloud/dns/service"
+require "google/cloud/dns/credentials"
+require "google/cloud/dns/zone"
+
+module Google
+  module Cloud
+    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 "google/cloud"
+      #
+      #   gcloud = Google::Cloud.new
+      #   dns = gcloud.dns
+      #   zone = dns.zone "example-com"
+      #   zone.records.each do |record|
+      #     puts record.name
+      #   end
+      #
+      # See {Google::Cloud#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 {Google::Cloud.dns}
+        def initialize service
+          @service = service
+          @gapi = nil
+        end
+
+        ##
+        # The unique ID string for the current project.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.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["GOOGLE_CLOUD_PROJECT"] ||
+            ENV["GCLOUD_PROJECT"] ||
+            Google::Cloud::Core::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 [Google::Cloud::Dns::Zone, nil] Returns `nil` if the zone does
+        #   not exist.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.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 Google::Cloud::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<Google::Cloud::Dns::Zone>] (See
+        # {Google::Cloud::Dns::Zone::List})
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   dns = gcloud.dns
+        #   zones = dns.zones
+        #   zones.each do |zone|
+        #     puts zone.name
+        #   end
+        #
+        # @example Retrieve all zones: (See {Zone::List#all})
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.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 [Google::Cloud::Dns::Zone]
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.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
+end