vra-restapi 1.5.2

data/lib/vra-restapi/exceptions.rb

@@ -0,0 +1,61 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'json'
+
+module Vra
+  module Exception
+    class DuplicateItemsDetected < RuntimeError; end
+    class NotFound < RuntimeError; end
+    class RequestError < RuntimeError; end
+    class Unauthorized < RuntimeError; end
+
+    class HTTPError < RuntimeError
+      attr_accessor :klass, :code, :body, :errors, :path
+      def initialize(opts={})
+        @code = opts[:code]
+        @body = opts[:body]
+        @path = opts[:path]
+        @klass = opts[:klass]
+        @errors = []
+
+        parse_errors
+      end
+
+      def parse_errors
+        begin
+          if @body.nil?
+            return
+          end
+          data = JSON.parse(@body)
+        rescue JSON::ParserError => e
+          return
+        end
+
+        return if data.nil?
+        return unless data['errors'].respond_to?(:each)
+
+        data['errors'].each do |error|
+          @errors << error['systemMessage']
+        end
+      end
+    end
+
+    class HTTPNotFound < HTTPError; end
+  end
+end

data/lib/vra-restapi/request.rb

@@ -0,0 +1,97 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'json'
+
+module Vra
+  class Request
+    attr_reader :client, :id
+    def initialize(client, id)
+      @client = client
+      @id     = id
+
+      @request_data       = nil
+      @status             = nil
+      @completion_state   = nil
+      @completion_details = nil
+    end
+
+    def refresh
+      @request_data = JSON.parse(client.http_get!("/catalog-service/api/consumer/requests/#{@id}"))
+    rescue Vra::Exception::HTTPNotFound
+      raise Vra::Exception::NotFound, "request ID #{@id} is not found"
+    end
+
+    def refresh_if_empty
+      refresh if request_empty?
+    end
+
+    def request_empty?
+      @request_data.nil?
+    end
+
+    def status
+      refresh_if_empty
+      return if request_empty?
+
+      @request_data['phase']
+    end
+
+    def completed?
+      successful? || failed?
+    end
+
+    def successful?
+      status == 'SUCCESSFUL'
+    end
+
+    def failed?
+      status == 'FAILED'
+    end
+
+    def completion_state
+      refresh_if_empty
+      return if request_empty?
+
+      @request_data['requestCompletion']['requestCompletionState']
+    end
+
+    def completion_details
+      refresh_if_empty
+      return if request_empty?
+
+      @request_data['requestCompletion']['completionDetails']
+    end
+
+    def resources
+      resources = []
+
+      begin
+        request_resources = client.http_get_paginated_array!("/catalog-service/api/consumer/requests/#{@id}/resources")
+      rescue Vra::Exception::HTTPNotFound
+        raise Vra::Exception::NotFound, "resources for request ID #{@id} are not found"
+      end
+
+      request_resources.each do |resource|
+        resources << Vra::Resource.new(client, data: resource)
+      end
+
+      resources
+    end
+  end
+end

data/lib/vra-restapi/request_parameters.rb

@@ -0,0 +1,67 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Vra
+  class RequestParameters
+    def initialize
+      @entries = {}
+    end
+
+    def set(key, type, value)
+      @entries[key] = Vra::RequestParameter.new(key, type, value)
+    end
+
+    def delete(key)
+      @entries.delete(key)
+    end
+
+    def all_entries
+      @entries.values
+    end
+  end
+
+  class RequestParameter
+    attr_accessor :key, :type, :value
+    def initialize(key, type, value)
+      @key   = key
+      @type  = type
+      @value = value
+    end
+
+    def to_h
+      {
+        'key' => @key,
+        'value' => {
+          'type' => @type,
+          'value' => format_value
+        }
+      }
+    end
+
+    def format_value
+      case @type
+      when 'integer'
+        @value.to_i
+      when 'string'
+        @value.to_s
+      else
+        @value.to_s
+      end
+    end
+  end
+end

data/lib/vra-restapi/requests.rb

@@ -0,0 +1,40 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Vra
+  class Requests
+    def initialize(client)
+      @client = client
+    end
+
+    def all_requests
+      requests = []
+
+      items = @client.http_get_paginated_array!('/catalog-service/api/consumer/requests')
+      items.each do |item|
+        requests << Vra::Request.new(@client, item['id'])
+      end
+
+      requests
+    end
+
+    def by_id(id)
+      Vra::Request.new(@client, id)
+    end
+  end
+end

data/lib/vra-restapi/resource.rb

@@ -0,0 +1,234 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'json'
+
+module Vra
+  # rubocop:disable ClassLength
+  class Resource
+    attr_reader :client, :id, :resource_data
+
+    def initialize(client, opts)
+      @client           = client
+      @id               = opts[:id]
+      @resource_data    = opts[:data]
+      @resource_actions = []
+
+      if @id.nil? && @resource_data.nil?
+        raise ArgumentError, 'must supply an id or a resource data hash'
+      end
+
+      if ! @id.nil? && ! @resource_data.nil?
+        raise ArgumentError, 'must supply an id OR a resource data hash, not both'
+      end
+
+      if @resource_data.nil?
+        fetch_resource_data
+      else
+        @id = @resource_data['id']
+      end
+    end
+
+    def fetch_resource_data
+      @resource_data = JSON.parse(client.http_get!("/catalog-service/api/consumer/resources/#{@id}"))
+    rescue Vra::Exception::HTTPNotFound
+      raise Vra::Exception::NotFound, "resource ID #{@id} does not exist"
+    end
+    alias refresh fetch_resource_data
+
+    def name
+      resource_data['name']
+    end
+
+    def description
+      resource_data['description']
+    end
+
+    def status
+      resource_data['status']
+    end
+
+    def vm?
+      %w(Infrastructure.Virtual Infrastructure.Cloud).include?(resource_data['resourceTypeRef']['id'])
+    end
+
+    def tenant_id
+      resource_data['organization']['tenantRef']
+    end
+
+    def tenant_name
+      resource_data['organization']['tenantLabel']
+    end
+
+    def subtenant_id
+      resource_data['organization']['subtenantRef']
+    end
+
+    def subtenant_name
+      resource_data['organization']['subtenantLabel']
+    end
+
+    def catalog_id
+      resource_data['catalogItem']['id']
+    end
+
+    def catalog_name
+      resource_data['catalogItem']['label']
+    end
+
+    def owner_ids
+      resource_data['owners'].map { |x| x['ref'] }
+    end
+
+    def owner_names
+      resource_data['owners'].map { |x| x['value'] }
+    end
+
+    def machine_status
+      status = resource_data['resourceData']['entries'].find { |x| x['key'] == 'MachineStatus' }
+      raise 'No MachineStatus entry available for resource' if status.nil?
+
+      status['value']['value']
+    end
+
+    def machine_on?
+      machine_status == 'On'
+    end
+
+    def machine_off?
+      machine_status == 'Off'
+    end
+
+    def machine_turning_on?
+      machine_status == 'TurningOn' || machine_status == 'MachineActivated'
+    end
+
+    def machine_turning_off?
+      %w(TurningOff ShuttingDown).include?(machine_status)
+    end
+
+    def machine_in_provisioned_state?
+      machine_status == 'MachineProvisioned'
+    end
+
+    def network_interfaces
+      return unless vm?
+
+      network_list = resource_data['resourceData']['entries'].find { |x| x['key'] == 'NETWORK_LIST' }
+      return if network_list.nil?
+
+      network_list['value']['items'].each_with_object([]) do |item, nics|
+        nic = {}
+        item['values']['entries'].each do |entry|
+          key = entry['key']
+          value = entry['value']['value']
+          nic[key] = value
+        end
+
+        nics << nic
+      end
+    end
+
+    def ip_addresses
+      return if !vm? || network_interfaces.nil?
+
+      addrs = []
+      network_interfaces.each do |nic|
+        next unless nic.key?('NETWORK_ADDRESS')
+        addrs << nic['NETWORK_ADDRESS']
+      end
+
+      addrs
+    end
+
+    def actions
+      # if this Resource instance was created with data from a "all_resources" fetch,
+      # it is likely missing operations data because the vRA API is not pleasant sometimes.
+      fetch_resource_data if resource_data['operations'].nil?
+
+      resource_data['operations']
+    end
+
+    def action_id_by_name(name)
+      return if actions.nil?
+
+      action = actions.find { |x| x['name'] == name }
+      return if action.nil?
+
+      action['id']
+    end
+
+    def destroy
+      action_id = action_id_by_name('Destroy')
+      raise Vra::Exception::NotFound, "No destroy action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id)
+    end
+
+    def shutdown
+      action_id = action_id_by_name('Shutdown')
+      raise Vra::Exception::NotFound, "No shutdown action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id)
+    end
+
+    def poweroff
+      action_id = action_id_by_name('Power Off')
+      raise Vra::Exception::NotFound, "No power-off action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id)
+    end
+
+    def poweron
+      action_id = action_id_by_name('Power On')
+      raise Vra::Exception::NotFound, "No power-on action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id)
+    end
+
+    def action_request_payload(action_id)
+      {
+        '@type' => 'ResourceActionRequest',
+        'resourceRef' => {
+          'id' => @id
+        },
+        'resourceActionRef' => {
+          'id' => action_id
+        },
+        'organization' => {
+          'tenantRef' => tenant_id,
+          'tenantLabel' => tenant_name,
+          'subtenantRef' => subtenant_id,
+          'subtenantLabel' => subtenant_name
+        },
+        'state' => 'SUBMITTED',
+        'requestNumber' => 0,
+        'requestData' => {
+          'entries' => []
+        }
+      }
+    end
+
+    def submit_action_request(action_id)
+      payload = action_request_payload(action_id).to_json
+      response = client.http_post('/catalog-service/api/consumer/requests', payload)
+      request_id = response.headers[:location].split('/')[-1]
+      Vra::Request.new(client, request_id)
+    end
+  end
+end