octokit 4.21.0 → 10.0.0

data/lib/octokit/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'octokit/connection'
 require 'octokit/warnable'
 require 'octokit/arguments'
@@ -9,13 +11,15 @@ require 'octokit/rate_limit'
 require 'octokit/repository'
 require 'octokit/user'
 require 'octokit/organization'
-require 'octokit/preview'
+require 'octokit/client/actions_artifacts'
 require 'octokit/client/actions_secrets'
 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/code_scanning'
+require 'octokit/client/codespaces_secrets'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
 require 'octokit/client/commit_pulls'
@@ -23,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'
@@ -44,7 +50,6 @@ require 'octokit/client/objects'
 require 'octokit/client/organizations'
 require 'octokit/client/pages'
 require 'octokit/client/projects'
-require 'octokit/client/pub_sub_hubbub'
 require 'octokit/client/pull_requests'
 require 'octokit/client/rate_limit'
 require 'octokit/client/reactions'
@@ -59,33 +64,35 @@ 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'
 
 module Octokit
-
   # Client for the GitHub API
   #
   # @see https://developer.github.com
   class Client
-
     include Octokit::Authentication
     include Octokit::Configurable
     include Octokit::Connection
-    include Octokit::Preview
     include Octokit::Warnable
+    include Octokit::Client::ActionsArtifacts
     include Octokit::Client::ActionsSecrets
-    include Octokit::Client::Authorizations
     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
@@ -93,6 +100,7 @@ module Octokit
     include Octokit::Client::Gitignore
     include Octokit::Client::Hooks
     include Octokit::Client::ActionsWorkflows
+    include Octokit::Client::ActionsWorkflowJobs
     include Octokit::Client::ActionsWorkflowRuns
     include Octokit::Client::Apps
     include Octokit::Client::Issues
@@ -109,7 +117,6 @@ module Octokit
     include Octokit::Client::Organizations
     include Octokit::Client::Pages
     include Octokit::Client::Projects
-    include Octokit::Client::PubSubHubbub
     include Octokit::Client::PullRequests
     include Octokit::Client::RateLimit
     include Octokit::Client::Reactions
@@ -124,16 +131,24 @@ 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
 
     # Header keys that can be passed in options hash to {#get},{#head}
-    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+    CONVENIENCE_HEADERS = Set.new(%i[accept content_type])
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
+      #
+      # rubocop:disable Style/HashEachMethods
+      #
+      # This may look like a `.keys.each` which should be replaced with `#each_key`, but
+      # this doesn't actually work, since `#keys` is just a method we've defined ourselves.
+      # The class doesn't fulfill the whole `Enumerable` contract.
       Octokit::Configurable.keys.each do |key|
-        value = options.key?(key) ? options[key] : Octokit.instance_variable_get(:"@#{key}")
+        # rubocop:enable Style/HashEachMethods
+        value = options[key].nil? ? Octokit.instance_variable_get(:"@#{key}") : options[key]
         instance_variable_set(:"@#{key}", value)
       end
 
@@ -148,11 +163,17 @@ module Octokit
 
       # mask password
       inspected.gsub! @password, '*******' if @password
-      inspected.gsub! @management_console_password, '*******' if @management_console_password
+      if @management_console_password
+        inspected.gsub! @management_console_password, '*******'
+      end
       inspected.gsub! @bearer_token, '********' if @bearer_token
       # Only show last 4 of token, secret
-      inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}" if @access_token
-      inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}" if @client_secret
+      if @access_token
+        inspected.gsub! @access_token, "#{'*' * 36}#{@access_token[36..]}"
+      end
+      if @client_secret
+        inspected.gsub! @client_secret, "#{'*' * 36}#{@client_secret[36..]}"
+      end
 
       inspected
     end
@@ -170,11 +191,12 @@ module Octokit
     #     # GET https://foo:bar@api.github.com/
     #     client.get "/"
     #   end
-    def as_app(key = client_id, secret = client_secret, &block)
+    def as_app(key = client_id, secret = client_secret)
       if key.to_s.empty? || secret.to_s.empty?
-        raise ApplicationCredentialsRequired, "client_id and client_secret required"
+        raise ApplicationCredentialsRequired, 'client_id and client_secret required'
       end
-      app_client = self.dup
+
+      app_client = dup
       app_client.client_id = app_client.client_secret = nil
       app_client.login    = key
       app_client.password = secret
@@ -235,15 +257,17 @@ module Octokit
       conn_opts[:url] = @api_endpoint
       conn_opts[:builder] = @middleware.dup if @middleware
       conn_opts[:proxy] = @proxy if @proxy
-      conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      conn_opts[:ssl] = { verify_mode: @ssl_verify_mode } if @ssl_verify_mode
       conn = Faraday.new(conn_opts) do |http|
+        http_cache_middleware = http.builder.handlers.delete(Faraday::HttpCache) if Faraday.const_defined?(:HttpCache)
         if basic_authenticated?
-          http.basic_auth(@login, @password)
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
-          http.authorization 'token', @access_token
+          http.request :authorization, 'token', @access_token
         elsif bearer_authenticated?
-          http.authorization 'Bearer', @bearer_token
+          http.request :authorization, 'Bearer', @bearer_token
         end
+        http.builder.handlers.push(http_cache_middleware) unless http_cache_middleware.nil?
         http.headers['accept'] = options[:accept] if options.key?(:accept)
       end
       conn.builder.delete(Octokit::Middleware::FollowRedirects)

data/lib/octokit/configurable.rb

@@ -1,5 +1,6 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Configuration options for {Client}, defaulting to values
   # in {Default}
   module Configurable
@@ -31,6 +32,12 @@ module Octokit
     #   @return [String] An admin password set up for your GitHub Enterprise management console
     # @!attribute management_console_endpoint
     #   @return [String] Base URL for API requests to the GitHub Enterprise management console
+    # @!attribute manage_ghes_endpoint
+    #   @return [String] Base URL for API requests to the GitHub Enterprise Server Manage API
+    # @!attribute manage_ghes_username
+    #   @return [String] API username for requests to the GitHub Enterprise Server Manage API
+    # @!attribute manage_ghes_password
+    #   @return [String] API user password for requests to the GitHub Enterprise Server Manage API
     # @!attribute middleware
     #   @see https://github.com/lostisland/faraday
     #   @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@@ -58,34 +65,39 @@ module Octokit
                   :middleware, :netrc, :netrc_file,
                   :per_page, :proxy, :ssl_verify_mode, :user_agent
     attr_writer :password, :web_endpoint, :api_endpoint, :login,
-                :management_console_endpoint, :management_console_password
+                :management_console_endpoint, :management_console_password,
+                :manage_ghes_endpoint,
+                :manage_ghes_username,
+                :manage_ghes_password
 
     class << self
-
       # List of configurable keys for {Octokit::Client}
       # @return [Array] of option keys
       def keys
-        @keys ||= [
-          :access_token,
-          :api_endpoint,
-          :auto_paginate,
-          :bearer_token,
-          :client_id,
-          :client_secret,
-          :connection_options,
-          :default_media_type,
-          :login,
-          :management_console_endpoint,
-          :management_console_password,
-          :middleware,
-          :netrc,
-          :netrc_file,
-          :per_page,
-          :password,
-          :proxy,
-          :ssl_verify_mode,
-          :user_agent,
-          :web_endpoint
+        @keys ||= %i[
+          access_token
+          api_endpoint
+          auto_paginate
+          bearer_token
+          client_id
+          client_secret
+          connection_options
+          default_media_type
+          login
+          management_console_endpoint
+          management_console_password
+          manage_ghes_endpoint
+          manage_ghes_username
+          manage_ghes_password
+          middleware
+          netrc
+          netrc_file
+          per_page
+          password
+          proxy
+          ssl_verify_mode
+          user_agent
+          web_endpoint
         ]
       end
     end
@@ -97,7 +109,13 @@ module Octokit
 
     # Reset configuration options to default values
     def reset!
+      # rubocop:disable Style/HashEachMethods
+      #
+      # This may look like a `.keys.each` which should be replaced with `#each_key`, but
+      # this doesn't actually work, since `#keys` is just a method we've defined ourselves.
+      # The class doesn't fulfill the whole `Enumerable` contract.
       Octokit::Configurable.keys.each do |key|
+        # rubocop:enable Style/HashEachMethods
         instance_variable_set(:"@#{key}", Octokit::Default.options[key])
       end
       self
@@ -113,24 +131,26 @@ module Octokit
     end
 
     def api_endpoint
-      File.join(@api_endpoint, "")
+      File.join(@api_endpoint, '')
     end
 
     def management_console_endpoint
-      File.join(@management_console_endpoint, "")
+      File.join(@management_console_endpoint, '')
+    end
+
+    def manage_ghes_endpoint
+      File.join(@manage_ghes_endpoint, '')
     end
 
     # Base URL for generated web URLs
     #
     # @return [String] Default: https://github.com/
     def web_endpoint
-      File.join(@web_endpoint, "")
+      File.join(@web_endpoint, '')
     end
 
     def login
-      @login ||= begin
-        user.login if token_authenticated?
-      end
+      @login ||= (user.login if token_authenticated?)
     end
 
     def netrc?
@@ -140,7 +160,7 @@ module Octokit
     private
 
     def options
-      Hash[Octokit::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+      Octokit::Configurable.keys.to_h { |key| [key, instance_variable_get(:"@#{key}")] }
     end
 
     def fetch_client_id_and_secret(overrides = {})

data/lib/octokit/connection.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require 'sawyer'
 require 'octokit/authentication'
 module Octokit
-
   # Network layer for API clients.
   module Connection
-
     include Octokit::Authentication
 
     # Header keys that can be passed in options hash to {#get},{#head}
-    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+    CONVENIENCE_HEADERS = Set.new(%i[accept content_type])
 
     # Make a HTTP GET request
     #
@@ -75,17 +75,17 @@ module Octokit
     #   contains the contents of the requests so far and the second parameter
     #   contains the latest response.
     # @return [Sawyer::Resource]
-    def paginate(url, options = {}, &block)
+    def paginate(url, options = {})
       opts = parse_query_and_convenience_headers(options)
       if @auto_paginate || @per_page
-        opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
+        opts[:query][:per_page] ||= @per_page || (@auto_paginate ? 100 : nil)
       end
 
       data = request(:get, url, opts.dup)
 
       if @auto_paginate
         while @last_response.rels[:next] && rate_limit.remaining > 0
-          @last_response = @last_response.rels[:next].get(:headers => opts[:headers])
+          @last_response = @last_response.rels[:next].get(headers: opts[:headers])
           if block_given?
             yield(data, @last_response)
           else
@@ -104,17 +104,19 @@ module Octokit
     def agent
       @agent ||= Sawyer::Agent.new(endpoint, sawyer_options) do |http|
         http.headers[:accept] = default_media_type
-        http.headers[:content_type] = "application/json"
+        http.headers[:content_type] = 'application/json'
         http.headers[:user_agent] = user_agent
+        http_cache_middleware = http.builder.handlers.delete(Faraday::HttpCache) if Faraday.const_defined?(:HttpCache)
         if basic_authenticated?
-          http.basic_auth(@login, @password)
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
-          http.authorization 'token', @access_token
+          http.request :authorization, 'token', @access_token
         elsif bearer_authenticated?
-          http.authorization 'Bearer', @bearer_token
+          http.request :authorization, 'Bearer', @bearer_token
         elsif application_authenticated?
-          http.basic_auth(@client_id, @client_secret)
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret)
         end
+        http.builder.handlers.push(http_cache_middleware) unless http_cache_middleware.nil?
       end
     end
 
@@ -122,7 +124,7 @@ module Octokit
     #
     # @return [Sawyer::Resource]
     def root
-      get "/"
+      get '/'
     end
 
     # Response for last HTTP request
@@ -154,10 +156,10 @@ module Octokit
       end
 
       @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
-      response.data
-    rescue Octokit::Error => error
+      response_data_correctly_encoded(response)
+    rescue Octokit::Error => e
       @last_response = nil
-      raise error
+      raise e
     end
 
     # Executes the request, checking if it was successful
@@ -170,21 +172,20 @@ module Octokit
       false
     end
 
-
     def sawyer_options
       opts = {
-        :links_parser => Sawyer::LinkParsers::Simple.new
+        links_parser: Sawyer::LinkParsers::Simple.new
       }
       conn_opts = @connection_options
-      conn_opts[:builder] = @middleware if @middleware
+      conn_opts[:builder] = @middleware.dup if @middleware
       conn_opts[:proxy] = @proxy if @proxy
       if conn_opts[:ssl].nil?
-        conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+        conn_opts[:ssl] = { verify_mode: @ssl_verify_mode } if @ssl_verify_mode
       else
         verify = @connection_options[:ssl][:verify]
         conn_opts[:ssl] = {
-          :verify => verify,
-          :verify_mode => verify == false ? 0 : @ssl_verify_mode
+          verify: verify,
+          verify_mode: verify == false ? 0 : @ssl_verify_mode
         }
       end
       opts[:faraday] = Faraday.new(conn_opts)
@@ -194,18 +195,26 @@ module Octokit
 
     def parse_query_and_convenience_headers(options)
       options = options.dup
-      headers = options.delete(:headers) { Hash.new }
+      headers = options.delete(:headers) { {} }
       CONVENIENCE_HEADERS.each do |h|
         if header = options.delete(h)
           headers[h] = header
         end
       end
       query = options.delete(:query)
-      opts = {:query => options}
-      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts = { query: options }
+      opts[:query].merge!(query) if query.is_a?(Hash)
       opts[:headers] = headers unless headers.empty?
 
       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