direct_ssh 0.0.1 → 0.0.2

data/README.md

@@ -1,8 +1,6 @@
 # DirectSsh
 
-In order to use ssh without the need to enter password everytime,
-this gem will create public/private rsa keys if they do not exist
-and send public key to remote server
+In order to use ssh without the need to enter password everytime, this gem will create public/private rsa keys if they do not exist and send public key to remote server
 
 ## Installation
 
@@ -20,7 +18,82 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Scripts like these
+
+a. scripts which ask password everytime
+
+```ruby
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'net/ssh'
+require 'highline/import'
+
+host = '127.0.0.1'
+user = 'user'
+
+options = {}
+options[:password] = ask("#{user}@#{host}'s password: ") { |q| q.echo = false }
+
+Net::SSH.start(host, user, options) { |ssh|
+    puts ssh.exec!('cat /etc/*-release')
+}
+```
+
+b. scripts which expose password directly
+
+```ruby
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'net/ssh'
+require 'highline/import'
+
+Net::SSH.start('127.0.0.1', 'user', {:password => 'password'}) { |ssh|
+    puts ssh.exec!('cat /etc/*-release')
+}
+```
+
+can be rewritten like this
+
+c. direct_ssh example with block form
+
+```ruby
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'direct_ssh'
+
+DirectSsh.start('127.0.0.1', 'user') { |ssh|
+    puts ssh.exec!('cat /etc/*-release')
+}
+```
+
+or
+
+d. direct_ssh example without block
+
+```ruby
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'direct_ssh'
+
+ssh = DirectSsh.start('127.0.0.1', 'user')
+puts ssh.exec!('cat /etc/*-release')
+ssh.close
+```
+
+## Shell
+
+The direct_ssh shell command checks status of ssh connection to the remote server. It will ask password and send public key to remote server if neccessary.
+
+After ssh connection created successfully, The `cat /etc/*-release` command will be executed.
+
+```text
+Usage: direct_ssh user@host [-p port]
+ - default port 22 will be used if you leave it off
+```
 
 ## Contributing
 

data/bin/direct_ssh

@@ -6,8 +6,8 @@ require 'direct_ssh'
 require 'net/ssh'
 
 def usage
-    puts 'usage: direct_ssh user@host [-p port]'
-    puts '  The default port 22 will be used if you leave it off'
+    puts 'Usage: direct_ssh user@host [-p port]'
+    puts ' - default port 22 will be used if you leave it off'
 end
 
 def parse_args(argv)

data/direct_ssh.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["xxjapp@gmail.com"]
   spec.description   = %q{Create public/private rsa keys if they do not exist and send public key to remote server}
   spec.summary       = %q{Use ssh without the need to enter password everytime}
-  spec.homepage      = %q{http://rubygems.org/gems/direct_ssh}
+  spec.homepage      = %q{https://github.com/xxjapp/direct_ssh}
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/direct_ssh/version.rb

@@ -1,3 +1,3 @@
 module DirectSsh
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: direct_ssh
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -95,7 +95,7 @@ files:
 - lib/direct_ssh/key_handler.rb
 - lib/direct_ssh/validator.rb
 - lib/direct_ssh/version.rb
-homepage: http://rubygems.org/gems/direct_ssh
+homepage: https://github.com/xxjapp/direct_ssh
 licenses:
 - MIT
 post_install_message: