octokit 4.2.0 → 9.2.0

data/lib/octokit/rate_limit.rb

@@ -1,29 +1,31 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Class for API Rate Limit info
   #
   # @!attribute [w] limit
-  #   @return [Fixnum] Max tries per rate limit period
+  #   @return [Integer] Max tries per rate limit period
   # @!attribute [w] remaining
-  #   @return [Fixnum] Remaining tries per rate limit period
+  #   @return [Integer] Remaining tries per rate limit period
   # @!attribute [w] resets_at
   #   @return [Time] Indicates when rate limit resets
   # @!attribute [w] resets_in
-  #   @return [Fixnum] Number of seconds when rate limit resets
+  #   @return [Integer] Number of seconds when rate limit resets
   #
   # @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.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,16 +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)
-      Repository.new(URI.parse(url).path[1..-1])
+      new URI.parse(url).path[1..]
+             .gsub(%r{^repos/}, '')
+             .split('/', 3)[0..1]
+             .join('/')
     end
 
     # @raise [Octokit::InvalidRepository] if the repository
@@ -20,19 +25,17 @@ 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
       when Hash
-        @name = repo[:repo] ||= repo[:name]
-        @owner = repo[:owner] ||= repo[:user] ||= repo[:username]
+        @name = repo[:repo] || repo[:name]
+        @owner = repo[:owner] || repo[:user] || repo[:username]
       else
-        raise_invalid_repository!
-      end
-      if @owner && @name
-        validate_owner_and_name!
+        raise_invalid_repository!(repo)
       end
+      validate_owner_and_name!(repo) if @owner && @name
     end
 
     # Repository owner/name
@@ -40,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
 
@@ -71,20 +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!
-        if @owner.include?('/') || @name.include?('/') || !url.match(/\A#{URI.regexp}\z/)
-          raise_invalid_repository!
-        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!
-        raise Octokit::InvalidRepository, "Invalid Repository. Use user/repo format."
+    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,21 +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
-
-      private
-
+    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,16 +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
-
-      private
-
+    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,7 +1,9 @@
+# frozen_string_literal: true
+
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 4
+  MAJOR = 9
 
   # Current minor release.
   # @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,22 +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.0'
-  spec.add_dependency 'sawyer', '>= 0.5.3', '~> 0.6.0'
-  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 = '>= 1.9.2'
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,42 +10,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
+        version: '3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.9'
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com
@@ -60,17 +60,31 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- lib/ext/sawyer/relation.rb
 - lib/octokit.rb
 - lib/octokit/arguments.rb
 - lib/octokit/authentication.rb
 - lib/octokit/client.rb
-- lib/octokit/client/authorizations.rb
+- lib/octokit/client/actions_artifacts.rb
+- lib/octokit/client/actions_secrets.rb
+- lib/octokit/client/actions_workflow_jobs.rb
+- lib/octokit/client/actions_workflow_runs.rb
+- 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
@@ -81,23 +95,31 @@ files:
 - lib/octokit/client/legacy_search.rb
 - lib/octokit/client/licenses.rb
 - lib/octokit/client/markdown.rb
+- lib/octokit/client/marketplace.rb
 - lib/octokit/client/meta.rb
 - lib/octokit/client/milestones.rb
 - lib/octokit/client/notifications.rb
+- lib/octokit/client/oauth_applications.rb
 - lib/octokit/client/objects.rb
 - lib/octokit/client/organizations.rb
 - lib/octokit/client/pages.rb
-- lib/octokit/client/pub_sub_hubbub.rb
+- lib/octokit/client/projects.rb
 - lib/octokit/client/pull_requests.rb
 - lib/octokit/client/rate_limit.rb
+- lib/octokit/client/reactions.rb
 - lib/octokit/client/refs.rb
 - lib/octokit/client/releases.rb
 - lib/octokit/client/repositories.rb
+- lib/octokit/client/repository_invitations.rb
+- lib/octokit/client/reviews.rb
 - lib/octokit/client/say.rb
 - lib/octokit/client/search.rb
 - lib/octokit/client/service_status.rb
+- 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
 - lib/octokit/connection.rb
@@ -112,12 +134,14 @@ files:
 - lib/octokit/enterprise_management_console_client/management_console.rb
 - lib/octokit/error.rb
 - lib/octokit/gist.rb
+- lib/octokit/manage_ghes_client.rb
+- lib/octokit/manage_ghes_client/manage_ghes.rb
 - lib/octokit/middleware/follow_redirects.rb
 - lib/octokit/organization.rb
-- lib/octokit/preview.rb
 - lib/octokit/rate_limit.rb
 - lib/octokit/repo_arguments.rb
 - lib/octokit/repository.rb
+- lib/octokit/response/base_middleware.rb
 - lib/octokit/response/feed_parser.rb
 - lib/octokit/response/raise_error.rb
 - lib/octokit/user.rb
@@ -127,7 +151,8 @@ files:
 homepage: https://github.com/octokit/octokit.rb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -136,17 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API
 test_files: []
-has_rdoc: