jossh 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ada7289fa9d9e80eaeb6138d9db717288b39714e
-  data.tar.gz: 7bb2c4f1460ccbe880855196de4a7ff6d646b472
+  metadata.gz: 2392f4c98b9c8a6d7ccb5bc0480485e3b8caaf10
+  data.tar.gz: 76699c16469e9855283b62b88a4edf842e80194c
 SHA512:
-  metadata.gz: 7f7cec75732678fe5cab4c149d713b49b93829d0a2031f899bc88aeb8e70515de2009f10f230c8990b5fc661a8db50704f3d96094488fb0166724751a8af359c
-  data.tar.gz: 70e7cf9f993aa127938db51eaa595bc277087633fa0a6d55ff83d3197f6d974d31a954329c429ed26319951da534895c2dc8360d606a32c51b805323e909c3ab
+  metadata.gz: de3c0205fb8da77a2f3f4ec794e9711ef0a97bd4b2ba1597ec146098378cd441bcb2fe0a93fee412fb474d0f9594fdb6b19b5599122128e91a8de8df3cc960d8
+  data.tar.gz: 50559ec6d9797dec802eeb81390f9d0f6c85dbb6570444108b07506a052de8b0168ebe08616b53bc25407f7cf1ee6778ba64917e7c84fb81c4fa9e7e7335147f

data/README.md

@@ -8,7 +8,7 @@ Jossh - Your SSH Buddy
 
 **Jossh** is
 
-- a command line utility for running local scripts and comments over SSH.
+- a command line utility for running local scripts and commands over SSH.
 - a ruby library for easier and prettier SSH deployment and automation.
 
 ## Install
@@ -25,14 +25,15 @@ Or install manually
 ## Features
 
 1. Allows running one or more commands over SSH.
-2. Allows running external local scripts remotely
-3. Has four commands: `ssh`, `ssh!`, `ssh_script` and `ssh_script!`. The 'bang' versions generate pretty and indented output.
-4. Uses a single SSH connection.
-5. Uses a simple hash for defining hosts.
-6. Allows storing host specifications in a YAML file.
-7. Supports all options available in `Net::SSH#start`.
-8. Prints output Heroku-style.
-9. Provides a command line interface - `jossh <host> <script>` 
+2. Allows running local scripts remotely
+3. Allows running a script on multiple hosts.
+4. Has four commands: `ssh`, `ssh!`, `ssh_script` and `ssh_script!`. The 'bang' versions generate pretty and indented output.
+5. Uses a single SSH connection.
+6. Uses a simple hash for defining hosts.
+7. Allows storing host specifications in a YAML file.
+8. Supports all options available in `Net::SSH#start`.
+9. Prints output Heroku-style.
+10. Has a command line interface - `jossh <host> <script>` 
 
 ## Command Line Usage
 
@@ -42,46 +43,47 @@ commands or a local script over SSH.
     $ jossh -h
 
     Jossh
-
+    
     Usage:
       jossh <host> <script> [-- <arguments>...]
       jossh -m | --make-hostfile
       jossh -e | --edit-hostfile
       jossh -l | --list
-      jossh -h | --help
+      jossh -h | --help 
       jossh -v | --version
-
+    
     Arguments:
       <host>
         can be:
-        - :symbol    : in this case we will look in ./ssh_hosts.yml
+        - :symbol    : in this case we will look in ./ssh_hosts.yml or ~/ssh_hosts.yml
         - host       : in this case we will use the current logged in user
         - user@host
-
-      <script>
+    
+      <script> 
         can be:
         - a filename
         - one or more direct command
-
+    
       <arguments>...
         When specifying a filename as the <script>, you may also pass additional
-        arguments to it.
+        arguments to it. 
         Use $1 - $9 in your script file to work with these arguments.
         Use $@ (or $*) to use the entire arguments string
-
+    
     Options:
-      -m --make-hostfile     Generate a template ssh_hosts.yml
+      -m --make-hostfile     Generate a template ssh_hosts.yml 
       -e --edit-hostfile     Open the currently used ssh_hosts.yml file for editing
       -l --list              Show hosts in ./ssh_hosts.yml or ~/ssh_hosts.yml
       -h --help              Show this screen
       -v --version           Show version
-
-    Examples:
+    
+    Examples: 
       jossh :production "git status"
       jossh jack@server.com "cd ~ && ls -l"
       jossh server.com deploy
       jossh server.com rake -- db:migrate
 
+---
 
 ## Library Usage
 
@@ -138,7 +140,7 @@ echo "-> Done"
 
 See also: The [examples folder](https://github.com/DannyBen/jossh/tree/master/examples)
 
-## Host specification file
+## Host Specification File
 
 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
@@ -162,4 +164,58 @@ You can ask Jossh to create a sample file for you by running:
 
     $ jossh --make-hostfile
 
+## Working with Multiple Hosts
+
+Define multiple hosts in the `ssh_hosts.yml` file by simply providing an array
+of other keys:
+
+```yaml
+:web01:
+  :host: web01.server.com
+  :user: admin
+
+:web02:
+  :host: web02.server.com
+  :user: admin
+
+:production: 
+  - :web01
+  - :web02
+```
+
 See [ssh_hosts.example.yml](https://github.com/DannyBen/jossh/blob/master/ssh_hosts.example.yml) as an example.
+
+## Writing Scripts
+
+The scripts you execute with Jossh are simple shell scripts. These variables 
+are available to you inside the script:
+
+### `$1 - $9 and $@ or $*`
+
+When running through the command line and using the 
+`jossh <host> <script> -- <arguments>` syntax, these variables hold the 
+arguments.
+
+`$@` and `$*` hold the entire arguments string.
+
+Example: 
+```bash
+# myscript
+echo "-> Running requested rake task"
+rake $@
+```
+
+And call it with:
+`$ jossh :host myscript -- db:migrate`
+
+
+
+### `%{key}`
+When this syntax appears in your script, it will be replaced with any key
+from the host configuration. 
+
+Example: 
+```bash
+echo "-> Migrating database on %{host}"
+rake db:migrate
+```

data/lib/jossh/bin_handler.rb

@@ -71,7 +71,11 @@ module Jossh
       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]}"
+          if spec.is_a? Hash
+            say "  :#{key.to_s.ljust(14)} = !txtblu!#{spec[:user]}!txtrst!@!txtylw!#{spec[:host]}"
+          else
+            say "  :#{key.to_s.ljust(14)} = !txtpur!#{spec.join '!txtrst!, !txtpur!'}"
+          end
         end
       else
         say "!txtred!Cannot find ssh_hosts.yml or ~/ssh_hosts.yml"

data/lib/jossh/command_runner.rb

@@ -20,13 +20,12 @@ module Jossh
       callback ||= method :simple_puts
       script   = script.join "\n" if script.is_a? Array
       hostspec = load_spec(hostspec) if hostspec.is_a? Symbol
-      host     = hostspec.delete :host
-      user     = hostspec.delete :user
-
-      Net::SSH.start( host, user, hostspec ) do |ssh| 
-        ssh.exec! script do |_ch, stream, data|
-          callback.call data, stream
+      if hostspec.is_a? Array
+        hostspec.each do |spec|
+          execute_ssh_script spec, script, callback
         end
+      else
+        execute_ssh_script hostspec, script, callback
       end
     end
 
@@ -63,6 +62,17 @@ module Jossh
 
     private
 
+    def execute_ssh_script(hostspec, script, callback)
+      script = script % hostspec
+      host   = hostspec.delete :host
+      user   = hostspec.delete :user
+      Net::SSH.start( host, user, hostspec ) do |ssh| 
+        ssh.exec! script do |_ch, stream, data|
+          callback.call data, stream
+        end
+      end
+    end
+
     def simple_puts(data, stream)
       if stream == :stderr
         STDERR.puts data
@@ -72,7 +82,18 @@ module Jossh
     end
 
     def load_spec(key)
-      ssh_hosts[key] or raise "Cannot find :#{key}"
+      hostspec = ssh_hosts[key]
+      return hostspec if hostspec.is_a? Hash 
+      if hostspec.is_a? Array
+        hostspecs = []
+        hostspec.each do |inner_key|
+          inner_hostspec = load_spec(inner_key)
+          inner_hostspec or raise "Cannot find :#{inner_key} in :#{key}"
+          hostspecs << inner_hostspec
+        end
+        return hostspecs
+      end
+      raise "Cannot find :#{key}"
     end
 
     def load_ssh_hosts

data/lib/jossh/templates/docopt.txt

@@ -11,7 +11,7 @@ Usage:
 Arguments:
   <host>
     can be:
-    - :symbol    : in this case we will look in ./ssh_hosts.yml
+    - :symbol    : in this case we will look in ./ssh_hosts.yml or ~/ssh_hosts.yml
     - host       : in this case we will use the current logged in user
     - user@host
 

data/lib/jossh/version.rb

@@ -1,3 +1,3 @@
 module Jossh
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jossh
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -53,47 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: runfile
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: run-gem-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: run-gem-dev
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement