octokit 4.22.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 072c9ec7fa2439cc75655ff5c925efeedc19fe386eae30a30be712524802b3ad
-  data.tar.gz: 177806faf28428ecd942d0159c268cae122e2ec7a88d4bc3e0b34e41a2b3409c
+  metadata.gz: b64084ad94f7ab597007ce5baa5e9daa39e85c0270c0993cde6bf416a2834a2c
+  data.tar.gz: 429a34488349b5692bc28e6051571e3e4bddfd7f697be93bd0e24c7329d1bd18
 SHA512:
-  metadata.gz: 7a087ec2c360f33db0cd6526ba76ae8762d57885a24577d36ada1baf1cf3019e93beeaa70455bb6cf08f64d9328e84112043d202526b42e94f8cb1bfb96faada
-  data.tar.gz: 8425341fe9135936b066de860c2722ad77b8a3c3ce2d8fe478a5420a3c911fc56a419ce4808a290f55199074bab94953500d3cdbc7345f9d9137d66cccb9de39
+  metadata.gz: c52b64720e7ffa14ab04bf59283194dd8a0b83ba73bf9acc3c0cfbb4ef36ba6e87257f7650969d597135c8c75eb3bc1bf7a3b7a20f2746c5670e92f7cea95a9f
+  data.tar.gz: b0598cc84a8d4571d9e3fc64d1ed63dcef618fba37e2d9e33346ef42a766e366bc2e38fc02b7c9561b0fc7fe28a7ed8984599390deb305f86af8e98b21033b29

data/README.md

@@ -1,5 +1,8 @@
 # Octokit
 
+> **Note**
+> We've recently renamed the `4-stable` branch to `main`. This might affect you if you're making changes to Octokit's code locally. For more details and for the steps to reconfigure your local clone for the new branch name, check out [this post](https://github.com/octokit/octokit.rb/discussions/1455).
+
 Ruby toolkit for the GitHub API.
 
 ![logo](https://docs.github.com/assets/images/gundamcat.png)
@@ -10,43 +13,47 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
 ## Table of Contents
 
 1. [Philosophy](#philosophy)
-2. [Quick start](#quick-start)
+2. [Installation](#installation)
 3. [Making requests](#making-requests)
+   1. [Additional Query Parameters](#additional-query-parameters)
 4. [Consuming resources](#consuming-resources)
 5. [Accessing HTTP responses](#accessing-http-responses)
-6. [Authentication](#authentication)
+6. [Handling errors](#handling-errors)
+7. [Authentication](#authentication)
    1. [Basic Authentication](#basic-authentication)
    2. [OAuth access tokens](#oauth-access-tokens)
    3. [Two-Factor Authentication](#two-factor-authentication)
    4. [Using a .netrc file](#using-a-netrc-file)
    5. [Application authentication](#application-authentication)
-7. [Pagination](#pagination)
+   6. [GitHub App](#github-app)
+8. [Default results per_page](#default-results-per_page)
+9. [Pagination](#pagination)
    1. [Auto pagination](#auto-pagination)
-8. [Working with GitHub Enterprise](#working-with-github-enterprise)
+10. [Working with GitHub Enterprise](#working-with-github-enterprise)
    1. [Interacting with the GitHub.com APIs in GitHub Enterprise](#interacting-with-the-githubcom-apis-in-github-enterprise)
    2. [Interacting with the GitHub Enterprise Admin APIs](#interacting-with-the-github-enterprise-admin-apis)
    3. [Interacting with the GitHub Enterprise Management Console APIs](#interacting-with-the-github-enterprise-management-console-apis)
-9. [SSL Connection Errors](#ssl-connection-errors)
-10. [Configuration and defaults](#configuration-and-defaults)
+   4. [SSL Connection Errors](#ssl-connection-errors)
+11. [Configuration and defaults](#configuration-and-defaults)
     1. [Configuring module defaults](#configuring-module-defaults)
     2. [Using ENV variables](#using-env-variables)
     3. [Timeouts](#timeouts)
-11. [Hypermedia agent](#hypermedia-agent)
+12. [Hypermedia agent](#hypermedia-agent)
     1. [Hypermedia in Octokit](#hypermedia-in-octokit)
     2. [URI templates](#uri-templates)
     3. [The Full Hypermedia Experience™](#the-full-hypermedia-experience)
-12. [Upgrading guide](#upgrading-guide)
+13. [Upgrading guide](#upgrading-guide)
     1. [Upgrading from 1.x.x](#upgrading-from-1xx)
-13. [Advanced usage](#advanced-usage)
+14. [Advanced usage](#advanced-usage)
     1. [Debugging](#debugging)
     2. [Caching](#caching)
-14. [Hacking on Octokit.rb](#hacking-on-octokitrb)
+15. [Hacking on Octokit.rb](#hacking-on-octokitrb)
     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)
-17. [Making Repeating Requests](#making-repeating-requests)
-18. [License](#license)
+16. [Supported Ruby Versions](#supported-ruby-versions)
+17. [Versioning](#versioning)
+18. [Making Repeating Requests](#making-repeating-requests)
+19. [License](#license)
 
 ## Philosophy
 
@@ -66,7 +73,7 @@ client.readme 'al3x/sovereign', :accept => 'application/vnd.github.html'
 [wrappers]: http://wynnnetherland.com/journal/what-makes-a-good-api-wrapper
 [github-api]: https://developer.github.com/v3/
 
-## Quick start
+## Installation
 
 Install via Rubygems
 
@@ -74,13 +81,13 @@ Install via Rubygems
 
 ... or add to your Gemfile
 
-    gem "octokit", "~> 4.0"
+    gem "octokit"
 
 Access the library in Ruby:
 
     require 'octokit'
 
-### Making requests
+## Making requests
 
 [API methods][] are available as client instance methods.
 
@@ -95,7 +102,7 @@ client = Octokit::Client.new(:access_token => 'personal_access_token')
 client.user
 ```
 
-### Additional Query Parameters
+### Additional query parameters
 
 When passing additional parameters to GET based request use the following syntax:
 
@@ -109,9 +116,9 @@ When passing additional parameters to GET based request use the following syntax
  client.contents('octokit/octokit.rb', path: 'path/to/file.rb', query: {ref: 'some-other-branch'})
 ```
 
-[API methods]: http://octokit.github.io/octokit.rb/method_list.html
+[api methods]: http://octokit.github.io/octokit.rb/method_list.html
 
-### Consuming resources
+## Consuming resources
 
 Most methods return a `Resource` object which provides dot notation and `[]`
 access for fields returned in the API response.
@@ -134,7 +141,7 @@ user.rels[:gists].href
 **Note:** URL fields are culled into a separate `.rels` collection for easier
 [Hypermedia](#hypermedia-agent) support.
 
-### Accessing HTTP responses
+## Accessing HTTP responses
 
 While most methods return a `Resource` object or a Boolean, sometimes you may
 need access to the raw HTTP response headers. You can access the last HTTP
@@ -146,6 +153,23 @@ response  = client.last_response
 etag      = response.headers[:etag]
 ```
 
+## Handling errors
+
+When the API returns an error response, Octokit will raise a Ruby exception.
+
+A range of different exceptions can be raised depending on the error returned
+by the API - for example:
+
+* A `400 Bad Request` response will lead to an `Octokit::BadRequest` error 
+* A `403 Forbidden` error with a "rate limited exceeded" message will lead
+  to a `Octokit::TooManyRequests` error
+
+All of the different exception classes inherit from `Octokit::Error` and
+expose the `#response_status`, `#response_headers` and `#response_body`.
+For validation errors, `#errors` will return an `Array` of `Hash`es
+with the detailed information
+[returned by the API](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#client-errors).
+
 ## Authentication
 
 Octokit supports the various [authentication methods supported by the GitHub
@@ -163,6 +187,7 @@ user = client.user
 user.login
 # => "defunkt"
 ```
+
 While Basic Authentication allows you to get started quickly, OAuth access
 tokens are the preferred way to authenticate on behalf of users.
 
@@ -171,9 +196,9 @@ tokens are the preferred way to authenticate on behalf of users.
 [OAuth access tokens][oauth] provide two main benefits over using your username
 and password:
 
-* **Revokable access**. Access tokens can be revoked, removing access for only
+- **Revocable access**. Access tokens can be revoked, removing access for only
   that token without having to change your password everywhere.
-* **Limited access**. Access tokens have [access scopes][] which allow for more
+- **Limited access**. Access tokens have [access scopes][] which allow for more
   granular access to API resources. For instance, you can grant a third party
   access to your gists but not your private repositories.
 
@@ -188,15 +213,7 @@ user.login
 # => "defunkt"
 ```
 
-You can [create access tokens through your GitHub Account Settings](https://help.github.com/articles/creating-an-access-token-for-command-line-use)
-or with a basic authenticated Octokit client:
-
-```ruby
-client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
-
-client.create_authorization(:scopes => ["user"], :note => "Name of token")
-# => <your new oauth token>
-```
+You can [create access tokens through your GitHub Account Settings](https://help.github.com/articles/creating-an-access-token-for-command-line-use).
 
 ### Two-Factor Authentication
 
@@ -212,28 +229,17 @@ client = Octokit::Client.new \
 user = client.user("defunkt", :headers => { "X-GitHub-OTP" => "<your 2FA token>" })
 ```
 
-As you can imagine, this gets annoying quick since two-factor auth tokens are very short lived. So it is recommended to create an oauth token for the user to communicate with the API:
-
-```ruby
-client = Octokit::Client.new \
-  :login    => 'defunkt',
-  :password => 'c0d3b4ssssss!'
-
-client.create_authorization(:scopes => ["user"], :note => "Name of token",
-                            :headers => { "X-GitHub-OTP" => "<your 2FA token>" })
-# => <your new oauth token>
-```
-
 ### Using a .netrc file
 
 Octokit supports reading credentials from a netrc file (defaulting to
-`~/.netrc`).  Given these lines in your netrc:
+`~/.netrc`). Given these lines in your netrc:
 
 ```
 machine api.github.com
   login defunkt
   password c0d3b4ssssss!
 ```
+
 You can now create a client with those credentials:
 
 ```ruby
@@ -241,6 +247,7 @@ client = Octokit::Client.new(:netrc => true)
 client.login
 # => "defunkt"
 ```
+
 But _I want to use OAuth_ you say. Since the GitHub API supports using an OAuth
 token as a Basic password, you totally can:
 
@@ -273,6 +280,15 @@ user = client.user 'defunkt'
 [access scopes]: http://developer.github.com/v3/oauth/#scopes
 [app-creds]: http://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications
 
+### GitHub App
+Octokit.rb also supports authentication [using a GitHub App](https://docs.github.com/en/developers/apps/managing-github-apps/installing-github-apps), which [requires a generated JWT token](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app).
+
+```ruby
+client = Octokit::Client.new(:bearer_token => "<your jwt token>")
+client.app
+# => about GitHub App info
+```
+
 ## Default results per_page
 
 Default results from the GitHub API are 30, if you wish to add more you must do so during Octokit configuration.
@@ -329,7 +345,7 @@ With a bit of setup, you can also use Octokit with your GitHub Enterprise instan
 
 To interact with the "regular" GitHub.com APIs in GitHub Enterprise, simply configure the `api_endpoint` to match your hostname. For example:
 
-``` ruby
+```ruby
 Octokit.configure do |c|
   c.api_endpoint = "https://<hostname>/api/v3/"
 end
@@ -341,7 +357,7 @@ client = Octokit::Client.new(:access_token => "<your 40 char token>")
 
 The GitHub Enterprise Admin APIs are under a different client: `EnterpriseAdminClient`. You'll need to have an administrator account in order to use these APIs.
 
-``` ruby
+```ruby
 admin_client = Octokit::EnterpriseAdminClient.new(
   :access_token => "<your 40 char token>",
   :api_endpoint => "https://<hostname>/api/v3/"
@@ -358,9 +374,9 @@ admin_client = Octokit.enterprise_admin_client.new
 
 ### Interacting with the GitHub Enterprise Management Console APIs
 
-The GitHub Enterprise Management Console APIs are also under a separate client: `EnterpriseManagementConsoleClient`. In order to use it, you'll need to provide both your management console password as well as the endpoint to your management console. This is different than the API endpoint provided above.
+The GitHub Enterprise Management Console APIs are also under a separate client: `EnterpriseManagementConsoleClient`. In order to use it, you'll need to provide both your management console password as well as the endpoint to your management console. This is different from the API endpoint provided above.
 
-``` ruby
+```ruby
 management_console_client = Octokit::EnterpriseManagementConsoleClient.new(
   :management_console_password => "secret",
   :management_console_endpoint = "https://hostname:8633"
@@ -377,9 +393,9 @@ management_console_client = Octokit.enterprise_management_console_client.new
 
 ### SSL Connection Errors
 
-You *may* need to disable SSL temporarily while first setting up your GitHub Enterprise install. You can do that with the following configuration:
+You _may_ need to disable SSL temporarily while first setting up your GitHub Enterprise install. You can do that with the following configuration:
 
-``` ruby
+```ruby
 client.connection_options[:ssl] = { :verify => false }
 ```
 
@@ -444,6 +460,7 @@ Octokit.configure do |c|
   }
 end
 ```
+
 You should set a timeout in order to avoid Ruby’s Timeout module, which can hose your server. Here are some resources for more information on this:
 
 - [The Oldest Bug In Ruby - Why Rack::Timeout Might Hose your Server](https://www.schneems.com/2017/02/21/the-oldest-bug-in-ruby-why-racktimeout-might-hose-your-server/)
@@ -473,7 +490,7 @@ repos.last.name
 # => "faraday-zeromq"
 ```
 
-When processing API responses, all `*_url` attributes are culled in to the link
+When processing API responses, all `*_url` attributes are culled into the link
 relations collection. Any `url` attribute becomes `.rels[:self]`.
 
 ### URI templates
@@ -509,8 +526,8 @@ Octokit 3.0 aims to be hypermedia-driven, removing the internal URL
 construction currently used throughout the client.
 
 [hypermedia]: http://en.wikipedia.org/wiki/Hypermedia
-[Sawyer]: https://github.com/lostisland/sawyer
-[Faraday]: https://github.com/lostisland/faraday
+[sawyer]: https://github.com/lostisland/sawyer
+[faraday]: https://github.com/lostisland/faraday
 [uri-templates]: http://tools.ietf.org/html/rfc6570
 
 ## Upgrading guide
@@ -518,8 +535,8 @@ construction currently used throughout the client.
 Version 4.0
 
 - **removes support for a [long-deprecated overload][list-pulls] for
-passing state as a positional argument** when listing pull requests. Instead,
-pass `state` in the method options.
+  passing state as a positional argument** when listing pull requests. Instead,
+  pass `state` in the method options.
 - **drops support for Ruby < 2.0**.
 - adds support for new [Enterprise-only APIs](#working-with-github-enterprise).
 - adds support for [Repository redirects][redirects].
@@ -536,6 +553,7 @@ for the client:
 ```ruby
 Octokit.default_media_type = "application/vnd.github.beta+json"
 ```
+
 or per-request
 
 ```ruby
@@ -552,21 +570,20 @@ Version 2.0 includes a completely rewritten `Client` factory that now memoizes
 client instances based on unique configuration options. Breaking changes also
 include:
 
-* `:oauth_token` is now `:access_token`
-* `:auto_traversal` is now `:auto_paginate`
-* `Hashie::Mash` has been removed. Responses now return a `Sawyer::Resource`
+- `:oauth_token` is now `:access_token`
+- `:auto_traversal` is now `:auto_paginate`
+- `Hashie::Mash` has been removed. Responses now return a `Sawyer::Resource`
   object. This new type behaves mostly like a Ruby `Hash`, but does not fully
   support the `Hashie::Mash` API.
-* Two new client error types are raised where appropriate:
+- Two new client error types are raised where appropriate:
   `Octokit::TooManyRequests` and `Octokit::TooManyLoginAttempts`
-* The `search_*` methods from v1.x are now found at `legacy_search_*`
-* Support for netrc requires including the [netrc gem][] in your Gemfile or
+- The `search_*` methods from v1.x are now found at `legacy_search_*`
+- Support for netrc requires including the [netrc gem][] in your Gemfile or
   gemspec.
-* DateTime fields are now proper `DateTime` objects. Previous versions outputted DateTime fields as 'String' objects.
+- DateTime fields are now proper `DateTime` objects. Previous versions outputted DateTime fields as 'String' objects.
 
 [netrc gem]: https://rubygems.org/gems/netrc
 
-
 ## Advanced usage
 
 Since Octokit employs [Faraday][faraday] under the hood, some behavior can be
@@ -580,7 +597,7 @@ traffic:
 
 ```ruby
 stack = Faraday::RackBuilder.new do |builder|
-  builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
+  builder.use Faraday::Retry::Middleware, exceptions: Faraday::Request::Retry::DEFAULT_EXCEPTIONS + [Octokit::ServerError] # or Faraday::Request::Retry for Faraday < 2.0
   builder.use Octokit::Middleware::FollowRedirects
   builder.use Octokit::Response::RaiseError
   builder.use Octokit::Response::FeedParser
@@ -594,6 +611,7 @@ Octokit.middleware = stack
 client = Octokit::Client.new
 client.user 'pengwynn'
 ```
+
 ```
 I, [2013-08-22T15:54:38.583300 #88227]  INFO -- : get https://api.github.com/users/pengwynn
 D, [2013-08-22T15:54:38.583401 #88227] DEBUG -- request: Accept: "application/vnd.github.beta+json"
@@ -637,8 +655,7 @@ Once configured, the middleware will store responses in cache based on ETag
 fingerprint and serve those back up for future `304` responses for the same
 resource. See the [project README][cache] for advanced usage.
 
-
-[cache]: https://github.com/plataformatec/faraday-http-cache
+[cache]: https://github.com/sourcelevel/faraday-http-cache
 [faraday]: https://github.com/lostisland/faraday
 
 ## Hacking on Octokit.rb
@@ -653,12 +670,11 @@ to run a Ruby console to poke on Octokit, you can crank one up with:
 
     script/console
 
-Using the scripts in `./script` instead of `bundle exec rspec`, `bundle
-console`, etc.  ensures your dependencies are up-to-date.
+Using the scripts in `./script` instead of `bundle exec rspec`, `bundle console`, etc. ensures your dependencies are up-to-date.
 
 ### Code of Conduct
 
-We want both the Octokit.rb and larger Octokit communities to be an open
+We want both the Octokit.rb and larger Octokit communities to be open
 and welcoming environments. Please read and follow both in spirit and
 letter [Code of Conduct](CODE_OF_CONDUCT.md).
 
@@ -675,52 +691,57 @@ Octokit uses environmental variables for storing credentials used in testing.
 If you are testing an API endpoint that doesn't require authentication, you
 can get away without any additional configuration. For the most part, tests
 use an authenticated client, using a token stored in `ENV['OCTOKIT_TEST_GITHUB_TOKEN']`.
-There are several different authenticating method's used across the api.
+There are several different authentication methods used across the api.
 Here is the full list of configurable environmental variables for testing
 Octokit:
 
-ENV Variable | Description |
-:-------------------|:-----------------|
-`OCTOKIT_TEST_GITHUB_LOGIN`| GitHub login name (preferably one created specifically for testing against).
-`OCTOKIT_TEST_GITHUB_PASSWORD`| Password for the test GitHub login.
-`OCTOKIT_TEST_GITHUB_TOKEN` | [Personal Access Token](https://github.com/blog/1509-personal-api-tokens) for the test GitHub login.
-`OCTOKIT_TEST_GITHUB_CLIENT_ID` | Test OAuth application client id.
-`OCTOKIT_TEST_GITHUB_CLIENT_SECRET` | Test OAuth application client secret.
-`OCTOKIT_TEST_GITHUB_REPOSITORY` | Test repository to perform destructive actions against, this should not be set to any repository of importance. **Automatically created by the test suite if nonexistent** Default: `api-sandbox`
-`OCTOKIT_TEST_GITHUB_ORGANIZATION` | Test organization.
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_LOGIN` | GitHub Enterprise login name.
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_TOKEN` | GitHub Enterprise token.
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD` | GitHub Enterprise management console password.
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_ENDPOINT` | GitHub Enterprise hostname.
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT` | GitHub Enterprise Management Console endpoint.
-`OCTOKIT_TEST_GITHUB_INTEGRATION` | [GitHub Integration](https://developer.github.com/early-access/integrations/) owned by your test organization.
-`OCTOKIT_TEST_GITHUB_INTEGRATION_INSTALLATION` | Installation of the GitHub Integration specified above.
-`OCTOKIT_TEST_INTEGRATION_PEM_KEY` | File path to the private key generated from your integration.
+| ENV Variable                                                 | Description                                                                                                                                                                                       |
+| :----------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `OCTOKIT_TEST_GITHUB_LOGIN`                                  | GitHub login name (preferably one created specifically for testing against).                                                                                                                      |
+| `OCTOKIT_TEST_GITHUB_PASSWORD`                               | Password for the test GitHub login.                                                                                                                                                               |
+| `OCTOKIT_TEST_GITHUB_TOKEN`                                  | [Personal Access Token](https://github.com/blog/1509-personal-api-tokens) for the test GitHub login.                                                                                              |
+| `OCTOKIT_TEST_GITHUB_CLIENT_ID`                              | Test OAuth application client id.                                                                                                                                                                 |
+| `OCTOKIT_TEST_GITHUB_CLIENT_SECRET`                          | Test OAuth application client secret.                                                                                                                                                             |
+| `OCTOKIT_TEST_GITHUB_REPOSITORY`                             | Test repository to perform destructive actions against, this should not be set to any repository of importance. **Automatically created by the test suite if nonexistent** Default: `api-sandbox` |
+| `OCTOKIT_TEST_GITHUB_ORGANIZATION`                           | Test organization.                                                                                                                                                                                |
+| `OCTOKIT_TEST_GITHUB_ENTERPRISE_LOGIN`                       | GitHub Enterprise login name.                                                                                                                                                                     |
+| `OCTOKIT_TEST_GITHUB_ENTERPRISE_TOKEN`                       | GitHub Enterprise token.                                                                                                                                                                          |
+| `OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD` | GitHub Enterprise management console password.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_ENTERPRISE_ENDPOINT`                    | GitHub Enterprise hostname.                                                                                                                                                                       |
+| `OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT` | GitHub Enterprise Management Console endpoint.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_ENDPOINT`                          | GitHub Enterprise Server GHES Manage Endpoint.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_USERNAME`                          | GitHub Enterprise Server GHES Manage Username.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_MANAGE_GHES_PASSWORD`                          | GitHub Enterprise Server GHES Manage Password.                                                                                                                                                    |
+| `OCTOKIT_TEST_GITHUB_INTEGRATION`                            | [GitHub Integration](https://developer.github.com/early-access/integrations/) owned by your test organization.                                                                                    |
+| `OCTOKIT_TEST_GITHUB_INTEGRATION_INSTALLATION`               | Installation of the GitHub Integration specified above.                                                                                                                                           |
+| `OCTOKIT_TEST_INTEGRATION_PEM_KEY`                           | File path to the private key generated from your integration.                                                                                                                                     |
 
 Since we periodically refresh our cassettes, please keep some points in mind
 when writing new specs.
 
-* **Specs should be idempotent**. The HTTP calls made during a spec should be
+- **Specs should be idempotent**. The HTTP calls made during a spec should be
   able to be run over and over. This means deleting a known resource prior to
   creating it if the name has to be unique.
-* **Specs should be able to be run in random order.** If a spec depends on
+- **Specs should be able to be run in random order.** If a spec depends on
   another resource as a fixture, make sure that's created in the scope of the
   spec and not depend on a previous spec to create the data needed.
-* **Do not depend on authenticated user info.** Instead of asserting
+- **Do not depend on authenticated user info.** Instead of asserting
   actual values in resources, try to assert the existence of a key or that a
   response is an Array. We're testing the client, not the API.
 
 [bootstrapping]: http://wynnnetherland.com/linked/2013012801/bootstrapping-consistency
-[VCR]: https://github.com/vcr/vcr
+[vcr]: https://github.com/vcr/vcr
 
 ## Supported Ruby Versions
 
 This library aims to support and is [tested against][actions] the following Ruby
 implementations:
 
-* Ruby 2.5
-* Ruby 2.6
 * Ruby 2.7
+* Ruby 3.0
+* Ruby 3.1
+* Ruby 3.2
+* Ruby 3.3
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 
@@ -757,7 +778,8 @@ The changes made between versions can be seen on the [project releases page][rel
 [releases]: https://github.com/octokit/octokit.rb/releases
 
 ## Making Repeating Requests
-In most cases it would be best to use a [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests.
+
+In most cases it would be best to use [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests.
 
 ```ruby
 Octopoller.poll(timeout: 15.seconds) do

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

@@ -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
@@ -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
@@ -66,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