google-cloud-dns 0.20.0

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

@@ -0,0 +1,173 @@
+# 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/dns/record/list"
+
+module Google
+  module Cloud
+    module Dns
+      ##
+      # # DNS Record
+      #
+      # Represents a set of DNS resource records (RRs) for a given
+      # {Google::Cloud::Dns::Record#name} and {Google::Cloud::Dns::Record#type}
+      # in a {Google::Cloud::Dns::Zone}. Since it is a value object, a newly
+      # created Record instance is transient until it is added to a Zone with
+      # {Google::Cloud::Dns::Zone#update}. Note that
+      # {Google::Cloud::Dns::Zone#add} and the {Google::Cloud::Dns::Zone#update}
+      # block parameter can be used instead of {Google::Cloud::Dns::Zone#record}
+      # or `Record.new` to create new records.
+      #
+      # @example
+      #   require "google/cloud"
+      #
+      #   gcloud = Google::Cloud.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
+        # {Google::Cloud::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
+end

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

@@ -0,0 +1,177 @@
+# 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 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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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
+end

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

@@ -0,0 +1,166 @@
+# Copyright 2016 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/dns/version"
+require "google/apis/dns_v1"
+
+module Google
+  module Cloud
+    module Dns
+      ##
+      # @private
+      # Represents the service to DNS, exposing the API calls.
+      class Service
+        ##
+        # Alias to the Google Client API module
+        API = Google::Apis::DnsV1
+
+        attr_accessor :project
+        attr_accessor :credentials
+
+        ##
+        # Creates a new Service instance.
+        def initialize project, credentials, retries: nil, timeout: nil
+          @project = project
+          @credentials = credentials
+          @service = API::DnsService.new
+          @service.client_options.application_name    = "google-cloud-dns"
+          @service.client_options.application_version = \
+            Google::Cloud::Dns::VERSION
+          @service.request_options.retries = retries || 3
+          @service.request_options.timeout_sec = timeout if timeout
+          @service.authorization = @credentials.client
+        end
+
+        def service
+          return mocked_service if mocked_service
+          @service
+        end
+        attr_accessor :mocked_service
+
+        ##
+        # Returns Google::Apis::DnsV1::Project
+        def get_project project_id = @project
+          execute { service.get_project project_id }
+        end
+
+        ##
+        # Returns Google::Apis::DnsV1::ManagedZone
+        def get_zone zone_id
+          execute { service.get_managed_zone @project, zone_id }
+        end
+
+        ##
+        # Returns Google::Apis::DnsV1::ListManagedZonesResponse
+        def list_zones token: nil, max: nil
+          execute do
+            service.list_managed_zones @project, max_results: max,
+                                                 page_token: token
+          end
+        end
+
+        ##
+        # Returns Google::Apis::DnsV1::ManagedZone
+        def create_zone zone_name, zone_dns, description: nil,
+                        name_server_set: nil
+          managed_zone = Google::Apis::DnsV1::ManagedZone.new(
+            kind: "dns#managedZone",
+            name: zone_name,
+            dns_name: zone_dns,
+            description: (description || ""),
+            name_server_set: name_server_set
+          )
+          execute { service.create_managed_zone @project, managed_zone }
+        end
+
+        def delete_zone zone_id
+          execute { service.delete_managed_zone @project, zone_id }
+        end
+
+        ##
+        # Returns Google::Apis::DnsV1::Change
+        def get_change zone_id, change_id
+          execute { service.get_change @project, zone_id, change_id }
+        end
+
+        ##
+        # Returns Google::Apis::DnsV1::ListChangesResponse
+        def list_changes zone_id, token: nil, max: nil, order: nil, sort: nil
+          execute do
+            service.list_changes @project, zone_id, max_results: max,
+                                                    page_token: token,
+                                                    sort_by: sort,
+                                                    sort_order: order
+          end
+        end
+
+        ##
+        # Returns Google::Apis::DnsV1::Change
+        def create_change zone_id, additions, deletions
+          change = Google::Apis::DnsV1::Change.new(
+            kind: "dns#change",
+            additions: Array(additions),
+            deletions: Array(deletions)
+          )
+          execute { service.create_change @project, zone_id, change }
+        end
+
+        ##
+        # Returns Google::Apis::DnsV1::ListResourceRecordSetsResponse
+        def list_records zone_id, name = nil, type = nil, token: nil, max: nil
+          execute do
+            service.list_resource_record_sets @project, zone_id,
+                                              max_results: max, name: name,
+                                              page_token: token, type: type
+          end
+        end
+
+        ##
+        # Fully Qualified Domain Name
+        def self.fqdn name, origin_dns
+          name = name.to_s.strip
+          return name if self.ip_addr? name
+          name = origin_dns if name.empty?
+          name = origin_dns if name == "@"
+          name = "#{name}.#{origin_dns}" unless name.include? "."
+          name = "#{name}." unless name.end_with? "."
+          name
+        end
+
+        require "ipaddr"
+
+        def self.ip_addr? name
+          IPAddr.new name
+          true
+        rescue IPAddr::Error
+          false
+        end
+
+        def inspect
+          "#{self.class}(#{@project})"
+        end
+
+        protected
+
+        def execute
+          yield
+        rescue Google::Apis::Error => e
+          raise Google::Cloud::Error.from_error(e)
+        end
+      end
+    end
+  end
+end