livebuzz-gitx 0.1.0

data/lib/livebuzz/gitx/cli/review_command.rb

@@ -0,0 +1,101 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+require 'livebuzz/gitx/cli/update_command'
+require 'livebuzz/gitx/github'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class ReviewCommand < BaseCommand
+        include LiveBuzz::Gitx::Github
+
+        BUMP_COMMENT_PREFIX = '[gitx] review bump :tada:'
+        BUMP_COMMENT_FOOTER = <<-EOS.dedent
+          # Bump comments should include:
+          # * summary of what changed
+          #
+          # This footer will automatically be stripped from the created comment
+        EOS
+        APPROVAL_COMMENT_PREFIX  = '[gitx] review approved :shipit:'
+        APPROVAL_COMMENT_FOOTER = <<-EOS.dedent
+          # Approval comments can include:
+          # * feedback
+          # * post-release follow-up items
+          #
+          # This footer will automatically be stripped from the created comment
+        EOS
+        REJECTION_COMMENT_PREFIX = '[gitx] review rejected'
+        REJECTION_COMMENT_FOOTER = <<-EOS.dedent
+          # Rejection comments should include:
+          # * feedback for fixes required before approved
+          #
+          # This footer will automatically be stripped from the created comment
+        EOS
+
+        desc "review", "Create or update a pull request on github"
+        method_option :description, :type => :string, :aliases => '-d', :desc => 'pull request description'
+        method_option :assignee, :type => :string, :aliases => '-a', :desc => 'pull request assignee'
+        method_option :open, :type => :boolean, :aliases => '-o', :desc => 'open the pull request in a web browser'
+        method_option :bump, :type => :boolean, :aliases => '-b', :desc => 'bump an existing pull request by posting a comment to re-review new changes'
+        method_option :approve, :type => :boolean, :desc => 'approve the pull request an post comment on pull request'
+        method_option :reject, :type => :boolean, :desc => 'reject the pull request an post comment on pull request'
+        # @see http://developer.github.com/v3/pulls/
+        def review
+          fail 'Github authorization token not found' unless authorization_token
+
+          branch = current_branch.name
+          pull_request = find_or_create_pull_request(branch)
+          bump_pull_request(pull_request) if options[:bump]
+          approve_pull_request(pull_request) if options[:approve]
+          reject_pull_request(pull_request) if options[:reject]
+          assign_pull_request(pull_request) if options[:assignee]
+
+          run_cmd "open #{pull_request.html_url}" if options[:open]
+        end
+
+        private
+
+        def assign_pull_request(pull_request)
+          assignee = options[:assignee]
+          say "Assigning pull request to "
+          say assignee, :green
+
+          title = pull_request.title
+          body = pull_request.body
+          options = {
+            assignee: assignee
+          }
+          github_client.update_issue(github_slug, pull_request.number, title, body, options)
+        end
+
+        def bump_pull_request(pull_request)
+          comment = comment_from_template(pull_request, BUMP_COMMENT_PREFIX, BUMP_COMMENT_FOOTER)
+          set_review_status('pending', 'Peer review in progress')
+        end
+
+        def reject_pull_request(pull_request)
+          comment = comment_from_template(pull_request, REJECTION_COMMENT_PREFIX, REJECTION_COMMENT_FOOTER)
+          set_review_status('failure', 'Peer review rejected')
+        end
+
+        def approve_pull_request(pull_request)
+          comment = comment_from_template(pull_request, APPROVAL_COMMENT_PREFIX, APPROVAL_COMMENT_FOOTER)
+          set_review_status('success', 'Peer review approved')
+        end
+
+        def comment_from_template(pull_request, prefix, footer)
+          text = ask_editor("\n\n#{footer}", repo.config['core.editor'])
+          comment = [prefix, text].join("\n\n")
+          comment = comment.gsub(footer, '').chomp.strip
+          github_client.add_comment(github_slug, pull_request.number, comment)
+        end
+
+        def set_review_status(state, description)
+          latest_commit = repo.head.target_id
+          update_review_status(latest_commit, state, description)
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/share_command.rb

@@ -0,0 +1,17 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class ShareCommand < BaseCommand
+        desc 'share', 'Share the current branch in the remote repository'
+        def share
+          run_cmd "git push origin #{current_branch.name}"
+          run_cmd "git branch --set-upstream-to origin/#{current_branch.name}"
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/start_command.rb

@@ -0,0 +1,39 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class StartCommand < BaseCommand
+        EXAMPLE_BRANCH_NAMES = %w( api-fix-invalid-auth desktop-cleanup-avatar-markup share-form-add-edit-link )
+        VALID_BRANCH_NAME_REGEX = /^[A-Za-z0-9\-_]+$/
+
+        desc 'start', 'start a new git branch with latest changes from master'
+        def start(branch_name = nil)
+          until valid_new_branch_name?(branch_name)
+            branch_name = ask("What would you like to name your branch? (ex: #{EXAMPLE_BRANCH_NAMES.sample})")
+          end
+
+          checkout_branch LiveBuzz::Gitx::BASE_BRANCH
+          run_cmd 'git pull'
+          repo.create_branch branch_name, LiveBuzz::Gitx::BASE_BRANCH
+          checkout_branch branch_name
+        end
+
+        private
+
+        def valid_new_branch_name?(branch)
+          return false if repo_branches.include?(branch)
+          branch =~ VALID_BRANCH_NAME_REGEX
+        end
+
+        def repo_branches
+          @branch_names ||= repo.branches.each_name.map do |branch|
+            branch.split('/').last
+          end
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/track_command.rb

@@ -0,0 +1,16 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class TrackCommand < BaseCommand
+        desc 'track', 'set the current branch to track the remote branch with the same name'
+        def track
+          run_cmd "git branch --set-upstream-to origin/#{current_branch.name}"
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/update_command.rb

@@ -0,0 +1,37 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class UpdateCommand < BaseCommand
+        desc 'update', 'Update the current branch with latest changes from the remote feature branch and master'
+        def update
+          say "Updating "
+          say "#{current_branch.name} ", :green
+          say "with latest changes from "
+          say LiveBuzz::Gitx::BASE_BRANCH, :green
+
+          update_branch(current_branch.name) if remote_branch_exists?(current_branch.name)
+          update_branch(LiveBuzz::Gitx::BASE_BRANCH)
+          run_cmd 'git push origin HEAD'
+        end
+
+        private
+
+        def update_branch(branch)
+          begin
+            run_cmd "git pull origin #{branch}"
+          rescue
+            fail MergeError, "Merge Conflict Occurred. Please fix merge conflict and rerun the update command"
+          end
+        end
+
+        def remote_branch_exists?(branch)
+          repo.branches.each_name(:remote).include?("origin/#{branch}")
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/configuration.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module LiveBuzz
+  module Gitx
+    class Configuration
+      DEFAULT_CONFIG = {
+        'aggregate_branches' => %w( staging prototype ),
+        'reserved_branches' => %w( HEAD master next_release staging prototype ),
+        'taggable_branches' => %w( master staging )
+      }
+      CONFIG_FILE = '.gitx.yml'
+
+      attr_reader :config
+
+      def initialize(root_dir)
+        @config = Thor::CoreExt::HashWithIndifferentAccess.new(DEFAULT_CONFIG)
+        config_file_path = File.join(root_dir, CONFIG_FILE)
+        if File.exists?(config_file_path)
+          @config.merge!(::YAML::load_file(config_file_path))
+        end
+      end
+
+      def aggregate_branches
+        config[:aggregate_branches]
+      end
+      def aggregate_branch?(branch)
+        aggregate_branches.include?(branch)
+      end
+
+      def reserved_branches
+        config[:reserved_branches]
+      end
+
+      def reserved_branch?(branch)
+        reserved_branches.include?(branch)
+      end
+
+      def taggable_branches
+        config[:taggable_branches]
+      end
+
+      def taggable_branch?(branch)
+        taggable_branches.include?(branch)
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/extensions/string.rb

@@ -0,0 +1,12 @@
+class String
+  # @see http://api.rubyonrails.org/classes/String.html#method-i-strip_heredoc
+  def undent
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+  alias :dedent :undent
+
+  def blank?
+    self.to_s == ''
+  end
+end

data/lib/livebuzz/gitx/extensions/thor.rb

@@ -0,0 +1,39 @@
+require 'English'
+
+class Thor
+  module Actions
+    # execute a shell command and raise an error if non-zero exit code is returned
+    # return the string output from the command
+    def run_cmd(cmd, options = {})
+      say "$ #{cmd}"
+      output = `#{cmd}`
+      success = $CHILD_STATUS.to_i == 0
+      fail "#{cmd} failed" unless success || options[:allow_failure]
+      output
+    end
+
+    # launch configured editor to retreive message/string
+    # see http://osdir.com/ml/ruby-talk/2010-06/msg01424.html
+    # see https://gist.github.com/rkumar/456809
+    # see http://rdoc.info/github/visionmedia/commander/master/Commander/UI.ask_editor
+    def ask_editor(initial_text = '', editor = nil)
+      editor ||= ENV['EDITOR'] || 'vi'
+      Tempfile.open('comment.md') do |f|
+        f << initial_text
+        f.flush
+
+        flags = case editor
+        when 'mate', 'emacs', 'subl'
+          '-w'
+        when 'mvim'
+          '-f'
+        else
+          ''
+        end
+        pid = fork { exec([editor, flags, f.path].join(' ')) }
+        Process.waitpid(pid)
+        File.read(f.path)
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/github.rb

@@ -0,0 +1,177 @@
+require 'octokit'
+require 'fileutils'
+require 'yaml'
+
+module LiveBuzz
+  module Gitx
+    module Github
+      GLOBAL_CONFIG_FILE = '~/.config/gitx/github.yml'
+      REVIEW_CONTEXT = 'peer_review'
+      CLIENT_URL = 'https://github.com/livebuzzevents/livebuzz-gitx'
+      PULL_REQUEST_FOOTER = <<-EOS.dedent
+        # Pull Request Protips(tm):
+        # * Include description of how this change accomplishes the task at hand.
+        # * Use GitHub flavored Markdown http://github.github.com/github-flavored-markdown/
+        # * Review CONTRIBUTING.md for recommendations of artifacts, links, images, screencasts, etc.
+        #
+        # This footer will automatically be stripped from the pull request description
+      EOS
+
+      def find_or_create_pull_request(branch)
+        pull_request = find_pull_request(branch)
+        pull_request ||= begin
+          execute_command(LiveBuzz::Gitx::Cli::UpdateCommand, :update)
+          pull_request = create_pull_request(branch)
+          say 'Created pull request: '
+          say pull_request.html_url, :green
+
+          pull_request
+        end
+        pull_request
+      end
+
+      # @return [Sawyer::Resource] data structure of pull request info if found
+      # @return nil if no pull request found
+      def find_pull_request(branch)
+        head_reference = "#{github_organization}:#{branch}"
+        params = {
+          head: head_reference,
+          state: 'open'
+        }
+        pull_requests = github_client.pull_requests(github_slug, params)
+        pull_requests.first
+      end
+
+      # Get the current commit status of a branch
+      # @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
+      def branch_status(branch)
+        response = github_client.status(github_slug, branch)
+        response.state
+      end
+
+      # Update build status with peer review status
+      def update_review_status(commit_sha, state, description)
+        github_client.create_status(github_slug, commit_sha, state, context: REVIEW_CONTEXT, description: description)
+      end
+
+      # @see http://developer.github.com/v3/pulls/
+      def create_pull_request(branch)
+        say "Creating pull request for "
+        say "#{branch} ", :green
+        say "against "
+        say "#{LiveBuzz::Gitx::BASE_BRANCH} ", :green
+        say "in "
+        say github_slug, :green
+
+        title = branch
+        body = pull_request_body(branch)
+        github_client.create_pull_request(github_slug, LiveBuzz::Gitx::BASE_BRANCH, branch, title, body)
+      end
+
+      def pull_request_body(branch)
+        changelog = run_cmd("git log #{LiveBuzz::Gitx::BASE_BRANCH}...#{branch} --reverse --no-merges --pretty=format:'* %s%n%b'")
+        description = options[:description]
+
+        description_template = []
+        description_template << "#{description}\n" if description
+        description_template << '### Changelog'
+        description_template << changelog
+        description_template << PULL_REQUEST_FOOTER
+
+        body = ask_editor(description_template.join("\n"), repo.config['core.editor'])
+        body.gsub(PULL_REQUEST_FOOTER, '').chomp.strip
+      end
+
+      # authorization token used for github API calls
+      # the token is cached on the filesystem for future use
+      # @return [String] auth token stored in git (current repo, user config or installed global settings)
+      # @see http://developer.github.com/v3/oauth/#scopes
+      # @see http://developer.github.com/v3/#user-agent-required
+      def authorization_token
+        auth_token = global_config['token']
+        auth_token ||= begin
+          new_token = create_authorization
+          save_global_config('token' => new_token)
+          new_token
+        end
+        auth_token
+      end
+
+      def create_authorization
+        password = ask_without_echo("Github password for #{username}: ")
+        client = Octokit::Client.new(login: username, password: password)
+        options = {
+          :scopes => ['repo'],
+          :note => github_client_name,
+          :note_url => CLIENT_URL
+        }
+        two_factor_auth_token = ask_without_echo("Github two factor authorization token (if enabled): ")
+        options[:headers] = {'X-GitHub-OTP' => two_factor_auth_token} if two_factor_auth_token
+        response = client.create_authorization(options)
+        response.token
+      rescue Octokit::ClientError => e
+        say "Error creating authorization: #{e.message}", :red
+        retry
+      end
+
+      def github_client_name
+        timestamp = Time.now.utc.strftime('%FT%R:%S%z')
+        client_name = "The Garage Git eXtensions #{timestamp}"
+      end
+
+      def github_client
+        @client ||= Octokit::Client.new(:access_token => authorization_token)
+      end
+
+      # @return [String] github username (ex: 'wireframe') of the current github.user
+      # @raise error if github.user is not configured
+      def username
+        username = repo.config['github.user']
+        fail "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" unless username
+        username
+      end
+
+      # @return the github slug for the current repository's remote origin url.
+      # @example
+      #   git@github.com:socialcast/livebuzz/gitx.git #=> livebuzz/gitx
+      # @example
+      #   https://github.com/socialcast/livebuzz/gitx.git #=> livebuzz/gitx
+      def github_slug
+        remote = repo.config['remote.origin.url']
+        remote.to_s.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
+      end
+
+      def github_organization
+        github_slug.split('/').first
+      end
+
+      def global_config_file
+        File.expand_path(GLOBAL_CONFIG_FILE)
+      end
+
+      def global_config
+        @config ||= begin
+          File.exists?(global_config_file) ? YAML.load_file(global_config_file) : {}
+        end
+      end
+
+      def save_global_config(options)
+        config_dir = File.dirname(global_config_file)
+        ::FileUtils.mkdir_p(config_dir, mode: 0700) unless File.exists?(config_dir)
+
+        @config = global_config.merge(options)
+        File.open(global_config_file, "a+") do |file|
+          file.truncate(0)
+          file.write(@config.to_yaml)
+        end
+        File.chmod(0600, global_config_file)
+      end
+
+      def ask_without_echo(message)
+        value = ask(message, echo: false)
+        say ''
+        value
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/version.rb

@@ -0,0 +1,5 @@
+module LiveBuzz
+  module Gitx
+    VERSION = '0.1.0'
+  end
+end

data/lib/livebuzz/gitx.rb

@@ -0,0 +1,10 @@
+require 'livebuzz/gitx/version'
+require 'livebuzz/gitx/configuration'
+require 'livebuzz/gitx/extensions/string'
+require 'livebuzz/gitx/extensions/thor'
+
+module LiveBuzz
+  module Gitx
+    BASE_BRANCH = 'master'
+  end
+end

data/livebuzz-gitx.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'livebuzz/gitx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "livebuzz-gitx"
+  spec.version       = LiveBuzz::Gitx::VERSION
+  spec.authors       = ["LiveBuzz, forked from code by Ryan Sonnek"]
+  spec.email         = ["rob.lambell@livebuzz.co.uk"]
+  spec.description   = %q{Git eXtensions for common development workflow}
+  spec.summary       = %q{Utility scripts for Git to increase productivity for common operations}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rugged", '~> 0.21.0'
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "octokit"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.0'
+  spec.add_development_dependency "pry", '>= 0'
+  spec.add_development_dependency "webmock", '>= 0'
+  spec.add_development_dependency "timecop", "~> 0.7.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency 'terminal-notifier'
+  spec.add_development_dependency 'terminal-notifier-guard'
+end

data/spec/fixtures/vcr_cassettes/pull_request_does_exist_with_failure_status.yml

@@ -0,0 +1,135 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/repos/livebuzzevents/livebuzz-gitx/pulls?head=livebuzz:feature-branch&state=open
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json
+      User-Agent:
+      - Octokit Ruby Gem 3.4.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - token 123123
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Wed, 10 Dec 2014 19:14:11 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Status:
+      - 200 OK
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '58'
+      X-Ratelimit-Reset:
+      - '1418242282'
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - deny
+      Content-Security-Policy:
+      - default-src 'none'
+      Content-Length:
+      - '83'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Github-Request-Id:
+      - C6CBAFAF:141F:450BDAC:54889B83
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains; preload
+      X-Content-Type-Options:
+      - nosniff
+    body:
+      encoding: UTF-8
+      string: '[{"html_url":"https://path/to/html/pull/request","issue_url":"https://api/path/to/issue/url","number":10,"head":{"ref":"branch_name"}}]'
+    http_version:
+  recorded_at: Wed, 10 Dec 2014 19:14:11 GMT
+- request:
+    method: get
+    uri: https://api.github.com/repos/livebuzzevents/livebuzz-gitx/commits/feature-branch/status
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json
+      User-Agent:
+      - Octokit Ruby Gem 3.4.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - token 123123
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Wed, 10 Dec 2014 19:01:27 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4993'
+      X-Ratelimit-Reset:
+      - '1418241620'
+      X-Oauth-Scopes:
+      - repo
+      X-Accepted-Oauth-Scopes:
+      - repo, repo:status
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - deny
+      Content-Security-Policy:
+      - default-src 'none'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Github-Request-Id:
+      - C6CBAFAF:141D:2F27072:54889887
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains; preload
+      X-Content-Type-Options:
+      - nosniff
+    body:
+      encoding: UTF-8
+      string: '{"state":"failure"}'
+    http_version:
+  recorded_at: Wed, 10 Dec 2014 19:14:11 GMT
+recorded_with: VCR 2.9.2