gcloud 0.6.3 → 0.7.0

data/lib/gcloud/dns/change.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,19 +12,21 @@
 # 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
+    # # 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.
     #
+    # @example
     #   require "gcloud"
     #
     #   gcloud = Gcloud.new
@@ -38,16 +39,16 @@ module Gcloud
     #
     class Change
       ##
-      # The Zone object this Change belongs to.
-      attr_accessor :zone #:nodoc:
+      # @private The Zone object this Change belongs to.
+      attr_accessor :zone
 
       ##
-      # The Google API Client object.
-      attr_accessor :gapi #:nodoc:
+      # @private The Google API Client object.
+      attr_accessor :gapi
 
       ##
-      # Create an empty Change object.
-      def initialize #:nodoc:
+      # @private Create an empty Change object.
+      def initialize
         @zone = nil
         @gapi = {}
       end
@@ -74,21 +75,21 @@ module Gcloud
       end
 
       ##
-      # Status of the operation. Values are +"done"+ and +"pending"+.
+      # Status of the operation. Values are `"done"` and `"pending"`.
       #
       def status
         @gapi["status"]
       end
 
       ##
-      # Checks if the status is +"done"+.
+      # Checks if the status is `"done"`.
       def done?
         return false if status.nil?
         "done".casecmp(status).zero?
       end
 
       ##
-      # Checks if the status is +"pending"+.
+      # Checks if the status is `"pending"`.
       def pending?
         return false if status.nil?
         "pending".casecmp(status).zero?
@@ -117,11 +118,10 @@ module Gcloud
       alias_method :refresh!, :reload!
 
       ##
-      # Refreshes the change until the status is +done+.
+      # Refreshes the change until the status is `done`.
       # The delay between refreshes will incrementally increase.
       #
-      # === Example
-      #
+      # @example
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
@@ -143,8 +143,8 @@ module Gcloud
       end
 
       ##
-      # New Change from a Google API Client object.
-      def self.from_gapi gapi, zone #:nodoc:
+      # @private New Change from a Google API Client object.
+      def self.from_gapi gapi, zone
         new.tap do |f|
           f.gapi = gapi
           f.zone = zone

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

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "delegate"
 
 module Gcloud
@@ -47,8 +47,8 @@ module Gcloud
         end
 
         ##
-        # New Changes::List from a response object.
-        def self.from_response resp, zone #:nodoc:
+        # @private New Changes::List from a response object.
+        def self.from_response resp, zone
           changes = new(Array(resp.data["changes"]).map do |gapi_object|
             Change.from_gapi gapi_object, zone
           end)

data/lib/gcloud/dns/connection.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,23 +12,23 @@
 # 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:
+    # @private Represents the connection to DNS, as well as expose the API calls
+    class Connection
       API_VERSION = "v1"
 
       attr_accessor :project
-      attr_accessor :credentials #:nodoc:
+      attr_accessor :credentials
 
       ##
       # Creates a new Connection instance.
-      def initialize project, credentials #:nodoc:
+      def initialize project, credentials
         @project = project
         @credentials = credentials
         @client = Google::APIClient.new application_name:    "gcloud-ruby",
@@ -136,7 +135,7 @@ module Gcloud
 
       ##
       # Fully Qualified Domain Name
-      def self.fqdn name, origin_dns #:nodoc:
+      def self.fqdn name, origin_dns
         name = name.to_s.strip
         return name if self.ip_addr? name
         name = origin_dns if name.empty?
@@ -148,16 +147,16 @@ module Gcloud
 
       require "ipaddr"
       # Fix to make ip_addr? work on ruby 1.9
-      IPAddr::Error = ArgumentError unless defined? IPAddr::Error #:nodoc:
+      IPAddr::Error = ArgumentError unless defined? IPAddr::Error
 
-      def self.ip_addr? name #:nodoc:
+      def self.ip_addr? name
         IPAddr.new name
         true
       rescue IPAddr::Error
         false
       end
 
-      def inspect #:nodoc:
+      def inspect
         "#{self.class}(#{@project})"
       end
     end

data/lib/gcloud/dns/credentials.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,13 +12,14 @@
 # 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:
+    # @private Represents the Oauth2 signing logic for DNS.
+    class Credentials < Gcloud::Credentials
       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

data/lib/gcloud/dns/errors.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "gcloud/errors"
 
 module Gcloud
@@ -33,13 +33,15 @@ module Gcloud
       # The errors encountered.
       attr_reader :errors
 
-      def initialize message, code, errors = [] #:nodoc:
+      # @private
+      def initialize message, code, errors = []
         super message
         @code   = code
         @errors = errors
       end
 
-      def self.from_response resp #:nodoc:
+      # @private
+      def self.from_response resp
         if resp.data? && resp.data["error"]
           from_response_data resp.data["error"]
         else
@@ -47,11 +49,13 @@ module Gcloud
         end
       end
 
-      def self.from_response_data error #:nodoc:
+      # @private
+      def self.from_response_data error
         new error["message"], error["code"], error["errors"]
       end
 
-      def self.from_response_status resp #:nodoc:
+      # @private
+      def self.from_response_status resp
         if resp.status == 404
           new "#{resp.error_message}: #{resp.request.uri.request_uri}",
               resp.status

data/lib/gcloud/dns/importer.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,38 +12,37 @@
 # 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
+    # @private
+    # # DNS Importer
     #
-    # Reads a {DNS zone
-    # file}[https://en.wikipedia.org/wiki/Zone_file] and parses it, creating a
+    # 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
+    # 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
+    # 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.
+    # `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:
+    class Importer
       ##
       # 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+)
+      # @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
@@ -59,16 +57,12 @@ module Gcloud
       ##
       # Returns the Record instances created from the zone file.
       #
-      # === Parameters
-      #
-      # +only+::
-      #   Include only records of this type or types. (+String+ or +Array+)
-      # +except+::
-      #   Exclude records of this type or types. (+String+ or +Array+)
-      #
-      # === Returns
+      # @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.
       #
-      # An array of unsaved Record instances.
+      # @return [Array<Record>] An array of unsaved {Record} instances
       #
       def records only: nil, except: nil
         ret = @records

data/lib/gcloud/dns/project.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +12,7 @@
 # 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"
@@ -22,12 +22,13 @@ require "gcloud/dns/errors"
 module Gcloud
   module Dns
     ##
-    # = Project
+    # # 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].
+    # ManagedZones. Projects can be created only in the [Google Developers
+    # Console](https://console.developers.google.com).
     #
+    # @example
     #   require "gcloud"
     #
     #   gcloud = Gcloud.new
@@ -37,21 +38,21 @@ module Gcloud
     #     puts record.name
     #   end
     #
-    # See Gcloud#dns
+    # See {Gcloud#dns}
     class Project
       ##
-      # The Connection object.
-      attr_accessor :connection #:nodoc:
+      # @private The Connection object.
+      attr_accessor :connection
 
       ##
-      # The Google API Client object.
-      attr_accessor :gapi #:nodoc:
+      # @private The Google API Client object.
+      attr_accessor :gapi
 
       ##
-      # Creates a new Connection instance.
+      # @private Creates a new Connection instance.
       #
-      # See Gcloud.dns
-      def initialize project, credentials #:nodoc:
+      # See {Gcloud.dns}
+      def initialize project, credentials
         project = project.to_s # Always cast to a string
         fail ArgumentError, "project is missing" if project.empty?
         @connection = Connection.new project, credentials
@@ -61,8 +62,7 @@ module Gcloud
       ##
       # The unique ID string for the current project.
       #
-      # === Example
-      #
+      # @example
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new "my-todo-project", "/path/to/keyfile.json"
@@ -125,8 +125,8 @@ module Gcloud
       end
 
       ##
-      # Default project.
-      def self.default_project #:nodoc:
+      # @private Default project.
+      def self.default_project
         ENV["DNS_PROJECT"] ||
           ENV["GCLOUD_PROJECT"] ||
           ENV["GOOGLE_CLOUD_PROJECT"] ||
@@ -136,17 +136,12 @@ module Gcloud
       ##
       # Retrieves an existing zone by name or id.
       #
-      # === Parameters
-      #
-      # +zone_id+::
-      #   The name or id of a zone. (+String+ or +Integer+)
-      #
-      # === Returns
+      # @param [String, Integer] zone_id The name or id of a zone.
       #
-      # Gcloud::Dns::Zone or +nil+ if the zone does not exist
-      #
-      # === Example
+      # @return [Gcloud::Dns::Zone, nil] Returns `nil` if the zone does not
+      #   exist.
       #
+      # @example
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
@@ -169,20 +164,13 @@ module Gcloud
       ##
       # Retrieves the list of zones belonging to the project.
       #
-      # === Parameters
-      #
-      # +token+::
-      #   A previously-returned page token representing part of the larger set
-      #   of results to view. (+String+)
-      # +max+::
-      #   Maximum number of zones to return. (+Integer+)
-      #
-      # === Returns
+      # @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.
       #
-      # Array of Gcloud::Dns::Zone (See Gcloud::Dns::Zone::List)
-      #
-      # === Examples
+      # @return [Array<Gcloud::Dns::Zone>] (See {Gcloud::Dns::Zone::List})
       #
+      # @example
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
@@ -192,9 +180,7 @@ module Gcloud
       #     puts zone.name
       #   end
       #
-      # If you have a significant number of zones, you may need to paginate
-      # through them: (See Gcloud::Dns::Zone::List)
-      #
+      # @example With pagination: (See {Gcloud::Dns::Zone::List})
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
@@ -222,30 +208,22 @@ module Gcloud
       ##
       # 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+)
-      # +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.
-      #   (+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. (+String+)
-      #
-      # === Returns
-      #
-      # Gcloud::Dns::Zone
-      #
-      # === Examples
-      #
+      # @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