github_cli 0.4.4 → 0.5.0

data/features/search.feature

@@ -1,20 +1,20 @@
-Feature: ghc search
+Feature: gcli search
 
   Scenario: Available commands
 
-    When I run `ghc search`
+    When I run `gcli search`
     Then the exit status should be 0
-      And the output should contain "ghc search email"
-      And the output should contain "ghc search issue"
-      And the output should contain "ghc search repo"
-      And the output should contain "ghc search user"
+      And the output should contain "gcli search email"
+      And the output should contain "gcli search issue"
+      And the output should contain "gcli search repo"
+      And the output should contain "gcli search user"
 
   Scenario: Search issues
     Given the GitHub API server:
     """
     get('/legacy/issues/search/wycats/thor/open/shell') { status 200 }
     """
-    When I run `ghc search issue wycats thor shell --state=open`
+    When I run `gcli search issue wycats thor shell --state=open`
     Then the exit status should be 0
 
   Scenario: Search repositories
@@ -22,7 +22,7 @@ Feature: ghc search
     """
     get('/legacy/repos/search/shell') { status 200 }
     """
-    When I run `ghc search repo shell`
+    When I run `gcli search repo shell`
     Then the exit status should be 0
 
   Scenario: Search users
@@ -30,7 +30,7 @@ Feature: ghc search
     """
     get('/legacy/user/search/wycats') { status 200 }
     """
-    When I run `ghc search user wycats`
+    When I run `gcli search user wycats`
     Then the exit status should be 0
 
   Scenario: Search email
@@ -38,5 +38,5 @@ Feature: ghc search
     """
     get('/legacy/user/search/wycats') { status 200 }
     """
-    When I run `ghc search user wycats`
+    When I run `gcli search user wycats`
     Then the exit status should be 0

data/features/search_commands.feature

@@ -6,7 +6,7 @@ Feature: Github API Commands Search
   I have ability to list commands by search criteria
 
   Scenario: Listing
-    When I run `ghc list`
+    When I run `gcli list`
     Then the exit status should be 0
     And the output should contain:
     """
@@ -16,7 +16,7 @@ Feature: Github API Commands Search
     """
 
   Scenario Outline: Pattern Matching
-    When I run `ghc list <pattern>`
+    When I run `gcli list <pattern>`
     Then the output should contain "repo"
     And the output should not contain "issue"
 
@@ -26,8 +26,8 @@ Feature: Github API Commands Search
       | repo    |
 
   Scenario: No Match
-    When I run `ghc list bla`
+    When I run `gcli list bla`
     Then the output should contain:
     """
-    ghc: 'bla' is not a ghc command. See 'ghc --help'.
+    gcli: 'bla' is not a gcli command. See 'gcli --help'.
     """

data/features/support/hooks.rb

@@ -1,7 +1,9 @@
 require 'fileutils'
 
 Before do
-  @aruba_timeout_seconds = 10
+  @aruba_timeout_seconds = 5
+  @aruba_io_wait_seconds = 0.2
+
   @real_home = ENV['HOME']
   fake_home = File.join('/tmp', 'fakehome')
   FileUtils.rm_rf fake_home if File.exists? fake_home

data/features/tag.feature

@@ -1,18 +1,18 @@
-Feature: ghc tag
+Feature: gcli tag
 
   Scenario: Available commands
 
-    When I run `ghc tag`
+    When I run `gcli tag`
     Then the exit status should be 0
-      And the output should contain "ghc tag create"
-      And the output should contain "ghc tag get"
+      And the output should contain "gcli tag create"
+      And the output should contain "gcli tag get"
 
   Scenario: Get tag
     Given the GitHub API server:
     """
     get('/repos/wycats/thor/git/tags/827efc6d5') { status 200 }
     """
-    When I run `ghc tag get wycats thor 827efc6d5`
+    When I run `gcli tag get wycats thor 827efc6d5`
     Then the exit status should be 0
 
   Scenario: Create tag
@@ -20,5 +20,5 @@ Feature: ghc tag
     """
     post('/repos/wycats/thor/git/tags') { status 200 }
     """
-    When I run `ghc tag create wycats thor`
+    When I run `gcli tag create wycats thor`
     Then the exit status should be 0

data/features/team.feature

@@ -1,28 +1,28 @@
-Feature: ghc team
+Feature: gcli team
 
   Scenario: Available commands
-    When I run `ghc team`
+    When I run `gcli team`
     Then the exit status should be 0
-      And the output should contain "ghc team add_member"
-      And the output should contain "ghc team add_repo"
-      And the output should contain "ghc team create"
-      And the output should contain "ghc team delete"
-      And the output should contain "ghc team edit"
-      And the output should contain "ghc team get"
-      And the output should contain "ghc team list"
-      And the output should contain "ghc team list_member"
-      And the output should contain "ghc team list_repo"
-      And the output should contain "ghc team member"
-      And the output should contain "ghc team remove_member"
-      And the output should contain "ghc team remove_repo"
-      And the output should contain "ghc team repo"
+      And the output should contain "gcli team add_member"
+      And the output should contain "gcli team add_repo"
+      And the output should contain "gcli team create"
+      And the output should contain "gcli team delete"
+      And the output should contain "gcli team edit"
+      And the output should contain "gcli team get"
+      And the output should contain "gcli team list"
+      And the output should contain "gcli team list_member"
+      And the output should contain "gcli team list_repo"
+      And the output should contain "gcli team member"
+      And the output should contain "gcli team remove_member"
+      And the output should contain "gcli team remove_repo"
+      And the output should contain "gcli team repo"
 
   Scenario: List all teams
     Given the GitHub API server:
     """
     get('/orgs/rails/teams') { status 200 }
     """
-    When I run `ghc team ls rails`
+    When I run `gcli team ls rails`
     Then the exit status should be 0
 
   Scenario: Get team
@@ -30,7 +30,7 @@ Feature: ghc team
     """
     get('/teams/rails') { status 200 }
     """
-    When I run `ghc team get rails`
+    When I run `gcli team get rails`
     Then the exit status should be 0
 
   Scenario: Create team
@@ -38,7 +38,7 @@ Feature: ghc team
     """
     post('/orgs/rails/teams') { status 200 }
     """
-    When I run `ghc team create rails --params=name:'new team'`
+    When I run `gcli team create rails --params=name:'new team'`
     Then the exit status should be 0
 
   Scenario: Edit team
@@ -46,7 +46,7 @@ Feature: ghc team
     """
     patch('/teams/rails') { status 200 }
     """
-    When I run `ghc team edit rails --params=name:'new team'`
+    When I run `gcli team edit rails --params=name:'new team'`
     Then the exit status should be 0
 
   Scenario: Delete team
@@ -54,7 +54,7 @@ Feature: ghc team
     """
     delete('/teams/rails') { status 200 }
     """
-    When I run `ghc team del rails`
+    When I run `gcli team del rails`
     Then the exit status should be 0
 
   Scenario: List team members
@@ -62,7 +62,7 @@ Feature: ghc team
     """
     get('/teams/rails/members') { status 200 }
     """
-    When I run `ghc team list_members rails`
+    When I run `gcli team list_members rails`
     Then the exit status should be 0
 
   Scenario: Check is user is a team member
@@ -70,7 +70,7 @@ Feature: ghc team
     """
     get('/teams/rails/members/wycats') { status 200 }
     """
-    When I run `ghc team member rails wycats`
+    When I run `gcli team member rails wycats`
     Then the exit status should be 0
 
   Scenario: Add a team member
@@ -78,7 +78,7 @@ Feature: ghc team
     """
     put('/teams/rails/members/wycats') { status 200 }
     """
-    When I run `ghc team add_member rails wycats`
+    When I run `gcli team add_member rails wycats`
     Then the exit status should be 0
 
   Scenario: Remove a team member
@@ -86,7 +86,7 @@ Feature: ghc team
     """
     delete('/teams/rails/members/wycats') { status 200 }
     """
-    When I run `ghc team remove_member rails wycats`
+    When I run `gcli team remove_member rails wycats`
     Then the exit status should be 0
 
   Scenario: List team repositories
@@ -94,7 +94,7 @@ Feature: ghc team
     """
     get('/teams/rails/repos') { status 200 }
     """
-    When I run `ghc team list_repo rails`
+    When I run `gcli team list_repo rails`
     Then the exit status should be 0
 
   Scenario: Check if repository belongs to a team
@@ -102,7 +102,7 @@ Feature: ghc team
     """
     get('/teams/rails/repos/wycats/thor') { status 200 }
     """
-    When I run `ghc team repo rails wycats thor`
+    When I run `gcli team repo rails wycats thor`
     Then the exit status should be 0
 
   Scenario: Add a team repository
@@ -110,7 +110,7 @@ Feature: ghc team
     """
     put('/teams/rails/repos/wycats/thor') { status 200 }
     """
-    When I run `ghc team add_repo rails wycats thor`
+    When I run `gcli team add_repo rails wycats thor`
     Then the exit status should be 0
 
   Scenario: Remove a team repository
@@ -118,6 +118,6 @@ Feature: ghc team
     """
     delete('/teams/rails/repos/wycats/thor') { status 200 }
     """
-    When I run `ghc team remove_repo rails wycats thor`
+    When I run `gcli team remove_repo rails wycats thor`
     Then the exit status should be 0
 

data/features/tree.feature

@@ -1,16 +1,16 @@
-Feature: ghc tree
+Feature: gcli tree
 
   Scenario: Available commands
 
-    When I run `ghc tree`
+    When I run `gcli tree`
     Then the exit status should be 0
-      And the output should contain "ghc tree create"
-      And the output should contain "ghc tree get"
+      And the output should contain "gcli tree create"
+      And the output should contain "gcli tree get"
 
   Scenario: Get tree
     Given the GitHub API server:
     """
     get('/repos/wycats/thor/git/trees/827efc6d5') { status 200 }
     """
-    When I run `ghc tree get wycats thor 827efc6d5`
+    When I run `gcli tree get wycats thor 827efc6d5`
     Then the exit status should be 0

data/features/usage.feature

@@ -2,9 +2,9 @@ Feature: Command Usage
 
   Scenario: Getting Usage for Commands
 
-    When I run `ghc`
+    When I run `gcli`
     Then the exit status should be 0
-    And the output should contain "Usage: ghc"
+    And the output should contain "Usage: gcli"
       And the output should contain "[--config]"
       And the output should contain "[--no-color]"
       And the output should contain "[--no-pager]"
@@ -13,6 +13,6 @@ Feature: Command Usage
 
   Scenario: Specific usage for command
 
-    When I run `ghc repo`
+    When I run `gcli repo`
     Then the exit status should be 0
     And the output should contain "repo <subcommand>"

data/features/user.feature

@@ -1,18 +1,18 @@
-Feature: ghc user
+Feature: gcli user
 
   Scenario: Available commands
 
-    When I run `ghc user`
+    When I run `gcli user`
     Then the exit status should be 0
-      And the output should contain "ghc user get"
-      And the output should contain "ghc user update"
+      And the output should contain "gcli user get"
+      And the output should contain "gcli user update"
 
   Scenario: Get user
     Given the GitHub API server:
     """
     get('/users/wycats') { status 200 }
     """
-    When I run `ghc user get -u wycats`
+    When I run `gcli user get -u wycats`
     Then the exit status should be 0
 
   Scenario: Get the authenticated user
@@ -20,7 +20,7 @@ Feature: ghc user
     """
     get('/user') { status 200 }
     """
-    When I run `ghc user get`
+    When I run `gcli user get`
     Then the exit status should be 0
 
   Scenario: Update the authenticated user
@@ -28,5 +28,5 @@ Feature: ghc user
     """
     patch('/user') { status 200 }
     """
-    When I run `ghc user update --params=name:peter-murach`
+    When I run `gcli user update --params=name:peter-murach`
     Then the exit status should be 0

data/features/watching.feature

@@ -1,21 +1,21 @@
-Feature: ghc watching
+Feature: gcli watching
 
   Scenario: Available commands
 
-    When I run `ghc watch`
+    When I run `gcli watch`
     Then the exit status should be 0
-      And the output should contain "ghc watch start"
-      And the output should contain "ghc watch stop"
-      And the output should contain "ghc watch watched"
-      And the output should contain "ghc watch watchers"
-      And the output should contain "ghc watch watching"
+      And the output should contain "gcli watch start"
+      And the output should contain "gcli watch stop"
+      And the output should contain "gcli watch watched"
+      And the output should contain "gcli watch watchers"
+      And the output should contain "gcli watch watching"
 
   Scenario: Watchers
     Given the GitHub API server:
     """
     get('/repos/wycats/thor/watchers') { status 200 }
     """
-    When I run `ghc watch watchers wycats thor`
+    When I run `gcli watch watchers wycats thor`
     Then the exit status should be 0
 
   Scenario: Start watching
@@ -23,7 +23,7 @@ Feature: ghc watching
     """
     put('/user/watched/wycats/thor') { status 200 }
     """
-    When I run `ghc watch start wycats thor`
+    When I run `gcli watch start wycats thor`
     Then the exit status should be 0
 
   Scenario: Stop watching
@@ -31,7 +31,7 @@ Feature: ghc watching
     """
     delete('/user/watched/wycats/thor') { status 200 }
     """
-    When I run `ghc watch stop wycats thor`
+    When I run `gcli watch stop wycats thor`
     Then the exit status should be 0
 
   Scenario: Watching
@@ -39,7 +39,7 @@ Feature: ghc watching
     """
     get('/user/watched/wycats/thor') { status 200 }
     """
-    When I run `ghc watch watching wycats thor`
+    When I run `gcli watch watching wycats thor`
     Then the exit status should be 0
 
   Scenario: Watched by a user
@@ -47,7 +47,7 @@ Feature: ghc watching
     """
     get('/users/wycats/watched') { status 200 }
     """
-    When I run `ghc watch watched -u wycats`
+    When I run `gcli watch watched -u wycats`
     Then the exit status should be 0
 
   Scenario: Watched by the authenticated user
@@ -55,6 +55,6 @@ Feature: ghc watching
     """
     get('/user/watched') { status 200 }
     """
-    When I run `ghc watch watched`
+    When I run `gcli watch watched`
     Then the exit status should be 0
 

data/fixtures/simple_config

@@ -1,9 +1,10 @@
 ---
-oauth_token: ad7f9asdf97as98df7as9fd7
-basic_auth: 'login:password'
-host:
-user:
-repo:
-commands:
-  issue-list: { inputs: 'ticket' }
-  issue-get: {}
+auth.token: ad7f9asdf97as98df7as9fd7
+auth.basic: 'login:password'
+core.host:
+core.user:
+core.repo:
+commands.issue.list:
+  title: 'ticket'
+commands.issue.get:
+  title: 'ticket'

data/github_cli.gemspec

@@ -9,17 +9,17 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://github.com/peter-murach/github_cli"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
+  gem.files         = `git ls-files`.split("\n") + Dir.glob("lib/github_cli/man/**/*")
   gem.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
   gem.name          = "github_cli"
   gem.require_paths = ["lib"]
   gem.version       = GithubCLI::VERSION
 
   gem.add_dependency 'github_api', '~> 0.6'
-  gem.add_dependency 'thor'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'aruba'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'communist'
+  gem.add_development_dependency 'ronn'
 end

data/lib/github_cli/api.rb

@@ -20,9 +20,9 @@ module GithubCLI
 
       def configure_api
         @@api = Github.new
-        @@api.oauth_token = GithubCLI.config['oauth_token']
-        @@api.basic_auth  = GithubCLI.config['basic_auth']
-        puts "#{ENV['TEST_HOST']}"
+        @@api.oauth_token = GithubCLI.config['auth.token']
+        @@api.basic_auth  = GithubCLI.config['auth.basic']
+        @@api.endpoint    = GithubCLI.config['core.endpoint'] || @@api.endpoint
         if ENV['TEST_HOST']
           @@api.endpoint = 'http://' + ENV['TEST_HOST']
         end

data/lib/github_cli/cli.rb

@@ -18,56 +18,135 @@ module GithubCLI
       'reference'  => 'ref',
       'is'         => :issue,
       '--version'  => 'version',
+      '-V'         => 'version',
       'ls'         => 'list'
     }
 
     map ALIASES
 
     class_option :config, :type => :string,
-                 :desc => "Configuration file.", :banner => "Config file name",
+                 :desc => "Configuration file.", :banner => "<filename>",
                  :default => ".githubrc"
-    class_option :oauth, :type => :string, :aliases => '-a',
+    class_option :token, :type => :string,
                  :desc => 'Authentication token.',
-                 :banner => 'Set authentication token'
+                 :banner => '<oauth token>'
     class_option "no-color", :type => :boolean,
                  :desc => "Disable colorization in output."
     class_option "no-pager", :type => :boolean,
                  :desc => "Disable pagination of the output."
     class_option :pager, :type => :string, :aliases => '-p',
-                 :desc => "Command to be used for paging. Command can have options after it i.e. 'less -r'. Defaults to common pagers i.e. less if detected.",
-                 :banner => "less, more etc..."
+                 :desc => "Command to be used for paging.",
+                 :banner => "less|more|..."
     class_option :verbose, :type => :boolean,
                  :desc => "Enable verbose output mode."
-    class_option :version, :type => :boolean,
+    class_option :version, :type => :boolean, :aliases => ['-V'],
                  :desc => "Show program version"
 
-    desc 'init', 'Generates a configuration file in your home directory'
+    no_tasks do
+      def defaults
+        {
+          'auth.token'    => nil,
+          'auth.basic'    => nil,
+          'auth.login'    => nil,
+          'auth.password' => nil,
+          'core.endpoint' => nil,
+          'core.editor'   => 'vi',
+          'core.pager'    => 'less',
+          'core.no-pager' => false,
+          'core.no-color' => false,
+          'core.format'   => 'csv',
+          'core.auto'     => false,
+          'core.aliases'  => {}
+        }
+      end
+    end
+
+    desc 'init [<filename>]', 'Generates a configuration file in your home directory'
     long_desc <<-DESC
       Initializes a configuration file where you can set default options for
-      interacting with GitHub API. Both global and per-command options can be
-      specified. These defaults override the bult-in defaults and allow you to
-      omit commonly used command line options.
+      interacting with GitHub API.\n
+
+      Both global and per-command options can be specified. These defaults
+      override the bult-in defaults and allow you to save typing commonly  used
+      command line options.
     DESC
     method_option :force, :type => :boolean, :default => false, :aliases => "-f",
                   :banner => "Overwrite configuration file. "
+    method_option :global, :type => :boolean, :default => false,
+                  :desc => 'Create global config file'
+    method_option :local, :type => :boolean, :default => false,
+                  :desc => 'Create local config file'
     def init(filename=nil)
-      if filename.nil? || filename =~ /^\//
-        @config_filename = options[:config]
-      else
-        @config_filename = filename
+      config_filename = (filename.nil? || filename =~ /^\//)? options[:config] : filename
+
+      if !options[:global] and !options[:local]
+        GithubCLI.ui.error 'Invalid scope given. Please use --local or --global.'
+        exit 1
       end
 
-      # config = Config.new(@config_filename)
+      GithubCLI.config.location = options[:local] ? 'local' : 'global'
+
       if File.exists?(GithubCLI.config.path) && !options[:force]
         GithubCLI.ui.error "Not overwritting existing config file #{GithubCLI.config.path}, use --force to override."
         exit 1
       end
 
       oauth_token = ask "Please specify your GitHub Authentication Token (register on github.com to get it):"
-      GithubCLI.config.save({'oauth_token' => oauth_token, 'basic_auth' => nil })
+      GithubCLI.config.save(defaults.merge({'auth.token' => oauth_token}))
       GithubCLI.ui.confirm "Writing new configuration file to #{GithubCLI.config.path}"
     end
 
+    desc 'config <name> [<value>]', 'Get and set GitHub configuration options'
+    long_desc <<-DESC
+      You can query/set options with this command. The name is actually a hash key
+      string that is a composite one, nested with dots. If only name is provided, a
+      value will be retrieved. If two parameters are given then value will be set
+      or updated depending whether it already exists or not.\n
+
+      There two types of config files, global and project specific. When modifying
+      options ensure that you modifying the correct config.
+    DESC
+    method_option :global, :type => :boolean, :default => false,
+                  :desc => 'use global config file'
+    method_option :local, :type => :boolean, :default => false,
+                  :desc => 'use local config file'
+    method_option :list, :type => :boolean, :default => false, :aliases => '-l',
+                  :desc => 'list all'
+    method_option :edit, :type => :boolean, :default => false, :aliases => '-e',
+                  :desc => 'opens an editor'
+    def config(*args)
+      name, value = args.shift, args.shift
+
+      GithubCLI.config.location = options[:local] ? 'local' : 'global'
+
+      if !options[:global] and !options[:local]
+        GithubCLI.ui.error 'Invalid scope given. Please use --local or --global.'
+        exit 1
+      elsif !File.exists?(GithubCLI.config.path)
+        GithubCLI.ui.error "#{GithubCLI.config.location} configuration file does not exist. Please use `#{GithubCLI.executable_name} init --#{GithubCLI.config.location}`"
+        exit 1
+      end
+
+      if options[:list]
+        Terminal.print_config(name) && return
+      elsif options[:edit]
+        editor = Editor.new GithubCLI.config.path
+        editor.open && return
+      end
+
+      if !name
+        Terminal.print_config && return
+      end
+
+      if !value
+        Terminal.line GithubCLI.config[name]
+      else
+        Terminal.line GithubCLI.config[name] = value
+      end
+
+      return
+    end
+
     desc 'list <pattern>', 'List all available commands limited by pattern'
     def list(pattern="")
       pattern = /^#{pattern}.*$/i
@@ -76,7 +155,7 @@ module GithubCLI
 
     desc 'version', 'Display Github CLI version.'
     def version
-      say "Github CLI #{GithubCLI::VERSION}"
+      GithubCLI.ui.info "#{GithubCLI.program_name} v#{GithubCLI::VERSION}"
     end
 
   end # CLI