vas 0.3.0 → 0.4.0

data/lib/vas/vfabric/agent_image.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,21 +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 VFabric
 
+  # Provides access to the installation image for the vFabric Administration Agent
   class AgentImage < Shared::Resource
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client)
       @content_location = Util::LinkUtils.get_link_href(details, "content")
     end
 
+    # Retrieves the content of the agent installation image (a zip file) from the server
+    #
+    # @yield [chunk] a chunk of the agent image's content
+    #
+    # @return [void]
     def content(&block)
       client.get_stream(@content_location, &block)
     end
 
+    # Downloads and extracts the agent installation image
+    #
+    # @param location [String] the location to extract the agent to
+    #
+    # @return [void]
     def extract_to(location = '.')
       agent_image = Tempfile.open('agent-image.zip') { |temp_file|
         content { |chunk| temp_file << chunk }

data/lib/vas/vfabric/nodes.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,32 +12,39 @@
 # 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 VFabric
   
-  # Used to enumerate VFabric nodes. Support for enumeration is provided by the superclass, Shared::Nodes.
-  class Nodes < Shared::Collection
+  # Used to enumerate VFabric nodes
+  class Nodes < Shared::MutableCollection
 
+    # @private
     def initialize(location, client)
       super(location, client, 'nodes', Node)
     end
 
   end
 
-  # Deletes the Node
-  def delete(entry)
-    client.delete(entry.location)
+  # Deletes the node
+  #
+  # @param node [Node] the node to delete
+  #
+  # @return [void]
+  def delete(node)
+    client.delete(node.location)
   end
 
   # A VFabric node
   class Node < Shared::Node
-
-    def initialize(location, client) #:nodoc:
+  
+    # @private
+    def initialize(location, client)
       super(location, 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}' metadata='#{metadata}'>"
     end
 

data/lib/vas/vfabric/v_fabric.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,17 +12,21 @@
 # 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 general purpose vFabric administration
 module VFabric
 
+  # The entry point of the vFabric API
   class VFabric < Shared::Resource
 
+    # @return [Nodes] the nodes that are known to the server
     attr_reader :nodes
 
+    # @return [AgentImage] the installation image for the vFabric Administration agent
     attr_reader :agent_image
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       json = client.get(location)
       @nodes = Nodes.new(Util::LinkUtils.get_link_href(json, "nodes"), client)
       @agent_image = AgentImage.new(Util::LinkUtils.get_link_href(json, "agent-image"), client)

data/lib/vas/vfabric_administration_server.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,28 +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.
-#++
+
 
 # The main entry point to the vFabric Administration Server API.
 class VFabricAdministrationServer
 
-  # The GemFire API
+  # @return [Gemfire::Gemfire] the GemFire API
   attr_reader :gemfire
 
-  # The Rabbit API
+  # @return [RabbitMq::RabbitMq] the RabbitMQ API
   attr_reader :rabbitmq
 
-  # The tc Server API
+  # @return [TcServer::TcServer] the tc Server API
   attr_reader :tc_server
 
-  # The vFabric API
+  # @return [VFabric::VFabric] the vFabric API
   attr_reader :vfabric
 
-  # Creates an entry point that will connect to a vFabric Administration Server. Supported configuration options are:
-  # host:: The host of the Administration Server. Defaults to localhost.
-  # port:: The HTTPS port of the Administration Server. Defaults to 8443.
-  # username:: The username used to authenticate. Defaults to admin
-  # password:: The password used to authenticate. Defaults to vmware
+  # Creates an entry point that will connect to a vFabric Administration Server. 
+  # @param [Hash] configuration the connection configuration
+  # @option configuration [String] :username ('admin') The username to use to authenticate with the server
+  # @option configuration [String] :password ('vmware') The password to use to authenticate with the server
+  # @option configuration [String] :host ('localhost') The host of the server
+  # @option configuration [Integer] :port (8443) The HTTPS port of the server
   def initialize(configuration = {})
     @client = Util::Client.new(configuration[:username] || "admin", configuration[:password] || "vmware")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vas
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.3
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.3
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.5
   type: :runtime
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.5
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.9
   type: :runtime
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.9
 - !ruby/object:Gem::Dependency
@@ -64,7 +64,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.4
   type: :development
@@ -72,7 +72,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.4
 - !ruby/object:Gem::Dependency
@@ -80,7 +80,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
@@ -88,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
 description: A Ruby API for VMware vFabric Administration Server
@@ -104,7 +104,6 @@ files:
 - NOTICE
 - README.md
 - Rakefile
-- lib/vas/gemfire/agent_configuration.rb
 - lib/vas/gemfire/agent_instances.rb
 - lib/vas/gemfire/agent_live_configurations.rb
 - lib/vas/gemfire/agent_logs.rb
@@ -112,7 +111,6 @@ files:
 - lib/vas/gemfire/agent_pending_configurations.rb
 - lib/vas/gemfire/application_code.rb
 - lib/vas/gemfire/application_code_images.rb
-- lib/vas/gemfire/cache_server_configuration.rb
 - lib/vas/gemfire/cache_server_instances.rb
 - lib/vas/gemfire/cache_server_live_configurations.rb
 - lib/vas/gemfire/cache_server_logs.rb
@@ -124,7 +122,6 @@ files:
 - lib/vas/gemfire/installation_images.rb
 - lib/vas/gemfire/installations.rb
 - lib/vas/gemfire/live_application_codes.rb
-- lib/vas/gemfire/locator_configuration.rb
 - lib/vas/gemfire/locator_instances.rb
 - lib/vas/gemfire/locator_live_configurations.rb
 - lib/vas/gemfire/locator_logs.rb
@@ -133,7 +130,6 @@ files:
 - lib/vas/gemfire/nodes.rb
 - lib/vas/gemfire/pending_application_codes.rb
 - lib/vas/gemfire/statistics.rb
-- lib/vas/rabbitmq/configuration.rb
 - lib/vas/rabbitmq/groups.rb
 - lib/vas/rabbitmq/installation_images.rb
 - lib/vas/rabbitmq/installations.rb
@@ -151,7 +147,7 @@ files:
 - lib/vas/shared/groups.rb
 - lib/vas/shared/installation_images.rb
 - lib/vas/shared/installations.rb
-- lib/vas/shared/instances.rb
+- lib/vas/shared/instance.rb
 - lib/vas/shared/logs.rb
 - lib/vas/shared/mutable_collection.rb
 - lib/vas/shared/node_instances.rb

data/lib/vas/gemfire/agent_configuration.rb

@@ -1,28 +0,0 @@
-#--
-# vFabric Administration Server Ruby API
-# Copyright (c) 2012 VMware, Inc. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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
-
-  # A configuration file in an agent instance
-  class AgentConfiguration < Shared::Configuration
-
-    def initialize(location, client) #:nodoc:
-      super(location, client, "agent-group-instance", AgentInstance)
-    end
-
-  end
-end

data/lib/vas/gemfire/cache_server_configuration.rb

@@ -1,28 +0,0 @@
-#--
-# vFabric Administration Server Ruby API
-# Copyright (c) 2012 VMware, Inc. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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
-
-  # A configuration file in a cache server instance
-  class CacheServerConfiguration < Shared::Configuration
-
-    def initialize(location, client) #:nodoc:
-      super(location, client, "cache-server-group-instance", CacheServerInstance)
-    end
-
-  end
-end

data/lib/vas/gemfire/locator_configuration.rb

@@ -1,28 +0,0 @@
-#--
-# vFabric Administration Server Ruby API
-# Copyright (c) 2012 VMware, Inc. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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
-
-  # A configuration file in a locator instance
-  class LocatorConfiguration < Shared::Configuration
-
-    def initialize(location, client) #:nodoc:
-      super(location, client, "locator-group-instance", LocatorInstance)
-    end
-
-  end
-end

data/lib/vas/rabbitmq/configuration.rb

@@ -1,28 +0,0 @@
-#--
-# vFabric Administration Server Ruby API
-# Copyright (c) 2012 VMware, Inc. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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
-
-  # A configuration file in a Rabbit instance
-  class Configuration < Shared::Configuration
-
-    def initialize(location, client) #:nodoc:
-      super(location, client, "group-instance", Instance)
-    end
-
-  end
-end