tweemux 0.2.0 → 0.3.0

data/README.md

@@ -26,7 +26,10 @@ 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).
+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).
 
 Now, you can install the 'keyholes' for this user from Github. This means they
 will be able to get in without manually typing a password, just like when they
@@ -37,12 +40,8 @@ will be able to get in without manually typing a password, just like when they
     tweemux hubkey rking
 
 Now, they'll need a route to your sshd port. 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:
+firewall, you have these options: Use a VPN, directly open a port, use a host
+on the Internet, or SSH port forward. Tweemux provides a tool for this last one:
 
 In this example, sharpsaw.org is a machine that is not behind the firewall:
 
@@ -57,6 +56,14 @@ Then, after your pair can get to your SSHD socket, finally:
 
 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.
 
+## Details about "Route to your sshd port", above
+
+Your options are:
+* 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 machine on the Internet, that you both ssh into that. Can work very well, but 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.
+
 ## 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.rb

@@ -9,11 +9,17 @@ class Tweemux
       action = understand args
       action.call
     rescue Tweemux::Action::NoRestartsException => e
-      warn e.message.color :error
+      die e.message.color :error
+    end
+
+    def die msg
+      warn msg
       exit 1
     end
 
     def understand args
+      # dash args are out of fashion!
+      args = ['Help'] if args.empty? or args.first[/^-/]
       action = args.shift
       klass = Tweemux::Action.const_get action.capitalize
       klass.new args

data/lib/tweemux/action/help.rb

@@ -0,0 +1,14 @@
+class Tweemux::Action::Help < Tweemux::Action
+  def run _
+    five_dirs_up = (['..']*5).join '/'
+    readme_path =
+      File.expand_path 'lib/tweemux/action/help.rb'+five_dirs_up+'/README.md'
+    contents = File.read readme_path
+    contents.sub! /^.+(?=## Guest Usage)/m, ''
+    contents.sub! /## Going Further.*/m, ''
+    contents.sub! /For starters.+?gem install tweemux\n\n/mi, ''
+    contents.gsub! /^## (.+)/ do |m| m.color :heading end
+    contents.gsub! /^    .+/ do |m| m.color :command end
+    warn contents
+  end
+end

data/lib/tweemux/core_ext.rb

@@ -2,8 +2,8 @@ class String
   # Pallete viewable from:
   #   https://github.com/sharpsaw/tmux-dots/blob/master/bin/colortest
   COLORS = {
-    :middle_blue => 69,
-    :brighty_blue => 39,
+    :middle_blue => 69, :heading => 69,
+    :brighty_blue => 39, :command => 39,
     :gray245 => 245,
     :orange => 172,
     :pale_yellow => 180,

data/lib/tweemux/version.rb

@@ -1,3 +1,3 @@
 class Tweemux
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/test/tweemux/action/help_test.rb

@@ -0,0 +1,33 @@
+require_relative '../../action_test_helper'
+class Tweemux::Action
+  class HelpTest < MiniTest::Unit::TestCase
+    include TweemuxActionHelper
+    def argv; %w'help' end
+    def expected_commands; [] end
+    def test_run
+      output = nil
+      out, err = capture_io do
+        assert_equal stubbed_run.to_yaml, expected_commands.to_yaml
+      end
+      assert_match /Guest Usage/i, err
+      assert_match /tweemux at/, err
+      assert_match /Host Usage/i, err
+      assert_match /tweemux host/, err
+      refute_match /Problem/i, err
+      refute_match /Going Further/i, err
+      refute_match /For starters.*gem install tweemux/m, err
+    end
+  end
+
+  class ImpliedHelp < HelpTest
+    def argv; [] end
+  end
+
+  class DashyHelp < HelpTest
+    def argv; ['--help'] end
+  end
+
+  class YouKnowWhatNoDashiesAtAll < HelpTest
+    def argv; ['--help'] end
+  end
+end

data/test/tweemux/action/hubkey_test.rb

@@ -3,7 +3,7 @@ require 'ostruct'
 
 class Tweemux::Action::HubkeyTest < MiniTest::Unit::TestCase
   include TweemuxActionHelper
-  def argv; %w(bro hi HiOnGithub) end
+  def argv; %w(hubkey hi HiOnGithub) end
   def test_run
     commands_run = nil
     with_fake_expand_path expecting: '~hi', expanding_to: '/home/hi' do
@@ -20,17 +20,18 @@ class Tweemux::Action::HubkeyTest < MiniTest::Unit::TestCase
   end
 
   def test_run_will_not_clobber_auth_keys_file
+    warning = nil
     with_fake_expand_path expecting: '~hi', expanding_to: '/home/hi' do
       File.stub :exists?, -> path {
         assert_equal '/home/hi/.ssh/authorized_keys', path
         true
       } do
-        stubbed_run
+        Tweemux.stub :die, -> msg { warning = msg } do
+          stubbed_run
+        end
       end
     end
-    fail "Shouldn't get here"
-  rescue Tweemux::Action::NoRestartsException => e
-    assert_match /refusing to overwrite.*authorized_keys/i, e.message
+    assert_match /refusing to overwrite.*authorized_keys/i, warning
   end
 
   def with_fake_expand_path args

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweemux
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,6 +36,7 @@ files:
 - lib/tweemux/action.rb
 - lib/tweemux/action/at.rb
 - lib/tweemux/action/forward.rb
+- lib/tweemux/action/help.rb
 - lib/tweemux/action/host.rb
 - lib/tweemux/action/hubkey.rb
 - lib/tweemux/action/share.rb
@@ -46,6 +47,7 @@ files:
 - test/test_helper.rb
 - test/tweemux/action/at_test.rb
 - test/tweemux/action/forward_test.rb
+- test/tweemux/action/help_test.rb
 - test/tweemux/action/host_test.rb
 - test/tweemux/action/hubkey_test.rb
 - test/tweemux/action/share_test.rb
@@ -82,6 +84,7 @@ test_files:
 - test/test_helper.rb
 - test/tweemux/action/at_test.rb
 - test/tweemux/action/forward_test.rb
+- test/tweemux/action/help_test.rb
 - test/tweemux/action/host_test.rb
 - test/tweemux/action/hubkey_test.rb
 - test/tweemux/action/share_test.rb