fog-vcloud-director 0.1.0

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

@@ -0,0 +1,95 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of groups for organization the org admin belongs to
+        # 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.
+        #     * :GroupRecord<~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-GroupsFromQuery.html
+        # @since vCloud API version 1.5
+        def get_groups_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/groups/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' ?
+              :GroupReference : :GroupRecord
+
+          %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_guest_customization_system_section_vapp.rb

@@ -0,0 +1,69 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves the guest customization section 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-GuestCustomizationSystemSection-vApp.html
+        # @since vCloud API version 1.0
+        def get_guest_customization_system_section_vapp(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/guestCustomizationSection"
+          )
+        end
+      end
+
+      class Mock
+        def get_guest_customization_system_section_vapp(id)
+
+          type = 'application/vnd.vmware.vcloud.guestCustomizationSection+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_vm_guest_customization_section_body(id, vm)
+          )
+        end
+
+        def get_vm_guest_customization_section_body(id, vm)
+          {
+            :type => "application/vnd.vmware.vcloud.guestCustomizationSection+xml",
+            :href => make_href("vApp/#{id}/guestCustomizationSection/"),
+            :ovf_required => "false",
+            :"ovf:Info" => "Specifies Guest OS Customization Settings",
+            :Enabled => "true",
+            :ChangeSid => "false",
+            :VirtualMachineId => id.split('-').last, # strip the 'vm-' prefix
+            :JoinDomainEnabled => "false",
+            :UseOrgSettings => "false",
+            :AdminPasswordEnabled => "false",
+            :AdminPasswordAuto => "true",
+            :ResetPasswordRequired => "false",
+            :CustomizationScript => vm[:customization_script] || "",
+            :ComputerName => vm[:computer_name] || vm[:name],
+            :Link => {
+              :rel=>"edit",
+              :type=>"application/vnd.vmware.vcloud.guestCustomizationSection+xml",
+              :href=>make_href("vApp/#{id}"),
+            },
+          }
+        end
+
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # This is used for manual testing.
+        #
+        # @api private
+        def get_href(href)
+          request(
+            :expects       => 200,
+            :idempotent    => true,
+            :method        => 'GET',
+            :parser        => Fog::ToHashDocument.new,
+            :override_path => true,
+            :path          => URI.parse(href).path
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves the lease settings section of 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-LeaseSettingsSection-vApp.html
+        # @since vCloud API version 1.0
+        def get_lease_settings_section_vapp(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/leaseSettingsSection"
+          )
+        end
+      end
+
+      class Mock
+
+        def get_lease_settings_section_vapp(id)
+
+          type = 'application/vnd.vmware.vcloud.leaseSettingsSection+xml'
+
+          unless vapp = data[:vapps][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_vapp_lease_settings_section_body(id)
+          )
+
+        end
+
+        def get_vapp_lease_settings_section_body(id)
+          {
+            :type => "application/vnd.vmware.vcloud.leaseSettingsSection+xml",
+            :href => make_href("vApp/#{id}/leaseSettingsSection/"),
+            :ovf_required=>"false",
+            :"ovf:Info"=>"Lease settings section",
+            :DeploymentLeaseInSeconds=>"0",
+            :StorageLeaseInSeconds=>"0",
+          }
+        end
+
+      end
+
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,92 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve all RASD items that specify CD-ROM, DVD, and floppy disk
+        # device and controller properties of a VM.
+        #
+        # @param [String] id Object identifier of the VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-MediaDrivesRasdItemsList.html
+        # @since vCloud API version 0.9
+        def get_media_drives_rasd_items_list(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vApp/#{id}/virtualHardwareSection/media"
+          )
+        end
+      end
+
+      class Mock
+
+        def get_media_drives_rasd_items_list(id)
+          type = 'application/vnd.vmware.vcloud.rasdItemsList+xml'
+
+          unless vm = data[:vms][id]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              'This operation is denied.'
+            )
+          end
+
+          body = {
+            :type => type,
+            :href => make_href("vApp/#{id}/virtualHardwareSection/media"),
+            :Item => [
+              get_media_rasd_item_ide_controller_body(id, vm),
+              get_media_rasd_item_cdrom_body(id, vm),
+              get_media_rasd_item_floppy_body(id, vm),
+            ]
+          }
+
+          Excon::Response.new(
+            :status => 200,
+            :headers => {'Content-Type' => "#{type};version=#{api_version}"},
+            :body => body
+          )
+        end
+
+        def get_media_rasd_item_ide_controller_body(id, vm)
+          {
+            :"rasd:Address"=>"0",
+            :"rasd:Description"=>"IDE Controller",
+            :"rasd:ElementName"=>"IDE Controller 0",
+            :"rasd:InstanceID"=>"3",
+            :"rasd:ResourceType"=>"5"
+          }
+        end
+
+        def get_media_rasd_item_cdrom_body(id, vm)
+          {
+            :"rasd:AddressOnParent"=>"1",
+            :"rasd:AutomaticAllocation"=>"true",
+            :"rasd:Description"=>"CD/DVD Drive",
+            :"rasd:ElementName"=>"CD/DVD Drive 1",
+            :"rasd:HostResource"=>"",
+            :"rasd:InstanceID"=>"3000",
+            :"rasd:Parent"=>"3",
+            :"rasd:ResourceType"=>"15"
+          }
+        end
+
+        def get_media_rasd_item_floppy_body(id, vm)
+          {
+            :"rasd:AddressOnParent"=>"0",
+            :"rasd:AutomaticAllocation"=>"false",
+            :"rasd:Description"=>"Floppy Drive",
+            :"rasd:ElementName"=>"Floppy Drive 1",
+            :"rasd:HostResource"=>"",
+            :"rasd:InstanceID"=>"8000",
+            :"rasd:ResourceType"=>"14"
+          }
+        end
+
+      end
+
+    end
+  end
+end