octokit 6.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3018cabf6ab75fe3a4340d20a4844ab92fa7059a4bbbdd96b9b671537aef5b5
-  data.tar.gz: 6308252f312bb301eadfe573daf9d5e17ce0698480dbdc938f72b62831e73632
+  metadata.gz: a9f2dca26c45a1b912572448c2fe16e78f37b7bb5fc7dc885488847c6eb19315
+  data.tar.gz: 11a332c8d3ad5f92ac0ed01ccd03e6a699f852d31946e6e4acc43e75ea3b2d00
 SHA512:
-  metadata.gz: 7477cd6b438fedbec3fe952a8aebeefa224b991a65c8950c26c938db69962614d1ae066c3afd4b40a37ab935637af2dbc08ae126f8e5d199c16df1e646b2878b
-  data.tar.gz: 6d891d836aa8118c9cce64d265ee26d8e97f7dc05425d491d0d7123f1b9fab12eb3aa62ccc85a1b69640ed29819dba7b19d34161f2fa5b159a0b36701c0c758a
+  metadata.gz: 4790f888c01d7094b822ba72fc1ac576efa0803c6433982b53373787649b9b398842ee2986e43af6000677cda62a81e9072936b1d46c516a441a8256de10a1ae
+  data.tar.gz: 135c6ab374669d1db0fd18172670f79856adb627ef3e8cf015e0af93dacedf110f6f022df2be04907fdf11d4db68d7c382569e56f792d4c5eac2db7f65f8bbec

data/README.md

@@ -13,7 +13,7 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
 ## Table of Contents
 
 1. [Philosophy](#philosophy)
-2. [Installation](#quick-start)
+2. [Installation](#installation)
 3. [Making requests](#making-requests)
    1. [Additional Query Parameters](#additional-query-parameters)
 4. [Consuming resources](#consuming-resources)
@@ -25,33 +25,35 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
    3. [Two-Factor Authentication](#two-factor-authentication)
    4. [Using a .netrc file](#using-a-netrc-file)
    5. [Application authentication](#application-authentication)
-8. [Pagination](#pagination)
+   6. [GitHub App](#github-app)
+8. [Default results per_page](#default-results-per_page)
+9. [Pagination](#pagination)
    1. [Auto pagination](#auto-pagination)
-9. [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)
    4. [SSL Connection Errors](#ssl-connection-errors)
-10. [Configuration and defaults](#configuration-and-defaults)
+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
 
@@ -211,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
 
@@ -235,18 +229,6 @@ client = Octokit::Client.new \
 user = client.user("defunkt", :headers => { "X-GitHub-OTP" => "<your 2FA token>" })
 ```
 
-As you can imagine, this gets annoying quickly 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
@@ -298,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.
@@ -606,7 +597,7 @@ traffic:
 
 ```ruby
 stack = Faraday::RackBuilder.new do |builder|
-  builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError] # or Faraday::Request::Retry for Faraday < 2.0
+  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
@@ -746,6 +737,7 @@ implementations:
 * Ruby 2.7
 * Ruby 3.0
 * Ruby 3.1
+* Ruby 3.2
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 

data/Rakefile

@@ -3,22 +3,26 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(: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/octokit/client/actions_secrets.rb

@@ -11,7 +11,7 @@ module Octokit
       # @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)
+      def get_actions_public_key(repo)
         get "#{Repository.path repo}/actions/secrets/public-key"
       end
 
@@ -20,7 +20,7 @@ module Octokit
       # @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)
+      def list_actions_secrets(repo)
         paginate "#{Repository.path repo}/actions/secrets" do |data, last_response|
           data.secrets.concat last_response.data.secrets
         end
@@ -32,7 +32,7 @@ module Octokit
       # @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)
+      def get_actions_secret(repo, name)
         get "#{Repository.path repo}/actions/secrets/#{name}"
       end
 
@@ -42,7 +42,7 @@ module Octokit
       # @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)
+      def create_or_update_actions_secret(repo, name, options)
         put "#{Repository.path repo}/actions/secrets/#{name}", options
       end
 
@@ -51,9 +51,62 @@ module Octokit
       # @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)
+      def delete_actions_secret(repo, name)
         boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
       end
+
+      # Get environment public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-public-key
+      def get_actions_environment_public_key(repo, environment)
+        get "#{Repository.path repo}/environments/#{environment}/secrets/public-key"
+      end
+
+      # List environment secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://developer.github.com/v3/actions/secrets/#list-environment-secrets
+      def list_actions_environment_secrets(repo, environment)
+        paginate "#{Repository.path repo}/environments/#{environment}/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get an environment secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at and updated_at
+      # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-secret
+      def get_actions_environment_secret(repo, environment, name)
+        get "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
+      end
+
+      # Create or update an environment secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/actions/secrets#create-or-update-an-environment-secret
+      def create_or_update_actions_environment_secret(repo, environment, name, options)
+        put "#{Repository.path repo}/environments/#{environment}/secrets/#{name}", options
+      end
+
+      # Delete environment secret
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/actions/secrets#delete-an-environment-secret
+      def delete_actions_environment_secret(repo, environment, name)
+        boolean_from_response :delete, "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
+      end
     end
   end
 end

data/lib/octokit/client/apps.rb

@@ -217,6 +217,31 @@ module Octokit
       def delete_installation(installation, options = {})
         boolean_from_response :delete, "app/installations/#{installation}", options
       end
+
+      # Returns a list of webhook deliveries for the webhook configured for a GitHub App.
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://docs.github.com/en/rest/apps/webhooks#list-deliveries-for-an-app-webhook
+      #
+      # @return [Array<Hash>] an array of hook deliveries
+      def list_app_hook_deliveries(options = {})
+        paginate('app/hook/deliveries', options) do |data, last_response|
+          data.concat last_response.data
+        end
+      end
+
+      # Redeliver a delivery for the webhook configured for a GitHub App.
+      #
+      # @param delivery_id [Integer] The id of a GitHub App Hook Delivery
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#redeliver-a-delivery-for-an-app-webhook
+      #
+      # @return [Boolean] Success
+      def deliver_app_hook(delivery_id, options = {})
+        boolean_from_response :post, "app/hook/deliveries/#{delivery_id}/attempts", options
+      end
     end
   end
 end

data/lib/octokit/client/code_scanning.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'tempfile'
+require 'zlib'
+
+module Octokit
+  class Client
+    # Methods for the code scanning alerts API
+    #
+    # @see https://docs.github.com/rest/code-scanning
+    module CodeScanning
+      # Uploads SARIF data containing the results of a code scanning analysis
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param file [String] Path to the SARIF file to upload
+      # @param sha [String] The SHA of the commit to which the analysis you are uploading relates
+      # @param ref [String] The full Git reference, formatted as `refs/heads/<branch name>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#upload-an-analysis-as-sarif-data
+      def upload_sarif_data(repo, file, sha, ref, options = {})
+        options[:sarif] = compress_sarif_data(file)
+        options[:commit_sha] = sha
+        options[:ref] = ref
+
+        post "#{Repository.path repo}/code-scanning/sarifs", options
+      end
+
+      # Gets information about a SARIF upload
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param sarif_id [String] The SARIF ID obtained after uploading
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#get-information-about-a-sarif-upload
+      def get_sarif_upload_information(repo, sarif_id, options = {})
+        get "#{Repository.path repo}/code-scanning/sarifs/#{sarif_id}", options
+      end
+
+      private
+
+      def compress_sarif_data(file)
+        Tempfile.create('sarif.gz') do |tempfile|
+          Zlib::GzipWriter.open(tempfile) do |gz_file|
+            gz_file.write File.binread(file)
+          end
+          Base64.strict_encode64(tempfile.read)
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/codespaces_secrets.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Codespaces Secrets API
+    #
+    # @see https://docs.github.com/en/rest/codespaces/
+    module CodespacesSecrets
+      # Get public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets#get-a-repository-public-key
+      def get_codespaces_public_key(repo)
+        get "#{Repository.path repo}/codespaces/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://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_codespaces_secrets(repo)
+        paginate "#{Repository.path repo}/codespaces/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_codespaces_secret(repo, name)
+        get "#{Repository.path repo}/codespaces/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://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_codespaces_secret(repo, name, options)
+        put "#{Repository.path repo}/codespaces/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_codespaces_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/dependabot_secrets.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the dependabot Secrets API
+    #
+    # @see https://docs.github.com/en/rest/dependabot/
+    module DependabotSecrets
+      # Get public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets#get-a-repository-public-key
+      def get_dependabot_public_key(repo)
+        get "#{Repository.path repo}/dependabot/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://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_dependabot_secrets(repo)
+        paginate "#{Repository.path repo}/dependabot/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_dependabot_secret(repo, name)
+        get "#{Repository.path repo}/dependabot/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://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_dependabot_secret(repo, name, options)
+        put "#{Repository.path repo}/dependabot/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_dependabot_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/dependabot/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/environments.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Environments API
+    #
+    # @see https://docs.github.com/en/rest/deployments/environments
+    module Environments
+      # Fetch a single environment for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return <Sawyer::Resource> A single environment
+      # @see https://docs.github.com/en/rest/deployments/environments#get-an-environment
+      def environment(repo, environment_name, options = {})
+        get("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Lists the environments for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [Integer] :per_page The number of results per page (max 100). Default: 30
+      # @option options [Integer] :page Page number of the results to fetch. Default: 1
+      # @return [Sawyer::Resource] Total count of environments and list of environments
+      # @see https://docs.github.com/en/rest/deployments/environments#list-environments
+      def environments(repo, options = {})
+        get("#{Repository.path repo}/environments", options)
+      end
+      alias list_environments environments
+
+      # Create or update an environment with protection rules, such as required reviewers
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @option options [Integer] :wait_timer The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
+      # @option options [Array] :reviewers The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers.
+      # @option options [Object] :deployment_branch_policy The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
+      # @return [Sawyer::Resource] An environment
+      # @see https://docs.github.com/en/rest/deployments/environments#create-or-update-an-environment
+      def create_or_update_environment(repo, environment_name, options = {})
+        put("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Delete an Environment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return [No Content]
+      # @see https://docs.github.com/en/rest/deployments/environments#delete-an-environment
+      def delete_environment(repo, environment_name, options = {})
+        delete("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+    end
+  end
+end

data/lib/octokit/client/organizations.rb

@@ -50,12 +50,28 @@ module Octokit
       end
       alias update_org update_organization
 
+      # Delete an organization.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @param org [String, Integer] Organization login or ID.
+      # @return [Boolean] True if deletion successful, otherwise false.
+      # @see https://docs.github.com/rest/orgs/orgs#delete-an-organization
+      # @example
+      #   @client.delete_organization("my-org")
+      # @example
+      #   @client.delete_org("my-org")
+      def delete_organization(org)
+        boolean_from_response :delete, Organization.path(org)
+      end
+      alias delete_org delete_organization
+
       # Get organizations for a user.
       #
       # Nonauthenticated calls to this method will return organizations that
       # the user is a public member.
       #
-      # Use an authenicated client to get both public and private organizations
+      # Use an authenticated client to get both public and private organizations
       # for a user.
       #
       # Calling this method on a `@client` will return that users organizations.

data/lib/octokit/client/pull_requests.rb

@@ -197,18 +197,21 @@ module Octokit
       # @param body [String] Comment content
       # @param commit_id [String] Sha of the commit to comment on.
       # @param path [String] Relative path of the file to comment on.
-      # @param position [Integer] Line index in the diff to comment on.
+      # @param line [Integer] Line index in the diff to comment on.
+      #                       For a multi-line comment, the last line of the range
+      #                       and specify 'start_line' in the 'options'.
       # @return [Sawyer::Resource] Hash representing the new comment
+      # @deprecated The position will be deprecated in the next major version. Please refer to the details below.
       # @see https://developer.github.com/v3/pulls/comments/#create-a-comment
       # @example
       #   @client.create_pull_request_comment("octokit/octokit.rb", 163, ":shipit:",
       #     "2d3201e4440903d8b04a5487842053ca4883e5f0", "lib/octokit/request.rb", 47)
-      def create_pull_request_comment(repo, pull_id, body, commit_id, path, position, options = {})
+      def create_pull_request_comment(repo, pull_id, body, commit_id, path, line, options = {})
         options.merge!({
                          body: body,
                          commit_id: commit_id,
                          path: path,
-                         position: position
+                         line: line
                        })
         post "#{Repository.path repo}/pulls/#{pull_id}/comments", options
       end

data/lib/octokit/client/reactions.rb

@@ -137,16 +137,67 @@ module Octokit
 
       # Delete a reaction
       #
-      # @param id [Integer] Reaction id
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param issue_id [Integer] The Issue comment id
+      # @param reaction_id [Integer] The Reaction id
+      #
+      # @see https://docs.github.com/en/rest/reactions/reactions#delete-an-issue-reaction
+      #
+      # @example
+      #   @client.delete_issue_reaction("octokit/octokit.rb", 1, 2)
+      #
+      # @return [Boolean] Return true if reaction was deleted, false otherwise.
+      def delete_issue_reaction(repo, issue_id, reaction_id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/issues/#{issue_id}/reactions/#{reaction_id}", options
+      end
+
+      # List reactions for a release
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Release id
+      #
+      # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#list-reactions-for-a-release
+      #
+      # @example
+      #   @client.release_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def release_reactions(repo, release_id, options = {})
+        get "#{Repository.path repo}/releases/#{release_id}/reactions", options
+      end
+
+      # Create reaction for a release
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Release id
+      # @param reaction [String] The Reaction
+      #
+      # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#create-reaction-for-a-release
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_release_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction.
+      def create_release_reaction(repo, release_id, reaction, options = {})
+        options = options.merge(content: reaction)
+        post "#{Repository.path repo}/releases/#{release_id}/reactions", options
+      end
+
+      # Delete a reaction for a release
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param issue_id [Integer] The Release id
+      # @param reaction_id [Integer] The Reaction id
       #
-      # @see https://developer.github.com/v3/reactions/#delete-a-reaction
+      # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#delete-a-release-reaction
       #
       # @example
-      #   @client.delete_reaction(1)
+      #   @client.delete_release_reaction("octokit/octokit.rb", 1, 2)
       #
       # @return [Boolean] Return true if reaction was deleted, false otherwise.
-      def delete_reaction(id, options = {})
-        boolean_from_response :delete, "reactions/#{id}", options
+      def delete_release_reaction(repo, release_id, reaction_id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/releases/#{release_id}/reactions/#{reaction_id}", options
       end
     end
   end

data/lib/octokit/client/repositories.rb

@@ -564,7 +564,7 @@ module Octokit
       # @example Get branch 'master` from octokit/octokit.rb
       #   Octokit.branch("octokit/octokit.rb", "master")
       def branch(repo, branch, options = {})
-        get "#{Repository.path repo}/branches/#{branch}", options
+        get "#{Repository.path repo}/branches/#{CGI.escape(branch)}", options
       end
       alias get_branch branch
 

data/lib/octokit/client/reviews.rb

@@ -151,7 +151,7 @@ module Octokit
       # @param number [Integer] Number ID of the pull request
       # @param reviewers [Hash] :reviewers [Array<String>] An array of user logins
       # @param options [Hash] :team_reviewers [Array<String>] An array of team slugs
-      # @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
+      # @see https://developer.github.com/v3/pulls/review_requests/#request-reviewers-for-a-pull-request
       #
       # @example
       #   @client.request_pull_request_review('octokit/octokit.rb', 2, reviewers: ['soudy'])

data/lib/octokit/client/search.rb

@@ -44,6 +44,7 @@ module Octokit
       # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-issues-and-pull-requests
+      # @see https://docs.github.com/en/rest/search#limitations-on-query-length
       def search_issues(query, options = {})
         search 'search/issues', query, options
       end

data/lib/octokit/client.rb

@@ -18,6 +18,8 @@ require 'octokit/client/actions_workflow_jobs'
 require 'octokit/client/actions_workflow_runs'
 require 'octokit/client/apps'
 require 'octokit/client/checks'
+require 'octokit/client/code_scanning'
+require 'octokit/client/codespaces_secrets'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
 require 'octokit/client/commit_pulls'
@@ -25,7 +27,9 @@ require 'octokit/client/commit_branches'
 require 'octokit/client/community_profile'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
+require 'octokit/client/dependabot_secrets'
 require 'octokit/client/deployments'
+require 'octokit/client/environments'
 require 'octokit/client/emojis'
 require 'octokit/client/events'
 require 'octokit/client/feeds'
@@ -78,14 +82,18 @@ module Octokit
     include Octokit::Client::ActionsArtifacts
     include Octokit::Client::ActionsSecrets
     include Octokit::Client::Checks
+    include Octokit::Client::CodeScanning
+    include Octokit::Client::CodespacesSecrets
     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::DependabotSecrets
     include Octokit::Client::Deployments
     include Octokit::Client::Downloads
+    include Octokit::Client::Environments
     include Octokit::Client::Emojis
     include Octokit::Client::Events
     include Octokit::Client::Feeds
@@ -163,10 +171,10 @@ module Octokit
       inspected.gsub! @bearer_token, '********' if @bearer_token
       # Only show last 4 of token, secret
       if @access_token
-        inspected.gsub! @access_token, "#{'*' * 36}#{@access_token[36..-1]}"
+        inspected.gsub! @access_token, "#{'*' * 36}#{@access_token[36..]}"
       end
       if @client_secret
-        inspected.gsub! @client_secret, "#{'*' * 36}#{@client_secret[36..-1]}"
+        inspected.gsub! @client_secret, "#{'*' * 36}#{@client_secret[36..]}"
       end
 
       inspected

data/lib/octokit/configurable.rb

@@ -144,7 +144,7 @@ module Octokit
     private
 
     def options
-      Octokit::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }.to_h
+      Octokit::Configurable.keys.to_h { |key| [key, instance_variable_get(:"@#{key}")] }
     end
 
     def fetch_client_id_and_secret(overrides = {})

data/lib/octokit/connection.rb

@@ -154,7 +154,7 @@ module Octokit
       end
 
       @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
-      response.data
+      response_data_correctly_encoded(response)
     rescue Octokit::Error => e
       @last_response = nil
       raise e
@@ -206,5 +206,13 @@ module Octokit
 
       opts
     end
+
+    def response_data_correctly_encoded(response)
+      content_type = response.headers.fetch('content-type', '')
+      return response.data unless content_type.include?('charset') && response.data.is_a?(String)
+
+      reported_encoding = content_type.match(/charset=([^ ]+)/)[1]
+      response.data.force_encoding(reported_encoding)
+    end
   end
 end

data/lib/octokit/default.rb

@@ -34,9 +34,11 @@ module Octokit
       # In Faraday 2.x, Faraday::Request::Retry was moved to a separate gem
       # so we use it only when it's available.
       if defined?(Faraday::Request::Retry)
-        builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
+        retry_exceptions = Faraday::Request::Retry::DEFAULT_EXCEPTIONS + [Octokit::ServerError]
+        builder.use Faraday::Request::Retry, exceptions: retry_exceptions
       elsif defined?(Faraday::Retry::Middleware)
-        builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError]
+        retry_exceptions = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Octokit::ServerError]
+        builder.use Faraday::Retry::Middleware, exceptions: retry_exceptions
       end
 
       builder.use Octokit::Middleware::FollowRedirects
@@ -49,7 +51,7 @@ module Octokit
       # Configuration options
       # @return [Hash]
       def options
-        Octokit::Configurable.keys.map { |key| [key, send(key)] }.to_h
+        Octokit::Configurable.keys.to_h { |key| [key, send(key)] }
       end
 
       # Default access token from ENV

data/lib/octokit/error.rb

@@ -77,7 +77,7 @@ module Octokit
         Octokit::TooManyRequests
       when /login attempts exceeded/i
         Octokit::TooManyLoginAttempts
-      when /(returns|for) blobs (up to|between) [0-9\-]+ MB/i
+      when /(returns|for) blobs (up to|between) [0-9-]+ MB/i
         Octokit::TooLargeContent
       when /abuse/i
         Octokit::AbuseDetected
@@ -213,7 +213,7 @@ module Octokit
     end
 
     def redact_url(url_string)
-      %w[client_secret access_token].each do |token|
+      %w[client_secret access_token api_key].each do |token|
         if url_string.include? token
           url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)")
         end

data/lib/octokit/gist.rb

@@ -10,7 +10,7 @@ module Octokit
     # Instantiate {Gist} object from Gist URL
     # @ return [Gist]
     def self.from_url(url)
-      Gist.new(URI.parse(url).path[1..-1])
+      Gist.new(URI.parse(url).path[1..])
     end
 
     def initialize(gist)

data/lib/octokit/rate_limit.rb

@@ -20,10 +20,12 @@ module Octokit
     # @return [RateLimit]
     def self.from_response(response)
       info = new
-      if response.respond_to?(:headers) && !response.headers.nil?
-        info.limit = (response.headers['X-RateLimit-Limit'] || 1).to_i
-        info.remaining = (response.headers['X-RateLimit-Remaining'] || 1).to_i
-        info.resets_at = Time.at((response.headers['X-RateLimit-Reset'] || Time.now).to_i)
+      headers = response.headers if response.respond_to?(:headers) && !response.headers.nil?
+      headers ||= response.response_headers if response.respond_to?(:response_headers) && !response.response_headers.nil?
+      if headers
+        info.limit = (headers['X-RateLimit-Limit'] || 1).to_i
+        info.remaining = (headers['X-RateLimit-Remaining'] || 1).to_i
+        info.resets_at = Time.at((headers['X-RateLimit-Reset'] || Time.now).to_i)
         info.resets_in = [(info.resets_at - Time.now).to_i, 0].max
       end
 

data/lib/octokit/repository.rb

@@ -12,7 +12,7 @@ module Octokit
     #
     # @return [Repository]
     def self.from_url(url)
-      new URI.parse(url).path[1..-1]
+      new URI.parse(url).path[1..]
              .gsub(%r{^repos/}, '')
              .split('/', 3)[0..1]
              .join('/')
@@ -48,7 +48,8 @@ module Octokit
     # @return [String] Repository API path
     def path
       return named_api_path if @owner && @name
-      return id_api_path if @id
+
+      id_api_path if @id
     end
 
     # Get the api path for a repo

data/lib/octokit/version.rb

@@ -3,7 +3,7 @@
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 6
+  MAJOR = 8
 
   # Current minor release.
   # @return [Integer]

data/octokit.gemspec

@@ -5,7 +5,6 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'octokit/version'
 
 Gem::Specification.new do |spec|
-  spec.add_development_dependency 'bundler', '>= 1', '< 3'
   spec.add_dependency 'faraday', '>= 1', '< 3'
   spec.add_dependency 'sawyer', '~> 0.9'
   spec.authors = ['Wynn Netherland', 'Erik Michaels-Ober', 'Clint Shryock']

metadata

@@ -1,37 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Wynn Netherland
 - Erik Michaels-Ober
 - Clint Shryock
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -92,15 +72,19 @@ files:
 - lib/octokit/client/actions_workflows.rb
 - lib/octokit/client/apps.rb
 - lib/octokit/client/checks.rb
+- lib/octokit/client/code_scanning.rb
+- lib/octokit/client/codespaces_secrets.rb
 - lib/octokit/client/commit_branches.rb
 - lib/octokit/client/commit_comments.rb
 - lib/octokit/client/commit_pulls.rb
 - lib/octokit/client/commits.rb
 - lib/octokit/client/community_profile.rb
 - lib/octokit/client/contents.rb
+- lib/octokit/client/dependabot_secrets.rb
 - lib/octokit/client/deployments.rb
 - lib/octokit/client/downloads.rb
 - lib/octokit/client/emojis.rb
+- lib/octokit/client/environments.rb
 - lib/octokit/client/events.rb
 - lib/octokit/client/feeds.rb
 - lib/octokit/client/gists.rb
@@ -168,7 +152,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,8 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.0.dev
+signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API
 test_files: []