ssh_speak 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a5cfdd8a57eca284e037885a58e2588f347315e
-  data.tar.gz: f6f2a2a94e4cf57f3fc32947e119bcdea18f05f1
+SHA256:
+  metadata.gz: '048d9021fef3cba4d6ce69d90ee1eaa266d966aa9c5405f66a21c853ebf16759'
+  data.tar.gz: c9f92484d3d02eac7f052822a15ee12d2b518bbed4c5093d14f2d91e51119fea
 SHA512:
-  metadata.gz: 9efe8fdf1b2bb7a9af6225d762f490e01cf2bd937bb71970395ec80de58eb73b1eaaff6a8e11c20ff524d9bb89672c1e3e55704a32e12b97b5a9749dbbc9f4f0
-  data.tar.gz: 1d39e57888318b6c80c07523d88dca90f4a3b20e183eb915015a9ed0acd69b5ed26c539c951bae8eaa4c52b1d78453d1be56048d1f4f766f84f36fcbbc09f63f
+  metadata.gz: fd08e038a98f7733527c3320234d2caab5cb665311fc2a52f035ae82c586d448c398d12f2a3499a5e79630211e03527ea485872678de95336c1a9714cd7790fb
+  data.tar.gz: 1eabcedad321a5df0e914819e3759e3412af8a786a039fe030fe972a4f5035a0849d3ed5c3cc90bb73ea72b23a1ebc01a025523e1ba9557cf7381bea1327f8f9

data/README.md

@@ -2,13 +2,13 @@
 Talk to a peer over SSH with espeak.
 
 ## Installation
-First you need espeak:
 
+### Installing espeak
 On Ubuntu/Debian or apt based distros:
 ```shell
 sudo apt-get install espeak
 ```
-On Archlinux based distros:
+On Arch based distros:
 ```shell
 sudo pacman -S espeak
 ```
@@ -17,25 +17,43 @@ On Fedora or RPM based distros, e.g.
 dnf install espeak
 ```
 
+### Installing the Gem
+
 Then install the application
 ```shell
-gem install ssh_speak
+gem install ssh_speak --no-ri --no-rdoc
 ```
+make sure you have the install directory in your `$PATH`, gem will warn you if you don't.
 
 ## Usage
 Basic usage:
 ```shell
-ssh-speak [user]@[host]:[port] [options]
+ssh-speak [user]@[host]:[port] [options] [[-o] [espeak-options]]
 ```
+- `[user]` is the user you want to speak to.
+- `[host]` is the name of the machine you want to connect to
+- `[port]` is optional, it will default to `22`. Important if the user you're connecting to's sshd does not run on port `22`.
+- `[options]` include:
+  - `--playback` which will make the program say back to you what you wrote.
+  - `--wait` will make the console hang until espeak has finished talking on the other computer
+- `-o [options]` this argument must always be last, every subsequent argument (option) after `-o` will be passed in to `espeak`, so you could say things like `-v finnish` to get a finnish voice; all such espeak options must come after `-o`
 
 For example, speak to user `albert` on the server `68.179.53.103` on port `369`
 ```shell
 ssh-speak albert@68.179.53.103:369
 ```
-and it will propmpt you for alberts password
+and it will prompt you for Albert's password
 
-If you'd like the messages you send to be played back to you, simply add the `--playback` option, e.g.
+If you'd like the messages you send to be played back to you, and you want to wait until it finishes speaking simply add the `--playback` and `--wait` options, e.g.
 ```shell
-ssh-speak user@host:22 --playback
+ssh-speak user@host:22 --playback --wait
 ```
 
+As an example for the `-o` option, say you want to sound like a drunk Finnish person. Make sure you have slowed speech (`-s 50`, measured in words-per-minute, default is 175); you're loud (`-a 200` amplitude, default is 100); you're rather low pitch (`-p 20`, pitch, default is 50); and of course, you're Finnish (`-v finnish`, voice, default is `english`):
+```shell
+ssh-speak $(whoami)@localhost --wait -o -s 50 -a 200 -p 20 -v finnish
+```
+and try it out (make sure you have `sshd` running for yourself here, at port 22):
+```shell
+(talk)> perkele
+```

data/bin/ssh-speak

@@ -5,16 +5,15 @@ require 'readline'
 require 'io/console'
 
 abort 'Please supply ssh server argument in form of: 
-`user@host:port` (port is optional)' if ARGV.size.zero?
+`user@host:port` (port is optional, default 22)' if ARGV.size.zero?
 
 prompt = '(talk)> '
 
 user, _ = ARGV[0].split '@'
-location = ARGV[0].split ':'
-_, host = location[0].split '@'
-port = location[-1].to_i if location.size > 1
+server  = ARGV[0].split ':'
+_, host = server[0].split '@'
+port = server[-1].to_i if server.size > 1
 port = 22 if port.nil?
-playback = ARGV.include? '--playback'
 
 print 'Password: '
 pass = STDIN.noecho(&:gets).chomp
@@ -28,25 +27,32 @@ begin
   print "\rSuccessfully connected to host."
 rescue Errno::ECONNREFUSED
   print "\rCould not connect! Check username, hostname, port, etc."
+server  = ARGV[0].split ':'
+  exit 1
 end
 
+playback = ARGV.include? '--playback'
+wait = ARGV.include? '--wait'
+options = ARGV.index('-o') ? ARGV[(ARGV.index('-o') + 1)..-1].join(' ') : ''
+
 puts "\r"
 what = String.new
-until what == "\0"
-  trap 'SIGINT' do 
-    puts "\nUse EOF character to exit (Ctrl+D)"
-    print prompt
-  end
-  what = Readline.readline prompt, true
-  break if what.nil? || what.downcase.strip == 'exit'
 
-  Net::SSH.start host, user, :port => port, :password => pass do |ssh|
-    say = "espeak \"#{what}\""
+Net::SSH.start host, user, :port => port, :password => pass do |ssh|
+  until what == "\0"
+    trap 'SIGINT' do 
+      puts "\nUse EOF character to exit (Ctrl+D)"
+      print prompt
+    end
+
+    what = Readline.readline prompt, true
+    break if what.nil? || what.downcase.strip == 'exit'
 
+    say = "espeak #{options} \"#{what}\""
     %x{ #{say} >/dev/null 2>&1 & } if playback
-    ssh.exec! say
+    ssh.exec! wait ? say : "sh -c 'nohup #{say} > /dev/null 2>&1 &'"
   end
 end
 
-puts "\rTalker disconnected and exited."
+puts "\rSSH Speaker disconnected and exited."
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssh_speak
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Demonstrandum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Talk to peers over SSH