net-ssh-script 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb9f0d3800fed09a51bdfa21221a3500f179a0ed
+  data.tar.gz: 3486bb5af1fef149961419a81bdcff14369ce940
+SHA512:
+  metadata.gz: c62fd8a78022fb1037bae0cadfeff682b443027d0d6cfea851ea3ccfe8a66c05cd237b611c9ebb315710d358d6be96493ab629afc0444e7c099f8184dce5630d
+  data.tar.gz: 4248d36519e163af1bb1382d91a5018bb91a21d74efeaaff099959bf01b62b5abb913e54dfb27dfefb775a227cea46cd7d7c64c586b0d08571250ad357c5eb16

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+*.swp
+
+coverage
+doc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nuqz
+
+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,128 @@
+# Net::Ssh::Script
+
+Helps to run commands & scripts over Net::SSH session on remote machines.
+It can run a single command and whole script and log status/stdout/stderr of each command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net-ssh-script'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install net-ssh-script
+
+## Usage
+
+First, require module and create SSH session:
+
+```ruby
+require 'net/ssh/script'
+
+Net::SSH.start( '...' ) do |ssh|
+  # insert code below here...
+end
+```
+
+### Single command
+
+```ruby
+# Define a command
+cmd = Net::SSH::Script::Command['ls']
+# it is the same as
+cmd = Net::SSH::Script::Command.new('ls')
+
+cmd.to_s
+# => "ls"
+
+cmd.inspect
+# => "pending:ls"
+
+cmd.done?
+# => false
+
+cmd.status
+# => :pending
+
+cmd.run ssh
+# => true/false
+
+cmd.done?
+# => true
+
+cmd.status
+# => :failed/:error/:ok
+
+cmd.ok?  # => true/false
+cmd.error?  # => true/false
+cmd.failed?  # => true/false
+cmd.pending?  # => true/false
+
+cmd.inspect
+# => multiline string:
+#    ok:ls
+#    Output:
+#    <a list of files>
+
+# when command returns error
+cmd.inspect
+# => multiline string:
+#    error:ls
+#    Error:
+#    <error returned by command>
+```
+
+### Scripts
+
+```ruby
+script = Net::SSH::Script::Script[[
+  'cd /tmp',
+  'ls -l',
+  'cd -'
+]]
+
+script.run ssh
+# => true/false
+
+cmd.running?  # => true/false
+
+script.done?
+# => true/false
+
+script.ok?  # => true/false
+script.error?  # => true/false
+script.failed?  # => true/false
+script.pending?  # => true/false
+
+script.inspect
+# => multiline string:
+#    ok:cd /tmp
+#    Output:
+#    error:ls -l
+#    Error:
+#    'an error of ls -l command'
+#    pending:cd -
+```
+
+## 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/indiesoft/net-ssh-script.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "net/ssh/script"
+
+# 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(__FILE__)

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/script.rb

@@ -0,0 +1,59 @@
+require 'net/ssh/script/version'
+require 'net/ssh/script/command'
+
+module Net
+  module SSH
+    module Script
+      # Net::SSH::Command wrapper to work with multiple commands.
+      class Script
+        def self.[](commands)
+          new commands
+        end
+
+        def initialize(commands)
+          if commands.is_a? String
+            @_commands = [Command[commands]]
+          elsif commands.is_a?(Array) &&
+                commands.all? { |cmd| cmd.is_a? String }
+            @_commands = commands.map { |c| Command[c] }
+          elsif commands.is_a?(Array) &&
+                commands.all? { |cmd| cmd.is_a? Command }
+            @_commands = commands
+          else raise 'Invalid script argument.'
+          end
+        end
+
+        def run(ssh)
+          @_commands.each { |cmd| break unless cmd.run(ssh) }
+          ok?
+        end
+
+        def done?
+          @_commands.all?(&:done?)
+        end
+
+        def status
+          return :pending if @_commands.all?(&:pending?)
+          return :failed if @_commands.any?(&:failed?)
+          return :error if @_commands.any?(&:error?)
+          return :running unless done?
+          :ok
+        end
+
+        def to_s
+          @_commands.map(&:to_s).join "\n"
+        end
+
+        def inspect
+          @_commands.map(&:inspect).join "\n"
+        end
+
+        [:pending?, :running?, :failed?, :error?, :ok?].each do |helper|
+          define_method helper do
+            status == helper.to_s.sub('?', '').to_sym
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/script/command.rb

@@ -0,0 +1,90 @@
+require 'net/ssh'
+
+module Net
+  module SSH
+    module Script
+      # Net::SSH::Connection::Session wrapper to capture
+      # status/stdout/stderr produced by a command.
+      class Command
+        attr_reader :output, :error
+
+        def self.[](command)
+          new command
+        end
+
+        def initialize(command_string)
+          @_cmd = command_string
+          @_done = @_success = false
+          @output = @error = ''
+        end
+
+        def run(ssh)
+          channel = ssh.open_channel do |ch|
+            # In case when we want rerun a command
+            @_done = @_success = false
+            exec_command @_cmd, ch
+          end
+
+          channel.wait
+
+          ok?
+        end
+
+        def done?
+          @_done
+        end
+
+        def inspect
+          case status
+          when :ok
+            "#{status}: #{@_cmd}\nOutput:\n#{@output}\n"
+          when :error
+            "#{status}: #{@_cmd}\nError:\n#{@error}\n"
+          else
+            "#{status}: #{@_cmd}"
+          end
+        end
+
+        def status
+          return :pending unless done?
+          return :failed unless @_success
+          return :error unless @error.empty?
+          :ok
+        end
+
+        def to_s
+          @_cmd
+        end
+
+        [:pending?, :failed?, :error?, :ok?].each do |helper|
+          define_method helper do
+            status == helper.to_s.sub('?', '').to_sym
+          end
+        end
+
+        private
+
+        def listen_channel(chan)
+          chan.on_close { @_done = true }
+          chan.on_data { |_, data| @output << data }
+          chan.on_extended_data do |_, type, data|
+            @error << "(#{type}):#{data}\n"
+          end
+        end
+
+        def exec_command(command, chan)
+          chan.exec command do |ch, success|
+            @_success = success
+
+            unless success
+              @_done = true
+              return false
+            end
+
+            listen_channel ch
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Net
+  module SSH
+    module Script
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/net-ssh-script.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'net/ssh/script/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "net-ssh-script"
+  spec.version       = Net::SSH::Script::VERSION
+  spec.authors       = ["Nuqz"]
+  spec.email         = ["nuqz@indiesoft.ru"]
+
+  spec.summary       = %q{Helps to run commands & scripts over Net::SSH session on remote machines.}
+  spec.description   = %q{It can run a single command and whole script and log status/stdout/stderr of each command.}
+  spec.homepage      = "https://github.com/indiesoft/net-ssh-script"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'net-ssh', '~> 4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: net-ssh-script
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nuqz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: yard
+  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: 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: rubocop
+  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: It can run a single command and whole script and log status/stdout/stderr
+  of each command.
+email:
+- nuqz@indiesoft.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/net/ssh/script.rb
+- lib/net/ssh/script/command.rb
+- lib/net/ssh/script/version.rb
+- net-ssh-script.gemspec
+homepage: https://github.com/indiesoft/net-ssh-script
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Helps to run commands & scripts over Net::SSH session on remote machines.
+test_files: []