github-auth 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba2efedd769fc2ec5fc8aacfe3b4dc953bbb7452
-  data.tar.gz: 16c7b8ca303579763af15ad0a8a30da805f59708
+  metadata.gz: ae6c8829c44543ade8a4ee209b00af812e1282d4
+  data.tar.gz: b01479f59d0ee0626f6b8d53b0d5271b0c8d5115
 SHA512:
-  metadata.gz: afa9ef34522861aee155e9fcbb2bc6b86c68ebcd5df7631b3b203a38007ba4a39c0297ee4ab524a1f9226a55d636b6a3d436b984ecc13cb655e5af1a58614c31
-  data.tar.gz: 15977ad54d76b221cc83e6c1874fa3f4e527007b9a4a6d43e3012d626bea94f0dd63802f03a1a98303391884c61fbf40a86231b271ab09f021057df3859df4d6
+  metadata.gz: 7292a8368140bce7bac19bc704d0cccc0ddada1dbe3eeeb8603ac93907b1d294fd7facfac30069ff86776e2da31597bd025b1b15d10934ef701004633fa4bdcd
+  data.tar.gz: f79c42a9d9c078e168111a3ade0ada1362362c167dbaa793c5702ce297a4bcb72d230af3a1f1fbeceb483a318603ba63aa5991b5753a95cf17b11bf81f7c8f48

data/README.md

@@ -5,16 +5,19 @@
 
 ## Description
 
-If you decide to [`#pairwithme`](https://twitter.com/search?q=pairwithme),
-we'll probably be SSHing into my laptop, your laptop, or some laptop in the
-sky. Since I'd rather not send you a password over email or Skype, we'll use
-public key authentication.
+If you agree to [\#pairwithme](https://twitter.com/search?q=pairwithme), we'll
+probably be SSHing into my laptop, your laptop, or some laptop in the sky.
+Sharing passwords over email is no fun, so we'll use public key authentication
+to keep things fun, fast, and secure.
 
-`gh-auth` allows you to easily add and remove any Github user's public ssh keys
-from your [`authorized_keys`](http://en.wikipedia.org/wiki/Ssh-agent) file.
+`gh-auth` allows you to quickly add and remove any Github user's public ssh
+keys from your [`authorized_keys`](http://en.wikipedia.org/wiki/Ssh-agent)
+file.
 
-Let's say you'd like to pair with me. Awesome! To allow me to ssh into your
-machine, just run:
+Let's see how this works.
+
+After you've [installed](#installation) `gh-auth`, you can give me ssh access
+with:
 
 ```bash
 $ gh-auth add chrishunt
@@ -44,7 +47,7 @@ Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 ## Usage
 
 ```bash
-usage: gh-auth [add|remove] <username>
+usage: gh-auth [--version] [add|remove] <username>
 ```
 
 ## Installation
@@ -55,7 +58,7 @@ Install the `github-auth` gem:
 $ gem install github-auth
 
 $ gh-auth
-usage: gh-auth [add|remove] <username>
+usage: gh-auth [--version] [add|remove] <username>
 ```
 
 ### SSH Public Key Authentication (Mac OS X)
@@ -77,7 +80,7 @@ $ chmod 600 ~/.ssh/authorized_keys
 ### Verification
 
 If you'd like to verify that everything is working as expected, you can test
-right from your machine.
+locally on your own machine.
 
 First, authorized yourself for ssh. (Make sure to replace 'chrishunt' with
 *your* Github username)
@@ -87,8 +90,8 @@ $ gh-auth add chrishunt
 Adding 2 key(s) to '/Users/chris/.ssh/authorized_keys'
 ```
 
-Next, open an SSH session to your machine with public key authentication. It
-should work just fine.
+Now that your keys are added, verify that you can open an SSH session to your
+machine with public key authentication:
 
 ```bash
 $ ssh -o PreferredAuthentications=publickey localhost
@@ -96,15 +99,15 @@ $ ssh -o PreferredAuthentications=publickey localhost
 (localhost)$
 ```
 
-Now remove your public keys from the keys file:
+Next, remove your public keys from the keys file:
 
 ```bash
 $ gh-auth remove chrishunt
 Removing 2 key(s) from '/Users/chris/.ssh/authorized_keys'
 ```
 
-You should no longer be able to login to the machine since the keys have been
-removed.
+Since you've removed your keys, verify now that you can no longer login to your
+machine with public key authentication:
 
 ```bash
 $ ssh -o PreferredAuthentications=publickey localhost
@@ -112,11 +115,71 @@ $ ssh -o PreferredAuthentications=publickey localhost
 > Permission denied (publickey,keyboard-interactive)
 ```
 
+## Troubleshooting
+
+### How do people actually connect to my machine?
+
+Good question! Others will connect to your machine using ssh:
+
+```bash
+$ ssh username@external-ip-address
+```
+
+### What username do I use?
+
+The `username` is going to be the same username that you used to add the keys.
+In most cases, it's a good idea to create a new `pair` account and use that
+account for all pairings. You don't want strangers reading your email!
+
+Once you've created the pair account, you can switch to it yourself in a
+terminal with:
+
+```bash
+$ su - pair
+```
+
+### How do I get my external IP?
+
+You can get your external IP address with:
+
+```bash
+$ curl http://remote-ip.herokuapp.com
+```
+
+### It's still not working! :(
+
+In almost all cases, your laptop is not directly plugged into your modem.
+You're on a wirelress network or plugged directly into a router or switch. This
+means the external IP address that your pair is connecting to is not your
+machine, it's actually your router.
+
+You can tell your router to forward ssh connections to your machine by enabling
+[port forwarding](http://en.wikipedia.org/wiki/Port_forwarding). You will want
+to forward port `22` (ssh) to the local IP address of your machine.
+
+If port `22` is already forwarded to another machine or you want to change
+things up, you can have ssh listen on another port and have your pair connect
+with:
+
+```bash
+ssh -p <port> username@external-ip-address
+```
+
+### I can't enable port forwarding, my boss won't let me. Can I still pair?
+
+Yes! A nice solution to this is to have a machine **somewhere else** that both
+of you can ssh into. Place this machine on a network that you *do* have the
+ability to forward ports. Maybe this machine is at home, a friend's house, or
+at a company your worked for in the past that forgot to turn it off.
+
+If this isn't possible, then you can use a VPS provider like
+[Linode](http://www.linode.com) to setup a pairing machine in the cloud.
+
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes, with tests (`git commit -am 'Add some feature'`)
 4. Run the tests (`bundle exec rake spec`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request

data/Rakefile

@@ -1,9 +1,16 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'cane/rake_task'
 
 desc 'Run all tests'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = '--color --order random'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = '--color --order random'
+end
+
+desc 'Check code quality'
+Cane::RakeTask.new(:quality) do |task|
+  task.abc_max = 9
 end
 
 task default: :spec
+task default: :quality

data/github-auth.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'cane'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'thin'

data/lib/github/auth/cli.rb

@@ -1,4 +1,5 @@
 module Github::Auth
+  # Command Line Interface for parsing and executing commands
   class CLI
     attr_reader :command, :usernames
 

data/lib/github/auth/keys_client.rb

@@ -1,6 +1,7 @@
 require 'httparty'
 
 module Github::Auth
+  # Client for fetching public SSH keys using the Github API
   class KeysClient
     attr_reader :username, :hostname
 

data/lib/github/auth/keys_file.rb

@@ -1,4 +1,5 @@
 module Github::Auth
+  # Write and delete keys from the authorized_keys file
   class KeysFile
     attr_reader :path
 

data/lib/github/auth/version.rb

@@ -1,5 +1,5 @@
 module Github
   module Auth
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-auth
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Chris Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement