jossh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89bbdbdf3826fe36d90cb9c883b272dc2a61b480
+  data.tar.gz: 8f3ee16da118802914ec86221606a4abf99cdb89
+SHA512:
+  metadata.gz: 474aa547a0e00146e1a0bc0b477e358e2d210939639f58f8e854b42c530c8a24d20f04d711de205a6eb2fa538e7a2793dcc9dfa2eb186ee2634627c9db0be2c2
+  data.tar.gz: 28e579729179e79b391eb2ce7e443d3dd5087bba59d98e67269f7f18c0ee85ca310f49fec4cb50f2b9c571b6bfa1316898cbc0b3936d8188e3b16471d6bcfdc1

data/README.md

@@ -0,0 +1,81 @@
+Jossh - Your SSH Buddy
+======================
+
+Ruby SSH functions for easier and prettier remote deployment and automation.
+
+## Install
+
+Add to your Gemfile
+
+	gem 'jossh'
+
+Or install manually
+
+	gem install jossh
+
+
+## Features
+
+1. Allows running one or more commands over SSH.
+2. Allows running external local scripts remotely
+3. Has four commands: `ssh`, `ssh!`, `ssh_script` and `ssh_script!`. The 'bang' versions generate pretty and indented output.
+4. Uses a single SSH connection.
+5. Uses a simple hash for defining hosts.
+6. Allows storing host specifications in a YAML file.
+7. Supports all options available in `Net::SSH#start`.
+8. Prints output Heroku-style.
+
+## Usage
+
+### Example 1: Host specifications in a YAML file
+
+```ruby
+# example.rb
+require 'jossh'
+
+ssh! :localhost, ["cd /opt/app", "git pull"]
+```
+
+```yaml
+# ssh_hosts.yml
+:localhost:
+  :host: 'localhost'
+  :user: 'vagrant'
+```
+
+### Example 2: Host specifications directly in the code
+
+```ruby
+# example.rb
+require 'jossh'
+
+localhost = {
+  host: 'localhost',
+  user: 'vagrant',
+  forward_agent: true,
+}
+
+ssh! localhost, ["cd /opt/app", "git pull"]
+```
+
+
+### Example 3: Run an external local script remotely
+
+```ruby
+# example.rb
+require 'jossh'
+
+ssh_script! :production, deploy
+```
+
+```bash
+# deploy
+cd /opt/app
+echo "-> Pulling source from origin"
+git pull
+echo "-> Restarting server"
+touch 'tmp/restart.txt'
+echo "-> Done"
+```
+
+See also: The examples folder

data/lib/jossh/api.rb

@@ -0,0 +1,21 @@
+module Jossh
+
+  def ssh_script!(hostspec, script)
+    CommandRunner.new.ssh_script! hostspec, script
+  end
+
+  def ssh_script(hostspec, script, callback: nil)
+    CommandRunner.new.ssh_script hostspec, script, callback: callback
+  end
+
+  def ssh!(hostspec, script)
+    CommandRunner.new.ssh! hostspec, script
+  end
+
+  def ssh(hostspec, script, callback: nil)
+    CommandRunner.new.ssh hostspec, script, callback: callback
+  end
+
+
+end
+

data/lib/jossh/command_runner.rb

@@ -0,0 +1,64 @@
+require "net/ssh"
+require "yaml"
+
+module Jossh
+
+  class CommandRunner
+
+    def ssh!(hostspec, script)
+      ssh hostspec, script, callback: OutputHandler.new.method(:pretty_puts)
+    end
+
+    def ssh(hostspec, script, callback: nil)
+      callback ||= method :puts
+      script   = script.join "\n" if script.is_a? Array
+      hostspec = load_spec(hostspec) if hostspec.is_a? Symbol
+      host     = hostspec.delete :host
+      user     = hostspec.delete :user
+
+      Net::SSH.start( host, user, hostspec ) do |ssh| 
+        ssh.exec! script do |ch, stream, data|
+          callback.call data
+        end
+      end
+    end
+
+    def ssh_script!(hostspec, script)
+      ssh! hostspec, load_script(script)
+    end
+
+    def ssh_script(hostspec, script, callback: nil)
+      ssh hostspec, load_script(script), callback: callback
+    end
+
+    private
+
+    def load_spec(key)
+      ssh_hosts[key] or abort "Cannot find :#{key} in #{hostfile}"
+    end
+
+    def ssh_hosts
+      @ssh_hosts ||= load_ssh_hosts
+    end
+
+    def load_ssh_hosts
+      File.exist? hostfile or abort "Cannot find #{hostfile}"
+      YAML.load_file hostfile
+    end
+
+    def hostfile
+      @hostfile ||= 'ssh_hosts.yml'
+    end
+
+    def hostfile=(file)
+      @hostfile = file
+    end
+
+    def load_script(script)
+      File.read script
+    end
+
+  end
+
+end
+

data/lib/jossh/output_handler.rb

@@ -0,0 +1,52 @@
+require 'colsole'
+
+# Print functions inspired by Heroku and based on code from Mina
+# https://github.com/mina-deploy/mina/blob/master/lib/mina/output_helpers.rb
+
+module Jossh
+
+  class OutputHandler
+
+    include Colsole
+
+    def pretty_puts(lines)
+      lines = lines.split("\n") if lines.is_a? String
+      lines.each do |line|
+        if line =~ /^\-+> (.*?)$/
+          puts_status $1
+        elsif line =~ /^! (.*?)$/
+          puts_error $1
+        elsif line =~ /^\$ (.*?)$/
+          puts_command $1
+        else
+          puts_stdout line
+        end
+      end
+    end
+
+    private
+
+    def puts_status(msg)
+      say "!txtgrn!----->!txtrst! #{msg}"
+    end
+
+    def puts_error(msg)
+      say "  !txtylw!!!txtrst!    !txtred!#{msg}"
+    end
+
+    def puts_stderr(msg)
+      say "       !txtred!#{msg}"
+    end
+
+    def puts_command(msg)
+      say "       !txtpur!$ #{msg}"
+    end
+
+    def puts_stdout(msg)
+      say "       #{msg}"
+    end
+
+  end
+
+end
+

data/lib/jossh/version.rb

@@ -0,0 +1,3 @@
+module Jossh
+  VERSION = "0.0.1"
+end

data/lib/jossh.rb

@@ -0,0 +1,6 @@
+require 'jossh/version'
+require 'jossh/command_runner'
+require 'jossh/output_handler'
+require 'jossh/api'
+
+self.extend Jossh

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: jossh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: run-gem-dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Jossh is a wrapper around Ruby Net::SSH with a simpler interface and
+  prettier output
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jossh.rb
+- lib/jossh/api.rb
+- lib/jossh/command_runner.rb
+- lib/jossh/output_handler.rb
+- lib/jossh/version.rb
+homepage: https://github.com/DannyBen/jossh
+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.6
+signing_key: 
+specification_version: 4
+summary: Easier and Prettier SSH for Ruby
+test_files: []