vas 0.3.0 → 0.4.0

data/lib/vas/tc_server/groups.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, create, and delete tc Server groups.
+  # Used to enumerate, create, and delete tc Server groups
   class Groups < Shared::Groups
 
-    def initialize(location, client) #:nodoc:#
+    # @private
+    def initialize(location, client)
       super(location, client, Group)
     end
 
@@ -31,8 +31,9 @@ module TcServer
 
     # The group's instances
     attr_reader :instances
-
-    def initialize(location, client) #:nodoc:#
+    
+    # @private
+    def initialize(location, client)
       super(location, client, Node, Installations)
       @instances = Instances.new(Util::LinkUtils.get_link_href(details, "group-instances"), client)
     end

data/lib/vas/tc_server/installation_images.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, create, and delete tc Server installation images.
   class InstallationImages < Shared::InstallationImages
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, InstallationImage)
     end
 
@@ -29,7 +29,8 @@ module TcServer
   # A tc Server installation image
   class InstallationImage < Shared::InstallationImage
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Installation)
     end
 

data/lib/vas/tc_server/installations.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, create, and delete tc Server installations.
   class Installations < Shared::Installations
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Installation)
     end
     
@@ -29,22 +29,21 @@ module TcServer
   # A tc Server installation
   class Installation < Shared::Installation
 
-    # The versions of the tc Server runtime that are supported by the installation
+    # @return [String[]] the versions of the tc Server runtime that are supported by the installation
     attr_reader :runtime_versions
+    
+    # @return [Templates] the installation's templates
+    attr_reader :templates
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, InstallationImage, Group)
 
       @runtime_versions = details["runtime-versions"]
-      @templates_location = Util::LinkUtils.get_link_href(details, "templates")
-    end
-    
-    # The installation's templates
-    def templates
-      Templates.new(@templates_location, client)
+      @templates = Templates.new(Util::LinkUtils.get_link_href(details, "templates"), client)
     end
 
-    # An array of the instances that are using the installation
+    # @return [Instance[]] the instances that are using the installation
     def instances
       retrieve_instances("group-instance", Instance);
     end

data/lib/vas/tc_server/instances.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,30 +12,33 @@
 # 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 instances.
   class Instances < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "group-instances", Instance)
     end
 
-    # Creates a new instance named +name+, using the Installation +installation+.
-    # Creation can be customized using +options+.
+    # Creates a new instance
+    #
+    # @param installation [Installation] the installation to be used by the instance
+    # @param name [String] the name of the instance
+    # @param options [Hash] optional configuration
     #
-    # Recognized options are:
+    # @option options :properties [Hash] configuration properties that customise the instance
+    # @option options :runtime_version [String] the version of the runtime to be used by the 
+    #   instance. Must be one of the +runtime_versions+ available in the +installation+.
+    #   Defaults to the latest version that is available in the installation
+    # @option options :templates [Template[]] the templates to use when creating the instance
+    # @option options :layout [String] the layout to use when creating the instance. Valid
+    #   values are +COMBINED+ and +SEPARATE+. Defaults to +SEPARATE+
     #
-    # properties::      A hash of properties
-    # runtime_version:: The version of the runtime to be used by the instance.
-    #                   Must be one of the runtime_versions available in the Installation.
-    #                   Defaults to the latest available version.
-    # templates::       An array of templates to use when creating the instance. Each Template
-    #                   must be present in the Installation.
-    # layout::          The layout to use when creating the instance. Valid values are +COMBINED+
-    #                   and +SEPARATE+. Defaults to +SEPARATE+.
+    # @return [Instance] the new instance
     def create(installation, name, options = {})
       payload = { :installation => installation.location, :name => name }
       
@@ -66,19 +68,20 @@ module TcServer
   # A tc Server instance
   class Instance < Shared::Instance
     
-    # The instance's layout
+    # @return [String] the instance's layout
     attr_reader :layout
     
-    # The version of runtime used by the instance
+    # @return [String] the version of runtime used by the instance
     attr_reader :runtime_version
     
-    # The instance's services
+    # @return [Hash] the instance's services
     attr_reader :services
 
-    # The instance's Applications
+    # @return [Applications] the instance's applications
     attr_reader :applications
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Group, Installation, LiveConfigurations, PendingConfigurations, NodeInstance, 'node-instance')
 
       @layout = details["layout"]
@@ -88,7 +91,12 @@ module TcServer
 
     end
 
-    # Updates the instance to use the given +installation+ and, optionally, to use the given +runtime_version+
+    # Updates the installation and, optionally, the runtime_version used by the instance
+    #
+    # @param installation [Installation] the installation to be used by the instance
+    # @param runtime_version [String] the version of the runtime to be used by the instance
+    #
+    # @return [void]
     def update(installation, runtime_version = nil)
       payload = { :installation => installation.location }
       if (!runtime_version.nil?)

data/lib/vas/tc_server/live_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 live configuration
   class LiveConfigurations < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "live-configurations", Configuration)
     end
 

data/lib/vas/tc_server/logs.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,7 +12,7 @@
 # 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
 

data/lib/vas/tc_server/node_applications.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,41 +12,46 @@
 # 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 a NodeInstance's NodeApplication s
+  # Used to enumerate a node instance's applications
   class NodeApplications < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "applications", NodeApplication)
     end
 
   end
 
-  # A node application
+  # An application on a node instance
   class NodeApplication < Shared::Resource
 
-    # The application's context path
+    # @return [String] the application's context path
     attr_reader :context_path
 
-    # The application's name
+    # @return [String] the application's name
     attr_reader :name
 
-    # The service the application will deploy its revisions to
+    # @return [String] the service the application will deploy its revisions to
     attr_reader :service
 
-    # The host the application will deploy its revisions to
+    # @return [String] the host the application will deploy its revisions to
     attr_reader :host
 
-    # The application's NodeRevisions
+    # @return [NodeRevisions] the application's revisions
     attr_reader :revisions
 
-    # The Application that this node application is a member of
+    # @return [Application] the application that this node application is a member of
     attr_reader :group_application
+    
+    # @return [NodeInstance] the node instance that contains the application
+    attr_reader :instance
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
 
       @revisions = NodeRevisions.new(Util::LinkUtils.get_link_href(details, "node-revisions"), client)
@@ -57,17 +61,13 @@ module TcServer
       @service = details["service"]
       @host = details["host"]
 
-      @instance_location = Util::LinkUtils.get_link_href(details, "node-instance")
+      @instance = NodeInstance.new(Util::LinkUtils.get_link_href(details, "node-instance"), client)
 
       @group_application = Application.new(Util::LinkUtils.get_link_href(details, "group-application"), client)
     end
 
-    # The node instance that contains the application
-    def instance
-      NodeInstance.new(@instance_location, client)
-    end
-
-    def to_s #:nodoc:
+    # @return [String] a string representation of the node application
+    def to_s
       "#<#{self.class} name='#@name' context_path='#@context_path' service='#@service' host='#@host'>"
     end
 

data/lib/vas/tc_server/node_instances.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 tc Server instances on an individual node
   class NodeInstances < Shared::NodeInstances
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "node-instances", NodeInstance)
     end
 
@@ -29,19 +29,20 @@ module TcServer
   # A tc Server node instance
   class NodeInstance < Shared::NodeInstance
     
-    # The instance's layout
+    # @return [String] the instance's layout
     attr_reader :layout
     
-    # The version of runtime used by the instance
+    # @return [String] the version of runtime used by the instance
     attr_reader :runtime_version
     
-    # The instance's services
+    # @return [Hash] the instance's services
     attr_reader :services
 
-    # The instance's NodeApplications
+    # @return [NodeApplications] the instance's applications
     attr_reader :applications
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Node, Logs, Instance, 'group-instance')
 
       @layout = details["layout"]

data/lib/vas/tc_server/node_revisions.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,32 +12,34 @@
 # 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 Node Revision s
+  # Used to enumerate revisions of a node application
   class NodeRevisions < Shared::Collection
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'revisions', NodeRevision)
     end
     
   end
 
-  # A revision of a NodeApplication
+  # A revision of a node application
   class NodeRevision < Shared::StateResource
 
-    # The Revision's version
+    # @return [String] the revision's version
     attr_reader :version
 
-    # The Revision's application
+    # @return [NodeApplication] the revision's application
     attr_reader :application
 
-    # The revision's group revision
+    # @return [Revision] the group revision that this node revision is a member of
     attr_reader :group_revision
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
       
       @version = details['version']
@@ -46,7 +47,8 @@ module TcServer
       @group_revision = Revision.new(Util::LinkUtils.get_link_href(details, 'group-revision'), client)
     end
 
-    def to_s #:nodoc:
+    # @return [String] a string representation of the ndoe revision
+    def to_s
       "#<#{self.class} version='#@version'>"
     end
 

data/lib/vas/tc_server/nodes.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 tc Server nodes
   class Nodes < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "nodes", Node)
     end
 
@@ -29,19 +29,21 @@ module TcServer
   # A tc Server node
   class Node < Shared::GroupableNode
 
-    # The Node's Java home
+    # @return [String] the node's Java home
     attr_reader :java_home
+    
+    # @return [NodeInstances] the node's instances
+    attr_reader :instances
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Group)
       @java_home = details["java-home"]
-    end
-
-    def instances
       @instances = NodeInstances.new(Util::LinkUtils.get_link_href(details, "node-instances"), client)
     end
     
-    def to_s #:nodoc:
+    # @return [String] a string representation of the node
+    def to_s
       "#<#{self.class} host_names='#{host_names}' ip_addresses='#{ip_addresses}' operating_system='#{operating_system}' architecture='#{architecture}' agent_home='#{agent_home}' java_home='#{java_home}' metadata='#{metadata}'>"
     end