vmfloaty 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f215110e7c13ce2a72f19cb35aa90964cf7dd7c
-  data.tar.gz: 5968455832c792537a7139dbe7ed4a95292a3458
+  metadata.gz: 1a6d9fbc28754d8b0ab518b73f62d6b20057b1d2
+  data.tar.gz: d328a16a9430b324a4ba5a050f1a72e0c5cf8f53
 SHA512:
-  metadata.gz: b360f9ae8c057843796e65afdc421944c8bd787f27ab46093292df78ed1418f1d1e36cdc00dc8377bf9b7b5017e44637a0072b04a2156c6764e461cfc9846483
-  data.tar.gz: 0ad5001db7b91489e043e3104c444fa6918919065a88c8eed3b968a9faff289f76d44726dc56f3c876f4944881980bb34febdac242457f067e847c723a52ebcf
+  metadata.gz: d9a5361e957db68222c1112912b17264417d19995f9b31ba7a19f3901454cf94c00d331e348cce6b8565daa0ca51848afb14fcdbd3d468a6548cd7ae68faf7a8
+  data.tar.gz: 1c1aea226b929c869930c5e65eb6814bc343116ffac03bfd729e0c72e604e5f7071912819769f19c75426798d1f4508caf030be49462686b9dbae22448631fc6

data/README.md

@@ -40,6 +40,22 @@ gem install vmfloaty
         Display backtrace when an error occurs
 ```
 
+### Example workflow
+
+Grabbing a token for authenticated pooler requests:
+
+```
+floaty token get --user me --url https://vmpooler.mycompany.net
+```
+
+This command will then ask you to log in. If successful, it will return a token that you can save either in a dotfile or use with other cli commands.
+
+Grabbing vms:
+
+```
+floaty get centos-7,debian-7,windows-10 --token mytokenstring --url https://vmpooler.mycompany.net
+```
+
 ### vmfloaty dotfile
 
 If you do not wish to continuely specify various config options with the cli, you can have a dotfile in your home directory for some defaults. For example:
@@ -48,10 +64,92 @@ If you do not wish to continuely specify various config options with the cli, yo
 #file at /Users/me/.vmfloaty.yml
 url: 'http://vmpooler.mycompany.net'
 user: 'brian'
+token: 'tokenstring'
 ```
 
 Now vmfloaty will use those config files if no flag was specified.
 
+#### Valid config keys
+
+Here are the keys that vmfloaty currently supports:
+
+- verbose
+  + true
+  + false
+- token
+  + :token-string
+- user
+  + :username
+- url
+  + :pooler-url
+
 ## vmpooler API
 
 This cli tool uses the [vmpooler API](https://github.com/puppetlabs/vmpooler/blob/master/API.md).
+
+## Using the Pooler class
+
+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'
+  token = aquire_token(verbose, url)
+  os = ARGV[0]
+
+  hostname = grab_vm(os, token, url, verbose)
+  run_puppet_on_host(hostname)
+end
+```
+
+```
+ruby myscript.rb centos-7-x86_64
+```

data/lib/vmfloaty.rb

@@ -2,18 +2,20 @@
 
 require 'rubygems'
 require 'commander'
-require 'yaml'
 require 'vmfloaty/auth'
 require 'vmfloaty/pooler'
+require 'vmfloaty/version'
+require 'vmfloaty/conf'
+require 'vmfloaty/format'
 
 class Vmfloaty
   include Commander::Methods
 
   def run
-    program :version, '0.2.5'
+    program :version, Version.get
     program :description, 'A CLI helper tool for Puppet Labs vmpooler to help you stay afloat'
 
-    config = read_config
+    config = Conf.read_config
 
     command :get do |c|
       c.syntax = 'floaty get [hostname,...]'
@@ -234,14 +236,4 @@ class Vmfloaty
 
     run!
   end
-
-  def read_config
-    conf = {}
-    begin
-      conf = YAML.load_file("#{Dir.home}/.vmfloaty.yml")
-    rescue
-      STDERR.puts "There was no config file at #{Dir.home}/.vmfloaty.yml"
-    end
-    conf
-  end
 end

data/lib/vmfloaty/conf.rb

@@ -0,0 +1,14 @@
+require 'yaml'
+
+class Conf
+
+  def self.read_config
+    conf = {}
+    begin
+      conf = YAML.load_file("#{Dir.home}/.vmfloaty.yml")
+    rescue
+      STDERR.puts "WARNING: There was no config file at #{Dir.home}/.vmfloaty.yml"
+    end
+    conf
+  end
+end

data/lib/vmfloaty/format.rb

@@ -0,0 +1,7 @@
+
+class Format
+  # TODO: Takes the json response body from an HTTP GET
+  # request and "pretty prints" it
+  def self.get_hosts(hostname_hash)
+  end
+end

data/lib/vmfloaty/version.rb

@@ -0,0 +1,8 @@
+
+class Version
+  @version = '0.2.6'
+
+  def self.get
+    @version
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Brian Cain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: A helper tool for vmpooler to help you stay afloat
 email:
 - brian.cain@puppetlabs.com
@@ -37,8 +51,11 @@ files:
 - bin/floaty
 - lib/vmfloaty.rb
 - lib/vmfloaty/auth.rb
+- lib/vmfloaty/conf.rb
+- lib/vmfloaty/format.rb
 - lib/vmfloaty/http.rb
 - lib/vmfloaty/pooler.rb
+- lib/vmfloaty/version.rb
 - spec/spec_helper.rb
 homepage: https://github.com/briancain/vmfloaty
 licenses: