jossh 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44f63f279e57f3d0989f79931804f0c5739e1500
-  data.tar.gz: ab66d4c0dd2ce09933bec771b2bd62998039f214
+  metadata.gz: 3857009678775cc0439cfbc76d384550da761b35
+  data.tar.gz: bea78d4e9600dfb3d87b589c7529cbfe2a9ac071
 SHA512:
-  metadata.gz: 810969e0823f92a77c6e3060b86a8cda94f8b9c02097db57ac2bbffed7273c3e949f9e98cc1847111025a8d69084a2e8b90bc0c394a647a5c9ac02c832e4ae1e
-  data.tar.gz: 721e0c004c4814567509951875c9d6f9270625a62412e770b8a18458bf59b04b59f7413256986aa1f9b7c9bffea06267dc70308f0549ca4cbaea2d2a0972dd67
+  metadata.gz: bb2711d5f7ca8ad17daf52d042a16d2590c5b182d2a0ad237b6f01a4bf8672f2a5923d2946837a169cbbb2cc899237e6b5640ce16b569c6ca8bd0ac74b6c2c28
+  data.tar.gz: f5108787af8a0048589d0503810113028672d20fb3fa58565302746114c68dcea8e50b85dd7de03fb89f53c3c7727f048e70f3482fc6920de1cf2034308522f6

data/README.md

@@ -39,41 +39,40 @@ Or install manually
 After installing, you can call `jossh` from the command line to run arbitrary
 commands or a local script over SSH.
 
-```
-$ jossh -h
-
-Jossh
+    $ jossh -h
 
-Usage:
-  jossh <host> <script>
-  jossh -m | --make-hostfile
-  jossh -h | --help
-  jossh -v | --version
+    Jossh
 
-Arguments:
-  <host>
-    can be:
-    - :symbol    : in this case we will look in ./ssh_hosts.yml
-    - host       : in this case we will use the current logged in user
-    - user@host
+    Usage:
+      jossh <host> <script>
+      jossh -m | --make-hostfile
+      jossh -l | --list
+      jossh -h | --help
+      jossh -v | --version
 
-  <script>
-    can be:
-    - a filename
-    - one or more direct command
+    Arguments:
+      <host>
+        can be:
+        - :symbol    : in this case we will look in ./ssh_hosts.yml
+        - host       : in this case we will use the current logged in user
+        - user@host
 
-Options:
-  -m --make-hostfile     Generate a template ssh_hosts.yml
-  -h --help              Show this screen
-  -v --version           Show version
+      <script>
+        can be:
+        - a filename
+        - one or more direct command
 
-Examples:
-  jossh :production "git status"
-  jossh jack@server.com "cd ~ && ls -l"
-  jossh server.com deploy
+    Options:
+      -m --make-hostfile     Generate a template ssh_hosts.yml
+      -l --list              Show hosts in ./ssh_hosts.yml or ~/ssh_hosts.yml
+      -h --help              Show this screen
+      -v --version           Show version
 
+    Examples:
+      jossh :production "git status"
+      jossh jack@server.com "cd ~ && ls -l"
+      jossh server.com deploy
 
-```
 
 ## Library Usage
 
@@ -132,12 +131,21 @@ See also: The [examples folder](https://github.com/DannyBen/jossh/tree/master/ex
 
 ## Host specification file
 
-Host specifications should be configured in `ssh_hosts.yml` by default.
+When using a :symbol as the host name, Jossh will look for a YAML 
+configuration file named `ssh_hosts.yml`. The file is expected to be either
+in the current directory or the user's home directory.
 
-If you wish to use a different location, use the `ssh_hostfile` method:
+If you wish to use a different filename or location, use the `ssh_hostfile` 
+method. If you specify only a filename or a relative path, Jossh will still 
+look for this file in both the current directory and user's home directory.
 
 ```ruby
-ssh_hostfile "my_hosts.yml"
+# Specify exact location
+ssh_hostfile "/etc/my_hosts.yml"
+ssh! :myhost, 'ls'
+
+# Look for ./configs/hosts.yml or ~/configs/hosts.yml
+ssh_hostfile "configs/hosts.yml"
 ssh! :myhost, 'ls'
 ```
 

data/lib/jossh/api.rb

@@ -26,7 +26,7 @@ module Jossh
   #
   #   ssh { host: 'localhost', user: 'vagrant' }, "ls -l"
   #
-  #   def my_puts(data)
+  #   def my_puts(data, stream)
   #     puts "> #{data}"
   #   end
   #   ssh :localhost, "ls -l", method: my_puts
@@ -73,6 +73,13 @@ module Jossh
     CommandRunner.instance.ssh_script! hostspec, script
   end
 
+  # Set the name of the hostfile
+  #
+  # ==== Params:
+  #
+  # +file+:: 
+  #   Path to a YAML file
+  #
   def ssh_hostfile(file)
     CommandRunner.instance.ssh_hostfile file
   end

data/lib/jossh/bin_handler.rb

@@ -1,11 +1,14 @@
 require 'etc'
 require 'docopt'
+require 'colsole'
 require 'fileutils'
 
 module Jossh
 
   class BinHandler
 
+    include Colsole
+
     def handle(args)
       begin
         execute Docopt::docopt(doc, argv: args)
@@ -17,8 +20,9 @@ module Jossh
     private
 
     def execute(args)
-      return make_hostfile if args['--make-hostfile']
       return show_version if args['--version']
+      return make_hostfile if args['--make-hostfile']
+      return list_hosts if args['--list']
       handle_script args['<host>'].dup, args['<script>']
     end
 
@@ -58,7 +62,19 @@ module Jossh
       abort "ssh_hosts.yml already exists" if File.exist?('ssh_hosts.yml')
       FileUtils.copy template('ssh_hosts.yml'), './ssh_hosts.yml'
       File.exist? './ssh_hosts.yml' or abort "Unable to create ssh_hosts.yml"
-      puts "Created ssh_hosts.yml" 
+      say "!txtgrn!Created ssh_hosts.yml" 
+    end
+
+    def list_hosts
+      runner = CommandRunner.new
+      if runner.active_hostfile
+        say "!txtgrn!Using: #{runner.active_hostfile}\n"
+        runner.ssh_hosts.each do |key, spec|
+          say "  :#{key.to_s.ljust(14)} = !txtblu!#{spec[:user]}!txtrst!@!txtylw!#{spec[:host]}"
+        end
+      else
+        say "!txtred!Cannot find ssh_hosts.yml or ~/ssh_hosts.yml"
+      end
     end
 
     def show_version

data/lib/jossh/command_runner.rb

@@ -39,6 +39,7 @@ module Jossh
     end
 
     def ssh_hostfile(file)
+      file = 'ssh_hosts.yml' if file == :default
       @hostfile = file
 
       # force reload in case we were called after some ssh call was
@@ -46,6 +47,20 @@ module Jossh
       @ssh_hosts = nil 
     end
 
+    def ssh_hosts
+      @ssh_hosts ||= load_ssh_hosts
+    end
+
+    def active_hostfile
+      if File.exist? hostfile 
+        hostfile
+      elsif hostfile[0] != '/' and File.exist? user_hostfile
+        user_hostfile
+      else
+        false
+      end
+    end
+
     private
 
     def simple_puts(data, stream)
@@ -57,22 +72,25 @@ module Jossh
     end
 
     def load_spec(key)
-      ssh_hosts[key] or raise "Cannot find :#{key} in #{hostfile}"
-    end
-
-    def ssh_hosts
-      @ssh_hosts ||= load_ssh_hosts
+      ssh_hosts[key] or raise "Cannot find :#{key}"
     end
 
     def load_ssh_hosts
-      File.exist? hostfile or raise "Cannot find #{hostfile}"
-      YAML.load_file hostfile
+      if active_hostfile
+        YAML.load_file active_hostfile
+      else
+        raise "Cannot find #{hostfile} or #{user_hostfile}"
+      end
     end
 
     def hostfile
       @hostfile ||= 'ssh_hosts.yml'
     end
 
+    def user_hostfile
+      "#{Dir.home}/#{hostfile}"
+    end
+
     def load_script(script)
       File.read script
     end

data/lib/jossh/templates/docopt.txt

@@ -3,6 +3,7 @@ Jossh
 Usage:
   jossh <host> <script>
   jossh -m | --make-hostfile
+  jossh -l | --list
   jossh -h | --help 
   jossh -v | --version
 
@@ -20,6 +21,7 @@ Arguments:
 
 Options:
   -m --make-hostfile     Generate a template ssh_hosts.yml 
+  -l --list              Show hosts in ./ssh_hosts.yml or ~/ssh_hosts.yml
   -h --help              Show this screen
   -v --version           Show version
 

data/lib/jossh/version.rb

@@ -1,3 +1,3 @@
 module Jossh
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jossh
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole