vas 0.3.0 → 0.4.0

data/lib/vas/gemfire/locator_live_configurations.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,15 +12,26 @@
 # 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 Gemfire
 
   # Used to enumerate a locator instance's live configuration
   class LocatorLiveConfigurations < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
-      super(location, client, "live-configurations", LocatorConfiguration)
+    # @private
+    def initialize(location, client)
+      super(location, client, "live-configurations", LocatorLiveConfiguration)
+    end
+
+  end
+  
+  # A live configuration file in a locator instance
+  class LocatorLiveConfiguration < Shared::Configuration
+
+    # @private
+    def initialize(location, client)
+      super(location, client, "locator-group-instance", LocatorInstance)
     end
 
   end

data/lib/vas/gemfire/locator_logs.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 Gemfire
 
   # Used to enumerate a locator node instance's logs
   class LocatorLogs < Shared::Logs
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, LocatorLog)
     end
 
@@ -29,7 +29,8 @@ module Gemfire
   # A log file in a locator node instance
   class LocatorLog < Shared::Log
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'locator-node-instance', LocatorNodeInstance)
     end
 

data/lib/vas/gemfire/locator_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 Gemfire
 
   # Used to enumerate locator instances on an individual node
   class LocatorNodeInstances < Shared::NodeInstances
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "locator-node-instances", LocatorNodeInstance)
     end
 
@@ -29,21 +29,22 @@ module Gemfire
   # A locator node instance
   class LocatorNodeInstance < Shared::NodeInstance
 
+    # @private
     def initialize(location, client) #:nodoc:
       super(location, client, Node, LocatorLogs, LocatorInstance, 'locator-group-instance')
     end
 
-    # The port that the locator will listen on
+    # @return [Integer] the port that the locator will listen on
     def port
       client.get(location)['port']
     end
 
-    # +true+ if the locator will act as a peer, +false+ if it will not
+    # @return [Boolean] +true+ if the locator will act as a peer, +false+ if it will not
     def peer
       client.get(location)['peer']
     end
 
-    # +true+ if the locator will act as a server, +false+ if it will not
+    # @return [Boolean] +true+ if the locator will act as a server, +false+ if it will not
     def server
       client.get(location)['server']
     end

data/lib/vas/gemfire/locator_pending_configurations.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,23 +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 Gemfire
 
   # Used to enumerate a locator instance's pending configuration
   class LocatorPendingConfigurations < Shared::PendingConfigurations
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'pending-configurations', LocatorPendingConfiguration)
     end
 
   end
 
-  # A configuration file that is pending
+  # A locator configuration file that is pending
   class LocatorPendingConfiguration < Shared::PendingConfiguration
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'locator-group-instance', LocatorInstance)
     end
 

data/lib/vas/gemfire/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 Gemfire
   
   # Used to enumerate GemFire nodes
   class Nodes < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "nodes", Node)
     end
 
@@ -29,30 +29,29 @@ module Gemfire
   # A GemFire node
   class Node < Shared::GroupableNode
 
-    # The Node's Java home
+    # @return [String] the Node's Java home
     attr_reader :java_home
+    
+    # @return [AgentNodeInstances] the node's agent instances
+    attr_reader :agent_instances
+    
+    # @return [CacheServerInstances] the node's cache server instances
+    attr_reader :cache_server_instances
+    
+    # @return [LocatorNodeInstances] the node's locator instances
+    attr_reader :locator_instances
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Group)
       @java_home = details["java-home"]
+      @agent_instances = AgentNodeInstances.new(Util::LinkUtils.get_link_href(details, "agent-node-instances"), client)
+      @cache_server_instances = CacheServerNodeInstances.new(Util::LinkUtils.get_link_href(details, "cache-server-node-instances"), client)
+      @locator_instances = LocatorNodeInstances.new(Util::LinkUtils.get_link_href(details, "locator-node-instances"), client)
     end
 
-    # The node's agent instances
-    def agent_instances
-      @instances = AgentNodeInstances.new(Util::LinkUtils.get_link_href(details, "agent-node-instances"), client)
-    end
-
-    # The node's cache server instances
-    def cache_server_instances
-      @instances = CacheServerNodeInstances.new(Util::LinkUtils.get_link_href(details, "cache-server-node-instances"), client)
-    end
-
-    # The node's locator instances
-    def locator_instances
-      @instances = LocatorNodeInstances.new(Util::LinkUtils.get_link_href(details, "locator-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
 

data/lib/vas/gemfire/pending_application_codes.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 Gemfire
 
   # Used to enumerate, create, and delete a cache server's pending application code.
   class PendingApplicationCodes < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "pending-application-code", ApplicationCode)
     end
 
-    # Creates pending application code from the +image+
+    # Creates a new pending application code
+    #
+    # @param image [ApplicationCodeImage] the image to create the application code from
+    #
+    # @return [ApplicationCode] the new application code
     def create(image)
       ApplicationCode.new(client.post(location, { :image => image.location}), client)
     end

data/lib/vas/gemfire/statistics.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,13 +12,14 @@
 # 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 Gemfire
 
   # Used to enumerate and delete a cache server's statistics.
   class Statistics < Shared::MutableCollection
 
+    # @private
     def initialize(location, client)
       super(location, client, 'statistics', Statistic)
     end
@@ -29,34 +29,42 @@ module Gemfire
   # A statistic of a cache server
   class Statistic < Shared::Resource
 
-    # The last modified time of the disk store
-    attr_reader :last_modified
-
-    # The path of statistic
+    # @return [String] the path of statistic
     attr_reader :path
 
-    # The size of the statistic
-    attr_reader :size
-
-    # The statistic's cache server node instance
+    # @return [CacheServerNodeInstance] The statistic's cache server node instance
     attr_reader :instance
 
+    # @private
     def initialize(location, client)
       super(location, client)
 
-      @last_modified = details['last-modified']
       @path = details['path']
-      @size = details['size']
 
       @instance = CacheServerNodeInstance.new(Util::LinkUtils.get_link_href(details, 'cache-server-node-instance'), client)
       @content_location = Util::LinkUtils.get_link_href(details, 'content')
     end
+    
+    # @return [Integer] the size of the statistic
+    def size
+      client.get(location)['size']
+    end
+
+    # @return [Integer] the last modified stamp of the statistic
+    def last_modified
+      client.get(location)['last-modified']
+    end
 
-    # Retrieves the statistic's content and passes it to the +block+
+    # Retrieves the statistic's content
+    #
+    # @yield [chunk] a chunk of the statistic's content
+    #
+    # @return [void]
     def content(&block)
       client.get_stream(@content_location, &block)
     end
 
+    # @return [String] a string representation of the statistic
     def to_s
       "#<#{self.class} path='#@path'>"
     end

data/lib/vas/rabbitmq/groups.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,26 +12,28 @@
 # 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 RabbitMq
 
-  # Used to enumerate, create, and delete Rabbit groups.
+  # Used to enumerate, create, and delete RabbitMQ groups.
   class Groups < Shared::Groups
 
-    def initialize(location, client) #:nodoc:#
+    # @private
+    def initialize(location, client)
       super(location, client, Group)
     end
 
   end
 
-  # A Rabbit group
+  # A RabbitMQ group
   class Group < Shared::Group
 
-    # The group's instances
+    # @return [Instances] 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/rabbitmq/installation_images.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,23 +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 RabbitMq
 
-  # Used to enumerate, create, and delete Rabbit installation images.
+  # Used to enumerate, create, and delete RabbitMQ installation images.
   class InstallationImages < Shared::InstallationImages
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, InstallationImage)
     end
 
   end
   
-  # A Rabbit installation image
+  # A RabbitMQ installation image
   class InstallationImage < Shared::InstallationImage
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Installation)
     end
 

data/lib/vas/rabbitmq/installations.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,27 +12,29 @@
 # 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 RabbitMq
 
-  # Used to enumerate, create, and delete Rabbit installations.
+  # Used to enumerate, create, and delete RabbitMQ installations
   class Installations < Shared::Installations
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Installation)
     end
     
   end
   
-  # A Rabbit installation
+  # A RabbitMQ installation
   class Installation < Shared::Installation
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, InstallationImage, Group)
     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