vmware-vra 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59dc63417610669ee08b3379e114b69272cc166c
-  data.tar.gz: 47067ef3785e706540ed305c2241f0d9774d2c89
+  metadata.gz: 56ccef7bb2c458c16968ac45d3ba00306e0cfe39
+  data.tar.gz: 8023755792111c3fbebb453f3b651c6d12dde66f
 SHA512:
-  metadata.gz: bf497f53a802a230e484b6b5b171ec2300973785a0e36000d9820f155c4328ed73b9c8e0a205765c60ad3196c263563a93e9660f14a6372a8f7f0999371015eb
-  data.tar.gz: 1204363ea16057b658ace83d3e714c6b7cc6b980bb7e9d6dc3cb6910396b8deadaec9fcb3a2d015ac8c7e66d93d920b1f654f6d7723d0ecf7c5607a15da263c8
+  metadata.gz: 24cd4008b751382b4869c1a5e9abb49c35087ad0f65c29e9e2c9911a34a07ada9a31323e16c1867454ba19081b73ec788da3807b9a78d4b0d33148edd4ca2737
+  data.tar.gz: cd5567b6825a179d15a043d048fa5862fd88b6ee8ae3ef1a4ca4ed01acc378ee1cd1a28f148705a8c2d36ee39de2672aae72c0f1f92df471e50440c347012583

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## v1.1.0
+* [pr#9](https://github.com/chef-partners/vmware-vra-gem/pull/9) Mask password and bearer token in console/debug/log output. 
+  Thanks to [@rubytester](https://github.com/rubytester) for the idea and initial proposal to address in [pr#7](https://github.com/chef-partners/vmware-vra-gem/pull/7)
+
+## v1.0.0
+* Initial release.

data/README.md

@@ -2,7 +2,7 @@
 
 Client gem for interacting with VMware's vRealize Automation application.
 
-Not all vRA functionality is included in this gem; only API calls necessary 
+Not all vRA functionality is included in this gem; only API calls necessary
 to interact with the catalog, requests, and existing items is included.
 
 The primary goal of this gem is to provide a reusable set of methods in order
@@ -33,7 +33,7 @@ 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 tenant ID from your vRA administrator.
 
 ```
 vra = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', tenant: 'mytenant', base_url: 'https://vra.corp.local', verify_ssl: true)
@@ -61,7 +61,7 @@ catalog_request = vra.catalog.request('a9cd6148-6e0b-4a80-ac47-f5255c52b43d', cp
 => #<Vra::CatalogRequest:0x00000003477c20 ... >
 ```
 
-vRA requires your sub-tenant (a.k.a. "business group") to be specified when requesting an item from the catalog.  If the catalog item you are requesting is specifically created for a given business group, the gem will use that ID automatically without you needing to specify it.
+vRA requires your sub-tenant (a.k.a. "business group") to be specified when requesting an item from the catalog. If the catalog item you are requesting is specifically created for a given business group, the gem will use that ID automatically without you needing to specify it.
 
 However, if there is no sub-tenant ID available for us to use, you will receive an error when you submit:
 
@@ -124,7 +124,7 @@ new_request.status
 => "SUCCESSFUL"
 ```
 
-When the request is successful, you can query the resources created as the result of your request.  Assuming that the catalog item blueprint we requested only creates a single VM, we can get that resource and learn more information about it:
+When the request is successful, you can query the resources created as the result of your request. Assuming that the catalog item blueprint we requested only creates a single VM, we can get that resource and learn more information about it:
 
 ```
 resource = request.resources.first

data/lib/vra/client.rb

@@ -18,6 +18,7 @@
 
 require 'ffi_yajl'
 require 'rest-client'
+require 'passwordmasker'
 
 module Vra
   # rubocop:disable ClassLength
@@ -27,10 +28,10 @@ module Vra
     def initialize(opts)
       @base_url     = opts[:base_url]
       @username     = opts[:username]
-      @password     = opts[:password]
+      @password     = PasswordMasker.new(opts[:password])
       @tenant       = opts[:tenant]
       @verify_ssl   = opts.fetch(:verify_ssl, true)
-      @bearer_token = nil
+      @bearer_token = PasswordMasker.new(nil)
 
       validate_client_options!
     end
@@ -60,7 +61,7 @@ module Vra
     def bearer_token_request_body
       {
         'username' => @username,
-        'password' => @password,
+        'password' => @password.value,
         'tenant'   => @tenant
       }
     end
@@ -69,7 +70,7 @@ module Vra
       headers = {}
       headers['Accept']        = 'application/json'
       headers['Content-Type']  = 'application/json'
-      headers['Authorization'] = "Bearer #{@bearer_token}" unless @bearer_token.nil?
+      headers['Authorization'] = "Bearer #{@bearer_token.value}" unless @bearer_token.value.nil?
       headers
     end
 
@@ -80,9 +81,9 @@ module Vra
     end
 
     def authorized?
-      return false if @bearer_token.nil?
+      return false if @bearer_token.value.nil?
 
-      response = http_head("/identity/api/tokens/#{@bearer_token}", :skip_auth)
+      response = http_head("/identity/api/tokens/#{@bearer_token.value}", :skip_auth)
       if response.code == 204
         true
       else
@@ -91,7 +92,7 @@ module Vra
     end
 
     def generate_bearer_token
-      @bearer_token = nil
+      @bearer_token.value = nil
       validate_client_options!
 
       response = http_post('/identity/api/tokens', bearer_token_request_body.to_json, :skip_auth)
@@ -99,7 +100,7 @@ module Vra
         raise Vra::Exception::Unauthorized, "Unable to get bearer token: #{response.body}"
       end
 
-      @bearer_token = FFI_Yajl::Parser.parse(response.body)['id']
+      @bearer_token.value = FFI_Yajl::Parser.parse(response.body)['id']
     end
 
     def full_url(path)
@@ -191,7 +192,7 @@ module Vra
     end
 
     def validate_client_options!
-      raise ArgumentError, 'Username and password are required' if @username.nil? || @password.nil?
+      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)

data/lib/vra/version.rb

@@ -17,5 +17,5 @@
 #
 
 module Vra
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/client_spec.rb

@@ -37,10 +37,16 @@ describe Vra::Client do
     end
   end
 
+  describe '#bearer_token_request_body' do
+    it 'gets the correct password from the PasswordMasker object' do
+      expect(client.bearer_token_request_body['password']).to eq('password')
+    end
+  end
+
   describe '#request_headers' do
     context 'when bearer token exists' do
       it 'has an Authorization header' do
-        client.bearer_token = '12345'
+        client.bearer_token.value = '12345'
         expect(client.request_headers.key?('Authorization')).to be true
       end
     end
@@ -95,7 +101,7 @@ describe Vra::Client do
 
     context 'when token exists' do
       before(:each) do
-        client.bearer_token = '12345'
+        client.bearer_token.value = '12345'
       end
 
       url = '/identity/api/tokens/12345'
@@ -147,7 +153,7 @@ describe Vra::Client do
 
         client.generate_bearer_token
 
-        expect(client.bearer_token).to eq '12345'
+        expect(client.bearer_token.value).to eq '12345'
       end
     end
 
@@ -398,7 +404,7 @@ describe Vra::Client do
   describe '#validate_client_options!' do
     context 'when all required options are supplied' do
       it 'does not raise an exception' do
-        expect { client.validate_client_options! }.not_to raise_error(ArgumentError)
+        expect { client.validate_client_options! }.not_to raise_error
       end
     end
 

data/vmware-vra.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rest-client', '~> 1.8'
-  spec.add_dependency 'ffi-yajl',    '~> 2.2'
+  spec.add_dependency 'rest-client',    '~> 1.8'
+  spec.add_dependency 'ffi-yajl',       '~> 2.2'
+  spec.add_dependency 'passwordmasker', '~> 1.2'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake',    '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmware-vra
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Leff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: passwordmasker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md