vmfloaty 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 635cb7b974854695815a6287203b5db7842ccfdd
-  data.tar.gz: 8bf5c5be05395beb8154243aa212d08d94559869
+  metadata.gz: 67dbbc5d6d8ccb1f5c5663f9483759784f6a97d4
+  data.tar.gz: aee780777b391982f50e1cfc2bd84bc74c93e9d1
 SHA512:
-  metadata.gz: 7fe3df32eca62872bcf93fca60ddbb312ee89e24fae6952f5f7d3fcad5f20b5bb22e418c4e0dc9a741721d37375039378083303dea0d54df7e212409613de8f1
-  data.tar.gz: 0063aba22c8ef7a481b13792fe90ccc15d3b117bd439436279ec5f2709cc5b2f91da84b55e59844ae0d68b20c28dc7fef1a2e9f6d584614f67e4b9ccd0ebaf68
+  metadata.gz: 1f23297133c942c633df3d1b44ab645df7049c43a726739f606d71458fec57b353d05e81123dcf7a5731f923eccd92a6b60e276ffa2fdc99d50c8247dc7686b5
+  data.tar.gz: ccfc5600caab2e20698052fb299e2db7bdb9b40058cc185aa8308bb5cac872e5333b592d108298301ac3c63e7c40c07da533450c4c40d266740b61dcf3015e01

data/README.md

@@ -1,7 +1,7 @@
 vmfloaty
 ========
 
-[![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty)
+[![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty) [![Build Status](https://travis-ci.org/briancain/vmfloaty.svg?branch=master)](https://travis-ci.org/briancain/vmfloaty)
 
 A CLI helper tool for [Puppet Labs vmpooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.
 
@@ -12,7 +12,10 @@ A CLI helper tool for [Puppet Labs vmpooler](https://github.com/puppetlabs/vmpoo
 Grab the latest from ruby gems...
 
 ```
-gem install vmfloaty
+$ gem install vmfloaty
+...
+...
+$ floaty --help
 ```
 
 ## Usage
@@ -26,6 +29,7 @@ gem install vmfloaty
     query    Get information about a given vm
     revert   Reverts a vm to a specified snapshot
     snapshot Takes a snapshot of a given vm
+    ssh      Grabs a single vm and sshs into it
     status   Prints the status of vmpooler
     summary  Prints the summary of vmpooler
     token    Retrieves or deletes a token
@@ -47,7 +51,7 @@ gem install vmfloaty
 Grabbing a token for authenticated pooler requests:
 
 ```
-floaty token get --user me --url https://vmpooler.mycompany.net/api/v1
+floaty token get --user username --url https://vmpooler.mycompany.net/api/v1
 ```
 
 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.
@@ -64,7 +68,7 @@ If you do not wish to continuely specify various config options with the cli, yo
 
 ```yaml
 #file at /Users/me/.vmfloaty.yml
-url: 'http://vmpooler.mycompany.net/api/v1'
+url: 'https://vmpooler.mycompany.net/api/v1'
 user: 'brian'
 token: 'tokenstring'
 ```
@@ -76,14 +80,13 @@ Now vmfloaty will use those config files if no flag was specified.
 Here are the keys that vmfloaty currently supports:
 
 - verbose
-  + true
-  + false
+  + Boolean
 - token
-  + :token-string
+  + String
 - user
-  + :username
+  + String
 - url
-  + :pooler-url
+  + String
 
 ## vmpooler API
 
@@ -91,6 +94,10 @@ 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

data/lib/vmfloaty/http.rb

@@ -1,11 +1,30 @@
 require 'faraday'
+require 'uri'
 
 class Http
+  def self.is_url(url)
+    # This method exists because it seems like Farady
+    # has no handling around if a user gives us a URI
+    # with no protocol on the beginning of the URL
+
+    uri = URI.parse(url)
+
+    if uri.kind_of?(URI::HTTP) or uri.kind_of?(URI::HTTPS)
+      return true
+    end
+
+    return false
+  end
+
   def self.get_conn(verbose, url)
     if url.nil?
       raise "Did not provide a url to connect to"
     end
 
+    unless is_url(url)
+      url = "https://#{url}"
+    end
+
     conn = Faraday.new(:url => url, :ssl => {:verify => false}) do |faraday|
       faraday.request :url_encoded
       faraday.response :logger if verbose
@@ -24,6 +43,10 @@ class Http
       raise "You did not provide a user to authenticate with"
     end
 
+    unless is_url(url)
+      url = "https://#{url}"
+    end
+
     conn = Faraday.new(:url => url, :ssl => {:verify => false}) do |faraday|
       faraday.request :url_encoded
       faraday.request :basic_auth, user, password

data/lib/vmfloaty/ssh.rb

@@ -0,0 +1,43 @@
+class Ssh
+
+  def self.which(cmd)
+    # Gets path of executable for given command
+
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.each { |ext|
+        exe = File.join(path, "#{cmd}#{ext}")
+        return exe if File.executable?(exe) && !File.directory?(exe)
+      }
+    end
+    return nil
+  end
+
+  def self.ssh(verbose, host_os, token, url)
+    ssh_path = which("ssh")
+    if !ssh_path
+      raise "Could not determine path to ssh"
+    end
+    os_types = {}
+    os_types[host_os] = 1
+
+    response = Pooler.retrieve(verbose, os_types, token, url)
+    if response["ok"] == true
+      if host_os =~ /win/
+        user = "Administrator"
+      else
+        user = "root"
+      end
+
+      hostname = "#{response[host_os]["hostname"]}.#{response["domain"]}"
+      cmd = "#{ssh_path} #{user}@#{hostname}"
+
+      # TODO: Should this respect more ssh settings? Can it be configured
+      #       by users ssh config and does this respect those settings?
+      Kernel.exec(cmd)
+    else
+      raise "Could not get vm from vmpooler:\n #{response}"
+    end
+    return
+  end
+end

data/lib/vmfloaty/version.rb

@@ -1,6 +1,6 @@
 
 class Version
-  @version = '0.5.0'
+  @version = '0.6.0'
 
   def self.get
     @version

data/lib/vmfloaty.rb

@@ -8,6 +8,7 @@ require 'vmfloaty/pooler'
 require 'vmfloaty/version'
 require 'vmfloaty/conf'
 require 'vmfloaty/utils'
+require 'vmfloaty/ssh'
 
 class Vmfloaty
   include Commander::Methods
@@ -45,11 +46,14 @@ class Vmfloaty
         unless os_types.empty?
           if no_token
             response = Pooler.retrieve(verbose, os_types, nil, url)
-            puts response
+            puts Utils.format_hosts(response)
             exit 0
           else
             unless token
               puts "No token found. Retrieving a token..."
+              if !user
+                raise "You did not provide a user to authenticate to vmpooler with"
+              end
               pass = password "Enter your password please:", '*'
               token = Auth.get_token(verbose, url, user, pass)
               puts "\nToken retrieved!"
@@ -345,6 +349,46 @@ class Vmfloaty
       end
     end
 
+    command :ssh do |c|
+      c.syntax = 'floaty ssh os_type'
+      c.summary = 'Grabs a single vm and sshs into it'
+      c.description = ''
+      c.example 'SSHs into a centos vm', 'floaty ssh centos7 --url https://vmpooler.example.com'
+      c.option '--verbose', 'Enables verbose output'
+      c.option '--url STRING', String, 'URL of vmpooler'
+      c.option '--user STRING', String, 'User to authenticate with'
+      c.option '--token STRING', String, 'Token for vmpooler'
+      c.option '--notoken', 'Makes a request without a token'
+      c.action do |args, options|
+        verbose = options.verbose || config['verbose']
+        url = options.url ||= config['url']
+        token = options.token ||= config['token']
+        user = options.user ||= config['user']
+        no_token = options.notoken
+
+        if args.empty?
+          STDERR.puts "No operating systems provided to obtain. See `floaty ssh --help` for more information on how to get VMs."
+          exit 1
+        end
+
+        host_os = args.first
+
+        if !no_token && !token
+          puts "No token found. Retrieving a token..."
+          if !user
+            raise "You did not provide a user to authenticate to vmpooler with"
+          end
+          pass = password "Enter your password please:", '*'
+          token = Auth.get_token(verbose, url, user, pass)
+          puts "\nToken retrieved!"
+          puts token
+        end
+
+        Ssh.ssh(verbose, host_os, token, url)
+        exit 0
+      end
+    end
+
     run!
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Brian Cain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-10 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !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
@@ -54,6 +54,7 @@ files:
 - lib/vmfloaty/conf.rb
 - lib/vmfloaty/http.rb
 - lib/vmfloaty/pooler.rb
+- lib/vmfloaty/ssh.rb
 - lib/vmfloaty/utils.rb
 - lib/vmfloaty/version.rb
 - spec/spec_helper.rb
@@ -70,17 +71,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: CLI application to interface with vmpooler