sshkit-interactive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2908a10617b2c1d702b525f2540b89aaf9e6d6d3
+  data.tar.gz: 97199152d548f65b98d6658044e56f52f7ffc4ff
+SHA512:
+  metadata.gz: cb3dbb43f59ee5a5b41fce160adb41a77754265ca938c9fd5960a1f1082f86e0a2ea6d1bb99568cfcdba4cf4571a45b3e87b01e1352349e2a6225ee37c383802
+  data.tar.gz: 4590d048ab511003cb780828173e4a79d13b501c65f66099897f914ae9f9a2e3112353b145c4c8b7f7ebaaf67dce2e693792baa6e74554a5810453f59247960b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Aidan Feldman
+
+MIT License
+
+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,61 @@
+# SSHKit::Interactive
+
+An [SSHKit](https://github.com/capistrano/sshkit) [backend](https://github.com/capistrano/sshkit/tree/master/test/unit/backends) that allows you to execute interactive commands on your servers. Remote commands that you might want to use this for:
+
+* A Rails console
+* A text editor
+* `less`
+* *etc.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sshkit-interactive'
+```
+
+And then execute:
+
+    $ bundle
+
+If you're using [Capistrano](http://capistranorb.com/), add the following to your Capfile:
+
+```ruby
+require 'sshkit/interactive'
+```
+
+## Usage
+
+From SSHKit, use the [interactive backend](lib/sshkit/interactive/backend.rb) (which makes a system call to `ssh` under the hood), then execute commands as normal.
+
+```ruby
+SSHKit.config.backend = SSHKit::Interactive::Backend
+hosts = %w{my.server.com}
+on hosts do |host|
+  execute(:vim)
+end
+```
+
+Note that you will probably only want to execute on a single host. In Capistrano, it might look something like this:
+
+```ruby
+namespace :rails do
+  desc "Run Rails console"
+  task :console do
+    SSHKit.config.backend = SSHKit::Interactive::Backend
+    on primary(:app) do |host|
+      execute(:rails, :console)
+    end
+  end
+end
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/afeld/sshkit-interactive/fork)
+1. Clone it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sshkit/interactive.rb

@@ -0,0 +1,11 @@
+require 'sshkit'
+
+require_relative 'interactive/version'
+require_relative 'interactive/command'
+require_relative 'interactive/backend'
+
+module SSHKit
+  module Interactive
+    # Your code goes here...
+  end
+end

data/lib/sshkit/interactive/backend.rb

@@ -0,0 +1,23 @@
+# based on https://github.com/jetthoughts/j-cap-recipes/blob/be9dffe279b7bee816c9bafcb3633109096b20d5/lib/sshkit/backends/ssh_command.rb
+module SSHKit
+  module Interactive
+    class Backend < SSHKit::Backend::Printer
+      def run
+        instance_exec(host, &@block)
+      end
+
+      def within(directory, &block)
+        (@pwd ||= []).push directory.to_s
+        yield
+      ensure
+        @pwd.pop
+      end
+
+      def execute(*args, &block)
+        remote_command = command(*args)
+        output << remote_command
+        Command.new(host, remote_command).execute
+      end
+    end
+  end
+end

data/lib/sshkit/interactive/command.rb

@@ -0,0 +1,69 @@
+module SSHKit
+  module Interactive
+    class Command
+      attr_reader :host, :remote_command
+
+      # remote_command can be an SSHKit::Command or a String
+      def initialize(host, remote_command=nil)
+        @host = host
+        @remote_command = remote_command
+      end
+
+      def netssh_options
+        self.host.netssh_options
+      end
+
+      def user
+        self.host.user
+      end
+
+      def hostname
+        self.host.hostname
+      end
+
+      def options
+        opts = []
+        opts << '-A' if netssh_options[:forward_agent]
+        if netssh_options[:keys]
+          netssh_options[:keys].each do |k|
+            opts << "-i #{k}"
+          end
+        end
+        opts << "-l #{user}" if user
+        opts << %{-o "PreferredAuthentications #{netssh_options[:auth_methods].join(',')}"} if netssh_options[:auth_methods]
+        opts << %{-o "ProxyCommand #{netssh_options[:proxy].command_line_template}"} if netssh_options[:proxy]
+        opts << "-p #{netssh_options[:port]}" if netssh_options[:port]
+        opts << '-t' if self.remote_command
+
+        opts
+      end
+
+      def options_str
+        self.options.join(' ')
+      end
+
+      def remote_command_str
+        if self.remote_command
+          %{"#{self.remote_command}"}
+        else
+          ''
+        end
+      end
+
+      def to_s
+        parts = [
+          'ssh',
+          self.options_str,
+          self.hostname,
+          self.remote_command_str
+        ]
+
+        parts.reject(&:empty?).join(' ')
+      end
+
+      def execute
+        system(self.to_s)
+      end
+    end
+  end
+end

data/lib/sshkit/interactive/version.rb

@@ -0,0 +1,5 @@
+module SSHKit
+  module Interactive
+    VERSION = '0.1.0'
+  end
+end

data/spec/backend_spec.rb

@@ -0,0 +1,10 @@
+describe SSHKit::Interactive::Backend do
+  describe '#execute' do
+    it "does a system call with the SSH command" do
+      host = SSHKit::Host.new('example.com')
+      backend = SSHKit::Interactive::Backend.new(host)
+      expect_any_instance_of(SSHKit::Interactive::Command).to receive(:system).with('ssh -A -t example.com "/usr/bin/env ls"')
+      backend.execute('ls')
+    end
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,72 @@
+describe SSHKit::Interactive::Command do
+  describe '#options_str' do
+    def command_options_str(host)
+      command = SSHKit::Interactive::Command.new(host)
+      command.options_str
+    end
+
+    it "handles a simple hostname" do
+      host = SSHKit::Host.new('example.com')
+      expect(command_options_str(host)).to eq('-A')
+    end
+
+    it "handles a username and port" do
+      host = SSHKit::Host.new('someuser@example.com:2222')
+      expect(command_options_str(host)).to eq('-A -l someuser -p 2222')
+    end
+
+    it "handles a proxy" do
+      host = SSHKit::Host.new('someuser@example.com:2222')
+      host.ssh_options = {
+        proxy: Net::SSH::Proxy::Command.new('ssh mygateway.com -W %h:%p')
+      }
+
+      expect(command_options_str(host)).to eq('-A -l someuser -o "ProxyCommand ssh mygateway.com -W %h:%p" -p 2222')
+    end
+
+    it "handles keys option" do
+      host = SSHKit::Host.new('example.com')
+      host.ssh_options = { keys: %w(/home/user/.ssh/id_rsa) }
+
+      expect(command_options_str(host)).to eq('-A -i /home/user/.ssh/id_rsa')
+    end
+
+    # TODO split into separate tests
+    it "handles extra options" do
+      host = SSHKit::Host.new('someuser@example.com:2222')
+      host.keys     = ["~/.ssh/some_key_here"]
+      host.ssh_options = {
+        port: 3232,
+        keys: %w(/home/user/.ssh/id_rsa),
+        forward_agent: false,
+        auth_methods: %w(publickey password)
+      }
+
+      expect(command_options_str(host)).to eq('-i /home/user/.ssh/id_rsa -l someuser -o "PreferredAuthentications publickey,password" -p 3232')
+    end
+
+    it "handles a password"
+  end
+
+  describe '#to_s' do
+    it "includes options" do
+      host = SSHKit::Host.new('example.com')
+      command = SSHKit::Interactive::Command.new(host)
+      expect(command).to receive(:options_str).and_return('-A -B -C')
+      expect(command.to_s).to eq('ssh -A -B -C example.com')
+    end
+
+    it "excludes options if they're blank" do
+      host = SSHKit::Host.new('example.com')
+      command = SSHKit::Interactive::Command.new(host)
+      expect(command).to receive(:options_str).and_return('')
+      expect(command.to_s).to eq('ssh example.com')
+    end
+
+    it "accepts a remote command" do
+      host = SSHKit::Host.new('example.com')
+      command = SSHKit::Interactive::Command.new(host, 'ls')
+      expect(command.to_s).to eq('ssh -A -t example.com "ls"')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,95 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require_relative '../lib/sshkit/interactive'
+
+require 'net/ssh/proxy/command'
+
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/sshkit-interactive.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sshkit/interactive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sshkit-interactive"
+  spec.version       = SSHKit::Interactive::VERSION
+  spec.authors       = ["Aidan Feldman"]
+  spec.email         = ["aidan.feldman@gmail.com"]
+  spec.summary       = %q{An SSHKit backend that allows you to execute interactive commands on your servers. }
+  spec.homepage      = "https://github.com/afeld/sshkit-interactive"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "sshkit", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: sshkit-interactive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- aidan.feldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sshkit/interactive.rb
+- lib/sshkit/interactive/backend.rb
+- lib/sshkit/interactive/command.rb
+- lib/sshkit/interactive/version.rb
+- spec/backend_spec.rb
+- spec/command_spec.rb
+- spec/spec_helper.rb
+- sshkit-interactive.gemspec
+homepage: https://github.com/afeld/sshkit-interactive
+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.5
+signing_key: 
+specification_version: 4
+summary: An SSHKit backend that allows you to execute interactive commands on your
+  servers.
+test_files:
+- spec/backend_spec.rb
+- spec/command_spec.rb
+- spec/spec_helper.rb