github_cli 0.4.0 → 0.4.1

data/.travis.yml

@@ -7,3 +7,6 @@ notifications:
 rvm:
   - 1.9.2
   - 1.9.3
+  - rbx-19mode
+  - jruby
+  - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.4.1 (June 28, 2012)
+
+* Add search api commands.
+* Add repo content api commands.
+* Remove params from all commands up to command.
+* Add more feature tests for the command interface.
+
 0.4.0 (June 15, 2012)
 
 * Add user api commands.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_cli (0.4.0)
+    github_cli (0.4.1)
       github_api (~> 0.6)
       thor
 
@@ -27,12 +27,12 @@ GEM
     ffi (1.0.11)
     gherkin (2.11.0)
       json (>= 1.4.6)
-    github_api (0.6.0)
-      faraday (~> 0.8.0)
+    github_api (0.6.1)
+      faraday (~> 0.8.1)
       hashie (~> 1.2.0)
       multi_json (~> 1.3)
       nokogiri (~> 1.5.2)
-      oauth2 (~> 0.7)
+      oauth2
     hashie (1.2.0)
     httpauth (0.1)
     json (1.7.3)

data/README.md

@@ -1,8 +1,9 @@
 # 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]
+[![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] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
 
 [travis]: http://travis-ci.org/peter-murach/github_cli
 [gemnasium]: https://gemnasium.com/peter-murach/github_cli
+[codeclimate]: https://codeclimate.com/github/peter-murach/github_cli
 
 CLI-based access to GitHub API v3 that works hand-in-hand with 'github_api' gem.
 
@@ -114,6 +115,12 @@ Interact with authorizations:
 $ ghc auth
 ```
 
+Interact with search:
+
+```shell
+$ ghc search
+```
+
 ### Output Format
 
 The API responses can be formatted as `csv`, `json`, `pretty`, `table`.

data/features/blob.feature

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

data/features/collaborator.feature

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

data/features/commit.feature

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

data/features/content.feature

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

data/features/gist.feature

@@ -0,0 +1,15 @@
+Feature: ghc gist
+
+  Scenario: Available commands
+
+    When I run `ghc gist`
+    Then the exit status should be 0
+      And the output should contain "ghc gist create"
+      And the output should contain "ghc gist delete"
+      And the output should contain "ghc gist edit"
+      And the output should contain "ghc gist get"
+      And the output should contain "ghc gist fork"
+      And the output should contain "ghc gist list"
+      And the output should contain "ghc gist star"
+      And the output should contain "ghc gist starred"
+      And the output should contain "ghc gist unstar"

data/features/pull_request.feature

@@ -0,0 +1,14 @@
+Feature: ghc pull request
+
+  Scenario: Available commands
+
+    When I run `ghc pull`
+    Then the exit status should be 0
+      And the output should contain "ghc pull commits"
+      And the output should contain "ghc pull create"
+      And the output should contain "ghc pull files"
+      And the output should contain "ghc pull get"
+      And the output should contain "ghc pull list"
+      And the output should contain "ghc pull merge"
+      And the output should contain "ghc pull merged"
+      And the output should contain "ghc pull update"

data/features/search.feature

@@ -1,33 +1,10 @@
-@search
-Feature: Github API Commands Search
+Feature: ghc search
 
-  As a developer who wants to search for commands that leverage GitHub APIs
-  When I use interface provided by GHC
-  I have ability to list commands by search criteria
+  Scenario: Available commands
 
-  Scenario: Listing
-    When I run `ghc list`
+    When I run `ghc search`
     Then the exit status should be 0
-    And the output should contain:
-    """
-    Github CLI client
-
-    Commands:
-    """
-
-  Scenario Outline: Pattern Matching
-    When I run `ghc list <pattern>`
-    Then the output should contain "repo"
-    And the output should not contain "issue"
-
-    Examples:
-      | pattern |
-      | re      |
-      | repo    |
-
-  Scenario: No Match
-    When I run `ghc list bla`
-    Then the output should contain:
-    """
-    ghc: 'bla' is not a ghc command. See 'ghc --help'.
-    """
+      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"

data/features/search_commands.feature

@@ -0,0 +1,33 @@
+@search
+Feature: Github API Commands Search
+
+  As a developer who wants to search for commands that leverage GitHub APIs
+  When I use interface provided by GHC
+  I have ability to list commands by search criteria
+
+  Scenario: Listing
+    When I run `ghc list`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Github CLI client
+
+    Commands:
+    """
+
+  Scenario Outline: Pattern Matching
+    When I run `ghc list <pattern>`
+    Then the output should contain "repo"
+    And the output should not contain "issue"
+
+    Examples:
+      | pattern |
+      | re      |
+      | repo    |
+
+  Scenario: No Match
+    When I run `ghc list bla`
+    Then the output should contain:
+    """
+    ghc: 'bla' is not a ghc command. See 'ghc --help'.
+    """

data/features/watching.feature

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

data/lib/github_cli/apis.rb

@@ -13,6 +13,7 @@ end
   blob
   collaborator
   commit
+  content
   download
   email
   follower
@@ -28,6 +29,7 @@ end
   pull_request
   reference
   repository
+  search
   tag
   team
   tree

data/lib/github_cli/apis/content.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Content < API
+
+    class << self
+
+      def get(user, repo, path, params, format)
+        output format do
+          github_api.repos.contents.get user, repo, path, params
+        end
+      end
+
+      def readme(user, repo, params, format)
+        output format do
+          github_api.repos.contents.readme user, repo, params
+        end
+      end
+
+      def archive(user, repo, params, format)
+        output format do
+          github_api.repos.contents.archive user, repo, params
+        end
+      end
+    end
+
+  end # Content
+end # GithubCLI

data/lib/github_cli/apis/search.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Search < API
+
+    class << self
+
+      def issue(owner, repo, keyword, params, format)
+        output format do
+          github_api.search.issues params.update(:owner => owner, :repo => repo, :keyword => keyword)
+        end
+      end
+
+      def repo(params, format)
+        output format do
+          github_api.search.repos params
+        end
+      end
+
+      def user(params, format)
+        output format do
+          github_api.search.users params
+        end
+      end
+
+      def email(params, format)
+        output format do
+          github_api.search.email params
+        end
+      end
+
+    end
+
+  end # Search
+end # GithubCLI

data/lib/github_cli/cli.rb

@@ -13,11 +13,15 @@ module GithubCLI
       options["no-pager"] ? Pager.disable : Pager.enable
     end
 
-    map "repository" => :repo,
-        "reference"  => :ref,
-        "is" => :issue,
-        "--version" => :version,
-        "ls" => :list
+    ALIASES = {
+      'repository' => 'repo',
+      'reference'  => 'ref',
+      'is'         => :issue,
+      '--version'  => 'version',
+      'ls'         => 'list'
+    }
+
+    map ALIASES
 
     class_option :config, :type => :string,
                  :desc => "Configuration file.", :banner => "Config file name",

data/lib/github_cli/command.rb

@@ -6,13 +6,14 @@ module GithubCLI
 
     API_CLASSES = %w(
       c_l_i
-      repo download key fork hook watch collab
+      repo download key fork hook watch collab content
       issue label milestone
       tag tree blob reference commit
       pull
       user email follower
       org member team
       event
+      search
     )
 
     HELP_COMMAND = 'help'

data/lib/github_cli/commands.rb

@@ -6,6 +6,7 @@ module GithubCLI
     autoload :Blobs,          'github_cli/commands/blobs'
     autoload :Collaborators,  'github_cli/commands/collaborators'
     autoload :Commits,        'github_cli/commands/commits'
+    autoload :Contents,       'github_cli/commands/contents'
     autoload :Downloads,      'github_cli/commands/downloads'
     autoload :Emails,         'github_cli/commands/emails'
     autoload :Events,         'github_cli/commands/events'
@@ -22,6 +23,7 @@ module GithubCLI
     autoload :PullRequests,   'github_cli/commands/pull_requests'
     autoload :References,     'github_cli/commands/references'
     autoload :Repositories,   'github_cli/commands/repositories'
+    autoload :Search,         'github_cli/commands/search'
     autoload :Tags,           'github_cli/commands/tags'
     autoload :Teams,          'github_cli/commands/teams'
     autoload :Trees,          'github_cli/commands/trees'

data/lib/github_cli/commands/blobs.rb

@@ -6,8 +6,6 @@ module GithubCLI
     namespace :blob
 
     desc 'get <user> <repo> <sha>', 'Get a Blob'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additonal request parameters e.i per_page:100'
     def get(user, repo, sha)
       Blob.get user, repo, sha, options[:params], options[:format]
     end
@@ -19,8 +17,6 @@ module GithubCLI
         content - String of content \n
         encoding - String containing encoding utf-8 or base64
     DESC
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additonal request parameters e.i per_page:100'
     def create(user, repo)
       Blob.create user, repo, options[:params], options[:format]
     end

data/lib/github_cli/commands/collaborators.rb

@@ -6,29 +6,21 @@ module GithubCLI
     namespace :collab
 
     desc 'list <user> <repo>', 'Lists collaborators'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additional request parameters e.i per_page:100'
     def list(user, repo)
       Collaborator.all user, repo, options[:params], options[:format]
     end
 
     desc 'add <user> <repo> <collab>', 'Add a collaborator'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additional request parameters e.i per_page:100'
     def add(user, repo, collab)
       Collaborator.add user, repo, collab, options[:params], options[:format]
     end
 
     desc 'collab <user> <repo> <collab>', 'Checks if user is a collaborator on a given repo'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additional request parameters e.i per_page:100'
     def collab(user, repo, collab)
       Collaborator.collaborator? user, repo, collab, options[:params], options[:format]
     end
 
     desc 'remove <user> <repo> <id>', 'Remove a collaborator'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additonal request parameters e.i per_page:100'
     def remove(user, repo, collab)
       Collaborator.remove user, repo, collab, options[:params]. options[:format]
     end

data/lib/github_cli/commands/commits.rb

@@ -6,8 +6,6 @@ module GithubCLI
     namespace :commit
 
     desc 'get <user> <repo> <sha>', 'Get a Commit'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additonal request parameters e.i per_page:100'
     def get(user, repo, sha)
       Commit.get user, repo, sha, options[:params], options[:format]
     end
@@ -31,8 +29,6 @@ module GithubCLI
         committer.email - String of the email of the committer of the commit \n
         committer.date:: Timestamp of when this commit was committed
     DESC
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additonal request parameters e.i per_page:100'
     def create(user, repo)
       Commit.create user, repo, options[:params], options[:format]
     end

data/lib/github_cli/commands/contents.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Commands::Contents < Command
+
+    namespace :content
+
+    desc 'get <user> <repo> <path>', 'Get repository <path> contents'
+    long_desc <<-DESC
+      This method returns the contents of any file or directory in a repository.
+
+      Parameters
+
+      ref - Optional string - The String name of the Commit/Branch/Tag. Defaults to master.
+    DESC
+    def get(user, repo, path)
+      Content.get user, repo, path, options[:params], options[:format]
+    end
+
+    desc 'readme <user> <repo>', 'Get the README'
+    long_desc <<-DESC
+      Parameters
+
+      ref - Optional string - The String name of the Commit/Branch/Tag. Defaults to master.
+    DESC
+    def readme(user, repo)
+      Content.readme user, repo, options[:params], options[:format]
+    end
+
+    desc 'archive <user> <repo>', 'Get archive link'
+    long_desc <<-DESC
+      This method will return a 302 to a URL to download a tarball or zipball
+      archive for a repository. Please make sure your HTTP framework is configured
+      to follow redirects or you will need to use the Location header to make
+      a second GET request.\n
+
+      Note: For private repositories, these links are temporary and expire quickly.
+
+      Parameters
+
+      archive_format - Required string - either tarball or zipball\n
+      ref - Optional string - valid Git reference, defaults to master\n
+    DESC
+    def archive(user, repo)
+      Content.archive user, repo, options[:params], options[:format]
+    end
+
+  end # Contents
+end # GithubCLI