octonaut 0.0.1

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Wynn Netherland
+
+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,184 @@
+# 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. But hub focuses mostly 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][].
+
+### 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
+    -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
+```
+
+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.
+```
+
+## 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
+
+$ 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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/bin/octonaut

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'octonaut'
+
+exit Octonaut.run(ARGV)

data/lib/octonaut.rb

@@ -0,0 +1,66 @@
+require 'csv'
+require 'gli'
+require 'launchy'
+require 'octokit'
+require 'octonaut/printer'
+require 'octonaut/helpers'
+require 'octonaut/version'
+
+module Octonaut
+  extend GLI::App
+  extend Octonaut::Printer
+  extend Octonaut::Helpers
+
+  program_desc 'Octokit-powered CLI for GitHub'
+  commands_from 'octonaut/commands'
+  commands_from File.join(ENV['HOME'], '.octonaut', 'plugins')
+
+
+  desc 'Use .netrc file for authentication'
+  default_value false
+  switch [:n, :netrc]
+
+  desc 'GitHub login'
+  flag [:u, :login]
+  desc 'GitHub password'
+  flag [:p, :password], :mask => true
+  desc 'GitHub API token'
+  flag [:t, :oauth_token, :token], :mask => true
+  desc 'Automatically fetch all pages of paginated results'
+  switch [:a, :auto_traversal]
+
+
+  pre do |global,command,options,args|
+    # Pre logic here
+    # Return true to proceed; false to abourt and not call the
+    # chosen command
+    # Use skips_pre before a command to skip this block
+    # on that command only
+
+    @client = client(global, options)
+    true
+  end
+
+  post do |global,command,options,args|
+    # Post logic here
+    # Use skips_post before a command to skip this
+    # block on that command only
+  end
+
+  on_error do |exception|
+    case exception
+    when Octokit::Unauthorized
+      puts "Authentication required. Please check your login, password, or token."
+    else
+      # Need to handle other return codes within the calling method
+      true
+    end
+  end
+
+  def self.client(global, options)
+    opts = global.merge(options).
+      select {|k, v| Octokit::Configuration::VALID_OPTIONS_KEYS.include?(k) }
+    Octokit::Client.new(opts)
+  end
+
+end

data/lib/octonaut/commands/common.rb

@@ -0,0 +1,19 @@
+module Octonaut
+  desc 'Browse resource on github.com'
+  arg_name 'name'
+  command :browse do |c|
+    c.action do |global,options,args|
+      name = args.shift
+      raise ArgumentError.new("Name required") if name.nil?
+
+      owner, repo = name.split("/")
+      if repo.nil?
+        item = @client.user owner
+      else
+        item = @client.repo(name)
+      end
+
+      Octonaut.open item
+    end
+  end
+end

data/lib/octonaut/commands/repositories.rb

@@ -0,0 +1,42 @@
+module Octonaut
+
+  desc "Display details for a repository"
+  arg_name 'name'
+  command [:repo, :repository] do |c|
+    c.action do |global,options,args|
+      name = args.shift
+
+      print_repo_table @client.repo(name)
+    end
+  end
+
+  desc "List repositories for a user or organization"
+  arg_name 'login', :optional
+  command [:repos, :repositories] do |c|
+    c.desc "Filter repos by type: all, owner, member, public, private"
+    c.flag :type
+
+    c.desc "Sort repos by: created, updated, pushed, full_name"
+    c.flag :sort
+
+    c.desc "Sort direction: asc or desc"
+    c.flag :direction
+
+    c.action do |global,options,args|
+      login = args.shift
+      opts = options.select {|k,v| !v.nil? }
+
+      ls_repos @client.repositories(login, opts)
+    end
+  end
+
+  desc "Display languages for a repo"
+  arg_name "owner/repo"
+  command [:langs, :languages] do |c|
+    c.action do |global,options,args|
+      name = args.shift
+
+      print_table @client.languages(name)
+    end
+  end
+end

data/lib/octonaut/commands/users.rb

@@ -0,0 +1,88 @@
+module Octonaut
+  desc "View your profile"
+  command :me do |c|
+    c.action do |global,options,args|
+      user = @client.user
+      print_user_table user
+    end
+  end
+
+  desc "View profile for a user"
+  arg_name 'login'
+  command [:user, :whois] do |c|
+    c.action do |global,options,args|
+      login = args.shift
+      begin
+        user = @client.user login
+        case user['type']
+        when 'Organization'
+          print_org_table user
+        else
+          print_user_table user
+        end
+      rescue Octokit::NotFound
+        puts "User or organization #{login} not found"
+      end
+    end
+  end
+
+  desc "View followers for a user"
+  arg_name 'login', :optional
+  command :followers do |c|
+    c.action do |global,options,args|
+      login = args.shift || @client.login
+      print_users @client.followers(login), options
+    end
+  end
+
+  desc "View who a user is following"
+  arg_name 'login', :optional
+  command :following do |c|
+    c.action do |global,options,args|
+      login = args.shift || @client.login
+      print_users @client.following(login), options
+    end
+  end
+
+  desc "Check to see if a user follows another"
+  arg_name 'target'
+  command :follows do |c|
+    c.action do |global,options,args|
+      target = args.shift
+      message = if @client.follows?(target)
+        "Yes, #{@client.login} follows #{target}."
+      else
+        "No, #{@client.login} does not follow #{target}."
+      end
+
+      puts message
+    end
+  end
+
+  desc "Follow a user"
+  arg_name 'target', :multiple
+  command :follow do |c|
+    c.action do |global,options,args|
+      targets = args
+      targets.each {|t| follow_user(t) }
+    end
+  end
+
+  desc "Unfollow a user"
+  arg_name 'target', :multiple
+  command :unfollow do |c|
+    c.action do |global,options,args|
+      targets = args
+      targets.each {|t| unfollow_user(t) }
+    end
+  end
+
+  def self.follow_user(target)
+    puts "Followed #{target}." if @client.follow(target)
+  end
+
+  def self.unfollow_user(target)
+    puts "Unfollowed #{target}." if @client.unfollow(target)
+  end
+
+end

data/lib/octonaut/helpers.rb

@@ -0,0 +1,20 @@
+module Octonaut
+  module Helpers
+
+    def open(resource, relation = 'html')
+      link_field = case relation
+                   when 'self'
+                     'url'
+                   when /_url$/
+                     relation
+                   else
+                     "#{relation}_url"
+                   end
+
+      url = resource.send(link_field.to_sym)
+
+      Launchy.open url
+    end
+
+  end
+end