github_cli 0.3.1 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+0.4.0 (June 15, 2012)
+
+* Add user api commands.
+* Add user followers api commands.
+* Add organizations api commands.
+* Add organization members api commands.
+* Add organization teams api commands.
+* Add gem logo.
+* Add system configuration utilities.
+* Add response pager to automatically paginate long output with ability to switch
+  it off as well as specify custom pager command.
+* Fix issue with output formatting when simple string response is returned.
+* Add interface feature tests.
+* Add printing of command usage information.
+* Refactor utility methods.
+* Add new formatter for the output rendering.
+* Refactor table & csv output, add vertical & horizontal table rendering.
+* Add utility methods for string truncation and padding.
+* Add ability to output to editor.
+* Update gem dependecies and gem summary.
+
 0.3.1 (May 30, 2012)
 
 * Add milestone api commands.

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    github_cli (0.3.1)
-      github_api (~> 0.5)
+    github_cli (0.4.0)
+      github_api (~> 0.6)
       thor
 
 GEM
@@ -14,21 +14,20 @@ GEM
       ffi (>= 1.0.11)
       rspec (>= 2.7.0)
     builder (3.0.0)
-    childprocess (0.3.1)
+    childprocess (0.3.2)
       ffi (~> 1.0.6)
-    cucumber (1.1.9)
+    cucumber (1.2.1)
       builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (~> 2.9.0)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
       json (>= 1.4.6)
-      term-ansicolor (>= 1.0.6)
     diff-lcs (1.1.3)
-    faraday (0.8.0)
+    faraday (0.8.1)
       multipart-post (~> 1.1)
     ffi (1.0.11)
-    gherkin (2.9.0)
+    gherkin (2.11.0)
       json (>= 1.4.6)
-    github_api (0.5.2)
+    github_api (0.6.0)
       faraday (~> 0.8.0)
       hashie (~> 1.2.0)
       multi_json (~> 1.3)
@@ -36,10 +35,10 @@ GEM
       oauth2 (~> 0.7)
     hashie (1.2.0)
     httpauth (0.1)
-    json (1.6.5)
-    multi_json (1.3.2)
+    json (1.7.3)
+    multi_json (1.3.6)
     multipart-post (1.1.5)
-    nokogiri (1.5.2)
+    nokogiri (1.5.3)
     oauth2 (0.7.1)
       faraday (~> 0.8)
       httpauth (~> 0.1)
@@ -47,15 +46,14 @@ GEM
       rack (~> 1.4)
     rack (1.4.1)
     rake (0.9.2.2)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    term-ansicolor (1.0.7)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
     thor (0.15.2)
 
 PLATFORMS

data/README.md

@@ -1,4 +1,4 @@
-# GithubCLI
+# GithubCLI<img src="https://github.com/peter-murach/github_cli/raw/master/ghc_logo.png" align="right" />
 [![Build Status](https://secure.travis-ci.org/peter-murach/github_cli.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/peter-murach/github_cli.png?travis)][gemnasium]
 
 [travis]: http://travis-ci.org/peter-murach/github_cli
@@ -95,10 +95,19 @@ $ ghc gist
 Interact with users:
 
 ```shell
+$ ghc user
 $ ghc email
 $ ghc follower
 ```
 
+Interact with organizations:
+
+```shell
+$ ghc org
+$ ghc member
+$ ghc team
+```
+
 Interact with authorizations:
 
 ```shell
@@ -107,12 +116,18 @@ $ ghc auth
 
 ### Output Format
 
-The API responses can be formattaed as `csv`, `json`, `pretty`, `table`.
+The API responses can be formatted as `csv`, `json`, `pretty`, `table`.
 
-By default responses are in tabular format. Run the following
+By default responses are in tabular format. Tables are available in `horizontal` and `vertical` mode. To enforce table display pass `:h` and `:v` respectively. Otherwise a default orientation will be picked depending on the request made and terminal size.
 
 ```shell
-ghc repo get peter-murach github_cli
+ghc user get -u peter-murach --format=table:h
+
+┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳
+┃ type     ┃ login    ┃ public_… ┃ blog     ┃ hireable ┃ followe… ┃ followi… ┃ location ┃ html_url ┃ name     ┃
+┣━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋
+┃ User     ┃ peter-m… ┃ 14       ┃ peter-m… ┃ false    ┃ 18       ┃ 52       ┃ Sheffie… ┃ https:/… ┃ Piotr M… ┃
+┗━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻
 ```
 
 To get `csv` formatting for easy command piping do
@@ -121,6 +136,16 @@ To get `csv` formatting for easy command piping do
 ghc repo ls -u wycats --format=csv
 ```
 
+### Output Paging
+
+By default all responses are paged. You can switch off paging by supplying `no-pager` flag.
+
+```shell
+ghc --no-pager user ls -u wycats
+```
+
+Also you can supply you preferred `pager`, otherwise the paging program is taken from environment variable PAGER if defined or defaults to "less".
+
 ### Examples
 
 You can create repository by supplying required parameters

data/bin/ghc

@@ -12,7 +12,7 @@ rescue Interrupt => e
 rescue SystemExit => e
   exit e.status
 rescue Exception => e
-  GithubCLI.ui.error "Fatal error has occurred." + e.message
+  GithubCLI.ui.error "Fatal error has occurred. " + e.message
   GithubCLI.ui.debug e.backtrace.join("\n")
   exit 1
 end

data/features/download.feature

@@ -0,0 +1,11 @@
+Feature: ghc download
+
+  Scenario: Available commands
+
+    When I run `ghc download`
+    Then the exit status should be 0
+      And the output should contain "ghc download create"
+      And the output should contain "ghc download delete"
+      And the output should contain "ghc download get"
+      And the output should contain "ghc download list"
+      And the output should contain "ghc download upload"

data/features/email.feature

@@ -0,0 +1,9 @@
+Feature: ghc email
+
+  Scenario: Available commands
+
+    When I run `ghc email`
+    Then the exit status should be 0
+      And the output should contain "ghc email delete"
+      And the output should contain "ghc email list"
+      And the output should contain "ghc email add"

data/features/errors.feature

@@ -0,0 +1,10 @@
+Feature: ghc errors notification
+
+  Scenario: Unknown formatting option
+
+    When I run `ghc repo list -u wycats --format=unknown`
+    Then the exit status should be 1
+    And the output should contain:
+    """
+    Fatal error has occurred. Unrecognized formatting options: unknown
+    """

data/features/event.feature

@@ -0,0 +1,14 @@
+Feature: ghc event
+
+  Scenario: Available commands
+
+    When I run `ghc event`
+    Then the exit status should be 0
+      And the output should contain "ghc event issue"
+      And the output should contain "ghc event network"
+      And the output should contain "ghc event org"
+      And the output should contain "ghc event performed"
+      And the output should contain "ghc event public"
+      And the output should contain "ghc event received"
+      And the output should contain "ghc event repo"
+      And the output should contain "ghc event user_org"

data/features/executable.feature

@@ -6,32 +6,59 @@ Feature: The GHC Executable
   I have access to command line interface
 
   Scenario Outline: Getting Help for Commands
-    When I run `ghc <command>`
+
+    When I run `ghc <cmd>`
     Then the exit status should be 0
     And the output should contain:
     """
-      ghc help [TASK]
+      ghc help <command>
     """
     Examples:
-      | command |
-      |         |
-      | help    |
+      | cmd  |
+      |      |
+      | help |
+
+  Scenario: Getting Usage for Commands
+
+    When I run `ghc`
+    Then the exit status should be 0
+    And the output should contain "Usage: ghc"
+      And the output should contain "[--config]"
+      And the output should contain "[--no-color]"
+      And the output should contain "[--no-pager]"
+      And the output should contain "[--version]"
+      And the output should contain "[--verbose]"
 
   Scenario Outline: Getting Subcommands
+
     When I run `ghc <command>`
     Then the exit status should be 0
     And the output should contain "ghc <command>"
 
     Examples:
-      | command  |
-      | auth     |
-      | repo     |
-      | issue    |
-      | blob     |
-      | tree     |
-      | ref      |
-      | pull     |
-      | fork     |
-      | commit   |
-      | download |
-      | key      |
+      | command   |
+      | auth      |
+      | blob      |
+      | commit    |
+      | download  |
+      | email     |
+      | event     |
+      | follower  |
+      | fork      |
+      | gist      |
+      | hook      |
+      | issue     |
+      | key       |
+      | label     |
+      | member    |
+      | milestone |
+      | org       |
+      | pull      |
+      | ref       |
+      | repo      |
+      | tag       |
+      | team      |
+      | tree      |
+      | user      |
+      | watch     |
+

data/features/follower.feature

@@ -0,0 +1,11 @@
+Feature: ghc follower
+
+  Scenario: Available commands
+
+    When I run `ghc follower`
+    Then the exit status should be 0
+      And the output should contain "ghc follower follow"
+      And the output should contain "ghc follower follower"
+      And the output should contain "ghc follower following"
+      And the output should contain "ghc follower list"
+      And the output should contain "ghc follower unfollow"

data/features/fork.feature

@@ -0,0 +1,13 @@
+Feature: ghc fork
+
+  Scenario: Available commands
+
+    When I run `ghc fork`
+    Then the exit status should be 0
+      And the output should contain "ghc fork create"
+      And the output should contain "ghc fork list"
+
+#   Scenario: List forks
+#     When I run `ghc fork ls wycats thor` interactively
+#       And I type "q"
+#     Then the exit status should be 0

data/features/hook.feature

@@ -0,0 +1,12 @@
+Feature: ghc hook
+
+  Scenario: Available commands
+
+    When I run `ghc hook`
+    Then the exit status should be 0
+      And the output should contain "ghc hook create"
+      And the output should contain "ghc hook delete"
+      And the output should contain "ghc hook edit"
+      And the output should contain "ghc hook get"
+      And the output should contain "ghc hook list"
+      And the output should contain "ghc hook test"

data/features/label.feature

@@ -0,0 +1,16 @@
+Feature: ghc label
+
+  Scenario: Available commands
+
+    When I run `ghc label`
+    Then the exit status should be 0
+      And the output should contain "ghc label add"
+      And the output should contain "ghc label create"
+      And the output should contain "ghc label delete"
+      And the output should contain "ghc label get"
+      And the output should contain "ghc label issue"
+      And the output should contain "ghc label list"
+      And the output should contain "ghc label milestone"
+      And the output should contain "ghc label remove"
+      And the output should contain "ghc label replace"
+      And the output should contain "ghc label update"

data/features/member.feature

@@ -0,0 +1,18 @@
+Feature: ghc member
+
+  Scenario: Available commands
+
+    When I run `ghc member`
+    Then the exit status should be 0
+      And the output should contain "ghc member delete"
+      And the output should contain "ghc member list"
+      And the output should contain "ghc member member"
+      And the output should contain "ghc member publicize"
+
+#   Scenario: List an organization members
+#     When I run `ghc member ls rails`
+#     Then the exit status should be 0
+# 
+#   Scenario: List an organization public members
+#     When I run `ghc member ls rails --public`
+#     Then the exit status should be 0

data/features/milestone.feature

@@ -0,0 +1,11 @@
+Feature: ghc milestone
+
+  Scenario: Available commands
+
+    When I run `ghc milestone`
+    Then the exit status should be 0
+      And the output should contain "ghc milestone create"
+      And the output should contain "ghc milestone delete"
+      And the output should contain "ghc milestone get"
+      And the output should contain "ghc milestone list"
+      And the output should contain "ghc milestone update"

data/features/organization.feature

@@ -0,0 +1,9 @@
+Feature: ghc org
+
+  Scenario: Available commands
+
+    When I run `ghc org`
+    Then the exit status should be 0
+      And the output should contain "ghc org edit"
+      And the output should contain "ghc org list"
+      And the output should contain "ghc org get"

data/features/reference.feature

@@ -0,0 +1,11 @@
+Feature: ghc ref
+
+  Scenario: Available commands
+
+    When I run `ghc ref`
+    Then the exit status should be 0
+      And the output should contain "ghc ref create"
+      And the output should contain "ghc ref delete"
+      And the output should contain "ghc ref get"
+      And the output should contain "ghc ref list"
+      And the output should contain "ghc ref update"

data/features/repositories.feature

@@ -1,9 +1,18 @@
-@repositories
-Feature: Repository Commands
+Feature: gh repository
 
-  As a developer who wants to interact with GitHub Repository API
-  I have access to commands
-
-  Scenario: List repositories
-    When I run `ghc repo list --user=wycats`
+  Scenario: Available commands
+    When I run `ghc repo`
     Then the exit status should be 0
+      And the output should contain "ghc repo branches"
+      And the output should contain "ghc repo contribs"
+      And the output should contain "ghc repo create"
+      And the output should contain "ghc repo edit"
+      And the output should contain "ghc repo get"
+      And the output should contain "ghc repo list"
+      And the output should contain "ghc repo languages"
+      And the output should contain "ghc repo tags"
+      And the output should contain "ghc repo teams"
+
+#   Scenario: List repositories
+#     When I run `ghc repo ls --user=wycats`
+#     Then the exit status should be 0

data/features/tag.feature

@@ -0,0 +1,8 @@
+Feature: ghc tag
+
+  Scenario: Available commands
+
+    When I run `ghc tag`
+    Then the exit status should be 0
+      And the output should contain "ghc tag create"
+      And the output should contain "ghc tag get"

data/features/team.feature

@@ -0,0 +1,18 @@
+Feature: ghc team
+
+  Scenario: Available commands
+    When I run `ghc 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"

data/features/tree.feature

@@ -0,0 +1,8 @@
+Feature: ghc tree
+
+  Scenario: Available commands
+
+    When I run `ghc tree`
+    Then the exit status should be 0
+      And the output should contain "ghc tree create"
+      And the output should contain "ghc tree get"

data/features/user.feature

@@ -0,0 +1,8 @@
+Feature: ghc user
+
+  Scenario: Available commands
+
+    When I run `ghc user`
+    Then the exit status should be 0
+      And the output should contain "ghc user get"
+      And the output should contain "ghc user update"

data/github_cli.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Piotr Murach"]
   gem.email         = ["pmurach@gmail.com"]
   gem.description   = %q{CLI-based access to GitHub API v3}
-  gem.summary       = %q{CLI-based access to GitHub API v3}
+  gem.summary       = %q{github_cli is a set of tools that provide full command line access to GitHub API v3}
   gem.homepage      = "http://github.com/peter-murach/github_cli"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = GithubCLI::VERSION
 
-  gem.add_dependency 'github_api', '~> 0.5'
+  gem.add_dependency 'github_api', '~> 0.6'
   gem.add_dependency 'thor'
 
   gem.add_development_dependency 'rspec'

data/lib/github_cli/api.rb

@@ -3,27 +3,30 @@
 module GithubCLI
   # The API class is the main entry point for creating GithubCLI APIs.
   class API
-    class ApiError < StandardError; end
 
     @@api = nil
 
-    def self.github_api
-      if @@api
-        @@api
-      else
+    class << self
+
+      def github_api
+        @@api ||= begin
+          @@api = configure_api
+        end
+      end
+
+      def configure_api
         @@api = Github.new
         @@api.oauth_token = GithubCLI.config['oauth_token']
         @@api.basic_auth  = GithubCLI.config['basic_auth']
         @@api
       end
-    end
 
-    def self.configure_api
-    end
+      def output(format=:table, &block)
+        response =  block.call
+        formatter = Formatter.new response, :format => format
+        formatter.render_output
+      end
 
-    def self.output(format=:table, &block)
-      response =  block.call
-      GithubCLI::Terminal.render_output response, :format => format
     end
 
     class All

data/lib/github_cli/apis/follower.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Follower < API
+
+    class << self
+
+      def all(user, params, format)
+        output format do
+          github_api.users.followers.list user, params
+        end
+      end
+
+      def following(user, params, format)
+        output format do
+          github_api.users.followers.following user, params
+        end
+      end
+
+      def follower(user, params, format)
+        output format do
+          github_api.users.followers.following? user, params
+        end
+      end
+
+      def follow(user, params, format)
+        output format do
+          github_api.users.followers.follow user, params
+        end
+      end
+
+      def unfollow(user, params, format)
+        output format do
+          github_api.users.followers.unfollow user, params
+        end
+      end
+    end
+
+  end # Follower
+end # GithubCLI

data/lib/github_cli/apis/member.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Member < API
+
+    class << self
+
+      def all(org, params, format)
+        output format do
+          github_api.orgs.members.list org, params
+        end
+      end
+
+      def all_public(org, params, format)
+        output format do
+          github_api.orgs.members.list_public org, params
+        end
+      end
+
+      def member?(org, user, params, format)
+        output format do
+          github_api.orgs.members.member? org, user, params
+        end
+      end
+
+      def public_member?(org, user, params, format)
+        output format do
+          github_api.orgs.members.public_member? org, user, params
+        end
+      end
+
+      def delete(org, user, params, format)
+        output format do
+          github_api.orgs.members.delete org, user, params
+        end
+      end
+
+      def publicize(org, user, params, format)
+        output format do
+          github_api.orgs.members.publicize org, user, params
+        end
+      end
+
+      def conceal(org, user, params, format)
+        output format do
+          github_api.orgs.members.conceal org, user, params
+        end
+      end
+    end
+
+  end # Member
+end # GithubCLI