gcloud 0.3.1 → 0.4.0

data/lib/gcloud/dns/change.rb

@@ -0,0 +1,163 @@
+#--
+# 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/change/list"
+require "time"
+
+module Gcloud
+  module Dns
+    ##
+    # = DNS Change
+    #
+    # Represents a request containing additions or deletions or records.
+    # Additions and deletions can be done in bulk, in a single atomic
+    # transaction, and take effect at the same time in each authoritative DNS
+    # server.
+    #
+    #   require "gcloud"
+    #
+    #   gcloud = Gcloud.new
+    #   dns = gcloud.dns
+    #   zone = dns.zone "example-com"
+    #   zone.changes.each do |change|
+    #     puts "Change includes #{change.additions.count} additions " \
+    #          "and #{change.additions.count} deletions."
+    #   end
+    #
+    class Change
+      ##
+      # The Zone object this Change belongs to.
+      attr_accessor :zone #:nodoc:
+
+      ##
+      # The Google API Client object.
+      attr_accessor :gapi #:nodoc:
+
+      ##
+      # Create an empty Change object.
+      def initialize #:nodoc:
+        @zone = nil
+        @gapi = {}
+      end
+
+      ##
+      # Unique identifier for the resource; defined by the server.
+      #
+      def id
+        @gapi["id"]
+      end
+
+      ##
+      # The records added in this change request.
+      #
+      def additions
+        Array(@gapi["additions"]).map { |gapi| Record.from_gapi gapi }
+      end
+
+      ##
+      # The records removed in this change request.
+      #
+      def deletions
+        Array(@gapi["deletions"]).map { |gapi| Record.from_gapi gapi }
+      end
+
+      ##
+      # Status of the operation. Values are +"done"+ and +"pending"+.
+      #
+      def status
+        @gapi["status"]
+      end
+
+      ##
+      # Checks if the status is +"done"+.
+      def done?
+        return false if status.nil?
+        "done".casecmp(status).zero?
+      end
+
+      ##
+      # Checks if the status is +"pending"+.
+      def pending?
+        return false if status.nil?
+        "pending".casecmp(status).zero?
+      end
+
+      ##
+      # The time that this operation was started by the server.
+      #
+      def started_at
+        Time.parse @gapi["startTime"]
+      rescue
+        nil
+      end
+
+      ##
+      # Reloads the change with updated status from the DNS service.
+      def reload!
+        ensure_connection!
+        resp = zone.connection.get_change @zone.id, id
+        if resp.success?
+          @gapi = resp.data
+        else
+          fail ApiError.from_response(resp)
+        end
+      end
+      alias_method :refresh!, :reload!
+
+      ##
+      # Refreshes the change until the status is +done+.
+      # The delay between refreshes will incrementally increase.
+      #
+      # === Example
+      #
+      #   require "gcloud"
+      #
+      #   gcloud = Gcloud.new
+      #   dns = gcloud.dns
+      #   zone = dns.zone "example-com"
+      #   change = zone.change 1234567890
+      #   change.done? #=> false
+      #   change.wait_until_done!
+      #   change.done? #=> true
+      #
+      def wait_until_done!
+        backoff = ->(retries) { sleep 2 * retries + 5 }
+        retries = 0
+        until done?
+          backoff.call retries
+          retries += 1
+          reload!
+        end
+      end
+
+      ##
+      # New Change from a Google API Client object.
+      def self.from_gapi gapi, zone #:nodoc:
+        new.tap do |f|
+          f.gapi = gapi
+          f.zone = zone
+        end
+      end
+
+      protected
+
+      ##
+      # Raise an error unless an active connection is available.
+      def ensure_connection!
+        fail "Must have active connection" unless zone && zone.connection
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+#--
+# 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 Change
+      ##
+      # Change::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
+
+        ##
+        # Create a new Change::List with an array of Change instances.
+        def initialize arr = []
+          super arr
+        end
+
+        ##
+        # Whether there a next page of zones.
+        def next?
+          !token.nil?
+        end
+
+        ##
+        # Retrieve the next page of zones.
+        def next
+          return nil unless next?
+          ensure_zone!
+          @zone.changes token: token
+        end
+
+        ##
+        # New Changes::List from a response object.
+        def self.from_response resp, zone #:nodoc:
+          changes = new(Array(resp.data["changes"]).map do |gapi_object|
+            Change.from_gapi gapi_object, zone
+          end)
+          changes.instance_eval do
+            @token = resp.data["nextPageToken"]
+            @zone = zone
+          end
+          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

data/lib/gcloud/dns/connection.rb

@@ -0,0 +1,164 @@
+#--
+# 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/version"
+require "google/api_client"
+
+module Gcloud
+  module Dns
+    ##
+    # Represents the connection to DNS,
+    # as well as expose the API calls.
+    class Connection #:nodoc:
+      API_VERSION = "v1"
+
+      attr_accessor :project
+      attr_accessor :credentials #:nodoc:
+
+      ##
+      # Creates a new Connection instance.
+      def initialize project, credentials #:nodoc:
+        @project = project
+        @credentials = credentials
+        @client = Google::APIClient.new application_name:    "gcloud-ruby",
+                                        application_version: Gcloud::VERSION
+        @client.authorization = @credentials.client
+        @dns = @client.discovered_api "dns", API_VERSION
+      end
+
+      def get_project project_id = @project
+        @client.execute(
+          api_method: @dns.projects.get,
+          parameters: { project: project_id }
+        )
+      end
+
+      def get_zone zone_id
+        @client.execute(
+          api_method: @dns.managed_zones.get,
+          parameters: { project: @project, managedZone: zone_id }
+        )
+      end
+
+      def list_zones options = {}
+        params = { project: @project,
+                   pageToken: options.delete(:token),
+                   maxResults: options.delete(:max)
+                 }.delete_if { |_, v| v.nil? }
+
+        @client.execute(
+          api_method: @dns.managed_zones.list,
+          parameters: params
+        )
+      end
+
+      def create_zone zone_name, zone_dns, options = {}
+        body = { kind: "dns#managedZone",
+                 name: zone_name, dnsName: zone_dns,
+                 description: (options[:description] || ""),
+                 nameServerSet: options[:name_server_set]
+               }.delete_if { |_, v| v.nil? }
+
+        @client.execute(
+          api_method: @dns.managed_zones.create,
+          parameters: { project: @project },
+          body_object: body
+        )
+      end
+
+      def delete_zone zone_id
+        @client.execute(
+          api_method: @dns.managed_zones.delete,
+          parameters: { project: @project, managedZone: zone_id }
+        )
+      end
+
+      def get_change zone_id, change_id
+        @client.execute(
+          api_method: @dns.changes.get,
+          parameters: { project: @project, managedZone: zone_id,
+                        changeId: change_id }
+        )
+      end
+
+      def list_changes zone_id, options = {}
+        params = { project: @project, managedZone: zone_id,
+                   pageToken: options.delete(:token),
+                   maxResults: options.delete(:max),
+                   sortBy: options.delete(:sort),
+                   sortOrder: options.delete(:order)
+                 }.delete_if { |_, v| v.nil? }
+
+        @client.execute(
+          api_method: @dns.changes.list,
+          parameters: params
+        )
+      end
+
+      def create_change zone_id, additions, deletions
+        change = { "kind"      => "dns#change",
+                   "additions" => Array(additions),
+                   "deletions" => Array(deletions) }
+
+        @client.execute(
+          api_method: @dns.changes.create,
+          parameters: { project: @project, managedZone: zone_id },
+          body_object: change
+        )
+      end
+
+      def list_records zone_id, options = {}
+        params = { project: @project, managedZone: zone_id,
+                   pageToken: options.delete(:token),
+                   maxResults: options.delete(:max),
+                   name: options.delete(:name),
+                   type: options.delete(:type)
+                 }.delete_if { |_, v| v.nil? }
+
+        @client.execute(
+          api_method: @dns.resource_record_sets.list,
+          parameters: params
+        )
+      end
+
+      ##
+      # Fully Qualified Domain Name
+      def self.fqdn name, origin_dns #:nodoc:
+        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"
+      # Fix to make ip_addr? work on ruby 1.9
+      IPAddr::Error = ArgumentError unless defined? IPAddr::Error #:nodoc:
+
+      def self.ip_addr? name #:nodoc:
+        IPAddr.new name
+        true
+      rescue IPAddr::Error
+        false
+      end
+
+      def inspect #:nodoc:
+        "#{self.class}(#{@project})"
+      end
+    end
+  end
+end

data/lib/gcloud/dns/credentials.rb

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

data/lib/gcloud/dns/errors.rb

@@ -0,0 +1,64 @@
+#--
+# 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"
+
+module Gcloud
+  module Dns
+    ##
+    # Base DNS exception class.
+    class Error < Gcloud::Error
+    end
+
+    ##
+    # Raised when an API call is not successful.
+    class ApiError < Error
+      ##
+      # The code of the error.
+      attr_reader :code
+
+      ##
+      # The errors encountered.
+      attr_reader :errors
+
+      def initialize message, code, errors = [] #:nodoc:
+        super message
+        @code   = code
+        @errors = errors
+      end
+
+      def self.from_response resp #:nodoc:
+        if resp.data? && resp.data["error"]
+          from_response_data resp.data["error"]
+        else
+          from_response_status resp
+        end
+      end
+
+      def self.from_response_data error #:nodoc:
+        new error["message"], error["code"], error["errors"]
+      end
+
+      def self.from_response_status resp #:nodoc:
+        if resp.status == 404
+          new "#{resp.error_message}: #{resp.request.uri.request_uri}",
+              resp.status
+        else
+          new resp.error_message, resp.status
+        end
+      end
+    end
+  end
+end