octokit 4.22.0 → 7.0.0

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,7 +43,7 @@ module Octokit
     def slug
       "#{@owner}/#{@name}"
     end
-    alias :to_s :slug
+    alias to_s slug
 
     # @return [String] Repository API path
     def path
@@ -54,7 +54,7 @@ module Octokit
     # 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 +74,22 @@ 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
+    def validate_owner_and_name!(repo)
+      if @owner.include?('/') || @name.include?('/') || !url.match(URI::ABS_URI)
+        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
+    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 = 7
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 22
+  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,12 @@
+# frozen_string_literal: true
+
+require 'octokit/default'
 require 'octokit/client'
 require 'octokit/enterprise_admin_client'
 require 'octokit/enterprise_management_console_client'
-require 'octokit/default'
 
 # Ruby toolkit for the GitHub API
 module Octokit
-
   class << self
     include Octokit::Configurable
 
@@ -14,6 +15,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 +23,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 +34,19 @@ 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
 
     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)
     end
 
     def method_missing(method_name, *args, &block)
@@ -52,7 +60,6 @@ module Octokit
 
       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

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.22.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Wynn Netherland
 - Erik Michaels-Ober
 - Clint Shryock
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -22,7 +22,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -36,34 +36,14 @@ dependencies:
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  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.8.0
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Simple wrapper for the GitHub API
@@ -85,21 +65,26 @@ files:
 - lib/octokit/arguments.rb
 - lib/octokit/authentication.rb
 - lib/octokit/client.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/authorizations.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
@@ -134,6 +119,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
@@ -151,10 +137,10 @@ files:
 - lib/octokit/gist.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
@@ -164,8 +150,9 @@ files:
 homepage: https://github.com/octokit/octokit.rb
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,15 +160,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.0.dev
+signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API
 test_files: []

data/lib/octokit/client/authorizations.rb

@@ -1,182 +0,0 @@
-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)
-          raise ArgumentError.new("Client ID and Secret required for idempotent authorizations") unless client_id && client_secret
-
-          # 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.new("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