fog-maestrodev 1.15.0.20130927082724 → 1.18.0.20131111203459

data/lib/fog/vcloud_director/requests/compute/get_lease_settings_section_vapp_template.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves the lease settings section of a vApp template.
+        #
+        # @param [String] id Object identifier of the vApp template.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-LeaseSettingsSection-vAppTemplate.html
+        # @since vCloud API version 0.9
+        def get_lease_settings_section_vapp_template(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/leaseSettingsSection"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_media.rb

@@ -0,0 +1,111 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a media object.
+        #
+        # @param [String] id Object identifier of the media object.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-Media.html
+        # @since vCloud API version 0.9
+        def get_media(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "media/#{id}"
+          )
+          ensure_list! response.body, :Files, :File
+          response
+        end
+      end
+
+      class Mock
+        def get_media(id)
+          unless data[:medias][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.media:#{id})\"."
+            )
+          end
+
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location
+          }.merge(media_body(id))
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=>#{@api_version}"},
+            :body => body
+          )
+        end
+
+        private
+
+        def media_body(id)
+          media = data[:medias][id]
+
+          body = {
+            :size => media[:size].to_s,
+            :imageType => media[:image_type],
+            :status => media[:status].to_s,
+            :name => media[:name],
+            :id => "urn:vcloud:media:#{id}",
+            :type => 'application/vnd.vmware.vcloud.media+xml',
+            :href => make_href("media/#{id}"),
+            :Link => {
+              :href => make_href("vdc/#{media[:vdc_id]}"),
+              :type => 'application/vnd.vmware.vcloud.vdc+xml',
+              :rel => 'up'
+            },
+            :Description => media[:description] || '',
+            :Tasks => {
+              # FIXME: there's only one for now
+              :Task => media[:tasks].map {|task_id| task_body(task_id)}.first
+            },
+            :Files => {
+              :File => []
+            },
+            :Owner => {
+              :type => 'application/vnd.vmware.vcloud.owner+xml',
+              :User => {
+                :href => make_href("admin/user/#{user_uuid}"),
+                :name => user_uuid,
+                :type => 'application/vnd.vmware.admin.user+xml',
+              }
+            }
+          }
+
+          if media[:status] == 0
+            body[:Files][:File] << {
+              :size => media[:size].to_s,
+              :bytesTransferred => media[:file][:bytes_transferred].to_s,
+              :name => 'file',
+              :Link=> {
+                :href => make_href("transfer/#{media[:file][:uuid]}/file"),
+                :rel => 'upload:default'
+              }
+            }
+          end
+
+          if api_version.to_f >= 5.1
+            storage_class_id = media[:vdc_storage_class]
+            body[:VdcStorageProfile] = {
+              :href => make_href("vdcStorageProfile/#{storage_class_id}"),
+              :name => data[:vdc_storage_classes][storage_class_id][:name],
+              :type => 'application/vnd.vmware.vcloud.vdcStorageProfile+xml',
+            }
+          end
+
+          body
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_media_drives_rasd_items_list.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve all RASD items that specify CD-ROM, DVD, and floppy disk
+        # device and controller properties of a VM.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-MediaDrivesRasdItemsList.html
+        # @since vCloud API version 0.9
+        def get_media_drives_rasd_items_list(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/virtualHardwareSection/media"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_media_metadata.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve metadata associated with a media object.
+        #
+        # @param [String] id Object identifier of the media object
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-MediaMetadata.html
+        # @since vCloud API version 1.5
+        def get_media_metadata(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "media/#{id}/metadata"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_media_metadata_item_metadata.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the value of the specified key from media object metadata.
+        #
+        # @param [String] id Object identifier of the media object.
+        # @param [String] key Key of the metadata.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-MediaMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def get_media_metadata_item_metadata(id, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "media/#{id}/metadata/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_media_owner.rb

@@ -0,0 +1,70 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the owner of a media object.
+        #
+        # @param [String] id Object identifier of the media object.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the media object.
+        #     * :type<~String> - The MIME type of the media object.
+        #     * :Link<~Hash>:
+        #       * :href<~String> -
+        #       * :type<~String> -
+        #       * :rel<~String> -
+        #     * :User<~Hash> - Reference to the user who is the owner of this
+        #       media object.
+        #       * :href<~String> - The URI of the user.
+        #       * :name<~String> - The name of the user.
+        #       * :type<~String> - The MIME type of the user.
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-MediaOwner.html
+        # @since vCloud API version 1.5
+        def get_media_owner(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "media/#{id}/owner"
+          )
+        end
+      end
+
+      class Mock
+        def get_media_owner(id)
+          unless data[:medias][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'No access to entity "com.vmware.vcloud.entity.media:%s".' % id
+            )
+          end
+
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location,
+            :Link => {
+              :href => make_href("media/#{id}"),
+              :type => 'application/vnd.vmware.vcloud.media+xml',
+              :rel => 'up'
+            },
+            :User => {
+              :href => make_href("admin/user/#{user_uuid}"),
+              :name => user_name,
+              :type => 'application/vnd.vmware.admin.user+xml',
+            }
+          }
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{@version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_medias_from_query.rb

@@ -0,0 +1,94 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a media list by using REST API general QueryHandler.
+        #
+        # @param [Hash] options
+        # @option options [String] :sortAsc (Sorted by database ID) Sort
+        #   results by attribute-name in ascending order. attribute-name cannot
+        #   include metadata.
+        # @option options [String] :sortDesc (Sorted by database ID) Sort
+        #   results by attribute-name in descending order. attribute-name
+        #   cannot include metadata.
+        # @option options [Integer] :page (1) If the query results span
+        #   multiple pages, return this page.
+        # @option options [Integer] :pageSize (25) Number of results per page,
+        #   to a maximum of 128.
+        # @option options [String] :format (records) One of the following
+        #   types:
+        #   - *references* Returns a reference to each object, including its
+        #     :name, :type, and :href attributes.
+        #   - *records* Returns all database records for each object, with each
+        #     record as an attribute.
+        #   - *idrecords* Identical to the records format, except that object
+        #     references are returned in :id format rather than :href format.
+        # @option options [Array<String>] :fields (all static attribute names)
+        #   List of attribute names or metadata key names to return.
+        # @option options [Integer] :offset (0) Integer value specifying the
+        #   first record to return. Record numbers < offset are not returned.
+        # @option options [String] :filter (none) Filter expression.
+        # @return [Excon::Response]
+        #   * hash<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :name<~String> - Query name that generated this result set.
+        #     * :page<~String> - Page of the result set that this container
+        #       holds. The first page is page number 1.
+        #     * :pageSize<~String> - Page size, as a number of records or
+        #       references.
+        #     * :total<~String> - Total number of records or references in the
+        #       container.
+        #     * :Link<~Array<Hash>>:
+        #       * :href<~String> - Contains the URI to the entity.
+        #       * :type<~String> - Contains the type of the entity.
+        #       * :rel<~String> - Defines the relationship of the link to the
+        #         object that contains it.
+        #     * :MediaRecord<~Array<Hash>>:
+        #       * TODO
+        #     * :firstPage<~Integer> - First page in the result set.
+        #     * :previousPage<~Integer> - Previous page in the result set.
+        #     * :nextPage<~Integer> - Next page in the result set.
+        #     * :lastPage<~Integer> - Last page in the result set.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-MediasFromQuery.html
+        # @since vCloud API version 1.5
+        def get_medias_from_query(options={})
+          query = []
+          query << "sortAsc=#{options[:sortAsc]}" if options[:sortAsc]
+          query << "sortDesc=#{options[:sortDesc]}" if options[:sortDesc]
+          query << "page=#{options[:page]}" if options[:page]
+          query << "pageSize=#{options[:pageSize]}" if options[:pageSize]
+          query << "format=#{options[:format]}" if options[:format]
+          query << "fields=#{Array(options[:fields]).join(',')}" if options[:fields]
+          query << "offset=#{options[:offset]}" if options[:offset]
+          query << "filter=#{options[:filter]}" if options[:filter]
+
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => 'mediaList/query',
+            :query      => query.map {|q| URI.escape(q)}.join('&')
+          )
+          ensure_list! response.body, :Link
+          ensure_list! response.body,
+            response.body[:type] == 'application/vnd.vmware.vcloud.query.references+xml' ?
+              :MediaReference : :MediaRecord
+
+          %w[firstPage previousPage nextPage lastPage].each do |rel|
+            if link = response.body[:Link].detect {|l| l[:rel] == rel}
+              href = Nokogiri::XML.fragment(link[:href])
+              query = CGI.parse(URI.parse(href.text).query)
+              response.body[rel.to_sym] = query['page'].first.to_i
+              response.body[:pageSize] ||= query['pageSize'].first.to_i
+            end
+          end
+
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_memory_rasd_item.rb

@@ -0,0 +1,28 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_vm_memory, :get_memory_rasd_item
+
+        # Retrieve the RASD item that specifies memory properties of a VM.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-MemoryRasdItem.html
+        # @since vCloud API version 0.9
+        def get_memory_rasd_item(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/virtualHardwareSection/memory"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_metadata.rb

@@ -2,18 +2,28 @@ module Fog
   module Compute
     class VcloudDirector
       class Real
-
-        def get_metadata(vm_id)
+        # Retrieve metadata associated with the vApp or VM.
+        #
+        # @deprecated Use {#get_vapp_metadata} instead.
+        # @todo Log deprecation warning.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppMetadata.html
+        # @since vCloud API version 1.5
+        def get_metadata(id)
           require 'fog/vcloud_director/parsers/compute/metadata'
 
           request(
-            :expects => 200,
-            :method  => 'GET',
-            :parser  => Fog::Parsers::Compute::VcloudDirector::Metadata.new,
-            :path    => "vApp/#{vm_id}/metadata/"
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Compute::VcloudDirector::Metadata.new,
+            :path       => "vApp/#{id}/metadata/"
           )
         end
-
       end
     end
   end

data/lib/fog/vcloud_director/requests/compute/get_network.rb

@@ -2,20 +2,62 @@ module Fog
   module Compute
     class VcloudDirector
       class Real
-
         require 'fog/vcloud_director/parsers/compute/network'
 
-        def get_network(network_id)
+        # Retrieve an organization network.
+        #
+        # @param [String] id Object identifier of the network.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-Network.html
+        # @since vCloud API version 0.9
+        def get_network(id)
           request(
-            :expects => 200,
-            :method  => 'GET',
-            :parser  => Fog::Parsers::Compute::VcloudDirector::Network.new,
-            :path    => "network/#{network_id}"
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Compute::VcloudDirector::Network.new,
+            :path       => "network/#{id}"
           )
         end
+      end
+
+      class Mock
+        def get_network(id)
+          unless network = data[:networks][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          body =
+            {:name=>network[:name],
+             :href=>make_href("network/#{id}"),
+             :type=>"application/vnd.vmware.vcloud.orgNetwork+xml",
+             :id=>id,
+             :description=>nil,
+             :is_inherited=>network[:IsInherited],
+             :gateway=>network[:Gateway],
+             :netmask=>network[:Netmask],
+             :dns1=>network[:Dns1],
+             :dns2=>network[:Dns2],
+             :dns_suffix=>network[:DnsSuffix]}
 
+          body[:ip_ranges] = network[:IpRanges].map do |ip_range|
+            {:start_address=>ip_range[:StartAddress],
+             :end_address=>ip_range[:EndAddress]}
+          end
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
       end
     end
   end
 end
-

data/lib/fog/vcloud_director/requests/compute/get_network_cards_items_list.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve all RASD items that specify network card properties of a VM.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-NetworkCardsItemsList.html
+        # @since vCloud API version 0.9
+        def get_network_cards_items_list(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/virtualHardwareSection/networkCards"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_network_config_section_vapp.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the network config section of a vApp.
+        #
+        # @param [String] id The object identifier of the vApp.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-NetworkConfigSection-vApp.html
+        # @since vCloud API version 0.9
+        def get_network_config_section_vapp(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/networkConfigSection/"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_network_config_section_vapp_template.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the network config section of a vApp template.
+        #
+        # @param [String] id The object identifier of the vApp template.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-NetworkConfigSection-vAppTemplate.html
+        # @since vCloud API version 0.9
+        def get_network_config_section_vapp_template(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/networkConfigSection/"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_network_connection_system_section_vapp.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the network connection section of a VM.
+        #
+        # @param [String] id The object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-NetworkConnectionSystemSection-vApp.html
+        # @since vCloud API version 0.9
+        def get_network_connection_system_section_vapp(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/networkConnectionSection/"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_network_connection_system_section_vapp_template.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the network connection section of a VM.
+        #
+        # @param [String] id The object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-NetworkConnectionSystemSection-vAppTemplate.html
+        # @since vCloud API version 0.9
+        def get_network_connection_system_section_vapp_template(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/networkConnectionSection/"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/requests/compute/get_network_metadata.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve metadata associated with the network.
+        #
+        # @param [String] id Object identifier of the network.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-NetworkMetadata.html
+        # @since vCloud API version 1.5
+        def get_network_metadata(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "network/#{id}/metadata"
+          )
+        end
+      end
+    end
+  end
+end