nutshell 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.0.1 / 2012-07-18
+
+* Bugfixes:
+
+  * Update homepage
+
 === 1.0.0 / 2010-09-28
  
 * 1 major enhancement

data/README.txt

@@ -1,6 +1,6 @@
 = Nutshell
 
-* http://github.com/yaksnrainbows/nutshell
+* http://yaks.me/nutshell
 
 == DESCRIPTION:
 
@@ -43,7 +43,7 @@ A light weight ssh client that wraps the ssh and rsync commands.
 
 * highline gem
 
-* Unix based OS
+* Unix based OS with ssh and rsync
 
 == INSTALL:
 
@@ -53,7 +53,7 @@ A light weight ssh client that wraps the ssh and rsync commands.
 
 (The MIT License)
 
-Copyright (c) 2010 FIX
+Copyright (c) 2010 Jeremie Castagna
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -39,6 +39,7 @@ Hoe.spec 'nutshell' do |p|
   developer('Jeremie Castagna', 'yaksnrainbows@gmail.com')
   self.extra_deps << ['open4',    '>= 1.0.1']
   self.extra_deps << ['highline', '>= 1.5.1']
+  self.extra_deps << ['ruby-termios', '>= 0.9.6']
 end
 
 # vim: syntax=Ruby

data/lib/nutshell.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'open4'
 require 'highline'
+require 'termios'
 
 require 'fileutils'
 require 'tmpdir'
@@ -8,7 +9,7 @@ require 'tmpdir'
 
 module Nutshell
 
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 
   ##
   # Temp directory used by various nutshell classes
@@ -21,22 +22,48 @@ module Nutshell
   class CmdError < Exception; end
   class ConnectionError < Exception; end
 
+  DEFAULT_CONFIG = {
+    :timeout => 300,
+    :interactive => true,
+    :tty_state_freq => 0.1
+  }
+
+  ##
+  # Set the config.
 
   def self.config
-    @config ||= {}
+    @config ||= DEFAULT_CONFIG.dup
   end
 
 
+  ##
+  # How long to wait with no data coming in before timing out.
+  # Reads config[:timeout].
+
   def self.timeout
     config[:timeout]
   end
 
 
+  ##
+  # Defines if process should fail when user interaction is required.
+  # Defaults to true. Reads config[:interactive].
+
   def self.interactive?
     config[:interactive]
   end
 
 
+  ##
+  # How often to check the state of the tty in seconds.
+  # Used for detecting prompts.
+  # Defaults to 0.1. Reads config[:tty_state_freq].
+
+  def self.tty_state_freq
+    config[:tty_state_freq]
+  end
+
+
   require 'nutshell/shell'
   require 'nutshell/remote_shell'
 end

data/lib/nutshell/remote_shell.rb

@@ -60,7 +60,7 @@ module Nutshell
 
       @user ||= options[:user]
 
-      @rsync_flags = ["-azP"]
+      @rsync_flags = ["-azrP"]
       @rsync_flags.concat [*options[:rsync_flags]] if options[:rsync_flags]
 
       @ssh_flags = [
@@ -107,7 +107,7 @@ module Nutshell
         raise TimeoutError if timed_out?(start_time, LOGIN_TIMEOUT)
       end
 
-      unless connected?
+      unless ready && connected?
         disconnect
         host_info = [@user, @host].compact.join("@")
         raise ConnectionError, "Can't connect to #{host_info}"
@@ -165,7 +165,7 @@ module Nutshell
     # Checks if the given file exists
 
     def file? filepath
-      syscall "test -f #{filepath}"
+      self.system "test -f #{filepath}"
     end
 
 

data/lib/nutshell/shell.rb

@@ -10,8 +10,22 @@ module Nutshell
     LOCAL_USER = `whoami`.chomp
     LOCAL_HOST = `hostname`.chomp
 
-    SUDO_FAILED = /^Sorry, try again./
-    SUDO_PROMPT = /^Password:/
+
+    class << self
+      # The message to match in stderr to determine logging in has failed.
+      # Defaults to:
+      #   /^Sorry, try again./
+      attr_accessor :sudo_failed_matcher
+
+      # The message to match in stderr to determine a password is required.
+      # Defaults to:
+      #   /^Password:/
+      attr_accessor :sudo_prompt_matcher
+    end
+
+    self.sudo_failed_matcher = /^Sorry, try again./
+    self.sudo_prompt_matcher = /^Password:/
+
 
     attr_reader :user, :host, :password, :input, :output, :mutex
     attr_accessor :env, :sudo, :timeout
@@ -69,6 +83,14 @@ module Nutshell
     end
 
 
+    ##
+    # Prompt the user to make a choice.
+
+    def choose(&block)
+      sync{ @input.choose(&block) }
+    end
+
+
     ##
     # Close the output IO. (Required by the Logger class)
 
@@ -206,7 +228,7 @@ module Nutshell
     # Build an sh -c command
 
     def sh_cmd cmd
-      ["sh", "-c", quote_cmd(cmd)]
+      ["sh", "-i", "-c", quote_cmd(cmd)]
     end
 
 
@@ -258,7 +280,7 @@ module Nutshell
     ##
     # Returns true if command was run successfully, otherwise returns false.
 
-    def syscall cmd, options=nil
+    def system cmd, options=nil
       call(cmd, options) && true rescue false
     end
 
@@ -339,6 +361,8 @@ module Nutshell
       inn.sync = true
       log_methods = {out => :debug, err => :error}
 
+      status = nil
+
       result, status = process_streams(pid, out, err) do |stream, data|
         stream_name = :out if stream == out
         stream_name = :err if stream == err
@@ -352,9 +376,7 @@ module Nutshell
 
 
         if password_required?(stream_name, data) then
-
           kill_process(pid) unless Nutshell.interactive?
-
           send_password_to_stream(inn, data)
         end
       end
@@ -379,12 +401,12 @@ module Nutshell
 
 
     def password_required? stream_name, data
-      stream_name == :err && data =~ SUDO_PROMPT
+      stream_name == :err && data =~ Shell.sudo_prompt_matcher
     end
 
 
     def send_password_to_stream inn, data
-      prompt_for_password if data =~ SUDO_FAILED
+      prompt_for_password if data =~ Shell.sudo_failed_matcher
       inn.puts @password || prompt_for_password
     end
 

data/test/test_helper.rb

@@ -80,7 +80,7 @@ def assert_rsync from, to, ds=@remote_shell, sudo=false
     "--rsync-path='#{ path }' "
   end
 
-  rsync_cmd = "rsync -azP #{rsync_path}-e \"ssh #{ds.ssh_flags.join(' ')}\""
+  rsync_cmd = "rsync -azrP #{rsync_path}-e \"ssh #{ds.ssh_flags.join(' ')}\""
 
   error_msg = "No such command in remote_shell log [#{ds.host}]\n#{rsync_cmd}"
   error_msg << "#{from.inspect} #{to.inspect}"

data/test/test_shell.rb

@@ -24,13 +24,13 @@ class TestShell < Test::Unit::TestCase
 
   def test_ask
     @shell.ask "input something!"
-    assert 1, @shell.input.method_call_count(:ask)
+    assert_equal 1, @shell.input.method_call_count(:ask)
   end
 
 
   def test_close
     @shell.close
-    assert 1, @shell.output.method_call_count(:close)
+    assert_equal 1, @shell.output.method_call_count(:close)
   end
 
 

metadata

@@ -1,76 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nutshell
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jeremie Castagna
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-09-28 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: open4
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 1
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
   name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: ruby-termios
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 3
-        version: 2.3.3
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A light weight ssh client that wraps the ssh and rsync commands.
-email: 
+email:
 - yaksnrainbows@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
-files: 
+files:
 - History.txt
 - Manifest.txt
 - README.txt
@@ -83,38 +113,34 @@ files:
 - test/test_helper.rb
 - test/test_remote_shell.rb
 - test/test_shell.rb
-has_rdoc: true
-homepage: http://github.com/yaksnrainbows/nutshell
+- .gemtest
+homepage: http://yaks.me/nutshell
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: nutshell
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A light weight ssh client that wraps the ssh and rsync commands.
-test_files: 
+test_files:
 - test/test_helper.rb
 - test/test_remote_shell.rb
 - test/test_shell.rb