octokit 4.6.0 → 4.21.0

data/lib/octokit/client/users.rb

@@ -44,7 +44,7 @@ module Octokit
       # @example
       #   Octokit.exchange_code_for_token('aaaa', 'xxxx', 'yyyy', {:accept => 'application/json'})
       def exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {})
-        options.merge!({
+        options = options.merge({
           :code => code,
           :client_id => app_id,
           :client_secret => app_secret,
@@ -53,6 +53,7 @@ module Octokit
             :accept       => 'application/json'
           }
         })
+
         post "#{web_endpoint}login/oauth/access_token", options
       end
 
@@ -339,6 +340,92 @@ module Octokit
       end
       alias :watched :subscriptions
 
+      # Initiates the generation of a migration archive.
+      #
+      # Requires authenticated user.
+      #
+      # @param repositories [Array<String>] :repositories Repositories for the organization.
+      # @option options [Boolean, optional] :lock_repositories Indicates whether repositories should be locked during migration
+      # @option options [Boolean, optional] :exclude_attachments Exclude attachments fro the migration data
+      # @return [Sawyer::Resource] Hash representing the new migration.
+      # @example
+      #   @client.start_migration(['octocat/hello-world'])
+      # @see https://docs.github.com/en/rest/reference/migrations#start-a-user-migration
+      def start_user_migration(repositories, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        options[:repositories] = repositories
+        post "user/migrations", options
+      end
+
+      # Lists the most recent migrations.
+      #
+      # Requires authenticated user.
+      #
+      # @return [Array<Sawyer::Resource>] Array of migration resources.
+      # @see https://docs.github.com/en/rest/reference/migrations#list-user-migrations
+      def user_migrations(options = {})
+        options = ensure_api_media_type(:migrations, options)
+        paginate "user/migrations", options
+      end
+
+      # Fetches the status of a migration.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#get-a-user-migration-status
+      def user_migration_status(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        get "user/migrations/#{id}", options
+      end
+
+      # Fetches the URL to a migration archive.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#download-a-user-migration-archive
+      def user_migration_archive_url(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        url = "user/migrations/#{id}/archive"
+
+        response = client_without_redirects(options).get(url)
+        response.headers['location']
+      end
+
+      # Deletes a previous migration archive.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#delete-a-user-migration-archive
+      def delete_user_migration_archive(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        delete "user/migrations/#{id}/archive", options
+      end
+
+      # List repositories for a user migration.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#list-repositories-for-a-user-migration
+      def user_migration_repositories(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        get "user/migrations/#{id}/repositories", options
+      end
+
+      # Unlock a user repository which has been locked by a migration.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @param repo [String] Name of the repository.
+      # @see https://docs.github.com/en/rest/reference/migrations#unlock-a-user-repository
+      def unlock_user_repository(id, repo, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        delete "user/migrations/#{id}/repos/#{repo}/lock", options
+      end
     end
 
     private

data/lib/octokit/client.rb

@@ -10,9 +10,17 @@ require 'octokit/repository'
 require 'octokit/user'
 require 'octokit/organization'
 require 'octokit/preview'
+require 'octokit/client/actions_secrets'
+require 'octokit/client/actions_workflows'
+require 'octokit/client/actions_workflow_runs'
+require 'octokit/client/apps'
 require 'octokit/client/authorizations'
+require 'octokit/client/checks'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
+require 'octokit/client/commit_pulls'
+require 'octokit/client/commit_branches'
+require 'octokit/client/community_profile'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
 require 'octokit/client/deployments'
@@ -28,8 +36,10 @@ require 'octokit/client/legacy_search'
 require 'octokit/client/licenses'
 require 'octokit/client/meta'
 require 'octokit/client/markdown'
+require 'octokit/client/marketplace'
 require 'octokit/client/milestones'
 require 'octokit/client/notifications'
+require 'octokit/client/oauth_applications'
 require 'octokit/client/objects'
 require 'octokit/client/organizations'
 require 'octokit/client/pages'
@@ -42,6 +52,7 @@ require 'octokit/client/refs'
 require 'octokit/client/releases'
 require 'octokit/client/repositories'
 require 'octokit/client/repository_invitations'
+require 'octokit/client/reviews'
 require 'octokit/client/say'
 require 'octokit/client/search'
 require 'octokit/client/service_status'
@@ -50,6 +61,7 @@ require 'octokit/client/stats'
 require 'octokit/client/statuses'
 require 'octokit/client/traffic'
 require 'octokit/client/users'
+require 'ext/sawyer/relation'
 
 module Octokit
 
@@ -63,9 +75,14 @@ module Octokit
     include Octokit::Connection
     include Octokit::Preview
     include Octokit::Warnable
+    include Octokit::Client::ActionsSecrets
     include Octokit::Client::Authorizations
+    include Octokit::Client::Checks
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
+    include Octokit::Client::CommitPulls
+    include Octokit::Client::CommitBranches
+    include Octokit::Client::CommunityProfile
     include Octokit::Client::Contents
     include Octokit::Client::Deployments
     include Octokit::Client::Downloads
@@ -75,14 +92,19 @@ module Octokit
     include Octokit::Client::Gists
     include Octokit::Client::Gitignore
     include Octokit::Client::Hooks
+    include Octokit::Client::ActionsWorkflows
+    include Octokit::Client::ActionsWorkflowRuns
+    include Octokit::Client::Apps
     include Octokit::Client::Issues
     include Octokit::Client::Labels
     include Octokit::Client::LegacySearch
     include Octokit::Client::Licenses
     include Octokit::Client::Meta
     include Octokit::Client::Markdown
+    include Octokit::Client::Marketplace
     include Octokit::Client::Milestones
     include Octokit::Client::Notifications
+    include Octokit::Client::OauthApplications
     include Octokit::Client::Objects
     include Octokit::Client::Organizations
     include Octokit::Client::Pages
@@ -95,6 +117,7 @@ module Octokit
     include Octokit::Client::Releases
     include Octokit::Client::Repositories
     include Octokit::Client::RepositoryInvitations
+    include Octokit::Client::Reviews
     include Octokit::Client::Say
     include Octokit::Client::Search
     include Octokit::Client::ServiceStatus
@@ -110,7 +133,8 @@ module Octokit
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
       Octokit::Configurable.keys.each do |key|
-        instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
+        value = options.key?(key) ? options[key] : Octokit.instance_variable_get(:"@#{key}")
+        instance_variable_set(:"@#{key}", value)
       end
 
       login_from_netrc unless user_authenticated? || application_authenticated?
@@ -123,15 +147,12 @@ module Octokit
       inspected = super
 
       # mask password
-      inspected = inspected.gsub! @password, "*******" if @password
-      inspected = inspected.gsub! @management_console_password, "*******" if @management_console_password
+      inspected.gsub! @password, '*******' if @password
+      inspected.gsub! @management_console_password, '*******' if @management_console_password
+      inspected.gsub! @bearer_token, '********' if @bearer_token
       # Only show last 4 of token, secret
-      if @access_token
-        inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
-      end
-      if @client_secret
-        inspected = inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}"
-      end
+      inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}" if @access_token
+      inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}" if @client_secret
 
       inspected
     end
@@ -185,6 +206,14 @@ module Octokit
       @access_token = value
     end
 
+    # Set Bearer Token for authentication
+    #
+    # @param value [String] JWT
+    def bearer_token=(value)
+      reset_agent
+      @bearer_token = value
+    end
+
     # Set OAuth app client_id
     #
     # @param value [String] 20 character GitHub OAuth app client_id
@@ -206,11 +235,14 @@ module Octokit
       conn_opts[:url] = @api_endpoint
       conn_opts[:builder] = @middleware.dup if @middleware
       conn_opts[:proxy] = @proxy if @proxy
+      conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
       conn = Faraday.new(conn_opts) do |http|
         if basic_authenticated?
           http.basic_auth(@login, @password)
         elsif token_authenticated?
           http.authorization 'token', @access_token
+        elsif bearer_authenticated?
+          http.authorization 'Bearer', @bearer_token
         end
         http.headers['accept'] = options[:accept] if options.key?(:accept)
       end

data/lib/octokit/configurable.rb

@@ -10,6 +10,9 @@ module Octokit
     #   @return [String] Base URL for API requests. default: https://api.github.com/
     # @!attribute auto_paginate
     #   @return [Boolean] Auto fetch next page of results until rate limit reached
+    # @!attribute [w] bearer_token
+    #   @see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
+    #   @return [String] JWT bearer token for authentication
     # @!attribute client_id
     #   @see https://developer.github.com/v3/oauth/
     #   @return [String] Configure OAuth app key
@@ -42,15 +45,18 @@ module Octokit
     # @!attribute proxy
     #   @see https://github.com/lostisland/faraday
     #   @return [String] URI for proxy server
+    # @!attribute ssl_verify_mode
+    #   @see https://github.com/lostisland/faraday
+    #   @return [String] SSL verify mode for ssl connections
     # @!attribute user_agent
     #   @return [String] Configure User-Agent header for requests.
     # @!attribute web_endpoint
     #   @return [String] Base URL for web URLs. default: https://github.com/
 
-    attr_accessor :access_token, :auto_paginate, :client_id,
+    attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id,
                   :client_secret, :default_media_type, :connection_options,
                   :middleware, :netrc, :netrc_file,
-                  :per_page, :proxy, :user_agent
+                  :per_page, :proxy, :ssl_verify_mode, :user_agent
     attr_writer :password, :web_endpoint, :api_endpoint, :login,
                 :management_console_endpoint, :management_console_password
 
@@ -63,6 +69,7 @@ module Octokit
           :access_token,
           :api_endpoint,
           :auto_paginate,
+          :bearer_token,
           :client_id,
           :client_secret,
           :connection_options,
@@ -76,6 +83,7 @@ module Octokit
           :per_page,
           :password,
           :proxy,
+          :ssl_verify_mode,
           :user_agent,
           :web_endpoint
         ]

data/lib/octokit/connection.rb

@@ -76,7 +76,7 @@ module Octokit
     #   contains the latest response.
     # @return [Sawyer::Resource]
     def paginate(url, options = {}, &block)
-      opts = parse_query_and_convenience_headers(options.dup)
+      opts = parse_query_and_convenience_headers(options)
       if @auto_paginate || @per_page
         opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
       end
@@ -110,8 +110,10 @@ module Octokit
           http.basic_auth(@login, @password)
         elsif token_authenticated?
           http.authorization 'token', @access_token
+        elsif bearer_authenticated?
+          http.authorization 'Bearer', @bearer_token
         elsif application_authenticated?
-          http.params = http.params.merge application_authentication
+          http.basic_auth(@client_id, @client_secret)
         end
       end
     end
@@ -151,8 +153,11 @@ module Octokit
         end
       end
 
-      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+      @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
       response.data
+    rescue Octokit::Error => error
+      @last_response = nil
+      raise error
     end
 
     # Executes the request, checking if it was successful
@@ -160,7 +165,7 @@ module Octokit
     # @return [Boolean] True on success, false otherwise
     def boolean_from_response(method, path, options = {})
       request(method, path, options)
-      @last_response.status == 204
+      [201, 202, 204].include? @last_response.status
     rescue Octokit::NotFound
       false
     end
@@ -173,12 +178,22 @@ module Octokit
       conn_opts = @connection_options
       conn_opts[:builder] = @middleware if @middleware
       conn_opts[:proxy] = @proxy if @proxy
+      if conn_opts[:ssl].nil?
+        conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      else
+        verify = @connection_options[:ssl][:verify]
+        conn_opts[:ssl] = {
+          :verify => verify,
+          :verify_mode => verify == false ? 0 : @ssl_verify_mode
+        }
+      end
       opts[:faraday] = Faraday.new(conn_opts)
 
       opts
     end
 
     def parse_query_and_convenience_headers(options)
+      options = options.dup
       headers = options.delete(:headers) { Hash.new }
       CONVENIENCE_HEADERS.each do |h|
         if header = options.delete(h)

data/lib/octokit/default.rb

@@ -25,6 +25,7 @@ module Octokit
 
     # Default Faraday middleware stack
     MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
       builder.use Octokit::Middleware::FollowRedirects
       builder.use Octokit::Response::RaiseError
       builder.use Octokit::Response::FeedParser
@@ -57,6 +58,12 @@ module Octokit
         ENV['OCTOKIT_AUTO_PAGINATE']
       end
 
+      # Default bearer token from ENV
+      # @return [String]
+      def bearer_token
+        ENV['OCTOKIT_BEARER_TOKEN']
+      end
+
       # Default OAuth app key from ENV
       # @return [String]
       def client_id
@@ -118,7 +125,7 @@ module Octokit
       end
 
       # Default pagination page size from ENV
-      # @return [Fixnum] Page size
+      # @return [Integer] Page size
       def per_page
         page_size = ENV['OCTOKIT_PER_PAGE']
 
@@ -131,6 +138,15 @@ module Octokit
         ENV['OCTOKIT_PROXY']
       end
 
+      # Default SSL verify mode from ENV
+      # @return [Integer]
+      def ssl_verify_mode
+        # 0 is OpenSSL::SSL::VERIFY_NONE
+        # 1 is OpenSSL::SSL::SSL_VERIFY_PEER
+        # the standard default for SSL is SSL_VERIFY_PEER which requires a server certificate check on the client
+        ENV.fetch('OCTOKIT_SSL_VERIFY_MODE', 1).to_i
+      end
+
       # Default User-Agent header string from ENV or {USER_AGENT}
       # @return [String]
       def user_agent

data/lib/octokit/enterprise_admin_client/admin_stats.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise Admin Stats API
     #
-    # @see https://developer.github.com/v3/enterprise/admin_stats/
+    # @see https://developer.github.com/v3/enterprise-admin/admin_stats/
     module AdminStats
 
       # Get all available stats

data/lib/octokit/enterprise_admin_client/license.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise License API
     #
-    # @see https://developer.github.com/v3/enterprise/license/
+    # @see https://developer.github.com/v3/enterprise-admin/license/
     module License
 
       # Get information about the Enterprise license

data/lib/octokit/enterprise_admin_client/orgs.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise Orgs API
     #
-    # @see https://developer.github.com/v3/enterprise/orgs/
+    # @see https://developer.github.com/v3/enterprise-admin/orgs/
     module Orgs
 
       # Create a new organization on the instance.
@@ -13,7 +13,7 @@ module Octokit
       # @param options [Hash] A set of options.
       # @option options [String] :profile_name The organization's display name.
       # @return [nil]
-      # @see https://developer.github.com/v3/enterprise/orgs/#create-an-organization
+      # @see https://developer.github.com/v3/enterprise-admin/orgs/#create-an-organization
       # @example
       #   @admin_client.create_organization('SuchAGreatOrg', 'gjtorikian')
       def create_organization(login, admin, options = {})

data/lib/octokit/enterprise_admin_client/search_indexing.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise Search Indexing API
     #
-    # @see https://developer.github.com/v3/enterprise/search_indexing/
+    # @see https://developer.github.com/v3/enterprise-admin/search_indexing/
     module SearchIndexing
 
       # Queue a User or Organization to be indexed

data/lib/octokit/enterprise_admin_client/users.rb

@@ -3,13 +3,13 @@ module Octokit
 
     # 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 = {})
@@ -22,7 +22,7 @@ module Octokit
       #
       # @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 +33,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 +44,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,7 +55,7 @@ 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(username, options = {})
@@ -66,7 +66,7 @@ module Octokit
       #
       # @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 +77,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 +88,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 +98,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,7 +107,7 @@ 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 = {})
@@ -117,7 +117,7 @@ module Octokit
       # 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 = {})

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # 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

data/lib/octokit/enterprise_management_console_client.rb

@@ -10,7 +10,7 @@ module Octokit
   #
   # @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