tweemux 0.0.2 → 0.1.0

data/.gemspec

@@ -7,7 +7,7 @@ Working.gemspec(
   :name => 'tweemux',
   :summary => Working.third_line_of_readme,
   #:description => Working.readme_snippet(/== Usage/, /== TODO/),
-  :description => 'tweemux host; tweemux at some_machine; plus some more stuff',
+  :description => Working.third_line_of_readme,
   :version => Tweemux::VERSION,
   :authors => %w(☈king),
   :email => 'rking-tweemux@sharpsaw.org',

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 group :development do
   gem 'working'
 end

data/README.md

@@ -0,0 +1,63 @@
+![tweemux: For Remote Pair Programming](img/tweemux.png)
+
+For Remote Pair Programming: A handy script to create-or-join a world-readable tmux session
+
+One of the aims of this script is to be convenient. Another of its aims is to be transparent (read: loud) about what it's doing. None of the parts of this are inherently complicated, and we'd like to make sure you can wean yourself off of this if you ever want to.
+
+## Problem
+
+Though tmux is an amazing tool, some of the setup for a shared session over the Internet can be tricky, at first. As you will see from the commands output of this script, it is not utterly difficult, but it's still usually more than you want you or your pair to think about when you're trying to work.
+
+## Guest Usage
+
+    gem install tweemux
+    tweemux at somehost.org
+    # or, specify a port:
+    tweemux at somehost.org 3322
+
+If all goes well, that's it!
+
+Now, time to roll up sleeves and get into the details of how to roll out a red
+carpet like this for one's pair.
+
+## Host Usage
+
+For starters:
+
+    gem install tweemux
+
+Then, create the user on your machine (this varies. On decent Unices, it's `adduser` or `useradd`. On OS X you can either get an [adduser-like script](https://raw.github.com/sharpsaw/mac-dots/master/bin/adduser) or do it through the System Preferences GUI).
+
+If you're on a machine behind a firewall, you have these options:
+
+* VPN. If you're on a business network with your pair, you probably can already `ping` each other's machines. Easy stuff, then.
+* Directly open a port, such as going to your router config (perhaps at http://10.0.0.1 ?) and setting it to pass the external IP (see `curl ifconfig.me` or http://whatismyip.com ) through to your local box. This is smpler once you get it set up, as long as your location is stable and you have control over the router.
+* Use a Virtual machine on the web, and you both ssh into that. Can work very well, and has other advantages (such as the ability to trash the machine all you want and just rebuild it later). The big downside is that you now have two lagged users rather than only one.
+* SSH port forward. This is my favorite, but the downside is that you have to have access to a shell account somewhere public. Tweemux provides a tool for this:
+
+In this example, sharpsaw.org is a machine that is not behind the firewall:
+
+    tweemux forward local 22 from sharpsaw.org 3322
+
+Then, after your pair can get to your SSHD socket, finally:
+
+    tweemux host
+    # (now they're ready to `tweemux at <yourhost> <your-port>`)
+
+## Going Further
+
+It's also nice to share a windowing environment session as well. For example, the "Guest" can host a VNC that you, as the tweemux host, can then connect to. This allows you to "point" at things with the mouse, and to share web browsing, etc.
+
+## No Public Box?
+
+If you don't have a public SSH account (like the way I use sharpsaw.org, above), let me know ( i-am-stuck@sharpsaw.org ). We'll solve that.
+
+## TODO
+
+    tweemux keys lwoodson # when their Github username == desired Unix username
+    # -or-
+    tweemux keys cirwin github: ConradIrwin
+
+## Thanks to
+
+The `wemux` script, which is similar to this, but has a different scope of features.

data/lib/tweemux/action/at.rb

@@ -1,8 +1,12 @@
 class Tweemux::Action::At < Tweemux::Action
   def run args
     host, port = args
-    port ||= 22
-    explained_run %W(ssh #{host} -p#{port} -t tmux -S #{Tweemux::SOCK} attach),
-      "Connect to #{host} on port #{port}, demand a pty, then attach to session"
+    cmd = 'ssh', host
+    if port
+      cmd.push '-p'+port
+      port_parens = " (on port #{port})"
+    end
+    explained_run cmd + %W(-t tmux -S #{Tweemux::SOCK} attach),
+      "Connect to #{host}#{port_parens}, demand a pty, then attach to session"
   end
 end

data/lib/tweemux/action/keys.rb

@@ -0,0 +1,3 @@
+class Tweemux::Action::Keys < Tweemux::Action
+
+end

data/lib/tweemux/action.rb

@@ -35,11 +35,11 @@ class Tweemux
         end
 
         def system_or_raise cmd
-          system *cmd or pseudo_restarts(*cmd)
+          system *cmd or pseudo_restarts cmd.join(' ')
         end
 
         def highlight_command arr
-          ':Running'.color(:middle_blue) \
+          ': Running'.color(:middle_blue) \
             + '; '.color(:gray245) \
             + colorize_tmux_command(arr)
         end
@@ -65,13 +65,22 @@ class Tweemux
           warn '# failed ☹'.color :error
           ctrl_c = 'Ctrl+c'.color :keypress, :prompt
           enter = 'Enter'.color :keypress, :prompt
+          letter_p = 'p'.color :keypress, :prompt
           # TODO: work pry-rescue into this so we can offer a 'try-again'
           # See also: https://github.com/ConradIrwin/pry-rescue/issues/29
-          warn <<-EOT.color :prompt
-  To give up, hit: #{ctrl_c}
+          print <<-EOT.chomp.color :prompt
+   To give up, hit: #{ctrl_c}
 To run anyway, hit: #{enter}
+  To pry from here: #{letter_p}
+> 
           EOT
-          $stdin.readline
+          answer = $stdin.readline
+          if answer[/p/i]
+            notice = 'I will be very impressed if this is useful...'
+            warn notice.color :error
+            require 'pry'
+            binding.pry
+          end
         end
 
         def load_all!

data/lib/tweemux/version.rb

@@ -1,3 +1,3 @@
 class Tweemux
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/test/ok18.rb

@@ -0,0 +1 @@
+# Just a file to make sure ruby18 is a working compiler

data/test/tweemux/action/at_test.rb

@@ -11,6 +11,6 @@ class Tweemux::Action::AtImplicitPortTest  < MiniTest::Unit::TestCase
   include TweemuxActionHelper
   def argv; %w'at sharpsaw.org' end
   def expected_commands
-    [ %w(ssh sharpsaw.org -p22 -t tmux -S /tmp/tweemux.sock attach) ]
+    [ %w(ssh sharpsaw.org -t tmux -S /tmp/tweemux.sock attach) ]
   end
 end

data/test/tweemux_test.rb

@@ -2,7 +2,7 @@ require_relative 'test_helper'
 
 class TweemuxTest < MiniTest::Unit::TestCase
   def test_doc_claims
-    claimed_working = File.readlines('README.rdoc').grep /^ {4}tweemux/
+    claimed_working = File.readlines('README.md').grep /^ {4}tweemux/
     claimed_working.each do |line|
       line.sub! /#.*/, ''
       fake_argv = line.sub(/^\s*tweemux/, '').split.map{|e| e.strip}
@@ -16,6 +16,8 @@ class TweemuxTest < MiniTest::Unit::TestCase
   end
 
   def test_ruby18
+    return warn "Needs a working ruby18 executable in $PATH".color(:orange) \
+      unless ruby18ok 'test/ok18.rb'
     # TODO: optimize this by running them all in one command
     Dir['{bin,lib}/*.rb'].each do |e|
       fail "ruby18 hates #{e}" unless "Syntax OK\n" == `ruby18 -c #{e}`
@@ -24,4 +26,8 @@ class TweemuxTest < MiniTest::Unit::TestCase
     skip 'Needs ruby18 executable in $PATH' if e.message[/ruby18/]
     raise e
   end
+
+  def ruby18ok args
+    "Syntax OK\n" == `ruby18 -c #{args}`
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweemux
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,13 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies: []
 description: ! 'For Remote Pair Programming: A handy script to create-or-join a world-readable
-  tmux session (smaller than wemux)
+  tmux session
 
 
-  tweemux host; tweemux at some_machine; plus some more stuff'
+  For Remote Pair Programming: A handy script to create-or-join a world-readable tmux
+  session
+
+'
 email: rking-tweemux@sharpsaw.org
 executables:
 - tweemux
@@ -27,20 +30,22 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - bin/tweemux
+- img/tweemux.blend
+- img/tweemux.png
 - lib/tweemux.rb
 - lib/tweemux/action.rb
 - lib/tweemux/action/at.rb
-- lib/tweemux/action/bro.rb
 - lib/tweemux/action/forward.rb
 - lib/tweemux/action/host.rb
+- lib/tweemux/action/keys.rb
 - lib/tweemux/action/share.rb
-- lib/tweemux/action/sis.rb
 - lib/tweemux/core_ext.rb
 - lib/tweemux/version.rb
 - test/action_test_helper.rb
+- test/ok18.rb
 - test/test_helper.rb
 - test/tweemux/action/at_test.rb
 - test/tweemux/action/forward_test.rb
@@ -68,13 +73,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: ! 'For Remote Pair Programming: A handy script to create-or-join a world-readable
-  tmux session (smaller than wemux)'
+  tmux session'
 test_files:
 - test/action_test_helper.rb
+- test/ok18.rb
 - test/test_helper.rb
 - test/tweemux/action/at_test.rb
 - test/tweemux/action/forward_test.rb

data/README.rdoc

@@ -1,49 +0,0 @@
-= tweemux
-
-For Remote Pair Programming: A handy script to create-or-join a world-readable tmux session (smaller than wemux)
-
-One of the aims of this script is to be convenient. Another of its aims is to be transparent (read: loud) about what it's doing. None of the parts of this are inherently complicated, and any of them is prone to need additional debugging, so it's best that `tweemux`'s behavior is visible.
-
-== Problem
-
-Though tmux is an amazing tool, some of the parts of it are low-level. As you can see from the tmux portion of this script's source, there isn't much you have to do to get a shared session, but it's still more than you want you or your pair to think about when you're trying to work.  The `wemux` script is similar to this, but I don't care for its complexity/optionality/config (and the thing that really bothers me is that it has a 'read-only' mode that only is read-only because of the command used to connect to the socket — the socket itself is still `chmod 777`, so you might as well be honest about the idea that the session could be connected by any user in writeable mode).
-
-Once you've solved the "shared tmux" problem, that's actually the easier part of it. This script goes a little further and helps with the user and SSH connection problems.
-
-== Host Usage
-
-For starters:
-
-    gem install tweemux
-
-Then, create the user on your machine:
-
-    tweemux bro lwoodson # when their Github username == desired Unix username
-    # -or-
-    tweemux bro cirwin github: ConradIrwin
-    # -or-
-    tweemux sis ghopper # synonym for 'bro'
-
-If you're on a machine behind a firewall, use one that is *not* behind a firewall that you also have SSH access to (in this example, sharpsaw.org is the one not behind the firewall):
-
-    tweemux forward local 22 from sharpsaw.org 3322
-    # ^ Or, if you're in control of the router, you can just open a port and
-    # point your pair at your actual IP (`curl ifconfig.me` comes in handy for
-    # finding the public IP)
-
-Then finally:
-
-    tweemux host
-
-== Guest Usage
-
-    gem install tweemux
-    tweemux at sharpsaw.org 3322 # uses the 'forward' set up from above
-
-== Going Further
-
-It's also nice to share a windowing environment session as well. For example, the "Guest" can host a VNC that you, as the tweemux host, can then connect to. This allows you to "point" at things with the mouse, and to share web browsing, etc.
-
-== No Public Box?
-
-If you don't have a public SSH account (like the way I use sharpsaw.org, above), let me know ( i-am-stuck@sharpsaw.org ). We'll solve that.

data/lib/tweemux/action/bro.rb

@@ -1,3 +0,0 @@
-class Tweemux::Action::Bro < Tweemux::Action
-
-end

data/lib/tweemux/action/sis.rb

@@ -1,2 +0,0 @@
-require 'tweemux/action/bro'
-class Tweemux::Action::Sis < Tweemux::Action::Bro; end