octokit 4.15.0 → 4.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acde45338bbfff0aac4a04d4e9867b5345f1b1123e58fdc80d0c69d01a1f0877
-  data.tar.gz: 65324c811d6edbfb510ef41a2ffbe54cc3197d64cfc018e1997858e8d59a5e20
+  metadata.gz: be4c54d083639a915bef0eb235748b93351f17f2a98e204b7b9f2899c156f2f6
+  data.tar.gz: 21998779cea8f95e63b1814dc264102c1ac69c9d66fef6694ef6442554419bbc
 SHA512:
-  metadata.gz: dc30ba3288f921516c9aa78f27389c91840522aedb97e3a0c1fb21d672b69586d7096b12affc25a7cd859906da8fe6376a9b5244ca667a5977aad400ec65eff0
-  data.tar.gz: cdd80e10b58cfa64d2ed18d0376c762ce478b6efddb41e1581f529c3c1d265a0fb67c337398a7e9beee307045b6468732d7d11db2b5b54797734dac917e6029b
+  metadata.gz: 14221c5912859f6fa1a9f3dce7d7ee1cb6b5730bc1a95c997e84ff2972f23a3e8eaad723acbabd57982afadc1f4bb1538af510bd10583e21e0f208c7712ce1e6
+  data.tar.gz: 23300ee9b4e73fc660a391018efbc969742dbdc9740faa57ed7609853830689cc1edcca8d445df2d939f2d7353056f828b53ad44b33269573ed06a8e93b8dbd4

data/CONTRIBUTING.md

@@ -1,8 +1,8 @@
 ## Submitting a Pull Request
 
 0. Read our [Code of Conduct](CODE_OF_CONDUCT.md).
-1. Check out Hacking on Octokit in the README guide for
-   bootstrapping the project for local development.
+1. Check out [Hacking on Octokit](README.md#hacking-on-octokitrb) in the
+   README for bootstrapping the project for local development.
 2. [Fork the repository.][fork]
 3. [Create a topic branch.][branch]
 4. Add specs for your unimplemented feature or bug fix.
@@ -18,8 +18,6 @@
     add "[ci skip]" to your commit message to avoid needless CI builds.
 12. [Submit a pull request.][pr]
 
-Please abide by
-
 [fork]: https://help.github.com/articles/fork-a-repo
 [branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
 [pr]: https://help.github.com/articles/using-pull-requests

data/README.md

@@ -2,7 +2,7 @@
 
 Ruby toolkit for the GitHub API.
 
-![logo](http://cl.ly/image/3Y013H0A2z3z/gundam-ruby.png)
+![logo](https://docs.github.com/assets/images/gundamcat.png)
 
 Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
 [major version][semver].
@@ -41,7 +41,7 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
     1. [Debugging](#debugging)
     2. [Caching](#caching)
 14. [Hacking on Octokit.rb](#hacking-on-octokitrb)
-    1. [Code of Conduction](#code_of_conduct)
+    1. [Code of Conduct](#code-of-conduct)
     2. [Running and writing new tests](#running-and-writing-new-tests)
 15. [Supported Ruby Versions](#supported-ruby-versions)
 16. [Versioning](#versioning)
@@ -86,10 +86,10 @@ Access the library in Ruby:
 
 ```ruby
 # Provide authentication credentials
-client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
+client = Octokit::Client.new(:access_token => 'personal_access_token')
 
-# Set access_token instead of login and password if you use personal access token
-# client = Octokit::Client.new(:access_token => '[personal_access_token]!')
+# You can still use the username/password syntax by replacing the password value with your PAT.
+# client = Octokit::Client.new(:login => 'defunkt', :password => 'personal_access_token')
 
 # Fetch the current user
 client.user
@@ -323,7 +323,7 @@ custom pattern for traversing large lists.
 
 ## Working with GitHub Enterprise
 
-With a bit of setup, you can also use Octokit with your Github Enterprise instance.
+With a bit of setup, you can also use Octokit with your GitHub Enterprise instance.
 
 ### Interacting with the GitHub.com APIs in GitHub Enterprise
 
@@ -651,7 +651,7 @@ to run a Ruby console to poke on Octokit, you can crank one up with:
 
     script/console
 
-Using the scripts in `./scripts` instead of `bundle exec rspec`, `bundle
+Using the scripts in `./script` instead of `bundle exec rspec`, `bundle
 console`, etc.  ensures your dependencies are up-to-date.
 
 ### Code of Conduct
@@ -713,16 +713,12 @@ when writing new specs.
 
 ## Supported Ruby Versions
 
-This library aims to support and is [tested against][travis] the following Ruby
+This library aims to support and is [tested against][actions] the following Ruby
 implementations:
 
-* Ruby 2.0
-* Ruby 2.1
-* Ruby 2.2
-* Ruby 2.3
-* Ruby 2.4
 * Ruby 2.5
 * Ruby 2.6
+* Ruby 2.7
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 
@@ -737,7 +733,7 @@ implementation, you will be responsible for providing patches in a timely
 fashion. If critical issues for a particular implementation exist at the time
 of a major release, support for that Ruby version may be dropped.
 
-[travis]: https://travis-ci.org/octokit/octokit.rb
+[actions]: https://github.com/octokit/octokit.rb/actions
 
 ## Versioning
 

data/lib/octokit/authentication.rb

@@ -43,22 +43,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?
 

data/lib/octokit/client.rb

@@ -10,12 +10,16 @@ require 'octokit/repository'
 require 'octokit/user'
 require 'octokit/organization'
 require 'octokit/preview'
+require 'octokit/client/actions_secrets'
+require 'octokit/client/actions_workflows'
+require 'octokit/client/actions_workflow_runs'
 require 'octokit/client/apps'
 require 'octokit/client/authorizations'
 require 'octokit/client/checks'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
 require 'octokit/client/commit_pulls'
+require 'octokit/client/commit_branches'
 require 'octokit/client/community_profile'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
@@ -35,6 +39,7 @@ require 'octokit/client/markdown'
 require 'octokit/client/marketplace'
 require 'octokit/client/milestones'
 require 'octokit/client/notifications'
+require 'octokit/client/oauth_applications'
 require 'octokit/client/objects'
 require 'octokit/client/organizations'
 require 'octokit/client/pages'
@@ -70,11 +75,13 @@ module Octokit
     include Octokit::Connection
     include Octokit::Preview
     include Octokit::Warnable
+    include Octokit::Client::ActionsSecrets
     include Octokit::Client::Authorizations
     include Octokit::Client::Checks
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
     include Octokit::Client::CommitPulls
+    include Octokit::Client::CommitBranches
     include Octokit::Client::CommunityProfile
     include Octokit::Client::Contents
     include Octokit::Client::Deployments
@@ -85,6 +92,8 @@ module Octokit
     include Octokit::Client::Gists
     include Octokit::Client::Gitignore
     include Octokit::Client::Hooks
+    include Octokit::Client::ActionsWorkflows
+    include Octokit::Client::ActionsWorkflowRuns
     include Octokit::Client::Apps
     include Octokit::Client::Issues
     include Octokit::Client::Labels
@@ -95,6 +104,7 @@ module Octokit
     include Octokit::Client::Marketplace
     include Octokit::Client::Milestones
     include Octokit::Client::Notifications
+    include Octokit::Client::OauthApplications
     include Octokit::Client::Objects
     include Octokit::Client::Organizations
     include Octokit::Client::Pages

data/lib/octokit/client/actions_secrets.rb

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

@@ -4,16 +4,26 @@ module Octokit
     # 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/#find-installations
+      # @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 = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate "app/installations", opts
+        paginate "app/installations", options
       end
       alias find_installations find_app_installations
 
@@ -31,12 +41,11 @@ module Octokit
       #
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#list-installations-for-user
+      # @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 = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate("user/installations", opts) do |data, last_response|
+        paginate("user/installations", options) do |data, last_response|
           data.installations.concat last_response.data.installations
         end
       end
@@ -45,12 +54,11 @@ module Octokit
       #
       # @param id [Integer] Installation id
       #
-      # @see https://developer.github.com/v3/apps/#get-a-single-installation
+      # @see https://developer.github.com/v3/apps/#get-an-installation
       #
       # @return [Sawyer::Resource] Installation information
       def installation(id, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "app/installations/#{id}", opts
+        get "app/installations/#{id}", options
       end
 
       # Create a new installation token
@@ -58,12 +66,11 @@ module Octokit
       # @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/#find-installations
+      # @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 = {})
-        opts = ensure_api_media_type(:integrations, options)
-        post "app/installations/#{installation}/access_tokens", opts
+        post "app/installations/#{installation}/access_tokens", options
       end
       alias create_installation_access_token create_app_installation_access_token
 
@@ -82,12 +89,11 @@ module Octokit
       # @param organization [String] Organization GitHub login
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-organization-installation
+      # @see https://developer.github.com/v3/apps/#get-an-organization-installation
       #
       # @return [Sawyer::Resource] Installation information
       def find_organization_installation(organization, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "#{Organization.path(organization)}/installation", opts
+        get "#{Organization.path(organization)}/installation", options
       end
 
       # Enables an app to find the repository's installation information.
@@ -95,12 +101,11 @@ module Octokit
       # @param repo [String] A GitHub repository
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-repository-installation
+      # @see https://developer.github.com/v3/apps/#get-a-repository-installation
       #
       # @return [Sawyer::Resource] Installation information
       def find_repository_installation(repo, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "#{Repository.path(repo)}/installation", opts
+        get "#{Repository.path(repo)}/installation", options
       end
 
       # Enables an app to find the user's installation information.
@@ -108,23 +113,22 @@ module Octokit
       # @param user [String] GitHub user login
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-user-installation
+      # @see https://developer.github.com/v3/apps/#get-a-user-installation
       #
       # @return [Sawyer::Resource] Installation information
       def find_user_installation(user, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "#{User.path(user)}/installation", opts
+        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 = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate("installation/repositories", opts) do |data, last_response|
+        paginate("installation/repositories", options) do |data, last_response|
           data.repositories.concat last_response.data.repositories
         end
       end
@@ -150,8 +154,7 @@ module Octokit
       #
       # @return [Boolean] Success
       def add_repository_to_app_installation(installation, repo, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        boolean_from_response :put, "user/installations/#{installation}/repositories/#{repo}", opts
+        boolean_from_response :put, "user/installations/#{installation}/repositories/#{repo}", options
       end
       alias add_repo_to_installation add_repository_to_app_installation
 
@@ -175,8 +178,7 @@ module Octokit
       #
       # @return [Boolean] Success
       def remove_repository_from_app_installation(installation, repo, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        boolean_from_response :delete, "user/installations/#{installation}/repositories/#{repo}", opts
+        boolean_from_response :delete, "user/installations/#{installation}/repositories/#{repo}", options
       end
       alias remove_repo_from_installation remove_repository_from_app_installation
 
@@ -195,12 +197,11 @@ module Octokit
       # @param installation [Integer] The id of a GitHub App Installation
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps/
+      # @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 = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate("user/installations/#{installation}/repositories", opts) do |data, last_response|
+        paginate("user/installations/#{installation}/repositories", options) do |data, last_response|
           data.repositories.concat last_response.data.repositories
         end
       end
@@ -214,8 +215,7 @@ module Octokit
       #
       # @return [Boolean] Success
       def delete_installation(installation, options = {})
-        opts = ensure_api_media_type(:uninstall_github_app, options)
-        boolean_from_response :delete, "app/installations/#{installation}", opts
+        boolean_from_response :delete, "app/installations/#{installation}", options
       end
     end
   end