github_helper 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tristan Foureur
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# GithubHelper
+This useful little gem allows you **in a single command** to commit your staged changes, push them to your remote repository, and open a pull request for those changes. 
+
+Usually, when you have a quick fix to submit for an upstream repository, you would have to : 
+
+* Commit your fix
+* Push your fix to your repository
+* Go to your repository on Github
+* Open a pullrequest and type the title/description
+* Submit the pullrequest *(And you won't know if it's mergeable)*
+
+GithubHelper does all that for you just with :
+
+	ghh -fm "Fixing a bug"
+Or
+
+	git commit -m "Fixing a bug"
+	ghh -f
+
+## Installation
+
+Just install the gem using :
+
+    gem install github_helper
+
+## Usage
+To add an issue ID to the Pull request's description, just use the `-i` option.
+
+To get some help, just run `ghh -h`
+
+Here are the detailed options :
+
+    -f, --fast                       Fast mode : push to origin & pull-request
+    -r, --request                    Creates a pull request
+    -c, --commit                     Commit staged changes
+    -m, --message [message]          Your commit message
+    -i, --id [id]                    Issue ID
+        --reset-config               Resets your YML config file and enter your data again.
+    -l, --pulls                      Lists the open pull requests
+    -t, --title [TITLE]              Pull request title. (Defaults to latest commit)
+    -d, --description [BODY]         Pull request description. (Defaults to an empty string)
+    -b, --base [master]              Pull request base. (Defaults to master)
+    -p, --push                       Push branch to remote before doing the pullrequest(To username/currentbranch)
+    -n, --head [head]                Pull request head (Defaults to current branch)
+    -v, --verbose                    Enables verbose mode
+    -h, --help                       Displays this screen
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/ghh

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+require 'github_helper'
+require 'github_helper/first_time'
+require 'optparse'
+
+# Basic class to know that we have an error with the arguments
+class ArgException < Exception
+end
+
+options = {}
+action = false
+
+optparse = OptionParser.new do|opts|
+
+# Set the banner
+opts.banner = "GitHelper #{GithubHelper::VERSION} - Easy & fast commandline pull-request - Tristan Foureur (2012)\nUsage : ghh\nList of options:"
+
+# Define the options
+options[:fastmode] = false
+opts.on( '-f', '--fast', 'Fast mode : push to origin & pull-request' ) do
+  options[:fastmode] = true
+  action = true
+end
+
+options[:createpull] = false
+opts.on( '-r', '--request', 'Creates a pull request' ) do
+  options[:createpull] = true
+  action = true;
+end
+
+options[:commit] = false
+opts.on( '-c', '--commit', 'Commit staged changes' ) do
+  options[:commit] = true
+  action = true;
+end
+
+options[:commitmessage] = false
+opts.on( '-m', '--message [message]', 'Your commit message' ) do |m|
+  options[:commitmessage] = m
+end
+
+ options[:issueid] = false
+ opts.on( '-i', '--id [id]', 'Issue ID' ) do |i|
+   options[:issueid] = i
+ end
+
+ options[:regenconfig] = false
+ opts.on( nil, '--reset-config', 'Resets your YML config file and enter your data again.' ) do
+   options[:regenconfig] = true
+ end
+
+ options[:listpulls] = false
+ opts.on( '-l', '--pulls', 'Lists the open pull requests' ) do
+   options[:listpulls] = true
+   action = true;
+ end
+
+ options[:pulltitle] = false
+ opts.on( '-t', '--title [TITLE]', 'Pull request title. (Defaults to latest commit)' ) do |f|
+   options[:pulltitle] = f
+ end
+
+
+ options[:pullbody] = ''
+ opts.on( '-d', '--description [BODY]', 'Pull request description. (Defaults to an empty string)' ) do |b|
+   options[:pullbody] = b
+ end
+
+ options[:base] = "master"
+ opts.on( '-b', '--base [master]', 'Pull request base. (Defaults to master)' ) do |b|
+   options[:base] = b
+ end
+
+ options[:push] = false
+ opts.on( '-p', '--push', 'Push branch to remote before doing the pullrequest(To username/currentbranch)' ) do |p|
+   options[:push] = p
+   action = true;
+ end
+
+ options[:head] = false
+ opts.on( '-n', '--head [head]', 'Pull request head (Defaults to current branch)' ) do |h|
+   options[:head] = h
+ end
+
+ options[:verbose] = false
+ opts.on( '-v', '--verbose', 'Enables verbose mode' ) do
+   options[:verbose] = true
+ end
+
+ # This displays the help screen, all programs are
+ # assumed to have this option.
+ opts.on( '-h', '--help', 'Displays this screen' ) do
+   action = true;
+   puts opts
+ end
+
+ options[:help] = opts
+end
+
+begin
+  optparse.parse!
+
+  # Do we have a config file ? If we don't, lets make one !
+  f = GithubHelper::FirstTime.new() if !File.exists?('.git/githelper.config.yml') || options[:regenconfig]
+
+  raise ArgException, "No action specified" if !action
+  raise ArgException, "Your commit needs a message" if (options[:commit]) && !options[:commitmessage]
+
+  GH = GithubHelper::Github.new(options)
+
+  GH.displaypulls! if options[:listpulls]
+  GH.commit! if (options[:fastmode] || options[:commit])  && options[:commitmessage]
+  GH.pushBranch! if options[:push] || options[:fastmode]
+  GH.createPull! if options[:createpull] || options[:fastmode]
+
+# Initialization exceptions management
+rescue OptionParser::InvalidOption,ArgException => e
+  puts e.message
+  puts options[:help]
+  puts e.backtrace if options[:verbose]
+
+# Run-time exceptions management
+rescue Exception => e
+  puts e.message
+  puts e.backtrace if options[:verbose]
+end

data/github_helper.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_helper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "github_helper"
+  gem.version       = GithubHelper::VERSION
+  gem.authors       = ["Tristan Foureur"]
+  gem.email         = ["tristan.foureur@gmail.com"]
+  gem.description   = %q{A small gem to commit, push to remote, and open a pull request, in a single line. It can also handle issue ids and add them to the Pullrequest's description.}
+  gem.summary       = %q{A useful tool to commit, push to remote and open a pull request, in a single line.}
+  gem.homepage      = "https://github.com/Esya/GithubHelper"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   << 'ghh'
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "httparty"
+  gem.add_dependency "git"
+  gem.add_dependency "json"
+end

data/lib/github_helper/first_time.rb

@@ -0,0 +1,60 @@
+# First time run ? Let's make the config file !
+class GithubHelper::FirstTime
+  include HTTParty
+  base_uri 'https://api.github.com'
+
+  # Outputs the string as a question then waits for the user input
+  def ask(string,default=nil)
+    puts string
+    input = gets.strip
+    puts ""
+    input = (input == "") ? default : input
+  end
+
+  # This let us get the OAuth token
+  def getToken(user,password)
+      data = {:scopes => ["repo"], :note => "GithubHelper Gem"}
+      resp = self.class.post("/authorizations",:body => data.to_json)
+
+      if resp.headers['status'][0..2].to_i != 201
+        raise "Can't get the OAuth token : Wrong credentials, please try again"
+      end
+
+      resp.parsed_response["token"]
+  end
+
+  def initialize()
+    @config = Hash.new()
+    @config = {'credentials' => {'user' => '', 'token' => ''}, 'remote' => {'user' => '', 'repo' => ''}}
+
+    fillArray!
+  end
+
+  # Interactive building of the YAML file.
+  def fillArray!
+    puts "Setting your credentials"
+    user = ask("What's your github user name (Won't work with your email) ?")
+    password = ask("What's your git password ?\n(This won't be logged, used to get an OAuth token)")
+    self.class.basic_auth user, password
+
+    @config['credentials']['user'] = user
+    @config['credentials']['token'] = getToken(user,password)
+
+    puts "Now let's set up your repo you want to send your pull requests to"
+    @config['remote']['user'] = ask("What's the user you want to send your pull requests to ? ")
+    @config['remote']['repo'] = ask("What's the user's repo ?")
+
+    puts "Writing to config file : .git/githelper.config.yml"
+    header = "# GitHelper.rb config file\n# You can edit your credentials here\n"
+    yaml = @config.to_yaml
+
+    output = header + yaml
+    begin
+        File.open('.git/githelper.config.yml', 'w') {|f| f.write(output) }
+    rescue Exception
+        puts "Can't write to .git/githelper.config.yml, are you sure this a git directory?"
+        raise
+    end
+
+  end
+end

data/lib/github_helper/git.rb

@@ -0,0 +1,27 @@
+# This is a little hack to the Git gem to add a way to check the staged files
+# And also to forcepush a branch.
+module Git
+  class Status
+    public
+
+    # A file about to be commited has a type and a sha_index
+    def staged
+      @files.select { |k, f| f.sha_index != "0000000000000000000000000000000000000000" && f.type != nil }
+    end
+  end
+
+#The git gem doesn't include a way to force push, let's implement it !
+  class Base
+    public
+    def forcepush(remote = 'origin', branch = 'master')
+      self.lib.forcepush(remote, branch)
+    end
+  end
+
+  class Lib
+    public
+    def forcepush(remote, branch)
+      command('push -f', [remote, branch])
+    end
+  end
+end

data/lib/github_helper/version.rb

@@ -0,0 +1,3 @@
+module GithubHelper
+  VERSION = "1.0.0"
+end

data/lib/github_helper.rb

@@ -0,0 +1,161 @@
+require "github_helper/version"
+require "github_helper/git"
+require "json"
+require "HTTParty"
+require "git"
+require "pp"
+
+module GithubHelper
+  class Github
+    include HTTParty
+
+    base_uri 'https://api.github.com'
+
+    @current_branch = ''
+
+    @verbose = false
+    @@target_user = ''
+    @@target_repo = ''
+
+    attr_accessor :options
+
+    # Display the open pull requests on the target repo
+    def displaypulls!
+      puts "Pull requests for #{@@target_user}/#{@@target_repo}\n"
+      pulls = get("/repos/#{@@target_user}/#{@@target_repo}/pulls")
+      pp pulls if @verbose
+      checkHeaders(pulls)
+      pulls.each { |pull| print "*\t"+pull['title'] + "\t" + pull['user']['login'] + "\n" } 
+    end
+
+    def initialize(options)
+      @config = YAML::load( File.open( '.git/githelper.config.yml' ) )
+
+      # Credentials setting from YML
+      @@my_user = @config['credentials']['user']
+      @@my_token = @config['credentials']['token']
+
+      # Remote settings from YML
+      @@target_user = @config['remote']['user']
+      @@target_repo = @config['remote']['repo']
+
+      @options = options
+      @verbose = true if options[:verbose]
+      @currentBranch = ''
+      @Git = Git.open('.');
+      @@my_name = @Git.config['user.name']
+    end
+
+    def get(url)
+      self.class.get(url+"?access_token=#{@@my_token}")
+    end
+
+    def post(url,data)
+      self.class.post(url+"?access_token=#{@@my_token}",data)
+    end
+
+    # Creates a pull request
+    def createPull!
+      # Formats the HEAD to user:branch
+      head = @@my_user+':'+currentBranch?
+
+      # Do we have a title ? If not, takes it from the last commit
+      pullTitle = (@options[:pulltitle] == false) ? lastCommit? : @options[:pulltitle]
+
+      body = @options[:pullbody]
+      body = "#{body}\n##{options[:issueid]}\n" if (options[:issueid] != false)
+
+      data = {:title => pullTitle, :body => body, :base => @options[:base], :head => head}
+      pp data if @verbose
+      puts "Asking for #{data[:head]} to be merged into #{@@target_user}/#{data[:base]}"
+
+      # Let's send the request
+      resp = post("/repos/#{@@target_user}/#{@@target_repo}/pulls", :body => data.to_json)
+      pp resp if @verbose
+      checkHeaders(resp)
+
+      # So far so good. Lets check if it's mergeable and give the user the proper link
+      puts "Pull request succeeded. Getting more informations..\n"
+
+      infos_resp = get("/repos/#{@@target_user}/#{@@target_repo}/pulls/"+resp.parsed_response['number'].to_s)
+      pp infos_resp if @verbose
+      checkHeaders(infos_resp)
+
+      infos = infos_resp.parsed_response
+
+      puts 'Url : '+infos['_links']['html']['href']
+      if(infos['mergeable'])
+        puts 'Your pull request is mergeable.'
+      else
+        puts "/!\\ ..But your pull request cannot be merged. Try to rebase then push again. /!\\"
+      end
+    end
+
+    # Commits staged changes
+    def commit!
+      if(options[:commitmessage])
+        #Do we have files to commit ?
+        count = @Git.status.staged.count
+
+        raise Exception, "You have no staged files, aborting your commit" if (count == 0)
+
+        message = options[:commitmessage]
+
+        ci = @Git.commit(message)
+        pp ci
+      else
+        raise Exception, "Commit needs a message"
+      end
+    end
+
+    # Do we have a good HTTP status ?
+    def checkHeaders(resp)
+      code = resp.headers['status'][0..2];
+
+      #If the status isnt 200 (OK) or 201 (Created), raise an exception
+      good = case code.to_i
+      when 200..201 then true
+      when 401 then 
+        raise Exception, "Bad credentials, maybe your OAuth token isn't valid anymore.\nReset your config with ghh --reset-config and try again"
+      else
+        error = formatError(resp)
+        raise Exception, "Error (HTTP #{code}) : "+error
+      end
+      good
+    end
+
+    # Format errors from the github api
+    def formatError(resp)
+      output = "";
+
+      output << resp.parsed_response['message'];
+      if(resp.parsed_response['errors'] != nil)
+        resp.parsed_response['errors'].each { |e| 
+          output << "\n" + e['message'] if e['message'] != nil
+        }
+      end
+      output
+    end
+
+    # Push the branch to origin
+    def pushBranch!
+      @Git.forcepush('origin',currentBranch?)
+      puts "Pushed #{@currentBranch} to origin"
+    end
+
+    # Return your last commit's title
+    def lastCommit?
+      message = ''
+      @Git.log(1).author(@@my_name).each { |c| message = c.message }
+      message
+    end
+
+    # Return your current branch's name
+    def currentBranch?
+      if(@currentBranch == '')
+        @currentBranch = `git branch | grep '*' | cut -d " " -f2`.strip!
+      end
+      @currentBranch
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: github_helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tristan Foureur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small gem to commit, push to remote, and open a pull request, in a
+  single line. It can also handle issue ids and add them to the Pullrequest's description.
+email:
+- tristan.foureur@gmail.com
+executables:
+- ghh
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ghh
+- github_helper.gemspec
+- lib/github_helper.rb
+- lib/github_helper/first_time.rb
+- lib/github_helper/git.rb
+- lib/github_helper/version.rb
+homepage: https://github.com/Esya/GithubHelper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A useful tool to commit, push to remote and open a pull request, in a single
+  line.
+test_files: []