git-process-lib 2.0.4 → 3.0.0

data/lib/git-process/git_logger.rb

@@ -33,8 +33,14 @@ module GitProc
       end
       @logger.level = log_level.nil? ? GitLogger::WARN : log_level
       @logger.datetime_format = '%Y-%m-%d %H:%M:%S'
-      @logger.formatter = proc do |_, _, _, msg|
-        "#{msg}\n"
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        if progname.nil?
+          m = "#{msg}\n"
+        else
+          m = "#{progname} => #{msg}\n"
+        end
+
+        @logger.debug? ? "[#{'%-5.5s' % severity}] #{datetime} - #{m}" : m
       end
     end
 
@@ -45,38 +51,27 @@ module GitProc
 
 
     def debug(msg = nil, &block)
-      if msg.nil?
-        @logger.debug(&block)
-      else
-        @logger.debug(msg)
-      end
+      @logger.debug(msg, &block)
     end
 
 
     def info(msg = nil, &block)
-      if msg.nil?
-        @logger.info(&block)
-      else
-        @logger.info(msg)
-      end
+      @logger.info(msg, &block)
     end
 
 
     def warn(msg = nil, &block)
-      if msg.nil?
-        @logger.send(:warn, &block)
-      else
-        @logger.send(:warn, msg)
-      end
+      @logger.warn(msg, &block)
     end
 
 
     def error(msg = nil, &block)
-      if msg.nil?
-        @logger.error(&block)
-      else
-        @logger.error(msg)
-      end
+      @logger.error(msg, &block)
+    end
+
+
+    def fatal(msg = nil, &block)
+      @logger.fatal(msg, &block)
     end
 
   end

data/lib/git-process/git_process.rb

@@ -107,13 +107,20 @@ module GitProc
     end
 
 
+    # noinspection RubyLocalVariableNamingConvention
     def should_remove_master?
-      my_branches = gitlib.branches()
-      gitlib.has_a_remote? and
-          my_branches.include?(config.master_branch) and
-          my_branches.current.name != config.master_branch and
-          !keep_local_integration_branch? and
-          my_branches[config.integration_branch].contains_all_of(config.master_branch)
+      has_a_remote = gitlib.has_a_remote?
+      my_branches = gitlib.branches
+      includes_master_branch = my_branches.include?(config.master_branch)
+      current_branch_is_not_master = my_branches.current.name != config.master_branch
+      do_not_keep_integration_branch = !keep_local_integration_branch?
+      integration_branch_contains_all_of_master = my_branches[config.integration_branch].contains_all_of(config.master_branch)
+
+      return (has_a_remote and
+          includes_master_branch and
+          current_branch_is_not_master and
+          do_not_keep_integration_branch and
+          integration_branch_contains_all_of_master)
     end
 
 

data/lib/git-process/git_remote.rb

@@ -12,9 +12,6 @@
 
 require 'git-process/git_config'
 require 'addressable/uri'
-#require 'git-process/git_branches'
-#require 'git-process/git_status'
-#require 'git-process/git_process_error'
 
 
 class String
@@ -61,7 +58,7 @@ module GitProc
 
 
     # @deprecated
-    # TODO: Remove
+    # @todo Remove
     def server_name
       @server_name ||= self.remote_name
     end
@@ -77,6 +74,13 @@ module GitProc
     end
 
 
+    #
+    # The name of the repository
+    #
+    # @example
+    #   repo_name #=> "jdigger/git-process"
+    #
+    # @return [String] the name of the repository
     def repo_name
       unless @repo_name
         url = config["remote.#{name}.url"]
@@ -88,7 +92,14 @@ module GitProc
     end
 
 
-    def name
+    #
+    # Returns the "remote name" to use. By convention the most common name is "origin".
+    #
+    # If the Git configuration "gitProcess.remoteName" is set, that will always be used. Otherwise this
+    # simple returns the first name it finds in the list of remotes.
+    #
+    # @return [String, nil] the remote name, or nil if there are none defined
+    def remote_name
       unless @remote_name
         @remote_name = config['gitProcess.remoteName']
         if @remote_name.nil? or @remote_name.empty?
@@ -97,7 +108,7 @@ module GitProc
             @remote_name = nil
           else
             @remote_name = remotes[0]
-            raise '!@remote_name.is_a? String' unless @remote_name.is_a? String
+            raise "remote name is not a String: #{@remote_name.inspect}" unless @remote_name.is_a? String
           end
         end
         logger.debug { "Using remote name of '#{@remote_name}'" }
@@ -106,11 +117,25 @@ module GitProc
     end
 
 
+    alias :name :remote_name
+
+
+    #
+    # Takes {#remote_name} and combines it with {GitConfig#master_branch}.
+    #
+    # @example
+    #   master_branch_name #=> origin/master
+    #
+    # @return [String] the complete remote name of the integration branch
+    #
     def master_branch_name
       "#{self.name}/#{config.master_branch}"
     end
 
 
+    alias :remote_integration_branch_name :master_branch_name
+
+
     def remote_names
       remote_str = config.gitlib.command(:remote, [:show])
       if remote_str.nil? or remote_str.empty?
@@ -136,6 +161,8 @@ module GitProc
     # @raise [URI::InvalidURIError] the retrieved URL does not have a schema
     # @raise [GitHubService::NoRemoteRepository] if could not figure out a host for the retrieved URL
     # @raise [::ArgumentError] if a server name is not provided
+    #
+    # @todo use the netrc gem
     def expanded_url(server_name = 'origin', raw_url = nil, opts = {})
       if raw_url.nil?
         raise ArgumentError.new('Need server_name') unless server_name
@@ -185,6 +212,7 @@ module GitProc
     alias :add :add_remote
 
 
+    # @todo use the netrc gem
     #noinspection RubyClassMethodNamingConvention
     def self.hostname_and_user_from_ssh_config(host_alias, config_file)
       if File.exists?(config_file)

data/lib/git-process/github_configuration.rb

@@ -10,31 +10,34 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'git-process/git_lib'
+require File.dirname(__FILE__) + '/git_lib'
+require File.dirname(__FILE__) + '/git_logger'
 require 'highline/import'
 require 'octokit'
+require 'octokit/default'
 require 'uri'
+require 'faraday'
+require 'faraday/response/logger'
 
 
-#
-# Provides methods related to GitHub configuration
-#
 module GitHubService
 
+  #
+  # Provides methods related to GitHub configuration
+  #
   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] :remote_name (Configuration#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
+    # @option opts [String] :password (Configuration#password) the password to authenticate with
     #
     # @return [String] the OAuth token
     #
+    # @todo pass in {GitLib} instead of {GitConfig}
+    #
     def initialize(git_config, opts = {})
       @git_config = git_config
       @user = opts[:user]
@@ -43,7 +46,15 @@ module GitHubService
     end
 
 
-    # @return [String]
+    # @return [GitProc::GitConfig]
+    def git_config
+      @git_config
+    end
+
+
+    # @return [String] the "remote name" (e.g., origin) for GitHub
+    #
+    # @see GitProc::GitRemote#remote_name
     def remote_name
       unless @remote_name
         @remote_name = gitlib.remote.name
@@ -53,21 +64,21 @@ module GitHubService
     end
 
 
-    # @return [String]
+    # @return [String] the user name for GitHub
     def user
       @user ||= Configuration.ask_for_user(gitlib)
     end
 
 
-    # @return [String]
+    # @return [String] the password for GitHub
     def password
       @password ||= Configuration.ask_for_password
     end
 
 
-    # @return [Octokit::Client]
+    # @return [Octokit::Client] the client for communicating with GitHub using {Configuration#user} and {Configuration#auth_token}
     def client
-      create_client
+      @client ||= create_client
     end
 
 
@@ -77,33 +88,26 @@ module GitHubService
     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
+    # @option opts [String] :base_url The base URL to use for the GitHub server; defaults to {#base_github_api_url_for_remote}
     #
     # @return [void]
     #
+    # @todo remove opts and pass in base_url directly
+    #
     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
+      if logger.level < ::GitProc::GitLogger::INFO
+        Octokit.middleware = Faraday::RackBuilder.new do |builder|
+          builder.response :logger, logger
+          builder.use Octokit::Response::RaiseError
+          builder.adapter Faraday.default_adapter
         end
       end
     end
@@ -124,7 +128,7 @@ module GitHubService
       if /github.com/ !~ base_url
         "#{base_url}/api/v3"
       else
-        Octokit::Configuration::DEFAULT_API_ENDPOINT
+        Octokit::Default::API_ENDPOINT
       end
     end
 
@@ -144,7 +148,7 @@ module GitHubService
       if /github.com/ !~ base_url
         base_url
       else
-        Octokit::Configuration::DEFAULT_WEB_ENDPOINT
+        Octokit::Default::WEB_ENDPOINT
       end
     end
 
@@ -167,17 +171,24 @@ module GitHubService
     # @param url [String] the URL to translate
     # @return [String] the base GitHub API URL
     #
+    # @example
+    #   url_to_base_github_api_url('git@github.com:jdigger/git-process.git') #=> 'https://api.github.com'
+    #
+    #   url_to_base_github_api_url('http://ghe.myco.com/jdigger/git-process.git') #=> 'http://ghe.myco.com'
+    #
+    # @todo use Octokit's improved ability to determine this
+    #
     def self.url_to_base_github_api_url(url)
       uri = URI.parse(url)
       host = uri.host
 
       if /github.com$/ =~ host
-        'https://api.github.com'
+        return 'https://api.github.com'
       else
         scheme = uri.scheme
         scheme = 'https' unless scheme.start_with?('http')
         host = 'unknown-host' unless host
-        "#{scheme}://#{host}"
+        return "#{scheme}://#{host}"
       end
     end
 
@@ -192,11 +203,14 @@ module GitHubService
     # @option opts [String] :user the username to authenticate with
     # @option opts [String] :password (#password) the password to authenticate with
     #
+    # @return [Octokit::Client] the Octokit client for communicating with GitHub
+    #
     def create_pw_client(opts = {})
       usr = opts[:user] || user()
       pw = opts[:password] || password()
+      remote = opts[:remote_name] || self.remote_name
 
-      logger.debug { "Creating GitHub client for user #{usr} using BasicAuth w/ password" }
+      logger.info("Authorizing #{usr} to work with #{remote}.")
 
       configure_octokit(opts)
 
@@ -224,34 +238,72 @@ module GitHubService
     #
     # 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] :remote_name (Configuration#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
+    # @option opts [String] :two_factor (#password) the password to authenticate with
     #
     # @return [String] the OAuth token
     #
+    # noinspection RubyStringKeysInHashInspection
     def create_authorization(opts = {})
-      username = opts[:user] || self.user
-      remote = opts[:remote_name] || self.remote_name
-      logger.info("Authorizing #{username} to work with #{remote}.")
+      client = opts[:client] || create_pw_client(opts)
+
+      return create_authorization_token(client, opts[:two_factor])
+    end
+
 
-      auth = create_pw_client(opts).create_authorization(
-          :scopes => %w(repo user gist),
-          :note => 'Git-Process',
-          :note_url => 'http://jdigger.github.com/git-process')
+    def create_authorization_token(client, two_factor)
+      begin
+        # noinspection RubyStringKeysInHashInspection
+        headers = two_factor ? {'X-GitHub-OTP' => two_factor} : nil
+        auth = client.create_authorization(
+            :scopes => %w(repo user gist),
+            :note => 'Git-Process',
+            :note_url => 'http://jdigger.github.com/git-process',
+            :headers => headers
+        )
+      rescue Octokit::OneTimePasswordRequired
+        return create_2f_authorization(client)
+      rescue Octokit::UnprocessableEntity => exp
+        return unprocessable_authorization(exp)
+      end
 
-      config_auth_token = auth['token']
+      config_auth_token = auth[:token]
 
       # remember it for next time
       gitlib.config['gitProcess.github.authToken'] = config_auth_token
 
-      config_auth_token
+      return config_auth_token
     end
 
 
-    # @return [String]
+    #
+    # Connects to GitHub to get an OAuth token.
+    #
+    # @option opts [String] :base_url The base URL to use for the GitHub server
+    # @option opts [String] :remote_name (Configuration#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
+    # @option opts [String] :two_factor (#password) the password to authenticate with
+    #
+    # @return [String] the OAuth token
+    #
+    # noinspection RubyStringKeysInHashInspection
+    def create_2f_authorization(client)
+      two_factor = Configuration.ask_for_two_factor
+
+      create_authorization_token(client, two_factor)
+    end
+
+
+    def two_factor_auth(authorization_count, opts)
+      return create_authorization(opts.merge(:two_factor => two_factor, :authorization_count => authorization_count + 1))
+    end
+
+
+    # @return [String, nil] the OAuth token, or nil if not found
     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
@@ -266,6 +318,24 @@ module GitHubService
     private
 
 
+    #
+    # Create a client for communicating with GitHub using {Configuration#user} and {Configuration#auth_token}
+    #
+    # @return [Octokit::Client]
+    #
+    # @todo have the params passed in explicitly instead of via opts
+    #
+    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(:access_token => auth_token)
+    end
+
+
     def self.ask_for_user(gitlib)
       user = gitlib.config['github.user']
       if user.nil? or user.empty?
@@ -285,6 +355,42 @@ module GitHubService
       end
     end
 
+
+    def self.ask_for_two_factor
+      ask("Your <%= color('GitHub', [:bold, :blue]) %> two-factor code: ") do |q|
+        q.validate = /^\w\w+$/
+      end
+    end
+
+
+    # @todo implement https://github.com/jdigger/git-process/issues/142
+    def ask_about_resetting_authorization
+      raise TokenAlreadyExists.new("The token already exists. Please check your OAuth settings for your account.")
+    end
+
+
+    #
+    # Tries to more gracefully handle the token already existing. See
+    #
+    # @return [String] the OAuth token
+    #
+    # @raise [TokenAlreadyExists] the token already exists
+    # @raise [Octokit::UnprocessableEntity] there was another problem
+    def unprocessable_authorization(exp)
+      errors = exp.errors
+      if not (errors.nil? or errors.empty?)
+        error_hash = errors[0]
+        if error_hash[:resource] == 'OauthAccess'
+          # error_hash[:code]
+          return ask_about_resetting_authorization
+        else
+          raise exp
+        end
+      else
+        raise exp
+      end
+    end
+
   end
 
 
@@ -295,4 +401,7 @@ module GitHubService
   class NoRemoteRepository < Error
   end
 
+  class TokenAlreadyExists < Error
+  end
+
 end