octokit 4.6.0 → 4.21.0

data/lib/octokit/client/actions_workflow_runs.rb

@@ -0,0 +1,105 @@
+module Octokit
+  class Client
+    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
+
+      # Delets 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
+    end
+  end
+end

data/lib/octokit/client/actions_workflows.rb

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

data/lib/octokit/client/apps.rb

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

data/lib/octokit/client/authorizations.rb

@@ -59,14 +59,18 @@ module Octokit
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.create_authorization({:idempotent => true, :client_id => 'xxxx', :client_secret => 'yyyy', :scopes => ["user"]})
       def create_authorization(options = {})
-        # Techincally we can omit scopes as GitHub has a default, however the
+        # Technically we can omit scopes as GitHub has a default, however the
         # API will reject us if we send a POST request with an empty body.
-
+        options = options.dup
         if options.delete :idempotent
           client_id, client_secret = fetch_client_id_and_secret(options)
           raise ArgumentError.new("Client ID and Secret required for idempotent authorizations") unless client_id && client_secret
 
-          if fingerprint = options.delete(:fingerprint)
+          # Remove the client_id from the body otherwise
+          # this will result in a 422.
+          options.delete(:client_id)
+
+          if (fingerprint = options.delete(:fingerprint))
             put "authorizations/clients/#{client_id}/#{fingerprint}", options.merge(:client_secret => client_secret)
           else
             put "authorizations/clients/#{client_id}", options.merge(:client_secret => client_secret)
@@ -122,6 +126,7 @@ module Octokit
       # @return [Array<String>] OAuth scopes
       # @see https://developer.github.com/v3/oauth/#scopes
       def scopes(token = @access_token, options = {})
+        options= options.dup
         raise ArgumentError.new("Access token required") if token.nil?
 
         auth = { "Authorization" => "token #{token}" }
@@ -135,74 +140,6 @@ module Octokit
           sort
       end
 
-      # Check if a token is valid.
-      #
-      # Applications can check if a token is valid without rate limits.
-      #
-      # @param token [String] 40 character GitHub OAuth access token
-      #
-      # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#check-an-authorization
-      # @example
-      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
-      #  client.check_application_authorization('deadbeef1234567890deadbeef987654321')
-      def check_application_authorization(token, options = {})
-        opts = options.dup
-        key    = opts.delete(:client_id)     || client_id
-        secret = opts.delete(:client_secret) || client_secret
-
-        as_app(key, secret) do |app_client|
-          app_client.get "/applications/#{client_id}/tokens/#{token}", opts
-        end
-      end
-
-      # Reset a token
-      #
-      # Applications can reset a token without requiring a user to re-authorize.
-      #
-      # @param token [String] 40 character GitHub OAuth access token
-      #
-      # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization
-      # @example
-      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
-      #  client.reset_application_authorization('deadbeef1234567890deadbeef987654321')
-      def reset_application_authorization(token, options = {})
-        opts = options.dup
-        key    = opts.delete(:client_id)     || client_id
-        secret = opts.delete(:client_secret) || client_secret
-
-        as_app(key, secret) do |app_client|
-          app_client.post "/applications/#{client_id}/tokens/#{token}", opts
-        end
-      end
-
-      # Revoke a token
-      #
-      # Applications can revoke (delete) a token
-      #
-      # @param token [String] 40 character GitHub OAuth access token
-      #
-      # @return [Boolean] Result
-      # @see https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application
-      # @example
-      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
-      #  client.revoke_application_authorization('deadbeef1234567890deadbeef987654321')
-      def revoke_application_authorization(token, options = {})
-        opts = options.dup
-        key    = opts.delete(:client_id)     || client_id
-        secret = opts.delete(:client_secret) || client_secret
-
-        as_app(key, secret) do |app_client|
-          app_client.delete "/applications/#{client_id}/tokens/#{token}", opts
-
-          app_client.last_response.status == 204
-        end
-      rescue Octokit::NotFound
-        false
-      end
-      alias :delete_application_authorization :revoke_application_authorization
-
       # Revoke all tokens for an app
       #
       # Applications can revoke all of their tokens in a single request
@@ -226,14 +163,15 @@ module Octokit
       # @example
       #   @client.authorize_url('xxxx')
       def authorize_url(app_id = client_id, options = {})
+        opts = options.dup
         if app_id.to_s.empty?
-          raise Octokit::ApplicationCredentialsRequired.new "client_id required"
+          raise Octokit::ApplicationCredentialsRequired, "client_id required"
         end
-        authorize_url = options.delete(:endpoint) || Octokit.web_endpoint
+        authorize_url = opts.delete(:endpoint) || Octokit.web_endpoint
         authorize_url << "login/oauth/authorize?client_id=#{app_id}"
 
         require 'cgi'
-        options.each do |key, value|
+        opts.each do |key, value|
           authorize_url << "&#{key}=#{CGI.escape value}"
         end