vmware-vra 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e805c8c8d6fd5228962ffa907ce07409b60022e29166ba970194e0aa61cc42
-  data.tar.gz: 49beb545bf435a61aefccf06daa25629ccd991363dc9ca7546e3a15996cca362
+  metadata.gz: 55b844fe4edf716d4c6668cfa5c13721caa0f36a4873aae4f2949509cf6bfc1c
+  data.tar.gz: 5a68b428aa38c0e30a8ba89790ccdb5fd9b5d233485497886cd4d290f4f528d0
 SHA512:
-  metadata.gz: de450415be0060fb3aef5d796e407bf9fedfb79b0f83a003d702073ee7aaa06508a5758191916d4c522c42348d166c01c23f8671221c2b8cd66b5e4b839177e7
-  data.tar.gz: ade68fa3e927d199c2c263bd1fcc918c21ea8c9aa52703ab74092461e9719c442294064c1410fc890c27d90908be089d21340141c11814db04cbccf3d1e4710a
+  metadata.gz: b41f6cf8aca5fde7912e59937a569af9b0fb550877a07eb1302edd94b02a3caac478ca41474786fbf2293c2a96fc3334440b0eb72784a7b48c41090a401a9f99
+  data.tar.gz: 3dfa51c5e343ca7994f9240afa7b6b2f81de243bd88de0b8a9f19f9d189d571a4d95d4fe00628950a50673e8e15f4f2b849cf78456edc8423ff20aa512a84eb8

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Change Log
+
+## [3.1.0](https://github.com/chef-partners/vmware-vra-gem/tree/v3.1.0) (2022-01-30)
+[Full Changelog](https://github.com/chef-partners/vmware-vra-gem/compare/v3.0.1...v3.1.0)
+
+- Make the version param optional in deployment request api 
+
 ## [3.0.1](https://github.com/chef-partners/vmware-vra-gem/tree/v3.0.1) (2022-01-25)
 [Full Changelog](https://github.com/chef-partners/vmware-vra-gem/compare/v3.0.0...v3.0.1)
 

data/README.md

@@ -125,8 +125,10 @@ request = client.catalog.request(
 #<Vra::DeploymentRequest:0x00007fb7340b7438
 ...
 ```
-To request a deployment from a catalog item, you can use the above method with a project ID that has a cloud template version released to the project. 
-The ID of the catalog item from which you are requesting the deployment should be also included, and the version of the released cloud template. 
+To request a deployment from a catalog item, you can use the above method with a project ID that has a cloud template version released to the project.
+
+The ID of the catalog item from which you are requesting the deployment should be also included, and the version of the released cloud template. If the user doesn't specify a version explicitly, the latest version will be fetched automatically and will be used for the request.
+ 
 Additionally, the name of the deployment should be specified and it should be unique.
 The image mapping specifies the OS image for a VM and the flavor mapping specifies the CPU count and RAM of a VM.
 

data/lib/vra/catalog_item.rb

@@ -73,12 +73,24 @@ module Vra
       data['iconId']
     end
 
+    def versions
+      client
+        .http_get_paginated_array!("/catalog/api/items/#{id}/versions")
+        .map { |v| v['id'] }
+    end
+
     def entitle!(opts = {})
       super(opts.merge(type: 'CatalogItemIdentifier'))
     end
 
-    def self.entitle!(client, id)
-      new(client, id: id).entitle!
+    class << self
+      def entitle!(client, id)
+        new(client, id: id).entitle!
+      end
+
+      def fetch_latest_version(client, id)
+        new(client, data: { 'id' => id }).versions&.first
+      end
     end
   end
 end

data/lib/vra/deployment_request.rb

@@ -85,13 +85,21 @@ module Vra
 
     def validate!
       missing_params = []
-      %i[image_mapping flavor_mapping name project_id version].each do |arg|
+      %i[image_mapping flavor_mapping name project_id].each do |arg|
         missing_params << arg if send(arg).nil?
       end
 
-      return if missing_params.empty?
+      unless missing_params.empty?
+        raise ArgumentError, "Unable to submit request, required param(s) missing => #{missing_params.join(', ')}"
+      end
+
+      # If the user doesn't supply the catalog version, fetch the latest version and use it
+      # and if the API was unable to find a valid version, alert the user.
+      return unless @version.nil?
+
 
-      raise ArgumentError, "Unable to submit request, required param(s) missing => #{missing_params.join(', ')}"
+      @version = CatalogItem.fetch_latest_version(client, catalog_id)
+      raise ArgumentError, 'Unable to fetch a valid catalog version' if @version.nil?
     end
 
     def send_request!

data/lib/vra/version.rb

@@ -18,5 +18,5 @@
 #
 
 module Vra
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/spec/catalog_item_spec.rb

@@ -122,4 +122,37 @@ describe Vra::CatalogItem do
       expect(catalog_item.type).to be_a(Vra::CatalogType)
     end
   end
+
+  describe '#versions' do
+    let(:versions_response) do
+      [{ id: '2', description: 'v2.0' }, { id: '1', description: 'v1.0' }]
+    end
+
+    before do
+      allow(client).to receive(:authorized?).and_return(true)
+    end
+
+    it 'should call the api to fetch the versions' do
+      expect(client)
+        .to receive(:http_get_paginated_array!)
+        .with('/catalog/api/items/catalog-12345/versions')
+        .and_return(versions_response)
+
+      described_class.fetch_latest_version(client, 'catalog-12345')
+    end
+
+    it 'should return the correct version' do
+      stub_request(:get, client.full_url('/catalog/api/items/catalog-12345/versions?$skip=0&$top=20'))
+        .to_return(
+          status: 200,
+          body: {
+            content: versions_response,
+            totalPages: 1
+          }.to_json,
+          headers: {}
+        )
+
+      expect(described_class.fetch_latest_version(client, 'catalog-12345')).to eq('2')
+    end
+  end
 end

data/spec/deployment_request_spec.rb

@@ -70,6 +70,45 @@ describe Vra::DeploymentRequest do
 
       expect { request.send(:validate!) }.not_to raise_error(ArgumentError)
     end
+
+    context 'versions' do
+      let(:dep_request) do
+        described_class.new(
+          client,
+          catalog_id,
+          image_mapping: 'centos',
+          name: 'sample dep',
+          flavor_mapping: 'small',
+          project_id: 'pro-123'
+        )
+      end
+
+      before do
+        allow(client).to receive(:authorized?).and_return(true)
+      end
+
+      it 'should not call the api to fetch versions if provided in the params' do
+        expect(client).not_to receive(:http_get_paginated_array!)
+
+        dep_request.version = '1'
+        dep_request.send(:validate!)
+      end
+
+      it 'should fetch version from api if version is blank' do
+        expect(client).to receive(:http_get_paginated_array!).and_return([{ 'id' => '2', 'description' => 'v2.0' }])
+
+        dep_request.send(:validate!)
+        expect(dep_request.version).to eq('2')
+      end
+
+      it 'should raise an exception if no valid versions found' do
+        expect(client).to receive(:http_get_paginated_array!).and_return([])
+
+        expect { dep_request.send(:validate!) }
+          .to raise_error(ArgumentError)
+          .with_message('Unable to fetch a valid catalog version')
+      end
+    end
   end
 
   describe '#additional parameters' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vmware-vra
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Adam Leff
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-yajl