octokit 4.21.0 → 10.0.0

data/lib/octokit/manage_ghes_client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'octokit/configurable'
+require 'octokit/connection'
+require 'octokit/warnable'
+require 'octokit/manage_ghes_client/manage_ghes'
+
+module Octokit
+  # ManageGHESClient is only meant to be used by GitHub Enterprise Server (GHES) operators
+  # and provides access to the Manage GHES API endpoints.
+  #
+  # @see Octokit::Client Use Octokit::Client for regular API use for GitHub
+  #   and GitHub Enterprise.
+  # @see https://developer.github.com/v3/enterprise-admin/manage-ghes/
+  class ManageGHESClient
+    include Octokit::Configurable
+    include Octokit::Connection
+    include Octokit::Warnable
+    include Octokit::ManageGHESClient::ManageAPI
+
+    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
+
+    protected
+
+    def endpoint
+      manage_ghes_endpoint
+    end
+
+    # Set Manage GHES API endpoint
+    #
+    # @param value [String] Manage GHES API endpoint
+    def manage_ghes_endpoint=(value)
+      reset_agent
+      @manage_ghes_endpoint = value
+    end
+
+    # Set Manage GHES API username
+    #
+    # @param value [String] Manage GHES API username
+    def manage_ghes_username=(value)
+      reset_agent
+      @manage_ghes_username = value
+    end
+
+    # Set Manage GHES API password
+    #
+    # @param value [String] Manage GHES API password
+    def manage_ghes_password=(value)
+      reset_agent
+      @manage_ghes_password = value
+    end
+  end
+end

data/lib/octokit/middleware/follow_redirects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'set'
 
@@ -7,15 +9,13 @@ 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
 
       def initialize(response)
-        super "too many redirects; last one to: #{response['location']}"
+        super("too many redirects; last one to: #{response['location']}")
         @response = response
       end
     end
@@ -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,9 +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])
-          env[:request_headers].delete("Authorization")
+          # 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'
         end
 
         if convert_to_get?(response)
@@ -122,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,19 +1,18 @@
-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
 
     def initialize(args)
-      arguments = super(args)
+      arguments = super
       @repo = arguments.shift
 
       arguments
     end
-
   end
 end

data/lib/octokit/repository.rb

@@ -1,19 +1,21 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Class to parse GitHub repository owner and name from
   # URLs and to generate URLs
   class Repository
     attr_accessor :owner, :name, :id
-    NAME_WITH_OWNER_PATTERN = /\A[\w.-]+\/[\w.-]+\z/i
+
+    NAME_WITH_OWNER_PATTERN = %r{\A[\w.-]+/[\w.-]+\z}i.freeze
 
     # Instantiate from a GitHub repository URL
     #
     # @return [Repository]
     def self.from_url(url)
-      new URI.parse(url).path[1..-1].
-        gsub(/^repos\//,'').
-        split('/', 3)[0..1].
-        join('/')
+      new URI.parse(url).path[1..]
+             .gsub(%r{^repos/}, '')
+             .split('/', 3)[0..1]
+             .join('/')
     end
 
     # @raise [Octokit::InvalidRepository] if the repository
@@ -23,7 +25,7 @@ module Octokit
       when Integer
         @id = repo
       when NAME_WITH_OWNER_PATTERN
-        @owner, @name = repo.split("/")
+        @owner, @name = repo.split('/')
       when Repository
         @owner = repo.owner
         @name = repo.name
@@ -33,9 +35,7 @@ module Octokit
       else
         raise_invalid_repository!(repo)
       end
-      if @owner && @name
-        validate_owner_and_name!(repo)
-      end
+      validate_owner_and_name!(repo) if @owner && @name
     end
 
     # Repository owner/name
@@ -43,18 +43,19 @@ module Octokit
     def slug
       "#{@owner}/#{@name}"
     end
-    alias :to_s :slug
+    alias to_s slug
 
     # @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
     # @param repo [Integer, String, Hash, Repository] A GitHub repository.
     # @return [String] Api path.
-    def self.path repo
+    def self.path(repo)
       new(repo).path
     end
 
@@ -74,22 +75,28 @@ module Octokit
       "#{Octokit.web_endpoint}#{slug}"
     end
 
-    alias :user :owner
-    alias :username :owner
-    alias :repo :name
+    alias user owner
+    alias username owner
+    alias repo name
 
     private
 
-      def validate_owner_and_name!(repo)
-        if @owner.include?('/') || @name.include?('/') || !url.match(URI::ABS_URI)
-          raise_invalid_repository!(repo)
-        end
-      end
+    ABS_URI_REGEXP = if URI.const_defined?(:RFC2396_PARSER) # Ruby 3.4+
+                       URI::RFC2396_PARSER.regexp.fetch(:ABS_URI)
+                     else
+                       URI::RFC2396_Parser.new.regexp.fetch(:ABS_URI)
+                     end
 
-      def raise_invalid_repository!(repo)
-        msg = "#{repo.inspect} is invalid as a repository identifier. " +
-              "Use the user/repo (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys."
-        raise Octokit::InvalidRepository, msg
+    def validate_owner_and_name!(repo)
+      if @owner.include?('/') || @name.include?('/') || !url.match?(ABS_URI_REGEXP)
+        raise_invalid_repository!(repo)
       end
+    end
+
+    def raise_invalid_repository!(repo)
+      msg = "#{repo.inspect} is invalid as a repository identifier. " \
+            'Use the user/repo (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys.'
+      raise Octokit::InvalidRepository, msg
+    end
   end
 end

data/lib/octokit/response/base_middleware.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Octokit
+  module Response
+    # In Faraday 2.x, Faraday::Response::Middleware was removed
+    BaseMiddleware = defined?(Faraday::Response::Middleware) ? Faraday::Response::Middleware : Faraday::Middleware
+  end
+end

data/lib/octokit/response/feed_parser.rb

@@ -1,19 +1,17 @@
-require 'faraday'
+# frozen_string_literal: true
 
-module Octokit
+require 'octokit/response/base_middleware'
 
+module Octokit
   module Response
-
     # Parses RSS and Atom feed responses.
-    class FeedParser < Faraday::Response::Middleware
-
+    class FeedParser < BaseMiddleware
       def on_complete(env)
-        if env[:response_headers]["content-type"] =~ /(\batom|\brss)/
+        if env[:response_headers]['content-type'] =~ /(\batom|\brss)/
           require 'rss'
           env[:body] = RSS::Parser.parse env[:body]
         end
       end
-
     end
   end
 end

data/lib/octokit/response/raise_error.rb

@@ -1,14 +1,14 @@
-require 'faraday'
+# frozen_string_literal: true
+
+require 'octokit/response/base_middleware'
 require 'octokit/error'
 
 module Octokit
   # Faraday response middleware
   module Response
-
     # This class raises an Octokit-flavored exception based
     # HTTP status codes returned by the API
-    class RaiseError < Faraday::Response::Middleware
-
+    class RaiseError < BaseMiddleware
       def on_complete(response)
         if error = Octokit::Error.from_response(response)
           raise error

data/lib/octokit/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Octokit
   # GitHub user class to generate API path urls
   class User
@@ -5,14 +7,14 @@ module Octokit
     #
     # @param user [String, Integer] GitHub user login or id
     # @return [String] User Api path
-    def self.path user
+    def self.path(user)
       case user
       when String
         "users/#{user}"
       when Integer
         "user/#{user}"
       else
-        "user"
+        'user'
       end
     end
   end

data/lib/octokit/version.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 4
+  MAJOR = 10
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 21
+  MINOR = 0
 
   # Current patch level.
   # @return [Integer]

data/lib/octokit/warnable.rb

@@ -1,17 +1,16 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Allows warnings to be suppressed via environment variable.
   module Warnable
+    module_function
 
     # Wrapper around Kernel#warn to print warnings unless
     # OCTOKIT_SILENT is set to true.
     #
     # @return [nil]
     def octokit_warn(*message)
-      unless ENV['OCTOKIT_SILENT']
-        warn message
-      end
+      warn message unless ENV['OCTOKIT_SILENT']
     end
   end
 end
-

data/lib/octokit.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
+require 'octokit/default'
 require 'octokit/client'
 require 'octokit/enterprise_admin_client'
 require 'octokit/enterprise_management_console_client'
-require 'octokit/default'
+require 'octokit/manage_ghes_client'
 
 # Ruby toolkit for the GitHub API
 module Octokit
-
   class << self
     include Octokit::Configurable
 
@@ -14,6 +16,7 @@ module Octokit
     # @return [Octokit::Client] API wrapper
     def client
       return @client if defined?(@client) && @client.same_options?(options)
+
       @client = Octokit::Client.new(options)
     end
 
@@ -21,7 +24,10 @@ module Octokit
     #
     # @return [Octokit::EnterpriseAdminClient] API wrapper
     def enterprise_admin_client
-      return @enterprise_admin_client if defined?(@enterprise_admin_client) && @enterprise_admin_client.same_options?(options)
+      if defined?(@enterprise_admin_client) && @enterprise_admin_client.same_options?(options)
+        return @enterprise_admin_client
+      end
+
       @enterprise_admin_client = Octokit::EnterpriseAdminClient.new(options)
     end
 
@@ -29,16 +35,31 @@ module Octokit
     #
     # @return [Octokit::EnterpriseManagementConsoleClient] API wrapper
     def enterprise_management_console_client
-      return @enterprise_management_console_client if defined?(@enterprise_management_console_client) && @enterprise_management_console_client.same_options?(options)
+      if defined?(@enterprise_management_console_client) && @enterprise_management_console_client.same_options?(options)
+        return @enterprise_management_console_client
+      end
+
       @enterprise_management_console_client = Octokit::EnterpriseManagementConsoleClient.new(options)
     end
 
+    # ManageGHESClient client based on configured options {Configurable}
+    #
+    # @return [Octokit::ManageGHESClient] API wrapper
+    def manage_ghes_client
+      if defined?(@manage_ghes_client) && @manage_ghes_client.same_options?(options)
+        return @manage_ghes_client
+      end
+
+      @manage_ghes_client = Octokit::ManageGHESClient.new(options)
+    end
+
     private
 
-    def respond_to_missing?(method_name, include_private=false)
+    def respond_to_missing?(method_name, include_private = false)
       client.respond_to?(method_name, include_private) ||
-      enterprise_admin_client.respond_to?(method_name, include_private) ||
-      enterprise_management_console_client.respond_to?(method_name, include_private)
+        enterprise_admin_client.respond_to?(method_name, include_private) ||
+        enterprise_management_console_client.respond_to?(method_name, include_private) ||
+        manage_ghes_client.respond_to?(method_name, include_private)
     end
 
     def method_missing(method_name, *args, &block)
@@ -48,11 +69,12 @@ module Octokit
         return enterprise_admin_client.send(method_name, *args, &block)
       elsif enterprise_management_console_client.respond_to?(method_name)
         return enterprise_management_console_client.send(method_name, *args, &block)
+      elsif manage_ghes_client.respond_to?(method_name)
+        return manage_ghes_client.send(method_name, *args, &block)
       end
 
       super
     end
-
   end
 end
 

data/octokit.gemspec

@@ -1,23 +1,24 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $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 'sawyer', '>= 0.5.3', '~> 0.8.0'
-  spec.add_dependency 'faraday', '>= 0.9'
-  spec.authors = ["Wynn Netherland", "Erik Michaels-Ober", "Clint Shryock"]
-  spec.description = %q{Simple wrapper for the GitHub API}
+  spec.add_dependency 'faraday', '>= 1', '< 3'
+  spec.add_dependency 'sawyer', '~> 0.9'
+  spec.authors = ['Wynn Netherland', 'Erik Michaels-Ober', 'Clint Shryock']
+  spec.description = 'Simple wrapper for the GitHub API'
   spec.email = ['wynn.netherland@gmail.com', 'sferik@gmail.com', 'clint@ctshryock.com']
-  spec.files = %w(.document CONTRIBUTING.md LICENSE.md README.md Rakefile octokit.gemspec)
-  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files = %w[.document CONTRIBUTING.md LICENSE.md README.md Rakefile octokit.gemspec]
+  spec.files += Dir.glob('lib/**/*.rb')
   spec.homepage = 'https://github.com/octokit/octokit.rb'
   spec.licenses = ['MIT']
   spec.name = 'octokit'
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.7.0'
   spec.required_rubygems_version = '>= 1.3.5'
-  spec.summary = "Ruby toolkit for working with the GitHub API"
+  spec.summary = 'Ruby toolkit for working with the GitHub API'
   spec.version = Octokit::VERSION.dup
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 end