servers.rb in fog-maestrodev-1.14.0.20130806165225

- old
+ new
@@ -7,21 +7,54 @@
 
       class Servers < Fog::Collection
 
         model Fog::Compute::RackspaceV2::Server
 
-        def all
+        # Returns list of servers 
+        # @return [Fog::Compute::RackspaceV2::Servers] Retrieves a list servers.
+        # @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404
+        # @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400
+        # @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500
+        # @raise [Fog::Compute::RackspaceV2::ServiceError]
+        # @note Fog's current implementation only returns 1000 servers
+        # @note The filter parameter on the method is just to maintain compatability with other providers that support filtering.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Servers-d1e2078.html
+        def all(filters = {})
           data = service.list_servers.body['servers']
           load(data)
         end
 
+        # Creates a new server and populates ssh keys
+        # @return [Fog::Compute::RackspaceV2::Server]
+        # @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404
+        # @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400
+        # @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500
+        # @raise [Fog::Compute::RackspaceV2::ServiceError]
+        # @note This method is incompatible with Cloud Servers utlizing RackConnect. RackConnect users 
+        #     should use server personalization to install keys.  Please see Server#personality for more information.
+        # @example
+        #   service.servers.bootstrap :name => 'bootstrap-server',
+        #                             :flavor_id => service.flavors.first.id,
+        #                             :image_id => service.images.find {|img| img.name =~ /Ubuntu/}.id,
+        #                             :public_key_path => '~/.ssh/fog_rsa.pub',
+        #                             :private_key_path => '~/.ssh/fog_rsa'
+        #
+        # @raise [Fog::Compute::RackspaceV2::InvalidServerStateException] if server state is an error state
         def bootstrap(new_attributes = {})
           server = create(new_attributes)
-          server.wait_for { ready? }
+          server.wait_for(1500) { ready? && !public_ip_address.empty? }
           server.setup(:password => server.password)
           server
         end
 
+        # Retrieves server
+        # @param [String] server_id for server to be returned
+        # @return [Fog::Compute::RackspaceV2:Server]
+        # @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404
+        # @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400
+        # @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500
+        # @raise [Fog::Compute::RackspaceV2::ServiceError]
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Server_Details-d1e2623.html
         def get(server_id)
           data = service.get_server(server_id).body['server']
           new(data)
         rescue Fog::Compute::RackspaceV2::NotFound
           nil