vmware-vra 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f5265a1fb658c84986b019f01469ae9143300a5b0b36eda4825458ef28cc738
-  data.tar.gz: 638b354ab5cd83171f560e7eefcb53ebe4e773f3b7fc2b9ef5b7260fee5288fd
+  metadata.gz: 0e0045f6ebfa8fa27f8842d7d99cab6caebbfed8dde6143caeca4f3586b84e89
+  data.tar.gz: f44441731dd50642476d4a47c0e5d7c0d2bd957cb262cd10f566011ff902b299
 SHA512:
-  metadata.gz: 9c0e6ead2fc7eb2c8de12f87f5bcee61b7358f17061beb62f6f312521a4f29e2787d8018f22029c092aa86754c55c16918df13a457df304d48f6663d35d6f164
-  data.tar.gz: b425f0d3c34074720708d91ac06f6c1421e1e2020f786a02c903dbbce028df413eb16056e21995a3e34f9f5b01a3a9f93935287282d53e9607a33ffcff608e75
+  metadata.gz: ae31f69005d0e71b02712f75486619e8e68b22265ba5d45874a7f96e2c83ee75f5eea71d9c0bcd6eb8bad93bc8e3cf254b1fb1b2d2d0dbefb1447a7b3f26419d
+  data.tar.gz: c8c59ca96efa6784ddcad31204fa1e23b2c9119e5173a829cd87fdfb4f08fefd0af0eb84366593f3f731259da3b71c840e9471e743852acdd80a52fc68734e8b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [3.2.0](https://github.com/test-kitchen/vmware-vra-gem/tree/v3.2.0) (2022-12-19)
+
+- Updated the tenant attribute to domain
+
+[Full Changelog](https://github.com/test-kitchen/vmware-vra-gem/compare/v3.1.3...v3.2.0)
+
 ## [3.1.3](https://github.com/test-kitchen/vmware-vra-gem/tree/v3.1.3) (2022-05-26)
 
 - Use regular admin catalog endpoint to fetch catalog items

data/README.md

@@ -47,10 +47,10 @@ require 'vra'
 => true
 ```
 
-Then, set up your client object. You will need to know your tenant ID from your vRA administrator.
+Then, set up your client object. You will need to know your domain from your vRA administrator.
 
 ```shell
-client = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', tenant: 'mytenant', base_url: 'https://vra.corp.local', verify_ssl: true)
+client = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', domain: 'domain.corp.local', base_url: 'https://vra.corp.local', verify_ssl: true)
 => #<Vra::Client:0x000000034c0df8 ... >
 ```
 
@@ -234,7 +234,7 @@ deployment.requests
 vRA paginates API requests where lists of items are returned.  By default, this gem will ask vRA to provide items in groups of 20.  However, as reported in [Issue 10](https://github.com/chef-partners/vmware-vra-gem/issues/10), it appears vRA may have a pagination bug.  You can change the default page size from 20 to a value of your choice by passing in a `page_size` option when setting up the client:
 
 ```ruby
-vra = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', tenant: 'mytenant', base_url: 'https://vra.corp.local', verify_ssl: true, page_size: 100)
+vra = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', domain: 'domain.corp.local', base_url: 'https://vra.corp.local', verify_ssl: true, page_size: 100)
 ```
 
 ... or setting `page_size` on the client object after you've created it:

data/lib/vra/client.rb

@@ -33,7 +33,8 @@ module Vra
       @base_url      = opts[:base_url]
       @username      = opts[:username]
       @password      = PasswordMasker.new(opts[:password])
-      @tenant        = opts[:tenant]
+      @domain        = fetch_domain(opts)
+
       @verify_ssl    = opts.fetch(:verify_ssl, true)
       @refresh_token = PasswordMasker.new(nil)
       @access_token  = PasswordMasker.new(nil)
@@ -80,7 +81,7 @@ module Vra
       {
         'username': @username,
         'password': @password.value,
-        'domain': @tenant,
+        'domain': @domain,
       }
     end
 
@@ -231,7 +232,7 @@ module Vra
 
     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 domain is required" if @domain.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
@@ -242,5 +243,15 @@ module Vra
     rescue URI::InvalidURIError
       false
     end
+
+    private
+
+    # This is for backward compatibility, if someone still uses tenant key to pass the domain,
+    # it should also work.
+    def fetch_domain(opts)
+      return opts[:tenant] if opts.key?(:tenant) && !opts.key?(:domain)
+
+      opts[:domain]
+    end
   end
 end

data/lib/vra/deployment.rb

@@ -71,6 +71,10 @@ module Vra
       status == "CREATE_FAILED"
     end
 
+    def completion_details
+      requests.last.details
+    end
+
     def completed?
       successful? || failed?
     end

data/lib/vra/request.rb

@@ -76,6 +76,10 @@ module Vra
       status == "FAILED"
     end
 
+    def details
+      request_data["details"]
+    end
+
     private
 
     attr_reader :request_data, :client

data/lib/vra/version.rb

@@ -18,5 +18,5 @@
 #
 
 module Vra
-  VERSION = "3.1.3"
+  VERSION = "3.2.0"
 end

data/spec/catalog_item_spec.rb

@@ -24,7 +24,7 @@ describe Vra::CatalogItem do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/catalog_source_spec.rb

@@ -23,7 +23,7 @@ describe Vra::CatalogSource do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/catalog_spec.rb

@@ -24,7 +24,7 @@ describe Vra::Catalog do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/catalog_type_spec.rb

@@ -23,7 +23,7 @@ describe Vra::CatalogType do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/client_spec.rb

@@ -26,7 +26,7 @@ describe Vra::Client do
     {
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local",
     }
   end
@@ -136,7 +136,7 @@ describe Vra::Client do
       {
         username: "user@corp.local",
         password: "password",
-        domain: "tenant",
+        domain: "domain",
       }.to_json
     end
 
@@ -414,7 +414,7 @@ describe Vra::Client do
       let(:unverified_client) do
         Vra::Client.new(username: "user@corp.local",
                         password: "password",
-                        tenant: "tenant",
+                        domain: "domain",
                         base_url: "https://vra.corp.local",
                         verify_ssl: false)
       end
@@ -503,7 +503,7 @@ describe Vra::Client do
       let(:client) do
         described_class.new(
           password: "password",
-          tenant: "tenant",
+          domain: "domain",
           base_url: "https://vra.corp.local"
         )
       end
@@ -517,7 +517,7 @@ describe Vra::Client do
       let(:client) do
         described_class.new(
           username: "username",
-          tenant: "tenant",
+          domain: "domain",
           base_url: "https://vra.corp.local"
         )
       end
@@ -527,7 +527,7 @@ describe Vra::Client do
       end
     end
 
-    context "when tenant is missing" do
+    context "when domain is missing" do
       let(:client) do
         described_class.new(
           username: "username",
@@ -546,7 +546,7 @@ describe Vra::Client do
         described_class.new(
           username: "username",
           password: "password",
-          tenant: "tenant"
+          domain: "domain"
         )
       end
 
@@ -560,7 +560,7 @@ describe Vra::Client do
         described_class.new(
           username: "username",
           password: "password",
-          tenant: "tenant",
+          domain: "domain",
           base_url: "something-that-is-not-a-HTTP-URI"
         )
       end

data/spec/deployment_request_spec.rb

@@ -24,7 +24,7 @@ describe Vra::DeploymentRequest do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/deployment_spec.rb

@@ -24,7 +24,7 @@ describe ::Vra::Deployment do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/deployments_spec.rb

@@ -24,7 +24,7 @@ describe ::Vra::Deployments do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/request_spec.rb

@@ -37,7 +37,7 @@ describe Vra::Request do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

data/spec/resource_spec.rb

@@ -25,7 +25,7 @@ describe Vra::Resource do
     Vra::Client.new(
       username: "user@corp.local",
       password: "password",
-      tenant: "tenant",
+      domain: "domain",
       base_url: "https://vra.corp.local"
     )
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vmware-vra
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Adam Leff
 - JJ Asghar
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 2022-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-yajl
@@ -192,7 +192,7 @@ homepage: https://github.com/chef-partners/vmware-vra-gem
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -207,8 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: Client gem for interacting with VMware vRealize Automation.
 test_files: