fog-maestrodev 1.15.0.20130927082724 → 1.18.0.20131111203459

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

@@ -0,0 +1,94 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of vApps 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.
+        #     * :VAppRecord<~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-VAppsInLeaseFromQuery.html
+        # @since vCloud API version 1.5
+        def get_vapps_in_lease_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       => 'vApps/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' ?
+              :VAppReference : :VAppRecord
+
+          %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_vcloud.rb

@@ -0,0 +1,76 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve an administrative view of a cloud.
+        #
+        # The VCloud element provides access to cloud-wide namespace of objects
+        # that an administrator can view and, in most cases, modify.
+        #
+        # @return [Excon:Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :name<~String> - The name of the entity.
+        #     * :Description<~String> - Optional description.
+        #     * :OrganizationReferences<Hash>:
+        #       * :OrganizationReference<~Array<Hash>>:
+        #         * :href<~String> - Contains the URI to the entity.
+        #         * :name<~String> - Contains the name of the entity.
+        #         * :type<~String> - Contains the type of the entity.
+        #     * :ProviderVdcReferences<~Hash>:
+        #       * :ProviderVdcReferences<~Array<Hash>>:
+        #     * :RightReferences<~Hash>:
+        #       * :RightReferences<~Array<Hash>>:
+        #     * :RoleReferences<~Hash>:
+        #       * :RoleReferences<~Array<Hash>>:
+        #     * :Networks<~Hash>:
+        #       * :Network<~Array<Hash>>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-Vcloud.html
+        # @since vCloud API version 0.9
+        def get_vcloud
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => 'admin/'
+          )
+          ensure_list! response.body, :OrganizationReferences, :OrganizationReference
+          ensure_list! response.body, :ProviderVdcReferences, :ProviderVdcReference
+          ensure_list! response.body, :RightReferences, :RightReference
+          ensure_list! response.body, :RoleReferences, :RoleReference
+          ensure_list! response.body, :Networks, :Network
+          response
+        end
+      end
+
+      class Mock
+        def get_vcloud
+          body =
+            {:href=>make_href('admin/'),
+             :type=>"application/vnd.vmware.admin.vcloud+xml",
+             :name=>'VMware vCloud Director',
+             :Description=>'5.1.2.1377223 Tue Oct 15 20:56:05 GMT 2013',
+             :Tasks=>{:Task=>[]},
+             :OrganizationReferences=>
+              {:OrganizationReference=>
+               [{:type=>"application/vnd.vmware.admin.organization+xml",
+                 :name=>data[:org][:name],
+                 :href=>make_href("api/admin/org/#{data[:org][:uuid]}")}]},
+             :ProviderVdcReferences=>{:ProviderVdcReference=>[]},
+             :RightReferences=>{:RightReference=>[]},
+             :RoleReferences=>{:RoleReference=>[]},
+             :Networks=>{:Network=>[]}}
+
+          Excon::Response.new(
+            :body    => body,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :status  => 200
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -2,29 +2,49 @@ module Fog
   module Compute
     class VcloudDirector
       class Real
-        def get_vdc(vdc_id)
-          request(
-            :expects => 200,
-            :method  => 'GET',
-            :parser  => Fog::ToHashDocument.new,
-            :path    => "vdc/#{vdc_id}"
+        # Retrieve a vDC.
+        #
+        # @param [String] id Object identifier of the vDC.
+        # @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-Vdc.html
+        # @since vCloud API version 0.9
+        def get_vdc(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdc/#{id}"
           )
+          ensure_list! response.body, :ResourceEntities, :ResourceEntity
+          ensure_list! response.body, :AvailableNetworks, :Network
+          ensure_list! response.body, :VdcStorageProfiles, :VdcStorageProfile
+          response
         end
       end
 
       class Mock
         def get_vdc(vdc_id)
-          vdc = data[:vdc]
-          raise Excon::Errors::NotFound unless vdc_id == vdc[:uuid]
+          response = Excon::Response.new
+
+          unless vdc = data[:vdcs][vdc_id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"com.vmware.vcloud.entity.vdc:#{vdc_id}\"."
+            )
+          end
 
           body =
             {:xmlns=>xmlns,
              :xmlns_xsi=>xmlns_xsi,
              :status=>"1",
              :name=>vdc[:name],
-             :id=>"urn:vcloud:vdc:#{vdc[:uuid]}",
+             :id=>"urn:vcloud:vdc:#{vdc_id}",
              :type=>"application/vnd.vmware.vcloud.vdc+xml",
-             :href=>make_href("vdc/#{vdc[:uuid]}"),
+             :href=>make_href("vdc/#{vdc_id}"),
              :xsi_schemaLocation=>xsi_schema_location,
              :Link=>
               [{:rel=>"up",
@@ -32,47 +52,47 @@ module Fog
                 :href=>make_href("org/#{data[:org][:uuid]}")},
                {:rel=>"down",
                 :type=>"application/vnd.vmware.vcloud.metadata+xml",
-                :href=>make_href("vdc/#{vdc[:uuid]}/metadata")},
+                :href=>make_href("vdc/#{vdc_id}/metadata")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml",
                 :href=>
-                 make_href("vdc/#{vdc[:uuid]}/action/uploadVAppTemplate")},
+                 make_href("vdc/#{vdc_id}/action/uploadVAppTemplate")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.media+xml",
-                :href=>make_href("vdc/#{vdc[:uuid]}/media")},
+                :href=>make_href("vdc/#{vdc_id}/media")},
                {:rel=>"add",
                 :type=>
                  "application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml",
                 :href=>
-                 make_href("vdc/#{vdc[:uuid]}/action/instantiateVAppTemplate")},
+                 make_href("vdc/#{vdc_id}/action/instantiateVAppTemplate")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.cloneVAppParams+xml",
-                :href=>make_href("vdc/#{vdc[:uuid]}/action/cloneVApp")},
+                :href=>make_href("vdc/#{vdc_id}/action/cloneVApp")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.cloneVAppTemplateParams+xml",
                 :href=>
-                 make_href("vdc/#{vdc[:uuid]}/action/cloneVAppTemplate")},
+                 make_href("vdc/#{vdc_id}/action/cloneVAppTemplate")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.cloneMediaParams+xml",
-                :href=>make_href("vdc/#{vdc[:uuid]}/action/cloneMedia")},
+                :href=>make_href("vdc/#{vdc_id}/action/cloneMedia")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.captureVAppParams+xml",
-                :href=>make_href("vdc/#{vdc[:uuid]}/action/captureVApp")},
+                :href=>make_href("vdc/#{vdc_id}/action/captureVApp")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.composeVAppParams+xml",
-                :href=>make_href("vdc/#{vdc[:uuid]}/action/composeVApp")},
+                :href=>make_href("vdc/#{vdc_id}/action/composeVApp")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.diskCreateParams+xml",
-                :href=>make_href("vdc/#{vdc[:uuid]}/disk")},
+                :href=>make_href("vdc/#{vdc_id}/disk")},
                {:rel=>"edgeGateways",
                 :type=>"application/vnd.vmware.vcloud.query.records+xml",
-                :href=>make_href("admin/vdc/#{vdc[:uuid]}/edgeGateways")},
+                :href=>make_href("admin/vdc/#{vdc_id}/edgeGateways")},
                {:rel=>"add",
                 :type=>"application/vnd.vmware.vcloud.orgVdcNetwork+xml",
-                :href=>make_href("admin/vdc/#{vdc[:uuid]}/networks")},
+                :href=>make_href("admin/vdc/#{vdc_id}/networks")},
                {:rel=>"orgVdcNetworks",
                 :type=>"application/vnd.vmware.vcloud.query.records+xml",
-                :href=>make_href("admin/vdc/#{vdc[:uuid]}/networks")}],
+                :href=>make_href("admin/vdc/#{vdc_id}/networks")}],
              :Description=>vdc[:description]||'',
              :AllocationModel=>"AllocationVApp",
              :ComputeCapacity=>
@@ -101,52 +121,36 @@ module Fog
              :VmQuota=>"100",
              :IsEnabled=>"true"}
 
-          # Emulating Fog::ToHashDocument:
-          if data[:networks].size == 1
-            body[:AvailableNetworks][:Network] =
-              [{:type=>"application/vnd.vmware.vcloud.network+xml",
-                :name=>data[:networks].first[:name],
-                :href=>make_href("network/#{data[:networks].first[:name]}")}]
-          else
-            body[:AvailableNetworks][:Network] = data[:networks].map do |network|
-              {:type=>"application/vnd.vmware.vcloud.network+xml",
-               :name=>network[:name],
-               :href=>make_href("network/#{network[:name]}")}
+          body[:ResourceEntities][:ResourceEntity] =
+            data[:catalog_items].map do |id, item|
+              {:type=>"application/vnd.vmware.vcloud.#{item[:type]}+xml",
+               :name=>item[:name],
+               :href=>make_href("#{item[:type]}/#{item[:type]}-#{id}")}
             end
-          end
 
-          # Emulating Fog::ToHashDocument:
-          if data[:catalog_items].size == 1
-            item_type = data[:catalog_items].first[:type]
-            body[:ResourceEntities][:ResourceEntity] =
-              {:type=>"application/vnd.vmware.vcloud.#{item_type}+xml",
-               :name=>data[:catalog_items].first[:name],
-               :href=>
-                make_href("#{item_type}/#{item_type}-#{data[:catalog_items].first[:uuid]}")}
-          else
-            body[:ResourceEntities][:ResourceEntity] = data[:catalog_items].map do |catalog_item|
-              item_type = catalog_item[:type]
-              {:type=>"application/vnd.vmware.vcloud.#{item_type}+xml",
-               :name=>catalog_item[:name],
-               :href=>
-                make_href("#{item_type}/#{item_type}-#{catalog_item[:uuid]}")}
-            end
+          body[:AvailableNetworks][:Network] =
+            data[:networks].map do |id, network|
+              {:type=>"application/vnd.vmware.vcloud.network+xml",
+               :name=>network[:name],
+               :href=>make_href("network/#{id}")}
           end
 
           if api_version.to_f >= 5.1
-            # TODO
-            #body[:VdcStorageProfiles] =
-            # {:VdcStorageProfile=>
-            #  [{:type=>"application/vnd.vmware.vcloud.vdcStorageProfile+xml",
-            #    :name=>profile[:name],
-            #    :href=>make_href("vdcStorageProfile/#{profile[:uuid]}")}]}
+            body[:VdcStorageProfiles] = {}
+            body[:VdcStorageProfiles][:VdcStorageProfile] =
+              data[:vdc_storage_classes].select do |id, storage_class|
+                storage_class[:vdc] == vdc_id
+              end.map do |id, storage_class|
+                {:type => 'application/vnd.vmware.vcloud.vdcStorageProfile+xml',
+                 :name => storage_class[:name],
+                 :href => make_href("vdcStorageProfile/#{id}")}
+              end
           end
 
-          Excon::Response.new(
-            :body => body,
-            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
-            :status => 200
-          )
+          response.status = 200
+          response.headers = {'Content-Type' => "#{body[:type]};version=#{api_version}"}
+          response.body = body
+          response
         end
       end
     end

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

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

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

@@ -0,0 +1,28 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the value of the specified key from virtual datacenter
+        # metadata.
+        #
+        # @param [String] id Object identifier of the network.
+        # @param [String] domain
+        # @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-VdcMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def get_vdc_metadata_item_metadata(id, domain, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "admin/vdc/#{id}/metadata/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_vdc_storage_profile, :get_vdc_storage_class
+
+        # Returns storage class referred by the Id. All properties of the
+        # storage classes are visible to vcloud user, except for VDC Storage
+        # Class reference.
+        #
+        # @param [String] id Object identifier of the vDC storage profile.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :id<~String> - The entity identifier, expressed in URN format.
+        #       The value of this attribute uniquely identifies the entity,
+        #       persists for the life of the entity, and is never reused.
+        #     * :name<~String> - The name of the entity.
+        #     * :Description<~String> - Optional description.
+        #     * :Enabled<~String> - True if this storage profile is enabled for
+        #       use in the vDC.
+        #     * :Units<~String> - Units used to define :Limit.
+        #     * :Limit<~String> - Maximum number of :Units allocated for this
+        #       storage profile.
+        #     * :Default<~String> - True if this is default storage profile for
+        #       this vDC. The default storage profile is used when an object
+        #       that can specify a storage profile is created with no storage
+        #       profile specified.
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VdcStorageClass.html
+        def get_vdc_storage_class(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdcStorageProfile/#{id}"
+          )
+        end
+      end
+
+      class Mock
+        def get_vdc_storage_class(id)
+          unless vdc_storage_class = data[:vdc_storage_classes][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.vdcstorageProfile:#{id})\"."
+            )
+          end
+
+          body =
+            {:xmlns=>xmlns,
+             :xmlns_xsi=>xmlns_xsi,
+             :name=>vdc_storage_class[:name],
+             :id=>"urn:vcloud:vdcstorageProfile:#{id}",
+             :type=>"application/vnd.vmware.vcloud.vdcStorageProfile+xml",
+             :href=>make_href("api/vdcStorageProfile/#{id}"),
+             :xsi_schemaLocation=>xsi_schema_location,
+             :Link=>
+              [{:rel=>"up",
+                :type=>"application/vnd.vmware.vcloud.vdc+xml",
+                :href=>make_href("vdc/#{vdc_storage_class[:vdc]}")},
+               {:rel=>"down",
+                :type=>"application/vnd.vmware.vcloud.metadata+xml",
+                :href=>make_href("vdcStorageProfile/#{id}/metadata")}],
+             :Enabled=>vdc_storage_class[:enabled].to_s,
+             :Units=>vdc_storage_class[:units],
+             :Limit=>vdc_storage_class[:limit].to_s,
+             :Default=>vdc_storage_class[:default].to_s}
+
+          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_vdc_storage_class_metadata.rb

@@ -0,0 +1,27 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_vdc_storage_profile_metadata, :get_vdc_storage_class_metadata
+
+        # Retrieve metadata associated with the vDC storage profile.
+        #
+        # @param [String] id Object identifier of the vDC storage profile.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VdcStorageClassMetadata.html
+        def get_vdc_storage_class_metadata(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdcStorageProfile/#{id}/metadata/"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve metadata associated with the vDC storage profile.
+        #
+        # @param [String] id Object identifier of the vDC storage profile.
+        # @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-VdcStorageClassMetadataItem-metadata.html
+        def get_vdc_storage_class_metadata_item_metadata(id, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vdcStorageProfile/#{id}/metadata/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of vdcs in the organization.
+        #
+        # @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.
+        #     * :OrgVdcRecord<~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-55/topic/com.vmware.vcloud.api.reference.doc_55/doc/operations/GET-RightsFromQuery-query.html
+        # @since vCloud API version 1.5
+        def get_vdcs_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       => 'admin/vdcs/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' ?
+              :OrgVdcReference : :OrgVdcRecord
+
+          %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