octokit 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9f2dca26c45a1b912572448c2fe16e78f37b7bb5fc7dc885488847c6eb19315
-  data.tar.gz: 11a332c8d3ad5f92ac0ed01ccd03e6a699f852d31946e6e4acc43e75ea3b2d00
+  metadata.gz: ff098c16b9a72f52713782145e415ca2658ae2f7f48bd1c64f908507f26eb4cc
+  data.tar.gz: 06610fe737e7bf1c9b56447828fd5c5ab19e343832b34573f4ad0c02eec41c62
 SHA512:
-  metadata.gz: 4790f888c01d7094b822ba72fc1ac576efa0803c6433982b53373787649b9b398842ee2986e43af6000677cda62a81e9072936b1d46c516a441a8256de10a1ae
-  data.tar.gz: 135c6ab374669d1db0fd18172670f79856adb627ef3e8cf015e0af93dacedf110f6f022df2be04907fdf11d4db68d7c382569e56f792d4c5eac2db7f65f8bbec
+  metadata.gz: f236b59523559b762dd8c58718d0ff58d8181877740b7c2c5e10851f7be8f490e959bbf4f0b457e641c1931b562a6f5a4aa4f6d0f2b56bb63251a7cc3691faa1
+  data.tar.gz: f7b50ad0662923a499628fd914ba6aa36df8370c1e111d3fd16582f027eeef358fa8f25502376fac9e744848dbf55e5ddc781a5a5ca1ae7638cf4acbb6545b9e

data/README.md

@@ -81,7 +81,7 @@ Install via Rubygems
 
 ... or add to your Gemfile
 
-    gem "octokit", "~> 5.0"
+    gem "octokit"
 
 Access the library in Ruby:
 
@@ -709,6 +709,9 @@ Octokit:
 | `OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD` | GitHub Enterprise management console password.                                                                                                                                                    |
 | `OCTOKIT_TEST_GITHUB_ENTERPRISE_ENDPOINT`                    | GitHub Enterprise hostname.                                                                                                                                                                       |
 | `OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT` | GitHub Enterprise Management Console endpoint.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_ENDPOINT`                          | GitHub Enterprise Server GHES Manage Endpoint.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_USERNAME`                          | GitHub Enterprise Server GHES Manage Username.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_PASSWORD`                          | GitHub Enterprise Server GHES Manage Password.                                                                                                                                                    |
 | `OCTOKIT_TEST_GITHUB_INTEGRATION`                            | [GitHub Integration](https://developer.github.com/early-access/integrations/) owned by your test organization.                                                                                    |
 | `OCTOKIT_TEST_GITHUB_INTEGRATION_INSTALLATION`               | Installation of the GitHub Integration specified above.                                                                                                                                           |
 | `OCTOKIT_TEST_INTEGRATION_PEM_KEY`                           | File path to the private key generated from your integration.                                                                                                                                     |
@@ -738,6 +741,7 @@ implementations:
 * Ruby 3.0
 * Ruby 3.1
 * Ruby 3.2
+* Ruby 3.3
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 

data/lib/octokit/arguments.rb

@@ -8,7 +8,7 @@ module Octokit
 
     def initialize(args)
       @options = args.last.is_a?(::Hash) ? args.pop : {}
-      super(args)
+      super
     end
   end
 end

data/lib/octokit/client/actions_secrets.rb

@@ -15,6 +15,15 @@ module Octokit
         get "#{Repository.path repo}/actions/secrets/public-key"
       end
 
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://developer.github.com/v3/actions/secrets/#get-your-public-key
+      def get_org_actions_public_key(org)
+        get "#{Organization.path org}/actions/secrets/public-key"
+      end
+
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -26,6 +35,17 @@ module Octokit
         end
       end
 
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://developer.github.com/v3/actions/secrets/#list-organization-secrets
+      def list_org_actions_secrets(org)
+        paginate "#{Organization.path org}/actions/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
       # Get a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -36,6 +56,16 @@ module Octokit
         get "#{Repository.path repo}/actions/secrets/#{name}"
       end
 
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at and updated_at
+      # @see https://developer.github.com/v3/actions/secrets/#get-a-secret
+      def get_org_actions_secret(org, name)
+        get "#{Organization.path org}/actions/secrets/#{name}"
+      end
+
       # Create or update secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -46,6 +76,16 @@ module Octokit
         put "#{Repository.path repo}/actions/secrets/#{name}", options
       end
 
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret
+      def create_or_update_org_actions_secret(org, name, options)
+        put "#{Organization.path org}/actions/secrets/#{name}", options
+      end
+
       # Delete a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -55,6 +95,15 @@ module Octokit
         boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
       end
 
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret
+      def delete_org_actions_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/actions/secrets/#{name}"
+      end
+
       # Get environment public key for secrets encryption
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

data/lib/octokit/client/apps.rb

@@ -231,6 +231,18 @@ module Octokit
         end
       end
 
+      # Returns a delivery for the webhook configured for a GitHub App.
+      #
+      # @param delivery_id [String] The id of a GitHub App Hook Delivery
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://docs.github.com/en/rest/apps/webhooks#get-a-delivery-for-an-app-webhook
+      #
+      # @return [<Sawyer::Resource>] The webhook delivery
+      def app_hook_delivery(delivery_id, options = {})
+        get "/app/hook/deliveries/#{delivery_id}", options
+      end
+
       # Redeliver a delivery for the webhook configured for a GitHub App.
       #
       # @param delivery_id [Integer] The id of a GitHub App Hook Delivery

data/lib/octokit/client/code_scanning.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'base64'
 require 'tempfile'
 require 'zlib'
 
@@ -45,7 +44,7 @@ module Octokit
           Zlib::GzipWriter.open(tempfile) do |gz_file|
             gz_file.write File.binread(file)
           end
-          Base64.strict_encode64(tempfile.read)
+          [tempfile.read].pack('m0') # Base64.strict_encode64
         end
       end
     end

data/lib/octokit/client/codespaces_secrets.rb

@@ -15,6 +15,15 @@ module Octokit
         get "#{Repository.path repo}/codespaces/secrets/public-key"
       end
 
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key
+      def get_org_codespaces_public_key(org)
+        get "#{Organization.path org}/codespaces/secrets/public-key"
+      end
+
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -26,6 +35,17 @@ module Octokit
         end
       end
 
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#list-organization-secrets
+      def list_org_codespaces_secrets(org)
+        paginate "#{Organization.path org}/codespaces/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
       # Get a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -36,6 +56,16 @@ module Octokit
         get "#{Repository.path repo}/codespaces/secrets/#{name}"
       end
 
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret
+      def get_org_codespaces_secret(org, name)
+        get "#{Organization.path org}/codespaces/secrets/#{name}"
+      end
+
       # Create or update secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -46,6 +76,16 @@ module Octokit
         put "#{Repository.path repo}/codespaces/secrets/#{name}", options
       end
 
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret
+      def create_or_update_org_codespaces_secret(org, name, options)
+        put "#{Organization.path org}/codespaces/secrets/#{name}", options
+      end
+
       # Delete a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -54,6 +94,15 @@ module Octokit
       def delete_codespaces_secret(repo, name)
         boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
       end
+
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret
+      def delete_org_codespaces_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/codespaces/secrets/#{name}"
+      end
     end
   end
 end

data/lib/octokit/client/contents.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'base64'
-
 module Octokit
   class Client
     # Methods for the Repo Contents API
@@ -80,7 +78,7 @@ module Octokit
         end
         raise ArgumentError, 'content or :file option required' if content.nil?
 
-        options[:content] = Base64.strict_encode64(content)
+        options[:content] = [content].pack('m0') # Base64.strict_encode64
         options[:message] = message
         url = "#{Repository.path repo}/contents/#{path}"
         put url, options

data/lib/octokit/client/dependabot_secrets.rb

@@ -15,6 +15,15 @@ module Octokit
         get "#{Repository.path repo}/dependabot/secrets/public-key"
       end
 
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key
+      def get_org_dependabot_public_key(org)
+        get "#{Organization.path org}/dependabot/secrets/public-key"
+      end
+
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -26,6 +35,17 @@ module Octokit
         end
       end
 
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#list-organization-secrets
+      def list_org_dependabot_secrets(org)
+        paginate "#{Organization.path org}/dependabot/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
       # Get a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -36,6 +56,16 @@ module Octokit
         get "#{Repository.path repo}/dependabot/secrets/#{name}"
       end
 
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret
+      def get_org_dependabot_secret(org, name)
+        get "#{Organization.path org}/dependabot/secrets/#{name}"
+      end
+
       # Create or update secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -46,6 +76,16 @@ module Octokit
         put "#{Repository.path repo}/dependabot/secrets/#{name}", options
       end
 
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret
+      def create_or_update_org_dependabot_secret(org, name, options)
+        put "#{Organization.path org}/dependabot/secrets/#{name}", options
+      end
+
       # Delete a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -54,6 +94,15 @@ module Octokit
       def delete_dependabot_secret(repo, name)
         boolean_from_response :delete, "#{Repository.path repo}/dependabot/secrets/#{name}"
       end
+
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret
+      def delete_org_dependabot_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/dependabot/secrets/#{name}"
+      end
     end
   end
 end

data/lib/octokit/client/deployments.rb

@@ -22,7 +22,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of deployments
       # @see https://developer.github.com/v3/repos/deployments/#list-deployments
       def deployments(repo, options = {})
-        get("#{Repository.path repo}/deployments", options)
+        paginate("#{Repository.path repo}/deployments", options)
       end
       alias list_deployments deployments
 
@@ -60,7 +60,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
       def deployment_statuses(deployment_url, options = {})
         deployment = get(deployment_url, accept: options[:accept])
-        get(deployment.rels[:statuses].href, options)
+        paginate(deployment.rels[:statuses].href, options)
       end
       alias list_deployment_statuses deployment_statuses
 

data/lib/octokit/client/environments.rb

@@ -24,7 +24,10 @@ module Octokit
       # @return [Sawyer::Resource] Total count of environments and list of environments
       # @see https://docs.github.com/en/rest/deployments/environments#list-environments
       def environments(repo, options = {})
-        get("#{Repository.path repo}/environments", options)
+        paginate("#{Repository.path repo}/environments", options) do |data, last_response|
+          data.environments.concat last_response.data.environments
+          data.total_count += last_response.data.total_count
+        end
       end
       alias list_environments environments
 

data/lib/octokit/client/oauth_applications.rb

@@ -65,7 +65,7 @@ module Octokit
       #
       # @example
       #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
-      #  client.delete_token('deadbeef1234567890deadbeef987654321')
+      #  client.delete_app_token('deadbeef1234567890deadbeef987654321')
       def delete_app_token(access_token, options = {})
         options[:access_token] = access_token
 

data/lib/octokit/client/users.rb

@@ -57,6 +57,33 @@ module Octokit
         post "#{web_endpoint}login/oauth/access_token", options
       end
 
+      # Refresh a user's access token with a refresh token.
+      #
+      # Applications can refresh an access token without requiring a user to re-authorize using refresh access token.
+      #
+      # @param code [String] 40 character GitHub OAuth refresh access token
+      #
+      # @return [Sawyer::Resource]
+      # @see https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.refresh_access_token('40-character-refresh-token')
+      def refresh_access_token(code, app_id = client_id, app_secret = client_secret, options = {})
+        options = options.merge({
+                                  refresh_token: code,
+                                  client_id: app_id,
+                                  client_secret: app_secret,
+                                  grant_type: 'refresh_token',
+                                  headers: {
+                                    content_type: 'application/json',
+                                    accept: 'application/json'
+                                  }
+                                })
+
+        post "#{web_endpoint}login/oauth/access_token", options
+      end
+
       # Validate user username and password
       #
       # @param options [Hash] User credentials

data/lib/octokit/client.rb

@@ -50,7 +50,6 @@ require 'octokit/client/objects'
 require 'octokit/client/organizations'
 require 'octokit/client/pages'
 require 'octokit/client/projects'
-require 'octokit/client/pub_sub_hubbub'
 require 'octokit/client/pull_requests'
 require 'octokit/client/rate_limit'
 require 'octokit/client/reactions'
@@ -118,7 +117,6 @@ module Octokit
     include Octokit::Client::Organizations
     include Octokit::Client::Pages
     include Octokit::Client::Projects
-    include Octokit::Client::PubSubHubbub
     include Octokit::Client::PullRequests
     include Octokit::Client::RateLimit
     include Octokit::Client::Reactions

data/lib/octokit/configurable.rb

@@ -32,6 +32,12 @@ module Octokit
     #   @return [String] An admin password set up for your GitHub Enterprise management console
     # @!attribute management_console_endpoint
     #   @return [String] Base URL for API requests to the GitHub Enterprise management console
+    # @!attribute manage_ghes_endpoint
+    #   @return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
+    # @!attribute manage_ghes_username
+    #   @return [String] API username for requests to the GitHub Enterprise Server Manage API
+    # @!attribute manage_ghes_password
+    #   @return [String] API user password for requests to the GitHub Enterprise Server Manage API
     # @!attribute middleware
     #   @see https://github.com/lostisland/faraday
     #   @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@@ -59,7 +65,10 @@ module Octokit
                   :middleware, :netrc, :netrc_file,
                   :per_page, :proxy, :ssl_verify_mode, :user_agent
     attr_writer :password, :web_endpoint, :api_endpoint, :login,
-                :management_console_endpoint, :management_console_password
+                :management_console_endpoint, :management_console_password,
+                :manage_ghes_endpoint,
+                :manage_ghes_username,
+                :manage_ghes_password
 
     class << self
       # List of configurable keys for {Octokit::Client}
@@ -77,6 +86,9 @@ module Octokit
           login
           management_console_endpoint
           management_console_password
+          manage_ghes_endpoint
+          manage_ghes_username
+          manage_ghes_password
           middleware
           netrc
           netrc_file
@@ -126,6 +138,10 @@ module Octokit
       File.join(@management_console_endpoint, '')
     end
 
+    def manage_ghes_endpoint
+      File.join(@manage_ghes_endpoint, '')
+    end
+
     # Base URL for generated web URLs
     #
     # @return [String] Default: https://github.com/

data/lib/octokit/default.rb

@@ -12,6 +12,11 @@ if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
   rescue LoadError
     Octokit::Warnable.octokit_warn 'To use retry middleware with Faraday v2.0+, install `faraday-retry` gem'
   end
+  begin
+    require 'faraday/multipart'
+  rescue LoadError
+    Octokit::Warnable.octokit_warn 'To use multipart middleware with Faraday v2.0+, install `faraday-multipart` gem; note: this is used by the ManageGHES client for uploading licenses'
+  end
 end
 
 module Octokit
@@ -102,6 +107,24 @@ module Octokit
         ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT', nil)
       end
 
+      # Default GHES Manage API endpoint from ENV
+      # @return [String]
+      def manage_ghes_endpoint
+        ENV.fetch('OCTOKIT_MANAGE_GHES_ENDPOINT', nil)
+      end
+
+      # Default GHES Manage API username from ENV
+      # @return [String]
+      def manage_ghes_username
+        ENV.fetch('OCTOKIT_MANAGE_GHES_USERNAME', nil)
+      end
+
+      # Default GHES Manage API password from ENV
+      # @return [String]
+      def manage_ghes_password
+        ENV.fetch('OCTOKIT_MANAGE_GHES_PASSWORD', nil)
+      end
+
       # Default options for Faraday::Connection
       # @return [Hash]
       def connection_options

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -14,6 +14,7 @@ module Octokit
       # @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.14.0, please use the ManageGHES client instead.')
         conn = faraday_configuration
 
         params = {}
@@ -28,6 +29,7 @@ module Octokit
       #
       # @return nil
       def start_configuration
+        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.14.0, please use the ManageGHES client instead.')
         post '/setup/api/configure', password_hash
       end
 
@@ -37,6 +39,7 @@ module Octokit
       #
       # @return nil
       def upgrade(license)
+        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.14.0, please use the ManageGHES client instead.')
         conn = faraday_configuration
 
         params = {}
@@ -49,6 +52,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] The installation information
       def config_status
+        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.14.0, please use the ManageGHES client instead.')
         get '/setup/api/configcheck', password_hash
       end
       alias config_check config_status
@@ -57,6 +61,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] The settings
       def settings
+        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.14.0, please use the ManageGHES client instead.')
         get '/setup/api/settings', password_hash
       end
       alias get_settings settings
@@ -67,6 +72,7 @@ module Octokit
       #
       # @return [nil]
       def edit_settings(settings)
+        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.14.0, please use the ManageGHES client instead.')
         queries = password_hash
         queries[:query][:settings] = settings.to_json.to_s
         put '/setup/api/settings', queries
@@ -76,6 +82,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] The maintenance status
       def maintenance_status
+        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.14.0, please use the ManageGHES client instead.')
         get '/setup/api/maintenance', password_hash
       end
       alias get_maintenance_status maintenance_status
@@ -85,6 +92,7 @@ module Octokit
       # @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.14.0, please use the ManageGHES client instead.')
         queries = password_hash
         queries[:query][:maintenance] = maintenance.to_json.to_s
         post '/setup/api/maintenance', queries
@@ -95,6 +103,7 @@ module Octokit
       #
       # @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.14.0, please use the ManageGHES client instead.')
         get '/setup/api/settings/authorized-keys', password_hash
       end
       alias get_authorized_keys authorized_keys
@@ -104,6 +113,7 @@ 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 add_authorized_key(key)
+        octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.14.0, please use the ManageGHES client instead.')
         queries = password_hash
         case key
         when String
@@ -128,6 +138,7 @@ 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.14.0, please use the ManageGHES client instead.')
         queries = password_hash
         case key
         when String

data/lib/octokit/error.rb

@@ -10,6 +10,7 @@ module Octokit
     #
     # @param [Hash] response HTTP response
     # @return [Octokit::Error]
+    # rubocop:disable Metrics/CyclomaticComplexity
     def self.from_response(response)
       status  = response[:status].to_i
       body    = response[:body].to_s
@@ -23,6 +24,7 @@ module Octokit
                   when 405      then Octokit::MethodNotAllowed
                   when 406      then Octokit::NotAcceptable
                   when 409      then Octokit::Conflict
+                  when 410      then Octokit::Deprecated
                   when 415      then Octokit::UnsupportedMediaType
                   when 422      then error_for_422(body)
                   when 451      then Octokit::UnavailableForLegalReasons
@@ -36,6 +38,7 @@ module Octokit
         klass.new(response)
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def build_error_context
       if RATE_LIMITED_ERRORS.include?(self.class)
@@ -317,6 +320,9 @@ module Octokit
   # Raised when GitHub returns a 409 HTTP status code
   class Conflict < ClientError; end
 
+  # Raised when GHES Manage return a 410 HTTP status code
+  class Deprecated < ClientError; end
+
   # Raised when GitHub returns a 414 HTTP status code
   class UnsupportedMediaType < ClientError; end
 

data/lib/octokit/manage_ghes_client/manage_ghes.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Octokit
+  # Client for the Manage GitHub Enterprise Server API
+  class ManageGHESClient
+    # Methods for the Manage GitHub Enterprise Server API
+    #
+    # @see https://developer.github.com/v3/enterprise-admin/manage-ghes
+    module ManageAPI
+      # Get information about the maintenance status of the GHES instance
+      #
+      # @return [nil]
+      def maintenance_mode
+        conn = authenticated_client
+
+        @last_response = conn.get('/manage/v1/maintenance')
+      end
+
+      # Configure the maintenance mode of the GHES instance
+      #
+      # @param maintenance [Hash] A hash configuration of the maintenance mode status
+      # @return [nil]
+      def set_maintenance_mode(enabled, options = {})
+        conn = authenticated_client
+
+        options[:enabled] = enabled
+        @last_response = conn.post('/manage/v1/maintenance', options)
+      end
+      alias configure_maintenance_mode set_maintenance_mode
+    end
+
+    # Uploads a license for the first time
+    #
+    # @param license [String] The path to your .ghl license file.
+    #
+    # @return [nil]
+    def upload_license(license)
+      conn = authenticated_client
+      conn.request :multipart
+      params = {}
+      params[:license] = Faraday::FilePart.new(license, 'binary')
+      params[:password] = @manage_ghes_password
+      @last_response = conn.post('/manage/v1/config/init', params, { 'Content-Type' => 'multipart/form-data' })
+    end
+
+    # Start a configuration process.
+    #
+    # @return [nil]
+    def start_configuration
+      conn = authenticated_client
+      @last_response = conn.post('/manage/v1/config/apply')
+    end
+
+    # Get information about the Enterprise installation
+    #
+    # @return [nil]
+    def config_status
+      conn = authenticated_client
+      @last_response = conn.get('/manage/v1/config/apply')
+    end
+    alias config_check config_status
+
+    # Get information about the Enterprise installation
+    #
+    # @return [nil]
+    def settings
+      conn = authenticated_client
+      @last_response = conn.get('/manage/v1/config/settings')
+    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)
+      conn = authenticated_client
+      @last_response = conn.put('/manage/v1/config/settings', settings.to_json.to_s)
+    end
+
+    def authorized_keys
+      conn = authenticated_client
+      @last_response = conn.get('/manage/v1/access/ssh')
+    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 [nil]
+    def add_authorized_key(key)
+      conn = authenticated_client
+      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 = {}
+      queries[:key] = content
+      @last_response = conn.post('/manage/v1/access/ssh', 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 [nil]
+    def remove_authorized_key(key)
+      conn = authenticated_client
+      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 = {}
+      queries[:key] = content
+      @last_response = conn.run_request(:delete, '/manage/v1/access/ssh', queries, nil)
+    end
+    alias delete_authorized_key remove_authorized_key
+
+    private
+
+    def basic_authenticated?
+      !!(@manage_ghes_username && @manage_ghes_password)
+    end
+
+    # If no username is provided, we assume root site admin should be used
+    def root_site_admin_assumed?
+      !@manage_ghes_username
+    end
+
+    def authenticated_client
+      @authenticated_client ||= Faraday.new(url: @manage_ghes_endpoint) do |c|
+        c.headers[:user_agent] = user_agent
+        c.request  :json
+        c.response :json
+        c.adapter Faraday.default_adapter
+
+        if root_site_admin_assumed?
+          username = 'api_key'
+        elsif basic_authenticated?
+          username = @manage_ghes_username
+        end
+        c.request(*FARADAY_BASIC_AUTH_KEYS, username, @manage_ghes_password)
+
+        # Disabling SSL is essential for certain self-hosted Enterprise instances
+        c.ssl[:verify] = false if connection_options[:ssl] && !connection_options[:ssl][:verify]
+
+        c.use Octokit::Response::RaiseError
+      end
+    end
+  end
+end

data/lib/octokit/manage_ghes_client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'octokit/configurable'
+require 'octokit/connection'
+require 'octokit/warnable'
+require 'octokit/manage_ghes_client/manage_ghes'
+
+module Octokit
+  # ManageGHESClient is only meant to be used by GitHub Enterprise Server (GHES) operators
+  # and provides access to the Manage GHES API endpoints.
+  #
+  # @see Octokit::Client Use Octokit::Client for regular API use for GitHub
+  #   and GitHub Enterprise.
+  # @see https://developer.github.com/v3/enterprise-admin/manage-ghes/
+  class ManageGHESClient
+    include Octokit::Configurable
+    include Octokit::Connection
+    include Octokit::Warnable
+    include Octokit::ManageGHESClient::ManageAPI
+
+    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
+
+    protected
+
+    def endpoint
+      manage_ghes_endpoint
+    end
+
+    # Set Manage GHES API endpoint
+    #
+    # @param value [String] Manage GHES API endpoint
+    def manage_ghes_endpoint=(value)
+      reset_agent
+      @manage_ghes_endpoint = value
+    end
+
+    # Set Manage GHES API username
+    #
+    # @param value [String] Manage GHES API username
+    def manage_ghes_username=(value)
+      reset_agent
+      @manage_ghes_username = value
+    end
+
+    # Set Manage GHES API password
+    #
+    # @param value [String] Manage GHES API password
+    def manage_ghes_password=(value)
+      reset_agent
+      @manage_ghes_password = value
+    end
+  end
+end

data/lib/octokit/middleware/follow_redirects.rb

@@ -15,7 +15,7 @@ module Octokit
       attr_reader :response
 
       def initialize(response)
-        super "too many redirects; last one to: #{response['location']}"
+        super("too many redirects; last one to: #{response['location']}")
         @response = response
       end
     end

data/lib/octokit/repo_arguments.rb

@@ -9,7 +9,7 @@ module Octokit
     attr_reader :repo
 
     def initialize(args)
-      arguments = super(args)
+      arguments = super
       @repo = arguments.shift
 
       arguments

data/lib/octokit/version.rb

@@ -3,7 +3,7 @@
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 8
+  MAJOR = 9
 
   # Current minor release.
   # @return [Integer]

data/lib/octokit.rb

@@ -4,6 +4,7 @@ require 'octokit/default'
 require 'octokit/client'
 require 'octokit/enterprise_admin_client'
 require 'octokit/enterprise_management_console_client'
+require 'octokit/manage_ghes_client'
 
 # Ruby toolkit for the GitHub API
 module Octokit
@@ -41,12 +42,24 @@ module Octokit
       @enterprise_management_console_client = Octokit::EnterpriseManagementConsoleClient.new(options)
     end
 
+    # ManageGHESClient client based on configured options {Configurable}
+    #
+    # @return [Octokit::ManageGHESClient] API wrapper
+    def manage_ghes_client
+      if defined?(@manage_ghes_client) && @manage_ghes_client.same_options?(options)
+        return @manage_ghes_client
+      end
+
+      @manage_ghes_client = Octokit::ManageGHESClient.new(options)
+    end
+
     private
 
     def respond_to_missing?(method_name, include_private = false)
       client.respond_to?(method_name, include_private) ||
         enterprise_admin_client.respond_to?(method_name, include_private) ||
-        enterprise_management_console_client.respond_to?(method_name, include_private)
+        enterprise_management_console_client.respond_to?(method_name, include_private) ||
+        manage_ghes_client.respond_to?(method_name, include_private)
     end
 
     def method_missing(method_name, *args, &block)
@@ -56,6 +69,8 @@ module Octokit
         return enterprise_admin_client.send(method_name, *args, &block)
       elsif enterprise_management_console_client.respond_to?(method_name)
         return enterprise_management_console_client.send(method_name, *args, &block)
+      elsif manage_ghes_client.respond_to?(method_name)
+        return manage_ghes_client.send(method_name, *args, &block)
       end
 
       super

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,7 +104,6 @@ files:
 - lib/octokit/client/organizations.rb
 - lib/octokit/client/pages.rb
 - lib/octokit/client/projects.rb
-- lib/octokit/client/pub_sub_hubbub.rb
 - lib/octokit/client/pull_requests.rb
 - lib/octokit/client/rate_limit.rb
 - lib/octokit/client/reactions.rb
@@ -135,6 +134,8 @@ files:
 - lib/octokit/enterprise_management_console_client/management_console.rb
 - lib/octokit/error.rb
 - lib/octokit/gist.rb
+- lib/octokit/manage_ghes_client.rb
+- lib/octokit/manage_ghes_client/manage_ghes.rb
 - lib/octokit/middleware/follow_redirects.rb
 - lib/octokit/organization.rb
 - lib/octokit/rate_limit.rb
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module Octokit
-  class Client
-    # Methods for the PubSubHubbub API
-    #
-    # @see https://developer.github.com/v3/repos/hooks/#pubsubhubbub
-    module PubSubHubbub
-      # Subscribe to a pubsub topic
-      #
-      # @param topic [String] A recoginized and supported pubsub topic
-      # @param callback [String] A callback url to be posted to when the topic event is fired
-      # @param secret [String] An optional shared secret used to generate a SHA1 HMAC of the outgoing body content
-      # @return [Boolean] true if the subscribe was successful, otherwise an error is raised
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Subscribe to push events from one of your repositories, having an email sent when fired
-      #   client = Octokit::Client.new(:oauth_token = "token")
-      #   client.subscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
-      def subscribe(topic, callback, secret = nil)
-        options = {
-          'hub.callback': callback,
-          'hub.mode': 'subscribe',
-          'hub.topic': topic
-        }
-        options.merge!('hub.secret': secret) unless secret.nil?
-
-        response = pub_sub_hubbub_request(options)
-
-        response.status == 204
-      end
-
-      # Unsubscribe from a pubsub topic
-      #
-      # @param topic [String] A recoginized pubsub topic
-      # @param callback [String] A callback url to be unsubscribed from
-      # @return [Boolean] true if the unsubscribe was successful, otherwise an error is raised
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Unsubscribe to push events from one of your repositories, no longer having an email sent when fired
-      #   client = Octokit::Client.new(:oauth_token = "token")
-      #   client.unsubscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
-      def unsubscribe(topic, callback)
-        options = {
-          'hub.callback': callback,
-          'hub.mode': 'unsubscribe',
-          'hub.topic': topic
-        }
-        response = pub_sub_hubbub_request(options)
-
-        response.status == 204
-      end
-
-      # Subscribe to a repository through pubsub
-      #
-      # @param repo [String, Repository, Hash] A GitHub repository
-      # @param service_name [String] service name owner
-      # @param service_arguments [Hash] params that will be passed by subscribed hook.
-      #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
-      #    Please refer Data node for complete list of arguments.
-      # @param secret [String] An optional shared secret used to generate a SHA1 HMAC of the outgoing body content
-      # @return [Boolean] True if subscription successful, false otherwise
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Subscribe to push events to one of your repositories to Travis-CI
-      #    client = Octokit::Client.new(:oauth_token = "token")
-      #    client.subscribe_service_hook('joshk/device_imapable', 'Travis', { :token => "test", :domain => "domain", :user => "user" })
-      def subscribe_service_hook(repo, service_name, service_arguments = {}, secret = nil)
-        topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
-        callback = "github://#{service_name}?#{service_arguments.collect { |k, v| [k, v].map { |p| URI.encode_www_form_component(p) }.join('=') }.join('&')}"
-        subscribe(topic, callback, secret)
-      end
-
-      # Unsubscribe repository through pubsub
-      #
-      # @param repo [String, Repository, Hash] A GitHub repository
-      # @param service_name [String] service name owner
-      #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Subscribe to push events to one of your repositories to Travis-CI
-      #    client = Octokit::Client.new(:oauth_token = "token")
-      #    client.unsubscribe_service_hook('joshk/device_imapable', 'Travis')
-      def unsubscribe_service_hook(repo, service_name)
-        topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
-        callback = "github://#{service_name}"
-        unsubscribe(topic, callback)
-      end
-
-      private
-
-      def pub_sub_hubbub_request(options = {})
-        # This method is janky, bypass normal stack so we don't
-        # serialize request as JSON
-        conn = Faraday.new(url: @api_endpoint) do |http|
-          http.headers[:user_agent] = user_agent
-          if basic_authenticated?
-            http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
-          elsif token_authenticated?
-            http.request :authorization, 'token', @access_token
-          end
-          http.request :url_encoded
-          http.use Octokit::Response::RaiseError
-          http.adapter Faraday.default_adapter
-        end
-
-        conn.post do |req|
-          req.url 'hub'
-          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-          req.body = options
-        end
-      end
-    end
-  end
-end