pair 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - ree
+  - jruby
+  - rbx

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    pair (0.0.1)
-      httparty
+    pair (0.0.2)
+      httparty (~> 0.8.1)
 
 GEM
   remote: http://rubygems.org/
@@ -13,18 +13,20 @@ GEM
       multi_xml
     multi_json (1.0.3)
     multi_xml (0.4.1)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rake (0.9.2.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
+    rspec-mocks (2.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   pair!
-  rspec (~> 2.3.0)
+  rake
+  rspec (~> 2.7.0)

data/README.rdoc

@@ -11,15 +11,24 @@ Hosting Users:
 * Must have a variant of unix installed
 * Must have tmux installed
 
+== Installation
+Pair is available on {RubyGems}[http://rubygems.org/gems/pair]; the
+easiest way to install it is
+
+    gem install pair
+
 == Example
 
-=== Interactive hosted session
+=== Hosting an interactive session
+In interactive mode, participants can interact with the tmux session.
 
-bin/pairmill host -p<github-user>,<github-user>,<github-user>
+    pair host -p<github-user>,<github-user>,<github-user>
 
-=== Interactive hosted session
+=== Hosting a view-only session
+In view mode, participants can see your tmux session but may not
+interact with it.
 
-bin/pairmill host -v<github-user>,<github-user>,<github-user>
+    pair host -v<github-user>,<github-user>,<github-user>
 
 == Contributing to pair
  

data/bin/pair

@@ -2,6 +2,6 @@
 
 $: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require "pair/command_line"
-Pair::CommandLine.run!(ARGV)
+require "pair/cli"
+Pair::Cli.run!(ARGV)
 

data/lib/pair.rb

@@ -1,10 +1,9 @@
-require 'httparty'
-require 'ruby-debug' if ENV["DEBUGGER"] == "true"
+module Pair
+end
 
 require "pair/version"
+
+require "pair/os"
+require "pair/config"
 require "pair/api"
 require "pair/session"
-
-module Pair
-  # Your code goes here...
-end

data/lib/pair/api.rb

@@ -1,60 +1,39 @@
-require 'yaml'
+require 'httparty'
+require 'pair/config'
 
 module Pair
   module Api
-    def create_session(session)
-      post("/v1/sessions", {
-        :body => {
-          :session => {
-            :name         => session.name,
-            :viewers      => session.viewers,
-            :participants => session.participants,
-            :tunnel       => {
-              :host_login => session.host_login
-            }
-          }
-        }
-      })
-    end
-
-    def join_session(session)
-      options = { :query => { :name => session.name, :host => session.host, :format => "json" } }
-      get("/v1/sessions/search.json", options)
-    end
+    include HTTParty
+    extend self
 
-    def api_token
-      config[:api_token]
+    def setup
+      base_uri ENV['BASE_URI'] || 'api.pairmill.com'
+      default_params :api_token => Pair.config.api_token
+      yield
     end
 
-    def config
-      @config ||= if File.exists?(config_file)
-        YAML.load_file(config_file)[base_uri] || setup_config
-      else
-        setup_config
+    def create_session(session)
+      setup do
+        post("/v1/sessions", {
+          :body => {
+            :session => {
+              :name         => session.name,
+              :viewers      => session.viewers,
+              :participants => session.participants,
+              :tunnel       => {
+                :host_login => session.host_login
+              }
+            }
+          }
+        })
       end
     end
 
-    def config_file
-      File.expand_path("~/.pair.yml")
-    end
-
-    def setup_config
-      config = YAML.load_file(config_file) rescue {}
-
-      print "Please input your API token for #{base_uri}: "
-      config[base_uri] = {:api_token => $stdin.gets.chomp}
-
-      File.open(config_file, 'w') do |f|
-        f.write(YAML.dump(config))
+    def join_session(session)
+      setup do
+        options = { :query => { :name => session.name, :host => session.host, :format => "json" } }
+        get("/v1/sessions/search.json", options)
       end
-
-      config[base_uri]
     end
-
-    include HTTParty
-    extend self
-
-    base_uri ENV['BASE_URI'] || 'api.pairmill.com'
-    default_params :api_token => api_token
   end
 end

data/lib/pair/{command_line.rb → cli.rb}

@@ -1,8 +1,9 @@
 require "pair"
+require 'pair/cli/custom_errors'
 require "optparse"
 
 module Pair
-  class CommandLine
+  class Cli
     attr_accessor :arguments,  :options
     private       :arguments=, :options=
 
@@ -18,35 +19,44 @@ module Pair
     def run!
       case command = arguments.shift
       when 'host'
-        require "pair/command_line/host"
+        require "pair/cli/host"
         Host.run!(arguments)
+      when 'config'
+        require "pair/cli/config"
+        Config.run!(arguments)
       else
         unknown_command(command)
       end
+    rescue ApiTokenMissingError, EnableSSHError => error
+      handle_error error.message, false
     rescue SystemExit
       raise
     rescue
-      if $-d
+      handle_error "  Please contact support@pairmill.com, there\n" +
+                   "  was an issue creating your session.", $-d
+    end
+
+    private
+    def handle_error message, reraise = true
+      if reraise
+        raise
+      else
         STDOUT.puts "\n"
-        STDOUT.puts "  Please contact support@pairmill.com, there"
-        STDOUT.puts "  was an issue creating your session."
+        STDOUT.puts message
         STDOUT.puts "\n"
-      else
-        raise
       end
     end
 
-    private
     def unknown_command(command)
       puts "Unknown command: #{command}" if command
 
       #{$0} join [options]
       abort %Q[
-        Usage: #{$0} host [options]
+        Usage: #{$0.split("/").last} host [options]
 
         You can pass -h to a subcommand to learn more about it.
 
-          e.g. #{$0} join -h
+          e.g. #{$0.split("/").last} join -h
       ].gsub(/^ {0,9}/,'')
     end
 

data/lib/pair/cli/config.rb

@@ -0,0 +1,28 @@
+module Pair
+  class Cli
+    class Config < self
+      def run!
+        parse!
+
+        Pair.config(options)
+      end
+
+      def parse!
+        opts = parse do |opts|
+          opts.banner = "Usage: #{$0.split("/").last} config" +
+                        "\n\n" +
+                        "Options:" +
+                        "\n"
+
+          opts.on("--api-token KEY") do |key|
+            options[:api_token] = key
+          end
+
+#          opts.on("--enable-ssh") do
+#            options[:enable_ssh] = true
+#          end
+        end
+      end
+    end
+  end
+end

data/lib/pair/cli/custom_errors.rb

@@ -0,0 +1,6 @@
+module Pair
+  class Cli
+    class ApiTokenMissingError < StandardError; end
+    class EnableSSHError < StandardError; end
+  end
+end

data/lib/pair/{command_line → cli}/host.rb

@@ -1,16 +1,31 @@
-require "pair/command_line"
-
 module Pair
-  class CommandLine
+  class Cli
     class Host < self
       def run!
         parse!
-        Pair::Session.host(options)
+
+        with_valid_config do
+          Pair::Session.host(options)
+        end
+      end
+
+      def with_valid_config
+        config = Pair.config
+
+        unless config.api_token
+          raise ApiTokenMissingError.new("api-token is required. try --help to understand how")
+        end
+
+        unless config.ssh_enabled?
+          raise EnableSSHError.new("ssh is not enabled, turn on ssh daemon to continue")
+        end
+
+        yield
       end
 
       def parse!
         opts = parse do |opts|
-          opts.banner = "Usage: #{$0} host [-s SESSION_NAME] [-v PAIR[,PAIR[,...]] [-p PAIR[,PAIR[,...]]" +
+          opts.banner = "Usage: #{$0.split("/").last} host [-s SESSION_NAME] [-v PAIR[,PAIR[,...]] [-p PAIR[,PAIR[,...]]" +
                         "\n\n" +
                         "At least one PAIR (of any type must be defined). A PAIR takes the form of a Github username." +
                         "\n\n"+

data/lib/pair/config.rb

@@ -0,0 +1,96 @@
+require 'yaml/store'
+
+module Pair
+  HOST = ENV['HOST'] || "api.pairmill.com"
+
+  def self.config(options = nil)
+    config = Config.new(HOST, STDIN, STDOUT)
+    config.update(options) if options
+    config
+  end
+
+  class Config
+    attr_accessor :host, :input, :output
+
+    def initialize(host = HOST, input = STDIN, output = STDOUT)
+      self.host   = host
+      self.input  = input
+      self.output = output
+    end
+
+#    def api_token
+#      self[:api_token] ||= begin
+#        print "Please input your API token for Pair: "
+#        gets.chomp
+#      end
+#    end
+
+    def method_missing(method, *args, &block)
+      method = method.to_s
+
+      if method =~ /=$/ # setter
+        self[method.gsub(/=$/,'').to_sym] = [*args].first
+      else
+        self[method.to_sym] || super
+      end
+    end
+
+    def api_token
+      self[:api_token]
+    end
+
+    def enable_ssh
+      self[:enable_ssh]
+    end
+
+    def ssh_enabled?
+      if Pair::OS.x?
+        `systemsetup -getremotelogin`.match("Remote Login: On")
+      end
+    end
+
+    def update(options = {})
+      if options.is_a? Hash
+        options.each do |k,v|
+          config.transaction do
+            host_config[k] = v
+          end
+        end
+      end
+    end
+
+    protected
+    def [](key)
+      config.transaction do
+        host_config[key]
+      end
+    end
+
+    def []=(key, value)
+      config.transaction do
+        host_config[key] = value
+      end
+    end
+
+    # Must be called within a config transaction
+    def host_config
+      config[host] ||= {}
+    end
+
+    def config
+      @config ||= YAML::Store.new(config_file)
+    end
+
+    def config_file
+      File.join(ENV['HOME'], ".pair.yml")
+    end
+
+    def print(*args)
+      output.print(*args)
+    end
+
+    def gets(*args)
+      input.gets(*args)
+    end
+  end
+end

data/lib/pair/os.rb

@@ -0,0 +1,13 @@
+require 'rbconfig'
+
+module Pair
+  module OS
+    def linux?
+      !RbConfig::CONFIG['target_os'].match("linux").nil?
+    end
+
+    def self.x?
+      !RbConfig::CONFIG['target_os'].match("darwin").nil?
+    end
+  end
+end

data/lib/pair/session/authorized_keys_file.rb

@@ -9,8 +9,8 @@ module Pair
       attr_accessor :attach_command
       attr_accessor :key_file_path
 
-      def initialize(member_keys = {}, attach_command)
-        self.member_keys    = member_keys
+      def initialize(member_keys, attach_command)
+        self.member_keys    = member_keys || {}
         self.attach_command = attach_command
         self.key_file_path  = File.expand_path("~/.ssh/authorized_keys")
       end

data/lib/pair/version.rb

@@ -1,3 +1,3 @@
 module Pair
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/pair.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("httparty", "~> 0.8.1")
 
-  gem.add_development_dependency("rspec", "~> 2.3.0")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec", "~> 2.7.0")
 end

data/spec/pair/config_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'pair/config'
+
+describe Pair::Config do
+  let(:stdin)  { StringIO.new }
+  let(:stdout) { StringIO.new }
+  let(:host)   { "api.domain.com" }
+
+  let(:config) { described_class.new(host, stdin, stdout) }
+
+  before do
+    config_hash = {}
+    YAML::Store.stub!(:new => config_hash)
+    def config_hash.transaction
+      yield
+    end
+  end
+
+  context "for different hosts" do
+    it "has a different set of configs for each host" do
+      host1, host2 = "api.domain.com", "api.beta.domain.com"
+      config1 = described_class.new(host1)
+      config2 = described_class.new(host2)
+      config3 = described_class.new(host1)
+
+      config1.a_setting = "setting 1"
+      config2.a_setting = "setting 2"
+
+      config1.a_setting.should == "setting 1"
+      config3.a_setting.should == "setting 1"
+      config2.a_setting.should == "setting 2"
+    end
+  end
+
+  describe '#api_token' do
+#    context "when none is saved" do
+#      it "prompts for key to be entered" do
+#        response = "abc123"
+#        stdin << "#{response}\n"
+#        stdin.rewind
+#
+#        config.api_token.should == response
+#
+#        stdout.rewind
+#        stdout.read.should == "Please input your API token for Pair: "
+#      end
+#
+#      it "saves the key" do
+#        stdin.should_receive(:gets).once.and_return("abc123\n")
+#        config.api_token
+#        config.api_token
+#      end
+#    end
+
+    context "when one is already saved" do
+      it "returns the saved value" do
+        api_token = "abc123"
+        config.api_token = api_token
+        config.api_token.should == api_token
+      end
+    end
+  end
+end

data/spec/pair/session/authorized_keys_file_spec.rb

@@ -1,5 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
+require 'pair/session/authorized_keys_file'
 require 'fileutils'
 
 describe Pair::Session::AuthorizedKeysFile do

data/spec/spec_helper.rb

@@ -2,14 +2,17 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rspec'
-require 'json'
 require 'fixture_helper'
-require 'pair'
+
+require 'pair/config'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-
+  config.before do
+    # Never ask for API token in tests
+    Pair.stub!(:config => stub(:api_token => "xxxx"))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pair
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-27 00:00:00.000000000Z
+date: 2011-12-08 00:00:00.000000000 -06:00
+default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70298620262940 !ruby/object:Gem::Requirement
+  requirement: &2157594700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,18 +23,29 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70298620262940
+  version_requirements: *2157594700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157594280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157594280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70298620258860 !ruby/object:Gem::Requirement
+  requirement: &2157593740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70298620258860
+  version_requirements: *2157593740
 description: Effortless remote pairing
 email:
 - me@bjeanes.com
@@ -46,6 +58,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.rdoc
@@ -53,8 +66,12 @@ files:
 - bin/pair
 - lib/pair.rb
 - lib/pair/api.rb
-- lib/pair/command_line.rb
-- lib/pair/command_line/host.rb
+- lib/pair/cli.rb
+- lib/pair/cli/config.rb
+- lib/pair/cli/custom_errors.rb
+- lib/pair/cli/host.rb
+- lib/pair/config.rb
+- lib/pair/os.rb
 - lib/pair/session.rb
 - lib/pair/session/authorized_keys_file.rb
 - lib/pair/session/hosted_session.rb
@@ -66,8 +83,10 @@ files:
 - spec/fixtures/api_hosted_session.yml
 - spec/fixtures/api_joined_session.yml
 - spec/fixtures/user_keys.yml
+- spec/pair/config_spec.rb
 - spec/pair/session/authorized_keys_file_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://www.pairmill.com
 licenses: []
 post_install_message: 
@@ -88,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Pair with remote programmers with a single command.
@@ -97,5 +116,6 @@ test_files:
 - spec/fixtures/api_hosted_session.yml
 - spec/fixtures/api_joined_session.yml
 - spec/fixtures/user_keys.yml
+- spec/pair/config_spec.rb
 - spec/pair/session/authorized_keys_file_spec.rb
 - spec/spec_helper.rb