Adds RDoc for #bootstrap, #get(id) and #all()

mohitsethi · Jan 14, 2015 · 89717f0 · 89717f0
1 parent 778ba2a
commit 89717f0
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/lib/fog/digitalocean/models/compute/servers.rb b/lib/fog/digitalocean/models/compute/servers.rb
@@ -7,11 +7,33 @@ class DigitalOcean
       class Servers < Fog::Collection
         model Fog::Compute::DigitalOcean::Server
 
+        # Returns list of servers
+        # @return [Fog::Compute::DigitalOcean::Servers] Retrieves a list of servers.
+        # @raise [Fog::Compute::DigitalOcean::NotFound] - HTTP 404
+        # @raise [Fog::Compute::DigitalOcean::BadRequest] - HTTP 400
+        # @raise [Fog::Compute::DigitalOcean::InternalServerError] - HTTP 500
+        # @raise [Fog::Compute::DigitalOcean::ServiceError]
+        # @see https://developers.digitalocean.com/v1/droplets/
         def all(filters = {})
           data = service.list_servers.body['droplets']
           load(data)
         end
 
+        # Creates a new server and populates ssh keys
+        #
+        # @return [Fog::Compute::DigitalOcean::Server]
+        # @raise [Fog::Compute::DigitalOcean::NotFound] - HTTP 404
+        # @raise [Fog::Compute::DigitalOcean::BadRequest] - HTTP 400
+        # @raise [Fog::Compute::DigitalOcean::InternalServerError] - HTTP 500
+        # @raise [Fog::Compute::DigitalOcean::ServiceError]
+        # @note This creates an SSH public key object and assigns it to the server on creation
+        # @example
+        #   service.servers.bootstrap :name => 'bootstrap-server',
+        #                             :flavor_ref => service.flavors.first.id,
+        #                             :image_ref => service.images.find {|img| img.name =~ /Ubuntu/}.id,
+        #                             :public_key_path => '~/.ssh/fog_rsa.pub',
+        #                             :private_key_path => '~/.ssh/fog_rsa'
+        #
         def bootstrap(new_attributes = {})
           server = new(new_attributes)
 
@@ -40,6 +62,14 @@ def bootstrap(new_attributes = {})
           server
         end
 
+        # Retrieves server
+        # @param [String] id for server to be returned
+        # @return [Fog::Compute::DigitalOcean:Server]
+        # @raise [Fog::Compute::DigitalOcean::NotFound] - HTTP 404
+        # @raise [Fog::Compute::DigitalOcean::BadRequest] - HTTP 400
+        # @raise [Fog::Compute::DigitalOcean::InternalServerError] - HTTP 500
+        # @raise [Fog::Compute::DigitalOcean::ServiceError]
+        # @see https://developers.digitalocean.com/v1/droplets/
         def get(id)
           server = service.get_server_details(id).body['droplet']
           new(server) if server