github_cli 0.5.9 → 0.6.0

data/.travis.yml

@@ -16,6 +16,7 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: jruby-18mode
+    - rvm: rbx-18mode
     - rvm: jruby-19mode
 branches:
   only: master

data/CHANGELOG.md

@@ -1,8 +1,19 @@
-0.5.9 (April , 2013)
+0.6.0 (June 1, 2013)
+
+* Add authorize command to ease pain with getting authenticated
+* Add 'every' flag to repository listing command
+* Add 'public' flag to gist listing command
+* Change all commands to pass through global options to configure api requests
+* Update vendor dependencies
+* Add ability to configure all github api request options
+
+0.5.9 (April 17, 2013)
 
 * Change API class configure to take options and allow for basic auth,
   stop using class api variable
 * Change API commands to take and pass options for global configuration
+* Add --quiet option for supressing output only for repo/hook/auth commands
+* Fix problem with repo create command and boolean option flags
 
 0.5.8 (April 14, 2013)
 

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    github_cli (0.5.9)
-      github_api (~> 0.9)
+    github_cli (0.6.0)
+      github_api (~> 0.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.3.4)
     aruba (0.5.1)
       childprocess (~> 0.3.6)
       cucumber (>= 1.1.1)
@@ -24,28 +25,29 @@ GEM
       gherkin (~> 2.11.0)
       json (>= 1.4.6)
     diff-lcs (1.2.1)
-    faraday (0.8.6)
+    faraday (0.8.7)
       multipart-post (~> 1.1)
     ffi (1.3.1)
     gherkin (2.11.6)
       json (>= 1.7.6)
-    github_api (0.9.3)
+    github_api (0.10.1)
+      addressable
       faraday (~> 0.8.1)
-      hashie (~> 2.0)
+      hashie (>= 1.2)
       multi_json (~> 1.4)
       nokogiri (~> 1.5.2)
       oauth2
-    hashie (2.0.2)
+    hashie (2.0.5)
     hpricot (0.8.6)
     httpauth (0.2.0)
-    json (1.7.6)
-    jwt (0.1.7)
+    json (1.8.0)
+    jwt (0.1.8)
       multi_json (>= 1.5)
-    multi_json (1.6.1)
+    multi_json (1.7.4)
     multi_xml (0.5.3)
     multipart-post (1.2.0)
     mustache (0.99.4)
-    nokogiri (1.5.6)
+    nokogiri (1.5.9)
     oauth2 (0.9.1)
       faraday (~> 0.8)
       httpauth (~> 0.1)

data/README.md

@@ -54,8 +54,12 @@ user.name             # Default user name
 user.repo             # Default repo name
 user.org              # Default organization name
 core.editor           # Editor to be opened
+core.endpoint         # The api endpoint, by deafult https://api.github.com
+core.site             # The web endpoint, by default https://github.com
 core.pager            # Pager to be used, by default less
 core.format           # Output formating
+core.quiet            # Surpass output to show only response status
+core.ssl              # SSL settings
 core.auto_pagination  # Switch on default results pagination, default false
 ```
 
@@ -181,6 +185,14 @@ to limit returned results pass `pattern`
 $ gcli list re*   # Returns all commands matching the pattern
 ```
 
+### Subcommands
+
+To see a list of subcommands that a given command provides just type top-level command like so
+
+```shell
+$ gcli repo
+```
+
 ### Output Format
 
 The API responses can be formatted as `csv`, `json`, `pretty`, `table`.
@@ -196,6 +208,12 @@ To get `csv` formatting for easy command piping do
 gcli repo ls -u wycats --format=csv
 ```
 
+To suppress output pass `--quiet` option like so
+
+```shell
+gcli repo create ... --quiet=true
+```
+
 ### Output Paging
 
 By default all responses are paged. You can switch off paging by supplying `no-pager` flag.

data/features/authorization.feature

@@ -0,0 +1,53 @@
+Feature: gcli auth
+
+  @ci-run
+  Scenario: Available commands
+
+    When I run `gcli auth`
+    Then the exit status should be 0
+      And the output should contain "auth list"
+      And the output should contain "auth get"
+      And the output should contain "auth create"
+      And the output should contain "auth update"
+      And the output should contain "auth delete"
+
+  Scenario: List authorizations
+    Given the Github API server:
+    """
+    get('/authorizations') { status 200 }
+    """
+    When I run `gcli auth ls --login=piotr --password=secret`
+    Then the exit status should be 0
+
+  Scenario: Get authorization
+    Given the Github API server:
+    """
+    get('/authorizations/1') { status 200 }
+    """
+    When I run `gcli auth get 1 --login=piotr --password=secret`
+    Then the exit status should be 0
+
+  Scenario: Create authorization
+    Given the Github API server:
+    """
+    post('/authorizations') { status 200 }
+    """
+    When I run `gcli auth create --scopes=repo --login=piotr --password=secret`
+    Then the exit status should be 0
+
+  Scenario: Update authorization
+    Given the Github API server:
+    """
+    patch('/authorizations/1') { status 200 }
+    """
+    When I run `gcli auth update 1 --scopes=repo --login=piotr --password=secret`
+    Then the exit status should be 0
+
+  Scenario: Delete authorization
+    Given the Github API server:
+    """
+    delete('/authorizations/1') { status 200 }
+    """
+    When I run `gcli auth delete 1 --login=piotr --password=secret`
+    Then the exit status should be 0
+

data/features/blob.feature

@@ -21,5 +21,5 @@ Feature: gcli blob
     """
     post('/repos/wycats/thor/git/blobs') { status 200 }
     """
-    When I run `gcli blob create wycats thor --params=content:'Content' encoding:'utf-8'`
+    When I run `gcli blob create wycats thor --content=Content --encoding='utf-8'`
     Then the exit status should be 0

data/features/download.feature

@@ -1,14 +1,15 @@
 Feature: gcli download
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli download`
     Then the exit status should be 0
-      And the output should contain "gcli download create"
-      And the output should contain "gcli download delete"
-      And the output should contain "gcli download get"
-      And the output should contain "gcli download list"
-      And the output should contain "gcli download upload"
+      And the output should contain "download create"
+      And the output should contain "download delete"
+      And the output should contain "download get"
+      And the output should contain "download list"
+      And the output should contain "download upload"
 
   Scenario: List downloads
     Given the GitHub API server:
@@ -26,18 +27,19 @@ Feature: gcli download
     When I run `gcli download get wycats thor 1`
     Then the exit status should be 0
 
-  Scenario: Delete download
+  Scenario: Create download
     Given the GitHub API server:
     """
-    delete('/repos/wycats/thor/downloads/1') { status 200 }
+    post('/repos/wycats/thor/downloads') { status 200 }
     """
-    When I run `gcli download delete wycats thor 1`
+    When I run `gcli download create wycats thor --name=octo.jpg --size=113410`
     Then the exit status should be 0
 
-  Scenario: Create download
+  Scenario: Delete download
     Given the GitHub API server:
     """
-    post('/repos/wycats/thor/downloads') { status 200 }
+    delete('/repos/wycats/thor/downloads/1') { status 200 }
     """
-    When I run `gcli download create wycats thor --params=name:octo.jpg size:113410`
+    When I run `gcli download delete wycats thor 1`
     Then the exit status should be 0
+

data/features/gist.feature

@@ -32,11 +32,19 @@ Feature: gcli gist
     Then the exit status should be 0
 
   Scenario: List public gists for the authenticated user
+    Given the GitHub API server:
+    """
+    get('/gists') { status 200 }
+    """
+    When I run `gcli gist ls --login=piotr --password=secret`
+    Then the exit status should be 0
+
+  Scenario: List all public gists
     Given the GitHub API server:
     """
     get('/gists/public') { status 200 }
     """
-    When I run `gcli gist ls`
+    When I run `gcli gist ls --public`
     Then the exit status should be 0
 
   Scenario: Get gist

data/features/label.feature

@@ -1,19 +1,18 @@
 Feature: gcli label
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli label`
     Then the exit status should be 0
-      And the output should contain "gcli label add"
-      And the output should contain "gcli label create"
-      And the output should contain "gcli label delete"
-      And the output should contain "gcli label get"
-      And the output should contain "gcli label issue"
-      And the output should contain "gcli label list"
-      And the output should contain "gcli label milestone"
-      And the output should contain "gcli label remove"
-      And the output should contain "gcli label replace"
-      And the output should contain "gcli label update"
+      And the output should contain "label add"
+      And the output should contain "label create"
+      And the output should contain "label delete"
+      And the output should contain "label get"
+      And the output should contain "label list"
+      And the output should contain "label remove"
+      And the output should contain "label replace"
+      And the output should contain "label update"
 
   Scenario: List labels
     Given the GitHub API server:
@@ -36,7 +35,7 @@ Feature: gcli label
     """
     post('/repos/wycats/thor/labels') { status 200 }
     """
-    When I run `gcli label create wycats thor --params=name:bug color:f3f3f3`
+    When I run `gcli label create wycats thor --name=bug --color=f3f3f3`
     Then the exit status should be 0
 
   Scenario: Update label
@@ -44,7 +43,7 @@ Feature: gcli label
     """
     patch('/repos/wycats/thor/labels/1') { status 200 }
     """
-    When I run `gcli label update wycats thor 1 --params=name:bug color:f3f3f3`
+    When I run `gcli label update wycats thor 1 --name=bug --color=f3f3f3`
     Then the exit status should be 0
 
   Scenario: Delete label

data/features/member.feature

@@ -1,13 +1,14 @@
 Feature: gcli member
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli member`
     Then the exit status should be 0
-      And the output should contain "gcli member delete"
-      And the output should contain "gcli member list"
-      And the output should contain "gcli member member"
-      And the output should contain "gcli member publicize"
+      And the output should contain "member delete"
+      And the output should contain "member list"
+      And the output should contain "member member"
+      And the output should contain "member publicize"
 
   Scenario: List members
     Given the GitHub API server:

data/features/merging.feature

@@ -1,10 +1,11 @@
 Feature: gcli merge
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli merge`
     Then the exit status should be 0
-      And the output should contain "gcli merge perform"
+      And the output should contain "merge perform"
 
   Scenario: Merge success
     Given the GitHub API server:
@@ -15,7 +16,7 @@ Feature: gcli merge
       status 201
     }
     """
-    When I successfully run `gcli merge perform wycats thor --params=base:master head:cool_feature`
+    When I successfully run `gcli merge perform wycats thor --base=master --head=cool_feature`
     Then the stdout should contain "octokit"
       And the stdout should contain "201"
 
@@ -26,7 +27,7 @@ Feature: gcli merge
       status 204
     }
     """
-    When I successfully run `gcli merge perform wycats thor --params=base:master head:cool_feature`
+    When I successfully run `gcli merge perform wycats thor --base=master --head=cool_feature`
     Then the stdout should contain "204"
 
   Scenario: Merge conflict
@@ -37,7 +38,7 @@ Feature: gcli merge
       status 409
     }
     """
-    When I run `gcli merge perform wycats thor --params=base:master head:cool_feature`
+    When I run `gcli merge perform wycats thor --base=master --head=cool_feature`
     Then the exit status should be 1
     Then the stdout should contain "Merge conflict"
       And the stdout should contain "409"

data/features/organization.feature

@@ -1,12 +1,13 @@
 Feature: gcli org
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli org`
     Then the exit status should be 0
-      And the output should contain "gcli org edit"
-      And the output should contain "gcli org list"
-      And the output should contain "gcli org get"
+      And the output should contain "org edit"
+      And the output should contain "org list"
+      And the output should contain "org get"
 
   Scenario: List public organizations for a user
     Given the GitHub API server:
@@ -37,5 +38,5 @@ Feature: gcli org
     """
     patch('/orgs/rails') { status 200 }
     """
-    When I run `gcli org edit rails --params=name:github company:GitHub email:support@github.com`
+    When I run `gcli org edit rails --name=github --company=GitHub --email=support@github.com`
     Then the exit status should be 0

data/features/repository.feature

@@ -21,7 +21,15 @@ Feature: gcli repository
     """
     get('/repositories') { status 200 }
     """
-    When I run `gcli repo ls`
+    When I run `gcli repo ls --every`
+    Then the exit status should be 0
+
+  Scenario: List all repositories for the authenticated user
+    Given the GitHub API server:
+    """
+    get('/user/repos') { status 200 }
+    """
+    When I run `gcli repo ls --login=piotr --password=secret`
     Then the exit status should be 0
 
   Scenario: List repositories for user

data/features/search.feature

@@ -1,13 +1,14 @@
 Feature: gcli search
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli search`
     Then the exit status should be 0
-      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"
+      And the output should contain "search email"
+      And the output should contain "search issue"
+      And the output should contain "search repo"
+      And the output should contain "search user"
 
   Scenario: Search issues
     Given the GitHub API server:

data/github_cli.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = GithubCLI::VERSION
 
-  gem.add_dependency 'github_api', '~> 0.9'
+  gem.add_dependency 'github_api', '~> 0.10'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'aruba'

data/lib/github_cli/api.rb

@@ -5,64 +5,71 @@ module GithubCLI
   # The API class is the main entry point for creating GithubCLI APIs.
   class API
 
-    class << self
-
-      # Access or initialize Github API client
-      #
-      # @api public
-      def github_api(options={})
-        @github_api ||= begin
-          @github_api = configure(options)
-        end
-      end
-
-      # this could become a command such as configure that gets class options
-      #
-      # @api public
-      def configure(options={})
-        api    = Github.new
-        config = GithubCLI.config.data
-
-        api.oauth_token = config['user.token'] if config['user.token']
+    # Access or initialize Github API client
+    #
+    # @api public
+    def self.github_api(options={})
+      @github_api ||= configure(options)
+    end
 
-        api.basic_auth  = set_basic_auth(config, options)
+    # Configures api options if provided in the configuration file
+    #
+    # @api public
+    def self.configure(options={})
+      api    = Github.new
+      config = GithubCLI.config
 
-        api.endpoint    = config['core.endpoint'] if config['core.endpoint']
+      api.basic_auth  = set_basic_auth(config, options)
+      api.ssl         = config['core.ssl']      if config['core.ssl']
+      api.adapter     = config['core.adapter']  if config['core.adapter']
+      api.oauth_token = config['user.token']    if config['user.token']
+      api.site        = config['core.site']     if config['core.site']
+      api.endpoint    = config['core.endpoint'] if config['core.endpoint']
+      api.auto_pagination = options['auto_pagination'] || config['core.auto_pagination']
 
-        if ENV['TEST_HOST']
-          api.endpoint = 'http://' + ENV['TEST_HOST']
-        end
-        api
+      if (test_env = ENV['TEST_HOST'])
+        api.endpoint = 'http://' + test_env
       end
+      api
+    end
 
-      # Set user basic authentication
-      #
-      # @api public
-      def set_basic_auth(config, options)
-        if options['login'] && options['password']
-           "#{options['login']}:#{options['password']}"
-        elsif config['user.login'] && config['user.password']
-          "#{config['user.login']}:#{config['user.password']}"
-        else
-          nil
-        end
+    # Set user basic authentication
+    #
+    # @api public
+    def self.set_basic_auth(config, options)
+      if (login = options['login']) && (password = options['password'])
+        "#{login}:#{password}"
+      elsif (login = config['user.login']) && (password = config['user.password'])
+        "#{login}:#{password}"
+      else
+        nil
       end
+    end
 
-      # Procoess response and output to shell
-      # TODO: change to take options
-      # @api public
-      def output(format=:table, quiet=false, &block)
-        GithubCLI.on_error do
-          response  = block.call
-          if response.respond_to?(:body)
-            formatter = Formatter.new response, :format => format, :quiet => quiet
-            formatter.render_output
-          else
-            response
-          end
+    # Procoess response and output to shell
+    #
+    # @param [Hash] options the options to format the output
+    # @option options [String] :format
+    #   The format type
+    # @option options [String] :quiet
+    #   The flag for reducing the output
+    #
+    # @api public
+    def self.output(options, &block)
+      config = GithubCLI.config
+      format = options.fetch(:format) { config['core.format'] || :table }
+      quiet  = options.fetch(:quiet)  { config['core.quiet'] }
+
+      GithubCLI.on_error do
+        response  = block.call
+        if response.respond_to?(:body)
+          formatter = Formatter.new response, :format => format, :quiet => quiet
+          formatter.render_output
+        else
+          Terminal.line response
         end
+        response
       end
-
     end
 
   end # API

data/lib/github_cli/apis/assignee.rb

@@ -5,15 +5,15 @@ module GithubCLI
 
     class << self
 
-      def all(user, repo, params, format)
-        output format do
-          github_api.issues.assignees.list user, repo, params
+      def all(user, repo, params, options)
+        output options do
+          github_api(options).issues.assignees.list user, repo, params
         end
       end
 
-      def check(user, repo, assignee, params, format)
-        output format do
-          github_api.issues.assignees.check user, repo, assignee, params
+      def check(user, repo, assignee, params, options)
+        output options do
+          github_api(options).issues.assignees.check user, repo, assignee, params
         end
       end
     end

data/lib/github_cli/apis/authorization.rb

@@ -6,31 +6,31 @@ module GithubCLI
     class << self
 
       def all(params, options)
-        output options[:format], options[:quiet] do
+        output options do
           github_api(options).oauth.list params
         end
       end
 
       def get(id, params, options)
-        output options[:format], options[:quiet] do
+        output options do
           github_api(options).oauth.get id, params
         end
       end
 
       def create(params, options)
-        output options[:format], options[:quiet] do
+        output options do
           github_api(options).oauth.create params
         end
       end
 
       def update(id, params, options)
-        output options[:format], options[:quiet] do
+        output options do
           github_api(options).oauth.update id, params
         end
       end
 
       def delete(id, params, options)
-        output options[:format], options[:quiet] do
+        output options do
           github_api(options).oauth.delete id, params
         end
       end

data/lib/github_cli/apis/blob.rb

@@ -5,15 +5,15 @@ module GithubCLI
 
     class << self
 
-      def get(user, repo, sha, params, format)
-        output format do
-          github_api.git_data.blobs.get user, repo, sha, params
+      def get(user, repo, sha, params, options)
+        output options do
+          github_api(options).git_data.blobs.get user, repo, sha, params
         end
       end
 
-      def create(user, repo, params, format)
-        output format do
-          github_api.git_data.blobs.create user, repo, params
+      def create(user, repo, params, options)
+        output options do
+          github_api(options).git_data.blobs.create user, repo, params
         end
       end
     end