vmfloaty 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1276bc1708aeaed0989e57cf71cdb5285a30e056
-  data.tar.gz: 31548a5160989a07c5e90535231a2bc3644bba5b
+  metadata.gz: 4c7884840968e8735caff3146f276a2f9075cf79
+  data.tar.gz: 172f0dc34672fb184d62bb4dc7eb93d306e9d413
 SHA512:
-  metadata.gz: d506a2ce2c29fef29b45a81cef91c3e643ff9cd9811a038ea601aeab9b9474715b08e2d31e4ce0d1e0c203115a52aa12760c70f33f841ecefc6de3a8342128d0
-  data.tar.gz: 2fe79335fab27724c2a86d16f899f394390d0990fb0f6857c6d773dd4b56a0ba6ce61bc8957c9c6ac5428dad64da44e3b4dde6829467af0c482b6f88746e31b2
+  metadata.gz: ebfe08176a0505aa253849222afc98cf5b08361db264cee13fce6947b292434f1c466e23291fdee722b3b0cf658ac50335d61f78397190e3b489c237cab10806
+  data.tar.gz: 0d776b18978fb5fe8a1c893e1f2c1198fd78c7190561388eb7b1be334d79923ae0a39fa498e3007e7bc3c09834c05145cac5790195fa39c6c4e19d6f719254ae

data/README.md

@@ -88,6 +88,22 @@ Here are the keys that vmfloaty currently supports:
 - url
   + String
 
+### Tab Completion
+
+There is a basic completion script for Bash (and possibly other shells) included with the gem in the [extras/completions](https://github.com/briancain/vmfloaty/blob/master/extras/completions) folder. To activate, that file simply needs to be sourced somehow in your shell profile.
+
+For convenience, the path to the completion script for the currently active version of the gem can be found with the `floaty completion` subcommand. This makes it easy to add the completion script to your profile like so:
+
+```bash
+source $(floaty completion --shell bash)
+```
+
+If you are running on macOS and use Homebrew's `bash-completion` formula, you can symlink the script to `/usr/local/etc/bash_completion.d/floaty` and it will be sourced automatically:
+
+```bash
+ln -s $(floaty completion --shell bash) /usr/local/etc/bash_completion.d/floaty
+```
+
 ## vmpooler API
 
 This cli tool uses the [vmpooler API](https://github.com/puppetlabs/vmpooler/blob/master/API.md).

data/extras/completions/floaty.bash

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+_vmfloaty()
+{
+  local cur prev subcommands template_subcommands hostname_subcommands
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+
+  subcommands="delete get help list modify query revert snapshot ssh status summary token"
+  template_subcommands="get ssh"
+  hostname_subcommands="delete modify query revert snapshot"
+
+  if [[ $cur == -* ]] ; then
+    # TODO: option completion
+    COMPREPLY=()
+  elif [[ $template_subcommands =~ (^| )$prev($| ) ]] ; then
+    if [[ -z "$_vmfloaty_avail_templates" ]] ; then
+      _vmfloaty_avail_templates=$(floaty list 2>/dev/null)
+    fi
+
+    COMPREPLY=( $(compgen -W "${_vmfloaty_avail_templates}" -- "${cur}") )
+  elif [[ $hostname_subcommands =~ (^| )$prev($| ) ]] ; then
+    _vmfloaty_active_hostnames=$(floaty list --active 2>/dev/null | grep '^-' | cut -d' ' -f2)
+    COMPREPLY=( $(compgen -W "${_vmfloaty_active_hostnames}" -- "${cur}") )
+  else
+    COMPREPLY=( $(compgen -W "${subcommands}" -- "${cur}") )
+  fi
+}
+complete -F _vmfloaty floaty

data/lib/vmfloaty.rb

@@ -16,7 +16,7 @@ class Vmfloaty
   include Commander::Methods
 
   def run
-    program :version, Version.get
+    program :version, Vmfloaty::VERSION
     program :description, 'A CLI helper tool for Puppet Labs vmpooler to help you stay afloat'
 
     config = Conf.read_config
@@ -75,7 +75,7 @@ class Vmfloaty
                 STDERR.puts "You did not provide a user to authenticate to vmpooler with"
                 exit 1
               end
-              pass = password "Enter your password please:", '*'
+              pass = password "Enter your vmpooler password please:", '*'
               begin
                 token = Auth.get_token(verbose, url, user, pass)
               rescue TokenError => e
@@ -479,7 +479,7 @@ class Vmfloaty
 
         case action
         when "get"
-          pass = password "Enter your password please:", '*'
+          pass = password "Enter your vmpooler password please:", '*'
           begin
             token = Auth.get_token(verbose, url, user, pass)
           rescue TokenError => e
@@ -489,7 +489,7 @@ class Vmfloaty
           puts token
           exit 0
         when "delete"
-          pass = password "Enter your password please:", '*'
+          pass = password "Enter your vmpooler password please:", '*'
           begin
             result = Auth.delete_token(verbose, url, user, pass, token)
           rescue TokenError => e
@@ -545,7 +545,7 @@ class Vmfloaty
             STDERR.puts "You did not provide a user to authenticate to vmpooler with"
             exit 1
           end
-          pass = password "Enter your password please:", '*'
+          pass = password "Enter your vmpooler password please:", '*'
           begin
             token = Auth.get_token(verbose, url, user, pass)
           rescue TokenError => e
@@ -562,6 +562,32 @@ class Vmfloaty
       end
     end
 
+    command :completion do |c|
+      c.syntax = 'floaty completion [options]'
+      c.summary = 'Outputs path to completion script'
+      c.description = Utils.strip_heredoc(<<-EOF)
+        Outputs path to a completion script for the specified shell (or 'bash' if not specified). This makes it easy to add the completion script to your profile:
+
+          source $(floaty completion --shell bash)
+
+        This subcommand will exit non-zero with an error message if no completion script is available for the requested shell.
+      EOF
+      c.example 'Gets path to bash tab completion script', 'floaty completion --shell bash'
+      c.option '--shell STRING', String, 'Shell to request completion script for'
+      c.action do |args, options|
+        shell = (options.shell || 'bash').downcase.strip
+        completion_file = File.expand_path(File.join('..', '..', 'extras', 'completions', "floaty.#{shell}"), __FILE__)
+
+        if File.exist?(completion_file)
+          puts completion_file
+          exit 0
+        else
+          STDERR.puts "Could not find completion file for '#{shell}': No such file #{completion_file}"
+          exit 1
+        end
+      end
+    end
+
     run!
   end
 end

data/lib/vmfloaty/utils.rb

@@ -113,4 +113,12 @@ class Utils
     puts
     puts message.colorize(status['status']['ok'] ? :default : :red)
   end
+
+  # Adapted from ActiveSupport
+  def self.strip_heredoc(str)
+    min_indent = str.scan(/^[ \t]*(?=\S)/).min
+    min_indent_size = min_indent.nil? ? 0 : min_indent.size
+
+    str.gsub(/^[ \t]{#{min_indent_size}}/, '')
+  end
 end

data/lib/vmfloaty/version.rb

@@ -1,8 +1,3 @@
-
-class Version
-  @version = '0.7.8'
-
-  def self.get
-    @version
-  end
+class Vmfloaty
+  VERSION = '0.7.9'.freeze
 end

data/spec/spec_helper.rb

@@ -1,2 +1,8 @@
 require 'vmfloaty'
 require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+  config.formatter = :documentation
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - Brian Cain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
 description: A helper tool for vmpooler to help you stay afloat
@@ -63,6 +63,7 @@ files:
 - LICENSE
 - README.md
 - bin/floaty
+- extras/completions/floaty.bash
 - lib/vmfloaty.rb
 - lib/vmfloaty/auth.rb
 - lib/vmfloaty/conf.rb
@@ -78,7 +79,7 @@ files:
 - spec/vmfloaty/utils_spec.rb
 homepage: https://github.com/briancain/vmfloaty
 licenses:
-- Apache
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -96,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: CLI application to interface with vmpooler