fog-vcloud-director 0.1.0

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

@@ -0,0 +1,27 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the value of the specified key from vApp template or VM
+        # metadata.
+        #
+        # @param [String] id Object identifier of the vApp template or VM.
+        # @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-VAppTemplateMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def get_vapp_template_metadata_item_metadata(id, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/metadata/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the OVF descriptor of a vApp template.
+        #
+        # @param [String] id Object identifier of the vAppTemplate.
+        # @return [Excon::Response]
+        #   * body<~String> - the OVF descriptor.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-VAppTemplateOvfDescriptor.html
+        # @since vCloud API version 0.9
+        def get_vapp_template_ovf_descriptor(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :path       => "vAppTemplate/#{id}/ovf"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the owner 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-VAppTemplateOwner.html
+        # @since vCloud API version 1.5
+        def get_vapp_template_owner(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/owner"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of vAppTemplates 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.
+        #     * :VAppTemplateRecord<~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-VAppTemplatesFromQuery.html
+        # @since vCloud API version 1.5
+        def get_vapp_templates_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       => 'vAppTemplates/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' ?
+              :VAppTemplateReference : :VAppTemplateRecord
+
+          %w[firstPage previousPage nextPage lastPage].each do |rel|
+            if link = response.body[:Link].find {|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_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].find {|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

@@ -0,0 +1,174 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # 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)
+          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_id}",
+             :type=>"application/vnd.vmware.vcloud.vdc+xml",
+             :href=>make_href("vdc/#{vdc_id}"),
+             :xsi_schemaLocation=>xsi_schema_location,
+             :Link=>
+              [{:rel=>"up",
+                :type=>"application/vnd.vmware.vcloud.org+xml",
+                :href=>make_href("org/#{data[:org][:uuid]}")},
+               {:rel=>"down",
+                :type=>"application/vnd.vmware.vcloud.metadata+xml",
+                :href=>make_href("vdc/#{vdc_id}/metadata")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml",
+                :href=>
+                 make_href("vdc/#{vdc_id}/action/uploadVAppTemplate")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.media+xml",
+                :href=>make_href("vdc/#{vdc_id}/media")},
+               {:rel=>"add",
+                :type=>
+                 "application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml",
+                :href=>
+                 make_href("vdc/#{vdc_id}/action/instantiateVAppTemplate")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.cloneVAppParams+xml",
+                :href=>make_href("vdc/#{vdc_id}/action/cloneVApp")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.cloneVAppTemplateParams+xml",
+                :href=>
+                 make_href("vdc/#{vdc_id}/action/cloneVAppTemplate")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.cloneMediaParams+xml",
+                :href=>make_href("vdc/#{vdc_id}/action/cloneMedia")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.captureVAppParams+xml",
+                :href=>make_href("vdc/#{vdc_id}/action/captureVApp")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.composeVAppParams+xml",
+                :href=>make_href("vdc/#{vdc_id}/action/composeVApp")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.diskCreateParams+xml",
+                :href=>make_href("vdc/#{vdc_id}/disk")},
+               {:rel=>"edgeGateways",
+                :type=>"application/vnd.vmware.vcloud.query.records+xml",
+                :href=>make_href("admin/vdc/#{vdc_id}/edgeGateways")},
+               {:rel=>"add",
+                :type=>"application/vnd.vmware.vcloud.orgVdcNetwork+xml",
+                :href=>make_href("admin/vdc/#{vdc_id}/networks")},
+               {:rel=>"orgVdcNetworks",
+                :type=>"application/vnd.vmware.vcloud.query.records+xml",
+                :href=>make_href("admin/vdc/#{vdc_id}/networks")}],
+             :Description=>vdc[:description]||'',
+             :AllocationModel=>"AllocationVApp",
+             :ComputeCapacity=>
+              {:Cpu=>
+               {:Units=>"MHz",
+                :Allocated=>"0",
+                :Limit=>"0",
+                :Reserved=>"0",
+                :Used=>"0",
+                :Overhead=>"0"},
+              :Memory=>
+               {:Units=>"MB",
+                :Allocated=>"0",
+                :Limit=>"0",
+                :Reserved=>"0",
+                :Used=>"0",
+                :Overhead=>"0"}},
+             :ResourceEntities => {
+               :ResourceEntity => []
+             },
+             :AvailableNetworks => {},
+             :Capabilities=>
+              {:SupportedHardwareVersions=>
+               {:SupportedHardwareVersion=>"vmx-08"}},
+             :NicQuota=>"0",
+             :NetworkQuota=>"20",
+             :UsedNetworkCount=>"0",
+             :VmQuota=>"100",
+             :IsEnabled=>"true"}
+
+          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
+
+          body[:ResourceEntities][:ResourceEntity] +=
+            get_vapps_in_this_vdc(vdc_id).map do |vapp_id, vapp|
+              {:type => "application/vnd.vmware.vcloud.vApp+xml",
+               :name => vapp[:name],
+               :href => make_href("vApp/#{vapp_id}")}
+            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
+            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
+
+          response.status = 200
+          response.headers = {'Content-Type' => "#{body[:type]};version=#{api_version}"}
+          response.body = body
+          response
+        end
+
+        def get_vapps_in_this_vdc(vdc_id)
+          data[:vapps].select do |vapp_id, vapp|
+            vapp[:vdc_id] == vdc_id
+          end
+        end
+
+      end
+    end
+  end
+end