octokit 5.6.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf0b3ef2f8550628d4bde2fa55f7bcb97261364e94aac9f5a149ce6e86fa019
-  data.tar.gz: d336c02e28efb73618c1c24827b2b7703dc5341ce95087467089cf36f11d96fb
+  metadata.gz: afa7dae6ede3d3871a1ba78d8c0de33d3aa4692869eacdbb30e0867f555c21f2
+  data.tar.gz: 213439dcb01e0af935df22e902caa69d9c395b1ab9076a83918efebc374140bd
 SHA512:
-  metadata.gz: 960aacdc0e1a37794e6bed1a0c5f2686c1dca5160c0802cb449590f92ecab4cf243a0201b65e419fe3ffa38c194f106eceed0d46c90f63ceeb8a4aa14b22d716
-  data.tar.gz: 22a81c032d49f11c2f3875bfbc1c577449787d0899f20d0108dc7de868a2b5f1c86163ccebf46eb4a4b2567277c46fd83aca619c071a238746229664894008bf
+  metadata.gz: 117e024b6078555cdd6809d941a19a0e8b77e629939e112ffe5a5116674c16d6b441358e3ba56bc2d27770fea108fd4adc18d48aa6c186206628abc28dd525d9
+  data.tar.gz: 4caea9cb705c43d9c8022f0de6d74cc9ece8d1e1771ae7a43c0e53a748c226a8c231fe25c64b813bf025a80521dd5c201eb7d2693ebbd6074d47a776137dd7fb

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
 
@@ -298,6 +300,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 +617,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 +757,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

@@ -10,15 +10,13 @@ task test: :spec
 task default: :spec
 
 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_artifacts.rb

@@ -13,7 +13,9 @@ module Octokit
       # @return [Sawyer::Resource] the total count and an array of artifacts
       # @see https://developer.github.com/v3/actions/artifacts#list-artifacts-for-a-repository
       def repository_artifacts(repo, options = {})
-        paginate "#{Repository.path repo}/actions/artifacts", options
+        paginate "#{Repository.path repo}/actions/artifacts", options do |data, last_response|
+          data.artifacts.concat last_response.data.artifacts
+        end
       end
 
       # List all artifacts for a workflow run
@@ -24,7 +26,9 @@ module Octokit
       # @return [Sawyer::Resource] the total count and an array of artifacts
       # @see https://docs.github.com/en/rest/actions/artifacts#list-workflow-run-artifacts
       def workflow_run_artifacts(repo, workflow_run_id, options = {})
-        paginate "#{Repository.path repo}/actions/runs/#{workflow_run_id}/artifacts", options
+        paginate "#{Repository.path repo}/actions/runs/#{workflow_run_id}/artifacts", options do |data, last_response|
+          data.artifacts.concat last_response.data.artifacts
+        end
       end
 
       # Get an artifact

data/lib/octokit/client/actions_secrets.rb

@@ -21,7 +21,9 @@ module Octokit
       # @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"
+        paginate "#{Repository.path repo}/actions/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
       end
 
       # Get a secret

data/lib/octokit/client/actions_workflow_jobs.rb

@@ -40,7 +40,9 @@ module Octokit
       # @return [Sawyer::Resource] Jobs information
       # @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
       def workflow_run_attempt_jobs(repo, run_id, attempt_number, options = {})
-        paginate "#{Repository.path repo}/actions/runs/#{run_id}/attempts/#{attempt_number}/jobs", options
+        paginate "#{Repository.path repo}/actions/runs/#{run_id}/attempts/#{attempt_number}/jobs", options do |data, last_response|
+          data.jobs.concat last_response.data.jobs
+        end
       end
       alias list_workflow_run_attempt_jobs workflow_run_attempt_jobs
 
@@ -53,7 +55,9 @@ module Octokit
       # @return [Sawyer::Resource] Jobs information
       # @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
       def workflow_run_jobs(repo, run_id, options = {})
-        paginate "#{Repository.path repo}/actions/runs/#{run_id}/jobs", options
+        paginate "#{Repository.path repo}/actions/runs/#{run_id}/jobs", options do |data, last_response|
+          data.jobs.concat last_response.data.jobs
+        end
       end
       alias list_workflow_run_jobs workflow_run_jobs
     end

data/lib/octokit/client/actions_workflow_runs.rb

@@ -18,7 +18,9 @@ module Octokit
       # @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
+        paginate "#{Repository.path repo}/actions/workflows/#{workflow}/runs", options do |data, last_response|
+          data.workflow_runs.concat last_response.data.workflow_runs
+        end
       end
       alias list_workflow_runs workflow_runs
 
@@ -33,7 +35,9 @@ module Octokit
       # @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
+        paginate "#{Repository.path repo}/actions/runs", options do |data, last_response|
+          data.workflow_runs.concat last_response.data.workflow_runs
+        end
       end
       alias list_repository_workflow_runs repository_workflow_runs
 

data/lib/octokit/client/actions_workflows.rb

@@ -13,7 +13,9 @@ module Octokit
       # @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
+        paginate "#{Repository.path repo}/actions/workflows", options do |data, last_response|
+          data.workflows.concat last_response.data.workflows
+        end
       end
       alias list_workflows workflows
 

data/lib/octokit/client/hooks.rb

@@ -4,16 +4,6 @@ module Octokit
   class Client
     # Methods for the Hooks API
     module Hooks
-      # List all Service Hooks supported by GitHub
-      #
-      # @return [Sawyer::Resource] A list of all hooks on GitHub
-      # @see https://developer.github.com/v3/repos/hooks/#services
-      # @example List all hooks
-      #   Octokit.available_hooks
-      def available_hooks(options = {})
-        get 'hooks', options
-      end
-
       # List repo hooks
       #
       # Requires authenticated client.

data/lib/octokit/client/refs.rb

@@ -77,9 +77,7 @@ module Octokit
       # @see https://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
       #   Octokit.update_ref("octocat/Hello-World", "heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
-      # @example Fast-forward update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
-      #   Octokit.update_ref("octocat/Hello-World", "heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd", false)
-      def update_ref(repo, ref, sha, force = true, options = {})
+      def update_ref(repo, ref, sha, force = false, options = {})
         parameters = {
           sha: sha,
           force: force

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/tokens.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Method to check scopes
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api
+    module Tokens
+      # Check scopes for a token
+      #
+      # @param token [String] GitHub OAuth token
+      # @param options [Hash] Header params for request
+      # @return [Array<String>] OAuth scopes
+      # @see https://developer.github.com/v3/oauth/#scopes
+      def scopes(token = @access_token, options = {})
+        options = options.dup
+        raise ArgumentError, 'Access token required' if token.nil?
+
+        auth = { 'Authorization' => "token #{token}" }
+        headers = (options.delete(:headers) || {}).merge(auth)
+
+        agent.call(:get, 'user', headers: headers)
+             .headers['X-OAuth-Scopes']
+             .to_s
+             .split(',')
+             .map(&:strip)
+             .sort
+      end
+    end
+  end
+end

data/lib/octokit/client.rb

@@ -17,7 +17,6 @@ require 'octokit/client/actions_workflows'
 require 'octokit/client/actions_workflow_jobs'
 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'
@@ -62,6 +61,7 @@ require 'octokit/client/service_status'
 require 'octokit/client/source_import'
 require 'octokit/client/stats'
 require 'octokit/client/statuses'
+require 'octokit/client/tokens'
 require 'octokit/client/traffic'
 require 'octokit/client/users'
 require 'ext/sawyer/relation'
@@ -77,7 +77,6 @@ module Octokit
     include Octokit::Warnable
     include Octokit::Client::ActionsArtifacts
     include Octokit::Client::ActionsSecrets
-    include Octokit::Client::Authorizations
     include Octokit::Client::Checks
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
@@ -126,6 +125,7 @@ module Octokit
     include Octokit::Client::SourceImport
     include Octokit::Client::Stats
     include Octokit::Client::Statuses
+    include Octokit::Client::Tokens
     include Octokit::Client::Traffic
     include Octokit::Client::Users
 
@@ -163,10 +163,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

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('/')

data/lib/octokit/version.rb

@@ -3,15 +3,15 @@
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 5
+  MAJOR = 6
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 6
+  MINOR = 1
 
   # Current patch level.
   # @return [Integer]
-  PATCH = 1
+  PATCH = 0
 
   # Full release version.
   # @return [String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 5.6.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,7 +91,6 @@ files:
 - lib/octokit/client/actions_workflow_runs.rb
 - lib/octokit/client/actions_workflows.rb
 - lib/octokit/client/apps.rb
-- lib/octokit/client/authorizations.rb
 - lib/octokit/client/checks.rb
 - lib/octokit/client/commit_branches.rb
 - lib/octokit/client/commit_comments.rb
@@ -136,6 +135,7 @@ files:
 - lib/octokit/client/source_import.rb
 - lib/octokit/client/stats.rb
 - lib/octokit/client/statuses.rb
+- lib/octokit/client/tokens.rb
 - lib/octokit/client/traffic.rb
 - lib/octokit/client/users.rb
 - lib/octokit/configurable.rb
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API

data/lib/octokit/client/authorizations.rb

@@ -1,185 +0,0 @@
-# frozen_string_literal: true
-
-module Octokit
-  class Client
-    # Methods for the Authorizations API
-    #
-    # @see https://developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api
-    module Authorizations
-      # List the authenticated user's authorizations
-      #
-      # API for users to manage their own tokens.
-      # You can only access your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @return [Array<Sawyer::Resource>] A list of authorizations for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
-      # @example List authorizations for user ctshryock
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.authorizations
-      def authorizations(options = {})
-        paginate 'authorizations', options
-      end
-
-      # Get a single authorization for the authenticated user.
-      #
-      # You can only access your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization
-      # @example Show authorization for user ctshryock's Travis auth
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.authorization(999999)
-      def authorization(number, options = {})
-        get "authorizations/#{number}", options
-      end
-
-      # Create an authorization for the authenticated user.
-      #
-      # You can create your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @param options [Hash] A customizable set of options.
-      # @option options [Array] :scopes A list of scopes that this authorization is in.
-      # @option options [String] :note A note to remind you what the OAuth token is for.
-      # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
-      # @option options [Boolean] :idempotent If true, will return an existing authorization if one has already been created.
-      # @option options [String] :client_id  Client Id we received when our application was registered with GitHub.
-      # @option options [String] :client_secret  Client Secret we received when our application was registered with GitHub.
-      #
-      # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth/#scopes Available scopes
-      # @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
-      # @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
-      # @example Create a new authorization for user ctshryock's project Zoidberg
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.create_authorization({:scopes => ["public_repo", "gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})
-      # @example Create a new OR return an existing authorization to be used by a specific client for user ctshryock's project Zoidberg
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.create_authorization({:idempotent => true, :client_id => 'xxxx', :client_secret => 'yyyy', :scopes => ["user"]})
-      def create_authorization(options = {})
-        # Technically we can omit scopes as GitHub has a default, however the
-        # API will reject us if we send a POST request with an empty body.
-        options = options.dup
-        if options.delete :idempotent
-          client_id, client_secret = fetch_client_id_and_secret(options)
-          unless client_id && client_secret
-            raise ArgumentError, 'Client ID and Secret required for idempotent authorizations'
-          end
-
-          # Remove the client_id from the body otherwise
-          # this will result in a 422.
-          options.delete(:client_id)
-
-          if (fingerprint = options.delete(:fingerprint))
-            put "authorizations/clients/#{client_id}/#{fingerprint}", options.merge(client_secret: client_secret)
-          else
-            put "authorizations/clients/#{client_id}", options.merge(client_secret: client_secret)
-          end
-
-        else
-          post 'authorizations', options
-        end
-      end
-
-      # Update an authorization for the authenticated user.
-      #
-      # You can update your own tokens, but only through
-      # Basic Authentication.
-      #
-      # @param options [Hash] A customizable set of options.
-      # @option options [Array] :scopes Replace the authorization scopes with these.
-      # @option options [Array] :add_scopes A list of scopes to add to this authorization.
-      # @option options [Array] :remove_scopes A list of scopes to remove from this authorization.
-      # @option options [String] :note A note to remind you what the OAuth token is for.
-      # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
-      #
-      # @return [Sawyer::Resource] A single (updated) authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
-      # @see https://developer.github.com/v3/oauth/#scopes for available scopes
-      # @example Update the authorization for user ctshryock's project Zoidberg
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.update_authorization(999999, {:add_scopes => ["gist", "repo"], :note => "Why not Zoidberg possibly?"})
-      def update_authorization(number, options = {})
-        patch "authorizations/#{number}", options
-      end
-
-      # Delete an authorization for the authenticated user.
-      #
-      # You can delete your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @param number [Number] An existing Authorization ID
-      #
-      # @return [Boolean] Success
-      # @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
-      # @example Delete an authorization
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.delete_authorization(999999)
-      def delete_authorization(number, options = {})
-        boolean_from_response :delete, "authorizations/#{number}", options
-      end
-
-      # Check scopes for a token
-      #
-      # @param token [String] GitHub OAuth token
-      # @param options [Hash] Header params for request
-      # @return [Array<String>] OAuth scopes
-      # @see https://developer.github.com/v3/oauth/#scopes
-      def scopes(token = @access_token, options = {})
-        options = options.dup
-        raise ArgumentError, 'Access token required' if token.nil?
-
-        auth = { 'Authorization' => "token #{token}" }
-        headers = (options.delete(:headers) || {}).merge(auth)
-
-        agent.call(:get, 'user', headers: headers)
-             .headers['X-OAuth-Scopes']
-             .to_s
-             .split(',')
-             .map(&:strip)
-             .sort
-      end
-
-      # Revoke all tokens for an app
-      #
-      # Applications can revoke all of their tokens in a single request
-      #
-      # @deprecated As of January 25th, 2016: https://developer.github.com/changes/2014-04-08-reset-api-tokens/
-      # @return [Boolean] false
-      def revoke_all_application_authorizations(_options = {})
-        octokit_warn('Deprecated: If you need to revoke all tokens for your application, you can do so via the settings page for your application.')
-        false
-      end
-
-      # Get the URL to authorize a user for an application via the web flow
-      #
-      # @param app_id [String] Client Id we received when our application was registered with GitHub.
-      # @option options [String] :redirect_uri The url to redirect to after authorizing.
-      # @option options [String] :scope The scopes to request from the user.
-      # @option options [String] :state A random string to protect against CSRF.
-      # @return [String] The url to redirect the user to authorize.
-      # @see Octokit::Client
-      # @see https://developer.github.com/v3/oauth/#web-application-flow
-      # @example
-      #   @client.authorize_url('xxxx')
-      def authorize_url(app_id = client_id, options = {})
-        opts = options.dup
-        if app_id.to_s.empty?
-          raise Octokit::ApplicationCredentialsRequired, 'client_id required'
-        end
-
-        authorize_url = opts.delete(:endpoint) || Octokit.web_endpoint
-        authorize_url << "login/oauth/authorize?client_id=#{app_id}"
-
-        require 'cgi'
-        opts.each do |key, value|
-          authorize_url << "&#{key}=#{CGI.escape value}"
-        end
-
-        authorize_url
-      end
-    end
-  end
-end