vmware-vra 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c44d1d09f07fe9362fd1ee9525a39a128612e60
+  data.tar.gz: 6d006f1b9ca2462fd5610ac5a7c2ab2499d65ffd
+SHA512:
+  metadata.gz: 91503ac793261088fbf81b35397d4862bdf3fc2ff07e6faecbf53a9bfd534e7d45f87b17412c0f30d6758828cb1a1dd5ef58ed75c371b35edb7c4ade8e270e6f
+  data.tar.gz: 2baebf8a4899ebd3d916f3ee2ebbc0eb0bd7e5932760f5fb34c59a304c1e616ca3945e0e4f2f2c65d682b833df9838b542b51cd6df3ca98e40ee50a94778d31d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/examples/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/AbcSize:
+  Max: 30
+Metrics/LineLength:
+  Max: 150
+Metrics/MethodLength:
+  Max: 30
+Style/Documentation:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+Style/SpaceInsideBrackets:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vmware-vra-gem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2015 Chef Software, Inc.
+
+   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.

data/README.md

@@ -0,0 +1,199 @@
+# VMware vRA Gem
+
+Client gem for interacting with VMware's vRealize Automation application.
+
+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
+to create Chef plugins for knife, test-kitchen, and provisioning.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vmware-vra'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vmware-vra
+
+## Usage
+
+First, load in the gem.
+
+```
+require 'vra'
+=> true
+```
+
+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)
+=> #<Vra::Client:0x000000034c0df8 ... >
+```
+
+To list all items in the catalog:
+
+```
+vra.catalog.all_items
+=> [{"@type"=>"CatalogItem", "id"=>"a9cd6148-6e0b-4a80-ac47-f5255c52b43d", "version"=>2, "name"=>"CentOS 6.6", "description"=>"Blueprint for deploying a CentOS Linux development server", ... }]
+```
+
+To only list the items in the catalog for which you are entitled to request:
+
+```
+vra.catalog.entitled_items
+=> [{"@type"=>"ConsumerEntitledCatalogItem", "catalogItem"=>{"id"=>"d29efd6b-3cd6-4f8d-b1d8-da4ddd4e52b1", "version"=>2, "name"=>"WindowsServer2012", "description"=>"Windows Server 2012", ... }]
+```
+
+When you are ready to request an item from the catalog, create a new catalog request object:
+
+```
+catalog_request = vra.catalog.request('a9cd6148-6e0b-4a80-ac47-f5255c52b43d', cpus: 1, memory: 512, requested_for: 'devmgr@corp.local', lease_days: 30)
+=> #<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.
+
+However, if there is no sub-tenant ID available for us to use, you will receive an error when you submit:
+
+```
+request = catalog_request.submit
+ArgumentError: Unable to submit request, required param(s) missing => subtenant_id
+	from /home/aleff/vmware-vra/lib/vra/catalog_request.rb:42:in `validate_params!'
+	from /home/aleff/vmware-vra/lib/vra/catalog_request.rb:99:in `submit'
+	from (irb):4
+	from /opt/chefdk/embedded/bin/irb:11:in `<main>'
+
+```
+
+In this case, you will need to supply the sub-tenant ID manually:
+
+```
+catalog_request.subtenant_id = '5327ddd3-1a4e-4663-9e9d-63db86ffc8af'
+=> "5327ddd3-1a4e-4663-9e9d-63db86ffc8af"
+```
+
+If your catalog blueprint item requires additional parameters to successfully submit your request, you may add them:
+
+```
+catalog_request.set_parameter('my_parameter', 'string', 'my value')
+```
+
+Now, submit your request!  The client will return a new "Request" object you can use to query for status.
+
+```
+request = catalog_request.submit
+=> #<Vra::Request:0x000000027caea0 ... >
+
+request.status
+=> "IN_PROGRESS"
+```
+
+You can easily refresh your request object to get the latest status:
+
+```
+request.refresh && request.status
+=> "SUCCESSFUL"
+
+request.completion_state
+=> "SUCCESSFUL"
+
+request.completion_details
+=> "Request succeeded. Created hol-dev-32."
+```
+
+You can also save the request ID for later, and create a new request object at your leisure to follow-up on your request:
+
+```
+request.id
+=> "aed22465-02db-481d-b55a-cefe216096a2"
+
+new_request = vra.requests.by_id('aed22465-02db-481d-b55a-cefe216096a2')
+=> #<Vra::Request:0x0000000564ac30 ... >
+
+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:
+
+```
+resource = request.resources.first
+=> #<Vra::Resource:0x00000006772e68 ... >
+
+resource.network_interfaces
+=> [{"NETWORK_ADDRESS"=>"192.168.110.203", "NETWORK_MAC_ADDRESS"=>"00:50:56:ae:1d:c7", "NETWORK_NAME"=>"vxw-dvs-35-virtualwire-2-sid-5000-Edge_Transport"}]
+
+resource.ip_addresses
+=> ["192.168.110.203"]
+
+resource.name
+=> "hol-dev-32"
+```
+
+And just like requests, you can save the resource ID and query it again later:
+
+```
+resource.id
+=> "331fd10b-f2a2-40ae-86bc-1255c1ee9a6d"
+
+new_resource = vra.resources.by_id('331fd10b-f2a2-40ae-86bc-1255c1ee9a6d')
+=> #<Vra::Resource:0x000000067c13b0 ... >
+
+new_resource.name
+=> "hol-dev-32"
+```
+
+When you no longer need the VM, you can destroy it, which returns another request object you can query for status:
+
+```
+destroy_req = resource.destroy
+=> #<Vra::Request:0x00000006ea90d8 ... >
+
+destroy_req.status
+=> "SUCCESSFUL"
+```
+
+You can also list all resources and requests you have permission to see with these methods:
+
+```
+vra.resources.all_resources
+vra.requests.all_requests
+```
+
+## License and Authors
+
+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.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/vmware-vra-gem/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request