octokit 4.2.0 → 9.2.0

data/lib/octokit/enterprise_admin_client/users.rb

@@ -1,28 +1,29 @@
+# frozen_string_literal: true
+
 module Octokit
   class EnterpriseAdminClient
-
     # Methods for the Enterprise User Administration API
     #
-    # @see https://developer.github.com/v3/users/administration/
+    # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/
     module Users
       # Create a new user.
       #
       # @param login [String] The user's username.
       # @param email [String] The user's email address.
-      # @see https://developer.github.com/v3/users/administration/#create-a-new-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users#create-a-new-user
       # @example
       #   @admin_client.create_user('foobar', 'notreal@foo.bar')
       def create_user(login, email, options = {})
         options[:login] = login
         options[:email] = email
-        post "admin/users", options
+        post 'admin/users', options
       end
 
       # Promote an ordinary user to a site administrator
       #
       # @param user [String] Username of the user to promote.
       # @return [Boolean] True if promote was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#promote-an-ordinary-user-to-a-site-administrator
       # @example
       #   @admin_client.promote('holman')
       def promote(user, options = {})
@@ -33,7 +34,7 @@ module Octokit
       #
       # @param user [String] Username of the user to demote.
       # @return [Boolean] True if demote was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#demote-a-site-administrator-to-an-ordinary-user
       # @example
       #   @admin_client.demote('holman')
       def demote(user, options = {})
@@ -44,7 +45,7 @@ module Octokit
       #
       # @param old_login [String] The user's old username.
       # @param new_login [String] The user's new username.
-      # @see https://developer.github.com/v3/users/administration/#rename-an-existing-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#rename-an-existing-user
       # @example
       #   @admin_client.rename_user('foobar', 'foofoobar')
       def rename_user(old_login, new_login, options = {})
@@ -55,18 +56,18 @@ module Octokit
       # Deletes a user.
       #
       # @param username [String] The username to delete.
-      # @see https://developer.github.com/v3/users/administration/#delete-a-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-user
       # @example
       #   @admin_client.delete_key(1)
-      def delete_user(id, options = {})
-        boolean_from_response :delete,  "admin/users/#{id}", options
+      def delete_user(username, options = {})
+        boolean_from_response :delete,  "admin/users/#{username}", options
       end
 
       # Suspend a user.
       #
       # @param user [String] Username of the user to suspend.
       # @return [Boolean] True if suspend was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#suspend-a-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#suspend-a-user
       # @example
       #   @admin_client.suspend('holman')
       def suspend(user, options = {})
@@ -77,7 +78,7 @@ module Octokit
       #
       # @param user [String] Username of the user to unsuspend.
       # @return [Boolean] True if unsuspend was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#unsuspend-a-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#unsuspend-a-user
       # @example
       #   @admin_client.unsuspend('holman')
       def unsuspend(user, options = {})
@@ -88,7 +89,7 @@ module Octokit
       #
       # @param login [String] The user to create a token for.
       # @param options [Array<String>] :scopes The scopes to apply.
-      # @see https://developer.github.com/v3/users/administration/#create-an-impersonation-oauth-token
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token
       # @example
       #   @admin_client.create_impersonation_token('foobar', {:scopes => ['repo:write']})
       def create_impersonation_token(login, options = {})
@@ -98,7 +99,7 @@ module Octokit
       # Deletes an impersonation OAuth token.
       #
       # @param login [String] The user whose token should be deleted.
-      # @see https://developer.github.com/v3/users/administration/#delete-an-impersonation-oauth-token
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token
       # @example
       #   @admin_client.delete_impersonation_token('foobar')
       def delete_impersonation_token(login, options = {})
@@ -107,21 +108,21 @@ module Octokit
 
       # Lists all the public SSH keys.
       #
-      # @see https://developer.github.com/v3/users/administration/#list-all-public-keys
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#list-all-public-keys
       # @example
       #   @admin_client.list_all_keys
       def list_all_keys(options = {})
-        get "admin/keys", options
+        get 'admin/keys', options
       end
 
       # Deletes a public SSH keys.
       #
       # @param id [Number] The ID of the key to delete.
-      # @see https://developer.github.com/v3/users/administration/#delete-a-public-key
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-public-key
       # @example
       #   @admin_client.delete_key(1)
       def delete_key(id, options = {})
-        boolean_from_response :delete,  "admin/keys/#{id}", options
+        boolean_from_response :delete, "admin/keys/#{id}", options
       end
     end
   end

data/lib/octokit/enterprise_admin_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'octokit/connection'
 require 'octokit/configurable'
 require 'octokit/warnable'
@@ -8,7 +10,6 @@ require 'octokit/enterprise_admin_client/search_indexing'
 require 'octokit/enterprise_admin_client/users'
 
 module Octokit
-
   # EnterpriseAdminClient is only meant to be used by GitHub Enterprise Admins
   # and provides access the Admin only API endpoints including Admin Stats,
   # Management Console, and the Search Indexing API.
@@ -17,7 +18,6 @@ module Octokit
   #   and GitHub Enterprise.
   # @see https://developer.github.com/v3/enterprise/
   class EnterpriseAdminClient
-
     include Octokit::Configurable
     include Octokit::Connection
     include Octokit::Warnable
@@ -29,10 +29,18 @@ module Octokit
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
+      #
+      # rubocop:disable Style/HashEachMethods
+      #
+      # This may look like a `.keys.each` which should be replaced with `#each_key`, but
+      # this doesn't actually work, since `#keys` is just a method we've defined ourselves.
+      # The class doesn't fulfill the whole `Enumerable` contract.
       Octokit::Configurable.keys.each do |key|
+        # rubocop:enable Style/HashEachMethods
         instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
       end
-    end
 
+      login_from_netrc unless user_authenticated? || application_authenticated?
+    end
   end
 end

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -1,34 +1,36 @@
+# frozen_string_literal: true
+
 module Octokit
   class EnterpriseManagementConsoleClient
-
     # Methods for the Enterprise Management Console API
     #
-    # @see https://developer.github.com/v3/enterprise/management_console
+    # @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 http: //git.io/j5NT
+      # @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 = {}
         params[:license] = Faraday::UploadIO.new(license, 'binary')
         params[:password] = @management_console_password
-        params[:settings] = "#{settings.to_json}" unless settings.nil?
+        params[:settings] = settings.to_json.to_s unless settings.nil?
 
-        @last_response = conn.post("/setup/api/start", params)
+        @last_response = conn.post('/setup/api/start', params)
       end
 
       # Start a configuration process.
       #
       # @return nil
       def start_configuration
-        post "/setup/api/configure", password_hash
+        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
@@ -37,29 +39,32 @@ module Octokit
       #
       # @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 = {}
         params[:license] = Faraday::UploadIO.new(license, 'binary')
         params[:api_key] = @management_console_password
-        @last_response = conn.post("/setup/api/upgrade", params)
+        @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
+        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
+      alias config_check config_status
 
       # Get information about the Enterprise installation
       #
       # @return [Sawyer::Resource] The settings
       def settings
-        get "/setup/api/settings", password_hash
+        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
+      alias get_settings settings
 
       # Modify the Enterprise settings
       #
@@ -67,48 +72,53 @@ module Octokit
       #
       # @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}"
-        put "/setup/api/settings", queries
+        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
-        get "/setup/api/maintenance", password_hash
+        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
+      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}"
-        post "/setup/api/maintenance", queries
+        queries[:query][:maintenance] = maintenance.to_json.to_s
+        post '/setup/api/maintenance', queries
       end
-      alias :edit_maintenance_status :set_maintenance_status
+      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
+        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
+      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")
+            key = File.open(key, 'r')
             content = key.read.strip
             key.close
           else
@@ -120,7 +130,7 @@ module Octokit
         end
 
         queries[:query][:authorized_key] = content
-        post "/setup/api/settings/authorized-keys", queries
+        post '/setup/api/settings/authorized-keys', queries
       end
 
       # Removes an authorized SSH keys from the Enterprise install
@@ -128,11 +138,12 @@ module Octokit
       # @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")
+            key = File.open(key, 'r')
             content = key.read.strip
             key.close
           else
@@ -144,27 +155,34 @@ module Octokit
         end
 
         queries[:query][:authorized_key] = content
-        delete "/setup/api/settings/authorized-keys", queries
+        delete '/setup/api/settings/authorized-keys', queries
       end
-      alias :delete_authorized_key :remove_authorized_key
-
+      alias delete_authorized_key remove_authorized_key
     end
+
     private
 
     def password_hash
-      { :query => { :api_key => @management_console_password } }
+      { 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
+    # 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|
+      @faraday_configuration ||= Faraday.new(url: @management_console_endpoint) do |http|
         http.headers[:user_agent] = user_agent
-        http.request :multipart
+        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 self.connection_options[:ssl] && !self.connection_options[:ssl][:verify]
+        if connection_options[:ssl] && !connection_options[:ssl][:verify]
           http.ssl[:verify] = false
         end
 

data/lib/octokit/enterprise_management_console_client.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 require 'octokit/configurable'
 require 'octokit/connection'
 require 'octokit/warnable'
 require 'octokit/enterprise_management_console_client/management_console'
 
 module Octokit
-
   # EnterpriseManagementConsoleClient is only meant to be used by GitHub Enterprise Admins
   # and provides access to the management console API endpoints.
   #
   # @see Octokit::Client Use Octokit::Client for regular API use for GitHub
   #   and GitHub Enterprise.
-  # @see https://developer.github.com/v3/enterprise/management_console/
+  # @see https://developer.github.com/v3/enterprise-admin/management_console/
   class EnterpriseManagementConsoleClient
-
     include Octokit::Configurable
     include Octokit::Connection
     include Octokit::Warnable
@@ -20,7 +20,13 @@ module Octokit
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
+      # rubocop:disable Style/HashEachMethods
+      #
+      # This may look like a `.keys.each` which should be replaced with `#each_key`, but
+      # this doesn't actually work, since `#keys` is just a method we've defined ourselves.
+      # The class doesn't fulfill the whole `Enumerable` contract.
       Octokit::Configurable.keys.each do |key|
+        # rubocop:enable Style/HashEachMethods
         instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
       end
     end