octokit 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff098c16b9a72f52713782145e415ca2658ae2f7f48bd1c64f908507f26eb4cc
-  data.tar.gz: 06610fe737e7bf1c9b56447828fd5c5ab19e343832b34573f4ad0c02eec41c62
+  metadata.gz: b64084ad94f7ab597007ce5baa5e9daa39e85c0270c0993cde6bf416a2834a2c
+  data.tar.gz: 429a34488349b5692bc28e6051571e3e4bddfd7f697be93bd0e24c7329d1bd18
 SHA512:
-  metadata.gz: f236b59523559b762dd8c58718d0ff58d8181877740b7c2c5e10851f7be8f490e959bbf4f0b457e641c1931b562a6f5a4aa4f6d0f2b56bb63251a7cc3691faa1
-  data.tar.gz: f7b50ad0662923a499628fd914ba6aa36df8370c1e111d3fd16582f027eeef358fa8f25502376fac9e744848dbf55e5ddc781a5a5ca1ae7638cf4acbb6545b9e
+  metadata.gz: c52b64720e7ffa14ab04bf59283194dd8a0b83ba73bf9acc3c0cfbb4ef36ba6e87257f7650969d597135c8c75eb3bc1bf7a3b7a20f2746c5670e92f7cea95a9f
+  data.tar.gz: b0598cc84a8d4571d9e3fc64d1ed63dcef618fba37e2d9e33346ef42a766e366bc2e38fc02b7c9561b0fc7fe28a7ed8984599390deb305f86af8e98b21033b29

data/lib/octokit/client/code_scanning.rb

@@ -9,6 +9,144 @@ module Octokit
     #
     # @see https://docs.github.com/rest/code-scanning
     module CodeScanning
+      # Updates a code scanning default setup configuration
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param state [String] The desired state of code scanning default setup
+      # @param query_suite [String] CodeQL query suite to be used
+      # @param languages [Array] List of CodeQL languages to be analyzed
+      #
+      # @return [Sawyer::Resource] Action Run information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
+      def update_code_scanning_default_config(repo, state, query_suite = nil, languages = nil, options = {})
+        options[:state] = state
+        options[:query_suite] = query_suite if query_suite
+        options[:languages] = languages if languages
+
+        patch "#{Repository.path repo}/code-scanning/default-setup", options
+      end
+
+      # Get Code Scanning Default Configuration
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Sawyer::Resource] CodeQl Default Setup Configuration Information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
+      def get_code_scanning_default_config(repo, options = {})
+        get "#{Repository.path repo}/code-scanning/default-setup", options
+      end
+
+      # Gets a CodeQL database for a language in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param language [String]
+      #
+      # @return [Sawyer::Resource] CodeQl Default Setup Configuration Information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
+      def get_codeql_database_for_repo(repo, language, options = {})
+        get "#{Repository.path repo}/code-scanning/codeql/databases/#{language}", options
+      end
+
+      # Lists the CodeQL databases that are available in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Array] List of CodeQL Databases
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
+      def list_codeql_database_for_repo(repo, options = {})
+        get "#{Repository.path repo}/code-scanning/codeql/databases", options
+      end
+
+      # Delete a specified code scanning analysis from a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param analysis_id [Integer] ID of the code scanning analysis
+      #
+      # @return [Sawyer::Resource] Next Code Scanning Analysis Information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
+      def delete_code_scanning_analysis(repo, analysis_id, options = {})
+        delete "#{Repository.path repo}/code-scanning/analyses/#{analysis_id}", options
+      end
+
+      # Get a code scanning analysis for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param analysis_id [Integer] ID of the code scanning analysis
+      #
+      # @return [Sawyer::Resource] Code Scanning Analysis
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
+      def get_code_scanning_analysis(repo, analysis_id, options = {})
+        get "#{Repository.path repo}/code-scanning/analyses/#{analysis_id}", options
+      end
+
+      # List code scanning analyses for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Array] List of Code Scanning Analyses
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
+      def list_code_scanning_analysis(repo, options = {})
+        paginate "#{Repository.path repo}/code-scanning/analyses", options
+      end
+
+      # List instances of a code scanning alert
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param alert_number [Integer] The number that identifies an alert
+      #
+      # @return [Array] List of Code Scanning Alerts
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
+      def list_instances_of_code_scanning_alert(repo, alert_number, options = {})
+        paginate "#{Repository.path repo}/code-scanning/alerts/#{alert_number}/instances", options
+      end
+
+      # Update a code scanning alert
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param alert_number [Integer] The number that identifies an alert
+      # @param state [String] The reason for dismissing or closing the alert. Required when the state is dismissed
+      #
+      # @return [Sawyer::Resource] Code Scanning Alert information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-alert
+      def update_code_scanning_alert(repo, alert_number, state, reason, comment = nil, options = {})
+        options[:state] = state
+        options[:dismissed_reason] = reason
+        options[:dismissed_comment] = comment if comment
+
+        patch "#{Repository.path repo}/code-scanning/alerts/#{alert_number}", options
+      end
+
+      # Gets a single code scanning alert
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param alert_number [Integer] The number that identifies an alert
+      #
+      # @return [Sawyer::Resource] Code Scanning Alert
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-alert
+      def get_code_scanning_alert(repo, alert_number, options = {})
+        get "#{Repository.path repo}/code-scanning/alerts/#{alert_number}", options
+      end
+
+      # List code scanning alerts for a repository
+      #
+      # @param org [String] A GitHub organization
+      #
+      # @return [Array] Code Scanning Alert information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
+      def list_code_scanning_alerts_for_repo(repo, options = {})
+        paginate "#{Repository.path repo}/code-scanning/alerts", options
+      end
+
+      # List code scanning alerts for an organization
+      #
+      # @param org [String] A GitHub organization
+      #
+      # @return [Array] Code Scanning Alert information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
+      def list_code_scanning_alerts_for_org(org, options = {})
+        paginate "orgs/#{org}/code-scanning/alerts", options
+      end
+
       # Uploads SARIF data containing the results of a code scanning analysis
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository

data/lib/octokit/client/pull_requests.rb

@@ -197,22 +197,30 @@ module Octokit
       # @param body [String] Comment content
       # @param commit_id [String] Sha of the commit to comment on.
       # @param path [String] Relative path of the file to comment on.
-      # @param line [Integer] Line index in the diff to comment on.
+      # @param line [Integer] Optional line index in the diff to comment on.
       #                       For a multi-line comment, the last line of the range
       #                       and specify 'start_line' in the 'options'.
+      #                       If not specified, the comment will be on the whole file.
       # @return [Sawyer::Resource] Hash representing the new comment
       # @deprecated The position will be deprecated in the next major version. Please refer to the details below.
       # @see https://developer.github.com/v3/pulls/comments/#create-a-comment
       # @example
       #   @client.create_pull_request_comment("octokit/octokit.rb", 163, ":shipit:",
       #     "2d3201e4440903d8b04a5487842053ca4883e5f0", "lib/octokit/request.rb", 47)
-      def create_pull_request_comment(repo, pull_id, body, commit_id, path, line, options = {})
-        options.merge!({
-                         body: body,
-                         commit_id: commit_id,
-                         path: path,
-                         line: line
-                       })
+      def create_pull_request_comment(repo, pull_id, body, commit_id, path, line = nil, options = {})
+        comment = {
+          body: body,
+          commit_id: commit_id,
+          path: path
+        }
+
+        if line.nil?
+          comment[:subject_type] = 'file'
+        else
+          comment[:line] = line
+        end
+
+        options.merge! comment
         post "#{Repository.path repo}/pulls/#{pull_id}/comments", options
       end
       alias create_pull_comment create_pull_request_comment

data/lib/octokit/client/repositories.rb

@@ -774,6 +774,49 @@ module Octokit
       def disable_vulnerability_alerts(repo, options = {})
         boolean_from_response(:delete, "#{Repository.path repo}/vulnerability-alerts", options)
       end
+
+      # Check to see if automated security fixes are enabled for a repository
+      #
+      # The authenticated user must have admin access to the repository.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Boolean] True if automated security fixes are enabled, false otherwise.
+      # @see https://docs.github.com/en/rest/reference/repos#check-if-automated-security-fixes-are-enabled-for-a-repository
+      #
+      # @example
+      #   @client.automated_security_fixes_enabled?("octokit/octokit.rb")
+      def automated_security_fixes_enabled?(repo, options = {})
+        response = get "#{Repository.path repo}/automated-security-fixes", options
+        return response[:enabled] if @last_response.status == 200
+
+        false
+      end
+
+      # Enable automated security fixes for a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      #
+      # @return [Boolean] True if vulnerability alerts enabled, false otherwise.
+      # @see https://docs.github.com/en/rest/reference/repos#automated-security-fixes
+      # @example Enable automated security fixes for a repository
+      #   @client.enable_automated_security_fixes("octokit/octokit.rb")
+      def enable_automated_security_fixes(repo, options = {})
+        boolean_from_response(:put, "#{Repository.path repo}/automated-security-fixes", options)
+      end
+
+      # Disable automated security fixes for a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      #
+      # @return [Boolean] True if vulnerability alerts disabled, false otherwise.
+      # @see https://docs.github.com/en/rest/reference/repos#automated-security-fixes
+      # @example Disable  automated security fixes for a repository
+      #   @client.disable_automated_security_fixes("octokit/octokit.rb")
+      def disable_automated_security_fixes(repo, options = {})
+        boolean_from_response(:delete, "#{Repository.path repo}/automated-security-fixes", options)
+      end
     end
   end
 end

data/lib/octokit/client.rb

@@ -259,6 +259,7 @@ module Octokit
       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|
+        http_cache_middleware = http.builder.handlers.delete(Faraday::HttpCache) if Faraday.const_defined?(:HttpCache)
         if basic_authenticated?
           http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
@@ -266,6 +267,7 @@ module Octokit
         elsif bearer_authenticated?
           http.request :authorization, 'Bearer', @bearer_token
         end
+        http.builder.handlers.push(http_cache_middleware) unless http_cache_middleware.nil?
         http.headers['accept'] = options[:accept] if options.key?(:accept)
       end
       conn.builder.delete(Octokit::Middleware::FollowRedirects)

data/lib/octokit/connection.rb

@@ -106,6 +106,7 @@ module Octokit
         http.headers[:accept] = default_media_type
         http.headers[:content_type] = 'application/json'
         http.headers[:user_agent] = user_agent
+        http_cache_middleware = http.builder.handlers.delete(Faraday::HttpCache) if Faraday.const_defined?(:HttpCache)
         if basic_authenticated?
           http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
@@ -115,6 +116,7 @@ module Octokit
         elsif application_authenticated?
           http.request(*FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret)
         end
+        http.builder.handlers.push(http_cache_middleware) unless http_cache_middleware.nil?
       end
     end
 

data/lib/octokit/default.rb

@@ -12,11 +12,6 @@ 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

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -14,7 +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.')
+        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 = {}
@@ -29,7 +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.')
+        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
 
@@ -39,7 +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.')
+        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 = {}
@@ -52,7 +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.')
+        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
@@ -61,7 +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.')
+        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
@@ -72,7 +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.')
+        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
@@ -82,7 +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.')
+        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
@@ -92,7 +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.')
+        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
@@ -103,7 +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.')
+        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
@@ -113,7 +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.')
+        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
@@ -138,7 +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.')
+        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
@@ -171,7 +171,14 @@ module Octokit
     def faraday_configuration
       @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

data/lib/octokit/manage_ghes_client/manage_ghes.rb

@@ -36,7 +36,14 @@ module Octokit
     # @return [nil]
     def upload_license(license)
       conn = authenticated_client
-      conn.request :multipart
+      begin
+        conn.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
       params = {}
       params[:license] = Faraday::FilePart.new(license, 'binary')
       params[:password] = @manage_ghes_password

data/lib/octokit/repository.rb

@@ -81,8 +81,14 @@ module Octokit
 
     private
 
+    ABS_URI_REGEXP = if URI.const_defined?(:RFC2396_PARSER) # Ruby 3.4+
+                       URI::RFC2396_PARSER.regexp.fetch(:ABS_URI)
+                     else
+                       URI::RFC2396_Parser.new.regexp.fetch(:ABS_URI)
+                     end
+
     def validate_owner_and_name!(repo)
-      if @owner.include?('/') || @name.include?('/') || !url.match(URI::ABS_URI)
+      if @owner.include?('/') || @name.include?('/') || !url.match?(ABS_URI_REGEXP)
         raise_invalid_repository!(repo)
       end
     end

data/lib/octokit/version.rb

@@ -7,7 +7,7 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 0
+  MINOR = 2
 
   # Current patch level.
   # @return [Integer]

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Wynn Netherland
 - Erik Michaels-Ober
 - Clint Shryock
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -153,7 +153,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API
 test_files: []