tweemux 0.1.0 → 0.2.0

data/.gemspec

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

data/README.md

@@ -28,7 +28,16 @@ For starters:
 
 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:
+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
+`git push` to Github:
+
+    tweemux hubkey cirwin github: ConradIrwin
+    # or, if their Unix username is their Github username, there's a shorthand:
+    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.
@@ -52,11 +61,33 @@ It's also nice to share a windowing environment session as well. For example, th
 
 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.
 
+## Comms
+
+Once you've shared the tmux session, you've got a lot. But you still need more bandwidth with your pair.
+
+There are a few solutions:
+
+- *Use inline comments* to type back and forth. Properly configured shells can also allow you to prefix with a `#` and say whatever you want. The downside is that only one person can be typing at any one time. A custom that helps is if you type what you're saying, then leave a trailing `#` with no space after it to indicate that you're done and waiting on your pair to type. This is a bit crufty, but some people are shy and only want to do the tmux share.
+- *Use IRC*. If you make a tmux pane and connect it to IRC (or some other text-based chat), both local users plus that shared session can all join the same channel. This provides the person that isn't driving the keyboard to switch to their local chat window and type something for the other person to see. (TODO: build this in as a tweemux feature).
+- *Use voice*. A much more powerful way to work. You "can" use Skype, but it's a commercial product and is continuously flaky. A better alternative is to sign up for a [SIP account](https://ekiga.net/), then get a [SIP client](https://en.wikipedia.org/wiki/List_of_SIP_software#Clients). For Linux, I use (Ekiga)[https://en.wikipedia.org/wiki/Ekiga), and for OS X I use [Telephone.app](http://www.tlphn.com/). Don't forget, if you can't get the Internetty stuff to work, there's always calling each other on cell phones.
+
 ## TODO
 
-    tweemux keys lwoodson # when their Github username == desired Unix username
-    # -or-
-    tweemux keys cirwin github: ConradIrwin
+# PeopleAdmin/tweemux open issues
+* 18: Rogue Mode 3
+* 17: Mention Google Voice/Hangouts 1
+* 16: Promote regular tmux session to tweemux
+* 15: Guest usage to connect to a different socket path
+* 14: Add pseudo_restart of 'retry'
+* 13: $TERM
+* 12: Mosh possible
+* 11: Basics of Tmux
+*  8: Port fw without ssh [enhancement] [question]
+*  7: adduser/useradd call [enhancement]
+*  6: Mac setup instructions [easy-peasy] [Mac]
+*  5: log [enhancement] [easy-peasy] [must-have]
+*  4: brew install someurl [Mac]
+*  1: --help and help [easy-peasy] [must-have]
 
 ## Thanks to
 

data/lib/tweemux/action/hubkey.rb

@@ -0,0 +1,45 @@
+class Tweemux::Action::Hubkey < Tweemux::Action
+  attr_reader :github_user, :unix_user
+  def run args
+    @unix_user, @github_user = args
+    @github_user ||= @unix_user
+    run_with_both_usernames
+  end
+
+  def run_with_both_usernames
+    ensure_ssh_dir_exists
+    refuse_to_overwrite_authorized_keys_file
+    install_github_keys
+  end
+
+  def ensure_ssh_dir_exists
+    explained_run_as unix_user, %W(mkdir -p -m700 #{home_dir}/.ssh),
+      "Make sure #{unix_user} has a ~/.ssh/ dir"
+  end
+
+  def refuse_to_overwrite_authorized_keys_file
+    return unless File.exists? authorized_keys_path
+    # TODO: some color
+    raise NoRestartsException, <<-EOT
+Refusing to overwrite #{authorized_keys_path}
+Try: sudo cat #{authorized_keys_path}
+Then maybe: sudo rm #{authorized_keys_path}
+    EOT
+  end
+
+  def install_github_keys
+    key_url = "https://github.com/#{github_user}.keys"
+    explained_run_as unix_user, %W(curl #{key_url} -o #{authorized_keys_path}),
+      "Download #{github_user}'s 'keyholes' from Github"
+  end
+
+  def home_dir
+    begin
+      their_dir = File.expand_path '~'+unix_user
+    rescue ArgumentError
+      raise NoSuchHomeDir
+    end
+  end
+
+  def authorized_keys_path; home_dir+'/.ssh/authorized_keys' end
+end

data/lib/tweemux/action.rb

@@ -9,12 +9,21 @@ class Tweemux
     end
 
     class FunkyUsage < RuntimeError; end
+    class NoSuchHomeDir < RuntimeError; end
+    class NoRestartsException < RuntimeError; end
 
     def run args; raise 'Unimplemented' end
 
-    # Hrm. This is kinda gross, but I feel like it cleans up the subclasses
-    def explained_run *a; self.class.explained_run *a end
-    def tmux_S *a; self.class.tmux_S *a end
+    # Hrm. These are kinda gross, but I feel like it cleans up the subclasses
+    def explained_run what, why
+      self.class.explained_run what, why
+    end
+    def explained_run_as who, what, why
+      self.class.explained_run_as who, what, why
+    end
+    def tmux_S *a
+      self.class.tmux_S *a
+    end
 
     class DubiousSystemInvocation < RuntimeError; end
     class << self
@@ -30,6 +39,11 @@ class Tweemux
             system_or_raise what
         end
 
+        def explained_run_as user, what, why
+          full_command = ['sudo', '-u', user] + what
+          explained_run full_command, why
+        end
+
         def explain what, why
           warn highlight_command(what) + highlight_explanation(why)
         end
@@ -81,6 +95,8 @@ To run anyway, hit: #{enter}
             require 'pry'
             binding.pry
           end
+        rescue Interrupt
+          exit 2
         end
 
         def load_all!

data/lib/tweemux/version.rb

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

data/lib/tweemux.rb

@@ -8,6 +8,9 @@ class Tweemux
     def run args
       action = understand args
       action.call
+    rescue Tweemux::Action::NoRestartsException => e
+      warn e.message.color :error
+      exit 1
     end
 
     def understand args

data/test/action_test_helper.rb

@@ -2,12 +2,17 @@ require_relative 'test_helper'
 
 module TweemuxActionHelper
   def test_run
+    assert_equal stubbed_run.to_yaml, expected_commands.to_yaml
+  end
+
+  def stubbed_run
     explained_runs = []
-    Tweemux::Action.stub :explained_run, -> *a { explained_runs << a } do
+    Tweemux::Action.stub :explained_run, -> what, why {
+      explained_runs << [ what, why ]
+    } do
       Tweemux.run argv
     end
-    got = explained_runs.map &:first
-    assert_equal got.to_yaml, expected_commands.to_yaml
+    explained_runs.map &:first # drop the explanations
   end
 
   def bad_runs; [] end

data/test/tweemux/action/hubkey_test.rb

@@ -0,0 +1,64 @@
+require_relative '../../action_test_helper'
+require 'ostruct'
+
+class Tweemux::Action::HubkeyTest < MiniTest::Unit::TestCase
+  include TweemuxActionHelper
+  def argv; %w(bro hi HiOnGithub) end
+  def test_run
+    commands_run = nil
+    with_fake_expand_path expecting: '~hi', expanding_to: '/home/hi' do
+      commands_run = stubbed_run
+    end
+    assert_equal %w(sudo -u hi mkdir -p -m700 /home/hi/.ssh),
+      commands_run.shift
+    assert_equal %W(
+      sudo -u hi
+        curl https://github.com/HiOnGithub.keys
+         -o /home/hi/.ssh/authorized_keys),
+      commands_run.shift
+    assert commands_run.empty?, commands_run
+  end
+
+  def test_run_will_not_clobber_auth_keys_file
+    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
+      end
+    end
+    fail "Shouldn't get here"
+  rescue Tweemux::Action::NoRestartsException => e
+    assert_match /refusing to overwrite.*authorized_keys/i, e.message
+  end
+
+  def with_fake_expand_path args
+    File.stub :expand_path, -> short_path {
+      assert_equal args[:expecting], short_path
+      args[:expanding_to]
+    } do yield end
+  end
+
+  def test_no_homedir
+    File.stub :expand_path, -> path { raise ArgumentError, 'no such user' } do
+      stubbed_run
+    end
+  rescue Tweemux::Action::NoSuchHomeDir
+  else
+    fail 'Should be noisy about missing users'
+  end
+
+  def test_shorthand_invocation
+    action = Tweemux::Action::Hubkey.new :unused
+    called = false
+    action.stub :run_with_both_usernames, -> {
+      called = true
+    } do
+      action.run 'a'
+    end
+    assert called
+    assert_equal 'a', action.unix_user
+    assert_equal 'a', action.github_user
+  end
+end

data/test/tweemux_test.rb

@@ -16,14 +16,19 @@ 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}`
-    end
+    got = `ruby18 -Ilib -rtweemux -e1`
+    fail "ruby18 hates us: #{got}" unless got.empty?
   rescue Errno::ENOENT => e
-    skip 'Needs ruby18 executable in $PATH' if e.message[/ruby18/]
+    # TODO: colorize
+    skip <<-EOT if e.message[/ruby18/]
+This test needs a 'ruby18' executable in $PATH
+If using rbenv, one such script might be:
+
+#!/bin/sh -e
+eval "$(rbenv init -)"
+rbenv shell 1.8.7-p371
+ruby "$@"
+    EOT
     raise e
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweemux
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies: []
 description: ! 'For Remote Pair Programming: A handy script to create-or-join a world-readable
   tmux session
 
 
-  For Remote Pair Programming: A handy script to create-or-join a world-readable tmux
-  session
-
-'
+  tweemux host; tweemux at some_machine; plus some more stuff'
 email: rking-tweemux@sharpsaw.org
 executables:
 - tweemux
@@ -40,7 +37,7 @@ files:
 - lib/tweemux/action/at.rb
 - lib/tweemux/action/forward.rb
 - lib/tweemux/action/host.rb
-- lib/tweemux/action/keys.rb
+- lib/tweemux/action/hubkey.rb
 - lib/tweemux/action/share.rb
 - lib/tweemux/core_ext.rb
 - lib/tweemux/version.rb
@@ -50,6 +47,7 @@ files:
 - test/tweemux/action/at_test.rb
 - test/tweemux/action/forward_test.rb
 - test/tweemux/action/host_test.rb
+- test/tweemux/action/hubkey_test.rb
 - test/tweemux/action/share_test.rb
 - test/tweemux/action_test.rb
 - test/tweemux_test.rb
@@ -60,17 +58,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -85,6 +83,7 @@ test_files:
 - test/tweemux/action/at_test.rb
 - test/tweemux/action/forward_test.rb
 - test/tweemux/action/host_test.rb
+- test/tweemux/action/hubkey_test.rb
 - test/tweemux/action/share_test.rb
 - test/tweemux/action_test.rb
 - test/tweemux_test.rb

data/lib/tweemux/action/keys.rb

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