vmfloaty 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eab6e0237c6ce8afe7ce25cb2573a852bd4e6e63
-  data.tar.gz: 6fa9a7232f1814cc602f1e8aa98900b618aab97d
+  metadata.gz: 1bb5fd73f29e77b581fadb37b382fceb4131497b
+  data.tar.gz: c947c5941fd8d4f6b6aaaa4be3c320b5276b66f0
 SHA512:
-  metadata.gz: 32cc876286d8dcc6d887dc471d5a4ca7af1bc541a7b838674fea05ff809712367f20e0181fda5182d9cde487e487b69277ae02b84a6972dbe8b11d6011a6996d
-  data.tar.gz: a1f92a6bd32a1d30fea8bdb258b03e56440fb81c5bf289510973ce02e8666a19aedfddd3a1a504fc459c3a21f705b3fb93ce46457b39510e4b75abb9ad1beb58
+  metadata.gz: 1c4cc430096ff5b521deac4a1f8c4ad70ef2739d3419f4dbe54fff3bf9da87e0f6d94c4b9cb629565ba025ba8238fe079351f3d7b31a0a4985b6b7c4433412d9
+  data.tar.gz: 065e1253192e6f2c48caa3b152573c63cddfc36fe2190610403469e34ce43dd7252f09c86574df91fdec0cf7721da94d0c64c65d04b32d320cbf41a560d472ff

data/README.md

@@ -94,71 +94,11 @@ This cli tool uses the [vmpooler API](https://github.com/puppetlabs/vmpooler/blo
 
 ## Using the Pooler class
 
-An example of an application using vmfloaty as a library can be seen in [vagrant-vmpooler](https://github.com/briancain/vagrant-vmpooler).
-
-### Scripting
-
-If you want to write some ruby scripts around the vmpooler api, vmfloaty provides a `Pooler` and `Auth` class to make things easier. The ruby script below shows off an example of a script that gets a token, grabs a vm, runs some commands through ssh, and then destroys the vm.
-
-```ruby
-require 'vmfloaty/pooler'
-require 'vmfloaty/auth'
-require 'io/console'
-require 'net/ssh'
-
-def aquire_token(verbose, url)
-  STDOUT.flush
-  puts "Enter username:"
-  user = $stdin.gets.chomp
-  puts "Enter password:"
-  password = STDIN.noecho(&:gets).chomp
-  token = Auth.get_token(verbose, url, user, password)
-
-  puts "Your token:\n#{token}"
-  token
-end
-
-def grab_vms(os_string, token, url, verbose)
-  response_body = Pooler.retrieve(verbose, os_string, token, url)
-
-  if response_body['ok'] == false
-    STDERR.puts "There was a problem with your request"
-    exit 1
-  end
-
-  response_body[os_string]
-end
-
-def run_puppet_on_host(hostname)
-  STDOUT.flush
-  puts "Enter 'root' password for vm:"
-  password = STDIN.noecho(&:gets).chomp
-  user = 'root'
-  # run puppet
-  run_puppet = "/opt/puppetlabs/puppet/bin/puppet agent -t"
-
-  begin
-    ssh = Net::SSH.start(hostname, user, :password => password)
-    output = ssh.exec!(run_puppet)
-    puts output
-    ssh.close
-  rescue
-    STDERR.puts "Unable to connect to #{hostname} using #{user}"
-    exit 1
-  end
-end
-
-if __FILE__ == $0
-  verbose = true
-  url = 'https://vmpooler.mycompany.net/api/v1'
-  token = aquire_token(verbose, url)
-  os = ARGV[0]
-
-  hostname = grab_vm(os, token, url, verbose)
-  run_puppet_on_host(hostname)
-end
-```
+vmfloaty providers a `Pooler` class that gives users the ability to make requests to vmpooler without having to write their own requests. It also provides an `Auth` class for managing vmpooler tokens within your application.
 
-```
-ruby myscript.rb centos-7-x86_64
-```
+### Example Projects
+
+- [John McCabe: vmpooler-bitbar](https://github.com/johnmccabe/vmpooler-bitbar/)
+  + vmpooler status and management in your menubar with bitbar
+- [Brian Cain: vagrant-vmpooler](https://github.com/briancain/vagrant-vmpooler)
+  + Use Vagrant to manage your vmpooler instances

data/lib/vmfloaty.rb

@@ -74,7 +74,7 @@ class Vmfloaty
     end
 
     command :list do |c|
-      c.syntax = 'floaty list [hostname]'
+      c.syntax = 'floaty list [options]'
       c.summary = 'Shows a list of available vms from the pooler'
       c.description = ''
       c.example 'Filter the list on centos', 'floaty list centos --url http://vmpooler.example.com'
@@ -117,7 +117,7 @@ class Vmfloaty
     end
 
     command :query do |c|
-      c.syntax = 'floaty query [options]'
+      c.syntax = 'floaty query [hostname] [options]'
       c.summary = 'Get information about a given vm'
       c.description = ''
       c.example 'Get information about a sample host', 'floaty query hostname --url http://vmpooler.example.com'
@@ -134,7 +134,7 @@ class Vmfloaty
     end
 
     command :modify do |c|
-      c.syntax = 'floaty modify [hostname]'
+      c.syntax = 'floaty modify [hostname] [options]'
       c.summary = 'Modify a vms tags, TTL, and disk space'
       c.description = ''
       c.example 'Modifies myhost1 to have a TTL of 12 hours and adds a custom tag', 'floaty modify myhost1 --lifetime 12 --url https://myurl --token mytokenstring --tags \'{"tag":"myvalue"}\''
@@ -254,7 +254,7 @@ class Vmfloaty
     end
 
     command :snapshot do |c|
-      c.syntax = 'floaty snapshot [options]'
+      c.syntax = 'floaty snapshot [hostname] [options]'
       c.summary = 'Takes a snapshot of a given vm'
       c.description = ''
       c.example 'Takes a snapshot for a given host', 'floaty snapshot myvm.example.com --url http://vmpooler.example.com --token a9znth9dn01t416hrguu56ze37t790bl'
@@ -273,10 +273,10 @@ class Vmfloaty
     end
 
     command :revert do |c|
-      c.syntax = 'floaty revert [options]'
+      c.syntax = 'floaty revert [hostname] [snapshot] [options]'
       c.summary = 'Reverts a vm to a specified snapshot'
       c.description = ''
-      c.example 'Reverts to a snapshot for a given host', 'floaty revert myvm.example.com --url http://vmpooler.example.com --token a9znth9dn01t416hrguu56ze37t790bl --snapshot n4eb4kdtp7rwv4x158366vd9jhac8btq'
+      c.example 'Reverts to a snapshot for a given host', 'floaty revert myvm.example.com n4eb4kdtp7rwv4x158366vd9jhac8btq --url http://vmpooler.example.com --token a9znth9dn01t416hrguu56ze37t790bl'
       c.option '--verbose', 'Enables verbose output'
       c.option '--url STRING', String, 'URL of vmpooler'
       c.option '--token STRING', String, 'Token for vmpooler'
@@ -286,7 +286,11 @@ class Vmfloaty
         url = options.url ||= config['url']
         hostname = args[0]
         token = options.token || config['token']
-        snapshot_sha = options.snapshot
+        snapshot_sha = args[1] || options.snapshot
+
+        if args[1] && options.snapshot
+          STDERR.puts "Two snapshot arguments were given....using snapshot #{snapshot_sha}"
+        end
 
         revert_req = Pooler.revert(verbose, url, hostname, token, snapshot_sha)
         pp revert_req
@@ -326,10 +330,10 @@ class Vmfloaty
     end
 
     command :token do |c|
-      c.syntax = 'floaty token [get | delete | status]'
+      c.syntax = 'floaty token [get | delete | status] [token]'
       c.summary = 'Retrieves or deletes a token'
       c.description = ''
-      c.example '', ''
+      c.example 'Gets a token from the pooler', 'floaty token get'
       c.option '--verbose', 'Enables verbose output'
       c.option '--url STRING', String, 'URL of vmpooler'
       c.option '--user STRING', String, 'User to authenticate with'
@@ -338,7 +342,7 @@ class Vmfloaty
         verbose = options.verbose || config['verbose']
         action = args.first
         url = options.url ||= config['url']
-        token = options.token ||= config['token']
+        token = args[1] ||= options.token ||= config['token']
         user = options.user ||= config['user']
 
         case action

data/lib/vmfloaty/pooler.rb

@@ -134,6 +134,10 @@ class Pooler
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token
 
+    if snapshot_sha.nil?
+      raise "Snapshot SHA provided was nil, could not revert #{hostname}"
+    end
+
     response = conn.post "vm/#{hostname}/snapshot/#{snapshot_sha}"
     res_body = JSON.parse(response.body)
     res_body

data/lib/vmfloaty/version.rb

@@ -1,6 +1,6 @@
 
 class Version
-  @version = '0.6.1'
+  @version = '0.6.2'
 
   def self.get
     @version

data/spec/vmfloaty/pooler_spec.rb

@@ -174,5 +174,9 @@ describe Pooler do
       revert_req = Pooler.revert(false, @vmpooler_url, 'fq6qlpjlsskycq6', 'mytokenfile', 'dAfewKNfaweLKNve')
       expect(revert_req["ok"]).to be true
     end
+
+    it "doesn't make a request to revert a vm if snapshot is not provided" do
+      expect{ Pooler.revert(false, @vmpooler_url, 'fq6qlpjlsskycq6', 'mytokenfile', nil) }.to raise_error(RuntimeError, "Snapshot SHA provided was nil, could not revert fq6qlpjlsskycq6")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Brian Cain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander