lib/octokit/enterprise_management_console_client/management_console.rb



# frozen_string_literal: true

module Octokit
  class EnterpriseManagementConsoleClient
    # Methods for the Enterprise Management Console API
    #
    # @see https://developer.github.com/v3/enterprise-admin/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 https://docs.github.com/en/enterprise-server@3.4/rest/enterprise-admin/management-console#create-a-github-license
      # @return nil
      def upload_license(license, settings = nil)
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        conn = faraday_configuration

        params = {}
        params[:license] = Faraday::UploadIO.new(license, 'binary')
        params[:password] = @management_console_password
        params[:settings] = settings.to_json.to_s unless settings.nil?

        @last_response = conn.post('/setup/api/start', params)
      end

      # Start a configuration process.
      #
      # @return nil
      def start_configuration
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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)
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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)
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        queries = password_hash
        queries[:query][:settings] = settings.to_json.to_s
        put '/setup/api/settings', queries
      end

      # Get information about the Enterprise maintenance status
      #
      # @return [Sawyer::Resource] The maintenance status
      def maintenance_status
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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)
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        queries = password_hash
        queries[:query][:maintenance] = maintenance.to_json.to_s
        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
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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)
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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)
        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.')
        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: https://github.com/lostisland/sawyer/blob/03fca4c020f465ec42856d0486ec3991859b0aed/lib/sawyer/agent.rb#L85
    def faraday_configuration
      @faraday_configuration ||= Faraday.new(url: @management_console_endpoint) do |http|
        http.headers[:user_agent] = user_agent
        begin
          http.request :multipart
        rescue Faraday::Error
          raise Faraday::Error, <<~ERROR
            The `faraday-multipart` gem is required to upload a license.
            Please add `gem "faraday-multipart"` to your Gemfile.
          ERROR
        end
        http.request :url_encoded

        # Disabling SSL is essential for certain self-hosted Enterprise instances
        if connection_options[:ssl] && !connection_options[:ssl][:verify]
          http.ssl[:verify] = false
        end

        http.use Octokit::Response::RaiseError
        http.adapter Faraday.default_adapter
      end
    end
  end
end