octonaut 0.1.0 → 0.2.0

data/README.md

@@ -39,7 +39,7 @@ GLOBAL OPTIONS
     -u, --login=arg                - GitHub login (default: none)
 
 COMMANDS
-    archive_link           - Get repository tarball or zipball archive URL
+    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
@@ -56,9 +56,17 @@ COMMANDS
     repo, repository       - Display details for a repository
     repos, repositories    - List repositories for a user or organization
     scopes                 - List scopes for a token
+    star                   - Star a repository
+    stargazers             - List stargazers
+    starred                - List or check starred repositories for a user
+    subscribe              - Subscribe to a repository
+    subscribers            - List subscribers for a repository
+    subscriptions          - List user repository subscriptions
     tokens, authorizations - Manage tokens
     unfollow               - Unfollow a user
-    user, whois            - View profile for a user
+    unstar                 - Unstar a repository
+    unsubscribe            - Unsubscribe to a repository
+    user, whois            - Manage users
 ```
 
 View a user's profile:
@@ -138,7 +146,7 @@ $ octonaut markdown "# Header #"
 ```
 Convert markdown using STDIN
 ```
-$ echo "Fixed in #3 " | be bin/octonaut markdown -c pengwynn/octonaut
+$ echo "Fixed in #3 " | 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>"
 ```
 
@@ -147,7 +155,7 @@ $ echo "Fixed in #3 " | be bin/octonaut markdown -c pengwynn/octonaut
 ## Extend with plugins
 
 Octonaut makes it simple to extend the CLI with new commands just by adding
-some Ruby files to `~/.octonaut/plugins`:
+some Ruby files to `~/.octonaut_plugins`:
 
 ```
 $ cat ~/.octonaut_plugins/test.rb

data/lib/octonaut.rb

@@ -5,12 +5,14 @@ require 'launchy'
 require 'octokit'
 require 'octonaut/printer'
 require 'octonaut/helpers'
+require 'octonaut/utils'
 require 'octonaut/version'
 
 module Octonaut
   extend GLI::App
   extend Octonaut::Printer
   extend Octonaut::Helpers
+  extend Octonaut::Utils
 
   def self.config_path
     path = if ENV['OCTONAUT_ENV'] == 'TEST'

data/lib/octonaut/commands/activity.rb

@@ -0,0 +1,126 @@
+module Octonaut
+
+
+  desc "List or check starred repositories for a user"
+  arg_name 'login or repository', :optional
+  command :starred do |c|
+
+    c.desc "Sort repos by: created, updated"
+    c.flag :sort
+
+    c.desc "Sort direction: asc or desc"
+    c.flag :direction
+
+    c.action do |global,options,args|
+      target = args.shift
+      if target && target[/\//]
+        user, repo = target.split("/")
+        login = @client.login
+      else
+        login = target || @client.login
+      end
+
+      if repo
+        # TODO: Fix this upstream to take a single arg
+        result  = @client.starred?(user, repo) ? "" : "not "
+        puts "#{login} has #{result}starred #{user}/#{repo}"
+      elsif login.nil?
+        puts "Please authenticate or provide a GitHub login"
+      else
+        opts = Octonaut.supplied_flags(options)
+        ls_repos @client.starred(login, opts)
+      end
+    end
+
+  end
+
+  desc "Star a repository"
+  arg_name 'repository'
+  command :star do |c|
+    c.action do |global,options,args|
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      puts "Starred #{repo}" if @client.star(repo)
+    end
+  end
+
+  desc "Unstar a repository"
+  arg_name 'repository'
+  command :unstar do |c|
+    c.action do |global,options,args|
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      puts "Unstarred #{repo}" if @client.unstar(repo)
+    end
+  end
+
+  desc "List stargazers"
+  arg_name 'repository'
+  command :stargazers do |c|
+    c.action do |global,options,args|
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      ls_users @client.stargazers(repo)
+    end
+  end
+
+  desc "Subscribe to a repository"
+  arg_name "repository"
+  command :subscribe do |c|
+    c.desc "Ignore notifications"
+    c.switch [:i, :ignored]
+    c.action do |global,options,args|
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      opts = Octonaut.supplied_flags(options).select {|k, v| k == 'ignored'}
+      if @client.update_subscription(repo, opts)
+        message = "Subscribed to #{repo}"
+        message << " and ignored" if opts['ignored']
+        puts message
+      else
+        puts "Could not subscribe to #{repo}"
+      end
+    end
+  end
+
+  desc "Unsubscribe to a repository"
+  arg_name "repository"
+  command :unsubscribe do |c|
+    c.action do |global,options,args|
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      if @client.delete_subscription(repo)
+        puts "Unsubscribed to #{repo}"
+      else
+        puts "Could not unsubscribe to #{repo}"
+      end
+    end
+  end
+
+  desc "List subscribers for a repository"
+  arg_name "repository"
+  command :subscribers do |c|
+    c.action do |global,options,args|
+      repo = args.shift
+      raise ArgumentError.new "Repository required" if repo.nil?
+
+      ls_users @client.subscribers(repo)
+    end
+  end
+
+  desc "List user repository subscriptions"
+  arg_name "user", :optional
+  command :subscriptions do |c|
+    c.action do |global,options,args|
+      user = args.shift || @client.login
+      raise ArgumentError.new "User or authentication required" if user.nil?
+      ls_repos @client.subscriptions(user)
+    end
+  end
+
+end

data/lib/octonaut/commands/contents.rb

@@ -49,7 +49,7 @@ module Octonaut
 
   desc "Get repository tarball or zipball archive URL"
   arg_name "repo"
-  command :archive_link do |c|
+  command 'archive-link' do |c|
     c.desc "Archive format"
     c.default_value "tar"
     c.flag [:f, :format]

data/lib/octonaut/commands/users.rb

@@ -7,25 +7,53 @@ module Octonaut
     end
   end
 
-  desc "View profile for a user"
-  arg_name 'login'
+  desc 'Manage users'
   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
+    c.default_command :show
+    c.desc "View a user profile"
+    c.arg_name 'login'
+    c.command :show do |show|
+      show.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
+
+    c.desc "Update a user profile"
+    c.command :update do |update|
+
+      update.arg_name "Name", :optional
+      update.flag :name
+      update.arg_name "Email", :optional
+      update.flag :email
+      update.arg_name "Blog", :optional
+      update.flag :blog
+      update.arg_name "Company", :optional
+      update.flag :company
+      update.arg_name "Location", :optional
+      update.flag :location
+      update.arg_name "Hireable", :optional
+      update.switch :hireable
+      update.action do |global,options,args|
+        opts = Octonaut.supplied_flags(options)
+        if @client.update_user(opts)
+          puts "User profile updated"
         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|

data/lib/octonaut/printers/repositories.rb

@@ -42,7 +42,7 @@ module Octonaut
       end
 
       def ls_repos(repos, options = {})
-        repos.each {|r| puts r.name }
+        repos.each {|r| puts r.full_name }
       end
     end
   end

data/lib/octonaut/utils.rb

@@ -0,0 +1,9 @@
+module Octonaut
+  module Utils
+
+    def supplied_flags(options = {})
+      options.dup.select {|k, v| k.is_a?(String)  }
+    end
+
+  end
+end

data/lib/octonaut/version.rb

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

data/spec/activity_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe Octonaut do
+
+  context "stars" do
+
+    it "lists your starred repositories" do
+      request = stub_get("https://defunkt:il0veruby@api.github.com/users/defunkt/starred").
+        to_return(json_response("starred.json"))
+
+
+      Octonaut.run %w(-u defunkt -p il0veruby starred)
+      expect(request).to have_been_made
+
+      expect($stdout.string).to eq(fixture('starred.ls').read)
+    end
+
+    it "lists stars for a user" do
+      request = stub_get("https://api.github.com/users/pengwynn/starred").
+        to_return(json_response("starred.json"))
+
+
+      Octonaut.run %w(starred pengwynn)
+      expect(request).to have_been_made
+
+      expect($stdout.string).to eq(fixture('starred.ls').read)
+    end
+
+    it "requires a username to list stars" do
+      request = stub_get("https://api.github.com/users/pengwynn/starred").
+        to_return(json_response("starred.json"))
+
+      Octonaut.run %w(starred)
+      expect(request).to have_not_been_made
+
+      expect($stdout.string).to eq("Please authenticate or provide a GitHub login\n")
+    end
+
+    it "stars a repository" do
+      request = stub_put("https://defunkt:il0veruby@api.github.com/user/starred/defunkt/dotjs").
+        to_return(:status => 204)
+
+      Octonaut.run %w(-u defunkt -p il0veruby star defunkt/dotjs)
+      expect(request).to have_been_made
+
+      expect($stdout.string).to eq("Starred defunkt/dotjs\n")
+    end
+
+    it "unstars a repository" do
+      request = stub_delete("https://defunkt:il0veruby@api.github.com/user/starred/defunkt/dotjs").
+        to_return(:status => 204)
+
+      Octonaut.run %w(-u defunkt -p il0veruby unstar defunkt/dotjs)
+      expect(request).to have_been_made
+
+      expect($stdout.string).to eq("Unstarred defunkt/dotjs\n")
+    end
+
+    it "checks if you've starred a repository" do
+      request = stub_get("https://defunkt:il0veruby@api.github.com/user/starred/defunkt/dotjs").
+        to_return(:status => 204)
+
+      Octonaut.run %w(-u defunkt -p il0veruby starred defunkt/dotjs)
+      expect(request).to have_been_made
+
+      expect($stdout.string).to eq("defunkt has starred defunkt/dotjs\n")
+    end
+
+    it "indicates a user has not starred a repo" do
+      request = stub_get("https://defunkt:il0veruby@api.github.com/user/starred/defunkt/dotjs").
+        to_return(:status => 404)
+
+      Octonaut.run %w(-u defunkt -p il0veruby starred defunkt/dotjs)
+      expect(request).to have_been_made
+
+      expect($stdout.string).to eq("defunkt has not starred defunkt/dotjs\n")
+    end
+
+    it "lists stargazers for a repository" do
+      request = stub_get("/repos/defunkt/dotjs/stargazers").
+        to_return(json_response("users.json"))
+
+      Octonaut.run %w(stargazers defunkt/dotjs)
+
+      expect(request).to have_been_made
+      expect($stdout.string).to eq(fixture('users.ls').read)
+    end
+
+  end
+
+  context "subscriptions" do
+
+    it "subscribes to a repository" do
+      request = stub_put("https://defunkt:il0veruby@api.github.com/repos/defunkt/dotjs/subscription").
+        to_return(:status => 204)
+
+      Octonaut.run %w(-u defunkt -p il0veruby subscribe defunkt/dotjs)
+      expect(request).to have_been_made
+      expect($stdout.string).to eq("Subscribed to defunkt/dotjs\n")
+    end
+
+    it "marks a subscription as ignored" do
+      request = stub_put("https://defunkt:il0veruby@api.github.com/repos/defunkt/dotjs/subscription").
+        with(:body => {:ignored => true}).
+        to_return(:status => 204)
+
+      Octonaut.run %w(-u defunkt -p il0veruby subscribe -i defunkt/dotjs)
+      expect(request).to have_been_made
+      expect($stdout.string).to eq("Subscribed to defunkt/dotjs and ignored\n")
+    end
+
+    it "unsubscribes to a repository" do
+      request = stub_delete("https://defunkt:il0veruby@api.github.com/repos/defunkt/dotjs/subscription").
+        to_return(:status => 204)
+
+      Octonaut.run %w(-u defunkt -p il0veruby unsubscribe defunkt/dotjs)
+      expect(request).to have_been_made
+      expect($stdout.string).to eq("Unsubscribed to defunkt/dotjs\n")
+    end
+
+    it "lists subscribers for a repository" do
+      request = stub_get("https://api.github.com/repos/defunkt/dotjs/subscribers").
+        to_return(json_response("subscribers.json"))
+
+      Octonaut.run %w(subscribers defunkt/dotjs)
+      expect(request).to have_been_made
+      expect($stdout.string).to eq(fixture('subscribers.ls').read)
+    end
+
+    it "lists subscribed repositories" do
+      request = stub_get("https://defunkt:il0veruby@api.github.com/users/defunkt/subscriptions").
+        to_return(json_response("repositories.json"))
+
+      Octonaut.run %w(-u defunkt -p il0veruby subscriptions)
+      expect(request).to have_been_made
+      expect($stdout.string).to eq(fixture('repositories.ls').read)
+    end
+
+  end
+
+end

data/spec/contents_spec.rb

@@ -54,7 +54,7 @@ describe Octonaut do
         with("pengwynn/octonaut", :format => "zipball", :ref => "master").
         and_return(url)
 
-      Octonaut.run %w(archive_link -f zip pengwynn/octonaut)
+      Octonaut.run %w(archive-link -f zip pengwynn/octonaut)
       expect($stdout.string).to eq(url)
 
     end

data/spec/fixtures/repositories.ls

@@ -1,30 +1,30 @@
-ace
-acts_as_textiled
-ambition
-ambitious_activeldap
-ambitious_activerecord
-barefootexamples
-body_matcher
-burn
-cache_fu
-cheat
-cheat.el
-choice
-cijoe
-coffee-mode
-colored
-currency_converter
-defunkt.github.com
-djangode
-dodgeball.github.com
-dotenv
-dotjs
-electron-wordwrap
-emacs
-email_reply_parser
-evilbot
-exception_logger
-facebox
-faceup
-fakefs
-fixture_scenarios_builder
+defunkt/ace
+defunkt/acts_as_textiled
+defunkt/ambition
+defunkt/ambitious_activeldap
+defunkt/ambitious_activerecord
+defunkt/barefootexamples
+defunkt/body_matcher
+defunkt/burn
+defunkt/cache_fu
+defunkt/cheat
+defunkt/cheat.el
+defunkt/choice
+defunkt/cijoe
+defunkt/coffee-mode
+defunkt/colored
+defunkt/currency_converter
+defunkt/defunkt.github.com
+defunkt/djangode
+defunkt/dodgeball.github.com
+defunkt/dotenv
+defunkt/dotjs
+defunkt/electron-wordwrap
+defunkt/emacs
+defunkt/email_reply_parser
+defunkt/evilbot
+defunkt/exception_logger
+defunkt/facebox
+defunkt/faceup
+defunkt/fakefs
+defunkt/fixture_scenarios_builder