vas 0.3.0 → 0.4.0

data/lib/vas/rabbitmq/instances.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,18 +12,24 @@
 # 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 instances.
+  # Used to enumerate, create, and delete RabbitMQ 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+.
+    # Creates a new instance
+    #
+    # @param installation [Installation] the installation to be used by the instance
+    # @param name [String] the name of the instance
+    #
+    # @return  [Instance] the new instance
     def create(installation, name)
       payload = { :installation => installation.location, :name => name }
       Instance.new(client.post(location, payload, "group-instance"), client)
@@ -32,19 +37,24 @@ module RabbitMq
 
   end
 
-  # A Rabbit instance
+  # A RabbitMQ instance
   class Instance < Shared::Instance
 
-    # The instance's plugins
+    # @return [Plugins] the instance's plugins
     attr_reader :plugins
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Group, Installation, LiveConfigurations, PendingConfigurations, NodeInstance, 'node-instance')
       @plugins = Plugins.new(Util::LinkUtils.get_link_href(details, "plugins"), client)
     end
 
-    # Updates the instance to use the given +installation+
-    def update(installation, runtime_version = nil)
+    # Updates the instance to use a different installation
+    #
+    # @param installation [Installation] the installation that the instance should use
+    #
+    # @return [void]
+    def update(installation)
       client.post(location, { :installation => installation.location });
     end
 

data/lib/vas/rabbitmq/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 RabbitMq
 
-  # Used to enumerate an instance's live configuration
+  # Used to enumerate a RabbitMQ instance's live configuration
   class LiveConfigurations < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
-      super(location, client, "live-configurations", Configuration)
+    # @private
+    def initialize(location, client)
+      super(location, client, "live-configurations", LiveConfiguration)
+    end
+
+  end
+  
+  # A live configuration file in a RabbitMQ instance
+  class LiveConfiguration < Shared::Configuration
+
+    # @private
+    def initialize(location, client)
+      super(location, client, "group-instance", Instance)
     end
 
   end

data/lib/vas/rabbitmq/logs.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 a tRabbit instance's logs
+  # Used to enumerate a RabbitMQ node instance's logs
   class Logs < Shared::Logs
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Log)
     end
 
   end
 
-  # A log file in a Rabbit node instance
+  # A log file in a RabbitMQ node instance
   class Log < Shared::Log
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'node-instance', NodeInstance)
     end
 

data/lib/vas/rabbitmq/node_instances.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 Rabbit instances on an individual node
+  # Used to enumerate RabbitMQ 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
 
   end
 
-  # A Rabbit node instance
+  # A RabbitMQ node instance
   class NodeInstance < Shared::NodeInstance
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Node, Logs, Instance, 'group-instance')
     end
 

data/lib/vas/rabbitmq/nodes.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,35 +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 RabbitMq
   
-  # Used to enumerate Rabbit nodes
+  # Used to enumerate RabbitMQ nodes
   class Nodes < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "nodes", Node)
     end
 
   end
 
-  # A Rabbit node
+  # A RabbitMQ node
   class Node < Shared::GroupableNode
+    
+    # @return [NodeInstances] the node's instances
+    attr_reader :instances
 
-    # The Node's Java home
-    attr_reader :java_home
-
-    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
 

data/lib/vas/rabbitmq/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 RabbitMq
 
-  # Used to enumerate an instance's pending configuration
+  # Used to enumerate a RabbitMQ 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
 
   end
 
-  # A configuration file that is pending
+  # A RabbitMQ instance's 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/rabbitmq/plugin_images.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 RabbitMq
 
-  # Used to enumerate, create, and delete Rabbit plugin images
+  # Used to enumerate, create, and delete RabbitMQ plugin images
   class PluginImages < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "plugin-images", PluginImage)
     end
     
-    # Creates a plugin image by uploading the file at the given +path+
+    # Creates a new plugin image by uploading a file
+    #
+    # @param path [String] the path of the plugin +.ez+ file to upload
+    #
+    # @return [PluginImage] the new plugin image
     def create(path)
       PluginImage.new(client.post_image(location, path), client)
     end
@@ -43,7 +47,8 @@ module RabbitMq
     # The plugin image's size
     attr_reader :size
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
 
       @name = details["name"]
@@ -51,14 +56,15 @@ module RabbitMq
       @size = details['size']
     end
 
-    # The plugins that have been created from this plugin image
+    # @return [Plugin[]] the plugins that have been created from this plugin image
     def plugins
       plugins = []
       Util::LinkUtils.get_link_hrefs(client.get(location), "plugin").each { |plugin_location| plugins << Plugin.new(plugin_location, client)}
       plugins
     end
 
-    def to_s #:nodoc:
+    # @return [String] a string representation of the plugin image
+    def to_s
       "#<#{self.class} name='#@name' version='#@version'>"
     end
 

data/lib/vas/rabbitmq/plugins.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,11 +12,11 @@
 # 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 plugins.
+  # Used to enumerate, create, and delete plugins
   class Plugins < Shared::MutableCollection
     
     def initialize(location, client) #:nodoc:
@@ -31,53 +30,55 @@ module RabbitMq
     
   end
 
-  # A plugin in a Rabbit instance
+  # A plugin in a RabbitMQ instance
   class Plugin < Shared::Resource
 
-    # The plugin's version
+    # @return [String] the plugin's version
     attr_reader :version
 
-    # The plugin's name
+    # @return [String] the plugin's name
     attr_reader :name
     
-    def initialize(location, client) #:nodoc:
+    # @return [Instance] the instance that contains the plugin
+    attr_reader :instance
+    
+    # @return [PluginImage] the plugin image, if any, that was used to create the plugin
+    attr_reader :plugin_image
+    
+    # @private
+    def initialize(location, client)
       super(location, client)
       
       @name = details['name']
       @version = details['version']
-      @plugin_image_location = Util::LinkUtils.get_link_href(details, 'plugin-image')
-      @instance_location = Util::LinkUtils.get_link_href(details, 'group-instance')
+      @instance = Instance.new(Util::LinkUtils.get_link_href(details, 'group-instance'), client)
       @state_location = Util::LinkUtils.get_link_href(details, 'state')
+      
+      plugin_image_location = Util::LinkUtils.get_link_href(details, 'plugin-image')
+      @plugin_image = PluginImage.new(plugin_image_location, client) unless plugin_image_location.nil?
     end
 
-    # The plugin image, if any, that was used to create the plugin
-    def plugin_image
-      if (!@plugin_image_location.nil?)
-        PluginImage.new(@plugin_image_location, client)
-      end
-    end
-
-    # The instance that contains the plugin
-    def instance
-      Instance.new(@instance_location, client)
-    end
-
-    # The state of the plugin
+    # @return [String] the state of the plugin
     def state
       client.get(@state_location)['status']
     end
 
     # Enables the plugin
+    #
+    # @return [void]
     def enable
       client.post(@state_location, { :status => 'ENABLED' })
     end
 
     # Disables the plugin
+    #
+    # @return [void]
     def disable
       client.post(@state_location, { :status => 'DISABLED' })
     end
     
-    def to_s #:nodoc:
+    # @return [String] a string representation of the plugin
+    def to_s
       "#<#{self.class} name='#@name' version='#@version'>"
     end
   end

data/lib/vas/rabbitmq/rabbitmq.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,24 +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.
-#++
 
+
+# API for administering RabbitMQ
 module RabbitMq
 
+  # The entry point to the API for administering RabbitMQ
   class RabbitMq
-    # The Rabbit groups
+    
+    # @return [Groups] the RabbitMQ groups
     attr_reader :groups
 
-    # The Rabbit installation images
+    # @return [InstallationImages] the RabbitMQ installation images
     attr_reader :installation_images
 
-    # The Rabbit plugin images
+    # @return [PluginImages] the RabbitMQ plugin images
     attr_reader :plugin_images
 
-    # The Rabbit nodes
+    # @return [Nodes] the RabbitMQ nodes
     attr_reader :nodes
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
 
       json = client.get(location)