octokit 4.2.0 → 9.2.0

data/Rakefile

@@ -1,22 +1,28 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+task test: :spec
+task default: :spec
 
-task :test => :spec
-task :default => :spec
+desc 'Run RSpec'
+task :spec do
+  if Process.respond_to?(:fork)
+    sh('rspec-queue')
+  else
+    sh('rspec')
+  end
+end
 
 namespace :doc do
-  begin
-    require 'yard'
-    YARD::Rake::YardocTask.new do |task|
-      task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
-      task.options = [
-        '--output-dir', 'doc/yard',
-        '--markup', 'markdown',
-      ]
-    end
-  rescue LoadError
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+    task.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown'
+    ]
   end
+rescue LoadError
 end

data/lib/ext/sawyer/relation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'sawyer'
+
+patch = Module.new do
+  def href(options = nil)
+    # Temporary workaround for: https://github.com/octokit/octokit.rb/issues/727
+    name.to_s == 'ssh' ? @href : super
+  end
+end
+
+Sawyer::Relation.send(:prepend, patch)

data/lib/octokit/arguments.rb

@@ -1,5 +1,6 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Extracts options from method arguments
   # @private
   class Arguments < Array
@@ -7,8 +8,7 @@ module Octokit
 
     def initialize(args)
       @options = args.last.is_a?(::Hash) ? args.pop : {}
-      super(args)
+      super
     end
-
   end
 end

data/lib/octokit/authentication.rb

@@ -1,7 +1,15 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Authentication methods for {Octokit::Client}
   module Authentication
+    # In Faraday 2.x, the authorization middleware uses new interface
+    FARADAY_BASIC_AUTH_KEYS =
+      if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+        %i[authorization basic]
+      else
+        [:basic_auth]
+      end
 
     # Indicates if the client was supplied  Basic Auth
     # username and password
@@ -21,6 +29,14 @@ module Octokit
       !!@access_token
     end
 
+    # Indicates if the client was supplied a bearer token
+    #
+    # @see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
+    # @return [Boolean]
+    def bearer_authenticated?
+      !!@bearer_token
+    end
+
     # Indicates if the client was supplied an OAuth
     # access token or Basic Auth username and password
     #
@@ -35,22 +51,13 @@ module Octokit
     # requests at a higher rate limit
     #
     # @see https://developer.github.com/v3/#unauthenticated-rate-limited-requests
-    # @return Boolean
+    # @return [Boolean]
     def application_authenticated?
-      !!application_authentication
+      !!(@client_id && @client_secret)
     end
 
     private
 
-    def application_authentication
-      if @client_id && @client_secret
-        {
-          :client_id     => @client_id,
-          :client_secret => @client_secret
-        }
-      end
-    end
-
     def login_from_netrc
       return unless netrc?
 
@@ -67,8 +74,7 @@ module Octokit
         self.password = creds.shift
       end
     rescue LoadError
-      octokit_warn "Please install netrc gem for .netrc support"
+      octokit_warn 'Please install netrc gem for .netrc support'
     end
-
   end
 end

data/lib/octokit/client/actions_artifacts.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Actions Artifacts API
+    #
+    # @see https://developer.github.com/v3/actions/artifacts
+    module ActionsArtifacts
+      # List all artifacts for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Sawyer::Resource] the total count and an array of artifacts
+      # @see https://developer.github.com/v3/actions/artifacts#list-artifacts-for-a-repository
+      def repository_artifacts(repo, options = {})
+        paginate "#{Repository.path repo}/actions/artifacts", options do |data, last_response|
+          data.artifacts.concat last_response.data.artifacts
+        end
+      end
+
+      # List all artifacts for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param workflow_run_id [Integer] Id of a workflow run
+      #
+      # @return [Sawyer::Resource] the total count and an array of artifacts
+      # @see https://docs.github.com/en/rest/actions/artifacts#list-workflow-run-artifacts
+      def workflow_run_artifacts(repo, workflow_run_id, options = {})
+        paginate "#{Repository.path repo}/actions/runs/#{workflow_run_id}/artifacts", options do |data, last_response|
+          data.artifacts.concat last_response.data.artifacts
+        end
+      end
+
+      # Get an artifact
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of an artifact
+      #
+      # @return [Sawyer::Resource] Artifact information
+      # @see https://docs.github.com/en/rest/actions/artifacts#get-an-artifact
+      def artifact(repo, id, options = {})
+        get "#{Repository.path repo}/actions/artifacts/#{id}", options
+      end
+
+      # Get a download URL for an artifact
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of an artifact
+      #
+      # @return [String] URL to the .zip archive of the artifact
+      # @see https://docs.github.com/en/rest/actions/artifacts#download-an-artifact
+      def artifact_download_url(repo, id, options = {})
+        url = "#{Repository.path repo}/actions/artifacts/#{id}/zip"
+
+        response = client_without_redirects.head(url, options)
+        response.headers['Location']
+      end
+
+      # Delete an artifact
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of an artifact
+      #
+      # @return [Boolean] Return true if the artifact was successfully deleted
+      # @see https://docs.github.com/en/rest/actions/artifacts#delete-an-artifact
+      def delete_artifact(repo, id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/actions/artifacts/#{id}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/actions_secrets.rb

@@ -0,0 +1,161 @@
+# 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_actions_public_key(repo)
+        get "#{Repository.path repo}/actions/secrets/public-key"
+      end
+
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://developer.github.com/v3/actions/secrets/#get-your-public-key
+      def get_org_actions_public_key(org)
+        get "#{Organization.path org}/actions/secrets/public-key"
+      end
+
+      # List secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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_actions_secrets(repo)
+        paginate "#{Repository.path repo}/actions/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://developer.github.com/v3/actions/secrets/#list-organization-secrets
+      def list_org_actions_secrets(org)
+        paginate "#{Organization.path org}/actions/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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_actions_secret(repo, name)
+        get "#{Repository.path repo}/actions/secrets/#{name}"
+      end
+
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at and updated_at
+      # @see https://developer.github.com/v3/actions/secrets/#get-a-secret
+      def get_org_actions_secret(org, name)
+        get "#{Organization.path org}/actions/secrets/#{name}"
+      end
+
+      # Create or update secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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_actions_secret(repo, name, options)
+        put "#{Repository.path repo}/actions/secrets/#{name}", options
+      end
+
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret
+      def create_or_update_org_actions_secret(org, name, options)
+        put "#{Organization.path org}/actions/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository
+      def delete_actions_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
+      end
+
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret
+      def delete_org_actions_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/actions/secrets/#{name}"
+      end
+
+      # Get environment public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-public-key
+      def get_actions_environment_public_key(repo, environment)
+        get "#{Repository.path repo}/environments/#{environment}/secrets/public-key"
+      end
+
+      # List environment secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @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-environment-secrets
+      def list_actions_environment_secrets(repo, environment)
+        paginate "#{Repository.path repo}/environments/#{environment}/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get an environment secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at and updated_at
+      # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-secret
+      def get_actions_environment_secret(repo, environment, name)
+        get "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
+      end
+
+      # Create or update an environment secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/actions/secrets#create-or-update-an-environment-secret
+      def create_or_update_actions_environment_secret(repo, environment, name, options)
+        put "#{Repository.path repo}/environments/#{environment}/secrets/#{name}", options
+      end
+
+      # Delete environment secret
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/actions/secrets#delete-an-environment-secret
+      def delete_actions_environment_secret(repo, environment, name)
+        boolean_from_response :delete, "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
+      end
+    end
+  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

@@ -0,0 +1,125 @@
+# 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
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param workflow [Integer, String] Id or file name of the workflow
+      # @option options [String] :actor Optional filtering by a user
+      # @option options [String] :branch Optional filtering by a branch
+      # @option options [String] :event Optional filtering by the event type
+      # @option options [String] :status Optional filtering by a status or conclusion
+      #
+      # @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 do |data, last_response|
+          data.workflow_runs.concat last_response.data.workflow_runs
+        end
+      end
+      alias list_workflow_runs workflow_runs
+
+      # List all workflow runs for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [String] :actor Optional filtering by the login of a user
+      # @option options [String] :branch Optional filtering by a branch
+      # @option options [String] :event Optional filtering by the event type (e.g. push, pull_request, issue)
+      # @option options [String] :status Optional filtering by a status or conclusion (e.g. success, completed...)
+      #
+      # @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 do |data, last_response|
+          data.workflow_runs.concat last_response.data.workflow_runs
+        end
+      end
+      alias list_repository_workflow_runs repository_workflow_runs
+
+      # Get a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Sawyer::Resource] Run information
+      # @see https://developer.github.com/v3/actions/workflow-runs/#get-a-workflow-run
+      def workflow_run(repo, id, options = {})
+        get "#{Repository.path repo}/actions/runs/#{id}", options
+      end
+
+      # Re-runs a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Boolean] Returns true if the re-run request was accepted
+      # @see https://developer.github.com/v3/actions/workflow-runs/#re-run-a-workflow
+      def rerun_workflow_run(repo, id, options = {})
+        boolean_from_response :post, "#{Repository.path repo}/actions/runs/#{id}/rerun", options
+      end
+
+      # Cancels a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Boolean] Returns true if the cancellation was accepted
+      # @see https://developer.github.com/v3/actions/workflow-runs/#cancel-a-workflow-run
+      def cancel_workflow_run(repo, id, options = {})
+        boolean_from_response :post, "#{Repository.path repo}/actions/runs/#{id}/cancel", options
+      end
+
+      # Deletes a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Boolean] Returns true if the run is deleted
+      # @see https://docs.github.com/en/rest/reference/actions#delete-a-workflow-run
+      def delete_workflow_run(repo, id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/actions/runs/#{id}", options
+      end
+
+      # Get a download url for archived log files of a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [String] URL to the archived log files of the run
+      # @see https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs
+      def workflow_run_logs(repo, id, options = {})
+        url = "#{Repository.path repo}/actions/runs/#{id}/logs"
+
+        response = client_without_redirects.head(url, options)
+        response.headers['Location']
+      end
+
+      # 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
+      #
+      # @return [Boolean] Returns true if the logs are deleted
+      # @see https://developer.github.com/v3/actions/workflow-runs/#delete-workflow-run-logs
+      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

@@ -0,0 +1,68 @@
+# 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
+      #
+      # @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 do |data, last_response|
+          data.workflows.concat last_response.data.workflows
+        end
+      end
+      alias list_workflows workflows
+
+      # Get single workflow in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      #
+      # @return [Sawyer::Resource] A single workflow
+      # @see https://developer.github.com/v3/actions/workflows/#get-a-workflow
+      def workflow(repo, id, options = {})
+        get "#{Repository.path repo}/actions/workflows/#{id}", options
+      end
+
+      # Create a workflow dispatch event
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      # @param ref [String] A SHA, branch name, or tag name
+      #
+      # @return [Boolean] True if event was dispatched, false otherwise
+      # @see https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event
+      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