net-ssh-stream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3dafb38bc03dc3154a8b6cdc3e83749c55cb81c
+  data.tar.gz: 000f03d12fd7d06e9ce7fd0ae1558ce54aadae12
+SHA512:
+  metadata.gz: 16bcb828394235ede1db6d0aa4dea3070e5cd26da89c410d0b93ca6ba09a9dfa2ca098e562797d94fbdb56fd2c0db6b6e8838a5ad98a596848b9f92ccbbea5bc
+  data.tar.gz: 8d72be8e49fdbb40db7a1ce6dd431512a142b0327219a1dcd3a44b6ae0841c0f6c1478db8c854654fe24c2fc78b61fff7e56478448b86d32b6105c001df185df

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: OkyNsEOdiEYG9PkRoN4kVjpUnwu1MQiOg

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+net-ssh-stream

data/.ruby-version

@@ -0,0 +1 @@
+ruby 2.0.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+before_install:
+  - gem install bundler -v 1.11.2
+  - sudo apt-get -y install openssh-server
+  - ssh-keygen -q -t rsa -N "" -f ~/.ssh/id_rsa
+  - cp $HOME/.ssh/id_rsa.pub $HOME/.ssh/authorized_keys

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in net-ssh-stream.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gabriel Naiman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Net::Ssh::Stream
+
+[![Gem Version](https://badge.fury.io/rb/net-ssh-stream.png)](https://rubygems.org/gems/net-ssh-stream)
+[![Build Status](https://travis-ci.org/gabynaiman/net-ssh-stream.png?branch=master)](https://travis-ci.org/gabynaiman/net-ssh-stream)
+[![Coverage Status](https://coveralls.io/repos/gabynaiman/net-ssh-stream/badge.png?branch=master)](https://coveralls.io/r/gabynaiman/net-ssh-stream?branch=master)
+[![Code Climate](https://codeclimate.com/github/gabynaiman/net-ssh-stream.png)](https://codeclimate.com/github/gabynaiman/net-ssh-stream)
+[![Dependency Status](https://gemnasium.com/gabynaiman/net-ssh-stream.png)](https://gemnasium.com/gabynaiman/net-ssh-stream)
+
+Net::SSH extension for streaming stdout and stderr from remote commnad
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net-ssh-stream'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install net-ssh-stream
+
+## Usage
+
+```ruby
+require 'net/ssh/stream'
+
+stdout = StringIO.new
+stderr = StringIO.new
+
+stream = Net::SSH::Stream.new 'host', 'user', password: 'password'
+
+stream.exec 'ls', stdout: stdout, stderr: stderr
+
+stream.close
+
+# OR
+
+Net::SSH::Stream.start('host', 'user', password: 'password') do |stream|
+  stream.exec 'ls', stdout: stdout, stderr: stderr
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/net-ssh-stream.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+desc 'Console'
+task :console do
+  require 'pry'
+  require 'net/ssh/stream'
+  ARGV.clear
+  Pry.start
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "net/ssh/stream"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/net/ssh/stream.rb

@@ -0,0 +1,57 @@
+require 'net/ssh/stream/version'
+
+require 'net/ssh'
+
+module Net
+  module SSH
+    class Stream
+
+      def initialize(*args)
+        @session ||= Net::SSH.start *args
+      end
+
+      def close
+        if @session && !@session.closed?
+          @session.close
+          @session = nil
+        end
+      end
+
+      def exec(command, stdout: STDOUT, stderr: STDERR)
+        exit_code = nil
+        
+        @session.open_channel do |channel|
+          channel.exec(command) do |ch, success|
+            unless success
+              abort "FAILED: couldn't execute command (ssh.channel.exec)"
+            end
+            
+            channel.on_data do |ch, data|
+              stdout << data
+            end
+
+            channel.on_extended_data do |ch, type, data|
+              stderr << data
+            end
+
+            channel.on_request("exit-status") do |ch, data|
+              exit_code = data.read_long
+            end
+          end
+        end
+
+        @session.loop
+        
+        exit_code
+      end
+
+      def self.start(*args)
+        stream = self.new *args
+        yield stream
+        stream.close
+        nil
+      end
+
+    end
+  end
+end

data/lib/net/ssh/stream/version.rb

@@ -0,0 +1,7 @@
+module Net
+  module Ssh
+    module Stream
+      VERSION = '0.1.0'
+    end
+  end
+end

data/net-ssh-stream.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'net/ssh/stream/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'net-ssh-stream'
+  spec.version       = Net::Ssh::Stream::VERSION
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+  spec.description   = 'Net::SSH extension for streaming stdout and stderr from remote commnad'
+  spec.summary       = 'Net::SSH extension for streaming stdout and stderr from remote commnad'
+  spec.homepage      = 'https://github.com/gabynaiman/net-ssh-stream'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'net-ssh'
+  
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 4.7'
+  spec.add_development_dependency 'turn', '~> 0.9'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry-nav'
+end

data/spec/coverage_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start

data/spec/minitest_helper.rb

@@ -0,0 +1,11 @@
+require 'coverage_helper'
+require 'minitest/autorun'
+require 'turn'
+require 'net/ssh/stream'
+require 'pry-nav'
+
+Turn.config do |c|
+  c.format = :pretty
+  c.natural = true
+  c.ansi = true
+end

data/spec/stream_spec.rb

@@ -0,0 +1,33 @@
+require 'minitest_helper'
+
+describe Net::SSH::Stream do
+
+  let(:username) { `whoami`.strip }
+
+  def exec(command, stdout: STDOUT, stderr: STDERR)
+    exit_status = nil
+    Net::SSH::Stream.start('localhost', username) do |stram|
+      exit_status = stram.exec command, stdout: stdout, stderr: stderr
+    end
+    exit_status
+  end
+  
+  it 'STDOUT' do
+    stdout = StringIO.new
+    exit_status = exec 'pwd', stdout: stdout
+    stdout.rewind
+
+    assert_equal 0, exit_status
+    assert_equal "/home/#{username}", stdout.read.strip
+  end
+
+  it 'STDERR' do
+    stderr = StringIO.new
+    exit_status = exec 'invalid-command', stderr: stderr
+    stderr.rewind
+
+    refute_equal 0, exit_status
+    assert_equal "bash: invalid-command: command not found", stderr.read.strip
+  end
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: net-ssh-stream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: pry-nav
+  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'
+description: Net::SSH extension for streaming stdout and stderr from remote commnad
+email:
+- gabynaiman@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/net/ssh/stream.rb
+- lib/net/ssh/stream/version.rb
+- net-ssh-stream.gemspec
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/stream_spec.rb
+homepage: https://github.com/gabynaiman/net-ssh-stream
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Net::SSH extension for streaming stdout and stderr from remote commnad
+test_files:
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/stream_spec.rb