octokit 4.22.0 → 7.0.0

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -1,34 +1,34 @@
+# frozen_string_literal: true
+
 module Octokit
   class EnterpriseManagementConsoleClient
-
     # Methods for the Enterprise Management Console API
     #
     # @see https://developer.github.com/v3/enterprise-admin/management_console/
     module ManagementConsole
-
       # Uploads a license for the first time
       #
       # @param license [String] The path to your .ghl license file.
       # @param settings [Hash] A hash configuration of the initial settings.
       #
-      # @see http: //git.io/j5NT
+      # @see https://docs.github.com/en/enterprise-server@3.4/rest/enterprise-admin/management-console#create-a-github-license
       # @return nil
       def upload_license(license, settings = nil)
         conn = faraday_configuration
 
-        params = { }
+        params = {}
         params[:license] = Faraday::UploadIO.new(license, 'binary')
         params[:password] = @management_console_password
-        params[:settings] = "#{settings.to_json}" unless settings.nil?
+        params[:settings] = settings.to_json.to_s unless settings.nil?
 
-        @last_response = conn.post("/setup/api/start", params)
+        @last_response = conn.post('/setup/api/start', params)
       end
 
       # Start a configuration process.
       #
       # @return nil
       def start_configuration
-        post "/setup/api/configure", password_hash
+        post '/setup/api/configure', password_hash
       end
 
       # Upgrade an Enterprise installation
@@ -39,27 +39,27 @@ module Octokit
       def upgrade(license)
         conn = faraday_configuration
 
-        params = { }
+        params = {}
         params[:license] = Faraday::UploadIO.new(license, 'binary')
         params[:api_key] = @management_console_password
-        @last_response = conn.post("/setup/api/upgrade", params)
+        @last_response = conn.post('/setup/api/upgrade', params)
       end
 
       # Get information about the Enterprise installation
       #
       # @return [Sawyer::Resource] The installation information
       def config_status
-        get "/setup/api/configcheck", password_hash
+        get '/setup/api/configcheck', password_hash
       end
-      alias :config_check :config_status
+      alias config_check config_status
 
       # Get information about the Enterprise installation
       #
       # @return [Sawyer::Resource] The settings
       def settings
-        get "/setup/api/settings", password_hash
+        get '/setup/api/settings', password_hash
       end
-      alias :get_settings :settings
+      alias get_settings settings
 
       # Modify the Enterprise settings
       #
@@ -68,17 +68,17 @@ module Octokit
       # @return [nil]
       def edit_settings(settings)
         queries = password_hash
-        queries[:query][:settings] = "#{settings.to_json}"
-        put "/setup/api/settings", queries
+        queries[:query][:settings] = settings.to_json.to_s
+        put '/setup/api/settings', queries
       end
 
       # Get information about the Enterprise maintenance status
       #
       # @return [Sawyer::Resource] The maintenance status
       def maintenance_status
-        get "/setup/api/maintenance", password_hash
+        get '/setup/api/maintenance', password_hash
       end
-      alias :get_maintenance_status :maintenance_status
+      alias get_maintenance_status maintenance_status
 
       # Start (or turn off) the Enterprise maintenance mode
       #
@@ -86,18 +86,18 @@ module Octokit
       # @return [nil]
       def set_maintenance_status(maintenance)
         queries = password_hash
-        queries[:query][:maintenance] = "#{maintenance.to_json}"
-        post "/setup/api/maintenance", queries
+        queries[:query][:maintenance] = maintenance.to_json.to_s
+        post '/setup/api/maintenance', queries
       end
-      alias :edit_maintenance_status :set_maintenance_status
+      alias edit_maintenance_status set_maintenance_status
 
       # Fetch the authorized SSH keys on the Enterprise install
       #
       # @return [Sawyer::Resource] An array of authorized SSH keys
       def authorized_keys
-        get "/setup/api/settings/authorized-keys", password_hash
+        get '/setup/api/settings/authorized-keys', password_hash
       end
-      alias :get_authorized_keys :authorized_keys
+      alias get_authorized_keys authorized_keys
 
       # Add an authorized SSH keys on the Enterprise install
       #
@@ -108,7 +108,7 @@ module Octokit
         case key
         when String
           if File.exist?(key)
-            key = File.open(key, "r")
+            key = File.open(key, 'r')
             content = key.read.strip
             key.close
           else
@@ -120,7 +120,7 @@ module Octokit
         end
 
         queries[:query][:authorized_key] = content
-        post "/setup/api/settings/authorized-keys", queries
+        post '/setup/api/settings/authorized-keys', queries
       end
 
       # Removes an authorized SSH keys from the Enterprise install
@@ -132,7 +132,7 @@ module Octokit
         case key
         when String
           if File.exist?(key)
-            key = File.open(key, "r")
+            key = File.open(key, 'r')
             content = key.read.strip
             key.close
           else
@@ -144,27 +144,27 @@ module Octokit
         end
 
         queries[:query][:authorized_key] = content
-        delete "/setup/api/settings/authorized-keys", queries
+        delete '/setup/api/settings/authorized-keys', queries
       end
-      alias :delete_authorized_key :remove_authorized_key
-
+      alias delete_authorized_key remove_authorized_key
     end
+
     private
 
     def password_hash
-      { :query => { :api_key => @management_console_password } }
+      { query: { api_key: @management_console_password } }
     end
 
     # We fall back to raw Faraday for handling the licenses because I'm suspicious
-    # that Sawyer isn't handling binary POSTs correctly: http://git.io/jMir
+    # that Sawyer isn't handling binary POSTs correctly: https://github.com/lostisland/sawyer/blob/03fca4c020f465ec42856d0486ec3991859b0aed/lib/sawyer/agent.rb#L85
     def faraday_configuration
-      @faraday_configuration ||= Faraday.new(:url => @management_console_endpoint) do |http|
+      @faraday_configuration ||= Faraday.new(url: @management_console_endpoint) do |http|
         http.headers[:user_agent] = user_agent
         http.request :multipart
         http.request :url_encoded
 
         # Disabling SSL is essential for certain self-hosted Enterprise instances
-        if self.connection_options[:ssl] && !self.connection_options[:ssl][:verify]
+        if connection_options[:ssl] && !connection_options[:ssl][:verify]
           http.ssl[:verify] = false
         end
 

data/lib/octokit/enterprise_management_console_client.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'octokit/configurable'
 require 'octokit/connection'
 require 'octokit/warnable'
 require 'octokit/enterprise_management_console_client/management_console'
 
 module Octokit
-
   # EnterpriseManagementConsoleClient is only meant to be used by GitHub Enterprise Admins
   # and provides access to the management console API endpoints.
   #
@@ -12,7 +13,6 @@ module Octokit
   #   and GitHub Enterprise.
   # @see https://developer.github.com/v3/enterprise-admin/management_console/
   class EnterpriseManagementConsoleClient
-
     include Octokit::Configurable
     include Octokit::Connection
     include Octokit::Warnable
@@ -20,7 +20,13 @@ module Octokit
 
     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|
+        # rubocop:enable Style/HashEachMethods
         instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
       end
     end

data/lib/octokit/error.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Octokit
   # Custom error class for rescuing from all GitHub errors
   class Error < StandardError
     attr_reader :context
+
     # Returns the appropriate Octokit::Error subclass based
     # on status and response message
     #
@@ -34,13 +37,13 @@ module Octokit
       end
     end
 
-     def build_error_context
-       if RATE_LIMITED_ERRORS.include?(self.class)
-         @context = Octokit::RateLimit.from_response(@response)
-       end
-     end
+    def build_error_context
+      if RATE_LIMITED_ERRORS.include?(self.class)
+        @context = Octokit::RateLimit.from_response(@response)
+      end
+    end
 
-    def initialize(response=nil)
+    def initialize(response = nil)
       @response = response
       super(build_error_message)
       build_error_context
@@ -55,7 +58,9 @@ module Octokit
 
     # Returns most appropriate error for 401 HTTP status code
     # @private
+    # rubocop:disable Naming/VariableNumber
     def self.error_for_401(headers)
+      # rubocop:enbale Naming/VariableNumber
       if Octokit::OneTimePasswordRequired.required_header(headers)
         Octokit::OneTimePasswordRequired
       else
@@ -66,25 +71,27 @@ module Octokit
     # Returns most appropriate error for 403 HTTP status code
     # @private
     def self.error_for_403(body)
-      if body =~ /rate limit exceeded/i
+      # rubocop:enable Naming/VariableNumber
+      case body
+      when /rate limit exceeded/i, /exceeded a secondary rate limit/i
         Octokit::TooManyRequests
-      elsif body =~ /login attempts exceeded/i
+      when /login attempts exceeded/i
         Octokit::TooManyLoginAttempts
-      elsif body =~ /returns blobs up to [0-9]+ MB/i
+      when /(returns|for) blobs (up to|between) [0-9-]+ MB/i
         Octokit::TooLargeContent
-      elsif body =~ /abuse/i
+      when /abuse/i
         Octokit::AbuseDetected
-      elsif body =~ /repository access blocked/i
+      when /repository access blocked/i
         Octokit::RepositoryUnavailable
-      elsif body =~ /email address must be verified/i
+      when /email address must be verified/i
         Octokit::UnverifiedEmail
-      elsif body =~ /account was suspended/i
+      when /account was suspended/i
         Octokit::AccountSuspended
-      elsif body =~ /billing issue/i
+      when /billing issue/i
         Octokit::BillingIssue
-      elsif body =~ /Resource protected by organization SAML enforcement/i
+      when /Resource protected by organization SAML enforcement/i
         Octokit::SAMLProtected
-      elsif body =~ /suspended your access|This installation has been suspended/i
+      when /suspended your access|This installation has been suspended/i
         Octokit::InstallationSuspended
       else
         Octokit::Forbidden
@@ -93,7 +100,9 @@ module Octokit
 
     # Return most appropriate error for 404 HTTP status code
     # @private
+    # rubocop:disable Naming/VariableNumber
     def self.error_for_404(body)
+      # rubocop:enable Naming/VariableNumber
       if body =~ /Branch not protected/i
         Octokit::BranchNotProtected
       else
@@ -103,7 +112,9 @@ module Octokit
 
     # Return most appropriate error for 422 HTTP status code
     # @private
+    # rubocop:disable Naming/VariableNumber
     def self.error_for_422(body)
+      # rubocop:enable Naming/VariableNumber
       if body =~ /PullRequestReviewComment/i && body =~ /(commit_id|end_commit_oid) is not part of the pull request/i
         Octokit::CommitIsNotPartOfPullRequest
       elsif body =~ /Path diff too large/i
@@ -116,7 +127,7 @@ module Octokit
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
-      if data && data.is_a?(Hash)
+      if data.is_a?(Hash)
         data[:errors] || []
       else
         []
@@ -150,15 +161,13 @@ module Octokit
       @data ||=
         if (body = @response[:body]) && !body.empty?
           if body.is_a?(String) &&
-            @response[:response_headers] &&
-            @response[:response_headers][:content_type] =~ /json/
+             @response[:response_headers] &&
+             @response[:response_headers][:content_type] =~ /json/
 
             Sawyer::Agent.serializer.decode(body)
           else
             body
           end
-        else
-          nil
         end
     end
 
@@ -178,10 +187,10 @@ module Octokit
     def response_error_summary
       return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
 
-      summary = "\nError summary:\n"
+      summary = +"\nError summary:\n"
       summary << data[:errors].map do |error|
         if error.is_a? Hash
-          error.map { |k,v| "  #{k}: #{v}" }
+          error.map { |k, v| "  #{k}: #{v}" }
         else
           "  #{error}"
         end
@@ -193,19 +202,21 @@ module Octokit
     def build_error_message
       return nil if @response.nil?
 
-      message =  "#{@response[:method].to_s.upcase} "
-      message << redact_url(@response[:url].to_s) + ": "
+      message = +"#{@response[:method].to_s.upcase} "
+      message << "#{redact_url(@response[:url].to_s.dup)}: "
       message << "#{@response[:status]} - "
-      message << "#{response_message}" unless response_message.nil?
-      message << "#{response_error}" unless response_error.nil?
-      message << "#{response_error_summary}" unless response_error_summary.nil?
+      message << response_message.to_s unless response_message.nil?
+      message << response_error.to_s unless response_error.nil?
+      message << response_error_summary.to_s unless response_error_summary.nil?
       message << " // See: #{documentation_url}" unless documentation_url.nil?
       message
     end
 
     def redact_url(url_string)
-      %w[client_secret access_token].each do |token|
-        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
+      %w[client_secret access_token api_key].each do |token|
+        if url_string.include? token
+          url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)")
+        end
       end
       url_string
     end
@@ -223,10 +234,10 @@ module Octokit
   # Raised when GitHub returns a 401 HTTP status code
   # and headers include "X-GitHub-OTP"
   class OneTimePasswordRequired < ClientError
-    #@private
-    OTP_DELIVERY_PATTERN = /required; (\w+)/i
+    # @private
+    OTP_DELIVERY_PATTERN = /required; (\w+)/i.freeze
 
-    #@private
+    # @private
     def self.required_header(headers)
       OTP_DELIVERY_PATTERN.match headers['X-GitHub-OTP'].to_s
     end
@@ -348,5 +359,5 @@ module Octokit
   # Raised when a repository is created with an invalid format
   class InvalidRepository < ArgumentError; end
 
-  RATE_LIMITED_ERRORS = [Octokit::TooManyRequests, Octokit::AbuseDetected]
+  RATE_LIMITED_ERRORS = [Octokit::TooManyRequests, Octokit::AbuseDetected].freeze
 end

data/lib/octokit/gist.rb

@@ -1,8 +1,8 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Class to parse and create Gist URLs
   class Gist
-
     # !@attribute id
     #   @return [String] Gist ID
     attr_accessor :id
@@ -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)
@@ -31,6 +31,5 @@ module Octokit
     def url
       "https://gist.github.com/#{@id}"
     end
-
   end
 end

data/lib/octokit/middleware/follow_redirects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'set'
 
@@ -7,9 +9,7 @@ require 'set'
 # https://github.com/lostisland/faraday_middleware/blob/138766e/lib/faraday_middleware/response/follow_redirects.rb
 
 module Octokit
-
   module Middleware
-
     # Public: Exception thrown when the maximum amount of requests is exceeded.
     class RedirectLimitReached < Faraday::ClientError
       attr_reader :response
@@ -30,13 +30,13 @@ module Octokit
     # doesn't support parallelism.
     class FollowRedirects < Faraday::Middleware
       # HTTP methods for which 30x redirects can be followed
-      ALLOWED_METHODS = Set.new [:head, :options, :get, :post, :put, :patch, :delete]
+      ALLOWED_METHODS = Set.new %i[head options get post put patch delete]
 
       # HTTP redirect status codes that this middleware implements
       REDIRECT_CODES  = Set.new [301, 302, 303, 307]
 
       # Keys in env hash which will get cleared between requests
-      ENV_TO_CLEAR    = Set.new [:status, :response, :response_headers]
+      ENV_TO_CLEAR    = Set.new %i[status response response_headers]
 
       # Default value for max redirects followed
       FOLLOW_LIMIT = 3
@@ -44,7 +44,7 @@ module Octokit
       # Regex that matches characters that need to be escaped in URLs, sans
       # the "%" character which we assume already represents an escaped
       # sequence.
-      URI_UNSAFE = /[^\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]%]/
+      URI_UNSAFE = %r{[^\-_.!~*'()a-zA-Z\d;/?:@&=+$,\[\]%]}.freeze
 
       # Public: Initialize the middleware.
       #
@@ -64,7 +64,7 @@ module Octokit
       private
 
       def convert_to_get?(response)
-        ![:head, :options].include?(response.env[:method]) &&
+        !%i[head options].include?(response.env[:method]) &&
           @convert_to_get.include?(response.status)
       end
 
@@ -75,6 +75,7 @@ module Octokit
         response.on_complete do |response_env|
           if follow_redirect?(response_env, response)
             raise(RedirectLimitReached, response) if follows.zero?
+
             new_request_env = update_env(response_env, request_body, response)
             response = perform_with_redirection(new_request_env, follows - 1)
           end
@@ -84,12 +85,12 @@ module Octokit
 
       def update_env(env, request_body, response)
         original_url = env[:url]
-        env[:url] += safe_escape(response["location"])
+        env[:url] += safe_escape(response['location'])
         unless same_host?(original_url, env[:url])
           # HACK: Faraday’s Authorization middlewares don’t touch the request if the `Authorization` header is set.
           #       This is a workaround to drop authentication info.
           #       See https://github.com/octokit/octokit.rb/pull/1359#issuecomment-925609697
-          env[:request_headers]["Authorization"] = "dummy"
+          env[:request_headers]['Authorization'] = 'dummy'
         end
 
         if convert_to_get?(response)
@@ -125,9 +126,9 @@ module Octokit
       # URI:HTTP using the `+` operator. Doesn't escape "%" characters so to not
       # risk double-escaping.
       def safe_escape(uri)
-        uri.to_s.gsub(URI_UNSAFE) { |match|
-          "%" + match.unpack("H2" * match.bytesize).join("%").upcase
-        }
+        uri.to_s.gsub(URI_UNSAFE) do |match|
+          "%#{match.unpack('H2' * match.bytesize).join('%').upcase}"
+        end
       end
     end
   end

data/lib/octokit/organization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Octokit
   # GitHub organization class to generate API path urls
   class Organization
@@ -5,7 +7,7 @@ module Octokit
     #
     # @param org [String, Integer] GitHub organization login or id
     # @return [String] Organization Api path
-    def self.path org
+    def self.path(org)
       case org
       when String
         "orgs/#{org}"

data/lib/octokit/rate_limit.rb

@@ -1,5 +1,6 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Class for API Rate Limit info
   #
   # @!attribute [w] limit
@@ -13,17 +14,18 @@ module Octokit
   #
   # @see https://developer.github.com/v3/#rate-limiting
   class RateLimit < Struct.new(:limit, :remaining, :resets_at, :resets_in)
-
     # Get rate limit info from HTTP response
     #
     # @param response [#headers] HTTP response
     # @return [RateLimit]
     def self.from_response(response)
       info = new
-      if response && 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/repo_arguments.rb

@@ -1,9 +1,9 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Class to extract options from Ruby arguments for
   # Repository-related methods
   class RepoArguments < Arguments
-
     # !@attribute [r] repo
     #   @return [Repository]
     attr_reader :repo
@@ -14,6 +14,5 @@ module Octokit
 
       arguments
     end
-
   end
 end