fog-vcloud-director 0.1.0

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

@@ -0,0 +1,83 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        extend Fog::Deprecation
+        deprecate :get_edge_gateways, :get_org_vdc_gateways
+
+        # List all gateways for this Org 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-OrgVdcGateways.html
+        # @since vCloud API version 5.1
+        def get_org_vdc_gateways(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "admin/vdc/#{id}/edgeGateways"
+          )
+          ensure_list! response.body, :EdgeGatewayRecord
+          response
+        end
+      end
+
+      class Mock
+        def get_org_vdc_gateways(vdc_id)
+          unless 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,
+             :total => "1",
+             :pageSize => "25",
+             :page => "1",
+             :name => "edgeGateways",
+             :type => "application/vnd.vmware.vcloud.query.records+xml",
+             :href => make_href("admin/vdc/#{vdc_id}edgeGateways?page=1&pageSize=25&format=records"),
+             :xsi_schemaLocation => xsi_schema_location,
+             :Link =>
+              [{:rel => "alternate",
+                :type => "application/vnd.vmware.vcloud.query.references+xml",
+                :href => make_href("admin/vdc/#{vdc_id}edgeGateways?page=1&pageSize=25&format=references")},
+               {:rel => "alternate",
+                :type => "application/vnd.vmware.vcloud.query.idrecords+xml",
+                :href => make_href("admin/vdc/#{vdc_id}edgeGateways?page=1&pageSize=25&format=records")}],
+             :EdgeGatewayRecord => []}
+
+          vdc_edge_gateways = data[:edge_gateways].select do |id, edge_gateway|
+            edge_gateway[:vdc] == vdc_id
+          end
+
+          body[:EdgeGatewayRecord] += vdc_edge_gateways.map do |id, edge_gateway|
+            {:vdc => make_href("vdc/#{vdc_id}"),
+             :numberOfOrgNetworks => "1",
+             :numberOfExtNetworks => "1",
+             :name => edge_gateway[:name],
+             :isBusy => "false",
+             :haStatus => "DISABLED",
+             :gatewayStatus => "READY",
+             :href => make_href("admin/edgeGateway/#{id}"),
+             :isSyslogServerSettingInSync => "true"}
+          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_organization.rb

@@ -0,0 +1,100 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve an organization.
+        #
+        # @param [String] id The object identifier of the organization.
+        # @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-Organization.html
+        # @since vCloud API version 0.9
+        def get_organization(id)
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "org/#{id}"
+          )
+          ensure_list! response.body, :Tasks, :Task
+          response
+        end
+      end
+
+      class Mock
+        def get_organization(id)
+          unless id == data[:org][:uuid]
+            raise Fog::Compute::VcloudDirector::Forbidden.new(
+              "No access to entity \"com.vmware.vcloud.entity.org:#{id}\""
+            )
+          end
+          org = data[:org]
+
+          body =
+            {:href=>make_href("org/#{id}"),
+             :type=>"application/vnd.vmware.vcloud.org+xml",
+             :id=>"urn:vcloud:org:#{id}",
+             :name=>org[:name],
+             :Link=>
+              [{:href=>make_href("tasksList/#{id}"),
+                :type=>"application/vnd.vmware.vcloud.tasksList+xml",
+                :rel=>"down"},
+               {:href=>make_href("admin/org/#{id}/catalogs"),
+                :type=>"application/vnd.vmware.admin.catalog+xml",
+                :rel=>"add"},
+               {:href=>make_href("org/#{id}/metadata"),
+                :type=>"application/vnd.vmware.vcloud.metadata+xml",
+                :rel=>"down"}],
+             :Description=>org[:description]||'',
+             :Tasks=>{:Task=>[]},
+             :FullName=>org[:full_name]}
+
+          body[:Link] += data[:catalogs].map do |catalog_id, catalog|
+            [{:href=>make_href("catalog/#{catalog_id}"),
+              :name=>catalog[:name],
+              :type=>"application/vnd.vmware.vcloud.catalog+xml",
+              :rel=>"down"},
+             {:href=>make_href("org/#{id}/catalog/#{catalog_id}/controlAccess/"),
+              :type=>"application/vnd.vmware.vcloud.controlAccess+xml",
+              :rel=>"down"},
+             {:href=>
+               make_href("org/#{id}/catalog/#{catalog_id}/action/controlAccess"),
+              :type=>"application/vnd.vmware.vcloud.controlAccess+xml",
+              :rel=>"controlAccess"}]
+          end.flatten
+
+          body[:Link] += data[:networks].map do |network_id, network|
+            {:href=>make_href("network/#{network_id}"),
+             :name=>network[:name],
+             :type=>"application/vnd.vmware.vcloud.orgNetwork+xml",
+             :rel=>"down"}
+          end
+
+          body[:Link] += data[:vdcs].map do |vdc_id, vdc|
+            {:href=>make_href("vdc/#{vdc_id}"),
+             :name=>vdc[:name],
+             :type=>"application/vnd.vmware.vcloud.vdc+xml",
+             :rel=>"down"}
+          end
+
+          if api_version.to_f >= 5.1
+            body[:Link] <<
+              {:href=>make_href('supportedSystemsInfo/'),
+               :type=>"application/vnd.vmware.vcloud.supportedSystemsInfo+xml",
+               :rel=>"down"}
+          end
+
+          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_organization_metadata.rb

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

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

@@ -0,0 +1,28 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve the value of the specified key in the specified domain from
+        # organization 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-OrganizationMetadataItem-metadata.html
+        # @since vCloud API version 5.1
+        def get_organization_metadata_item_metadata(id, domain, key)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "admin/org/#{id}/metadata/#{URI.escape(domain)}/#{URI.escape(key)})"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a list of organizations accessible to you.
+        #
+        # The system administrator has access to all organizations.
+        #
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #     * :href<~String> - The URI of the entity.
+        #     * :type<~String> - The MIME type of the entity.
+        #     * :Org<~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.
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-Organizations.html
+        # @since vCloud API version 0.9
+        def get_organizations
+          response = request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => 'org'
+          )
+          ensure_list! response.body, :Org
+          response
+        end
+      end
+
+      class Mock
+        def get_organizations
+          body =
+            {:href=>make_href('org/'),
+             :type=>"application/vnd.vmware.vcloud.orgList+xml",
+             :Org=>
+              [{:href=>make_href("org/#{data[:org][:uuid]}"),
+                :name=>data[:org][:name],
+                :type=>"application/vnd.vmware.vcloud.org+xml"}]}
+
+          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_organizations_from_query.rb

@@ -0,0 +1,95 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieves a list of organizations 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.
+        #     * :OrganizationRecord<~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-OrganizationsFromQuery.html
+        # @since vCloud API version 1.5
+        def get_organizations_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/orgs/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' ?
+              :OrganizationReference : :OrganizationRecord
+
+          %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_product_sections_vapp.rb

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

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

@@ -0,0 +1,26 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # Retrieve a list of ProductSection elements from a vApp template or
+        # VM.
+        #
+        # @param [String] id Object identifier of the vApp template or VM.
+        # @return [Excon::Response]
+        #   * body<~Hash>:
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/operations/GET-ProductSections-vAppTemplate.html
+        # @since vCloud API version 1.5
+        def get_product_sections_vapp_template(id)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::ToHashDocument.new,
+            :path       => "vAppTemplate/#{id}/productSections"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Fog
+  module Compute
+    class VcloudDirector
+      class Real
+        # This is used for manual testing.
+        #
+        # @api private
+        def get_request(uri)
+          request(
+            :expects    => 200,
+            :idempotent => true,
+            :method     => 'GET',
+            :path       => uri
+          )
+        end
+      end
+    end
+  end
+end