vas 0.3.0 → 0.4.0

data/lib/vas/tc_server/pending_configurations.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,14 +12,15 @@
 # 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 TcServer
 
   # Used to enumerate an instance's pending configuration
   class PendingConfigurations < Shared::PendingConfigurations
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'pending-configurations', PendingConfiguration)
     end
 
@@ -29,7 +29,8 @@ module TcServer
   # A configuration file that is pending
   class PendingConfiguration < Shared::PendingConfiguration
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'group-instance', Instance)
     end
 

data/lib/vas/tc_server/revision_images.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,18 +12,25 @@
 # 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 TcServer
 
   # Used to enumerate, create, and delete tc Server revision images.
   class RevisionImages < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "revision-images", RevisionImage)
     end
     
-    # Creates a RevisionImage named +name+ with the version +version+ by uploading the WAR file at the given +path+
+    # Creates a new revision image by uploading a war file to the server
+    #
+    # @param path [String] the path of the WAR file
+    # @param name [String] the name of the revision image
+    # @param version [String] the version of the revision image
+    #
+    # @return [RevisionImage] the new revision image
     def create(path, name, version)
       RevisionImage.new(client.post_image(location, path, { :name => name, :version => version }), client)
     end
@@ -34,16 +40,17 @@ module TcServer
   # A revision image, i.e. a WAR file
   class RevisionImage < Shared::Resource
 
-    # The revision image's name
+    # @return [String] the revision image's name
     attr_reader :name
 
-    # The revision image's version
+    # @return [String] the revision image's version
     attr_reader :version
 
-    # The revision image's size
+    # @return [Integer] the revision image's size
     attr_reader :size
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
 
       @name = details["name"]
@@ -51,15 +58,16 @@ module TcServer
       @size = details['size']
     end
 
-    # The revisions that have been created from this revision image
+    # @return [Revision[]] the revisions that have been created from this revision image
     def revisions
       revisions = []
       Util::LinkUtils.get_link_hrefs(client.get(location), "group-revision").each { |revision_location| revisions << Revision.new(revision_location, client)}
       revisions
     end
 
-    def to_s #:nodoc:
-      "#<#{self.class} name='#@name' version='#@version'>"
+    # @return [String] a string representation of the revision image
+    def to_s
+      "#<#{self.class} name='#@name' version='#@version' size='#@size'>"
     end
 
   end

data/lib/vas/tc_server/revisions.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,49 +12,53 @@
 # 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 TcServer
 
   # Used to enumerate, create, and delete application revisions.
   class Revisions < Shared::MutableCollection
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "revisions", Revision)
     end
 
-    # Creates a Revision by deploying the RevisionImage +revision_image+
+    # Creates a revision by deploying the revision image
+    #
+    # @param revision_image [RevisionImage] the revision image to deploy
+    #
+    # @return [Revision] the new revision
     def create(revision_image)
       Revision.new(client.post(location, { :image => revision_image.location}, 'group-revision'), client)
     end
     
   end
 
-  # A revision of an Application
+  # A revision of an application
   class Revision < Shared::StateResource
 
-    # The Revision's version
+    # @return [String] the revision's version
     attr_reader :version
 
-    # The Revision's application
+    # @return [Application] the revision's application
     attr_reader :application
     
-    def initialize(location, client) #:nodoc:
+    # @return [RevisionImage] the revision image, if any, that was used to create the revision
+    attr_reader :revision_image
+    
+    # @private
+    def initialize(location, client)
       super(location, client)
       
       @version = details['version']
-      @revision_image_location = Util::LinkUtils.get_link_href(details, 'revision-image')
       @application = Application.new(Util::LinkUtils.get_link_href(details, 'group-application'), client)
+      
+      revision_image_location = Util::LinkUtils.get_link_href(details, 'revision-image')
+      @revision_image = RevisionImage.new(revision_image_location, client) unless revision_image_location.nil?
     end
 
-    # The revision image, if any, that was used to create the revision
-    def revision_image
-      if (!@revision_image_location.nil?)
-        RevisionImage.new(@revision_image_location, client)
-      end
-    end
-
-    # An array of the revision's individual node revisions
+    # @return [NodeRevision[]] the revision's node revisions
     def node_revisions
       node_revisions = []
       Util::LinkUtils.get_link_hrefs(client.get(location), 'node-revision').each {
@@ -63,7 +66,8 @@ module TcServer
       node_revisions
     end
     
-    def to_s #:nodoc:
+    # @return [String] a string representation of the revision
+    def to_s
       "#<#{self.class} version='#@version'>"
     end
   end

data/lib/vas/tc_server/tc_server.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,29 +12,31 @@
 # 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.
-#++
 
+
+# API for administering tc Server
 module TcServer
   
   # The entry point to the API for administering tc Server
   class TcServer
 
-    # The tc Server Groups
+    # @return [Groups] the tc Server groups
     attr_reader :groups
 
-    # The tc Server InstallationImages
+    # @return [InstallationImages] the tc Server installation images
     attr_reader :installation_images
 
-    # The tc Server Nodes
+    # @return [Nodes] the tc Server Nodes
     attr_reader :nodes
 
-    # The tc Server RevisionImages
+    # @return [RevisionImages] the tc Server revision images
     attr_reader :revision_images
 
-    # The tc Server TemplateImages
+    # @return [TemplateImages] the tc Server template images
     attr_reader :template_images
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
 
       json = client.get(location)
       

data/lib/vas/tc_server/template_images.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,18 +12,25 @@
 # 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 TcServer
 
   # Used to enumerate, create, and delete tc Server template images.
   class TemplateImages < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "template-images", TemplateImage)
     end
     
-    # Creates a TemplateImage named +name+ with the version +version+ by uploading the file at the given +path+
+    # Creates a new template image by uploading a +.zip+ file to the server
+    #
+    # @param path [String] the path of the template image +.zip+ file
+    # @param name [String] the name of the template image
+    # @param version [String] the version of the template image
+    #
+    # @return [TemplateImage] the new template image
     def create(path, name, version)
       TemplateImage.new(client.post_image(location, path, { :name => name, :version => version }), client)
     end
@@ -34,16 +40,17 @@ module TcServer
   # A template image
   class TemplateImage < Shared::Resource
 
-    # The template image's name
+    # @return [String] the template image's name
     attr_reader :name
 
-    # The template image's version
+    # @return [String] the template image's version
     attr_reader :version
 
-    # The template image's size
+    # @return [String] the template image's size
     attr_reader :size
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
 
       @name = details["name"]
@@ -51,15 +58,16 @@ module TcServer
       @size = details['size']
     end
 
-    # The Template s that have been created from this TemplateImage
+    # @return [Template[]] the templates that have been created from the template image
     def templates
       templates = []
       Util::LinkUtils.get_link_hrefs(client.get(location), "template").each { |template_location| templates << Template.new(template_location, client)}
       templates
     end
 
-    def to_s #:nodoc:
-      "#<#{self.class} name='#@name' version='#@version'>"
+    # @return [String] a string representation of the template image
+    def to_s
+      "#<#{self.class} name='#@name' version='#@version' size='#@size'>"
     end
 
   end

data/lib/vas/tc_server/templates.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,18 +12,23 @@
 # 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 TcServer
 
   # Used to enumerate, create, and delete tc Server templates.
   class Templates < Shared::MutableCollection
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "templates", Template)
     end
     
-    # Creates a template from the +template_image+
+    # Creates a new template
+    #
+    # @param template_image [TemplateImage] the template image to use to create the template
+    #
+    # @return [Template] the new template
     def create(template_image)
       Template.new(client.post(location, { :image => template_image.location }, "template"), client)
     end
@@ -34,34 +38,32 @@ module TcServer
   # A tc Server template
   class Template < Shared::Resource
 
-    # The template's version
+    # @return [String] the template's version
     attr_reader :version
     
-    # The template's name
+    # @return [String] the template's name
     attr_reader :name
 
-    # The template image, if any, that this template was created from
+    # @return [TemplateImage] the template image, if any, that this template was created from
     attr_reader :template_image
 
-    # The template's installation
+    # @return [Installation] the template's installation
     attr_reader :installation
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
 
       @version = details["version"]
       @name = details["name"]
-
-      template_image_location = Util::LinkUtils.get_link_href(details, "template-image")
-      if (!template_image_location.nil?)
-        @template_image = TemplateImage.new(template_image_location, client)
-      end
-
       @installation = Installation.new(Util::LinkUtils.get_link_href(details, 'installation'), client)
 
+      template_image_location = Util::LinkUtils.get_link_href(details, "template-image")
+      @template_image = TemplateImage.new(template_image_location, client) unless template_image_location.nil?
     end
-    
-    def to_s #:nodoc:
+
+    # @return [String] a string representation of the template
+    def to_s
       "#<#{self.class} name='#@name' version='#@version'>"
     end
     

data/lib/vas/util/client.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,10 +12,12 @@
 # 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 Util #:nodoc: all
 
+# @private
+module Util
+
+  # @private
   class Client
   
     TASK_POLLING_INTERVAL = 1

data/lib/vas/util/link_utils.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,10 +12,12 @@
 # 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 Util #:nodoc: all
 
+# @private
+module Util
+
+  # @private
   class LinkUtils
 
     def LinkUtils.get_link_hrefs(json, rel)

data/lib/vas/vas_exception.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,18 +12,19 @@
 # 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.
-#++
+
 
 # Raised to indicate a failure has occurred when communicating with the vFabric Administration Server
 class VasException < RuntimeError
 
-  # The HTTP error code returned by the server
+  # @return [Integer] the HTTP error code returned by the server
   attr_reader :code
 
-  # The error messages, if any, returned by the server
+  # @return [String[]] the error messages, if any, returned by the server
   attr_reader :messages
-  
-  def initialize(messages, code=nil) #:nodoc:
+
+  # @private
+  def initialize(messages, code=nil)
     @code = code
     @messages = messages
   end