sc_tmux 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+results.html
+pkg
+html

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sc_tmux.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    sc_tmux (0.0.1)
+      methadone (~> 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.10)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    json (1.8.1)
+    methadone (1.3.1)
+      bundler
+    multi_json (1.8.2)
+    multi_test (0.0.2)
+    rake (0.9.6)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.3)
+  rake (~> 0.9.2)
+  rdoc
+  rspec
+  sc_tmux!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aaron Nichols
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# ScTmux
+
+### Problem
+When I run tmux on a remote host I lose access to my ssh-agent if I
+detach and attach again. Existing windows have old ssh-agent environment
+values. I also like to have my tmux windows named by the host I'm
+connecting to. This gem resolves those two problems.
+
+### Solution
+This script started as a set of bash scripts which made it easier to
+refresh ssh-agent info on existing tmux windows. These are now
+implemented as a gem which installs an 'sc' binary.
+
+sc has a number of features:
+
+- Collect ssh-agent vars to a file for use in other operations
+- make current ssh-agent vars available to eval in a new shell
+- Set the title on new tmux windows when you ssh to a host (requires you
+  use 'sc' instead of 'ssh')
+- create new tmux sessions or attach to existing ones, runs sc -g
+  automatically when re-attaching
+
+## Installation
+
+Installation is simple:
+
+    $ gem install sc_tmux
+
+## Usage
+sc is run both with arguments to interact with tmux & your shell as well
+as run as an ssh replacement. 
+
+### SSH Replacement
+When run as an ssh replacement it simply
+pulls the current ssh-agent vars into the shell (`sc -f`), outputs the
+result of `which ssh` to show which ssh binary is being run and then
+opens a new tmux window named after the hostname you specify to ssh to
+the host. 
+
+Example:
+
+    $ sc somehost
+
+or
+
+    $ sc username@somehost
+
+### Options
+
+`-g` Grab SSH
+
+This stores the current ssh-agent vars to a file for later use. This
+happens automatically if you use the `--attach` option. You may also run
+it just before re-attaching to your tmux session. 
+
+For example, I use tmuxinator, so I have the following alias:
+`alias mux='sc -g && mux'`
+
+`-f` Fix SSH
+
+This will output the current values stored by the `-g` option.
+Unfortunately it's really only useful when used inside an alias because
+you need to eval the contents of the file - thus I usually add the
+following alias:
+
+`alias fixssh='eval $(sc -f)'`
+
+Then when you want to 'fix' ssh inside a pre-existing tmux window you
+just type `fixssh`.
+
+`-s` Setup
+
+This is just a convenience method that outputs the fix alias above so
+you can easily add it to your setup.
+
+`-a` Attach
+
+This will first store the current ssh-agent vars and then will attempt
+to attach to an existing tmux session. This assumes a tmux session
+exists with the same name as is passed by the `-n` parameter ('prod' by
+default)
+
+`-c` Create
+
+This will create a new tmux session using the configured session name if
+one doesn't already exist.  
+
+`-n` Socket Name
+
+This will use the specified socket name when starting tmux - this allows
+you to have multiple tmux sessions attached to different sockets.
+
+`--agent_file` Agent file
+
+This is the name of the file used to store the ssh-agent var values. By
+default this filename is based on your hostname (to be compatible w/
+shared home directories) and is listed in the help output. 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add your tests, then add your new awesomeness
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/README.rdoc

@@ -0,0 +1,19 @@
+= sc_tmux - DESCRIBE YOUR GEM
+
+Author::  YOUR NAME (YOUR EMAIL)
+Copyright:: Copyright (c) 2013 YOUR NAME
+
+
+DESCRIBE YOUR GEM HERE
+
+== Links
+
+* {Source on Github}[LINK TO GITHUB]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing
+

data/Rakefile

@@ -0,0 +1,66 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+begin
+  require 'rspec/core/rake_task'
+rescue LoadError
+  dump_load_path
+  raise
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+
+  rd.main = "README.rdoc"
+
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:spec,:features]
+

data/bin/sc

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'sc_tmux.rb'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do # Add args you want: |like,so|
+    # your program code here
+    # You can access CLI options via
+    # the options Hash
+  end
+
+  # supplemental methods here
+
+  # Declare command-line interface here
+
+  # description "one line description of your app"
+  #
+  # Accept flags via:
+  # on("--flag VAL","Some flag")
+  # options[flag] will contain VAL
+  #
+  # Specify switches via:
+  # on("--[no-]switch","Some switch")
+  #
+  # Or, just call OptionParser methods on opts
+  #
+  # Require an argument
+  # arg :some_arg 
+  #
+  # # Make an argument optional
+  # arg :optional_arg, :optional
+
+  version ScTmux::VERSION
+
+  use_log_level_option
+
+  go!
+end

data/features/sc_tmux.feature

@@ -0,0 +1,76 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "sc"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+      |--create|
+      |--attach|
+      |--fix|
+      |--grab|
+      |--name|
+      |--agent_file|
+
+  Scenario: App provides help with no arguments
+    When I run `sc`
+    Then the exit status should be 64
+    And the banner should be present
+    And the output should contain "We expect a HOST if no options are passed"
+
+  Scenario: Grab gets variables
+    Given I set the environment variables to:
+      | SSH_CLIENT     | foo  |
+      | SSH_TTY        | bar  |
+      | SSH_AUTH_SOCK  | derp |
+      | SSH_CONNECTION | perp |
+    When I run `sc -g`
+    Then the exit status should be 0
+
+  Scenario: Grab gets variables to a custom agent_file
+    Given I set the environment variables to:
+      | SSH_CLIENT     | foo  |
+      | SSH_TTY        | bar  |
+      | SSH_AUTH_SOCK  | derp |
+      | SSH_CONNECTION | perp |
+    When I run `sc -g --agent_file .ag_file_test`
+    Then the exit status should be 0
+    And the file ".ag_file_test" should contain:
+    """
+    SSH_CLIENT="foo"
+    SSH_TTY="bar"
+    SSH_AUTH_SOCK="derp"
+    SSH_CONNECTION="perp"
+    """
+
+  Scenario: Fix outputs variables
+    Given a file named ".ag_file_test" with:
+    """
+    SSH_CLIENT="bark"
+    SSH_TTY="meow"
+    SSH_AUTH_SOCK="oink"
+    SSH_CONNECTION="caw"
+    """
+    When I run `sc -f --agent_file .ag_file_test`
+    Then the output should contain:
+    """
+    SSH_CLIENT="bark"
+    SSH_TTY="meow"
+    SSH_AUTH_SOCK="oink"
+    SSH_CONNECTION="caw"
+    """
+
+  Scenario: Setup outputs alias
+    When I run `sc -s`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Add the following alias to wherever you keep aliases:
+    alias fixssh='eval $(sc -f)'
+    """
+

data/features/step_definitions/sc_tmux_steps.rb

@@ -0,0 +1,8 @@
+# Put your step definitions here
+Given(/^I set the environment variables to:$/) do |table|
+  # table is a Cucumber::Ast::Table
+  data = table.rows_hash
+  data.each do |key, value|
+    ENV[key] = value
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/sc_tmux/version.rb

@@ -0,0 +1,3 @@
+module ScTmux
+  VERSION = "0.0.1"
+end

data/lib/sc_tmux.rb

@@ -0,0 +1,80 @@
+require "sc_tmux/version"
+
+module ScTmux
+  class Sc
+    include Methadone::Main
+    include Methadone::CLILogging
+    include Methadone::SH
+    version(ScTmux::VERSION)
+
+    main do |host|
+      if options[:grab]
+        grab
+      elsif options[:fix]
+        fix
+      elsif options[:create]
+        create
+      elsif options[:attach]
+        attach
+      elsif options[:setup]
+        setup
+      elsif host
+        ssh(host)
+      else
+        help_now!("We expect a HOST if no options are passed")
+      end
+
+    end
+
+    description "Reattach tmux windows to ssh-agent"
+    # Defaults
+    options[:agent_file] = "#{ENV['HOME']}/.sc_agent_info-#{%x[hostname -s].chomp}"
+    options[:name] = "prod"
+
+    arg :host, :optional, "Hostname for ssh connections"
+    on("-g", "--grab", "Grab current SSH Env vars")
+    on("-c", "--create", "Create new tmux session")
+    on("-a", "--attach", "Attach to existing tmux session")
+    on("-f", "--fix", "Output vars suitable for eval to fixup current shell")
+    on("-s", "--setup", "Show pasties for final setup")
+    on("--agent_file FILENAME", "Alternate file to store agent file")
+    on("-n NAME", "--name", "Socket name to use for tmux")
+
+    def self.setup
+      puts "Add the following alias to wherever you keep aliases:"
+      puts "alias fixssh='eval $(sc -f)'"
+    end
+
+    def self.grab
+      File.unlink(options[:agent_file]) if File.exist?(options[:agent_file])
+      f = File.new(options[:agent_file], "w")
+
+      %w(SSH_CLIENT SSH_TTY SSH_AUTH_SOCK SSH_CONNECTION).each do |var|
+        f.write("#{var}=\"#{ENV[var]}\"\n")
+      end
+      f.close
+    end
+
+    def self.fix
+      puts File.read(options[:agent_file])
+    end
+
+    def self.ssh(host)
+      which_ssh = `which ssh`.chomp
+      display_host = /(.+@)?(([0-9]+\.){3}[0-9]+|([^.]+))/.match(host)[2]
+      sh("tmux new-window -n #{display_host} \"echo 'Using: #{which_ssh}' ; . #{options[:agent_file]} ; ssh -A #{host}\"")
+    end
+
+    def self.create
+      grab
+      sh("tmux -L #{options[:name]}")
+    end
+
+    def self.attach
+      grab
+      sh("tmux -L #{options[:name]} attach")
+    end
+
+    go!
+  end
+end

data/sc_tmux.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sc_tmux/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sc_tmux"
+  spec.version       = ScTmux::VERSION
+  spec.authors       = ["Aaron Nichols"]
+  spec.email         = ["anichols@trumped.org"]
+  spec.description   = %q{Make a remote tmux play well with ssh-agent}
+  spec.summary       = %q{Make a remote tmux play well with ssh-agent}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('aruba')
+  spec.add_development_dependency('rake', '~> 0.9.2')
+  spec.add_dependency('methadone', '~> 1.3.1')
+  spec.add_development_dependency('rspec')
+end

data/spec/something_spec.rb

@@ -0,0 +1,5 @@
+describe "TestSomething" do
+  it "should be true" do
+    true.should be_true
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: sc_tmux
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make a remote tmux play well with ssh-agent
+email:
+- anichols@trumped.org
+executables:
+- sc
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- bin/sc
+- features/sc_tmux.feature
+- features/step_definitions/sc_tmux_steps.rb
+- features/support/env.rb
+- lib/sc_tmux.rb
+- lib/sc_tmux/version.rb
+- sc_tmux.gemspec
+- spec/something_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+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
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Make a remote tmux play well with ssh-agent
+test_files:
+- features/sc_tmux.feature
+- features/step_definitions/sc_tmux_steps.rb
+- features/support/env.rb
+- spec/something_spec.rb