git-process-lib 2.0.0

data/lib/git-process/git_status.rb

@@ -0,0 +1,108 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module GitProc
+
+  #
+  # The status of the Git repository.
+  #
+  # @!attribute [r] unmerged
+  #   @return [Enumerable] a sorted list of unmerged files
+  # @!attribute [r] modified
+  #   @return [Enumerable] a sorted list of modified files
+  # @!attribute [r] deleted
+  #   @return [Enumerable] a sorted list of deleted files
+  # @!attribute [r] added
+  #   @return [Enumerable] a sorted list of files that have been added
+  # @!attribute [r] unknown
+  #   @return [Enumerable] a sorted list of unknown files
+  class GitStatus
+    attr_reader :unmerged, :modified, :deleted, :added, :unknown
+
+
+    def initialize(lib)
+      unmerged = []
+      modified = []
+      deleted = []
+      added = []
+      unknown = []
+
+      stats = lib.porcelain_status.split("\n")
+
+      stats.each do |s|
+        stat = s[0..1]
+        file = s[3..-1]
+        #puts "stat #{stat} - #{file}"
+        f = unquote(file)
+        case stat
+          when 'U ', ' U'
+            unmerged << f
+          when 'UU'
+            unmerged << f
+            modified << f
+          when 'M ', ' M', 'MM'
+            modified << f
+          when 'MD'
+            modified << f
+            deleted << f
+          when 'D ', ' D', 'DD'
+            deleted << f
+          when 'DU', 'UD'
+            deleted << f
+            unmerged << f
+          when 'A ', ' A'
+            added << f
+          when 'AD'
+            added << f
+            deleted << f
+          when 'AA', 'AU', 'UA'
+            added << f
+            unmerged << f
+          when 'AM', 'MA'
+            added << f
+            modified << f
+          when '??', '!!'
+            unknown << f
+          when 'R '
+            old_file, new_file = file.split(' -> ')
+            deleted << unquote(old_file)
+            added << unquote(new_file)
+          when 'C '
+            old_file, new_file = file.split(' -> ')
+            added << unquote(old_file)
+            added << unquote(new_file)
+          else
+            raise "Do not know what to do with status #{stat} - #{file}"
+        end
+      end
+
+      @unmerged = unmerged.sort.uniq.freeze
+      @modified = modified.sort.uniq.freeze
+      @deleted = deleted.sort.uniq.freeze
+      @added = added.sort.uniq.freeze
+      @unknown = unknown.sort.uniq.freeze
+    end
+
+
+    def unquote(file)
+      file.match(/^"?(.*?)"?$/)[1]
+    end
+
+
+    # @return [Boolean] are there any changes in the index or working directory?
+    def clean?
+      @unmerged.empty? and @modified.empty? and @deleted.empty? and @added.empty? and @unknown.empty?
+    end
+
+  end
+
+end

data/lib/git-process/github_configuration.rb

@@ -0,0 +1,298 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'git-process/git_lib'
+require 'highline/import'
+require 'octokit'
+require 'uri'
+
+
+#
+# Provides methods related to GitHub configuration
+#
+module GitHubService
+
+  class Configuration
+
+    attr_reader :git_config
+
+
+    #
+    # @param [GitProc::GitConfig] git_config
+    # @param [Hash] opts
+    # @option opts [String] :remote_name (#remote_name) The "remote" name to use (e.g., 'origin')
+    # @option opts [String] :user the username to authenticate with
+    # @option opts [String] :password (#password) the password to authenticate with
+    #
+    # @return [String] the OAuth token
+    #
+    def initialize(git_config, opts = {})
+      @git_config = git_config
+      @user = opts[:user]
+      @password = opts[:password]
+      @remote_name = opts[:remote_name]
+    end
+
+
+    # @return [String]
+    def remote_name
+      unless @remote_name
+        @remote_name = gitlib.remote.name
+        raise NoRemoteRepository.new('No remote repository is defined') unless @remote_name
+      end
+      @remote_name
+    end
+
+
+    # @return [String]
+    def user
+      @user ||= Configuration.ask_for_user(gitlib)
+    end
+
+
+    # @return [String]
+    def password
+      @password ||= Configuration.ask_for_password
+    end
+
+
+    # @return [Octokit::Client]
+    def client
+      create_client
+    end
+
+
+    # @return [GitProc::GitLib]
+    def gitlib
+      @git_config.gitlib
+    end
+
+
+    # @return [Octokit::Client]
+    def create_client(opts = {})
+      logger.debug { "Creating GitHub client for user #{user} using token '#{auth_token}'" }
+
+      base_url = opts[:base_url] || base_github_api_url_for_remote
+
+      configure_octokit(:base_url => base_url)
+
+      Octokit::Client.new(:login => user, :oauth_token => auth_token)
+    end
+
+
+    #
+    # Configures Octokit to use the appropriate URLs for GitHub server.
+    #
+    # @param [Hash] opts the options to create a message with
+    # @option opts [String] :base_url The base URL to use for the GitHub server
+    #
+    # @return [void]
+    #
+    def configure_octokit(opts = {})
+      base_url = opts[:base_url] || base_github_api_url_for_remote
+      Octokit.configure do |c|
+        c.api_endpoint = api_endpoint(base_url)
+        c.web_endpoint = web_endpoint(base_url)
+        c.faraday_config do |f|
+          #f.response :logger
+        end
+      end
+    end
+
+
+    #
+    # Determines the URL used for using the GitHub REST interface based
+    # on a "base" URL.
+    #
+    # If the "base_url" is not provided, then it assumes that this object
+    # has a "remote_name" property that it can ask.
+    #
+    # @param [String] base_url the base GitHub URL
+    # @return [String] the GitHub REST API URL
+    #
+    def api_endpoint(base_url = nil)
+      base_url ||= base_github_api_url_for_remote
+      if /github.com/ !~ base_url
+        "#{base_url}/api/v3"
+      else
+        Octokit::Configuration::DEFAULT_API_ENDPOINT
+      end
+    end
+
+
+    #
+    # Determines the URL used for using the GitHub web interface based
+    # on a "base" URL.
+    #
+    # If the "base_url" is not provided, then it assumes that this object
+    # has a "remote_name" property that it can ask.
+    #
+    # @param [String] base_url the base GitHub URL
+    # @return [String] the GitHub web URL
+    #
+    def web_endpoint(base_url = nil)
+      base_url ||= base_github_api_url_for_remote
+      if /github.com/ !~ base_url
+        base_url
+      else
+        Octokit::Configuration::DEFAULT_WEB_ENDPOINT
+      end
+    end
+
+
+    #
+    # Determines the base URL for GitHub API calls.
+    #
+    # @return [String] the base GitHub API URL
+    #
+    def base_github_api_url_for_remote
+      url = gitlib.remote.expanded_url(remote_name)
+      Configuration.url_to_base_github_api_url(url)
+    end
+
+
+    #
+    # Translate any "git known" URL to the HTTP(S) URL needed for
+    # GitHub API calls.
+    #
+    # @param url [String] the URL to translate
+    # @return [String] the base GitHub API URL
+    #
+    def self.url_to_base_github_api_url(url)
+      uri = URI.parse(url)
+      host = uri.host
+
+      if /github.com$/ =~ host
+        'https://api.github.com'
+      else
+        scheme = uri.scheme
+        scheme = 'https' unless scheme.start_with?('http')
+        host = 'unknown-host' unless host
+        "#{scheme}://#{host}"
+      end
+    end
+
+
+    #
+    # Create a GitHub client using username and password specifically.
+    # Meant to be used to get an OAuth token for "regular" client calls.
+    #
+    # @param [Hash] opts the options to create a message with
+    # @option opts [String] :base_url The base URL to use for the GitHub server
+    # @option opts [String] :remote_name (#remote_name) The "remote" name to use (e.g., 'origin')
+    # @option opts [String] :user the username to authenticate with
+    # @option opts [String] :password (#password) the password to authenticate with
+    #
+    def create_pw_client(opts = {})
+      usr = opts[:user] || user()
+      pw = opts[:password] || password()
+
+      logger.debug { "Creating GitHub client for user #{usr} using BasicAuth w/ password" }
+
+      configure_octokit(opts)
+
+      Octokit::Client.new(:login => usr, :password => pw)
+    end
+
+
+    #
+    # Returns to OAuth token. If it's in .git/config, returns that.
+    #   Otherwise it connects to GitHub to get the authorization token.
+    #
+    # @param [Hash] opts
+    # @option opts [String] :base_url The base URL to use for the GitHub server
+    # @option opts [String] :remote_name (#remote_name) The "remote" name to use (e.g., 'origin')
+    # @option opts [String] :user the username to authenticate with
+    # @option opts [String] :password (#password) the password to authenticate with
+    #
+    # @return [String]
+    #
+    def auth_token(opts = {})
+      get_config_auth_token() || create_authorization(opts)
+    end
+
+
+    #
+    # Connects to GitHub to get an OAuth token.
+    #
+    # @param [Hash] opts
+    # @option opts [String] :base_url The base URL to use for the GitHub server
+    # @option opts [String] :remote_name (#remote_name) The "remote" name to use (e.g., 'origin')
+    # @option opts [String] :user the username to authenticate with
+    # @option opts [String] :password (#password) the password to authenticate with
+    #
+    # @return [String] the OAuth token
+    #
+    def create_authorization(opts = {})
+      username = opts[:user] || self.user
+      remote = opts[:remote_name] || self.remote_name
+      logger.info("Authorizing #{username} to work with #{remote}.")
+
+      auth = create_pw_client(opts).create_authorization(
+          :scopes => %w(repo user gist),
+          :note => 'Git-Process',
+          :note_url => 'http://jdigger.github.com/git-process')
+
+      config_auth_token = auth['token']
+
+      # remember it for next time
+      gitlib.config['gitProcess.github.authToken'] = config_auth_token
+
+      config_auth_token
+    end
+
+
+    # @return [String]
+    def get_config_auth_token
+      c_auth_token = gitlib.config['gitProcess.github.authToken']
+      (c_auth_token.nil? or c_auth_token.empty?) ? nil : c_auth_token
+    end
+
+
+    def logger
+      gitlib.logger
+    end
+
+
+    private
+
+
+    def self.ask_for_user(gitlib)
+      user = gitlib.config['github.user']
+      if user.nil? or user.empty?
+        user = ask("Your <%= color('GitHub', [:bold, :blue]) %> username: ") do |q|
+          q.validate = /^\w\w+$/
+        end
+        gitlib.config['github.user'] = user
+      end
+      user
+    end
+
+
+    def self.ask_for_password
+      ask("Your <%= color('GitHub', [:bold, :blue]) %> password: ") do |q|
+        q.validate = /^\S\S+$/
+        q.echo = 'x'
+      end
+    end
+
+  end
+
+
+  class Error < ::StandardError
+  end
+
+
+  class NoRemoteRepository < Error
+  end
+
+end

data/lib/git-process/github_pull_request.rb

@@ -0,0 +1,165 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'git-process/github_configuration'
+require 'octokit'
+require 'octokit/repository'
+
+
+module GitHub
+
+  class PullRequest
+    attr_reader :gitlib, :repo, :remote_name, :client, :configuration
+
+    MAX_RESEND = 5
+
+    def initialize(lib, remote_name, repo, opts = {})
+      @gitlib = lib
+      @repo = repo
+      @remote_name = remote_name
+      @configuration = GitHubService::Configuration.new(gitlib.config, :user => opts[:user], :password => opts[:password])
+    end
+
+
+    def client
+      @client ||= @configuration.create_client
+    end
+
+
+    def pull_requests(state = 'open', opts = {})
+      @pull_requests ||= client.pull_requests(repo, state, opts)
+    end
+
+
+    def create(base, head, title, body)
+      logger.info { "Creating a pull request asking for '#{head}' to be merged into '#{base}' on #{repo}." }
+      begin
+        client.create_pull_request(repo, base, head, title, body)
+      rescue Octokit::UnprocessableEntity => exp
+        pull = pull_requests.find { |p| p[:head][:ref] == head and p[:base][:ref] == base }
+        if pull
+          logger.warn { "Pull request already exists. See #{pull[:html_url]}" }
+        else
+          logger.warn { "UnprocessableEntity: #{exp}" }
+        end
+        pull
+      end
+    end
+
+
+    def logger
+      @gitlib.logger
+    end
+
+
+    def pull_request(pr_number)
+      client.pull_request(repo, pr_number)
+    end
+
+
+    #
+    # Find the pull request (PR) that matches the 'head' and 'base'.
+    #
+    # @param [String] base what the PR is merging into
+    # @param [String] head the branch of the PR
+    #
+    # @return [Hash]
+    # @raise [NotFoundError] if the pull request does not exist
+    #
+    def get_pull_request(base, head)
+      find_pull_request(base, head, true)
+    end
+
+
+    #
+    # Find the pull request (PR) that matches the 'head' and 'base'.
+    #
+    # @param [String] base what the PR is merging into
+    # @param [String] head the branch of the PR
+    # @param [boolean] error_if_missing should this error-out if the PR is not found?
+    #
+    # @return [Hash, nil]
+    # @raise [NotFoundError] if the pull request does not exist and 'error_if_missing' is true
+    #
+    def find_pull_request(base, head, error_if_missing = false)
+      logger.info { "Looking for a pull request asking for '#{head}' to be merged into '#{base}' on #{repo}." }
+
+      json = pull_requests
+      pr = json.find { |p| p[:head][:ref] == head and p[:base][:ref] == base }
+
+      raise NotFoundError.new(base, head, repo, json) if error_if_missing && pr.nil?
+
+      pr
+    end
+
+
+    def close(*args)
+      pull_number = if args.size == 2
+                      get_pull_request(args[0], args[1])[:number]
+                    elsif args.size == 1
+                      args[0]
+                    else
+                      raise ArgumentError.new('close(..) needs 1 or 2 arguments')
+                    end
+
+      logger.info { "Closing a pull request \##{pull_number} on #{repo}." }
+
+      send_close_req(pull_number, 1)
+    end
+
+
+    class NotFoundError < StandardError
+      attr_reader :base, :head, :repo
+
+
+      def initialize(base, head, repo, pull_requests_json)
+        @base = base
+        @head = head
+        @repo = repo
+
+        @pull_requests = pull_requests_json.map do |p|
+          {:head => p[:head][:ref], :base => p[:base][:ref]}
+        end
+
+        msg = "Could not find a pull request for '#{head}' to be merged with '#{base}' on #{repo}."
+        msg += "\n\nExisting Pull Requests:"
+        msg = pull_requests.inject(msg) { |a, v| "#{a}\n  #{v[:head]} -> #{v[:base]}" }
+
+        super(msg)
+      end
+
+
+      def pull_requests
+        @pull_requests
+      end
+
+    end
+
+
+    private
+
+
+    def send_close_req(pull_number, count)
+      begin
+        client.patch("repos/#{Octokit::Repository.new(repo)}/pulls/#{pull_number}", {:state => 'closed'})
+      rescue Octokit::UnprocessableEntity => exp
+        if count > MAX_RESEND
+          raise exp
+        end
+        logger.warn { "Retrying closing a pull request \##{pull_number} on #{repo} - try \##{count + 1}" }
+        send_close_req(pull_number, count + 1)
+      end
+    end
+
+  end
+
+end