fog-maestrodev 1.15.0.20130927082724 → 1.18.0.20131111203459

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

@@ -0,0 +1,18 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # @return [Excon::Response]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/DELETE-Logout.html
+        def delete_logout
+          request(
+            :expects => 204,
+            :method  => 'DELETE',
+            :path    => 'session'
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Delete a media object.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @param [String] id Object identifier of the media object.
+        # @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.
+        #     * :operationKey<~String> - Optional unique identifier to support
+        #       idempotent semantics for create and delete operations.
+        #     * :name<~String> - The name of the entity.
+        #     * :cancelRequested<~String> - Whether user has requested this
+        #       processing to be canceled.
+        #     * :endTime<~String> - The date and time that processing of the
+        #       task was completed. May not be present if the task is still
+        #       being executed.
+        #     * :expiryTime<~String> - The date and time at which the task
+        #       resource will be destroyed and no longer available for
+        #       retrieval. May not be present if the task has not been executed
+        #       or is still being executed.
+        #     * :operation<~String> - A message describing the operation that
+        #       is tracked by this task.
+        #     * :operationName<~String> - The short name of the operation that
+        #       is tracked by this task.
+        #     * :serviceNamespace<~String> - Identifier of the service that
+        #       created the task.
+        #     * :startTime<~String> - The date and time the system started
+        #       executing the task. May not be present if the task has not been
+        #       executed yet.
+        #     * :status<~String> - The execution status of the task.
+        #     * :Link<~Array<Hash>>:
+        #     * :Description<~String> - Optional description.
+        #     * :Owner<~Hash> - Reference to the owner of the task. This is
+        #       typically the object that the task is creating or updating.
+        #     * :href<~String> - Contains the URI to the entity.
+        #     * :name<~String> - Contains the name of the entity.
+        #     * :type<~String> - Contains the type of the entity.
+        #     * :Error<~Hash> - Represents error information from a failed
+        #       task.
+        #       * :majorErrorCode<~String> - The class of the error. Matches
+        #         the HTTP status code.
+        #       * :message<~String> - An one line, human-readable message
+        #         describing the error that occurred.
+        #       * :minorErrorCode<~String> - Resource-specific error code.
+        #       * :stackTrace<~String> - The stack trace of the exception.
+        #       * :vendorSpecificErrorCode<~String> - A vendor- or
+        #         implementation-specific error code that can reference
+        #         specific modules or source lines for diagnostic purposes.
+        #       * :User<~Hash> - The user who started the task.
+        #         * :href<~String> - Contains the URI to the entity.
+        #         * :name<~String> - Contains the name of the entity.
+        #         * :type<~String> - Contains the type of the entity.
+        #       * :Organization<~Hash> - The organization to which the :User
+        #         belongs.
+        #         * :href<~String> - Contains the URI to the entity.
+        #         * :name<~String> - Contains the name of the entity.
+        #         * :type<~String> - Contains the type of the entity.
+        #       * :Progress<~String> - Read-only indicator of task progress as
+        #         an approximate percentage between 0 and 100. Not available
+        #         for all tasks.
+        #       * :Params
+        #       * :Details<~String> - Detailed message about the task. Also
+        #         contained by the :Owner entity when task status is
+        #         preRunning.
+        #
+        # @raise [Fog::Compute::VcloudDirector::Forbidden]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/DELETE-Media.html
+        # @since vCloud API version 0.9
+        def delete_media(id)
+          request(
+            :expects => 202,
+            :method  => 'DELETE',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "media/#{id}"
+          )
+        end
+      end
+
+      class Mock
+        def delete_media(id)
+          unless media = data[:medias][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"(com.vmware.vcloud.entity.media:#{id})\""
+            )
+          end
+
+          owner = {
+            :href => make_href("media/#{id}"),
+            :type => 'application/vnd.vmware.vcloud.media+xml'
+          }
+          task_id = enqueue_task(
+            "Deleting Media File(#{media[:file][:uuid]})", 'vdcDeleteMedia', owner,
+            :on_success => lambda do
+              data[:medias].delete(id)
+            end
+          )
+          body = {
+            :xmlns => xmlns,
+            :xmlns_xsi => xmlns_xsi,
+            :xsi_schemaLocation => xsi_schema_location,
+          }.merge(task_body(task_id))
+
+          Excon::Response.new(
+            :status => 202,
+            :headers => {'Content-Type' => "#{body[:type]};version=#{api_version}"},
+            :body => body
+          )
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,30 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Deletes shadow VM.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @deprecated Since vCloud API version 5.1 this operation may be
+        #   removed in a future release.
+        #
+        # @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/DELETE-ShadowVm.html
+        # @since vCloud API version 1.5
+        def delete_shadow_vm(id)
+          request(
+            :expects => 202,
+            :method  => 'DELETE',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "shadowVm/#{id}"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -2,19 +2,28 @@ module Fog
   module Compute
     class VcloudDirector
       class Real
-
-        def delete_vapp(vapp_id)
-
+        # Delete a vApp or VM.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @param [String] id Object identifier of the vApp.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @raise [Fog::Compute::VcloudDirector::BadRequest]
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/DELETE-VApp.html
+        # @since vCloud API version 0.9
+        def delete_vapp(id)
           request(
-            :expects  => 202,
-            :method   => 'DELETE',
-            :parser => Fog::ToHashDocument.new,
-            :path     => "vApp/#{vapp_id}"
+            :expects => 202,
+            :method  => 'DELETE',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}"
           )
         end
-
       end
     end
   end
 end
-

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

@@ -0,0 +1,30 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :delete_metadata, :delete_vapp_metadata_item_metadata
+
+        require 'fog/vcloud_director/parsers/compute/metadata'
+
+        # Delete the specified key and its value from vApp or VM metadata.
+        #
+        # @param [String] id Object identifier of the vApp or VM.
+        # @param [String] key Key of the metadata item.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/DELETE-VAppMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def delete_vapp_metadata_item_metadata(id, key)
+          request(
+            :expects => 202,
+            :method  => 'DELETE',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vApp/#{id}/metadata/#{URI.escape(key)}"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Delete a vApp template.
+        #
+        # This operation is asynchronous and returns a task that you can
+        # monitor to track the progress of the request.
+        #
+        # @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/DELETE-VAppTemplate.html
+        # @since vCloud API version 0.9
+        def delete_vapp_template(id)
+          request(
+            :expects => 202,
+            :method  => 'DELETE',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vAppTemplate/#{id}"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Delete the specified key and its value from vApp template or VM
+        # metadata.
+        #
+        # @param [String] id Object identifier of the vApp template or VM.
+        # @param [String] key Key of the metadata item.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/DELETE-VAppTemplateMetadataItem-metadata.html
+        # @since vCloud API version 1.5
+        def delete_vapp_template_metadata_item_metadata(id, key)
+          request(
+            :expects => 202,
+            :method  => 'DELETE',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "vAppTemplate/#{id}/metadata/#{URI.escape(key)}"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a list of IP addresses allocated to 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-AllocatedIpAddresses.html
+        # @since vCloud API version 5.1
+        def get_allocated_ip_addresses(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "network/#{id}/allocatedAddresses"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -2,16 +2,40 @@ module Fog
   module Compute
     class VcloudDirector
       class Real
-
-        def get_catalog(catalog_uuid)
-          request(
-            :expects => 200,
-            :method  => 'GET',
-            :parser  => Fog::ToHashDocument.new,
-            :path    => "catalog/#{catalog_uuid}"
+        # 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
+
+          Fog::Mock.not_implemented
+          catalog.is_used_here # avoid warning from syntax checker
+        end
       end
     end
   end

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

@@ -2,16 +2,23 @@ module Fog
   module Compute
     class VcloudDirector
       class Real
-
-        def get_catalog_item(catalog_item_id)
+        # 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,
-            :method  => 'GET',
-            :parser  => Fog::ToHashDocument.new,
-            :path    => "catalogItem/#{catalog_item_id}"
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "catalogItem/#{id}"
           )
         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].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_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