github_cli 0.6.1 → 0.6.2

data/.travis.yml

@@ -6,18 +6,14 @@ rvm:
   - 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
-    - rvm: rbx-18mode
     - rvm: rbx-19mode
 branches:
   only: master

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.6.2 (October 6, 2013)
+
+* Add commands to repository contents API
+* Add tty dependency and fix issue #12 when reading user password
+* Change error message debug
+* Change on_error handler to catch common types of exceptions
+* Change executable to use new error helper
+
 0.6.1 (June 9, 2013)
 
 * Add stat command for Statistics API

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    github_cli (0.6.1)
+    github_cli (0.6.2)
       github_api (~> 0.10)
+      tty (~> 0.0.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.4)
+    addressable (2.3.5)
     aruba (0.5.1)
       childprocess (~> 0.3.6)
       cucumber (>= 1.1.1)
@@ -25,17 +26,17 @@ GEM
       gherkin (~> 2.11.0)
       json (>= 1.4.6)
     diff-lcs (1.2.1)
-    faraday (0.8.7)
-      multipart-post (~> 1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
     ffi (1.3.1)
     gherkin (2.11.6)
       json (>= 1.7.6)
-    github_api (0.10.1)
+    github_api (0.10.2)
       addressable
-      faraday (~> 0.8.1)
+      faraday (~> 0.8.7)
       hashie (>= 1.2)
       multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
+      nokogiri (~> 1.6.0)
       oauth2
     hashie (2.0.5)
     hpricot (0.8.6)
@@ -43,14 +44,16 @@ GEM
     json (1.8.0)
     jwt (0.1.8)
       multi_json (>= 1.5)
-    multi_json (1.7.4)
-    multi_xml (0.5.3)
+    mini_portile (0.5.1)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
     multipart-post (1.2.0)
     mustache (0.99.4)
-    nokogiri (1.5.9)
-    oauth2 (0.9.1)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.2)
       faraday (~> 0.8)
-      httpauth (~> 0.1)
+      httpauth (~> 0.2)
       jwt (~> 0.1.4)
       multi_json (~> 1.0)
       multi_xml (~> 0.5)
@@ -77,6 +80,7 @@ GEM
       rack-protection (~> 1.2)
       tilt (~> 1.3, >= 1.3.3)
     tilt (1.3.3)
+    tty (0.0.10)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,12 @@
 # GithubCLI
-[![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]
 
+[![Gem Version](https://badge.fury.io/rb/github_cli.png)][gem]
+[![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/github/peter-murach/github_cli.png)][codeclimate]
+[Website](http://peter-murach.github.io/github/)
+
+[gem]: http://badge.fury.io/rb/github_cli
 [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

data/bin/gcli

@@ -6,16 +6,4 @@ lib_dir = File.expand_path("../../lib", __FILE__)
 $LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
 
 require "github_cli"
-begin
-  GithubCLI::CLI.start
-rescue Interrupt => e
-  GithubCLI.ui.error "\nQuitting..."
-  GithubCLI.ui.debug e.backtrace.join("\n")
-  exit 1
-rescue SystemExit => e
-  exit e.status
-rescue Exception => e
-  GithubCLI.ui.error "Fatal error has occurred. " + e.message.to_s
-  GithubCLI.ui.debug e.backtrace.join("\n")
-  exit 1
-end
+GithubCLI.on_error { GithubCLI::CLI.start }

data/features/content.feature

@@ -6,23 +6,32 @@ Feature: gcli content
     When I run `gcli content`
     Then the exit status should be 0
       And the output should contain "content get"
+      And the output should contain "content create"
       And the output should contain "content readme"
       And the output should contain "content archive"
 
-  Scenario: Readme
+  Scenario: Get content
     Given the GitHub API server:
     """
-    get('/repos/wycats/thor/readme') { status 200 }
+    get('/repos/wycats/thor/contents/lib') { status 200 }
     """
-    When I run `gcli content readme wycats thor`
+    When I run `gcli content get wycats thor lib`
     Then the exit status should be 0
 
-  Scenario: Get content
+  Scenario: Create content
     Given the GitHub API server:
     """
-    get('/repos/wycats/thor/contents/lib') { status 200 }
+    put('/repos/wycats/thor/contents/lib') { status 200 }
     """
-    When I run `gcli content get wycats thor lib`
+    When I run `gcli content create wycats thor lib`
+    Then the exit status should be 0
+
+  Scenario: Readme
+    Given the GitHub API server:
+    """
+    get('/repos/wycats/thor/readme') { status 200 }
+    """
+    When I run `gcli content readme wycats thor`
     Then the exit status should be 0
 
   Scenario: Archive

data/github_cli.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.version       = GithubCLI::VERSION
 
   gem.add_dependency 'github_api', '~> 0.10'
+  gem.add_dependency 'tty',        '~> 0.0.10'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'aruba'

data/lib/github_cli.rb

@@ -7,6 +7,7 @@ require 'github_api'
 require 'github_cli/thor_ext'
 require 'github_cli/version'
 require 'github_cli/errors'
+require 'tty'
 
 # Base module which adds Github API to the command line
 module GithubCLI

data/lib/github_cli/apis/content.rb

@@ -11,6 +11,12 @@ module GithubCLI
         end
       end
 
+      def create(user, repo, path, params, options)
+        output options do
+          github_api(options).repos.contents.create user, repo, path, params
+        end
+      end
+
       def readme(user, repo, params, options)
         output options do
           github_api(options).repos.contents.readme user, repo, params

data/lib/github_cli/cli.rb

@@ -26,8 +26,6 @@ module GithubCLI
 
     map ALIASES
 
-    # can extract class options into global options module
-
     class_option :filename, :type => :string,
                  :desc => "Configuration file name.", :banner => "<filename>",
                  :default => ".githubrc"
@@ -69,7 +67,7 @@ module GithubCLI
           'core.no-pager' => false,
           'core.no-color' => false,
           'core.quiet'    => false,
-          'core.format'   => :table,
+          'core.format'   => 'table',
           'core.auto_pagination' => false,
           'core.aliases'  => nil,
         }
@@ -100,8 +98,8 @@ module GithubCLI
       params['note_url'] = options[:note_url] || 'https://github.com/peter-murach/github_cli'
       global_options[:params] = params
       # Need to configure client with login and password
-      login = ask("login: ")
-      password = ask("password: ")
+      login    = TTY.shell.ask("login: ").read_string.strip!
+      password = TTY.shell.ask("password: ").read_password.strip!
 
       global_options['login']    = login
       global_options['password'] = password
@@ -117,7 +115,7 @@ module GithubCLI
       config['user.token']    = token
 
       GithubCLI.ui.warn <<-EOF
-        Your #{GithubCLI.config.location} configuration file has been overwritten!
+        \nYour #{GithubCLI.config.location} configuration file has been overwritten!
       EOF
     end
 

data/lib/github_cli/commands/contents.rb

@@ -9,7 +9,7 @@ module GithubCLI
            :desc => "The String name of the Commit/Branch/Tag. Defaults to master."
     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.
+      This command returns the contents of any file or directory in a repository.
 
       Parameters
 
@@ -23,6 +23,57 @@ module GithubCLI
       Content.get user, repo, path, params, global_options
     end
 
+    option :path, :type => :string, :required => true, :banner => "",
+           :desc => "the content path"
+    option :message, :type => :string, :required => true, :banner => "",
+           :desc => "the commit message"
+    option :content, :type => :string, :required => true, :banner => "",
+           :desc => "the new file content which will be Base64 encoded"
+    option :branch, :type => :string, :required => true, :banner => "",
+           :desc => "the branch name"
+    option :"author-name", :type => :string,
+           :desc => "the name of the author of the commit"
+    option :"author-email", :type => :string,
+           :desc => "the email of the author of the commit"
+    option :"committer-name", :type => :string,
+           :desc => "the name of the committer of the commit"
+    option :"committer-email", :type => :string,
+           :desc => "the email of the committer of the commit"
+    desc 'create <user> <repo> <path>', 'Create repository <path> contents'
+    long_desc <<-DESC
+      This command creates a new file in a repository
+
+      Parameters
+
+      path    - Requried string - The content path
+      message - Requried string - The commit message
+      content - Requried string - The new file content,
+                which will be Base64 encoded
+      branch  - Optional string - The branch name. If not provided,
+                uses the repository’s default branch (usually master)
+
+      Optional Parameters
+
+      author.name  - string - The name of the author of the commit
+      author.email - string - The email of the author of the commit
+      committer.name - string - The name of the committer of the commit
+      committer.email - string - The email of the committer of the commit
+    DESC
+    def create(user, repo, path)
+      global_options = options.dup
+      params = options[:params].dup
+      params['path']    = options[:path]
+      params['message'] = options[:message]
+      params['content'] = options[:content]
+      params['branch']  = options[:branch]  if options[:branch]
+      params['author.name']     = options['author-name'] if options['author-name']
+      params['author.email']    = options['author-email'] if options['author-email']
+      params['committer.name']  = options['committer-name'] if options['committer-name']
+      params['committer.email'] = options['committer-email'] if options['committer-email']
+      Util.hash_without!(global_options, params.keys + ['author-name', 'author-email', 'committer-name', 'committer-email', 'params'])
+      Content.create user, repo, path, params, global_options
+    end
+
     option :ref, :type => :string,
            :desc => "The String name of the Commit/Branch/Tag. Defaults to master."
     desc 'readme <user> <repo>', 'Get the README'

data/lib/github_cli/dsl.rb

@@ -1,36 +1,41 @@
 # encoding: utf-8
 
 module GithubCLI
+
+  # Defines helpers
   module DSL
-    @@program_name = $0.split(/\//)[-1]
-    @@error_block  = nil
+
+    @program_name = $PROGRAM_NAME.split(/\//)[-1]
 
     # Defines a program name.
     #
-    def program_name(name=nil)
-      if name
-        @@program_name = name
-      end
-      @@program_name
+    def program_name(name = nil)
+      @program_name = name || @program_name
     end
 
     # Defines behaviour on error to emit consistent type.
     #
     def on_error
       yield
-    rescue Exception => error
-      handle_error(error)
-    end
-
-    def handle_error(error)
-      case error
-      when Github::Error::NotFound
-        terminal.newline
-        ui.error 'Resource Not Found'
-        terminal.newline
-      else
-        raise GithubCLI::GithubCLIError, "Rescued: #{error}"
-      end
+    rescue Github::Error::NotFound => e
+      terminal.newline
+      ui.error 'Resource Not Found'
+      terminal.newline
+      exit 15
+    rescue GithubCLI::GithubCLIError => e
+      GithubCLI.ui.error e.message
+      GithubCLI.ui.debug e
+      exit e.status_code
+    rescue Interrupt => e
+      GithubCLI.ui.error "\nQuitting..."
+      GithubCLI.ui.debug e
+      exit 1
+    rescue SystemExit => e
+      exit e.status
+    rescue Exception => e
+      GithubCLI.ui.error "\nFatal error has occurred. " + e.message.to_s
+      GithubCLI.ui.debug e
+      exit 1
     end
 
     def before(&block)

data/lib/github_cli/ui.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 
 module GithubCLI
+
+  # Class responsible for displaying different level information
   class UI
     attr_writer :shell
 
@@ -10,24 +12,25 @@ module GithubCLI
       @debug = ENV['DEBUG']
     end
 
-    def confirm(message, newline=nil)
+    def confirm(message, newline = nil)
       @shell.say message, :green, newline
     end
 
-    def info(message, newline=nil)
+    def info(message, newline = nil)
       @shell.say message, nil, newline
     end
 
-    def warn(message, newline=nil)
+    def warn(message, newline = nil)
       @shell.say message, :yellow, newline
     end
 
-    def error(message, newline=nil)
+    def error(message, newline = nil)
       @shell.say message, :red, newline
     end
 
-    def debug(message, newline=nil)
-      @shell.say message, nil, newline
+    def debug(error, newline = nil)
+      message = ["#{error.class}: #{error.message}", *error.backtrace]
+      @shell.say message.join("\n"), nil, newline
     end
 
     def quite!
@@ -38,11 +41,11 @@ module GithubCLI
       @debug = true
     end
 
-    def print_table(table, options={})
+    def print_table(table, options = {})
       @shell.print_table table, options
     end
 
-    def print_wrapped(message, options={})
+    def print_wrapped(message, options = {})
       @shell.print_wrapped message, options
     end
 

data/lib/github_cli/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module GithubCLI
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/spec/github_cli/commands/contents_spec.rb

@@ -29,6 +29,11 @@ describe GithubCLI::Commands::Contents do
     subject.invoke "content:get", [user, repo, path], :ref => "master"
   end
 
+  it "invokes content:create" do
+    api_class.should_receive(:create).with(user, repo, path, {'path' => path, 'message' => 'commit', 'content' => 'puts'}, format)
+    subject.invoke "content:create", [user, repo, path], {:path => path, :message => 'commit', :content => 'puts'}
+  end
+
   it "invokes content:archive" do
     api_class.should_receive(:archive).with(user, repo, {}, format)
     subject.invoke "content:archive", [user, repo]

data/spec/github_cli/dsl_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe GithubCLI, 'dsl' do
+  let(:object)    { described_class }
+  let(:error_cli) { GithubCLI::GitHubError }
+
+  before {
+    GithubCLI.ui.stub(:error)
+    GithubCLI.ui.stub(:debug)
+  }
+
+  after {
+    GithubCLI.ui.unstub(:error)
+    GithubCLI.ui.unstub(:debug)
+  }
+
+  context 'on_error' do
+    it "handles internal cli errors" do
+      expect { object.on_error { raise error_cli } }.to exit_with_code(11)
+    end
+
+    it "handles interrupts" do
+      expect { object.on_error { raise Interrupt } }.to exit_with_code(1)
+    end
+
+    it "handles fatal exceptions" do
+      expect { object.on_error { raise Exception } }.to exit_with_code(1)
+    end
+  end
+end

data/spec/github_cli/ui_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+Shell = Class.new do
+  def say(*args)
+    args.first
+  end
+end
+
+describe GithubCLI::UI do
+  let(:shell)   { Shell.new }
+  let(:message) { "error" }
+  let(:object)  { described_class.new(shell) }
+
+  subject { object }
+
+  it "confirms message" do
+    expect(object.confirm(message)).to eql(message)
+  end
+
+  it "debugs the error message" do
+    error = double(:error, message: message,
+                           class: 'Exception',
+                           backtrace: ['line1', 'line2'])
+    expect(object.debug(error)).to eql("Exception: error\nline1\nline2")
+  end
+end

data/spec/spec_helper.rb

@@ -10,6 +10,32 @@ RSpec.configure do |config|
   config.order = :rand
 end
 
+RSpec::Matchers.define :exit_with_code do |status_code|
+  actual = nil
+
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual and actual == status_code
+  end
+
+  failure_message_for_should do |block|
+    "expected block to call exit(#{status_code}) but exit" +
+    (actual.nil? ? " not called" : "(#{actual}) was called")
+  end
+
+  failure_message_for_should_not do |block|
+    "expected block not to call exit(#{status_code})"
+  end
+
+  description do
+    "expect block to call exit(#{status_code})"
+  end
+end
+
 def fixture(name)
   File.read File.expand_path File.join(File.dirname(__FILE__), '..', 'fixtures', name)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_cli
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000Z
+date: 2013-10-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
-  requirement: &2156012000 !ruby/object:Gem::Requirement
+  requirement: &2152245860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *2156012000
+  version_requirements: *2152245860
+- !ruby/object:Gem::Dependency
+  name: tty
+  requirement: &2152243640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152243640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156010900 !ruby/object:Gem::Requirement
+  requirement: &2152242660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156010900
+  version_requirements: *2152242660
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &2156003180 !ruby/object:Gem::Requirement
+  requirement: &2152241400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156003180
+  version_requirements: *2152241400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156002240 !ruby/object:Gem::Requirement
+  requirement: &2152240440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156002240
+  version_requirements: *2152240440
 - !ruby/object:Gem::Dependency
   name: communist
-  requirement: &2156001040 !ruby/object:Gem::Requirement
+  requirement: &2152239640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156001040
+  version_requirements: *2152239640
 - !ruby/object:Gem::Dependency
   name: ronn
-  requirement: &2155997580 !ruby/object:Gem::Requirement
+  requirement: &2152238500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155997580
+  version_requirements: *2152238500
 description: CLI-based access to GitHub API v3
 email:
 - ''
@@ -307,8 +318,10 @@ files:
 - spec/github_cli/commands/users_spec.rb
 - spec/github_cli/commands/watching_spec.rb
 - spec/github_cli/config_spec.rb
+- spec/github_cli/dsl_spec.rb
 - spec/github_cli/helpers_spec.rb
 - spec/github_cli/pager_spec.rb
+- spec/github_cli/ui_spec.rb
 - spec/github_cli/util/convert_value_spec.rb
 - spec/github_cli/util/convert_values_spec.rb
 - spec/github_cli/util_spec.rb
@@ -430,8 +443,10 @@ test_files:
 - spec/github_cli/commands/users_spec.rb
 - spec/github_cli/commands/watching_spec.rb
 - spec/github_cli/config_spec.rb
+- spec/github_cli/dsl_spec.rb
 - spec/github_cli/helpers_spec.rb
 - spec/github_cli/pager_spec.rb
+- spec/github_cli/ui_spec.rb
 - spec/github_cli/util/convert_value_spec.rb
 - spec/github_cli/util/convert_values_spec.rb
 - spec/github_cli/util_spec.rb