vra-restapi 1.5.2

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:style)
+
+task default: [ :spec, :style ]

data/lib/vra-restapi.rb

@@ -0,0 +1,29 @@
+#
+# 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 'vra-restapi/catalog'
+require 'vra-restapi/catalog_item'
+require 'vra-restapi/catalog_request'
+require 'vra-restapi/client'
+require 'vra-restapi/exceptions'
+require 'vra-restapi/request'
+require 'vra-restapi/request_parameters'
+require 'vra-restapi/requests'
+require 'vra-restapi/resource'
+require 'vra-restapi/resources'
+require 'vra-restapi/version'

data/lib/vra-restapi/catalog.rb

@@ -0,0 +1,41 @@
+#
+# 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 Catalog
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def all_items
+      client.http_get_paginated_array!('/catalog-service/api/consumer/catalogItems')
+            .map! { |x| Vra::CatalogItem.new(client, data: x) }
+    end
+
+    def entitled_items
+      client.http_get_paginated_array!('/catalog-service/api/consumer/entitledCatalogItems')
+            .map! { |x| Vra::CatalogItem.new(client, data: x['catalogItem']) }
+    end
+
+    def request(*args)
+      Vra::CatalogRequest.new(@client, *args)
+    end
+  end
+end

data/lib/vra-restapi/catalog_item.rb

@@ -0,0 +1,81 @@
+#
+# 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 CatalogItem
+    attr_reader :id, :client
+    def initialize(client, opts)
+      @client            = client
+      @id                = opts[:id]
+      @catalog_item_data = opts[:data]
+
+      if @id.nil? && @catalog_item_data.nil?
+        raise ArgumentError, 'must supply an id or a catalog item data hash'
+      end
+
+      if ! @id.nil? && ! @catalog_item_data.nil?
+        raise ArgumentError, 'must supply an id OR a catalog item data hash, not both'
+      end
+
+      if @catalog_item_data.nil?
+        fetch_catalog_item
+      else
+        @id = @catalog_item_data['id']
+      end
+    end
+
+    def fetch_catalog_item
+      @catalog_item_data = JSON.parse(client.http_get!("/catalog-service/api/consumer/catalogItems/#{id}"))
+    rescue Vra::Exception::HTTPNotFound
+      raise Vra::Exception::NotFound, "catalog ID #{id} does not exist"
+    end
+
+    def name
+      @catalog_item_data['name']
+    end
+
+    def description
+      @catalog_item_data['description']
+    end
+
+    def status
+      @catalog_item_data['status']
+    end
+
+    def tenant_id
+      @catalog_item_data['organization']['tenantRef']
+    end
+
+    def tenant_name
+      @catalog_item_data['organization']['tenantLabel']
+    end
+
+    def subtenant_id
+      @catalog_item_data['organization']['subtenantRef']
+    end
+
+    def subtenant_name
+      @catalog_item_data['organization']['subtenantLabel']
+    end
+
+    def blueprint_id
+      @catalog_item_data['providerBinding']['bindingId']
+    end
+  end
+end

data/lib/vra-restapi/catalog_request.rb

@@ -0,0 +1,112 @@
+#
+# 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 CatalogRequest
+    attr_reader :catalog_id, :catalog_item, :client, :custom_fields
+    attr_writer :subtenant_id
+    attr_accessor :cpus, :memory, :requested_for, :lease_days, :notes
+
+    def initialize(client, catalog_id, opts={})
+      @client            = client
+      @catalog_id        = catalog_id
+      @cpus              = opts[:cpus]
+      @memory            = opts[:memory]
+      @requested_for     = opts[:requested_for]
+      @lease_days        = opts[:lease_days]
+      @notes             = opts[:notes]
+      @subtenant_id      = opts[:subtenant_id]
+      @additional_params = Vra::RequestParameters.new
+
+      @catalog_item = Vra::CatalogItem.new(client, id: catalog_id)
+    end
+
+    def set_parameter(key, type, value)
+      @additional_params.set(key, type, value)
+    end
+
+    def delete_parameter(key)
+      @additional_params.delete(key)
+    end
+
+    def parameters
+      @additional_params.all_entries
+    end
+
+    def subtenant_id
+      @subtenant_id || catalog_item.subtenant_id
+    end
+
+    def validate_params!
+      missing_params = []
+      [ :catalog_id, :cpus, :memory, :requested_for, :subtenant_id ].each do |param|
+        missing_params << param.to_s if send(param).nil?
+      end
+
+      raise ArgumentError, "Unable to submit request, required param(s) missing => #{missing_params.join(', ')}" unless missing_params.empty?
+    end
+
+    def request_payload
+      payload = {
+        '@type' => 'CatalogItemRequest',
+        'catalogItemRef' => {
+          'id' => @catalog_id
+        },
+        'organization' => {
+          'tenantRef'    => catalog_item.tenant_id,
+          'subtenantRef' => subtenant_id
+        },
+        'requestedFor' => @requested_for,
+        'state' => 'SUBMITTED',
+        'requestNumber' => 0,
+        'requestData' => {
+          'entries' => [
+            Vra::RequestParameter.new('provider-blueprintId', 'string', catalog_item.blueprint_id).to_h,
+            Vra::RequestParameter.new('provider-provisioningGroupId', 'string', subtenant_id).to_h,
+            Vra::RequestParameter.new('requestedFor', 'string', @requested_for).to_h,
+            Vra::RequestParameter.new('provider-VirtualMachine.CPU.Count', 'integer', @cpus).to_h,
+            Vra::RequestParameter.new('provider-VirtualMachine.Memory.Size', 'integer', @memory).to_h,
+            Vra::RequestParameter.new('provider-VirtualMachine.LeaseDays', 'integer', @lease_days).to_h,
+            Vra::RequestParameter.new('provider-__Notes', 'string', @notes).to_h
+          ]
+        }
+      }
+
+      parameters.each do |entry|
+        payload['requestData']['entries'] << entry.to_h
+      end
+
+      payload
+    end
+
+    def submit
+      validate_params!
+
+      begin
+        response = client.http_post('/catalog-service/api/consumer/requests', request_payload.to_json)
+      rescue Vra::Exception::HTTPError => e
+        raise Vra::Exception::RequestError, "Unable to submit request: #{e.errors.join(', ')}"
+      rescue
+        raise
+      end
+
+      request_id = response.headers[:location].split('/')[-1]
+      Vra::Request.new(client, request_id)
+    end
+  end
+end

data/lib/vra-restapi/client.rb

@@ -0,0 +1,223 @@
+#
+# 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'
+require 'rest-client'
+require 'passwordmasker'
+
+module Vra
+  # rubocop:disable ClassLength
+  class Client
+    attr_accessor :page_size
+
+    def initialize(opts)
+      @base_url     = opts[:base_url]
+      @username     = opts[:username]
+      @password     = PasswordMasker.new(opts[:password])
+      @tenant       = opts[:tenant]
+      @verify_ssl   = opts.fetch(:verify_ssl, true)
+      @bearer_token = PasswordMasker.new(nil)
+      @page_size    = opts.fetch(:page_size, 20)
+
+      validate_client_options!
+    end
+
+    #########################
+    #
+    # methods to other classes
+    #
+
+    def catalog
+      Vra::Catalog.new(self)
+    end
+
+    def requests(*args)
+      Vra::Requests.new(self, *args)
+    end
+
+    def resources(*args)
+      Vra::Resources.new(self, *args)
+    end
+
+    #########################
+    #
+    # client methods
+    #
+
+    def bearer_token
+      @bearer_token.value
+    end
+
+    def bearer_token=(value)
+      @bearer_token.value = value
+    end
+
+    def bearer_token_request_body
+      {
+        'username' => @username,
+        'password' => @password.value,
+        'tenant'   => @tenant
+      }
+    end
+
+    def request_headers
+      headers = {}
+      headers['Accept']        = 'application/json'
+      headers['Content-Type']  = 'application/json'
+      headers['Authorization'] = "Bearer #{@bearer_token.value}" unless @bearer_token.value.nil?
+      headers
+    end
+
+    def authorize!
+      generate_bearer_token unless authorized?
+
+      raise Vra::Exception::Unauthorized, 'Unable to authorize against vRA' unless authorized?
+    end
+
+    def authorized?
+      return false if @bearer_token.value.nil?
+
+      response = http_head("/identity/api/tokens/#{@bearer_token.value}", :skip_auth)
+      if response.code == 204
+        true
+      else
+        false
+      end
+    end
+
+    def generate_bearer_token
+      @bearer_token.value = nil
+      validate_client_options!
+
+      response = http_post('/identity/api/tokens', bearer_token_request_body.to_json, :skip_auth)
+      if response.code != 200
+        raise Vra::Exception::Unauthorized, "Unable to get bearer token: #{response.body}"
+      end
+
+      @bearer_token.value = JSON.parse(response.body)['id']
+    end
+
+    def full_url(path)
+      "#{@base_url}#{path}"
+    end
+
+    def http_head(path, skip_auth=nil)
+      authorize! unless skip_auth
+
+      response = RestClient::Request.execute(method: :head,
+                                             url: full_url(path),
+                                             headers: request_headers,
+                                             verify_ssl: @verify_ssl)
+    rescue => e
+      raise Vra::Exception::HTTPError, "head #{path} failed: #{e.class}: #{e.message}"
+    else
+      response
+    end
+
+    def http_get(path, skip_auth=nil)
+      authorize! unless skip_auth
+
+      response = RestClient::Request.execute(method: :get,
+                                             url: full_url(path),
+                                             headers: request_headers,
+                                             verify_ssl: @verify_ssl)
+    rescue => e
+      raise_http_exception(e, path)
+    else
+      response
+    end
+
+    def http_get!(path)
+      response = http_get(path)
+      response.body
+    end
+
+    def http_get_paginated_array!(path)
+      items = []
+      page = 1
+      base_path = path + "?limit=#{page_size}"
+
+      loop do
+        response = JSON.parse(http_get!("#{base_path}&page=#{page}"))
+        items += response['content']
+
+        break if page >= response['metadata']['totalPages']
+        page += 1
+      end
+
+      raise Vra::Exception::DuplicateItemsDetected,
+            'Duplicate items were returned by the vRA API. ' \
+            'Increase your page size to avoid this vRA API bug. ' \
+            'See https://github.com/nwops/vra-restapi#pagination ' \
+            'for more information.' if items.uniq!
+
+      items
+    end
+
+    def http_post(path, payload, skip_auth=nil)
+      authorize! unless skip_auth
+
+      response = RestClient::Request.execute(method: :post,
+                                             url: full_url(path),
+                                             headers: request_headers,
+                                             payload: payload,
+                                             verify_ssl: @verify_ssl)
+    rescue => e
+      raise_http_exception(e, path)
+    else
+      response
+    end
+
+    def http_post!(path, payload)
+      response = http_post(path, payload)
+      response.body
+    end
+
+    def raise_http_exception(caught_exception, path)
+      raise unless caught_exception.respond_to?(:http_code)
+
+      klass = if caught_exception.http_code == 404
+                Vra::Exception::HTTPNotFound
+              else
+                Vra::Exception::HTTPError
+              end
+
+      exception = klass.new(code: caught_exception.http_code,
+                            body: caught_exception.response,
+                            klass: caught_exception.class,
+                            path: path)
+
+      message = exception.errors.empty? ? caught_exception.message : exception.errors.join(', ')
+      raise exception, message
+    end
+
+    def validate_client_options!
+      raise ArgumentError, 'Username and password are required' if @username.nil? || @password.value.nil?
+      raise ArgumentError, 'A tenant is required' if @tenant.nil?
+      raise ArgumentError, 'A base URL is required' if @base_url.nil?
+      raise ArgumentError, "Base URL #{@base_url} is not a valid URI." unless valid_uri?(@base_url)
+    end
+
+    def valid_uri?(uri)
+      uri = URI.parse(uri)
+      uri.is_a?(URI::HTTP)
+    rescue URI::InvalidURIError
+      false
+    end
+  end
+end