cast-ssh 0.1.4 → 0.1.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGEyMzk2NjVkM2UzMGM0MjY5Y2YwYWRhODcxY2MwMzZlNGFmZjViYw==
-  data.tar.gz: !binary |-
-    NGU3YjVjZTgyMzZmZDI5NDVjY2RmMjgxYTQxNzYzNTQ3MmRmNjZjOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YWExNDJjOGU3MTYzOWY1OWU1MzhhZGE5ZmU4ZjZjNDRjZTY3MzkyYjZiZGY2
-    ZTRiNzU0ZGQ3ODA1OTJjNzc0YmU0YzU4YmU1NzQ3OTM3YTAwOGRlNzI0ZjFl
-    MzNjNzI1YWNjNjhkNjQ4YzdjMTk2OTEwM2I4NmE1NGY3ZDkxNmQ=
-  data.tar.gz: !binary |-
-    MmYxMGMzYWQ5ODMzNDQ1OGIxOTNjNDc3NjJhZjM2ZGQwNzRkNWVkODUzZmZm
-    OThiODBlMGY3YzIxY2MxMDNjYTU1NWVlNmI0ZWEyMTJhMzdiZDIyNThkM2Qx
-    OWE4MjUwYzZmMGQ5MDA5MzZlYTM2MjdkNmRlMGM2ZDViZWI3MTY=
+SHA1:
+  metadata.gz: cceed46756626f5c4c561cf1f6d906db52030585
+  data.tar.gz: ea3828524600ca8e6f073b7b5de2da4d4b6e7ae6
+SHA512:
+  metadata.gz: 7f15fca12981a9c221f10e3d5a5975d4da9950afc192d89b0c5db69d3709cf913a4014cd3915bf30e353ad1038eb2be8233a7d0e037a4945f25664151ee56c0c
+  data.tar.gz: c873f60082c69d8c5bbac734243f4636db527e48f9e385e45c6fc7a9705b3227eaa54c637056cc67a2271ca9c3004fcfc4e104851e1ddcba0fd596adb42a75c2

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 

data/README.md

@@ -6,39 +6,47 @@ This is a Ruby gem that executes remote commands via ssh on groups of servers de
 
 Grab the gem:
 
-    gem install cast-ssh
+```bash
+gem install cast-ssh
+```
 
 Create your group file at ~/.cast.yml, like this:
 
-    group1:
-    - host1
-    - host2
-    - host3
+```yaml
+group1:
+- host1
+- host2
+- host3
 
-    group2:
-    - host1
-    - host4
-    - host5
+group2:
+- host1
+- host4
+- host5
+```
 
 Run commands in your shell:
 
-    cast group1 echo test
-    cast group1,group2 sudo whoami
-    cast -s group1,host4 df -h
+```bash
+cast group1 echo test
+cast group1,group2 sudo whoami
+cast -s group1,host4 df -h
+```
 
 The output from the second command will look something like this:
 
-    [cast] loading groups from ~/.cast.yml
-    [cast] running ssh host1 'sudo whoami'
-    [cast] running ssh host2 'sudo whoami'
-    [cast] running ssh host3 'sudo whoami'
-    [cast] running ssh host4 'sudo whoami'
-    [cast] running ssh host5 'sudo whoami'
-    [host3] root
-    [host1] root
-    [host2] root
-    [host5] root
-    [host4] root
+```
+[cast] loading groups from ~/.cast.yml
+[cast] running ssh host1 'sudo whoami'
+[cast] running ssh host2 'sudo whoami'
+[cast] running ssh host3 'sudo whoami'
+[cast] running ssh host4 'sudo whoami'
+[cast] running ssh host5 'sudo whoami'
+[host3] root
+[host1] root
+[host2] root
+[host5] root
+[host4] root
+```
 
 Note that the commands are run in parallel, so the output may be out of order.
 
@@ -55,19 +63,29 @@ Note that the commands are run in parallel, so the output may be out of order.
 
 ### API
 
-You can also access the same functionality from within Ruby. The following methods are available:
+You can also access the same functionality from within Ruby.
+
+To include Cast in your code do:
+```ruby
+require 'cast'
+```
+
+The following methods are available:
 
 * __Cast::remote__ host, cmd
 
   Run a remote command on the given host, sending output to stdout.
 
-* __Cast::local__ cmd, prefix = nil -> int
+* __Cast::local__ cmd, options = {} -> int
 
   Run a command locally, printing stdout and stderr from the command. Returns the process' return value.
 
-* __Cast::_ensure_local__ cmd, prefix = nil -> int
-
-  Run a command locally but raise an exception if it fails.
+  You can use the following options:
+  ```
+  :ensure              - Raise exceptions if the command returns a non-zero error code.
+  :prefix              - Prefix to use on lines when printing stdout/stderr.
+  :clean_bundler_env   - Use a clean bundler environment when running the command.
+  ```
 
 * __Cast::log__ msg, source = 'cast', stream = $stdout
 
@@ -81,3 +99,9 @@ You can also access the same functionality from within Ruby. The following metho
 
   Takes an array of groups and hosts, and expands the groups into their constituents given the input group hash. If no hash is given, use the value loaded most recently in load_groups. Returns an array of hostnames.
 
+#### TODO
+
+* Accept env vars for local and remote commands.
+* Check for duplicate groups in groupfile.
+* Propogate local signals to remote commands.
+

data/lib/cast.rb

@@ -2,12 +2,13 @@ require 'thread'
 require 'open3'
 require 'yaml'
 require 'peach'
+require 'bundler'
 
 STDOUT.sync = true
 STDERR.sync = true
 
 module Cast
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
   DEFAULTGROUPS = '~/.cast.yml'
 
   @@mux = Mutex.new
@@ -76,10 +77,18 @@ module Cast
     return r
   end
 
-  def self.local cmd, prefix = nil
+  def self.local cmd, options = {}
+    prefix = nil
+
+    if options.is_a? String
+      prefix = options # this is for backwards compatibility
+    elsif options[:prefix]
+      prefix = options[:prefix]
+    end
+
     r = nil
 
-    Open3.popen3 cmd do |stdin, stdout, stderr, wait_thr|
+    blk = Proc.new do |stdin, stdout, stderr, wait_thr|
       @@pids << wait_thr.pid
       stdin.close
 
@@ -118,6 +127,20 @@ module Cast
       r = wait_thr.value
     end
 
+    if options[:clean_bundler_env]
+      Bundler.with_clean_env do
+        Open3.popen3(cmd, &blk)
+      end
+    else
+      Open3.popen3(cmd, &blk)
+    end
+
+    if options[:ensure]
+      unless r.exitstatus == 0
+        raise "command failed: #{cmd}"
+      end
+    end
+
     return r.exitstatus
   end
 

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: cast-ssh
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Peter Bakkum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: autotest-standalone
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: peach
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Execute remote commands via ssh on groups of machines
@@ -90,14 +90,14 @@ extra_rdoc_files:
 - LICENSE.md
 - README.md
 files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
 - LICENSE.md
 - README.md
+- bin/cast
 - cast.gemspec
-- Gemfile
-- .rspec
-- .travis.yml
 - lib/cast.rb
-- bin/cast
 - spec/lib/cast_spec.rb
 - spec/spec_helper.rb
 - spec/test.yml
@@ -107,22 +107,22 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Execute remote commands via ssh on groups of machines
@@ -130,4 +130,3 @@ test_files:
 - spec/lib/cast_spec.rb
 - spec/spec_helper.rb
 - spec/test.yml
-has_rdoc: