octokit 4.6.2 → 5.2.0

data/Rakefile

@@ -1,11 +1,13 @@
+# 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
 
 namespace :doc do
   begin
@@ -14,7 +16,7 @@ namespace :doc do
       task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
       task.options = [
         '--output-dir', 'doc/yard',
-        '--markup', 'markdown',
+        '--markup', 'markdown'
       ]
     end
   rescue LoadError

data/lib/ext/sawyer/relation.rb

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

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
@@ -9,6 +10,5 @@ module Octokit
       @options = args.last.is_a?(::Hash) ? args.pop : {}
       super(args)
     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_secrets.rb

@@ -0,0 +1,57 @@
+# 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)
+        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"
+      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_secret(repo, name)
+        get "#{Repository.path repo}/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_secret(repo, name, options)
+        put "#{Repository.path repo}/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_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/actions_workflow_jobs.rb

@@ -0,0 +1,61 @@
+# 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
+      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
+      end
+      alias list_workflow_run_jobs workflow_run_jobs
+    end
+  end
+end

data/lib/octokit/client/actions_workflow_runs.rb

@@ -0,0 +1,121 @@
+# 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
+      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
+      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,66 @@
+# 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
+      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

data/lib/octokit/client/apps.rb

@@ -0,0 +1,222 @@
+# 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
+    end
+  end
+end