gitbc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9cde4872d0db042174216009deb16045c9d9902
+  data.tar.gz: 86307914e0ca9e847d0ac657f32d9eee1b336f0d
+SHA512:
+  metadata.gz: 7ccdfe24751c1d79754852a8fe1d85c45e816fae33c625a1f23436a099f1048bcc8b6b5beaadedad5d7a63552f296530ce653bf5984295848475b05fb008f26c
+  data.tar.gz: 452e3e4767ff406e589c907f01fe6b0df00437b9515c72c8603ca30af4f17d6825ffc6c56698b0ba334de47bd15e873dfb49478032e058bf1de165f05777411f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Orest Kulik
+
+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,64 @@
+# Gitbc
+
+Gitbc is a tool that extracts information from GitHub pull requests and combines it with related Basecamp to-dos. It might come handy if you're using Basecamp to-dos for tracking progress of your tasks. To make such tracking work, each time you create a pull request you need to copy to-do's URL into its body (which is probably something you're doing already).
+
+Gitbc does its magic by running git CLI locally on the developer's machine. There is git instructed to pick up all merge commits from some given start tag (if end tag was omitted, HEAD will be used). Pull requests' numbers are extracted from those commits (PR numbers are embedded into merge commits automatically by GitHub) and content of each pull request is retrieved using GitHub API. If the body of pull request contains a Basecamp's to-do URL, its title is fetched via Basecamp API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitbc', git: 'https://github.com/okulik/gitbc.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install specific_install && gem specific_install https://github.com/okulik/gitbc.git
+
+## Usage
+
+The only required parameter is start tag. All other parameters, such as branch and git repository names, will be automatically inferred by gitbc. Here are all available CLI parameters:
+
+```bash
+Usage: git-bc <start_tag> [end_tag] [options]
+    -f, --config-file FILE           Use specific configurations file (default is ~/.gitbc)
+    -a, --github-token TOKEN         Use specific GitHub access token
+    -u, --basecamp-user USER         Use specific Basecamp user
+    -p, --basecamp-password PASSWORD Use specific Basecamp password
+    -b, --branch BRANCH              Use specific git branch
+    -r, --repository REPO            Query specific GitHub repository
+    -q, --quiet                      Quiet tool output
+    -c, --basecamp-content           Include content of the related Basecamp TODO
+    -h, --help                       Show this message
+```
+
+GitHub and Basecamp credentials can be provided using CLI parameters or by creating a configuration file (default one used is ~/.gitbc).
+
+Configuration file requires three items:
+
+*  github\_access\_token - a personal [GitHub access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use), use full private repo access
+* basecamp\_user - Basecamp account's user name
+* basecamp\_password - Basecamp account's password
+
+Here's an example how .gitbc should look like
+
+```
+github_access_token: abcdefghabcdefghabcdefghabcdefghabcdefgh
+basecamp_user: orest@nisdom.com
+basecamp_password: 123456789012345678901234567890
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/okulik/gitbc.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/gitbc

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+
+require 'gitbc'
+
+trap('SIGINT') {puts ''; exit!}
+
+options = {}
+options[:config_file] = GitHubBasecampExtractor::DEFAULT_CONFIG_FILE
+options[:quiet] = false
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: git-bc <start_tag> [end_tag] [options]'
+
+  opts.on('-f FILE', '--config-file FILE', 'Use specific configurations file (default is ~/.gitbc)') do |f|
+    options[:config_file] = f
+  end
+
+  opts.on('-a TOKEN', '--github-token TOKEN', 'Use specific GitHub access token') do |a|
+    options[:github_access_token] = a
+  end
+
+  opts.on('-u USER', '--basecamp-user USER', 'Use specific Basecamp user') do |u|
+    options[:basecamp_user] = u
+  end
+
+  opts.on('-p PASSWORD', '--basecamp-password PASSWORD', 'Use specific Basecamp password') do |p|
+    options[:basecamp_password] = p
+  end
+
+  opts.on('-b BRANCH', '--branch BRANCH', 'Use specific git branch') do |b|
+    options[:branch] = b
+  end
+
+  opts.on('-r REPO', '--repository REPO', 'Query specific GitHub repository') do |r|
+    options[:repository] = r
+  end
+
+  opts.on('-q', '--quiet', 'Quiet tool output') do |q|
+    options[:quiet] = q
+  end
+
+  opts.on('-c', '--basecamp-content', 'Include content of the related Basecamp TODO') do |c|
+    options[:basecamp_content] = c
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+end
+
+opt_parser.parse!
+
+start_tag, end_tag = ARGV
+if start_tag.nil?
+  puts 'missing start tag'
+  exit -1
+end
+options[:start_tag] = start_tag
+options[:end_tag] = end_tag || GitHubBasecampExtractor::DEFAULT_END_TAG
+
+unless File.exist?(options[:config_file])
+  puts 'bad settings file'
+  exit -1
+end
+
+settings = YAML.load_file(options[:config_file])
+options[:github_access_token] = settings['github_access_token'] if settings['github_access_token']
+options[:basecamp_user] = settings['basecamp_user'] if settings['basecamp_user']
+options[:basecamp_password] = settings['basecamp_password'] if settings['basecamp_password']
+
+if options[:github_access_token].nil?
+  puts 'missing github token'
+  exit -1
+end
+
+if options[:basecamp_user].nil?
+  puts 'missing basecamp user name'
+  exit -1
+end
+
+if options[:basecamp_password].nil?
+  puts 'missing basecamp password'
+  exit -1
+end
+
+gitbc = GitHubBasecampExtractor.new(options)
+
+unless gitbc.is_git_installed?
+  puts 'git not installed'
+  exit -1
+end
+
+unless gitbc.is_git_repo?
+  puts 'not a git repo'
+  exit -1
+end
+
+if options[:branch]
+  unless gitbc.git_branch_exists?(options[:branch])
+    puts 'no such branch'
+    exit -1
+  end
+else
+  options[:branch] = gitbc.git_branch
+end
+
+if options[:repository]
+  unless gitbc.repo_exists?(options[:repository])
+    puts 'no such repo'
+    exit -1
+  end
+else
+  options[:repository] = gitbc.git_repository
+end
+
+unless gitbc.remote_matches?(options[:repository])
+  puts 'no such remote'
+  exit -1
+end
+
+unless gitbc.revision_exists?(options[:start_tag])
+  puts 'no such start tag'
+  exit -1
+end
+
+unless gitbc.revision_exists?(options[:end_tag])
+  puts 'no such end tag'
+  exit -1
+end
+
+gitbc.update_options(options)
+
+print 'parsing git logs...' unless options[:quiet]
+pull_requests = gitbc.get_pull_requests_from_git_logs
+puts "#{pull_requests.count} pull requests".send(pull_requests.count == 0 ? :yellow : :green) unless options[:quiet]
+if pull_requests.count == 0
+  exit 0
+end
+
+print 'querying GitHub for PRs...' unless options[:quiet]
+unless gitbc.is_github_alive?
+  puts 'not available'.red unless options[:quiet]
+  exit -1
+end
+puts 'ok'.green unless options[:quiet]
+
+basecamp_todos = gitbc.get_basecamp_todos(pull_requests) do |_, _|
+  print '.'.green unless options[:quiet]
+end
+puts '' unless options[:quiet]
+if basecamp_todos.count > 0
+  puts "start tag: #{options[:start_tag]}"
+  puts "end tag: #{options[:end_tag]}"
+  puts "branch: #{options[:branch]}"
+  puts "repository: #{options[:repository]}"
+  puts "********************************************"
+  basecamp_todos.each do |pr, todos|
+    puts "PR #{pr}"
+    todos.each do |todo|
+      puts "  #{todo[:url]}" + (todo[:content] ? ": #{todo[:content]}" : '')
+    end
+  end
+end
+
+exit 0

data/gitbc.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gitbc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gitbc'
+  spec.version       = Gitbc::VERSION
+  spec.authors       = ['Orest Kulik']
+  spec.email         = 'orest@nisdom.com'
+
+  spec.summary       = 'GitHub Basecamp to-dos extractor'
+  spec.description   = "Extracts Basecamp to-do URLs and titles from GitHub pull requests body"
+  spec.platform      = Gem::Platform::RUBY
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'octokit', '~> 4.2'
+  spec.add_dependency 'colorize', '~> 0.7'
+  spec.add_dependency 'httparty', '~> 0.13.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/gitbc/version.rb

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

data/lib/gitbc.rb

@@ -0,0 +1,98 @@
+require 'httparty'
+require 'colorize'
+require 'octokit'
+
+require 'optparse'
+require 'json'
+require 'yaml'
+require 'open3'
+
+class GitHubBasecampExtractor
+  DEFAULT_CONFIG_FILE = File.expand_path('~/.gitbc')
+  DEFAULT_END_TAG = 'HEAD'
+
+  def initialize(params)
+    @params = params
+    @github_client = Octokit::Client.new(access_token: @params[:github_access_token])
+  end
+
+  def get_pull_requests_from_git_logs
+    lines = `git --no-pager log #{@params[:branch]} #{@params[:start_tag]}..#{@params[:end_tag]} --merges | grep 'Merge pull request #'`.split("\n")
+    lines.map {|l| l[/.*#([0-9]+)/,1].to_i}
+  end
+
+  def is_git_installed?
+    begin
+      Open3.popen3('git --version')
+      return true
+    rescue Errno::ENOENT
+      return false
+    end
+  end
+
+  def is_git_repo?
+    Open3.popen3('git status') { |_, _, stderr, _| stderr.read } !~ /Not a git repository/
+  end
+
+  def git_branch
+    Open3.popen3('git status') { |_, stdout, _, _| stdout.read }[/^On branch ([^\n]+)/,1]
+  end
+
+  def git_branch_exists?(branch)
+    Open3.popen3('git branch') { |_, stdout, _, _| stdout.read } =~ /#{branch}/
+  end
+
+  def git_repository
+    Open3.popen3('git remote -v') { |_, stdout, _, _| stdout.read }[/git@github.com:(.+).git/,1]
+  end
+
+  def repo_exists?(repo)
+    @github_client.repository?(repo)
+  end
+
+  def remote_matches?(repo)
+    Open3.popen3('git remote -v') { |_, stdout, _, _| stdout.read } =~ /#{repo}/
+  end
+
+  def revision_exists?(rev)
+    Open3.popen3("git cat-file -t #{rev}") { |_, stdout, _, _| stdout.read } =~ /commit/
+  end
+
+  def is_github_alive?
+    begin
+      raise if @github_client.github_status_last_message.attrs[:status] != 'good'
+    rescue
+      return false
+    end
+    return true
+  end
+
+  def update_options(options)
+    @params.merge(options)
+  end
+
+  def get_basecamp_todos(pull_requests)
+    basecamp_todos = pull_requests.inject({}) do |memo, pull_request_id|
+      pr = @github_client.pull_request(@params[:repository], pull_request_id)
+      basecamp_lines = pr.attrs[:body].split("\r\n").grep(/.*https\:\/\/basecamp\.com.*/)
+      if basecamp_lines.count > 0
+        memo[pull_request_id] = basecamp_lines.map { |line| {url: line[/.*(https\:\/\/basecamp\.com[^!?#:;,.\s]*)/, 1]} }.uniq
+        if @params[:basecamp_content]
+          memo[pull_request_id].each do |line|
+            line[:url].match /(https\:\/\/basecamp\.com\/\d+\/)(.*)/ do |match|
+              begin
+                ret = HTTParty.get "#{match[1]}api/v1/#{match[2]}.json", {basic_auth: {username: @params[:basecamp_user], password: @params[:basecamp_password]}, headers: {'Content-Type' => 'application/json', 'User-Agent' => "gitbc API (#{@params[:basecamp_user]})"}}
+                line[:content] = JSON.parse(ret.body)['content'] if ret != nil && ret.body.length > 0
+              rescue
+              end
+            end
+          end
+        end
+      end
+      memo[pull_request_id] ||= []
+      yield(pull_request_id, memo[pull_request_id])
+      memo
+    end
+    basecamp_todos
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: gitbc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Orest Kulik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Extracts Basecamp to-do URLs and titles from GitHub pull requests body
+email: orest@nisdom.com
+executables:
+- gitbc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gitbc
+- gitbc.gemspec
+- lib/gitbc.rb
+- lib/gitbc/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: GitHub Basecamp to-dos extractor
+test_files: []