github_cli 0.5.3 → 0.5.4

data/.travis.yml

@@ -1,11 +1,22 @@
+language: ruby
 before_install:
   - gem install bundler
-matrix:
-  allow_failures:
-    - rvm: ruby-head
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
 branches:
   only: master
 notifications:

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+0.5.4 (March 23, 2013)
+
+* Update vendor dependency
+* Update github_api dependency
+* Change Labels commands to merge milestones and issues listing into list command
+* Change Tags create to take specific options and add tests
+* Change References create to take specific options and add tests
+* Chnage Tree create to take specific options and add tests
+* Change Commit create to take specific options and add tests
+* Change Milestone commands to take specific options
+* Change table and csv formatters to work with new 'github_api'
+* Change init command to be global by default and accept filename
+* Add filename to config class to allow for easy parametrization
+* Change config command to be global by default and add feature tests
+
 0.5.3 (September 29, 2012)
 
 * Fix bug with starring api starred command.[Issue #6]

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'communist', :path => '../communist'
+# gem 'communist', :path => '../communist'
 
 gemspec

data/Gemfile.lock

@@ -1,78 +1,75 @@
 PATH
   remote: .
   specs:
-    github_cli (0.5.3)
-      github_api (~> 0.7)
+    github_cli (0.5.4)
+      github_api (~> 0.9)
 
-PATH
-  remote: ../communist
+GEM
+  remote: https://rubygems.org/
   specs:
+    aruba (0.5.1)
+      childprocess (~> 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.1.4)
+    childprocess (0.3.7)
+      ffi (~> 1.0, >= 1.0.6)
     communist (0.3.0)
       json
       rack
       sinatra
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    aruba (0.4.11)
-      childprocess (>= 0.2.3)
-      cucumber (>= 1.1.1)
-      ffi (>= 1.0.11)
-      rspec (>= 2.7.0)
-    builder (3.0.0)
-    childprocess (0.3.2)
-      ffi (~> 1.0.6)
     cucumber (1.2.1)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.11.0)
       json (>= 1.4.6)
-    diff-lcs (1.1.3)
-    faraday (0.8.4)
+    diff-lcs (1.2.1)
+    faraday (0.8.6)
       multipart-post (~> 1.1)
-    ffi (1.0.11)
-    gherkin (2.11.0)
-      json (>= 1.4.6)
-    github_api (0.7.0)
+    ffi (1.3.1)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    github_api (0.9.3)
       faraday (~> 0.8.1)
-      hashie (~> 1.2.0)
-      multi_json (~> 1.3)
+      hashie (~> 2.0)
+      multi_json (~> 1.4)
       nokogiri (~> 1.5.2)
       oauth2
-    hashie (1.2.0)
+    hashie (2.0.2)
     hpricot (0.8.6)
-    httpauth (0.1)
-    json (1.7.3)
-    jwt (0.1.5)
-      multi_json (>= 1.0)
-    multi_json (1.3.6)
-    multipart-post (1.1.5)
+    httpauth (0.2.0)
+    json (1.7.6)
+    jwt (0.1.7)
+      multi_json (>= 1.5)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    multipart-post (1.2.0)
     mustache (0.99.4)
-    nokogiri (1.5.5)
-    oauth2 (0.8.0)
+    nokogiri (1.5.6)
+    oauth2 (0.9.1)
       faraday (~> 0.8)
       httpauth (~> 0.1)
       jwt (~> 0.1.4)
       multi_json (~> 1.0)
+      multi_xml (~> 0.5)
       rack (~> 1.2)
-    rack (1.4.1)
+    rack (1.5.2)
     rack-protection (1.2.0)
       rack
-    rake (0.9.2.2)
+    rake (10.0.3)
     rdiscount (1.6.8)
     ronn (0.7.3)
       hpricot (>= 0.8.2)
       mustache (>= 0.7.0)
       rdiscount (>= 1.5.8)
-    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)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     sinatra (1.3.2)
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
@@ -84,7 +81,7 @@ PLATFORMS
 
 DEPENDENCIES
   aruba
-  communist!
+  communist
   github_cli!
   rake
   ronn

data/README.md

@@ -1,5 +1,5 @@
 # GithubCLI
-[![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]
+[![Gem Version](https://badge.fury.io/rb/github_cli.png)](http://badge.fury.io/rb/github_cli) [![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
@@ -7,6 +7,8 @@
 
 CLI-based access to GitHub API v3 that works hand-in-hand with `github_api` gem.
 
+Important!: This library is currently being updated to include all Github API requests and undergoes rapid development cycles. A feature roadmap will be added shortly.
+
 ![Interface](https://github.com/peter-murach/github_cli/raw/master/screenshots/interface.png)
 
 ## Installation
@@ -36,31 +38,85 @@ $ gcli
 The first step is to create a configuration file, either global in home directory or local inside the project:
 
 ```shell
-$ gcli init [--global|--local]
+$ gcli init [--local] [filename]
 ```
 
-This will setup a `.githubrc` configuration file in your home/project directory
-with all the global settings. During the install process you will be prompted
-for your `authentication token`.
+Without any options this command will setup a `.githubrc` configuration file in
+your home/project directory with all the global settings. By passing `--local` option the config file will be created locally in the execution directory. Further, by default `.githubrc` name is used which can be changed by passing the `filename`.
+
+Main configuration options are:
+
+```
+user.token            # Authentication token
+user.login            # User login
+user.password         # User password
+user.name             # Default user name
+user.repo             # Default repo name
+user.org              # Default organization name
+core.editor           # Editor to be opened
+core.pager            # Pager to be used, by default less
+core.format           # Output formating
+core.auto_pagination  # Switch on default results pagination, default false
+```
 
 Moreover, `gcli config` command allows you to set/get any configuration option such as output format, editor or oauth token.
 
-For instance, to check value for your `token` do
+For instance, to check value for your `authentication token` do
 
 ```shell
-$ gcli config [--global|--local] auth.token
+$ gcli config [--local] user.token
 ```
 
 and to set the value do
 
 ```shell
-$ gcli config [--global|--local] auth.token lh23l4kj234....
+$ gcli config [--local] user.token lh23l4kj234....
 ```
 
 To list specific options
 
 ```shell
-$ gcli config [--global|--local] --list [regex]
+$ gcli config [--local] --list [regex]
+```
+
+To edit config in your favourite editor:
+
+```shell
+$ gcli config -e
+```
+
+Finally, to see a manpage about available configuration options do
+
+```shell
+$ gcli help config
+```
+
+### Authorization
+
+To create oauth tokens you need to setup your basic authentication like so
+
+```shell
+$ gcli init
+$ gcli config user.login '...'
+$ gcli config user.password '...'
+```
+
+Then to create your token do
+
+```shell
+$ gcli auth create --scopes=repo --note=gihtub_cli --note-url=http://github.com/peter-murach/github_cli
+```
+
+To see your current tokens do
+
+```shell
+$ gcli auth ls
+```
+
+Finally to add the token to your config do
+
+```shell
+$ gcli config user.token '...'
 ```
 
 ### Arguments
@@ -70,16 +126,16 @@ The required arguments come first as per command description, then are followed
 For instance, one can create repository by supplying parameters in the following way:
 
 ```shell
-$ gcli repo create octokit --params=description:'Test repo for kitty.'
+$ gcli repo create github_api --desc='Test repo for kitty.'
 ```
 
 To create repository inside organization:
 
 ```shell
-$ gcli repo create github/octokit --params=description:'Test repo for kitty.'
+$ gcli repo create github/github_api --desc='Test repo for kitty.'
 ```
 
-To find out which options are required and which are optional - type:
+To find out which options are required and which are optional use `help` command:
 
 ```shell
 $ gcli repo help create
@@ -155,7 +211,14 @@ $ gcli download
 $ gcli fork
 $ gcli hook
 $ gcli key
-$ gcli watching
+```
+
+Interact with activities:
+
+```shell
+$ gcli star
+$ gcli watch
+$ gcli event
 ```
 
 Interact with gists:
@@ -202,4 +265,4 @@ $ gcli search
 
 ## Copyright
 
-Copyright (c) 2012 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2012-2013 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -8,12 +8,14 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-Cucumber::Rake::Task.new(:features)
-
 task :default => [:spec, :features]
 
 task :release => ["man:clean", "man:build"]
 
+task :features do
+  sh 'bundle exec cucumber -f progress -t @ci-run features'
+end
+
 begin
   require 'ronn'
 

data/features/assignee.feature

@@ -1,5 +1,6 @@
 Feature: gcli assignee
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli assignee`

data/features/blob.feature

@@ -1,5 +1,6 @@
 Feature: gcli blob
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli blob`

data/features/collaborator.feature

@@ -1,5 +1,6 @@
 Feature: gcli collab
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli collab`

data/features/commit.feature

@@ -1,5 +1,6 @@
 Feature: gcli commit
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli commit`
@@ -20,5 +21,5 @@ Feature: gcli commit
     """
     post('/repos/wycats/thor/git/commits') { status 200 }
     """
-    When I run `gcli commit create wycats thor --params=message:'my commit' tree:827efc parents:['7d1b31e']`
+    When I run `gcli commit create wycats thor --message='my commit' --tree=827efc --parents=['7d1b31e']`
     Then the exit status should be 0

data/features/config.feature

@@ -1,55 +1,54 @@
+@ci-run
 Feature: Configuration file
 
-  Scenario: Config requires scope
-    When I run `gcli config`
-    Then the output should contain:
-    """
-    Invalid scope given. Please use --local or --global.
-    """
-
   Scenario: Missing global file
-    When I run `gcli config --global`
+    When I run `gcli config`
     Then the output should contain:
     """
-    global configuration file does not exist. Please use `gcli init --global`
+    Configuration file does not exist. Please use `gcli init` to create one.
     """
 
   Scenario: Missing local file
     When I run `gcli config --local`
     Then the output should contain:
     """
-    local configuration file does not exist. Please use `gcli init --local`
+    Configuration file does not exist. Please use `gcli init` to create one.
     """
 
   Scenario: List global file options
-    Given I run `gcli init --global` interactively
-      And I type "token"
-    When I run `gcli config --global`
+    Given I run `gcli init`
+    When I run `gcli config`
     Then the output should contain:
     """
     Configuration options:
     """
 
+  Scenario: Seek local before global configuration
+    Given a directory named "piotr"
+      And I cd to "piotr"
+      And I run `gcli init --local`
+   When I run `gcli config`
+   Then the output should contain:
+    """
+    Configuration options:
+    """
+
   Scenario: Read existing option
-    Given I run `gcli init --global` interactively
-      And I type "abc123"
-    When I successfully run `gcli config --global auth.token`
+    Given I run `gcli init`
+    When I successfully run `gcli config user.token abc123`
     Then the stdout should contain "abc123"
 
   Scenario: Read missing option
-    Given I run `gcli init --global` interactively
-      And I type "abc123"
-    When I run `gcli config --global missing.key`
+    Given I run `gcli init`
+    When I run `gcli config missing.key`
     Then the exit status should be 0
 
-  Scenario: Write existing option
-    Given I run `gcli init --global` interactively
-      And I type "abc123"
-    When I successfully run `gcli config --global auth.token eee555`
+  Scenario: Write custom option
+    Given I run `gcli init`
+    When I successfully run `gcli config core.host eee555`
     Then the stdout should contain "eee555"
 
-  Scenario: Write missing option
-    Given I run `gcli init --global` interactively
-      And I type "abc123"
-    When I successfully run `gcli config --global core.token eee555`
-    Then the stdout should contain "eee555"
+  Scenario: Listing all configuration options
+    Given I run `gcli init`
+    When I run `gcli config -l`
+    Then the stdout should contain "user.token"

data/features/event.feature

@@ -1,5 +1,6 @@
 Feature: gcli event
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli event`

data/features/init.feature

@@ -1,38 +1,29 @@
-@settings
+@ci-run
 Feature: Init command
 
   As a developer who wants to set global settings for interaction with GitHub API
-  When I use interface provided by GHC
+  When I use interface provided by GCLI
   I have ability to create configuration file
 
-  Scenario: Init requires scope
+  Scenario: Installs global config file
     When I run `gcli init`
     Then the output should contain:
-    """
-    Invalid scope given. Please use --local or --global.
-    """
-
-  Scenario: Installs global config file
-    When I run `gcli init --global` interactively
-      And I type "token"
-    Then the output should contain:
-    """
-    Writing new configuration file to /tmp/fakehome/.githubrc
-    """
-    And a file named "/tmp/fakehome/.githubrc" should exist
-    And the file "/tmp/fakehome/.githubrc" should contain "auth.token: token"
+      """
+      Writing new configuration file to /tmp/fakehome/.githubrc
+      """
+      And a file named "/tmp/fakehome/.githubrc" should exist
+      And the file "/tmp/fakehome/.githubrc" should contain "user.token:"
 
   Scenario: Installs local config file
     Given a directory named "piotr"
     When I cd to "piotr"
-      And I run `gcli init --local` interactively
-      And I type "token"
+      And I run `gcli init --local`
     Then a file named ".githubrc" should exist
-    And the file ".githubrc" should contain "auth.token: token"
+      And the file ".githubrc" should contain "user.token:"
 
   Scenario: Global config file arleady exists
     Given an empty file named "/tmp/fakehome/.githubrc"
-    When I run `gcli init --global`
+    When I run `gcli init`
     Then the output should contain:
     """
     Not overwritting existing config file /tmp/fakehome/.githubrc, use --force to override.
@@ -40,9 +31,15 @@ Feature: Init command
 
   Scenario: Force global config file override
     Given an empty file named "/tmp/fakehome/.githubrc"
-    When I run `gcli init --global --force` interactively
-      And I type "token"
+    When I run `gcli init --force`
     Then the output should contain:
     """
-    Please specify your GitHub Authentication Token (register on github.com to get it):
+    Writing new configuration file to /tmp/fakehome/.githubrc
     """
+
+  Scenario: Install config file with custom name
+    When I run `gcli init .custom-name`
+    Then the output should contain:
+      """
+      Writing new configuration file to /tmp/fakehome/.custom-name
+      """

data/features/key.feature

@@ -1,7 +1,7 @@
 Feature: gcli key
 
+  @commands
   Scenario: Available commands
-
     When I run `gcli key`
     Then the exit status should be 0
       And the output should contain "gcli key create"
@@ -13,7 +13,7 @@ Feature: gcli key
   Scenario: List keys
     Given the GitHub API server:
     """
-    get('/repos/wycats/thor/keys') { status 200 }
+    get('/repos/wycats/thor/keys') { json [{:key => "ssh"}] }
     """
     When I run `gcli key ls wycats thor`
     Then the exit status should be 0
@@ -21,7 +21,7 @@ Feature: gcli key
   Scenario: Get key
     Given the GitHub API server:
     """
-    get('/repos/wycats/thor/keys/1') { status 200 }
+    get('/repos/wycats/thor/keys/1') { json :key => "ssh" }
     """
     When I run `gcli key get wycats thor 1`
     Then the exit status should be 0
@@ -29,7 +29,7 @@ Feature: gcli key
   Scenario: Create key
     Given the GitHub API server:
     """
-    post('/repos/wycats/thor/keys') { status 200 }
+    post('/repos/wycats/thor/keys') { json :key => "ssh" }
     """
     When I run `gcli key create wycats thor --params=title:octo key:fh34d55`
     Then the exit status should be 0
@@ -37,7 +37,7 @@ Feature: gcli key
   Scenario: Edit key
     Given the GitHub API server:
     """
-    patch('/repos/wycats/thor/keys/1') { status 200 }
+    patch('/repos/wycats/thor/keys/1') { json :key => "ssh" }
     """
     When I run `gcli key edit wycats thor 1 --params=title:octo key:fh34d55`
     Then the exit status should be 0

data/features/milestone.feature

@@ -1,5 +1,6 @@
 Feature: gcli milestone
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli milestone`
@@ -31,7 +32,7 @@ Feature: gcli milestone
     """
     post('/repos/wycats/thor/milestones') { status 200 }
     """
-    When I run `gcli milestone create wycats thor --params=title:new`
+    When I run `gcli milestone create wycats thor --title=new`
     Then the exit status should be 0
 
   Scenario: Update milestone
@@ -39,7 +40,7 @@ Feature: gcli milestone
     """
     patch('/repos/wycats/thor/milestones/1') { status 200 }
     """
-    When I run `gcli milestone update wycats thor 1 --params=title:new`
+    When I run `gcli milestone update wycats thor 1 --title=new`
     Then the exit status should be 0
 
   Scenario: Delete milestone

data/features/reference.feature

@@ -1,5 +1,6 @@
 Feature: gcli ref
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli ref`
@@ -39,7 +40,7 @@ Feature: gcli ref
     """
     post('/repos/wycats/thor/git/refs') { status 200 }
     """
-    When I run `gcli ref create wycats thor --params=ref:refs/heads/master sha:827efc6d5`
+    When I run `gcli ref create wycats thor --ref=refs/heads/master --sha=827efc6d5`
     Then the exit status should be 0
 
   Scenario: Update reference
@@ -47,7 +48,7 @@ Feature: gcli ref
     """
     patch('/repos/wycats/thor/git/refs/7d1b31e') { status 200 }
     """
-    When I run `gcli ref update wycats thor 7d1b31e --params=force:true sha:827efc6d5`
+    When I run `gcli ref update wycats thor 7d1b31e --force --sha=827efc6d5`
     Then the exit status should be 0
 
   Scenario: Delete reference

data/features/starring.feature

@@ -1,5 +1,6 @@
 Feature: gcli star
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli star`

data/features/support/hooks.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
 
 Before do
-  @aruba_timeout_seconds = 5
+  @aruba_timeout_seconds = 10
   @aruba_io_wait_seconds = 0.2
 
   @real_home = ENV['HOME']

data/features/tag.feature

@@ -1,5 +1,6 @@
 Feature: gcli tag
 
+  @ci-run
   Scenario: Available commands
 
     When I run `gcli tag`
@@ -20,5 +21,5 @@ Feature: gcli tag
     """
     post('/repos/wycats/thor/git/tags') { status 200 }
     """
-    When I run `gcli tag create wycats thor`
+    When I run `gcli tag create wycats thor --object=234f23rf`
     Then the exit status should be 0