github_cli 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.3.1 (May 30, 2012)
+
+* Add milestone api commands.
+* Add emails api commands.
+* Add events api commands.
+* Fix bug with configuration access.
+* Add thor extensions.
+
 0.3.0 (May 13, 2012)
 
 * Add output formatting.

data/Gemfile.lock

@@ -1,14 +1,13 @@
 PATH
   remote: .
   specs:
-    github_cli (0.3.0)
+    github_cli (0.3.1)
       github_api (~> 0.5)
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.2.7)
     aruba (0.4.11)
       childprocess (>= 0.2.3)
       cucumber (>= 1.1.1)
@@ -24,27 +23,28 @@ GEM
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.6)
     diff-lcs (1.1.3)
-    faraday (0.7.6)
-      addressable (~> 2.2)
+    faraday (0.8.0)
       multipart-post (~> 1.1)
-      rack (~> 1.1)
     ffi (1.0.11)
     gherkin (2.9.0)
       json (>= 1.4.6)
-    github_api (0.5.1)
-      faraday (~> 0.7.6)
+    github_api (0.5.2)
+      faraday (~> 0.8.0)
       hashie (~> 1.2.0)
       multi_json (~> 1.3)
       nokogiri (~> 1.5.2)
-      oauth2 (~> 0.5.2)
+      oauth2 (~> 0.7)
     hashie (1.2.0)
+    httpauth (0.1)
     json (1.6.5)
     multi_json (1.3.2)
     multipart-post (1.1.5)
     nokogiri (1.5.2)
-    oauth2 (0.5.2)
-      faraday (~> 0.7)
+    oauth2 (0.7.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
       multi_json (~> 1.0)
+      rack (~> 1.4)
     rack (1.4.1)
     rake (0.9.2.2)
     rspec (2.8.0)
@@ -56,7 +56,7 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
     term-ansicolor (1.0.7)
-    thor (0.14.6)
+    thor (0.15.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -92,6 +92,13 @@ Interact with gists:
 $ ghc gist
 ```
 
+Interact with users:
+
+```shell
+$ ghc email
+$ ghc follower
+```
+
 Interact with authorizations:
 
 ```shell

data/lib/github_cli.rb

@@ -5,6 +5,7 @@ require 'pathname'
 require 'thor'
 require 'thor/group'
 require 'github_api'
+require 'github_cli/thor_ext'
 require 'github_cli/version'
 require 'github_cli/errors'
 

data/lib/github_cli/apis.rb

@@ -14,12 +14,14 @@ end
   collaborator
   commit
   download
+  email
   fork
   gist
   hook
   issue
   key
   label
+  milestone
   pull_request
   reference
   repository

data/lib/github_cli/apis/email.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Email < API
+
+    class << self
+
+      def all(params, format)
+        output format do
+          github_api.users.emails.list params
+        end
+      end
+
+      def add(emails, params, format)
+        output format do
+          github_api.users.emails.add emails, params
+        end
+      end
+
+      def delete(emails, params, format)
+        output format do
+          github_api.users.emails.delete emails, params
+        end
+      end
+    end
+
+  end # Email
+end # GithubCLI

data/lib/github_cli/apis/event.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Event < API
+
+    class << self
+
+      def public(params, format)
+        output format do
+          github_api.events.public params
+        end
+      end
+
+      def repository(user, repo, params, format)
+        output format do
+          github_api.events.repository user, repo, params
+        end
+      end
+
+      def issue(user, repo, params, format)
+        output format do
+          github_api.events.issue user, repo, params
+        end
+      end
+
+      def network(user, repo, params, format)
+        output format do
+          github_api.events.network user, repo, params
+        end
+      end
+
+      def organization(org, params, format)
+        output format do
+          github_api.events.organization org, params
+        end
+      end
+
+      def received(user, params, format)
+        output format do
+          github_api.events.received user, params
+        end
+      end
+
+      def performed(user, params, format)
+        output format do
+          github_api.events.performed user, params
+        end
+      end
+
+      def user_org(user, org, params, format)
+        output format do
+          github_api.events.user_org user, org, params
+        end
+      end
+    end
+
+  end # Event
+end # GithubCLI

data/lib/github_cli/apis/milestone.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Milestone < API
+
+    class << self
+
+      def all(user, repo, params, format)
+        output format do
+          github_api.issues.milestones.list user, repo, params
+        end
+      end
+
+      def get(user, repo, id, params, format)
+        output format do
+          github_api.issues.milestones.get user, repo, id, params
+        end
+      end
+
+      def create(user, repo, params, format)
+        output format do
+          github_api.issues.milestones.create user, repo, params
+        end
+      end
+
+      def update(user, repo, id, params, format)
+        output format do
+          github_api.issues.milestones.update user, repo, id, params
+        end
+      end
+
+      def delete(user, repo, id, params, format)
+        output format do
+          github_api.issues.milestones.delete user, repo, id, params
+        end
+      end
+    end
+
+  end # Milestone
+end # GithubCLI

data/lib/github_cli/cli.rb

@@ -30,7 +30,6 @@ module GithubCLI
     class_option :verbose, :type => :boolean,
                  :banner => "Enable verbose output mode."
 
-
     desc 'init', 'Generates a configuration file in your home directory'
     long_desc <<-DESC
       Initializes a configuration file where you can set default options for

data/lib/github_cli/command.rb

@@ -6,17 +6,18 @@ module GithubCLI
 
     API_CLASSES = %w(
       c_l_i
-      repo download key fork
-      issue label
+      repo download key fork hook watch collab
+      issue label milestone
       tag tree blob reference commit
       pull
+      email
+      event
     )
 
     HELP_COMMAND = 'help'
 
     class Comm < Struct.new(:namespace, :name, :desc, :usage); end
 
-
     def self.output_formats
       {
         'csv' => nil,
@@ -27,17 +28,22 @@ module GithubCLI
     end
 
     map "ls" => :list,
+        "all" => :list,
         "del" => :delete
 
     class_option :format, :type => :string, :aliases => '-f',
                  :default => 'table',
                  :banner => output_formats.keys.join('|'),
                  :desc => "Format of the output"
+    class_option :pager, :type => :boolean, :aliases => '-p',
+                 :default => true,
+                 :desc => "Determines if the output is paged."
 
     def self.banner(task, namespace=true, subcommand=true)
       "#{basename} #{task.formatted_usage(self, true, subcommand)}"
     end
 
+
     def self.all
       commands = []
       Base.subclasses.each do |klass|

data/lib/github_cli/commands.rb

@@ -7,12 +7,15 @@ module GithubCLI
     autoload :Collaborators,  'github_cli/commands/collaborators'
     autoload :Commits,        'github_cli/commands/commits'
     autoload :Downloads,      'github_cli/commands/downloads'
+    autoload :Emails,         'github_cli/commands/emails'
+    autoload :Events,         'github_cli/commands/events'
     autoload :Forks,          'github_cli/commands/forks'
     autoload :Gists,          'github_cli/commands/gists'
     autoload :Hooks,          'github_cli/commands/hooks'
     autoload :Issues,         'github_cli/commands/issues'
     autoload :Keys,           'github_cli/commands/keys'
     autoload :Labels,         'github_cli/commands/labels'
+    autoload :Milestones,     'github_cli/commands/milestones'
     autoload :PullRequests,   'github_cli/commands/pull_requests'
     autoload :References,     'github_cli/commands/references'
     autoload :Repositories,   'github_cli/commands/repositories'

data/lib/github_cli/commands/emails.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Commands::Emails < Command
+
+    namespace :email
+
+    desc 'list', 'Lists email addresses for the authenticated user'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def list()
+      Email.all options[:params], options[:format]
+    end
+
+    desc 'add <email(s)>', 'Add email address(es) for the authenticated user'
+    long_desc <<-DESC
+      You can include a single email address or an array of addresses
+    DESC
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additonal request parameters e.i per_page:100'
+    def add(*emails)
+      Email.add emails, options[:params], options[:format]
+    end
+
+    desc 'delete <email(s)>', 'Delete email address(es) for the authenticated user'
+    long_desc <<-DESC
+      You can include a single email address or an array of addresses
+    DESC
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additonal request parameters e.i per_page:100'
+    def delete(*emails)
+      Email.delete emails, options[:params], options[:format]
+    end
+
+  end # Emails
+end # GithubCLI

data/lib/github_cli/commands/events.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Commands::Events < Command
+
+    namespace :event
+
+    desc 'public', 'Lists all public events'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def public
+      Event.public options[:params], options[:format]
+    end
+
+    desc 'repo <user> <repo>', 'Lists all repository events for a given user'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def repo(user, repo)
+      Event.repository user, repo, options[:params], options[:format]
+    end
+
+    desc 'issue <user> <repo>', 'Lists all issue events for a given repository'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def issue(user, repo)
+      Event.issue user, repo, options[:params], options[:format]
+    end
+
+    desc 'network <user> <repo>', 'Lists all public events for a network of repositories'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def network(user, repo)
+      Event.network user, repo, options[:params], options[:format]
+    end
+
+    desc 'org <org>', 'Lists all public events for an organization'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def org(org)
+      Event.organization org, options[:params], options[:format]
+    end
+
+    desc 'received <user>', 'Lists all events that a user has received'
+    method_option :public, :type => :boolean,
+                  :desc => 'Lists all public events that a user has received'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    long_desc <<-DESC
+      These are events that you’ve received by watching repos and following users.
+      If you are authenticated as the given user, you will see private events.
+      Otherwise, you’ll only see public events.
+    DESC
+    def received(user)
+      if options[:public]
+        options[:params]['public'] = true
+      end
+      Event.received user, options[:params], options[:format]
+    end
+
+    desc 'performed <user>', 'Lists all events that a user has performed'
+    method_option :public, :type => :boolean,
+                  :desc => 'Lists all public events that a user has received'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    long_desc <<-DESC
+      If you are authenticated as the given user, you will see your private
+      events. Otherwise, you’ll only see public events.
+    DESC
+    def performed(user)
+      if options[:public]
+        options[:params]['public'] = true
+      end
+      Event.performed user, options[:params], options[:format]
+    end
+
+    desc 'user_org <user> <org>', "Lists all events for a user's organization"
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    long_desc <<-DESC
+      This is the user’s organization dashboard. You must be authenticated
+      as the user to view this.
+    DESC
+    def user_org(user, org)
+      Event.user_org user, org, options[:params], options[:format]
+    end
+
+  end # Events
+end # GithubCLI

data/lib/github_cli/commands/milestones.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Commands::Milestones < Command
+
+    namespace :milestone
+
+    desc 'list <user> <repo>', 'List milestones for a repository'
+    long_desc <<-DESC
+      Parameters
+
+        state - open, closed, default: open\n
+        sort - due_date, completeness, default: due_date\n
+        direction - asc, desc, default: desc\n
+    DESC
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def list(user, repo)
+      Milestone.all user, repo, options[:params], options[:format]
+    end
+
+    desc 'get <user> <repo> <id>', 'Get a single milestone'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additional request parameters e.i per_page:100'
+    def get(user, repo, id)
+      Milestone.get user, repo, id, options[:params], options[:format]
+    end
+
+    desc 'create <user> <repo>', 'Create a milestone'
+    long_desc <<-DESC
+      Parameters
+
+        title - Required string\n
+        state - Optional string - open or closed\n
+        description - Optional string\n
+        due_on - Optional string - ISO 8601 time\n
+    DESC
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additonal request parameters e.i per_page:100'
+    def create(user, repo)
+      Milestone.create user, repo, options[:params], options[:format]
+    end
+
+    desc 'update <user> <repo> <id>', 'Update a milestone'
+    long_desc <<-DESC
+      Parameters
+
+        title - Required string\n
+        state - Optional string - open or closed\n
+        description - Optional string\n
+        due_on - Optional string - ISO 8601 time\n
+    DESC
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additonal request parameters e.i per_page:100'
+    def upload(resource, filename)
+      Download.upload resource, filename, options[:format]
+    end
+
+    desc 'delete <user> <repo> <id>', 'Delete a milestone'
+    method_option :params, :type => :hash, :default => {},
+                  :desc => 'Additonal request parameters e.i per_page:100'
+    def delete(user, repo, id)
+      Milestone.delete user, repo, id, options[:params], options[:format]
+    end
+
+  end # Milestones
+end # GithubCLI

data/lib/github_cli/config.rb

@@ -17,7 +17,7 @@ module GithubCLI
     end
 
     def [](key)
-      data[key] #|| (data.nil? ? nil : data[COMMAND_KEY][key])
+      data[key] || data[COMMAND_KEY][key] rescue nil
     end
 
     def fetch(key, default=nil)

data/lib/github_cli/subcommands.rb

@@ -18,6 +18,12 @@ module GithubCLI
     desc "download <command>", "Leverage Downloads API"
     subcommand "download", GithubCLI::Commands::Downloads
 
+    desc "email <command>", "Leverage Emails API"
+    subcommand "email", GithubCLI::Commands::Emails
+
+    desc "event <command>", "Leverage Events API"
+    subcommand "event", GithubCLI::Commands::Events
+
     desc "fork <command>", "Leverage Forks API"
     subcommand "fork", GithubCLI::Commands::Forks
 
@@ -36,6 +42,9 @@ module GithubCLI
     desc "label <command>", "Leverage Labels API"
     subcommand "label", GithubCLI::Commands::Labels
 
+    desc "milestone <command>", "Leverage Milestones API"
+    subcommand "milestone", GithubCLI::Commands::Milestones
+
     desc "pull <command>", "Leverage Pull Requests API"
     subcommand "pull", GithubCLI::Commands::PullRequests
 

data/lib/github_cli/terminal.rb

@@ -63,13 +63,23 @@ module GithubCLI
         GithubCLI.ui.info "ghc: '#{cmd}' is not a ghc command. See 'ghc --help'."
       end
 
-      def print_program_name
+      def print_program_name(print=true)
         GithubCLI.ui.info <<-TEXT
 
   #{GithubCLI.program_name}
 
         TEXT
       end
+
+      def print_usage(print=true)
+        if print
+        GithubCLI.ui.info <<-TEXT
+
+  Usage: ghc <command> <subcommand> [<args>]
+
+        TEXT
+        end
+      end
     end
 
   end # Terminal

data/lib/github_cli/thor_ext.rb

@@ -0,0 +1,33 @@
+require 'thor'
+
+class Thor
+  include Thor::Base
+
+  class << self
+
+    def help(shell, subcommand = false)
+      list = printable_tasks(true, subcommand)
+      Thor::Util.thor_classes_in(self).each do |klass|
+        list += klass.printable_tasks(false)
+      end
+      list.sort!{ |a,b| a[0] <=> b[0] }
+
+      shell.say "Commands:"
+      shell.print_table(list, :indent => 2, :truncate => true)
+      shell.say
+      class_options_help(shell)
+    end
+
+    def subcommand_help(cmd)
+      desc "help <command>", "Describe subcommands or one specific subcommand"
+      class_eval <<-RUBY
+        def help(task = nil, subcommand = true); super; end
+      RUBY
+    end
+  end
+
+  desc "help <command>", "Describe available commands or one specific command"
+  def help(task = nil, subcommand = false)
+    task ? self.class.task_help(shell, task) : self.class.help(shell, subcommand)
+  end
+end # Thor

data/lib/github_cli/version.rb

@@ -1,3 +1,3 @@
 module GithubCLI
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/github_cli/config_spec.rb

@@ -5,16 +5,11 @@ describe GithubCLI::Config do
   let(:config_name) { 'simple_config' }
   let(:path) { "/users/#{filename}" }
 
-  before :all do
-    unless File.exists?(fixture_path('.githubrc'))
-      File.symlink(fixture_path(config_name), fixture_path('.githubrc'))
-    end
-  end
-
   context 'global' do
     let(:config) { GithubCLI::Config.new fixture_path }
 
     before do
+      config.stub(:global_options_file) { fixture_path(config_name) }
       File.stub(:open) { YAML.load fixture('simple_config') }
     end
 
@@ -24,9 +19,16 @@ describe GithubCLI::Config do
     end
 
     context 'array access' do
+      it 'returns value for the key' do
+        config['basic_auth'].should == 'login:password'
+      end
+
       it 'searches in commands' do
-        pending
-        # config['issue-list'].should == { 'inputs' => 'ticket' }
+        config['issue-list'].should == { 'inputs' => 'ticket' }
+      end
+
+      it 'returns nil for missing key' do
+        config['non-existent'].should be_nil
       end
     end
 
@@ -109,4 +111,7 @@ describe GithubCLI::Config do
     end
   end
 
+  context 'local' do
+  end
+
 end # GithubCLI::Config

data/spec/github_cli/helpers_spec.rb

@@ -4,7 +4,8 @@ describe GithubCLI::Helpers do
   subject { described_class }
 
   it 'throws error if config file does not exist' do
-    subject.stub(:find_configfile) { nil }
+    pending
+    subject.stub(:find_configfile).and_return nil
     expect {
       subject.default_configfile
     }.to raise_error(GithubCLI::ConfigFileNotFound)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_cli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-13 00:00:00.000000000Z
+date: 2012-05-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
-  requirement: &2153151980 !ruby/object:Gem::Requirement
+  requirement: &2160356360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2153151980
+  version_requirements: *2160356360
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2153151560 !ruby/object:Gem::Requirement
+  requirement: &2160355220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153151560
+  version_requirements: *2160355220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153151100 !ruby/object:Gem::Requirement
+  requirement: &2160354060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153151100
+  version_requirements: *2160354060
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &2153150680 !ruby/object:Gem::Requirement
+  requirement: &2160353500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153150680
+  version_requirements: *2160353500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153150260 !ruby/object:Gem::Requirement
+  requirement: &2160352620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153150260
+  version_requirements: *2160352620
 description: CLI-based access to GitHub API v3
 email:
 - pmurach@gmail.com
@@ -102,12 +102,15 @@ files:
 - lib/github_cli/apis/collaborator.rb
 - lib/github_cli/apis/commit.rb
 - lib/github_cli/apis/download.rb
+- lib/github_cli/apis/email.rb
+- lib/github_cli/apis/event.rb
 - lib/github_cli/apis/fork.rb
 - lib/github_cli/apis/gist.rb
 - lib/github_cli/apis/hook.rb
 - lib/github_cli/apis/issue.rb
 - lib/github_cli/apis/key.rb
 - lib/github_cli/apis/label.rb
+- lib/github_cli/apis/milestone.rb
 - lib/github_cli/apis/pull_request.rb
 - lib/github_cli/apis/reference.rb
 - lib/github_cli/apis/repository.rb
@@ -122,12 +125,15 @@ files:
 - lib/github_cli/commands/collaborators.rb
 - lib/github_cli/commands/commits.rb
 - lib/github_cli/commands/downloads.rb
+- lib/github_cli/commands/emails.rb
+- lib/github_cli/commands/events.rb
 - lib/github_cli/commands/forks.rb
 - lib/github_cli/commands/gists.rb
 - lib/github_cli/commands/hooks.rb
 - lib/github_cli/commands/issues.rb
 - lib/github_cli/commands/keys.rb
 - lib/github_cli/commands/labels.rb
+- lib/github_cli/commands/milestones.rb
 - lib/github_cli/commands/pull_requests.rb
 - lib/github_cli/commands/references.rb
 - lib/github_cli/commands/repositories.rb
@@ -143,6 +149,7 @@ files:
 - lib/github_cli/helpers.rb
 - lib/github_cli/subcommands.rb
 - lib/github_cli/terminal.rb
+- lib/github_cli/thor_ext.rb
 - lib/github_cli/ui.rb
 - lib/github_cli/util.rb
 - lib/github_cli/version.rb