vcloud-tools 0.8.0 → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.0 (2014-05-19)
+
+Features:
+
+  - We no longer specify a version for the gems that this meta-gem installs;
+    installing this gem should now install the most recent versions of its dependencies.
+  - Include vCloud Tools Tester gem
+
 ## 0.8.0 (2014-04-23)
 
 Features:

data/README.md

@@ -38,66 +38,55 @@ vCloud Core also comes with command line tool, vCloud Query, which exposes the v
 
 ( [gem in RubyGems](http://rubygems.org/gems/vcloud-core) | [code on GitHub](https://github.com/alphagov/vcloud-core) )
 
-Required set-up
-===============
 
-## Credentials
+## Installation
 
-vCloud Tools is based around [fog]. To use it you'll need to give it credentials that allow it to talk to a VMware
-environment. Fog offers two ways to do this.
+Add this line to your application's Gemfile:
 
-### 1. Create a `.fog` file containing your credentials
+    gem 'vcloud-tools'
 
-To use this method, you need a `.fog` file in your home directory.
+And then execute:
 
-For example:
+    $ bundle
 
-    test:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.example.com'
+Or install it yourself as:
 
-Unfortunately current usage of fog requires the password in this file. Multiple sets of credentials can be specified in the fog file, using the following format:
+    $ gem install vcloud-tools
 
-    test:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.example.com'
+Installing vCloud Tools will install all of the tools listed above.
 
-    test2:
-      vcloud_director_username: 'username@org_name'
-      vcloud_director_password: 'password'
-      vcloud_director_host: 'host.api.vendor.net'
+## Credentials
 
-You can then pass the `FOG_CREDENTIAL` environment variable at the start of your command. The value of the `FOG_CREDENTIAL` environment variable is the name of the credential set in your fog file which you wish to use.  For instance:
+vCloud Tools is based around [fog](http://fog.io/). To use it you'll need to give it credentials that allow it to talk to a vCloud Director environment.
 
-    FOG_CREDENTIAL=test2 bundle exec vcloud-launch node.yaml
+1. Create a '.fog' file in your home directory.
 
-To understand more about `.fog` files, visit the 'Credentials' section here => http://fog.io/about/getting_started.html.
+  For example:
 
-### 2. Log on externally and supply your session token
+      test_credentials:
+        vcloud_director_host: 'host.api.example.com'
+        vcloud_director_username: 'username@org_name'
+        vcloud_director_password: ''
 
-You can choose to log on externally by interacting independently with the API and supplying your session token to the
-tool by setting the `FOG_VCLOUD_TOKEN` ENV variable. This option reduces the risk footprint by allowing the user to
-store their credentials in safe storage. The default token lifetime is '30 minutes idle' - any activity extends the life by another 30 mins.
+2. Obtain a session token. First, curl the API:
 
-A basic example of this would be the following:
+        curl -D- -d '' \
+            -H 'Accept: application/*+xml;version=5.1' -u '<username>@<org_name>' \
+            https://<host.api.example.com>/api/sessions
 
-    curl
-       -D-
-       -d ''
-       -H 'Accept: application/*+xml;version=5.1' -u '<user>@<org>'
-       https://host.com/api/sessions
+  This will prompt for your password.
 
-This will prompt for your password.
+  From the headers returned, the value of the `x-vcloud-authorization` header is your session token, and this will be valid for 30 minutes idle - any activity will extend its life by another 30 minutes.
 
-From the headers returned, select the header below
+3. Specify your credentials and session token at the beginning of the command. For example:
 
-     x-vcloud-authorization: AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF=
+        FOG_CREDENTIAL=test_credentials \
+            FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= \
+            vcloud-launch node.yaml
 
-Use token as ENV var FOG_VCLOUD_TOKEN
+  You may find it easier to export one or both of the values as environment variables.
 
-    FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= bundle exec ...
+  **NB** It is also possible to sidestep the need for the session token by saving your password in the fog file. This is **not recommended**.
 
 ## Contributing
 

data/lib/vcloud/tools/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Tools
-    VERSION = '0.8.0'
+    VERSION = '1.0.0'
   end
 end

data/vcloud-tools.gemspec

@@ -17,11 +17,12 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'vcloud-core', '>= 0.0.12'
-  s.add_runtime_dependency 'vcloud-edge_gateway', '>= 0.2.3'
-  s.add_runtime_dependency 'vcloud-launcher', '>= 0.0.3'
-  s.add_runtime_dependency 'vcloud-net_launcher', '>=0.0.2'
-  s.add_runtime_dependency 'vcloud-walker', '>= 3.2.1'
+  s.add_runtime_dependency 'vcloud-core'
+  s.add_runtime_dependency 'vcloud-edge_gateway'
+  s.add_runtime_dependency 'vcloud-launcher'
+  s.add_runtime_dependency 'vcloud-net_launcher'
+  s.add_runtime_dependency 'vcloud-walker'
   s.add_development_dependency 'gem_publisher', '1.2.0'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'vcloud-tools-tester'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-tools
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcloud-core
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcloud-edge_gateway
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcloud-launcher
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcloud-net_launcher
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcloud-walker
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gem_publisher
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcloud-tools-tester
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables: []
@@ -154,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3739846069195511202
+      hash: 2217743853277878432
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -163,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3739846069195511202
+      hash: 2217743853277878432
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23