net-ssh-local 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf56178008f4dc111260ad9f4ce79645d2a95f2ced307d617242d7e7aadfa7c5
+  data.tar.gz: 43a4690de8e67a6ef867f1372b59d0b63c1262c375d3e97c277d3855b82a771f
+SHA512:
+  metadata.gz: 57231738e2c313e4cffc8f14c00ec40a67a52ebb3f87740f0572dcf407fb4d1f7aac6aadf6c023029e679835b15ee4509169be0b71ebf4dbc58c9797cb16b06b
+  data.tar.gz: 2ac2aa63f390502a38da507694fbc98c2bbadb945ac360c76599b4f13fe2ff5dcd70aaa8b3b0d1cc8c6d5470b5ec84525dd3526a13dc1239e1f746307a6dda00

data/.circleci/config.yml

@@ -0,0 +1,64 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.1-node-browsers
+      - image: circleci/ruby:2.5.3-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # # Database setup
+      # - run: bundle exec rake db:create
+      # - run: bundle exec rake db:schema:load
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Steve Lamotte
+
+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,51 @@
+# Net::SSH::Local
+[![CircleCI](https://circleci.com/gh/slamotte/net-ssh-local.svg?style=svg)](https://circleci.com/gh/slamotte/net-ssh-local)
+
+This gem is a Net::SSH plugin to streamline localhost deployment. It will streamline localhost operations when the hostname is "localhost" and the user is nil.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net-ssh-local', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install net-ssh-local
+
+## Usage
+
+Require in whichever file(s) you'd like to optimize e.g. `Capfile`:
+
+    require 'net/ssh/local'
+
+
+### Example
+
+`config/deploy/staging_and_local.rb`
+
+    # typically server config is:
+    server 'my.remotehost.com', roles: %w{app web}, user: 'deploy', key: '/path/to/key.pem'
+    # localhost config is:
+    server 'localhost', roles: %w{app web} # no need to set SSH configs.
+
+
+## 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/slamotte/net-ssh-local.
+
+## 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/local"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/extensions/net/ssh/connection/session.rb

@@ -0,0 +1,68 @@
+require 'net/ssh'
+require 'net/ssh/connection/session'
+
+module Extensions
+  module Net
+    module SSH
+      module Connection
+        module Session
+          def exec(command, status: nil, &block)
+            return super(command, status: status, &block) unless localhost?
+
+            result = exec_local_command(command)
+  
+            # Return status if given
+            if status
+              status[:exit_code] = result[:code]
+              status[:exit_signal] = result[:signal]
+            end
+  
+            # Process results
+            if result[:error].nil?
+              if block
+                block.call(nil, :stdout, result[:output])
+              else
+                $stdout.print(result[:output])
+              end
+            else
+              if block
+                block.call(nil, :stderr, result[:error])
+              else
+                $stderr.print(result[:error])
+              end
+            end
+          end
+  
+          def send_data(data)
+            return super(data) unless localhost?
+
+            binding.pry
+            raise 'what do do here?'
+            # stdin << data # maybe??
+          end
+
+          private
+  
+          def localhost?
+            host == 'localhost' && options[:user].nil?
+          end
+  
+          def exec_local_command(command)
+            result = {}
+            begin
+              result[:output] = `#{command}`
+            rescue StandardError => e
+              result[:error] = e.message
+            ensure
+              result[:code] = $?.exitstatus
+              result[:signal] = $?.termsig
+              result
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Net::SSH::Connection::Session.prepend(Extensions::Net::SSH::Connection::Session)

data/lib/extensions/net/ssh.rb

@@ -0,0 +1,18 @@
+require 'net/ssh'
+
+module Net
+  module SSH #:nodoc:
+    SSH.singleton_class.send(:alias_method, :original_start, :start) # TODO: any way to use prepend instead?
+
+    # Custom behaviour for localhost with no user: nothing to log in with
+    def self.start(host, user=nil, options={}, &block)
+      return original_start(host, user, options, &block) unless host == 'localhost' && user.nil?
+
+      transport = Transport::Session.new(host, options)
+      connection = Connection::Session.new(transport, {})      
+      return connection unless block_given?
+
+      yield connection
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Net
+  module SSH
+    module Local
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/net/ssh/local.rb

@@ -0,0 +1,10 @@
+require 'net/ssh/local/version'
+require 'extensions/net/ssh'
+require 'extensions/net/ssh/connection/session'
+
+module Net
+  module SSH
+    module Local #:nodoc:
+    end
+  end
+end

data/net-ssh-local.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/local/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "net-ssh-local"
+  spec.version       = Net::SSH::Local::VERSION
+  spec.authors       = ["Steve Lamotte"]
+  spec.email         = ["steve@lexor.ca"]
+
+  spec.summary       = %q{Net::SSH plugin to streamline localhost operations.}
+  spec.description   = %q(net-ssh-local is a plugin to streamline localhost operations when the hostname is "localhost" and the user is nil.)
+  spec.homepage      = "https://github.com/slamotte/net-ssh-local"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "net-ssh", "~> 5.2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec_junit_formatter"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: net-ssh-local
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Lamotte
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+  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: rake
+  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: rspec
+  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: rspec_junit_formatter
+  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-local is a plugin to streamline localhost operations when the
+  hostname is "localhost" and the user is nil.
+email:
+- steve@lexor.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/extensions/net/ssh.rb
+- lib/extensions/net/ssh/connection/session.rb
+- lib/net/ssh/local.rb
+- lib/net/ssh/local/version.rb
+- net-ssh-local.gemspec
+homepage: https://github.com/slamotte/net-ssh-local
+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.7.9
+signing_key: 
+specification_version: 4
+summary: Net::SSH plugin to streamline localhost operations.
+test_files: []