vas 0.3.0 → 0.4.0

data/README.md

@@ -13,13 +13,33 @@ The VAS Ruby API requires Ruby 1.8.7 or 1.9.x. It has been built and tested on 1
 
 ## Installation
 
-The VAS Ruby API is not yet available on [RubyGems](https://rubygems.org/). However, pre-built
-gems can be [downloaded](https://github.com/vFabric/vas-ruby-api/downloads) and installed. For
-example:
+The VAS Ruby API is available on [RubyGems](https://rubygems.org/gems/vas). To install it run:
 
-	gem install vas-<version>.gem
+	gem install vas
 
-## Licence
+## Getting started
+
+### Examples
+
+A number of [examples](https://github.com/vFabric/vas-ruby-api/tree/master/examples) are provided:
+
+#### tc Server
+
+* [Provision tc Server and deploy a web application](https://github.com/vFabric/vas-ruby-api/tree/master/examples/tc-server/web-application)
+
+#### RabbitMQ
+
+* [Provision Rabbit and enable the management plugin](https://github.com/vFabric/vas-ruby-api/tree/master/examples/rabbitmq/management-plugin)
+
+#### VAS
+
+* [Download, install, and start the VAS agent](https://github.com/vFabric/vas-ruby-api/tree/master/examples/rabbitmq/management-plugin)
+
+### Documentation
+
+You may also like to look at the [API documentation](http://rubydoc.info/gems/vas/0.3.0/frames).
+
+##Licence
 
 The VAS Ruby API is licensed under the [Apache Licence, Version 2.0][asl2].
 

data/lib/vas.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.
-#++
+
 
 require 'json'
 require 'net/http'
@@ -29,11 +28,10 @@ require 'vas/shared/installation_images'
 require 'vas/shared/pending_configuration'
 require 'vas/shared/security'
 require 'vas/shared/state_resource'
-require 'vas/shared/instances'
+require 'vas/shared/instance'
 require 'vas/shared/logs'
 require 'vas/shared/node_instances'
 require 'vas/shared/nodes'
-require 'vas/gemfire/agent_configuration'
 require 'vas/gemfire/agent_instances'
 require 'vas/gemfire/agent_live_configurations'
 require 'vas/gemfire/agent_logs'
@@ -41,7 +39,6 @@ require 'vas/gemfire/agent_node_instances'
 require 'vas/gemfire/agent_pending_configurations'
 require 'vas/gemfire/application_code_images'
 require 'vas/gemfire/application_code'
-require 'vas/gemfire/cache_server_configuration'
 require 'vas/gemfire/cache_server_instances'
 require 'vas/gemfire/cache_server_live_configurations'
 require 'vas/gemfire/cache_server_logs'
@@ -53,7 +50,6 @@ require 'vas/gemfire/groups'
 require 'vas/gemfire/installation_images'
 require 'vas/gemfire/installations'
 require 'vas/gemfire/live_application_codes'
-require 'vas/gemfire/locator_configuration'
 require 'vas/gemfire/locator_instances'
 require 'vas/gemfire/locator_live_configurations'
 require 'vas/gemfire/locator_logs'
@@ -62,7 +58,6 @@ require 'vas/gemfire/locator_pending_configurations'
 require 'vas/gemfire/nodes'
 require 'vas/gemfire/pending_application_codes'
 require 'vas/gemfire/statistics'
-require 'vas/rabbitmq/configuration'
 require 'vas/rabbitmq/groups'
 require 'vas/rabbitmq/installation_images'
 require 'vas/rabbitmq/plugin_images'

data/lib/vas/gemfire/agent_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 Gemfire
 
   # Used to enumerate, create, and delete agent instances.
   class AgentInstances < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "agent-group-instances", AgentInstance)
     end
 
-    # Creates a new instance named +name+, using the given +installation+.
+    # Creates a new agent instance
+    #
+    # @param installation [Installation] the installation to be used by the instance
+    # @param name [String] the name of the instance
+    # 
+    # @return [AgentInstance] the new agent instance
     def create(installation, name)
       payload = { :installation => installation.location, :name => name }
       AgentInstance.new(client.post(location, payload, "agent-group-instance"), client)
@@ -35,11 +40,16 @@ module Gemfire
   # An agent instance
   class AgentInstance < Shared::Instance
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Group, Installation, AgentLiveConfigurations, AgentPendingConfigurations, AgentNodeInstance, 'agent-node-instance')
     end
 
-    # Updates the instance to use the given +installation+
+    # 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/gemfire/agent_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 an agent instance's live configuration
   class AgentLiveConfigurations < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
-      super(location, client, "live-configurations", AgentConfiguration)
+    # @private
+    def initialize(location, client)
+      super(location, client, "live-configurations", AgentLiveConfiguration)
+    end
+
+  end
+  
+  # A live configuration file in an agent instance
+  class AgentLiveConfiguration < Shared::Configuration
+    
+    # @private
+    def initialize(location, client)
+      super(location, client, "agent-group-instance", AgentInstance)
     end
 
   end

data/lib/vas/gemfire/agent_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 an agent node instance's logs
   class AgentLogs < Shared::Logs
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, AgentLog)
     end
 
@@ -29,7 +29,8 @@ module Gemfire
   # A log file in an agent node instance
   class AgentLog < Shared::Log
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'agent-node-instance', AgentNodeInstance)
     end
 

data/lib/vas/gemfire/agent_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 agent instances on an individual node
   class AgentNodeInstances < Shared::NodeInstances
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "agent-node-instances", AgentNodeInstance)
     end
 
@@ -29,7 +29,8 @@ module Gemfire
   # An agent node instance
   class AgentNodeInstance < Shared::NodeInstance
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Node, AgentLogs, AgentInstance, 'agent-group-instance')
     end
 

data/lib/vas/gemfire/agent_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 Gemfire
 
   # Used to enumerate an agent instance's pending configuration
   class AgentPendingConfigurations < Shared::PendingConfigurations
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'pending-configurations', AgentPendingConfiguration)
     end
 
@@ -29,7 +29,8 @@ module Gemfire
   # A configuration file that is pending
   class AgentPendingConfiguration < Shared::PendingConfiguration
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'agent-group-instance', AgentInstance)
     end
 

data/lib/vas/gemfire/application_code.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,25 +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
 
   # Application code in a cache server instance
   class ApplicationCode < Shared::Resource
 
-    # The name of the application code
+    # @return [String] the name of the application code
     attr_reader :name
 
-    # The version of the application code
+    # @return [String] the version of the application code
     attr_reader :version
 
-    # The image that was used to create this application code
+    # @return [ApplicationCodeImage] the image that was used to create the application code
     attr_reader :application_code_image
 
-    # The cache server instance that contains this application code
+    # @return [CacheServerInstance] the cache server instance that contains the application code
     attr_reader :instance
 
+    # @private
     def initialize(location, client)
       super(location, client)
 
@@ -45,6 +45,7 @@ module Gemfire
           Util::LinkUtils.get_link_href(details, 'cache-server-group-instance'), client)
     end
 
+    # @return [String] a string representation of the application code
     def to_s #:nodoc:
       "#<#{self.class} name='#@name' version=#@version>"
     end

data/lib/vas/gemfire/application_code_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 Gemfire
 
   # Used to enumerate, create, and delete GemFire application code images.
   class ApplicationCodeImages < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "application-code-images", ApplicationCodeImage)
     end
     
-    # Creates an application code image named +name+ with the version +version+ by uploading the file at the given +path+
+    # Creates a new application code image by uploading a file and assigning it a name and version
+    #
+    # @param path [String] the path of the file to upload
+    # @param name [String] the name of the application code
+    # @param version [String] the version of the application code
+    #
+    # @return [ApplicationCodeImage] the new application code image
     def create(path, name, version)
       ApplicationCodeImage.new(client.post_image(location, path, { :name => name, :version => version }), client)
     end
@@ -34,16 +40,17 @@ module Gemfire
   # An application code image
   class ApplicationCodeImage < Shared::Resource
 
-    # The application code image's name
+    # @return [String] the application code image's name
     attr_reader :name
 
-    # The application code image's version
+    # @return [String] the application code image's version
     attr_reader :version
 
-    # The application code image's size
+    # @return [String] the application code image's size
     attr_reader :size
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
 
       @name = details['name']
@@ -51,7 +58,7 @@ module Gemfire
       @size = details['size']
     end
 
-    # An array of the live application code that has been created from this application code image
+    # @return [ApplicationCode[]] the live application code that has been created from this application code image
     def live_application_code
       application_codes = []
       Util::LinkUtils.get_link_hrefs(client.get(location), "live-application-code").each {
@@ -59,7 +66,7 @@ module Gemfire
       application_codes
     end
 
-    # An array of the pending application code that has been created from this application code image
+    # @return [ApplicationCode[]] the pending application code that has been created from this application code image
     def pending_application_code
       application_codes = []
       Util::LinkUtils.get_link_hrefs(client.get(location), "pending-application-code").each {
@@ -67,7 +74,8 @@ module Gemfire
       application_codes
     end
 
-    def to_s #:nodoc:
+    # @return [String] a string representation of the application code image
+    def to_s
       "#<#{self.class} name='#@name' version='#@version'>"
     end
 

data/lib/vas/gemfire/cache_server_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 Gemfire
 
   # Used to enumerate, create, and delete cache server instances.
   class CacheServerInstances < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "cache-server-group-instances", CacheServerInstance)
     end
 
-    # Creates a new instance named +name+, using the given +installation+.
+    # Creates a new cache server instance
+    #
+    # @param installation [Installation] the installation to be used by the instance
+    # @param name [String] the name of the instance
+    #
+    # @return [CacheServerInstance] the new cache server instance
     def create(installation, name)
       payload = { :installation => installation.location, :name => name }
       CacheServerInstance.new(client.post(location, payload, "cache-server-group-instance"), client)
@@ -35,19 +40,24 @@ module Gemfire
   # A cache server instance
   class CacheServerInstance < Shared::Instance
 
-    # The instance's live application code
+    # @return [LiveApplicationCodes] the instance's live application code
     attr_reader :live_application_code
 
-    # The instance's pending application code
+    # @return [PendingApplicationCodes] the instance's pending application code
     attr_reader :pending_application_code
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Group, Installation, CacheServerLiveConfigurations, CacheServerPendingConfigurations, CacheServerNodeInstance, 'cache-server-node-instance')
       @live_application_code = LiveApplicationCodes.new(Util::LinkUtils.get_link_href(details, 'live-application-code'), client)
       @pending_application_code = PendingApplicationCodes.new(Util::LinkUtils.get_link_href(details, 'pending-application-code'), client)
     end
 
-    # Updates the instance to use the given +installation+
+    # 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