Chee 0.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+coverage
+rdoc
+.yardoc

data/Chee.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "Chee/version"
+
+Gem::Specification.new do |s|
+  s.name        = "Chee"
+  s.version     = Chee::VERSION
+  s.authors     = ["da99"]
+  s.email       = ["i-hate-spam-45671204@mailinator.com"]
+  s.homepage    = "https://github.com/da99/Chee"
+  s.summary     = %q{Interact with a SSH session using tty and STDIN.}
+  s.description = %q{
+    Send commands through SSH, but using a tty/pty and STDIN.
+    That's right: Interactive SSH sessions. **Note:** Programs that
+    redraw the screen (e.g. vim) don't work that well. Apt-get and 
+    other programs that request input in a simple manner should work well enough.
+  }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'bacon'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'Bacon_Colored'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'mocha-on-bacon'
+  
+  # Specify any dependencies here; for example:
+  s.add_runtime_dependency 'Get_Set'
+  s.add_runtime_dependency 'net-ssh'
+  s.add_runtime_dependency 'net-scp'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in Bob.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+
+Chee
+================
+
+Send commands through SSH, but using a tty/pty and STDIN.
+That's right: Interactive SSH sessions. 
+
+Limitations
+-----------
+
+* Programs that redraw the screen (e.g. vim) don't work that well. 
+Apt-get and 
+other programs that request input in a simple manner should work well enough.
+
+* PTY (psuedo-terminal) is used. Which means it runs in a sub-shell. 
+Which leads to *no* STDERR access. All output is done on STDOUT.
+
+Installation
+------------
+
+    gem install Chee
+
+Usage
+------
+
+    require "Chee"
+    
+    Chee.server "my_server"  # If you configured server using ~/.ssh/config
+    Chee.server Hash[
+      :ip       => 'localhost', 
+      :user     => 'me', 
+      
+      # options other than :ip/:user are sent to Net::SSH
+      :password => "try to use private/public keys", 
+      :timeout  => 3  
+    ]
+    Chee.ssh %^ sudo add-apt-repository ppa:nginx/stable ^
+<!-- sudo apt-get install nginx -->
+<!-- ^ -->
+
+Or you could include the DSL into your own object:
+
+    Class My_SSH
+
+      include Chee::DSL
+
+      def ssh cmd
+        super cmd.strip
+      end
+
+    end # === Class My_SSH
+
+Run Tests
+---------
+
+To run the tests:
+
+    git clone git@github.com:da99/Chee.git
+    cd Chee
+    bundle update
+    bundle exec bacon spec/main.rb
+    
+Don't forget to setup ssh server, firewall, and passwordless SSH using
+private keys. The following is useful for Ubuntu users:
+
+    sudo apt-get install ufw openssh-server
+    sudo ufw allow from 127.0.0.1 to any port 22
+    sudo ufw deny ssh
+    sudo ufw default deny
+    sudo ufw enable
+
+* [UFW: Firewall](https://help.ubuntu.com/community/UFW)
+* Common UFW rules: [http://blog.bodhizazen.net/linux/firewall-ubuntu-desktops/](http://blog.bodhizazen.net/linux/firewall-ubuntu-desktops/)
+* [~/.ssh/config and private keys](http://www.cyberciti.biz/faq/force-ssh-client-to-use-given-private-key-identity-file/)
+
+"I hate writing."
+-----------------------------
+
+If you know of existing software that makes the above redundant,
+please tell me. The last thing I want to do is maintain code.
+

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "bundler/gem_tasks"

data/lib/Chee.rb

@@ -0,0 +1,165 @@
+require 'Chee/version'
+require 'Get_Set'
+require 'net/ssh'
+require 'net/scp'
+require 'readline'
+
+class Chee
+  
+  Result = Class.new {
+    include Get_Set::DSL
+    attr_get_set :exit_status, :out, :err
+  }
+  
+  Exit_Error = Class.new(RuntimeError) {
+    include Get_Set::DSL
+    attr_get_set :exit_status, :out, :err
+  }
+  
+  module DSL
+
+    def server *args
+      return @server if args.empty?
+      @server = args
+    end
+
+    # 
+    # Thread technique came from: 
+    # http://stackoverflow.com/questions/6942279/ruby-net-ssh-channel-dies
+    # 
+    def ssh command
+      stdout = ""
+      stderr = ""
+      t      = nil # used to store a Thread
+
+      ip, user, new_opts = *server
+      opts = {:timeout=>3}.merge(new_opts || {})
+
+      begin
+
+        get_input = true
+        @channel  = nil
+        cmd       = ''
+        prev_cmd  = ''
+        prev_data = ''
+        result    = Result.new
+
+        t = Thread.new { 
+
+          while get_input do
+
+            cmd = begin
+                    Readline.readline("", true).strip
+                  rescue Interrupt => e # Send CTRL-C:
+                    get_input = false
+                    "^C"
+                  end
+
+            if @channel
+              @channel.process
+            else
+              print "Connection closed. Could not send: #{cmd}\n"
+            end
+
+          end 
+
+        }
+
+        Net::SSH.start(ip, user, opts) { |ssh|
+
+          @channel = ssh.open_channel do |ch1|
+
+            ch1.on_extended_data do |ch, type, d|
+              stderr << d
+            end
+
+            ch1.on_request 'exit-status' do |ch, d|
+              result.exit_status d.read_long
+            end
+
+            ch1.on_open_failed { |ch, code, desc|
+              stderr << "Failure to open channel: #{code.inspect}: #{desc}"
+            }
+
+            ch1.on_process do |ch|
+              if cmd.strip == '^C'
+                #ch.close
+                ch.send_data( Net::SSH::Buffer.from(:byte, 3, :raw, "\n").to_s )
+                stderr << "User requested interrupt."
+              else
+                if cmd.strip.empty?
+                  # ignore it
+                else
+                  ch.send_data( "#{cmd}\n" ) 
+                  prev_cmd = cmd
+                  cmd = ''
+                end
+              end
+            end
+
+            ch1.on_data do |ch, d|
+
+              stdout << d # .sub(%r!\r?\n\Z!,'')
+
+              unless prev_cmd.to_s.strip == d.strip
+                print d
+                STDOUT.flush
+              end
+
+              prev_data = d
+            end
+
+            ch1.request_pty do |ch, success|
+              if success
+                # do nothing
+              else
+                ch.close
+                (stderr << "Unknown error requesting pty.") 
+              end
+            end
+
+            ch1.exec(command)
+
+          end
+
+          ssh.loop 0.1
+        } # === Net::SSH.start
+
+      rescue Timeout::Error  => e
+        raise e.class, server.inspect
+
+      rescue Net::SSH::AuthenticationFailed => e
+        raise e.class, "Using: #{server.inspect}"
+
+        #rescue Net::SSH::HostKeyMismatch => e
+        #  if e.message[%r!fingerprint .+ does not match for!]
+        #    print "Try this", "ssh-keygen -f \"~/.ssh/known_hosts\" -R #{server[:ip]}\n"
+        #    raise Retry_Command, "Removed the RSA key."
+        #  end
+        #  
+        #  raise e
+      ensure
+        get_input = false
+        t.exit if t
+      end
+
+      result.err stderr
+      result.out stdout
+      
+      if !result.err.empty? || result.exit_status != 0
+        e = Exit_Error.new("Exit: #{result.exit_status}, STDERR: #{result.err}")
+        e.exit_status result.exit_status
+        e.out         result.out
+        e.err         result.err
+        raise e
+      end
+
+      result.out.strip!
+      result
+    end
+
+  end # === module DSL
+
+  extend DSL
+
+end # === class Chee

data/lib/Chee/version.rb

@@ -0,0 +1,3 @@
+class Chee
+  VERSION = "0.1.0"
+end

data/spec/files/errors_with_exit_0.rb

@@ -0,0 +1,6 @@
+
+STDERR.puts "err msg 1"
+STDERR.puts "err msg 2"
+exit 0
+
+

data/spec/files/exit_with_2.rb

@@ -0,0 +1,2 @@
+puts "Exiting"
+exit 2

data/spec/helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.print e.message, "\n"
+  $stderr.print "Run `bundle install` to install missing gems\n"
+  exit e.status_code
+end
+require 'bacon'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+Bacon.summary_on_exit

data/spec/main.rb

@@ -0,0 +1,16 @@
+
+require File.expand_path('spec/helper')
+require 'Chee'
+require 'Bacon_Colored'
+require 'pry'
+require 'mocha-on-bacon'
+
+
+# ======== Include the tests.
+if ARGV.size > 1 && ARGV[1, ARGV.size - 1].detect { |a| File.exists?(a) }
+  # Do nothing. Bacon grabs the file.
+else
+  Dir.glob('spec/tests/*.rb').each { |file|
+    require File.expand_path(file.sub('.rb', '')) if File.file?(file)
+  }
+end

data/spec/tests/Chee.rb

@@ -0,0 +1,84 @@
+
+describe ":ssh_exec" do
+  
+  before do
+    @localhost = 'localhost'    
+    
+    @wrong_ip = Hash[
+      :ip=> 'localhosts',
+      :user=>`whoami`.strip
+    ]
+    
+    Chee.server @localhost
+  end
+  
+  it 'accepts a String for the server info.' do
+    Chee.server "localhost"
+    Chee.ssh("echo 'a'").out.should == "a"
+  end
+
+  it 'accepts a Hash for the server info.' do
+    Chee.server 'localhost', `whoami`.strip, :password=>nil
+    Chee.ssh("echo 'b'").out.should == 'b'
+  end
+
+  it 'uses a PTY' do
+    Chee.ssh("tty").out.should.match %r!/dev/pts/\d+!
+  end
+  
+  it 'returns a SSH::Results' do
+    Chee.ssh("hostname").should.be.is_a Chee::Result
+  end
+  
+  it "strips returned data" do
+    target = `uptime`.strip.gsub(%r!\d+!, '[0-9]{1,2}')
+    Chee.ssh("uptime").out.should.match %r!#{target}!
+  end
+  
+  it 'raises Net::SSH::AuthenticationFailed if login/password are incorrect' do
+    lambda {
+      Chee.server "github.com"
+      Chee.ssh "hostname"
+    }.should.raise(Net::SSH::AuthenticationFailed)
+    .message.should.match %r!Using: ..github.com..!
+
+  end
+
+  it 'raises Chee::Exit_Error if return status is not zero' do
+    e = lambda {
+      Chee.ssh "HOSTNAMES"
+    }.should.raise(Chee::Exit_Error)
+
+    e.exit_status.should == 127
+  end
+
+end # === describe :ssh_exec
+
+__END__
+describe ":ssh_exits" do
+  
+  it 'captures exits based on key => int, val => Regexp' do
+    lambda {
+      ignore_exits("cat something.txt", 1=>%r!something\.txt\: No such file or directory!)
+    }.should.not.raise
+  end
+  
+  it 'captures exits based on key => int, val => String' do
+    lambda {
+      ignore_exits("cat something.txt", 1=>'something.txt: No such file or directory') 
+    }.should.not.raise
+  end
+  
+  it 'returns SSH::Results for a non-zero exit status' do
+    ignore_exits("cat something.txt", 1=>'something.txt: No such file or directory')
+    .should.be.is_a Unified_IO::Remote::SSH::Results
+  end
+  
+  it 'returns SSH::Results for a zero exit status' do
+    ignore_exits("uptime", 1=>'something.txt: No such file or directory')
+    .should.be.is_a Unified_IO::Remote::SSH::Results
+  end
+  
+end # === describe :ssh_exits
+  
+

data/spec/tests/bin.rb

@@ -0,0 +1,13 @@
+
+bins = Dir.glob("bin/*")
+
+unless bins.empty?
+  describe "permissions of bin/" do
+    bins.each { |file|
+      it "should chmod 755 for: #{file}" do
+        `stat -c %a #{file}`.strip
+        .should.be == "755"
+      end
+    }
+  end # === permissions of bin/
+end # === unless bins.empty?

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: Chee
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- da99
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: Bacon_Colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha-on-bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: Get_Set
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "\n    Send commands through SSH, but using a tty/pty and STDIN.\n
+  \   That's right: Interactive SSH sessions. **Note:** Programs that\n    redraw
+  the screen (e.g. vim) don't work that well. Apt-get and \n    other programs that
+  request input in a simple manner should work well enough.\n  "
+email:
+- i-hate-spam-45671204@mailinator.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Chee.gemspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/Chee.rb
+- lib/Chee/version.rb
+- spec/files/errors_with_exit_0.rb
+- spec/files/exit_with_2.rb
+- spec/helper.rb
+- spec/main.rb
+- spec/tests/Chee.rb
+- spec/tests/bin.rb
+homepage: https://github.com/da99/Chee
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Interact with a SSH session using tty and STDIN.
+test_files: []