ssh_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7a5615e37ffe71d7c3ccb86b4013a7639458d1f
+  data.tar.gz: 299d9e6e3d6d9426d44aca8b20c3c1daa78cdb32
+SHA512:
+  metadata.gz: 721f31b7f5867280b098cf68a567a6c660ca25cb2501f35c946b15832258e162e4a49c358a914d00dbf59a56e4f10527da2679cfb45d716a72d7acf508ec8466
+  data.tar.gz: c18857031758e52688bf1847dd42ca664ca5ad6413b362572d83d55d8ac70c54cdb4d959b6d7d10f31bd756ae35e29d0d0fb65d0daa6c8c8abb569259dd184f6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.3.0
+before_install: 
+  - ssh-keygen -f $HOME/.ssh/id_rsa -N ''
+  - cat $HOME/.ssh/id_rsa.pub >> $HOME/.ssh/authorized_keys
+  - gem install bundler
+addons:
+  ssh_known_hosts:
+    - localhost

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at key@kosmatov.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ssh_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Konstantin Kosmatov
+
+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,110 @@
+# SSHClient
+
+[![Build Status](https://travis-ci.org/kosmatov/ssh_client.svg?branch=master)](https://travis-ci.org/kosmatov/ssh_client)
+[![Coverage Status](https://coveralls.io/repos/github/kosmatov/ssh_client/badge.svg?branch=master)](https://coveralls.io/github/kosmatov/ssh_client?branch=master)
+
+Ruby SSH client for servers without `exec` requests support
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ssh_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ssh_client
+
+## Usage
+
+### Configure client
+
+```ruby
+
+# Default config
+SSHClient.configure do |conf|
+  conf.hostname = 'example.com'
+  conf.username = 'sample'
+  conf.password = 'sample'
+  conf.logger = Logger.new('log/my.log') # default log to STDOUT
+  conf.read_timeout = 0.5 # default 0.3
+  conf.raise_on_errors = true # raise exception if command write to STDERR
+end
+
+# Custom config
+SSHClient.configure(:custom) do |conf|
+  conf.hostname = '127.0.0.1'
+end
+```
+
+### Execute commands
+
+Using connection instance
+
+```ruby
+connection = SSHClient.connect
+
+listener = connection.add_listener(:stdout) do |data|
+  puts data
+end
+
+connection.exec 'hostname'
+connection.remove_listener(listener)
+connection.close
+```
+
+Using connection with custom config
+
+```ruby
+connection = SSHClient.connect :custom
+```
+
+Pass hostname, username and password to connection
+
+```ruby
+connection = SSHClient.connect hostname: 'example.com', username: 'sample', password: 'sample'
+```
+
+Multiply commands run with block. Connection closed after block execution
+
+```ruby
+SSHClient.connect do
+  run 'hostname'
+  run 'uname -a'
+  run 'cat /proc/cpuinfo | grep model'
+end
+```
+
+Run command and return output
+
+```ruby
+output = connection.exec! 'hostname'
+
+output = connection.exec! do
+  run 'hostname'
+  run 'uname -a'
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/ssh_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ssh_client"
+require "pry"
+
+SSHClient.configure do |conf|
+  conf.hostname = ENV['SSHHOST'] || 'localhost'
+  conf.username = ENV['SSHUSER']
+  conf.password = ENV['SSHPASS']
+  conf.read_timeout = 0.3
+  conf.debug = true
+end
+
+SSHClient.config.logger = Logger.new "log/development.log"
+
+def ssh
+  @ssh ||= SSHClient.connect
+end
+
+Pry.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/ssh_client/command_builder.rb

@@ -0,0 +1,40 @@
+module SSHClient
+  class CommandBuilder
+    SEPARATOR = ' '.freeze
+
+    def initialize(&blk)
+      @paths = []
+      @context = eval 'self', blk.binding
+      instance_eval(&blk)
+    end
+
+    def to_a
+      @paths
+    end
+
+    def run(*args)
+      @paths << to_path(*args)
+    end
+
+    private
+
+    def method_missing(*args)
+      return @context.send(*args) if @context.respond_to?(args.first, true)
+      name = args.shift
+      value = to_path args.map { |a| to_path a }
+      @paths.pop if @paths.last == value
+      @paths << to_path(name, value)
+      @paths.last
+    end
+
+    def /(path)
+      "/#{path}"
+    end
+
+    def to_path(*args)
+      val = args.is_a?(Hash) ? args.to_a : args
+      Array(val).flatten.compact.join SEPARATOR
+    end
+
+  end
+end

data/lib/ssh_client/config_item.rb

@@ -0,0 +1,76 @@
+require 'logger'
+
+module SSHClient
+  class ConfigItem
+    DEFAULT_NAME = :default
+    READ_TIMEOUT = 0.5
+
+    attr_accessor :hostname, :username, :password
+    attr_reader :name
+    attr_writer :read_timeout, :logger, :transport, :debug
+
+    def initialize(name = nil)
+      @name = name || DEFAULT_NAME
+      @listeners = { stdout: Set.new, stderr: Set.new }
+
+      add_listener(:logger) { |data| logger.info "<< #{data}" } if default?
+    end
+
+    def listeners
+      @cached_listeners ||= if default?
+        @listeners
+      else
+        @listeners.each { |k, l| l += SSHClient.config.listeners[k] }
+      end
+    end
+
+    def add_listener(name, io_type = nil, &blk)
+      Array(io_type || @listeners.keys).each do |k|
+        @listeners[k] << blk
+      end
+      @cached_listeners = nil
+      blk
+    end
+
+    def remove_listener(listener, io_type = nil)
+      Array(io_type || @listeners.keys).each do |k|
+        @listeners[k].delete listener
+      end
+      @cached_listeners = nil
+    end
+
+    def read_timeout
+      @read_timeout || (default? ? READ_TIMEOUT : SSHClient.config.read_timeout)
+    end
+
+    def transport
+      transport_klass.new self
+    end
+
+    def transport_klass
+      @transport || (default? ? Transport::NetSSH : SSHClient.config.transport_klass)
+    end
+
+    def raise_on_errors=(value)
+      if value
+        add_listener(:raise_on_errors, :stderr) do |data|
+          Thread.main.raise CommandExitWithError.new(data) if data
+        end
+      else
+        remove_listener(:raise_on_errors, :stderr)
+      end
+    end
+
+    def logger
+      @logger || (default? ? Logger.new(STDOUT) : SSHClient.config.logger)
+    end
+
+    def debug?
+      @debug || (default? ? false : SSHClient.config.debug?)
+    end
+
+    def default?
+      name == DEFAULT_NAME
+    end
+  end
+end

data/lib/ssh_client/connection.rb

@@ -0,0 +1,48 @@
+require 'forwardable'
+
+module SSHClient
+  class Connection
+    extend Forwardable
+    def_delegators :transport, :open, :close, :closed?
+    def_delegators :config, :add_listener, :remove_listener
+
+    attr_reader :config, :transport
+
+    def initialize(config_name = nil, hostname: nil, username: nil, password: nil, &blk)
+      build_config hostname, username, password if hostname
+      @config ||= SSHClient.config config_name
+      @transport = config.transport
+
+      open
+      batch_exec(&blk) if block_given?
+
+      ObjectSpace.define_finalizer(self) { transport.close }
+    end
+
+    def build_config(hostname, username, password)
+      @config ||= SSHClient.configure(hostname) do |conf|
+        conf.hostname = hostname
+        conf.username = username
+        conf.password = password
+      end
+    end
+
+    def exec(command, close: false)
+      config.logger.info ">> #{command}"
+      transport.send_message command, close: close
+    end
+
+    def exec!(command = nil, &blk)
+      buffer = String.new
+      listener = add_listener(:stdout) { |data| buffer << data }
+      block_given? ? batch_exec(&blk) : exec(command, close: true)
+      remove_listener listener
+      buffer
+    end
+
+    def batch_exec(&blk)
+      exec CommandBuilder.new(&blk).to_a.join("\n"), close: true
+    end
+
+  end
+end

data/lib/ssh_client/transport/base.rb

@@ -0,0 +1,15 @@
+module SSHClient
+  module Transport
+    class Base
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def handle_listeners(io_type, data)
+        config.listeners[io_type].each { |l| l.call data }
+      end
+    end
+  end
+end

data/lib/ssh_client/transport/net_ssh.rb

@@ -0,0 +1,50 @@
+require 'net/ssh'
+require_relative 'base'
+
+module SSHClient
+  module Transport
+    class NetSSH < Base
+      attr_reader :ssh
+
+      def send_message(command, close: false)
+        open if closed?
+        last_read_time = nil
+
+        ssh.open_channel do |channel|
+          channel.send_channel_request 'shell' do |ch, success|
+            channel.on_data do |c, data|
+              handle_listeners :stdout, data
+              last_read_time = Time.now
+            end
+
+            channel.on_extended_data do |c, data|
+              handle_listeners :stderr, data
+            end
+
+            channel.send_data "#{command}\n"
+          end
+        end
+
+        ssh.loop(0.1) do
+          read_timeout = Time.now - last_read_time if last_read_time
+          ssh.busy? && (!read_timeout || read_timeout < config.read_timeout)
+        end
+
+        ssh.close if close
+      end
+
+      def open
+        @ssh = Net::SSH.start config.hostname, config.username,
+          password: config.password, logger: config.debug? && config.logger
+      end
+
+      def closed?
+        ssh.nil? || ssh.closed?
+      end
+
+      def close
+        @ssh.close if !closed?
+      end
+    end
+  end
+end

data/lib/ssh_client/version.rb

@@ -0,0 +1,3 @@
+module SSHClient
+  VERSION = "0.1.0"
+end

data/lib/ssh_client.rb

@@ -0,0 +1,27 @@
+require 'ssh_client/version'
+
+module SSHClient
+  autoload 'ConfigItem', 'ssh_client/config_item'
+  autoload 'Connection', 'ssh_client/connection'
+  autoload 'CommandBuilder', 'ssh_client/command_builder'
+  autoload 'Transport', 'ssh_client/transport/net_ssh'
+
+  CommandExitWithError = Class.new(StandardError)
+
+  def self.configure(name = nil)
+    yield config(name)
+  end
+
+  def self.config(name = nil)
+    @configurations ||= Hash.new
+    @configurations[name] ||= ConfigItem.new name
+  end
+
+  def self.connect(*args, &blk)
+    @current_connection = Connection.new(*args, &blk)
+  end
+
+  def self.close
+    @current_connection.close
+  end
+end

data/ssh_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ssh_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ssh_client"
+  spec.version       = SSHClient::VERSION
+  spec.authors       = ["Konstantin Kosmatov"]
+  spec.email         = ["key@kosmatov.ru"]
+
+  spec.summary       = %q{Ruby SSH client}
+  spec.description   = %q{Ruby SSH client using Open3 and OpenSSH to interact with any remote shell}
+  spec.homepage      = "https://github.com/kosmatov/ssh_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'net-ssh'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "coveralls", "~> 0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ssh_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Konstantin Kosmatov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-31 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: coveralls
+  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: Ruby SSH client using Open3 and OpenSSH to interact with any remote shell
+email:
+- key@kosmatov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ssh_client.rb
+- lib/ssh_client/command_builder.rb
+- lib/ssh_client/config_item.rb
+- lib/ssh_client/connection.rb
+- lib/ssh_client/transport/base.rb
+- lib/ssh_client/transport/net_ssh.rb
+- lib/ssh_client/version.rb
+- log/.gitkeep
+- ssh_client.gemspec
+homepage: https://github.com/kosmatov/ssh_client
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby SSH client
+test_files: []