gitx 2.13.1

data/lib/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/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/gitx/github.rb

@@ -0,0 +1,178 @@
+require 'octokit'
+require 'fileutils'
+require 'yaml'
+require 'gitx/cli/update_command'
+
+module Gitx
+  module Github
+    GLOBAL_CONFIG_FILE = '~/.config/gitx/github.yml'
+    REVIEW_CONTEXT = 'peer_review'
+    CLIENT_URL = 'https://github.com/wireframe/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
+        checkout_branch(branch)
+        execute_command(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(pull_request, state, description)
+      commit_sha = pull_request.head.sha
+      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 "#{Gitx::BASE_BRANCH} ", :green
+      say 'in '
+      say github_slug, :green
+
+      title = branch
+      body = pull_request_body(branch)
+      github_client.create_pull_request(github_slug, Gitx::BASE_BRANCH, branch, title, body)
+    end
+
+    def pull_request_body(branch)
+      changelog = run_cmd("git log #{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 = ENV['GITX_GITHUB_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/wireframe/gitx.git #=> wireframe/gitx
+    # @example
+    #   https://github.com/wireframe/gitx.git #=> wireframe/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

data/lib/gitx/version.rb

@@ -0,0 +1,3 @@
+module Gitx
+  VERSION = '2.13.1'
+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/wireframe/gitx/pulls?head=wireframe: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/wireframe/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

data/spec/fixtures/vcr_cassettes/pull_request_does_exist_with_success_status.yml

@@ -0,0 +1,149 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/repos/wireframe/gitx/pulls?head=wireframe:feature-branch&state=open
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json
+      User-Agent:
+      - Octokit Ruby Gem 3.2.0
+      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:
+      - Tue, 05 Aug 2014 16:36:03 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4991'
+      X-Ratelimit-Reset:
+      - '1407257585'
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      Etag:
+      - '"6d00d48abf2adf1877c8244700cd4c6f"'
+      X-Oauth-Scopes:
+      - repo
+      X-Accepted-Oauth-Scopes:
+      - ''
+      Vary:
+      - Accept, Authorization, Cookie, X-GitHub-OTP
+      - Accept-Encoding
+      X-Github-Media-Type:
+      - github.v3; format=json
+      Link:
+      - <https://api.github.com/repositories/17608725/pulls?head=wireframe%3Afeature-branch&state=open&page=0>;
+        rel="last"
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - deny
+      Content-Security-Policy:
+      - default-src 'none'
+      Content-Length:
+      - '2'
+      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:
+      - 46C5E25C:1E4F:1642AD9:53E107F3
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains
+      X-Content-Type-Options:
+      - nosniff
+      X-Served-By:
+      - d818ddef80f4c7d10683dd483558952a
+    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", "sha": "e12da4"}}]'
+    http_version:
+  recorded_at: Tue, 05 Aug 2014 16:36:03 GMT
+- request:
+    method: get
+    uri: https://api.github.com/repos/wireframe/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":"success"}'
+    http_version:
+  recorded_at: Wed, 10 Dec 2014 19:14:11 GMT
+recorded_with: VCR 2.9.2