octonaut 0.0.2 → 0.1.0

data/README.md

@@ -6,15 +6,15 @@ A little CLI sugar for the GitHub API, built with [gli][] and [Octokit][].
 
 ### Why not `hub`?
 
-[hub][] is great, you should use it. But hub focuses mostly on smoothing the
+[hub][] is great, you should use it; however, `hub` primarily focuses on smoothing the
 git workflow for GitHub and most commands are in the context of a GitHub
 repository.
 
-Octonaut is more general purpose CLI for the GitHub API. Oh and [plugins][].
+Octonaut is a more general-purpose CLI for the GitHub API. Oh, and [plugins][].
 
 ### Installation
 
-Install via Rubygems:
+Install via RubyGems:
 
 ```
 gem install octonaut
@@ -33,24 +33,32 @@ GLOBAL OPTIONS
     -a, --[no-]auto_traversal      - Automatically fetch all pages of paginated results
     --help                         - Show this message
     -n, --[no-]netrc               - Use .netrc file for authentication
+    --netrc-file=arg               - .netrc file for authentication (default: none)
     -p, --password=arg             - GitHub password (default: ********)
     -t, --oauth_token, --token=arg - GitHub API token (default: ********)
     -u, --login=arg                - GitHub login (default: none)
 
 COMMANDS
-    browse              - Browse resource on github.com
-    follow              - Follow a user
-    followers           - View followers for a user
-    following           - View who a user is following
-    follows             - Check to see if a user follows another
-    help                - Shows a list of commands or help for one command
-    langs, languages    - Display languages for a repo
-    me                  - View your profile
-    repo, repository    - Display details for a repository
-    repos, repositories - List repositories for a user or organization
-    say                 - An plugin method
-    unfollow            - Unfollow a user
-    user, whois         - View profile for a user
+    archive_link           - Get repository tarball or zipball archive URL
+    authorize              - Create and store an API token using username and password
+    browse                 - Browse resource on github.com
+    contents               - Get repository contents
+    follow                 - Follow a user
+    followers              - View followers for a user
+    following              - View who a user is following
+    follows                - Check to see if a user follows another
+    help                   - Shows a list of commands or help for one command
+    initconfig             - Initialize the config file using current global options
+    langs, languages       - Display languages for a repo
+    markdown, md           - Convert markdown to HTML
+    me                     - View your profile
+    readme                 - View README for repository
+    repo, repository       - Display details for a repository
+    repos, repositories    - List repositories for a user or organization
+    scopes                 - List scopes for a token
+    tokens, authorizations - Manage tokens
+    unfollow               - Unfollow a user
+    user, whois            - View profile for a user
 ```
 
 View a user's profile:
@@ -123,13 +131,26 @@ $ octonaut unfollow pengwynn
 Unfollowed pengwynn.
 ```
 
+Convert some markdown:
+```
+$ octonaut markdown "# Header #"
+<h1>Header</h1>
+```
+Convert markdown using STDIN
+```
+$ echo "Fixed in #3 " | be bin/octonaut markdown -c pengwynn/octonaut
+<p>Fixed in <a href="https://github.com/pengwynn/octonaut/issues/3" class="issue-link" title="authorize command">#3</a> </p>"
+```
+
+... and [much more][commands].
+
 ## Extend with plugins
 
 Octonaut makes it simple to extend the CLI with new commands just by adding
 some Ruby files to `~/.octonaut/plugins`:
 
 ```
-$ cat ~/.octonaut/plugins/test.rb
+$ cat ~/.octonaut_plugins/test.rb
 module Octonaut
 
   desc 'An plugin method'
@@ -141,6 +162,7 @@ module Octonaut
   end
 end
 
+$ export OCTONAUT_PLUGINS_PATH=~./octonaut_plugins
 $ octonaut say "hello from plugins"
 
            MMM.           .MMM
@@ -182,3 +204,4 @@ Copyright (c) 2013 Wynn Netherland. See [LICENSE][] for details.
 [t]: https://github.com/sferik/t
 [sferik]: https://github.com/sferik
 [LICENSE]: https://github.com/pengwynn/octonaut/blob/master/LICENSE.md
+[commands]: https://github.com/pengwynn/octonaut/tree/master/lib/octonaut/commands

data/lib/octonaut.rb

@@ -1,5 +1,6 @@
 require 'csv'
 require 'gli'
+require 'highline/import'
 require 'launchy'
 require 'octokit'
 require 'octonaut/printer'
@@ -11,15 +12,31 @@ module Octonaut
   extend Octonaut::Printer
   extend Octonaut::Helpers
 
+  def self.config_path
+    path = if ENV['OCTONAUT_ENV'] == 'TEST'
+      'tmp/fakehome'
+    else
+      ENV['HOME']
+    end
+
+    File.expand_path(File.join(path, '.octonaut'))
+  end
+
   program_desc 'Octokit-powered CLI for GitHub'
   commands_from 'octonaut/commands'
-  commands_from File.join(ENV['HOME'], '.octonaut', 'plugins')
+  if plugins_path = ENV['OCTONAUT_PLUGINS_PATH']
+    commands_from File.expand_path(plugins_path)
+  end
 
+  config_file Octonaut.config_path
 
   desc 'Use .netrc file for authentication'
   default_value false
   switch [:n, :netrc]
 
+  desc '.netrc file for authentication'
+  flag "netrc-file"
+
   desc 'GitHub login'
   flag [:u, :login]
   desc 'GitHub password'
@@ -58,9 +75,20 @@ module Octonaut
   end
 
   def self.client(global, options)
-    opts = global.merge(options).
+    opts = global
+    netrc_path = global.delete("netrc-file")
+    opts[:netrc] = netrc_path if netrc_path
+    # drop OAuth token if basic auth is present
+    if (opts['login'] && opts['password']) || opts[:netrc]
+      %w(t token oauth_token).each do |k|
+        opts.delete(k)
+        opts.delete(k.to_sym)
+      end
+    end
+    opts.merge!(options).
       select {|k, v| Octokit::Configuration::VALID_OPTIONS_KEYS.include?(k) }
     Octokit::Client.new(opts)
   end
 
+
 end

data/lib/octonaut/commands/authorizations.rb

@@ -0,0 +1,54 @@
+module Octonaut
+
+  desc "Create and store an API token using username and password"
+  command :authorize do |c|
+    c.action do |global,options,args|
+      username = ask("GitHub username:      ")
+      password = ask("Enter your password:  ") { |q| q.echo = false }
+
+      client = Octokit::Client.new :login => username, :password => password
+      authorization = client.create_authorization :scopes => []
+
+      if File.readable?(Octonaut.config_path)
+        config = YAML::load_file(Octonaut.config_path)
+        File.open(Octonaut.config_path, 'w') do |out|
+          %w(t token oauth_token).each do |key|
+            config.delete(key)
+            config.delete(key.to_sym)
+          end
+          config[:t] = authorization.token
+          YAML.dump(config, out)
+        end
+      else
+        Octonaut.run ["-t", authorization.token, "initconfig"]
+      end
+    end
+  end
+
+  desc "Manage tokens"
+  command [:tokens, :authorizations] do |c|
+    c.default_command :ls
+
+    c.desc "List GitHub API tokens"
+    c.command [:ls, :list] do |ls|
+      ls.action do |global,options,args|
+        raise ArgumentError.new "Basic Authentication required" unless @client.authenticated?
+
+        ls_tokens @client.authorizations
+      end
+    end
+
+  end
+
+  desc "List scopes for a token"
+  arg_name "token"
+  command :scopes do |c|
+    c.action do |global,options,args|
+      token = args.shift
+
+      raise ArgumentError.new "Token required" unless token
+
+      puts (Octokit.scopes(token).join(', '))
+    end
+  end
+end

data/lib/octonaut/commands/contents.rb

@@ -0,0 +1,70 @@
+module Octonaut
+
+  desc "View README for repository"
+  arg_name "repo"
+  command :readme do |c|
+    c.desc "Output format"
+    c.flag [:f, :format]
+    c.desc "Ref (branch name or commit SHA)"
+    c.flag [:ref]
+    c.action do |global,options,args|
+
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      format = options[:f] || "raw"
+
+      opts = {}
+      opts[:ref] = options[:ref] if options[:ref]
+      opts[:accept] = "application/vnd.github.#{format}"
+
+      puts @client.readme repo, opts
+    end
+
+  end
+
+  desc "Get repository contents"
+  arg_name "repo"
+  arg_name "path"
+  command :contents do |c|
+    c.desc "Output format"
+    c.flag [:f, :format]
+    c.desc "Ref (branch name or commit SHA)"
+    c.flag [:ref]
+    c.action do |global,options,args|
+
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      format = options[:f] || "raw"
+
+      opts = {}
+      opts[:ref]    = options[:ref] if options[:ref]
+      opts[:path]   = args.shift
+      opts[:accept] = "application/vnd.github.#{format}"
+
+      puts @client.contents repo, opts
+    end
+  end
+
+  desc "Get repository tarball or zipball archive URL"
+  arg_name "repo"
+  command :archive_link do |c|
+    c.desc "Archive format"
+    c.default_value "tar"
+    c.flag [:f, :format]
+    c.desc "Ref (branch name or commit SHA)"
+    c.default_value "master"
+    c.flag [:ref]
+    c.action do |global,options,args|
+
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      opts = {}
+      opts[:format] = "#{options[:format]}ball"
+      opts[:ref]    = options[:ref]
+      print @client.archive_link repo, opts
+    end
+  end
+end

data/lib/octonaut/commands/markdown.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module Octonaut
+
+  desc "Convert markdown to HTML"
+  arg_name 'string'
+  command [:markdown, :md] do |c|
+    MODE_OPTS = %w(gfm markdown)
+    c.desc "Render markdown in plain 'markdown' or 'gfm'"
+    c.default_value 'gfm'
+    c.flag [:m, :mode]
+
+    c.desc "The repository context for 'gfm' mode"
+    c.flag [:c, :context]
+
+    c.action do |global,options,args|
+      raise ArgumentError.new "Valid mode options are #{MODE_OPTS.join(', ')}" unless MODE_OPTS.include? options[:mode]
+
+      src  = args.shift
+      src  = $stdin.gets if src.nil?
+      opts = {}
+      if mode = options.fetch(:mode, nil)
+        opts[:mode] = mode
+      end
+      if context = options.fetch(:context, nil)
+        opts[:context] = context
+      end
+      response = @client.markdown src, opts
+
+      puts response
+    end
+  end
+end

data/lib/octonaut/printer.rb

@@ -1,11 +1,13 @@
+require 'octonaut/printers/authorizations'
 require 'octonaut/printers/organizations'
 require 'octonaut/printers/users'
 require 'octonaut/printers/repositories'
 
 module Octonaut
   module Printer
-    include Octonaut::Printers::Users
+    include Octonaut::Printers::Authorizations
     include Octonaut::Printers::Repositories
+    include Octonaut::Printers::Users
 
     def print_table(data)
       data.each { | key, value | puts "#{key.rjust(data.keys.map(&:length).max)} #{value}" }

data/lib/octonaut/printers/authorizations.rb

@@ -0,0 +1,11 @@
+module Octonaut
+  module Printers
+    module Authorizations
+
+      def ls_authorizations(authorizations, options = {})
+        authorizations.each {|a| puts "#{a.token}   #{a.scopes.join(',')}   #{a.app.name}" }
+      end
+      alias_method :ls_tokens, :ls_authorizations
+    end
+  end
+end

data/lib/octonaut/version.rb

@@ -1,3 +1,3 @@
 module Octonaut
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/octonaut.gemspec

@@ -19,7 +19,8 @@ spec = Gem::Specification.new do |s|
   s.executables << 'octonaut'
   s.add_dependency('gli','~> 2.5.5')
   s.add_dependency('octokit', '~> 1.22.0')
-  s.add_dependency('launchy')
+  s.add_dependency('launchy', '~> 2.2.0')
+  s.add_dependency('highline', '~> 1.6.15')
   s.add_development_dependency('rake')
   s.add_development_dependency('rdoc')
   s.add_development_dependency('guard-cucumber')

data/spec/authorizations_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Octonaut do
+
+  context "authorizations" do
+
+    it "lists tokens" do
+      request = stub_get("https://defunkt:il0veruby@api.github.com/authorizations").
+        to_return(json_response("tokens.json"))
+
+      Octonaut.run %w(-u defunkt -p il0veruby tokens)
+
+      expect($stdout.string).to eq(fixture('tokens.ls').read)
+    end
+
+    it "displays scopes for a token" do
+
+      request = stub_get("https://@api.github.com/user").
+        with(:headers => {"Authorization" => "token e46e749d1c727ff18b7fa403e924e58407fd9ac7"}).
+        to_return(json_response("user.json", {"X-OAuth-Scopes" => "repo, user"}))
+
+      Octonaut.run %w(scopes e46e749d1c727ff18b7fa403e924e58407fd9ac7 )
+
+      expect($stdout.string).to include("repo, user")
+
+    end
+
+    xit "creates a token" do
+      request = stub_post("https://defunkt:il0veruby@api.github.com/authorizations").
+        with(:body => {"scopes" => ["repo", "user"]}).
+        to_return(json_response("token.json"))
+
+
+      Octonaut.run %w(-u defunkt -p il0veruby tokens create -s repo user)
+      expect($stdout.string).to include("e46e749d1c727ff18b7fa403e924e58407fd9ac7")
+    end
+
+    xit "updates a token" do
+      # wait on hypermedia Octokit
+    end
+
+    xit "deletes a token" do
+      # wait on hypermedia Octokit
+    end
+  end
+
+end

data/spec/contents_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Octonaut do
+
+  context "contents" do
+
+    it "displays the src for a README" do
+      request = stub_get("/repos/pengwynn/octonaut/readme").
+        to_return(:headers => {"Content-Type" => "application/vnd.github.raw; charset=utf-8"},
+                  :body => fixture("readme.src"))
+
+      Octonaut.run %w(readme pengwynn/octonaut)
+
+      expect(request).to have_been_made
+      expect($stdout.string).to eq(fixture('readme.src').read)
+    end
+
+    it "displays a rendered README in HTML" do
+      request = stub_get("/repos/pengwynn/octonaut/readme").
+        to_return(:headers => {"Content-Type" => "application/vnd.github.html; charset=utf-8"},
+                  :body => fixture("readme.html"))
+
+      Octonaut.run %w(readme -f html pengwynn/octonaut)
+
+      expect(request).to have_been_made
+      expect($stdout.string).to eq(fixture('readme.html').read)
+    end
+
+    it "renders a README on a ref" do
+      Octokit::Client.any_instance.should_receive(:readme).
+        with("pengwynn/octonaut", :ref => "some-branch", :accept => "application/vnd.github.html")
+
+      Octonaut.run %w(readme -f html --ref some-branch pengwynn/octonaut)
+    end
+
+    xit "renders a directory tree of repository contents" do
+      # need more smarts in Octokit for this
+    end
+
+    it "gets contents of a file" do
+      request = stub_get("/repos/pengwynn/octonaut/contents/README.md").
+        to_return(:headers => {"Content-Type" => "application/vnd.github.raw; charset=utf-8"},
+                  :body => fixture("readme.src"))
+
+      Octonaut.run %w(contents pengwynn/octonaut README.md)
+
+      expect(request).to have_been_made
+      expect($stdout.string).to eq(fixture('readme.src').read)
+    end
+
+    it "gets an archive link" do
+      url = "https://nodeload.github.com/pengwynn/octonaut/legacy.zip/master"
+      Octokit::Client.any_instance.should_receive(:archive_link).
+        with("pengwynn/octonaut", :format => "zipball", :ref => "master").
+        and_return(url)
+
+      Octonaut.run %w(archive_link -f zip pengwynn/octonaut)
+      expect($stdout.string).to eq(url)
+
+    end
+
+  end
+
+end

data/spec/fixtures/gfm.html

@@ -0,0 +1 @@
+<h1>Test</h1>

data/spec/fixtures/markdown.html

@@ -0,0 +1,2 @@
+<h1>
+<a name="test" class="anchor" href="#test"><span class="mini-icon mini-icon-link"></span></a>Test</h1>

data/spec/fixtures/readme.html

@@ -0,0 +1,187 @@
+<div class="announce instapaper_body md" data-path="README.md" id="readme"><article class="markdown-body entry-content" itemprop="mainContentOfPage"><h1>
+<a name="octonaut" class="anchor" href="#octonaut"><span class="mini-icon mini-icon-link"></span></a>Octonaut</h1>
+
+<p>A little CLI sugar for the GitHub API, built with <a href="https://github.com/davetron5000/gli">gli</a> and <a href="https://github.com/pengwynn/octokit">Octokit</a>.</p>
+
+<p><strong>Still early. Rapidly evolving.</strong> Why not <a href="https://github.com/pengwynn/octonaut/blob/master/CONTRIBUTING.md">help out</a>?</p>
+
+<h3>
+<a name="why-not-hub" class="anchor" href="#why-not-hub"><span class="mini-icon mini-icon-link"></span></a>Why not <code>hub</code>?</h3>
+
+<p><a href="https://github.com/defunkt/hub">hub</a> is great, you should use it; however, <code>hub</code> primarily focuses on smoothing the
+git workflow for GitHub and most commands are in the context of a GitHub
+repository.</p>
+
+<p>Octonaut is a more general-purpose CLI for the GitHub API. Oh, and <a href="#extend-with-plugins">plugins</a>.</p>
+
+<h3>
+<a name="installation" class="anchor" href="#installation"><span class="mini-icon mini-icon-link"></span></a>Installation</h3>
+
+<p>Install via RubyGems:</p>
+
+<pre><code>gem install octonaut
+</code></pre>
+
+<h3>
+<a name="example-usage" class="anchor" href="#example-usage"><span class="mini-icon mini-icon-link"></span></a>Example usage</h3>
+
+<pre><code>$ octonaut
+NAME
+    octonaut - Octokit-powered CLI for GitHub
+
+SYNOPSIS
+    octonaut [global options] command [command options] [arguments...]
+
+GLOBAL OPTIONS
+    -a, --[no-]auto_traversal      - Automatically fetch all pages of paginated results
+    --help                         - Show this message
+    -n, --[no-]netrc               - Use .netrc file for authentication
+    --netrc-file=arg               - .netrc file for authentication (default: none)
+    -p, --password=arg             - GitHub password (default: ********)
+    -t, --oauth_token, --token=arg - GitHub API token (default: ********)
+    -u, --login=arg                - GitHub login (default: none)
+
+COMMANDS
+    browse              - Browse resource on github.com
+    follow              - Follow a user
+    followers           - View followers for a user
+    following           - View who a user is following
+    follows             - Check to see if a user follows another
+    help                - Shows a list of commands or help for one command
+    initconfig          - Initialize the config file using current global options
+    langs, languages    - Display languages for a repo
+    me                  - View your profile
+    repo, repository    - Display details for a repository
+    repos, repositories - List repositories for a user or organization
+    unfollow            - Unfollow a user
+    user, whois         - View profile for a user
+</code></pre>
+
+<p>View a user's profile:</p>
+
+<pre><code>$ octonaut whois cloudhead
+       ID 40774
+   JOINED 2008-12-16T15:09:49Z
+    LOGIN cloudhead
+     NAME Alexis Sellier
+  COMPANY SoundCloud, Ltd.
+ LOCATION Berlin
+FOLLOWERS 2347
+FOLLOWING 48
+ HIREABLE true
+      URL http://twitter.com/cloudhead
+</code></pre>
+
+<p>Browse a user on github.com in your default browser:</p>
+
+<pre><code>$ octonaut browse cloudhead
+</code></pre>
+
+<p>List followers:</p>
+
+<pre><code>$ octonaut followers pengwynn
+krisbulman
+camdub
+cglee
+nextmat
+zachinglis
+seaofclouds
+njonsson
+davidnorth
+polomasta
+webiest
+mchelen
+brogers
+marclove
+adamstac
+marshall
+asenchi
+piyush
+rmetzler
+nileshtrivedi
+sferik
+jimmybaker
+jnunemaker
+peterberkenbosch
+leah
+jakestutzman
+nkabbara
+etagwerker
+vagostino
+johan--
+bry4n
+...
+</code></pre>
+
+<p>Follow a user:</p>
+
+<pre><code>$ octonaut follow linus
+Followed linus.
+</code></pre>
+
+<p>Unfollow a user:</p>
+
+<pre><code>$ octonaut unfollow pengwynn
+Unfollowed pengwynn.
+</code></pre>
+
+<p>Convert some markdown:</p>
+
+<pre><code>$ octonaut markdown "# Header #"
+&lt;h1&gt;Header&lt;/h1&gt;
+</code></pre>
+
+<h2>
+<a name="extend-with-plugins" class="anchor" href="#extend-with-plugins"><span class="mini-icon mini-icon-link"></span></a>Extend with plugins</h2>
+
+<p>Octonaut makes it simple to extend the CLI with new commands just by adding
+some Ruby files to <code>~/.octonaut/plugins</code>:</p>
+
+<pre><code>$ cat ~/.octonaut_plugins/test.rb
+module Octonaut
+
+  desc 'An plugin method'
+  arg_name 'text'
+  command :say do |c|
+    c.action do |global,options,args|
+      puts @client.say args.shift
+    end
+  end
+end
+
+$ export OCTONAUT_PLUGINS_PATH=~./octonaut_plugins
+$ octonaut say "hello from plugins"
+
+           MMM.           .MMM
+           MMMMMMMMMMMMMMMMMMM
+           MMMMMMMMMMMMMMMMMMM      ____________________
+          MMMMMMMMMMMMMMMMMMMMM    |                    |
+         MMMMMMMMMMMMMMMMMMMMMMM   | hello from plugins |
+        MMMMMMMMMMMMMMMMMMMMMMMM   |_   ________________|
+        MMMM::- -:::::::- -::MMMM    |/
+         MM~:~   ~:::::~   ~:~MM
+    .. MMMMM::. .:::+:::. .::MMMMM ..
+          .MM::::: ._. :::::MM.
+             MMMM;:::::;MMMM
+      -MM        MMMMMMM
+      ^  M+     MMMMMMMMM
+          MMMMMMM MM MM MM
+               MM MM MM MM
+               MM MM MM MM
+            .~~MM~MM~MM~MM~~.
+         ~~~~MM:~MM~~~MM~:MM~~~~
+        ~~~~~~==~==~~~==~==~~~~~~
+         ~~~~~~==~==~==~==~~~~~~
+             :~==~==~==~==~~
+</code></pre>
+
+<h2>
+<a name="inspiration" class="anchor" href="#inspiration"><span class="mini-icon mini-icon-link"></span></a>Inspiration</h2>
+
+<p>Octonaut is inspired by <a href="https://github.com/sferik/t"><code>t</code>, the awesome Twitter CLI</a> from <a href="https://github.com/sferik">Erik Michaels-Ober</a>.</p>
+
+<h2>
+<a name="copyright" class="anchor" href="#copyright"><span class="mini-icon mini-icon-link"></span></a>Copyright</h2>
+
+<p>Copyright (c) 2013 Wynn Netherland. See <a href="https://github.com/pengwynn/octonaut/blob/master/LICENSE.md">LICENSE</a> for details.</p></article></div>
+

data/spec/fixtures/readme.src

@@ -0,0 +1,192 @@
+# Octonaut
+
+A little CLI sugar for the GitHub API, built with [gli][] and [Octokit][].
+
+**Still early. Rapidly evolving.** Why not [help out][contributing]?
+
+### Why not `hub`?
+
+[hub][] is great, you should use it; however, `hub` primarily focuses on smoothing the
+git workflow for GitHub and most commands are in the context of a GitHub
+repository.
+
+Octonaut is a more general-purpose CLI for the GitHub API. Oh, and [plugins][].
+
+### Installation
+
+Install via RubyGems:
+
+```
+gem install octonaut
+```
+
+### Example usage
+```
+$ octonaut
+NAME
+    octonaut - Octokit-powered CLI for GitHub
+
+SYNOPSIS
+    octonaut [global options] command [command options] [arguments...]
+
+GLOBAL OPTIONS
+    -a, --[no-]auto_traversal      - Automatically fetch all pages of paginated results
+    --help                         - Show this message
+    -n, --[no-]netrc               - Use .netrc file for authentication
+    --netrc-file=arg               - .netrc file for authentication (default: none)
+    -p, --password=arg             - GitHub password (default: ********)
+    -t, --oauth_token, --token=arg - GitHub API token (default: ********)
+    -u, --login=arg                - GitHub login (default: none)
+
+COMMANDS
+    browse              - Browse resource on github.com
+    follow              - Follow a user
+    followers           - View followers for a user
+    following           - View who a user is following
+    follows             - Check to see if a user follows another
+    help                - Shows a list of commands or help for one command
+    initconfig          - Initialize the config file using current global options
+    langs, languages    - Display languages for a repo
+    me                  - View your profile
+    repo, repository    - Display details for a repository
+    repos, repositories - List repositories for a user or organization
+    unfollow            - Unfollow a user
+    user, whois         - View profile for a user
+```
+
+View a user's profile:
+
+```
+$ octonaut whois cloudhead
+       ID 40774
+   JOINED 2008-12-16T15:09:49Z
+    LOGIN cloudhead
+     NAME Alexis Sellier
+  COMPANY SoundCloud, Ltd.
+ LOCATION Berlin
+FOLLOWERS 2347
+FOLLOWING 48
+ HIREABLE true
+      URL http://twitter.com/cloudhead
+```
+
+Browse a user on github.com in your default browser:
+
+```
+$ octonaut browse cloudhead
+```
+
+List followers:
+```
+$ octonaut followers pengwynn
+krisbulman
+camdub
+cglee
+nextmat
+zachinglis
+seaofclouds
+njonsson
+davidnorth
+polomasta
+webiest
+mchelen
+brogers
+marclove
+adamstac
+marshall
+asenchi
+piyush
+rmetzler
+nileshtrivedi
+sferik
+jimmybaker
+jnunemaker
+peterberkenbosch
+leah
+jakestutzman
+nkabbara
+etagwerker
+vagostino
+johan--
+bry4n
+...
+```
+
+Follow a user:
+```
+$ octonaut follow linus
+Followed linus.
+```
+
+Unfollow a user:
+```
+$ octonaut unfollow pengwynn
+Unfollowed pengwynn.
+```
+
+Convert some markdown:
+```
+$ octonaut markdown "# Header #"
+<h1>Header</h1>
+```
+
+## Extend with plugins
+
+Octonaut makes it simple to extend the CLI with new commands just by adding
+some Ruby files to `~/.octonaut/plugins`:
+
+```
+$ cat ~/.octonaut_plugins/test.rb
+module Octonaut
+
+  desc 'An plugin method'
+  arg_name 'text'
+  command :say do |c|
+    c.action do |global,options,args|
+      puts @client.say args.shift
+    end
+  end
+end
+
+$ export OCTONAUT_PLUGINS_PATH=~./octonaut_plugins
+$ octonaut say "hello from plugins"
+
+           MMM.           .MMM
+           MMMMMMMMMMMMMMMMMMM
+           MMMMMMMMMMMMMMMMMMM      ____________________
+          MMMMMMMMMMMMMMMMMMMMM    |                    |
+         MMMMMMMMMMMMMMMMMMMMMMM   | hello from plugins |
+        MMMMMMMMMMMMMMMMMMMMMMMM   |_   ________________|
+        MMMM::- -:::::::- -::MMMM    |/
+         MM~:~   ~:::::~   ~:~MM
+    .. MMMMM::. .:::+:::. .::MMMMM ..
+          .MM::::: ._. :::::MM.
+             MMMM;:::::;MMMM
+      -MM        MMMMMMM
+      ^  M+     MMMMMMMMM
+          MMMMMMM MM MM MM
+               MM MM MM MM
+               MM MM MM MM
+            .~~MM~MM~MM~MM~~.
+         ~~~~MM:~MM~~~MM~:MM~~~~
+        ~~~~~~==~==~~~==~==~~~~~~
+         ~~~~~~==~==~==~==~~~~~~
+             :~==~==~==~==~~
+```
+
+## Inspiration
+
+Octonaut is inspired by [`t`, the awesome Twitter CLI][t] from [Erik Michaels-Ober][sferik].
+
+## Copyright
+
+Copyright (c) 2013 Wynn Netherland. See [LICENSE][] for details.
+
+[hub]: https://github.com/defunkt/hub
+[gli]: https://github.com/davetron5000/gli
+[octokit]: https://github.com/pengwynn/octokit
+[plugins]: #extend-with-plugins
+[contributing]: https://github.com/pengwynn/octonaut/blob/master/CONTRIBUTING.md
+[t]: https://github.com/sferik/t
+[sferik]: https://github.com/sferik
+[LICENSE]: https://github.com/pengwynn/octonaut/blob/master/LICENSE.md

data/spec/fixtures/token.json

@@ -0,0 +1,16 @@
+{
+  "id": 2,
+  "url": "http://api.github.dev/authorizations/2",
+  "app": {
+    "name": "GitHub API",
+    "url": "http://developer.github.com/v3/oauth/#oauth-authorizations-api"
+  },
+  "token": "e46e749d1c727ff18b7fa403e924e58407fd9ac7",
+  "note": null,
+  "note_url": null,
+  "created_at": "2013-03-19T14:05:27Z",
+  "updated_at": "2013-03-19T14:05:27Z",
+  "scopes": [
+    "repo"
+  ]
+}

data/spec/fixtures/tokens.json

@@ -0,0 +1,50 @@
+[
+  {
+    "id": 1,
+    "url": "http://api.github.dev/authorizations/1",
+    "app": {
+      "name": "GitHub API",
+      "url": "http://developer.github.com/v3/oauth/#oauth-authorizations-api"
+    },
+    "token": "dafefb71c1ad57481f14e5e201e1b3c196fe8664",
+    "note": null,
+    "note_url": null,
+    "created_at": "2013-03-08T22:22:46Z",
+    "updated_at": "2013-03-08T22:23:13Z",
+    "scopes": [
+
+    ]
+  },
+  {
+    "id": 2,
+    "url": "http://api.github.dev/authorizations/2",
+    "app": {
+      "name": "GitHub API",
+      "url": "http://developer.github.com/v3/oauth/#oauth-authorizations-api"
+    },
+    "token": "e46e749d1c727ff18b7fa403e924e58407fd9ac7",
+    "note": null,
+    "note_url": null,
+    "created_at": "2013-03-19T14:05:27Z",
+    "updated_at": "2013-03-19T14:05:27Z",
+    "scopes": [
+      "repo"
+    ]
+  },
+  {
+    "id": 3,
+    "url": "http://api.github.dev/authorizations/3",
+    "app": {
+      "name": "GitHub API",
+      "url": "http://developer.github.com/v3/oauth/#oauth-authorizations-api"
+    },
+    "token": "ba7d03e4d3ede4f62fc5667040da3513877e6c11",
+    "note": null,
+    "note_url": null,
+    "created_at": "2013-03-19T17:08:03Z",
+    "updated_at": "2013-03-19T17:08:03Z",
+    "scopes": [
+
+    ]
+  }
+]

data/spec/fixtures/tokens.ls

@@ -0,0 +1,3 @@
+dafefb71c1ad57481f14e5e201e1b3c196fe8664      GitHub API
+e46e749d1c727ff18b7fa403e924e58407fd9ac7   repo   GitHub API
+ba7d03e4d3ede4f62fc5667040da3513877e6c11      GitHub API

data/spec/markdown_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Octonaut do
+
+  context "markdown" do
+
+    it "renders gfm markdown" do
+      request = stub_post('/markdown').
+        to_return(:body => fixture('gfm.html'))
+
+      Octonaut.run ['markdown', '# Test #']
+      expect(request).to have_been_made
+    end
+
+    it "renders plain markdown" do
+      request = stub_post('/markdown').
+        to_return(:body => fixture('markdown.html').read)
+
+      Octonaut.run ['markdown', '# Test #', '-m', 'markdown']
+      expect(request).to have_been_made
+    end
+
+    it "takes input from STDIN" do
+
+      $stdin.should_receive(:gets).and_return("*foo*")
+      Octokit::Client.any_instance.
+        should_receive(:markdown).
+        with("*foo*", {:mode => "gfm"})
+
+      Octonaut.run ['markdown']
+
+    end
+
+  end
+end

data/spec/octonaut_spec.rb

@@ -2,42 +2,28 @@ require 'spec_helper'
 
 describe Octonaut do
 
-  before :each do
-    @old_stderr = $stderr
-    $stderr = StringIO.new
-    @old_stdout = $stdout
-    $stdout = StringIO.new
-  end
-
-  after :each do
-    $stderr = @old_stderr
-    $stdout = @old_stdout
-  end
-
-  context "with an empty config file" do
-    before do
-      FileUtils.rm_f Dir.glob(File.join(ENV['HOME'], '.octonaut'))
+  context "with config files" do
+    it "can init a config file" do
+      Octonaut.run %w(-t 123456 initconfig)
+      info = YAML::load_file(Octonaut.config_path)
+      expect(info['t']).to eq "123456"
     end
+  end
 
-    after do
-      FileUtils.rm_f Dir.glob(File.join(ENV['HOME'], '.octonaut'))
-    end
+  context "plugins" do
+    it "finds plugins" do
+      Octonaut.run %w(foo)
 
-    it "works" do
-      expect(true).to be_true
+      expect($stdout.string).to include("bar")
     end
   end
 
   context "when authenticating" do
 
-    before do
-      FileUtils.cp File.join('spec', 'fixtures', '.netrc'), File.join(ENV['HOME'])
-    end
-
     it "knows about .netrc info" do
       request = stub_get("https://defunkt:il0veruby@api.github.com/user").
         to_return(json_response("user.json"))
-      Octonaut.run %w(-n me)
+      Octonaut.run %w(--netrc-file tmp/fakehome/.netrc me)
       expect(request).to have_been_made
     end
 
@@ -63,6 +49,54 @@ describe Octonaut do
       expect(request).to have_been_made
     end
 
+    context "when authorizing" do
+
+      it "can store a token for later" do
+        request = stub_post("https://defunkt:il0veruby@api.github.com/authorizations").
+          with(:body => {"scopes" => []}).
+          to_return(json_response("token.json"))
+
+        HighLine.any_instance.should_receive(:ask).
+          with("GitHub username:      ").
+          and_return("defunkt")
+        HighLine.any_instance.should_receive(:ask).
+          with("Enter your password:  ").
+          and_return("il0veruby")
+
+        Octonaut.run %w(authorize)
+
+        expect(request).to have_been_made
+        info = YAML::load_file(Octonaut.config_path)
+        expect(info['t']).to eq "e46e749d1c727ff18b7fa403e924e58407fd9ac7"
+      end
+
+      it "doesn't step on an existing config file" do
+        Octonaut.run %w(-u defunkt initconfig --force)
+        info = YAML::load_file(Octonaut.config_path)
+        expect(info['u']).to eq "defunkt"
+        expect(info['t']).to be_nil
+
+        request = stub_post("https://defunkt:il0veruby@api.github.com/authorizations").
+          with(:body => {"scopes" => []}).
+          to_return(json_response("token.json"))
+
+        HighLine.any_instance.should_receive(:ask).
+          with("GitHub username:      ").
+          and_return("defunkt")
+        HighLine.any_instance.should_receive(:ask).
+          with("Enter your password:  ").
+          and_return("il0veruby")
+
+        Octonaut.run %w(authorize)
+
+        expect(request).to have_been_made
+        info = YAML::load_file(Octonaut.config_path)
+        expect(info[:t]).to eq "e46e749d1c727ff18b7fa403e924e58407fd9ac7"
+        expect(info['u']).to eq "defunkt"
+      end
+
+    end
+
   end
 
 end

data/spec/repositories_spec.rb

@@ -2,18 +2,6 @@ require 'spec_helper'
 
 describe Octonaut do
 
-  before :each do
-    @old_stderr = $stderr
-    $stderr = StringIO.new
-    @old_stdout = $stdout
-    $stdout = StringIO.new
-  end
-
-  after :each do
-    $stderr = @old_stderr
-    $stdout = @old_stdout
-  end
-
   context "repositories" do
 
     it "displays repository information" do

data/spec/spec_helper.rb

@@ -1,19 +1,26 @@
+ENV['OCTONAUT_ENV']          = 'TEST'
+ENV['OCTONAUT_PLUGINS_PATH'] = 'tmp/fakehome/plugins'
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.order = 'random'
 
-  config.before do
-    unless ENV['CI']
-      @original_home = ENV['HOME']
-      new_home = File.expand_path("./tmp/fakehome")
-      ENV['HOME'] = new_home
-    end
+  config.before :each do
+    @old_stderr = $stderr
+    $stderr = StringIO.new
+    @old_stdout = $stdout
+    $stdout = StringIO.new
+    @old_stdin = $stdin
+    $stdin = StringIO.new
+    FileUtils.rm_f File.expand_path(Octonaut.config_path)
   end
 
-  config.after do
-    ENV['HOME'] = @original_home unless ENV['CI']
+  config.after :each do
+    $stderr = @old_stderr
+    $stdout = @old_stdout
+    $stdin  = @old_stdin
+    FileUtils.rm_f File.expand_path(Octonaut.config_path)
   end
-
 end
 
 require 'octonaut'
@@ -72,12 +79,12 @@ def fixture(file)
   File.new(fixture_path + '/' + file)
 end
 
-def json_response(file)
+def json_response(file, headers = {})
   {
     :body => fixture(file),
     :headers => {
       :content_type => 'application/json; charset=utf-8'
-    }
+    }.merge(headers)
   }
 end
 

data/spec/users_spec.rb

@@ -2,18 +2,6 @@ require 'spec_helper'
 
 describe Octonaut do
 
-  before :each do
-    @old_stderr = $stderr
-    $stderr = StringIO.new
-    @old_stdout = $stdout
-    $stdout = StringIO.new
-  end
-
-  after :each do
-    $stderr = @old_stderr
-    $stdout = @old_stdout
-  end
-
   context "users" do
 
     it "looks up users by login" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octonaut
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -49,17 +49,33 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.15
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -199,30 +215,43 @@ files:
 - LICENSE.md
 - Rakefile
 - octonaut.gemspec
+- lib/octonaut/commands/authorizations.rb
 - lib/octonaut/commands/common.rb
+- lib/octonaut/commands/contents.rb
+- lib/octonaut/commands/markdown.rb
 - lib/octonaut/commands/repositories.rb
 - lib/octonaut/commands/users.rb
 - lib/octonaut/helpers.rb
 - lib/octonaut/printer.rb
+- lib/octonaut/printers/authorizations.rb
 - lib/octonaut/printers/organizations.rb
 - lib/octonaut/printers/repositories.rb
 - lib/octonaut/printers/users.rb
 - lib/octonaut/version.rb
 - lib/octonaut.rb
 - bin/octonaut
+- spec/authorizations_spec.rb
+- spec/contents_spec.rb
+- spec/fixtures/gfm.html
 - spec/fixtures/languages.json
 - spec/fixtures/languages.table
+- spec/fixtures/markdown.html
+- spec/fixtures/readme.html
+- spec/fixtures/readme.src
 - spec/fixtures/repositories.json
 - spec/fixtures/repositories.ls
 - spec/fixtures/repository.json
+- spec/fixtures/token.json
+- spec/fixtures/tokens.json
+- spec/fixtures/tokens.ls
 - spec/fixtures/user.json
 - spec/fixtures/users.json
 - spec/fixtures/users.ls
+- spec/markdown_spec.rb
 - spec/octonaut_spec.rb
 - spec/repositories_spec.rb
 - spec/spec_helper.rb
 - spec/users_spec.rb
-- spec/fixtures/.netrc
 homepage: http://github.com/pengwynn
 licenses:
 - MIT
@@ -250,15 +279,24 @@ signing_key:
 specification_version: 3
 summary: CLI for GitHub
 test_files:
-- spec/fixtures/.netrc
+- spec/authorizations_spec.rb
+- spec/contents_spec.rb
+- spec/fixtures/gfm.html
 - spec/fixtures/languages.json
 - spec/fixtures/languages.table
+- spec/fixtures/markdown.html
+- spec/fixtures/readme.html
+- spec/fixtures/readme.src
 - spec/fixtures/repositories.json
 - spec/fixtures/repositories.ls
 - spec/fixtures/repository.json
+- spec/fixtures/token.json
+- spec/fixtures/tokens.json
+- spec/fixtures/tokens.ls
 - spec/fixtures/user.json
 - spec/fixtures/users.json
 - spec/fixtures/users.ls
+- spec/markdown_spec.rb
 - spec/octonaut_spec.rb
 - spec/repositories_spec.rb
 - spec/spec_helper.rb

data/spec/fixtures/.netrc

@@ -1,2 +0,0 @@
-machine api.github.com login defunkt password il0veruby
-machine api.github.dev login defunkt password il0veruby