octodoggy 4.6.2

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -0,0 +1,176 @@
+module Octokit
+  class EnterpriseManagementConsoleClient
+
+    # Methods for the Enterprise Management Console API
+    #
+    # @see https://developer.github.com/v3/enterprise/management_console
+    module ManagementConsole
+
+      # Uploads a license for the first time
+      #
+      # @param license [String] The path to your .ghl license file.
+      # @param settings [Hash] A hash configuration of the initial settings.
+      #
+      # @see http: //git.io/j5NT
+      # @return nil
+      def upload_license(license, settings = nil)
+        conn = faraday_configuration
+
+        params = { }
+        params[:license] = Faraday::UploadIO.new(license, 'binary')
+        params[:password] = @management_console_password
+        params[:settings] = "#{settings.to_json}" unless settings.nil?
+
+        @last_response = conn.post("/setup/api/start", params)
+      end
+
+      # Start a configuration process.
+      #
+      # @return nil
+      def start_configuration
+        post "/setup/api/configure", password_hash
+      end
+
+      # Upgrade an Enterprise installation
+      #
+      # @param license [String] The path to your .ghl license file.
+      #
+      # @return nil
+      def upgrade(license)
+        conn = faraday_configuration
+
+        params = { }
+        params[:license] = Faraday::UploadIO.new(license, 'binary')
+        params[:api_key] = @management_console_password
+        @last_response = conn.post("/setup/api/upgrade", params)
+      end
+
+      # Get information about the Enterprise installation
+      #
+      # @return [Sawyer::Resource] The installation information
+      def config_status
+        get "/setup/api/configcheck", password_hash
+      end
+      alias :config_check :config_status
+
+      # Get information about the Enterprise installation
+      #
+      # @return [Sawyer::Resource] The settings
+      def settings
+        get "/setup/api/settings", password_hash
+      end
+      alias :get_settings :settings
+
+      # Modify the Enterprise settings
+      #
+      # @param settings [Hash] A hash configuration of the new settings
+      #
+      # @return [nil]
+      def edit_settings(settings)
+        queries = password_hash
+        queries[:query][:settings] = "#{settings.to_json}"
+        put "/setup/api/settings", queries
+      end
+
+      # Get information about the Enterprise maintenance status
+      #
+      # @return [Sawyer::Resource] The maintenance status
+      def maintenance_status
+        get "/setup/api/maintenance", password_hash
+      end
+      alias :get_maintenance_status :maintenance_status
+
+      # Start (or turn off) the Enterprise maintenance mode
+      #
+      # @param maintenance [Hash] A hash configuration of the maintenance settings
+      # @return [nil]
+      def set_maintenance_status(maintenance)
+        queries = password_hash
+        queries[:query][:maintenance] = "#{maintenance.to_json}"
+        post "/setup/api/maintenance", queries
+      end
+      alias :edit_maintenance_status :set_maintenance_status
+
+      # Fetch the authorized SSH keys on the Enterprise install
+      #
+      # @return [Sawyer::Resource] An array of authorized SSH keys
+      def authorized_keys
+        get "/setup/api/settings/authorized-keys", password_hash
+      end
+      alias :get_authorized_keys :authorized_keys
+
+      # Add an authorized SSH keys on the Enterprise install
+      #
+      # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself
+      # @return [Sawyer::Resource] An array of authorized SSH keys
+      def add_authorized_key(key)
+        queries = password_hash
+        case key
+        when String
+          if File.exist?(key)
+            key = File.open(key, "r")
+            content = key.read.strip
+            key.close
+          else
+            content = key
+          end
+        when File
+          content = key.read.strip
+          key.close
+        end
+
+        queries[:query][:authorized_key] = content
+        post "/setup/api/settings/authorized-keys", queries
+      end
+
+      # Removes an authorized SSH keys from the Enterprise install
+      #
+      # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself
+      # @return [Sawyer::Resource] An array of authorized SSH keys
+      def remove_authorized_key(key)
+        queries = password_hash
+        case key
+        when String
+          if File.exist?(key)
+            key = File.open(key, "r")
+            content = key.read.strip
+            key.close
+          else
+            content = key
+          end
+        when File
+          content = key.read.strip
+          key.close
+        end
+
+        queries[:query][:authorized_key] = content
+        delete "/setup/api/settings/authorized-keys", queries
+      end
+      alias :delete_authorized_key :remove_authorized_key
+
+    end
+    private
+
+    def password_hash
+      { :query => { :api_key => @management_console_password } }
+    end
+
+    # We fall back to raw Faraday for handling the licenses because I'm suspicious
+    # that Sawyer isn't handling binary POSTs correctly: http://git.io/jMir
+    def faraday_configuration
+      @faraday_configuration ||= Faraday.new(:url => @management_console_endpoint) do |http|
+        http.headers[:user_agent] = user_agent
+        http.request :multipart
+        http.request :url_encoded
+
+        # Disabling SSL is essential for certain self-hosted Enterprise instances
+        if self.connection_options[:ssl] && !self.connection_options[:ssl][:verify]
+          http.ssl[:verify] = false
+        end
+
+        http.use Octokit::Response::RaiseError
+        http.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/octokit/error.rb

@@ -0,0 +1,286 @@
+module Octokit
+  # Custom error class for rescuing from all GitHub errors
+  class Error < StandardError
+
+    # Returns the appropriate Octokit::Error subclass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [Octokit::Error]
+    def self.from_response(response)
+      status  = response[:status].to_i
+      body    = response[:body].to_s
+      headers = response[:response_headers]
+
+      if klass =  case status
+                  when 400      then Octokit::BadRequest
+                  when 401      then error_for_401(headers)
+                  when 403      then error_for_403(body)
+                  when 404      then error_for_404(body)
+                  when 405      then Octokit::MethodNotAllowed
+                  when 406      then Octokit::NotAcceptable
+                  when 409      then Octokit::Conflict
+                  when 415      then Octokit::UnsupportedMediaType
+                  when 422      then Octokit::UnprocessableEntity
+                  when 451      then Octokit::UnavailableForLegalReasons
+                  when 400..499 then Octokit::ClientError
+                  when 500      then Octokit::InternalServerError
+                  when 501      then Octokit::NotImplemented
+                  when 502      then Octokit::BadGateway
+                  when 503      then Octokit::ServiceUnavailable
+                  when 500..599 then Octokit::ServerError
+                  end
+        klass.new(response)
+      end
+    end
+
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    # Documentation URL returned by the API for some errors
+    #
+    # @return [String]
+    def documentation_url
+      data[:documentation_url] if data.is_a? Hash
+    end
+
+    # Returns most appropriate error for 401 HTTP status code
+    # @private
+    def self.error_for_401(headers)
+      if Octokit::OneTimePasswordRequired.required_header(headers)
+        Octokit::OneTimePasswordRequired
+      else
+        Octokit::Unauthorized
+      end
+    end
+
+    # Returns most appropriate error for 403 HTTP status code
+    # @private
+    def self.error_for_403(body)
+      if body =~ /rate limit exceeded/i
+        Octokit::TooManyRequests
+      elsif body =~ /login attempts exceeded/i
+        Octokit::TooManyLoginAttempts
+      elsif body =~ /abuse/i
+        Octokit::AbuseDetected
+      elsif body =~ /repository access blocked/i
+        Octokit::RepositoryUnavailable
+      elsif body =~ /email address must be verified/i
+        Octokit::UnverifiedEmail
+      elsif body =~ /account was suspended/i
+        Octokit::AccountSuspended
+      else
+        Octokit::Forbidden
+      end
+    end
+
+    # Return most appropriate error for 404 HTTP status code
+    # @private
+    def self.error_for_404(body)
+      if body =~ /Branch not protected/i
+        Octokit::BranchNotProtected
+      else
+        Octokit::NotFound
+      end
+    end
+
+    # Array of validation errors
+    # @return [Array<Hash>] Error info
+    def errors
+      if data && data.is_a?(Hash)
+        data[:errors] || []
+      else
+        []
+      end
+    end
+
+    # Status code returned by the GitHub server.
+    #
+    # @return [Integer]
+    def response_status
+      @response[:status]
+    end
+
+    private
+
+    def data
+      @data ||=
+        if (body = @response[:body]) && !body.empty?
+          if body.is_a?(String) &&
+            @response[:response_headers] &&
+            @response[:response_headers][:content_type] =~ /json/
+
+            Sawyer::Agent.serializer.decode(body)
+          else
+            body
+          end
+        else
+          nil
+        end
+    end
+
+    def response_message
+      case data
+      when Hash
+        data[:message]
+      when String
+        data
+      end
+    end
+
+    def response_error
+      "Error: #{data[:error]}" if data.is_a?(Hash) && data[:error]
+    end
+
+    def response_error_summary
+      return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
+
+      summary = "\nError summary:\n"
+      summary << data[:errors].map do |error|
+        if error.is_a? Hash
+          error.map { |k,v| "  #{k}: #{v}" }
+        else
+          "  #{error}"
+        end
+      end.join("\n")
+
+      summary
+    end
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message =  "#{@response[:method].to_s.upcase} "
+      message << redact_url(@response[:url].to_s) + ": "
+      message << "#{@response[:status]} - "
+      message << "#{response_message}" unless response_message.nil?
+      message << "#{response_error}" unless response_error.nil?
+      message << "#{response_error_summary}" unless response_error_summary.nil?
+      message << " // See: #{documentation_url}" unless documentation_url.nil?
+      message
+    end
+
+    def redact_url(url_string)
+      %w[client_secret access_token].each do |token|
+        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
+      end
+      url_string
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when GitHub returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when GitHub returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when GitHub returns a 401 HTTP status code
+  # and headers include "X-GitHub-OTP"
+  class OneTimePasswordRequired < ClientError
+    #@private
+    OTP_DELIVERY_PATTERN = /required; (\w+)/i
+
+    #@private
+    def self.required_header(headers)
+      OTP_DELIVERY_PATTERN.match headers['X-GitHub-OTP'].to_s
+    end
+
+    # Delivery method for the user's OTP
+    #
+    # @return [String]
+    def password_delivery
+      @password_delivery ||= delivery_method_from_header
+    end
+
+    private
+
+    def delivery_method_from_header
+      if match = self.class.required_header(@response[:response_headers])
+        match[1]
+      end
+    end
+  end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'rate limit exceeded'
+  class TooManyRequests < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'login attempts exceeded'
+  class TooManyLoginAttempts < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'abuse'
+  class AbuseDetected < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'repository access blocked'
+  class RepositoryUnavailable < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'email address must be verified'
+  class UnverifiedEmail < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'account was suspended'
+  class AccountSuspended < Forbidden; end
+
+  # Raised when GitHub returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when GitHub returns a 404 HTTP status code
+  # and body matches 'Branch not protected'
+  class BranchNotProtected < ClientError; end
+
+  # Raised when GitHub returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when GitHub returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when GitHub returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when GitHub returns a 414 HTTP status code
+  class UnsupportedMediaType < ClientError; end
+
+  # Raised when GitHub returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised when GitHub returns a 451 HTTP status code
+  class UnavailableForLegalReasons < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when GitHub returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when GitHub returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when GitHub returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when GitHub returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+
+  # Raised when client fails to provide valid Content-Type
+  class MissingContentType < ArgumentError; end
+
+  # Raised when a method requires an application client_id
+  # and secret but none is provided
+  class ApplicationCredentialsRequired < StandardError; end
+
+  # Raised when a repository is created with an invalid format
+  class InvalidRepository < ArgumentError; end
+
+end