octokit 4.22.0 → 7.0.0

data/lib/octokit/client/actions_secrets.rb

@@ -1,28 +1,29 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Actions Secrets API
     #
     # @see https://developer.github.com/v3/actions/secrets/
     module ActionsSecrets
-
       # Get public key for secrets encryption
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Hash] key_id and key
       # @see https://developer.github.com/v3/actions/secrets/#get-your-public-key
-      def get_public_key(repo)
+      def get_actions_public_key(repo)
         get "#{Repository.path repo}/actions/secrets/public-key"
       end
 
-
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @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-secrets-for-a-repository
-      def list_secrets(repo)
-        paginate "#{Repository.path repo}/actions/secrets"
+      def list_actions_secrets(repo)
+        paginate "#{Repository.path repo}/actions/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
       end
 
       # Get a secret
@@ -31,7 +32,7 @@ module Octokit
       # @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_secret(repo, name)
+      def get_actions_secret(repo, name)
         get "#{Repository.path repo}/actions/secrets/#{name}"
       end
 
@@ -41,7 +42,7 @@ module Octokit
       # @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-for-a-repository
-      def create_or_update_secret(repo, name, options)
+      def create_or_update_actions_secret(repo, name, options)
         put "#{Repository.path repo}/actions/secrets/#{name}", options
       end
 
@@ -50,7 +51,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param name [String] Name of secret
       # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository
-      def delete_secret(repo, name)
+      def delete_actions_secret(repo, name)
         boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
       end
     end

data/lib/octokit/client/actions_workflow_jobs.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Actions Workflows jobs API
+    #
+    # @see https://docs.github.com/rest/actions/workflow-jobs
+    module ActionsWorkflowJobs
+      # Get a job for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param job_id [Integer, String] Id of the job
+      #
+      # @return [Sawyer::Resource] Job information
+      # @see https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
+      def workflow_run_job(repo, job_id, options = {})
+        get "#{Repository.path repo}/actions/jobs/#{job_id}", options
+      end
+
+      # Download job logs for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param job_id [Integer, String] Id of the job
+      #
+      # @return [String] URL to the archived log files of the job
+      # @see https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
+      def workflow_run_job_logs(repo, job_id, options = {})
+        url = "#{Repository.path repo}/actions/jobs/#{job_id}/logs"
+
+        response = client_without_redirects.head(url, options)
+        response.headers['Location']
+      end
+
+      # List jobs for a workflow run attempt
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param run_id [Integer, String] Id of the workflow run
+      # @param attempt_number [Integer, String] Attempt number of the workflow run
+      #
+      # @return [Sawyer::Resource] Jobs information
+      # @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
+      def workflow_run_attempt_jobs(repo, run_id, attempt_number, options = {})
+        paginate "#{Repository.path repo}/actions/runs/#{run_id}/attempts/#{attempt_number}/jobs", options do |data, last_response|
+          data.jobs.concat last_response.data.jobs
+        end
+      end
+      alias list_workflow_run_attempt_jobs workflow_run_attempt_jobs
+
+      # List jobs for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param run_id [Integer, String] Id of the workflow run
+      # @option options [String] :filter Optional filtering by a `completed_at` timestamp
+      #
+      # @return [Sawyer::Resource] Jobs information
+      # @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
+      def workflow_run_jobs(repo, run_id, options = {})
+        paginate "#{Repository.path repo}/actions/runs/#{run_id}/jobs", options do |data, last_response|
+          data.jobs.concat last_response.data.jobs
+        end
+      end
+      alias list_workflow_run_jobs workflow_run_jobs
+    end
+  end
+end

data/lib/octokit/client/actions_workflow_runs.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
+    # Methods for the Actions Workflows runs API
+    #
+    # @see https://docs.github.com/rest/actions/workflow-runs
     module ActionsWorkflowRuns
       # List all runs for a repository workflow
       #
@@ -13,7 +18,9 @@ module Octokit
       # @return [Sawyer::Resource] the total count and an array of workflows
       # @see https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs
       def workflow_runs(repo, workflow, options = {})
-        paginate "#{Repository.path repo}/actions/workflows/#{workflow}/runs", options
+        paginate "#{Repository.path repo}/actions/workflows/#{workflow}/runs", options do |data, last_response|
+          data.workflow_runs.concat last_response.data.workflow_runs
+        end
       end
       alias list_workflow_runs workflow_runs
 
@@ -28,7 +35,9 @@ module Octokit
       # @return [Sawyer::Resource] the total count and an array of workflows
       # @see https://developer.github.com/v3/actions/workflow-runs/#list-repository-workflow-runs
       def repository_workflow_runs(repo, options = {})
-        paginate "#{Repository.path repo}/actions/runs", options
+        paginate "#{Repository.path repo}/actions/runs", options do |data, last_response|
+          data.workflow_runs.concat last_response.data.workflow_runs
+        end
       end
       alias list_repository_workflow_runs repository_workflow_runs
 
@@ -90,7 +99,7 @@ module Octokit
         response.headers['Location']
       end
 
-      # Delets all log files of a workflow run
+      # Delete all log files of a workflow run
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param id [Integer] Id of a workflow run
@@ -100,6 +109,17 @@ module Octokit
       def delete_workflow_run_logs(repo, id, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/actions/runs/#{id}/logs", options
       end
+
+      # Get workflow run usage
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Sawyer::Resource] Run usage
+      # @see https://developer.github.com/v3/actions/workflow-runs/#get-workflow-run-usage
+      def workflow_run_usage(repo, id, options = {})
+        get "#{Repository.path repo}/actions/runs/#{id}/timing", options
+      end
     end
   end
 end

data/lib/octokit/client/actions_workflows.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
     # Methods for the Actions Workflows API
     #
     # @see https://developer.github.com/v3/actions/workflows
     module ActionsWorkflows
-
       # Get the workflows in a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -12,7 +13,9 @@ module Octokit
       # @return [Sawyer::Resource] the total count and an array of workflows
       # @see https://developer.github.com/v3/actions/workflows/#list-repository-workflows
       def workflows(repo, options = {})
-        paginate "#{Repository.path repo}/actions/workflows", options
+        paginate "#{Repository.path repo}/actions/workflows", options do |data, last_response|
+          data.workflows.concat last_response.data.workflows
+        end
       end
       alias list_workflows workflows
 
@@ -38,6 +41,28 @@ module Octokit
       def workflow_dispatch(repo, id, ref, options = {})
         boolean_from_response :post, "#{Repository.path repo}/actions/workflows/#{id}/dispatches", options.merge({ ref: ref })
       end
+
+      # Enable a workflow
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      #
+      # @return [Boolean] True if workflow was enabled, false otherwise
+      # @see https://docs.github.com/en/rest/actions/workflows#enable-a-workflow
+      def workflow_enable(repo, id, options = {})
+        boolean_from_response :put, "#{Repository.path repo}/actions/workflows/#{id}/enable", options
+      end
+
+      # Disable a workflow
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      #
+      # @return [Boolean] True if workflow was disabled, false otherwise
+      # @see https://docs.github.com/en/rest/actions/workflows#disable-a-workflow
+      def workflow_disable(repo, id, options = {})
+        boolean_from_response :put, "#{Repository.path repo}/actions/workflows/#{id}/disable", options
+      end
     end
   end
 end

data/lib/octokit/client/apps.rb

@@ -1,9 +1,9 @@
+# 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
@@ -12,7 +12,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] App information
       def app(options = {})
-        get "app", options
+        get 'app', options
       end
 
       # Find all installations that belong to an App
@@ -23,16 +23,16 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] the total_count and an array of installations
       def find_app_installations(options = {})
-        paginate "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."
+          '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
@@ -45,7 +45,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] the total_count and an array of installations
       def find_user_installations(options = {})
-        paginate("user/installations", options) do |data, last_response|
+        paginate('user/installations', options) do |data, last_response|
           data.installations.concat last_response.data.installations
         end
       end
@@ -76,10 +76,10 @@ module Octokit
 
       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."
+          '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
@@ -128,7 +128,7 @@ module Octokit
       #
       # @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|
+        paginate('installation/repositories', options) do |data, last_response|
           data.repositories.concat last_response.data.repositories
         end
       end
@@ -136,10 +136,10 @@ module Octokit
 
       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."
+          '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
@@ -160,10 +160,10 @@ module Octokit
 
       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."
+          '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
@@ -184,10 +184,10 @@ module Octokit
 
       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."
+          '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

data/lib/octokit/client/checks.rb

@@ -1,11 +1,11 @@
+# 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/
@@ -60,9 +60,12 @@ module Octokit
       #   result.check_runs[0].id # => 51295429
       #   result.check_runs[0].status # => "in_progress"
       def check_runs_for_ref(repo, ref, options = {})
-        get "#{Repository.path repo}/commits/#{ref}/check-runs", 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
+      alias list_check_runs_for_ref check_runs_for_ref
 
       # List check runs in a check suite
       #
@@ -81,9 +84,12 @@ module Octokit
       #   result.check_runs[0].check_suite.id # => 50440400
       #   result.check_runs[0].status # => "in_progress"
       def check_runs_for_check_suite(repo, id, options = {})
-        get "#{Repository.path repo}/check-suites/#{id}/check-runs", 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
+      alias list_check_runs_for_check_suite check_runs_for_check_suite
 
       # Get a single check run
       #
@@ -107,7 +113,7 @@ module Octokit
       #   annotations[0].path # => "README.md"
       #   annotations[0].message # => "Looks good!"
       def check_run_annotations(repo, id, options = {})
-        get "#{Repository.path repo}/check-runs/#{id}/annotations", options
+        paginate "#{Repository.path repo}/check-runs/#{id}/annotations", options
       end
 
       # Methods for Check Suites
@@ -140,9 +146,12 @@ module Octokit
       #   result.check_suites[0].id # => 50440400
       #   result.check_suites[0].app.id # => 76765
       def check_suites_for_ref(repo, ref, options = {})
-        get "#{Repository.path repo}/commits/#{ref}/check-suites", 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
+      alias list_check_suites_for_ref check_suites_for_ref
 
       # Set preferences for check suites on a repository
       #

data/lib/octokit/client/code_scanning.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'base64'
+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
+      # 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
+          Base64.strict_encode64(tempfile.read)
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/codespaces_secrets.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Codespaces Secrets API
+    #
+    # @see https://docs.github.com/en/rest/codespaces/
+    module CodespacesSecrets
+      # Get public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets#get-a-repository-public-key
+      def get_codespaces_public_key(repo)
+        get "#{Repository.path repo}/codespaces/secrets/public-key"
+      end
+
+      # List secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_codespaces_secrets(repo)
+        paginate "#{Repository.path repo}/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
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_codespaces_secret(repo, name)
+        get "#{Repository.path repo}/codespaces/secrets/#{name}"
+      end
+
+      # Create or update secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_codespaces_secret(repo, name, options)
+        put "#{Repository.path repo}/codespaces/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_codespaces_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/commit_branches.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Branches for HEAD API
     #
     # @see https://developer.github.com/v3/repos/commits/
     module CommitBranches
-
       # List branches for a single HEAD commit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

data/lib/octokit/client/commit_comments.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Comments API
     #
     # @see https://developer.github.com/v3/repos/comments/
     module CommitComments
-
       # List all commit comments
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -53,12 +53,12 @@ module Octokit
       #   comment.path # => "README.md"
       #   comment.line # => 10
       #   comment.position # => 1
-      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options = {})
+      def create_commit_comment(repo, sha, body, path = nil, line = nil, position = nil, options = {})
         params = {
-          :body => body,
-          :path => path,
-          :line => line,
-          :position => position
+          body: body,
+          path: path,
+          line: line,
+          position: position
         }
         post "#{Repository.path repo}/commits/#{sha}/comments", options.merge(params)
       end
@@ -76,7 +76,7 @@ module Octokit
       #   comment.body # => "Updated commit comment"
       def update_commit_comment(repo, id, body, options = {})
         params = {
-          :body => body
+          body: body
         }
         patch "#{Repository.path repo}/comments/#{id}", options.merge(params)
       end

data/lib/octokit/client/commit_pulls.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Pulls API
     #
     # @see https://developer.github.com/v3/repos/comments/
     module CommitPulls
-
       # List pulls for a single commit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository