weave 1.0.2.beta1 → 1.1.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c11f2751ec38a419142cd0f20bfab5a12f42393
-  data.tar.gz: e078add354738f1f22b85c12c01817e83349ca02
+  metadata.gz: aa0ce3c6677178d9891d65239ab9982fe0e6038d
+  data.tar.gz: 892226999386cb1e0caf1a93b55fd4f72e362703
 SHA512:
-  metadata.gz: d86352f8c23e2b51dd8f64ffbe91b5f5e8da46452442656b24dd07cec4e0ee5600958179f70685ef2244184424b5425b7ec064b7be7d0b69b0cc07eb7f2ea561
-  data.tar.gz: 824967f7cd66565084c8376899abd1379ef10a222e309603435f224f3edbfb0e692fb054ee5ae2c03d46e3e952ed2997947b67dad285c49469a0bfaba0857253
+  metadata.gz: 2c691d81f57e0d6ae599fea383ee7bd9b9b31341d17b6614719198a5de20989c9d87b7e07a91bb405b8824db4a36626bf2b3c9c81543bd4fa7d29cfed63778e9
+  data.tar.gz: 0fe3897f7c733b1228742bd76588f6b2cc831037d38013840fa434d5baecf96135ec7952aba7c76d94dbb48bc50f1fcf8918492f53c1cb1aaa7590ad572f0327

data/README.md

@@ -10,9 +10,8 @@ Put `weave` in your Gemfile or install directly:
 
 ## Documentation
 
-[Method docs here](http://rubydoc.info/github/cespare/weave/master/frames). Usage docs coming soon. See the
-examples (in `examples/`) to get started.
-
+[Method docs here](http://rubydoc.info/github/cespare/weave/master/frames). See the examples (in `examples/`)
+to get started.
 
 ## Implemented features
 
@@ -22,3 +21,9 @@ examples (in `examples/`) to get started.
 * Commands:
 
   - `run`
+
+## Tests
+
+You need vagrant installed. `vagrant up` to get the machines running. Then:
+
+    $ bundle exec rake test

data/examples/basic.rb

@@ -2,6 +2,6 @@ $:.unshift File.join(File.dirname(__FILE__), "../lib")
 
 require "weave"
 
-pool = Weave.connect(ARGV) do
-  run "ls"
+Weave.connect(ARGV) do
+  run "ls /"
 end

data/lib/weave.rb

@@ -1,6 +1,5 @@
 require "net/ssh"
 require "thread"
-require "timeout"
 
 module Weave
   DEFAULT_THREAD_POOL_SIZE = 10
@@ -12,16 +11,18 @@ module Weave
   COLORS = { :red => 1, :green => 2 }
 
   # Create a connection pool for an array of hosts. Each host must have a user specified (e.g.,
-  # root@example.com). If a block is given, then the options are passed through to the underlying
-  # ConnectionPool and the block is immediately run in the context of each connection. Otherwise, a pool is
-  # returned.
+  # root@example.com). If the key :net_ssh_options is present in options, then the value is a hash of options
+  # that is passed directly to Net::SSH.start. If a block is given, then the options (except for
+  # :net_ssh_options)  are passed through to the underlying ConnectionPool and the block is immediately run in
+  # the context of each connection. Otherwise, a pool is returned.
   #
   # @see ConnectionPool#execute
   def self.connect(host_list, options = {}, &block)
     unless host_list.is_a? Array
       raise Weave::Error, "Must pass an array for host_list. Received: #{host_list.inspect}"
     end
-    pool = ConnectionPool.new(host_list)
+    net_ssh_options = options.delete(:net_ssh_options)
+    pool = ConnectionPool.new(host_list, net_ssh_options)
     if block_given?
       pool.execute(options, &block)
       pool.disconnect!
@@ -61,9 +62,12 @@ module Weave
   class ConnectionPool
     # @param [Array] host_list the array of hosts, of the form user@host. You may leave off this argument, and
     # use #execute_with (instead of #execute) to specify the whole list of hosts each time.
-    def initialize(host_list = [])
+    def initialize(host_list = [], net_ssh_options = {})
       @hosts = host_list
-      @connections = host_list.reduce({}) { |pool, host| pool.merge(host => LazyConnection.new(host)) }
+      @net_ssh_options = net_ssh_options
+      @connections = host_list.reduce({}) do |pool, host|
+        pool.merge(host => LazyConnection.new(host, @net_ssh_options))
+      end
     end
 
     # Run a command over the connection pool. The block is evaluated in the context of LazyConnection.
@@ -82,7 +86,7 @@ module Weave
     # This is the same as #execute, except that host_list overrides the list of connections with which this
     # ConnectionPool was initialized. Any hosts in here that weren't already in the pool will be added.
     def execute_with(host_list, options = {}, &block)
-      host_list.each { |host| @connections[host] ||= LazyConnection.new(host) }
+      host_list.each { |host| @connections[host] ||= LazyConnection.new(host, @net_ssh_options) }
       args = options[:args] || []
       num_threads = options[:num_threads] || DEFAULT_THREAD_POOL_SIZE
       if options[:serial]
@@ -120,9 +124,10 @@ module Weave
     attr_reader :host
 
     # @param [String] host_string the host of the form user@host
-    def initialize(host_string)
+    def initialize(host_string, net_ssh_options = {})
       @user, @host = self.class.user_and_host(host_string)
       @connection = nil
+      @net_ssh_options = net_ssh_options || {}
       @mutex = NilMutex
     end
 
@@ -144,71 +149,47 @@ module Weave
     # command terminated via a signal or with a non-zero exit status. Otherwise (the default), these will
     # cause a `Weave::Error` to be raised.
     #
-    # The option `:timeout`, if provided, specifies the number of seconds to allow the command to execute
-    # before timing it out. If this happens, the output is unchanged (but in most cases, this will be an error
-    # as your process was killed by a signal from the pseudo-tty Weave allocates for it on the remote host).
-    # If the command is timed out, the result hash also has `:timed_out => true` (is is `false` otherwise).
-    #
     # @param [Hash] options the output options
     # @option options [Symbol] :output the output format
-    # @option options [Symbol] :continue_on_failure whether to raise an exception if the command exits with a
-    #     non-zero exit status or because of a signal
-    # @option options[Symbol] :timeout if given, how many seconds to give the command before timing it out
     def run(command, options = {})
       options[:output] ||= :pretty
-      @connection ||= Net::SSH.start(@host, @user)
+      @connection ||= Net::SSH.start(@host, @user, @net_ssh_options)
       result = options[:output] == :capture ? { :stdout => "", :stderr => "" } : {}
-      result[:timed_out] = false
       @connection.open_channel do |channel|
-        channel.request_pty do |ch, success|
-          raise Error, "Error requesting pty" unless success
-          ch.exec(command) do |_, succ|
-            unless succ
-              raise Error, "Could not run ssh command: #{command}"
-            end
+        channel.exec(command) do |_, success|
+          unless success
+            raise Error, "Could not run ssh command: #{command}"
+          end
 
-            ch.on_data do |_, data|
-              append_or_print_output(result, data, :stdout, options)
-            end
+          channel.on_data do |_, data|
+            append_or_print_output(result, data, :stdout, options)
+          end
 
-            ch.on_extended_data do |_, type, data|
-              next unless type == 1
-              append_or_print_output(result, data, :stderr, options)
-            end
+          channel.on_extended_data do |_, type, data|
+            next unless type == 1
+            append_or_print_output(result, data, :stderr, options)
+          end
 
-            ch.on_request("exit-status") do |_, data|
-              code = data.read_long
-              unless code.zero? || options[:continue_on_failure]
-                raise Error, "[#{@host}] command finished with exit status #{code}: #{command}"
-              end
-              result[:exit_code] = code
+          channel.on_request("exit-status") do |_, data|
+            code = data.read_long
+            unless code.zero? || options[:continue_on_failure]
+              raise Error, "[#{@host}] command finished with exit status #{code}: #{command}"
             end
+            result[:exit_code] = code
+          end
 
-            ch.on_request("exit-signal") do |_, data|
-              signal = data.read_long
-              unless options[:continue_on_failure]
-                signal_name = Signal.list.invert[signal]
-                signal_message = signal_name ? "#{signal} (#{signal_name})" : "#{signal}"
-                raise Error, "[#{@host}] command received signal #{signal_message}: #{command}"
-              end
-              result[:exit_signal] = signal
+          channel.on_request("exit-signal") do |_, data|
+            signal = data.read_long
+            unless options[:continue_on_failure]
+              signal_name = Signal.list.invert[signal]
+              signal_message = signal_name ? "#{signal} (#{signal_name})" : "#{signal}"
+              raise Error, "[#{@host}] command received signal #{signal_message}: #{command}"
             end
+            result[:exit_signal] = signal
           end
         end
       end
-      if options[:timeout].nil?
-        @connection.loop(0.05)
-      else
-        begin
-          Timeout.timeout(options[:timeout]) do
-            @connection.loop(0.05)
-          end
-        rescue Timeout::Error
-          @connection.close
-          @connection = nil
-          result[:timed_out] = true
-        end
-      end
+      @connection.loop(0.05)
       result
     end
 

data/weave.gemspec

@@ -1,6 +1,3 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/weave/version', __FILE__)
-
 Gem::Specification.new do |gem|
   gem.authors       = ["Caleb Spare"]
   gem.email         = ["cespare@gmail.com"]
@@ -14,14 +11,14 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "weave"
   gem.require_paths = ["lib"]
-  gem.version       = Weave::VERSION
+  gem.version       = "1.1.0-beta1"
 
-  gem.add_dependency "net-ssh", ">= 2.2.0"
+  gem.add_dependency "net-ssh", "~> 2.9"
 
   # For running integration tests.
-  gem.add_development_dependency "minitest"
-  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest", "~> 5.0"
+  gem.add_development_dependency "rake", "~> 10.0"
   # For generating the docs
-  gem.add_development_dependency "yard"
-  gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "yard", "~> 0.8"
+  gem.add_development_dependency "redcarpet", "~> 3.0"
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: weave
 version: !ruby/object:Gem::Version
-  version: 1.0.2.beta1
+  version: 1.1.0.pre.beta1
 platform: ruby
 authors:
 - Caleb Spare
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Simple parallel ssh.
 email:
 - cespare@gmail.com
@@ -87,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .yardopts
+- ".gitignore"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -97,7 +97,6 @@ files:
 - examples/basic.rb
 - examples/parallel-console.rb
 - lib/weave.rb
-- lib/weave/version.rb
 - test/integrations/sanity_test.rb
 - test/test_helper.rb
 - weave.gemspec
@@ -111,20 +110,21 @@ 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.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple parallel ssh.
 test_files:
 - test/integrations/sanity_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/lib/weave/version.rb

@@ -1,3 +0,0 @@
-module Weave
-  VERSION = "1.0.2.beta1"
-end