fog-vcloud-director 0.1.0

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

@@ -0,0 +1,63 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a catalog.
+        #
+        # @param [String] id Object identifier of the catalog.
+        # @return [Excon::Response]
+        #   * hash<~Hash>:
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-Catalog.html
+        # @since vCloud API version 0.9
+        def get_catalog(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "catalog/#{id}"
+          )
+          ensure_list! response.body, :CatalogItems, :CatalogItem
+          response
+        end
+      end
+
+      class Mock
+        def get_catalog(id)
+          unless catalog = data[:catalogs][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.catalog:#{id})\"."
+            )
+          end
+          
+          items = data[:catalog_items].select {|_,v| v[:catalog] == id}
+          
+          body = {
+            :href => make_href("catalog/#{id}"),
+            :type => 'application/vnd.vmware.vcloud.catalog+xml',
+            :id   => id,
+            :name => catalog[:name],
+            :CatalogItems => {
+              :CatalogItem => items.map do |uuid,item|
+                {
+                  :href => make_href("catalogItem/#{uuid}"),
+                  :id   => uuid,
+                  :name => item[:name],
+                  :type => 'application/vnd.vmware.vcloud.catalogItem+xml'
+                }
+              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_catalog_item.rb

@@ -0,0 +1,48 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a catalog item.
+        #
+        # @param [String] id Object identifier of the catalog item.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-CatalogItem.html
+        # @since vCloud API version 0.9
+        def get_catalog_item(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "catalogItem/#{id}"
+          )
+        end
+      end
+      class Mock
+        def get_catalog_item(id)
+          unless item = data[:catalog_items][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.catalogItem:#{id})\"."
+            )
+          end
+          body = {
+            :href => make_href("catalogItem/#{id}"),
+            :id   => id,
+            :name => item[:name],
+            :type => 'application/vnd.vmware.vcloud.catalogItem+xml',
+            :Entity => {
+              :href => make_href("vAppTemplate/#{item[:template_id]}")              
+            }
+          }
+          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_catalog_item_metadata.rb

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

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

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

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

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

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

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

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

@@ -0,0 +1,94 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of Catalogs 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.
+        #     * :CatalogRecord<~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-CatalogsFromQuery.html
+        # @since vCloud API version 1.5
+        def get_catalogs_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       => 'catalogs/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' ?
+              :CatalogReference : :CatalogRecord
+
+          %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_control_access_params_catalog.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve access control information for a catalog.
+        #
+        # @param [String] id Object identifier of the organization.
+        # @param [String] catalog_id Object identifier of the catalog.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-ControlAccessParams-vApp.html
+        # @since vCloud API 0.9
+        def get_control_access_params_catalog(id, catalog_id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "org/#{id}/catalog/#{catalog_id}/controlAccess"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve access control information for a vApp.
+        #
+        # @param [String] id 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-ControlAccessParams-vApp.html
+        # @since vCloud API 0.9
+        def get_control_access_params_vapp(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/controlAccess"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_vm_cpu, :get_cpu_rasd_item
+
+        # Retrieve the RASD item that specifies CPU 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-CpuRasdItem.html
+        # @since vCloud API version 0.9
+        def get_cpu_rasd_item(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/virtualHardwareSection/cpu"
+          )
+        end
+
+      end
+
+      class Mock
+
+        def get_cpu_rasd_item(id)
+          type = 'application/vnd.vmware.vcloud.rasdItem+xml'
+
+          unless vm = data[:vms][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{type};version=#{api_version}"},
+            :body => get_cpu_rasd_item_body(id, vm)
+          )
+        end
+
+        def get_cpu_rasd_item_body(id, vm)
+          {
+            :ns12_href => make_href("vApp/#{id}/virtualHardwareSection/cpu"),
+            :ns12_type => "application/vnd.vmware.vcloud.rasdItem+xml",
+            :"rasd:AllocationUnits"=>"hertz * 10^6",
+            :"rasd:Description"=>"Number of Virtual CPUs",
+            :"rasd:ElementName"=>"#{vm[:cpu_count]} virtual CPU(s)",
+            :"rasd:InstanceID"=>"4",
+            :"rasd:Reservation"=>"0",
+            :"rasd:ResourceType"=>"3",
+            :"rasd:VirtualQuantity"=>"#{vm[:cpu_count]}",
+            :"rasd:Weight"=>"0",
+          }
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a representation of the current session.
+        #
+        # A Session object contains one or more URLs from which you can begin
+        # browsing, as well as links to the query service and entity resolver.
+        # The list of URLs in the Session object is based on the role and
+        # privileges of the authenticated user.
+        #
+        # A Session object expires after a configurable interval of client
+        # inactivity.
+        #
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :org<~String> - The name of the user's organization.
+        #     * :user<~String> - The name of the user that owns the session
+        #     * :Link<~Array<Hash>]:
+        #       * :href<~String> - Contains the URI to the linked entity.
+        #       * :name<~String> - Contains the name of the linked entity.
+        #       * :type<~String> - Contains the type of the linked entity.
+        #       * :rel<~String> - Defines the relationship of the link to the
+        #         object that contains it.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-CurrentSession.html
+        # @since vCloud API version 1.5
+        def get_current_session
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => 'session'
+          )
+        end
+      end
+
+      class Mock
+        def get_current_session
+          body =
+            {:href => make_href('session/'),
+             :type => 'application/vnd.vmware.vcloud.session+xml',
+             :org => data[:org][:name],
+             :user => user_name,
+             :Link =>
+              [{:href => make_href('org/'),
+                :type => 'application/vnd.vmware.vcloud.orgList+xml',
+                :rel => 'down'},
+               {:href => make_href('admin/'),
+                :type => 'application/vnd.vmware.admin.vcloud+xml',
+                :rel => 'down'},
+               {:href => make_href("org/#{data[:org][:uuid]}"),
+                :name => data[:org][:name],
+                :type => 'application/vnd.vmware.vcloud.org+xml',
+                :rel => 'down'},
+               {:href => make_href('query'),
+                :type => 'application/vnd.vmware.vcloud.query.queryList+xml',
+                :rel => 'down'},
+               {:href => make_href('entity/'),
+                :type => 'application/vnd.vmware.vcloud.entity+xml',
+                :rel => 'entityResolver'}]}
+
+          if @api_version.to_f >= 5.1
+            body[:Link] << {
+              :href => make_href('extensibility'),
+              :type => 'application/vnd.vmware.vcloud.apiextensibility+xml',
+              :rel => 'down:extensibility'
+            }
+          end
+
+          Excon::Response.new(
+            :body => body,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :status => 200
+          )
+        end
+      end
+    end
+  end
+end