octokit 4.2.0 → 9.2.0

data/lib/octokit/client/apps.rb

@@ -0,0 +1,259 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Apps API
+    module Apps
+      # Get the authenticated App
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-the-authenticated-app
+      #
+      # @return [Sawyer::Resource] App information
+      def app(options = {})
+        get 'app', options
+      end
+
+      # Find all installations that belong to an App
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#list-installations
+      #
+      # @return [Array<Sawyer::Resource>] the total_count and an array of installations
+      def find_app_installations(options = {})
+        paginate 'app/installations', options
+      end
+      alias find_installations find_app_installations
+
+      def find_integration_installations(options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#find_integration_installations ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#find_app_installations before the next major ' \
+          'Octokit version update.'
+        )
+        find_app_installations(options)
+      end
+
+      # Find all installations that are accessible to the authenticated user
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#list-installations-for-a-user
+      #
+      # @return [Sawyer::Resource] the total_count and an array of installations
+      def find_user_installations(options = {})
+        paginate('user/installations', options) do |data, last_response|
+          data.installations.concat last_response.data.installations
+        end
+      end
+
+      # Get a single installation
+      #
+      # @param id [Integer] Installation id
+      #
+      # @see https://developer.github.com/v3/apps/#get-an-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def installation(id, options = {})
+        get "app/installations/#{id}", options
+      end
+
+      # Create a new installation token
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#create-a-new-installation-token
+      #
+      # @return [<Sawyer::Resource>] An installation token
+      def create_app_installation_access_token(installation, options = {})
+        post "app/installations/#{installation}/access_tokens", options
+      end
+      alias create_installation_access_token create_app_installation_access_token
+
+      def create_integration_installation_access_token(installation, options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#create_integration_installation_access_token ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#create_app_installation_access_token before the next major ' \
+          'Octokit version update.'
+        )
+        create_app_installation_access_token(installation, options)
+      end
+
+      # Enables an app to find the organization's installation information.
+      #
+      # @param organization [String] Organization GitHub login
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-an-organization-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def find_organization_installation(organization, options = {})
+        get "#{Organization.path(organization)}/installation", options
+      end
+
+      # Enables an app to find the repository's installation information.
+      #
+      # @param repo [String] A GitHub repository
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-a-repository-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def find_repository_installation(repo, options = {})
+        get "#{Repository.path(repo)}/installation", options
+      end
+
+      # Enables an app to find the user's installation information.
+      #
+      # @param user [String] GitHub user login
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-a-user-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def find_user_installation(user, options = {})
+        get "#{User.path(user)}/installation", options
+      end
+
+      # List repositories that are accessible to the authenticated installation
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#list-repositories
+      #
+      # @return [Sawyer::Resource] the total_count and an array of repositories
+      def list_app_installation_repositories(options = {})
+        paginate('installation/repositories', options) do |data, last_response|
+          data.repositories.concat last_response.data.repositories
+        end
+      end
+      alias list_installation_repos list_app_installation_repositories
+
+      def list_integration_installation_repositories(options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#list_integration_installation_repositories ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#list_app_installation_repositories before the next major ' \
+          'Octokit version update.'
+        )
+        list_app_installation_repositories(options)
+      end
+
+      # Add a single repository to an installation
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#add-repository-to-installation
+      #
+      # @return [Boolean] Success
+      def add_repository_to_app_installation(installation, repo, options = {})
+        boolean_from_response :put, "user/installations/#{installation}/repositories/#{repo}", options
+      end
+      alias add_repo_to_installation add_repository_to_app_installation
+
+      def add_repository_to_integration_installation(installation, repo, options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#add_repository_to_integration_installation ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#add_repository_to_app_installation before the next major ' \
+          'Octokit version update.'
+        )
+        add_repository_to_app_installation(installation, repo, options)
+      end
+
+      # Remove a single repository to an installation
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#remove-repository-from-installation
+      #
+      # @return [Boolean] Success
+      def remove_repository_from_app_installation(installation, repo, options = {})
+        boolean_from_response :delete, "user/installations/#{installation}/repositories/#{repo}", options
+      end
+      alias remove_repo_from_installation remove_repository_from_app_installation
+
+      def remove_repository_from_integration_installation(installation, repo, options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#remove_repository_from_integration_installation ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#remove_repository_from_app_installation before the next major ' \
+          'Octokit version update.'
+        )
+        remove_repository_from_app_installation(installation, repo, options)
+      end
+
+      # List repositories accessible to the user for an installation
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation
+      #
+      # @return [Sawyer::Resource] the total_count and an array of repositories
+      def find_installation_repositories_for_user(installation, options = {})
+        paginate("user/installations/#{installation}/repositories", options) do |data, last_response|
+          data.repositories.concat last_response.data.repositories
+        end
+      end
+
+      # Delete an installation and uninstall a GitHub App
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#delete-an-installation
+      #
+      # @return [Boolean] Success
+      def delete_installation(installation, options = {})
+        boolean_from_response :delete, "app/installations/#{installation}", options
+      end
+
+      # Returns a list of webhook deliveries for the webhook configured for a GitHub App.
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://docs.github.com/en/rest/apps/webhooks#list-deliveries-for-an-app-webhook
+      #
+      # @return [Array<Hash>] an array of hook deliveries
+      def list_app_hook_deliveries(options = {})
+        paginate('app/hook/deliveries', options) do |data, last_response|
+          data.concat last_response.data
+        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
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#redeliver-a-delivery-for-an-app-webhook
+      #
+      # @return [Boolean] Success
+      def deliver_app_hook(delivery_id, options = {})
+        boolean_from_response :post, "app/hook/deliveries/#{delivery_id}/attempts", options
+      end
+    end
+  end
+end

data/lib/octokit/client/checks.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Checks API
+    #
+    # @see https://developer.github.com/v3/checks/
+    module Checks
+      # Methods for Check Runs
+      #
+      # @see https://developer.github.com/v3/checks/runs/
+
+      # Create a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] The name of the check
+      # @param head_sha [String] The SHA of the commit to check
+      # @return [Sawyer::Resource] A hash representing the new check run
+      # @see https://developer.github.com/v3/checks/runs/#create-a-check-run
+      # @example Create a check run
+      #   check_run = @client.create_check_run("octocat/Hello-World", "my-check", "7638417db6d59f3c431d3e1f261cc637155684cd")
+      #   check_run.name # => "my-check"
+      #   check_run.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
+      #   check_run.status # => "queued"
+      def create_check_run(repo, name, head_sha, options = {})
+        options[:name] = name
+        options[:head_sha] = head_sha
+
+        post "#{Repository.path repo}/check-runs", options
+      end
+
+      # Update a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Sawyer::Resource] A hash representing the updated check run
+      # @see https://developer.github.com/v3/checks/runs/#update-a-check-run
+      # @example Update a check run
+      #   check_run = @client.update_check_run("octocat/Hello-World", 51295429, status: "in_progress")
+      #   check_run.id # => 51295429
+      #   check_run.status # => "in_progress"
+      def update_check_run(repo, id, options = {})
+        patch "#{Repository.path repo}/check-runs/#{id}", options
+      end
+
+      # List check runs for a specific ref
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param ref [String] A SHA, branch name, or tag name
+      # @param options [Hash] A set of optional filters
+      # @option options [String] :check_name Returns check runs with the specified <tt>name</tt>
+      # @option options [String] :status Returns check runs with the specified <tt>status</tt>
+      # @option options [String] :filter Filters check runs by their <tt>completed_at</tt> timestamp
+      # @return [Sawyer::Resource] A hash representing a collection of check runs
+      # @see https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref
+      # @example List check runs for a specific ref
+      #   result = @client.check_runs_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", status: "in_progress")
+      #   result.total_count # => 1
+      #   result.check_runs.count # => 1
+      #   result.check_runs[0].id # => 51295429
+      #   result.check_runs[0].status # => "in_progress"
+      def check_runs_for_ref(repo, ref, options = {})
+        paginate "#{Repository.path repo}/commits/#{ref}/check-runs", options do |data, last_response|
+          data.check_runs.concat last_response.data.check_runs
+          data.total_count += last_response.data.total_count
+        end
+      end
+      alias list_check_runs_for_ref check_runs_for_ref
+
+      # List check runs in a check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @param options [Hash] A set of optional filters
+      # @option options [String] :check_name Returns check runs with the specified <tt>name</tt>
+      # @option options [String] :status Returns check runs with the specified <tt>status</tt>
+      # @option options [String] :filter Filters check runs by their <tt>completed_at</tt> timestamp
+      # @return [Sawyer::Resource] A hash representing a collection of check runs
+      # @see https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite
+      # @example List check runs in a check suite
+      #   result = @client.check_runs_for_check_suite("octocat/Hello-World", 50440400, status: "in_progress")
+      #   result.total_count # => 1
+      #   result.check_runs.count # => 1
+      #   result.check_runs[0].check_suite.id # => 50440400
+      #   result.check_runs[0].status # => "in_progress"
+      def check_runs_for_check_suite(repo, id, options = {})
+        paginate "#{Repository.path repo}/check-suites/#{id}/check-runs", options do |data, last_response|
+          data.check_runs.concat last_response.data.check_runs
+          data.total_count += last_response.data.total_count
+        end
+      end
+      alias list_check_runs_for_check_suite check_runs_for_check_suite
+
+      # Get a single check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Sawyer::Resource] A hash representing the check run
+      # @see https://developer.github.com/v3/checks/runs/#get-a-single-check-run
+      def check_run(repo, id, options = {})
+        get "#{Repository.path repo}/check-runs/#{id}", options
+      end
+
+      # List annotations for a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Array<Sawyer::Resource>] An array of hashes representing check run annotations
+      # @see https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run
+      # @example List annotations for a check run
+      #   annotations = @client.check_run_annotations("octocat/Hello-World", 51295429)
+      #   annotations.count # => 1
+      #   annotations[0].path # => "README.md"
+      #   annotations[0].message # => "Looks good!"
+      def check_run_annotations(repo, id, options = {})
+        paginate "#{Repository.path repo}/check-runs/#{id}/annotations", options
+      end
+
+      # Methods for Check Suites
+      #
+      # @see https://developer.github.com/v3/checks/suites/
+
+      # Get a single check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @return [Sawyer::Resource] A hash representing the check suite
+      # @see https://developer.github.com/v3/checks/suites/#get-a-single-check-suite
+      def check_suite(repo, id, options = {})
+        get "#{Repository.path repo}/check-suites/#{id}", options
+      end
+
+      # List check suites for a specific ref
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param ref [String] A SHA, branch name, or tag name
+      # @param options [Hash] A set of optional filters
+      # @option options [Integer] :app_id Filters check suites by GitHub App <tt>id</tt>
+      # @option options [String] :check_name Filters checks suites by the <tt>name</tt> of the check run
+      # @return [Sawyer::Resource] A hash representing a collection of check suites
+      # @see https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref
+      # @example List check suites for a specific ref
+      #   result = @client.check_suites_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", app_id: 76765)
+      #   result.total_count # => 1
+      #   result.check_suites.count # => 1
+      #   result.check_suites[0].id # => 50440400
+      #   result.check_suites[0].app.id # => 76765
+      def check_suites_for_ref(repo, ref, options = {})
+        paginate "#{Repository.path repo}/commits/#{ref}/check-suites", options do |data, last_response|
+          data.check_suites.concat last_response.data.check_suites
+          data.total_count += last_response.data.total_count
+        end
+      end
+      alias list_check_suites_for_ref check_suites_for_ref
+
+      # Set preferences for check suites on a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Preferences to set
+      # @return [Sawyer::Resource] A hash representing the repository's check suite preferences
+      # @see https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository
+      # @example Set preferences for check suites on a repository
+      #   result = @client.set_check_suite_preferences("octocat/Hello-World", auto_trigger_checks: [{ app_id: 76765, setting: false }])
+      #   result.preferences.auto_trigger_checks.count # => 1
+      #   result.preferences.auto_trigger_checks[0].app_id # => 76765
+      #   result.preferences.auto_trigger_checks[0].setting # => false
+      #   result.repository.full_name # => "octocat/Hello-World"
+      def set_check_suite_preferences(repo, options = {})
+        patch "#{Repository.path repo}/check-suites/preferences", options
+      end
+
+      # Create a check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param head_sha [String] The SHA of the commit to check
+      # @return [Sawyer::Resource] A hash representing the new check suite
+      # @see https://developer.github.com/v3/checks/suites/#create-a-check-suite
+      # @example Create a check suite
+      #   check_suite = @client.create_check_suite("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd")
+      #   check_suite.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
+      #   check_suite.status # => "queued"
+      def create_check_suite(repo, head_sha, options = {})
+        options[:head_sha] = head_sha
+
+        post "#{Repository.path repo}/check-suites", options
+      end
+
+      # Rerequest check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @return [Boolean] True if successful, raises an error otherwise
+      # @see https://developer.github.com/v3/checks/suites/#rerequest-check-suite
+      def rerequest_check_suite(repo, id, options = {})
+        post "#{Repository.path repo}/check-suites/#{id}/rerequest", options
+        true
+      end
+    end
+  end
+end

data/lib/octokit/client/code_scanning.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'zlib'
+
+module Octokit
+  class Client
+    # Methods for the code scanning alerts API
+    #
+    # @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
+      # @param file [String] Path to the SARIF file to upload
+      # @param sha [String] The SHA of the commit to which the analysis you are uploading relates
+      # @param ref [String] The full Git reference, formatted as `refs/heads/<branch name>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#upload-an-analysis-as-sarif-data
+      def upload_sarif_data(repo, file, sha, ref, options = {})
+        options[:sarif] = compress_sarif_data(file)
+        options[:commit_sha] = sha
+        options[:ref] = ref
+
+        post "#{Repository.path repo}/code-scanning/sarifs", options
+      end
+
+      # Gets information about a SARIF upload
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param sarif_id [String] The SARIF ID obtained after uploading
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#get-information-about-a-sarif-upload
+      def get_sarif_upload_information(repo, sarif_id, options = {})
+        get "#{Repository.path repo}/code-scanning/sarifs/#{sarif_id}", options
+      end
+
+      private
+
+      def compress_sarif_data(file)
+        Tempfile.create('sarif.gz') do |tempfile|
+          Zlib::GzipWriter.open(tempfile) do |gz_file|
+            gz_file.write File.binread(file)
+          end
+          [tempfile.read].pack('m0') # Base64.strict_encode64
+        end
+      end
+    end
+  end
+end