plainprograms-virtuozzo 0.5.2 → 0.5.3

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = CHANGELOG
 
+== 0.5.1 to 0.5.3
+
+* Minor bug fixes and documentation revisions.
+
 == 0.5.0 "Jill" 2008-11-13
 
 * Expanded documentation for Virtuozzo::SOAP::Connection class.

data/README.rdoc

@@ -1,11 +1,10 @@
-= +virtuozzo+
-    by James Thompson
-    http://github.com/plainprograms/virtuozzo
+= virtuozzo
 
-== DESCRIPTION
+The virtuozzo gem is designed to support working with Parallels Virtuozzo 
+Agent's XML and SOAP API from Ruby.
 
-+virtuozzo+ is designed to support working with Parallels Virtuozzo Agent's 
-XML and SOAP API from Ruby.
+* API Documentation: http://virtuozzo.rubyforge.org/virtuozzo/
+* Wiki: http://github.com/plainprograms/virtuozzo/wikis
 
 == REQUIREMENTS
 
@@ -13,14 +12,23 @@ XML and SOAP API from Ruby.
 
 == INSTALL
 
-  $ gem sources -a http://gems.github.com/
-  $ gem install plainprograms-virtuozzo
+To get the latest stable public release you can simply install the virtuozzo
+gem as you would any other:
+
+  $ sudo gem install virtuozzo
+
+Development gems are released on Github and can be installed by adding
+Github's gem server to your sources and then installing the latest development
+release gem.
+
+  $ sudo gem sources -a http://gems.github.com/
+  $ sudo gem install plainprograms-virtuozzo
 
 == SOURCE
 
-The +virtuozzo+ git repo is available on GitHub, which can be browsed at:
+The virtuozzo git repo is available on Github, which can be browsed at:
 
-  http://github.com/plainprograms/virtuozzo
+  http://github.com/plainprograms/virtuozzo/tree/
 
 and cloned from:
 

data/Rakefile

@@ -2,12 +2,15 @@ require 'rubygems'
 require 'echoe'
 require 'spec/rake/spectask'
 
-Echoe.new('virtuozzo', '0.5.2') do |p|
+PROJECT = "virtuozzo"
+RUBYFORGE_PROJECT = "virtuozzo"
+
+Echoe.new(PROJECT, '0.5.3') do |p|
   p.description               = "Ruby library for Parallels Virtuozzo Agent's API"
   p.url                       = "http://github.com/plainprograms/virtuozzo"
   p.author                    = "James Thompson"
   p.email                     = "james@plainprograms.com"
-  p.project                   = "virtuozzo"
+  p.project                   = RUBYFORGE_PROJECT
   p.ignore_pattern            = ["tmp/*, script/*"]
   p.development_dependencies  = ["echoe"]
   p.runtime_dependencies      = ["soap4r >=1.5.8"]

data/lib/virtuozzo/constants.rb

@@ -1,4 +1,4 @@
-module Virtuozzo # :nodoc:
+module Virtuozzo
   # Virtuozzo Agent's protocol version
   PROTOCOL_VERSION = '4.0.0'
 

data/lib/virtuozzo/soap/header_handler.rb

@@ -3,10 +3,10 @@ require 'soap/header/simplehandler'
 module Virtuozzo
   module SOAP
     ##
-    # The +HeaderHandler+ class takes care of properly formatting the
-    # +packet_header+ element inside a SOAP envelope header are. This
+    # The HeaderHandler class takes care of properly formatting the
+    # packet_header element inside a SOAP envelope header are. This
     # implementation will properly marshal all attributes and elements
-    # for the +packet_header+ element according to the Virtuozzo SOAP
+    # for the packet_header element according to the Virtuozzo SOAP
     # API specification.
     #
     class HeaderHandler < ::SOAP::Header::SimpleHandler
@@ -14,33 +14,33 @@ module Virtuozzo
 
       ##
       # Accepts a number of options that will inform the values assigned to the
-      # attributes and elements of the +packet_header+ element.
+      # attributes and elements of the packet_header element.
       #
-      # == +opts+ options
+      # == opts options
       #
       # === Attributes
       #
-      # * +:id+ represents a unique identifier for a given message. The
+      # * :id represents a unique identifier for a given message. The
       #   response will include this token for identification.
-      # * +:priority+ tells the agent to process the message with the given
+      # * :priority tells the agent to process the message with the given
       #   priority.
-      # * +:time+ represents the time and date the message was sent.
-      # * +:progress+ tells the agent to enable progress monitoring.
-      # * +:log+ tells the agent log the activities related to this message.
-      # * +:timeout+ tells the agent to stop processing the message after the
+      # * :time represents the time and date the message was sent.
+      # * :progress tells the agent to enable progress monitoring.
+      # * :log tells the agent log the activities related to this message.
+      # * :timeout tells the agent to stop processing the message after the
       #   supplied interval of time.
       #
       # === Elements
       #
-      # * +:session+ tells the agent which authenticated session this message
+      # * :session tells the agent which authenticated session this message
       #   should be processed in the context of.
-      # * +:target+ tells the agent which operator should handle this message.
-      # * +:cookie+ represents a unique token that will be retruned with the
+      # * :target tells the agent which operator should handle this message.
+      # * :cookie represents a unique token that will be retruned with the
       #   response message as a means of identification.
-      # * +:dst+ tells the agent to forward this message to another destination
+      # * :dst tells the agent to forward this message to another destination
       #   for final processing.
       #
-      # @param [Hash] opts values for +packet_header attributes and elements.
+      # @param [Hash] opts values for packet_header attributes and elements.
       #
       def initialize(opts = {})
         @elem_options = {

data/lib/virtuozzo/soap.rb

@@ -11,8 +11,8 @@ require 'virtuozzo/soap/drivers/support'
 
 require 'virtuozzo/soap/header_handler'
 
-module Virtuozzo  # :nodoc:
-  module SOAP     # :nodoc:
+module Virtuozzo
+  module SOAP
     ##
     # The Connection class provides for establishing of a SOAP session with a
     # Virtuozzo Agent using either an SSL-secured or unsecure HTTP connection.
@@ -25,18 +25,18 @@ module Virtuozzo  # :nodoc:
       # Establish a new session with the specified host using the supplied
       # credentials and options.
       #
-      # The +opts+ hash may define +:debug+ to be either +true+, +false+ or the
-      # 'device' to be used for wiredumps, defaults to +false+. If set to
-      # +true+ +STDERR+ will be used for wiredumps.
+      # The opts hash may define :debug to be either true, false or the
+      # 'device' to be used for wiredumps, defaults to false. If set to true
+      # STDERR will be used for wiredumps.
       #
-      # The +opts+ hash may define +:verify_ssl+ to be either +true+ or +false+
-      # in regards to whether SSL certificates should be verified for the
-      # various SOAP::RPC::Driver connections. The default is +false+, causing
-      # no SSL certificate verification.
+      # The opts hash may define :verify_ssl to be either true or false in
+      # regards to whether SSL certificates should be verified for the various
+      # SOAP::RPC::Driver connections. The default is +false+, causing no SSL
+      # certificate verification.
       #
-      # The +opts+ hash may define a +:realm+ for authentication. The default
-      # is the Virtuozzo system realm represented by the
-      # Virtuozzo::DEFAULT_REALM constant.
+      # The opts hash may define a :realm for authentication. The default is
+      # the Virtuozzo system realm represented by the Virtuozzo::DEFAULT_REALM
+      # constant.
       #
       # @param [String] host the host to connect to
       # @param [String] username the user to authenticate as
@@ -64,81 +64,81 @@ module Virtuozzo  # :nodoc:
       end
 
       ##
-      # Handle for the +sessionm+ interface of the Virtuozzo API.
+      # Handle for the sessionm interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +sessionm+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] sessionm SOAP::RPC::Driver instance.
       def session
         @session ||= Virtuozzo::SOAP::Drivers::Session.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzaenvm+ interface of the Virtuozzo API.
+      # Handle for the vzaenvm interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzaenvmm+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzaenvmm SOAP::RPC::Driver instance.
       def environment
         @environment ||= Virtuozzo::SOAP::Drivers::Environment.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzapackagem+ interface of the Virtuozzo API.
+      # Handle for the vzapackagem interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzapackagem+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzapackagem SOAP::RPC::Driver instance.
       def template
         @template ||= Virtuozzo::SOAP::Drivers::Template.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzarelocator+ interface of the Virtuozzo API.
+      # Handle for the vzarelocator interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzarelocator+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzarelocator SOAP::RPC::Driver instance.
       def relocator
         @relocator ||= Virtuozzo::SOAP::Drivers::Relocator.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzadevm+ interface of the Virtuozzo API.
+      # Handle for the vzadevm interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzadevm+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzadevm SOAP::RPC::Driver instance.
       def device
         @device ||= Virtuozzo::SOAP::Drivers::Device.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzanetworkm+ interface of the Virtuozzo API.
+      # Handle for the vzanetworkm interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzanetworkm+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzanetworkm SOAP::RPC::Driver instance.
       def network
         @network ||= Virtuozzo::SOAP::Drivers::Network.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzaproc_info+ interface of the Virtuozzo API.
+      # Handle for the vzaproc_info interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzaproc_info+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzaproc_info SOAP::RPC::Driver instance.
       def process_info
         @process_info ||= Virtuozzo::SOAP::Drivers::ProcessInfo.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzaprocessmm+ interface of the Virtuozzo API.
+      # Handle for the vzaprocessmm interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzaprocessm+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzaprocessm SOAP::RPC::Driver instance.
       def process
         @process ||= Virtuozzo::SOAP::Drivers::Process.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzaup2date+ interface of the Virtuozzo API.
+      # Handle for the vzaup2date interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzaup2date+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzaup2date SOAP::RPC::Driver instance.
       def up2date
         @up2date ||= Virtuozzo::SOAP::Drivers::Up2date.new(@endpoint)
       end
   
       ##
-      # Handle for the +vzasupport+ interface of the Virtuozzo API.
+      # Handle for the vzasupport interface of the Virtuozzo API.
       #
-      # @return [SOAP::RPC::Driver] +vzasupport+ SOAP::RPC::Driver instance.
+      # @return [SOAP::RPC::Driver] vzasupport SOAP::RPC::Driver instance.
       def support
         @support ||= Virtuozzo::SOAP::Drivers::Support.new(@endpoint)
       end
@@ -200,7 +200,7 @@ module Virtuozzo  # :nodoc:
 
       ##
       # Sets up handling of the SOAP envelope header for all outbound messages
-      # given the established +session_id+ and sets the appropriate target for
+      # given the established session_id and sets the appropriate target for
       # each driver in turn.
       #
       def setup_header_handler

data/lib/virtuozzo.rb

@@ -1,8 +1,3 @@
-# = virtuozzo
-#
-# +virtuozzo+ is intended to provide an interface to the Parallels Virtuozzo
-# Agent XML & SOAP API via the Ruby programming language.
-#
 require 'base64'
 require 'rubygems'
 

data/tasks/general.rake

@@ -0,0 +1,4 @@
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /#.*(FIXME|TODO|TBD)/
+end

data/tasks/yard.rake

@@ -2,11 +2,34 @@ require 'rubygems'
 require 'yard'
 
 namespace :yard do
-  YARD::Rake::YardocTask.new(:doc) do |t|
+  YARD::Rake::YardocTask.new(:docs) do |t|
+    puts "Generating YARD Documentation"
     t.options = [
         '--readme', 'README.rdoc',
-        '--use-cache', '.yardoc',
-        '--db', '.yardoc'
       ]
   end
+  
+  desc "Publish YARD documentation."
+  task :publish => [:docs] do
+    puts "Publishing YARD Documentation"
+
+    local_dir = 'doc'
+    remote_dir_name = "#{RUBYFORGE_PROJECT}/#{PROJECT}"
+
+    config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+    pub = Rake::SshDirPublisher.new "#{config["username"]}@rubyforge.org", "/var/www/gforge-projects/#{remote_dir_name}", local_dir
+      
+    def pub.upload
+      begin
+        super
+      rescue
+        # project directory probably doesn't exist, transfer as a whole
+        cmd = "scp -qr #{local_dir} #{host}:#{remote_dir}"
+        puts "Uploading: #{cmd}"
+        system(cmd)
+      end
+    end
+
+    pub.upload
+  end
 end

data/virtuozzo.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{virtuozzo}
-  s.version = "0.5.2"
+  s.version = "0.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Thompson"]
-  s.date = %q{2008-11-14}
+  s.date = %q{2008-11-15}
   s.description = %q{Ruby library for Parallels Virtuozzo Agent's API}
   s.email = %q{james@plainprograms.com}
-  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/virtuozzo/constants.rb", "lib/virtuozzo/soap/drivers/device.rb", "lib/virtuozzo/soap/drivers/environment.rb", "lib/virtuozzo/soap/drivers/network.rb", "lib/virtuozzo/soap/drivers/process.rb", "lib/virtuozzo/soap/drivers/process_info.rb", "lib/virtuozzo/soap/drivers/relocator.rb", "lib/virtuozzo/soap/drivers/session.rb", "lib/virtuozzo/soap/drivers/support.rb", "lib/virtuozzo/soap/drivers/template.rb", "lib/virtuozzo/soap/drivers/up2date.rb", "lib/virtuozzo/soap/header_handler.rb", "lib/virtuozzo/soap/mapping_registries/device.rb", "lib/virtuozzo/soap/mapping_registries/environment.rb", "lib/virtuozzo/soap/mapping_registries/network.rb", "lib/virtuozzo/soap/mapping_registries/process.rb", "lib/virtuozzo/soap/mapping_registries/process_info.rb", "lib/virtuozzo/soap/mapping_registries/relocator.rb", "lib/virtuozzo/soap/mapping_registries/session.rb", "lib/virtuozzo/soap/mapping_registries/support.rb", "lib/virtuozzo/soap/mapping_registries/template.rb", "lib/virtuozzo/soap/mapping_registries/up2date.rb", "lib/virtuozzo/soap/types/device.rb", "lib/virtuozzo/soap/types/environment.rb", "lib/virtuozzo/soap/types/network.rb", "lib/virtuozzo/soap/types/process.rb", "lib/virtuozzo/soap/types/process_info.rb", "lib/virtuozzo/soap/types/relocator.rb", "lib/virtuozzo/soap/types/session.rb", "lib/virtuozzo/soap/types/support.rb", "lib/virtuozzo/soap/types/template.rb", "lib/virtuozzo/soap/types/up2date.rb", "lib/virtuozzo/soap.rb", "lib/virtuozzo.rb", "README.rdoc", "tasks/yard.rake"]
-  s.files = ["CHANGELOG.rdoc", "lib/virtuozzo/constants.rb", "lib/virtuozzo/soap/drivers/device.rb", "lib/virtuozzo/soap/drivers/environment.rb", "lib/virtuozzo/soap/drivers/network.rb", "lib/virtuozzo/soap/drivers/process.rb", "lib/virtuozzo/soap/drivers/process_info.rb", "lib/virtuozzo/soap/drivers/relocator.rb", "lib/virtuozzo/soap/drivers/session.rb", "lib/virtuozzo/soap/drivers/support.rb", "lib/virtuozzo/soap/drivers/template.rb", "lib/virtuozzo/soap/drivers/up2date.rb", "lib/virtuozzo/soap/header_handler.rb", "lib/virtuozzo/soap/mapping_registries/device.rb", "lib/virtuozzo/soap/mapping_registries/environment.rb", "lib/virtuozzo/soap/mapping_registries/network.rb", "lib/virtuozzo/soap/mapping_registries/process.rb", "lib/virtuozzo/soap/mapping_registries/process_info.rb", "lib/virtuozzo/soap/mapping_registries/relocator.rb", "lib/virtuozzo/soap/mapping_registries/session.rb", "lib/virtuozzo/soap/mapping_registries/support.rb", "lib/virtuozzo/soap/mapping_registries/template.rb", "lib/virtuozzo/soap/mapping_registries/up2date.rb", "lib/virtuozzo/soap/types/device.rb", "lib/virtuozzo/soap/types/environment.rb", "lib/virtuozzo/soap/types/network.rb", "lib/virtuozzo/soap/types/process.rb", "lib/virtuozzo/soap/types/process_info.rb", "lib/virtuozzo/soap/types/relocator.rb", "lib/virtuozzo/soap/types/session.rb", "lib/virtuozzo/soap/types/support.rb", "lib/virtuozzo/soap/types/template.rb", "lib/virtuozzo/soap/types/up2date.rb", "lib/virtuozzo/soap.rb", "lib/virtuozzo.rb", "Manifest", "Rakefile", "README.rdoc", "script/console", "script/github-gem-test", "tasks/yard.rake", "virtuozzo.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/virtuozzo/constants.rb", "lib/virtuozzo/soap/drivers/device.rb", "lib/virtuozzo/soap/drivers/environment.rb", "lib/virtuozzo/soap/drivers/network.rb", "lib/virtuozzo/soap/drivers/process.rb", "lib/virtuozzo/soap/drivers/process_info.rb", "lib/virtuozzo/soap/drivers/relocator.rb", "lib/virtuozzo/soap/drivers/session.rb", "lib/virtuozzo/soap/drivers/support.rb", "lib/virtuozzo/soap/drivers/template.rb", "lib/virtuozzo/soap/drivers/up2date.rb", "lib/virtuozzo/soap/header_handler.rb", "lib/virtuozzo/soap/mapping_registries/device.rb", "lib/virtuozzo/soap/mapping_registries/environment.rb", "lib/virtuozzo/soap/mapping_registries/network.rb", "lib/virtuozzo/soap/mapping_registries/process.rb", "lib/virtuozzo/soap/mapping_registries/process_info.rb", "lib/virtuozzo/soap/mapping_registries/relocator.rb", "lib/virtuozzo/soap/mapping_registries/session.rb", "lib/virtuozzo/soap/mapping_registries/support.rb", "lib/virtuozzo/soap/mapping_registries/template.rb", "lib/virtuozzo/soap/mapping_registries/up2date.rb", "lib/virtuozzo/soap/types/device.rb", "lib/virtuozzo/soap/types/environment.rb", "lib/virtuozzo/soap/types/network.rb", "lib/virtuozzo/soap/types/process.rb", "lib/virtuozzo/soap/types/process_info.rb", "lib/virtuozzo/soap/types/relocator.rb", "lib/virtuozzo/soap/types/session.rb", "lib/virtuozzo/soap/types/support.rb", "lib/virtuozzo/soap/types/template.rb", "lib/virtuozzo/soap/types/up2date.rb", "lib/virtuozzo/soap.rb", "lib/virtuozzo.rb", "README.rdoc", "tasks/general.rake", "tasks/yard.rake"]
+  s.files = ["CHANGELOG.rdoc", "lib/virtuozzo/constants.rb", "lib/virtuozzo/soap/drivers/device.rb", "lib/virtuozzo/soap/drivers/environment.rb", "lib/virtuozzo/soap/drivers/network.rb", "lib/virtuozzo/soap/drivers/process.rb", "lib/virtuozzo/soap/drivers/process_info.rb", "lib/virtuozzo/soap/drivers/relocator.rb", "lib/virtuozzo/soap/drivers/session.rb", "lib/virtuozzo/soap/drivers/support.rb", "lib/virtuozzo/soap/drivers/template.rb", "lib/virtuozzo/soap/drivers/up2date.rb", "lib/virtuozzo/soap/header_handler.rb", "lib/virtuozzo/soap/mapping_registries/device.rb", "lib/virtuozzo/soap/mapping_registries/environment.rb", "lib/virtuozzo/soap/mapping_registries/network.rb", "lib/virtuozzo/soap/mapping_registries/process.rb", "lib/virtuozzo/soap/mapping_registries/process_info.rb", "lib/virtuozzo/soap/mapping_registries/relocator.rb", "lib/virtuozzo/soap/mapping_registries/session.rb", "lib/virtuozzo/soap/mapping_registries/support.rb", "lib/virtuozzo/soap/mapping_registries/template.rb", "lib/virtuozzo/soap/mapping_registries/up2date.rb", "lib/virtuozzo/soap/types/device.rb", "lib/virtuozzo/soap/types/environment.rb", "lib/virtuozzo/soap/types/network.rb", "lib/virtuozzo/soap/types/process.rb", "lib/virtuozzo/soap/types/process_info.rb", "lib/virtuozzo/soap/types/relocator.rb", "lib/virtuozzo/soap/types/session.rb", "lib/virtuozzo/soap/types/support.rb", "lib/virtuozzo/soap/types/template.rb", "lib/virtuozzo/soap/types/up2date.rb", "lib/virtuozzo/soap.rb", "lib/virtuozzo.rb", "Manifest", "Rakefile", "README.rdoc", "script/console", "script/github-gem-test", "tasks/general.rake", "tasks/yard.rake", "virtuozzo.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/plainprograms/virtuozzo}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Virtuozzo", "--main", "README.rdoc"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: plainprograms-virtuozzo
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors: 
 - James Thompson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-14 00:00:00 -08:00
+date: 2008-11-15 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,7 @@ extra_rdoc_files:
 - lib/virtuozzo/soap.rb
 - lib/virtuozzo.rb
 - README.rdoc
+- tasks/general.rake
 - tasks/yard.rake
 files: 
 - CHANGELOG.rdoc
@@ -115,6 +116,7 @@ files:
 - README.rdoc
 - script/console
 - script/github-gem-test
+- tasks/general.rake
 - tasks/yard.rake
 - virtuozzo.gemspec
 has_rdoc: true