jossh 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15cd40420f857c0961001c61dab3d683f89c907a
-  data.tar.gz: 884df776481c6aca398241d303fa6a58aceb3b80
+  metadata.gz: 44f63f279e57f3d0989f79931804f0c5739e1500
+  data.tar.gz: ab66d4c0dd2ce09933bec771b2bd62998039f214
 SHA512:
-  metadata.gz: dab42099d80d7d3aff945323a136cdd6078d244c7b2dceaf4e8c36e104ed7cb44300a0f7fb06c926643761e7a0e5f54daed53df8a95e78c3dbd69d09d269706f
-  data.tar.gz: 13a3af70813a58a68dec6784389c48beee274a41655a60c5fcdb5e9acc3427b6fd94af16d5e315a38367aa686357d8eac5760e1392cdfad8a03a76f12b5805c9
+  metadata.gz: 810969e0823f92a77c6e3060b86a8cda94f8b9c02097db57ac2bbffed7273c3e949f9e98cc1847111025a8d69084a2e8b90bc0c394a647a5c9ac02c832e4ae1e
+  data.tar.gz: 721e0c004c4814567509951875c9d6f9270625a62412e770b8a18458bf59b04b59f7413256986aa1f9b7c9bffea06267dc70308f0549ca4cbaea2d2a0972dd67

data/README.md

@@ -40,24 +40,38 @@ After installing, you can call `jossh` from the command line to run arbitrary
 commands or a local script over SSH.
 
 ```
-$ jossh
+$ jossh -h
 
-Usage: jossh <host> <script>
-       jossh -h
+Jossh
 
- <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 -h | --help
+  jossh -v | --version
 
- <script> can be:
-   - a filename
-   - one or more direct command - quotes are only needed if you include
-     multiple commands with && or semicolor (;)
+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
+
+  <script>
+    can be:
+    - a filename
+    - one or more direct command
+
+Options:
+  -m --make-hostfile     Generate a template 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
 
-Examples: jossh :production git status
-          jossh jack@server.com "cd ~ && ls -l"
-          jossh server.com deploy
 
 ```
 
@@ -127,4 +141,8 @@ ssh_hostfile "my_hosts.yml"
 ssh! :myhost, 'ls'
 ```
 
+You can ask Jossh to create a sample file for you by running:
+
+    $ jossh --make-hostfile
+
 See [ssh_hosts.example.yml](https://github.com/DannyBen/jossh/blob/master/ssh_hosts.example.yml) as an example.

data/bin/jossh

@@ -1,62 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'jossh'
-require 'etc'
-
-# for dev (not needed in most cases)
-# require File.dirname(__FILE__) + "/../lib/jossh"
-
 trap(:INT) { abort "\r\nGoodbye" }
+include Jossh
+BinHandler.new.handle ARGV
 
-def short_usage
-  "\nUsage: jossh <host> <script>\n" +
-  "       jossh -h\n\n" 
-end
-
-def usage
-  short_usage +
-  " <host> can be:\n"+
-  "   - :symbol    - in this case we will look in ./ssh_hosts.yml\n" +
-  "   - host       - in this case we will use the current logged in user\n" +
-  "   - user@host\n\n" +
-  " <script> can be:\n" +
-  "   - a filename\n" + 
-  "   - one or more direct command - quotes are only needed if you include\n" +
-  "     multiple commands with && or semicolor (;)\n\n" +
-  "Examples: jossh :production git status\n" +
-  "          jossh jack@server.com \"cd ~ && ls -l\"\n" +
-  "          jossh server.com deploy"
-end
-
-def run
-  ARGV.empty? and abort short_usage
-  ARGV[0] == '-h' and abort usage
-  host   = ARGV.shift.dup
-  script = ARGV.join ' '
-  host and script or abort short_usage
-  host = standardize_host host
-  begin
-    if File.exist? script
-      ssh_script! host, script
-    else
-      ssh host, script
-    end
-  rescue => e
-    abort e.message
-  end
-end
-
-def standardize_host(str)
-  if str[0] == ':' 
-    str[0] = ''
-    return str.to_sym
-  end
-
-  if str =~ /^(.+)@(.+)$/
-    return { user: $1, host: $2 }
-  end
-
-  return { user: Etc.getlogin, host: str }
-end
-
-run

data/lib/jossh/bin_handler.rb

@@ -0,0 +1,77 @@
+require 'etc'
+require 'docopt'
+require 'fileutils'
+
+module Jossh
+
+  class BinHandler
+
+    def handle(args)
+      begin
+        execute Docopt::docopt(doc, argv: args)
+      rescue Docopt::Exit => e
+        puts e.message
+      end
+    end
+
+    private
+
+    def execute(args)
+      return make_hostfile if args['--make-hostfile']
+      return show_version if args['--version']
+      handle_script args['<host>'].dup, args['<script>']
+    end
+
+    def handle_script(host, script)
+      host = standardize_host host
+
+      begin
+        if File.exist? script
+          ssh_script! host, script
+        else
+          ssh host, script
+        end
+      # :nocov:
+      rescue => e
+        abort e.message
+      end
+      # :nocov:
+    end
+
+    def standardize_host(str)
+      if str[0] == ':' 
+        str[0] = ''
+        return str.to_sym
+      end
+
+      # :nocov:
+      # We DO have a test for these two cases, requires manual password type
+      if str =~ /^(.+)@(.+)$/
+        return { user: $1, host: $2 }
+      end
+
+      return { user: Etc.getlogin, host: str }
+      # :nocov:
+    end
+
+    def make_hostfile
+      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" 
+    end
+
+    def show_version
+      puts VERSION
+    end
+
+    def doc
+      return @doc if @doc 
+      @doc = File.read template 'docopt.txt'
+    end
+
+    def template(file)
+      File.expand_path("../templates/#{file}", __FILE__)
+    end
+  end
+end

data/lib/jossh/templates/docopt.txt

@@ -0,0 +1,30 @@
+Jossh
+
+Usage:
+  jossh <host> <script>
+  jossh -m | --make-hostfile
+  jossh -h | --help 
+  jossh -v | --version
+
+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
+
+  <script> 
+    can be:
+    - a filename
+    - one or more direct command
+
+Options:
+  -m --make-hostfile     Generate a template 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
+

data/lib/jossh/templates/ssh_hosts.yml

@@ -0,0 +1,21 @@
+# SSH Hosts File for Jossh
+#
+# Supports any of the attributes available in Net::SSH#start
+# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+#
+# :host: and :user: are required, everything else is optional
+#
+
+:localhost:
+  :host: 'localhost'
+  :user: 'me'
+
+:production:
+  :host: 'production.server.com'
+  :user: 'josh'
+  :port: 22
+  :timeout: 60
+  :passphrase: 'when using private key to prevent prompt'
+  :password: 'when using user/password'
+  :forward_agent: true
+  :use_agent: true

data/lib/jossh/version.rb

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

data/lib/jossh.rb

@@ -1,6 +1,7 @@
 require 'jossh/version'
 require 'jossh/command_runner'
 require 'jossh/output_handler'
+require 'jossh/bin_handler'
 require 'jossh/api'
 
 self.extend Jossh

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jossh
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +134,11 @@ files:
 - bin/jossh
 - lib/jossh.rb
 - lib/jossh/api.rb
+- lib/jossh/bin_handler.rb
 - lib/jossh/command_runner.rb
 - lib/jossh/output_handler.rb
+- lib/jossh/templates/docopt.txt
+- lib/jossh/templates/ssh_hosts.yml
 - lib/jossh/version.rb
 homepage: https://github.com/DannyBen/jossh
 licenses: