octokit 4.25.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fb998f706df43131e06c214bd4db92440fe39efa77569b1e883f0a31a8fa8f4
-  data.tar.gz: 9ae3da4441db278a0a143b6d6cd38734beb6060ecc8339b002c483156da6069a
+  metadata.gz: abc3f58113bc1ba895a10399af08ffa4cb77046d7ec70b58772fd562a7136f7c
+  data.tar.gz: ccb63539ce291e0146c604643445ca0a4013d6329f6345f3dee4a92d01206970
 SHA512:
-  metadata.gz: d01307c7c2a1ab08c1867ffcdbd26633c83844834345637acbde2dc794b02cf219181e3d90031beda91169812483a1637b3c2cf7af5028a01b03ce7b58d95785
-  data.tar.gz: 30da625ea0b0d89b1cc000ffee759fb3f8a4289940190281899a397c15dce692ebf3dced181b2a9e863ea7a118b7f23fefe491da8f1af0650c3e6d8856edd479
+  metadata.gz: ca2ff431a0b98c1e38ec32c6fe46c405d5f741a97b33b3288bf44c1cb6641da1ddbd91988114f2174a0740c75c5ab4a63b2b61111a77dfe06ce77ea2b02280dd
+  data.tar.gz: 83638f66161513b9f437906515e3f83bc205b1003d9c7fa11d96579d3bab05b19adfd2969c4b59f44d568b9924c75f16fd5aee91b907d6dc3d655e816a9317b4

data/README.md

@@ -1,5 +1,8 @@
 # Octokit
 
+> **Note**
+> We've recently renamed the `4-stable` branch to `main`. This might affect you if you're making changes to Octokit's code locally. For more details and for the steps to reconfigure your local clone for the new branch name, check out [this post](https://github.com/octokit/octokit.rb/discussions/1455).
+
 Ruby toolkit for the GitHub API.
 
 ![logo](https://docs.github.com/assets/images/gundamcat.png)
@@ -740,8 +743,6 @@ when writing new specs.
 This library aims to support and is [tested against][actions] the following Ruby
 implementations:
 
-* Ruby 2.5
-* Ruby 2.6
 * Ruby 2.7
 * Ruby 3.0
 * Ruby 3.1

data/lib/octokit/client/actions_workflow_jobs.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Actions Workflows jobs API
+    #
+    # @see https://docs.github.com/rest/actions/workflow-jobs
+    module ActionsWorkflowJobs
+      # Get a job for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param job_id [Integer, String] Id of the job
+      #
+      # @return [Sawyer::Resource] Job information
+      # @see https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
+      def workflow_run_job(repo, job_id, options = {})
+        get "#{Repository.path repo}/actions/jobs/#{job_id}", options
+      end
+
+      # Download job logs for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param job_id [Integer, String] Id of the job
+      #
+      # @return [String] URL to the archived log files of the job
+      # @see https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
+      def workflow_run_job_logs(repo, job_id, options = {})
+        url = "#{Repository.path repo}/actions/jobs/#{job_id}/logs"
+
+        response = client_without_redirects.head(url, options)
+        response.headers['Location']
+      end
+
+      # List jobs for a workflow run attempt
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param run_id [Integer, String] Id of the workflow run
+      # @param attempt_number [Integer, String] Attempt number of the workflow run
+      #
+      # @return [Sawyer::Resource] Jobs information
+      # @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
+      def workflow_run_attempt_jobs(repo, run_id, attempt_number, options = {})
+        paginate "#{Repository.path repo}/actions/runs/#{run_id}/attempts/#{attempt_number}/jobs", options
+      end
+      alias list_workflow_run_attempt_jobs workflow_run_attempt_jobs
+
+      # List jobs for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param run_id [Integer, String] Id of the workflow run
+      # @option options [String] :filter Optional filtering by a `completed_at` timestamp
+      #
+      # @return [Sawyer::Resource] Jobs information
+      # @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
+      def workflow_run_jobs(repo, run_id, options = {})
+        paginate "#{Repository.path repo}/actions/runs/#{run_id}/jobs", options
+      end
+      alias list_workflow_run_jobs workflow_run_jobs
+    end
+  end
+end

data/lib/octokit/client/actions_workflow_runs.rb

@@ -2,6 +2,9 @@
 
 module Octokit
   class Client
+    # Methods for the Actions Workflows runs API
+    #
+    # @see https://docs.github.com/rest/actions/workflow-runs
     module ActionsWorkflowRuns
       # List all runs for a repository workflow
       #
@@ -92,7 +95,7 @@ module Octokit
         response.headers['Location']
       end
 
-      # Delets all log files of a workflow run
+      # Delete all log files of a workflow run
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param id [Integer] Id of a workflow run
@@ -102,6 +105,17 @@ module Octokit
       def delete_workflow_run_logs(repo, id, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/actions/runs/#{id}/logs", options
       end
+
+      # Get workflow run usage
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Sawyer::Resource] Run usage
+      # @see https://developer.github.com/v3/actions/workflow-runs/#get-workflow-run-usage
+      def workflow_run_usage(repo, id, options = {})
+        get "#{Repository.path repo}/actions/runs/#{id}/timing", options
+      end
     end
   end
 end

data/lib/octokit/client/actions_workflows.rb

@@ -39,6 +39,28 @@ module Octokit
       def workflow_dispatch(repo, id, ref, options = {})
         boolean_from_response :post, "#{Repository.path repo}/actions/workflows/#{id}/dispatches", options.merge({ ref: ref })
       end
+
+      # Enable a workflow
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      #
+      # @return [Boolean] True if workflow was enabled, false otherwise
+      # @see https://docs.github.com/en/rest/actions/workflows#enable-a-workflow
+      def workflow_enable(repo, id, options = {})
+        boolean_from_response :put, "#{Repository.path repo}/actions/workflows/#{id}/enable", options
+      end
+
+      # Disable a workflow
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      #
+      # @return [Boolean] True if workflow was disabled, false otherwise
+      # @see https://docs.github.com/en/rest/actions/workflows#disable-a-workflow
+      def workflow_disable(repo, id, options = {})
+        boolean_from_response :put, "#{Repository.path repo}/actions/workflows/#{id}/disable", options
+      end
     end
   end
 end

data/lib/octokit/client/apps.rb

@@ -29,9 +29,9 @@ module Octokit
 
       def find_integration_installations(options = {})
         octokit_warn(
-          'Deprecated: Octokit::Client::Apps#find_integration_installations '\
-          'method is deprecated. Please update your call to use '\
-          'Octokit::Client::Apps#find_app_installations before the next major '\
+          'Deprecated: Octokit::Client::Apps#find_integration_installations ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#find_app_installations before the next major ' \
           'Octokit version update.'
         )
         find_app_installations(options)
@@ -76,9 +76,9 @@ module Octokit
 
       def create_integration_installation_access_token(installation, options = {})
         octokit_warn(
-          'Deprecated: Octokit::Client::Apps#create_integration_installation_access_token '\
-          'method is deprecated. Please update your call to use '\
-          'Octokit::Client::Apps#create_app_installation_access_token before the next major '\
+          'Deprecated: Octokit::Client::Apps#create_integration_installation_access_token ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#create_app_installation_access_token before the next major ' \
           'Octokit version update.'
         )
         create_app_installation_access_token(installation, options)
@@ -136,9 +136,9 @@ module Octokit
 
       def list_integration_installation_repositories(options = {})
         octokit_warn(
-          'Deprecated: Octokit::Client::Apps#list_integration_installation_repositories '\
-          'method is deprecated. Please update your call to use '\
-          'Octokit::Client::Apps#list_app_installation_repositories before the next major '\
+          'Deprecated: Octokit::Client::Apps#list_integration_installation_repositories ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#list_app_installation_repositories before the next major ' \
           'Octokit version update.'
         )
         list_app_installation_repositories(options)
@@ -160,9 +160,9 @@ module Octokit
 
       def add_repository_to_integration_installation(installation, repo, options = {})
         octokit_warn(
-          'Deprecated: Octokit::Client::Apps#add_repository_to_integration_installation '\
-          'method is deprecated. Please update your call to use '\
-          'Octokit::Client::Apps#add_repository_to_app_installation before the next major '\
+          'Deprecated: Octokit::Client::Apps#add_repository_to_integration_installation ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#add_repository_to_app_installation before the next major ' \
           'Octokit version update.'
         )
         add_repository_to_app_installation(installation, repo, options)
@@ -184,9 +184,9 @@ module Octokit
 
       def remove_repository_from_integration_installation(installation, repo, options = {})
         octokit_warn(
-          'Deprecated: Octokit::Client::Apps#remove_repository_from_integration_installation '\
-          'method is deprecated. Please update your call to use '\
-          'Octokit::Client::Apps#remove_repository_from_app_installation before the next major '\
+          'Deprecated: Octokit::Client::Apps#remove_repository_from_integration_installation ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#remove_repository_from_app_installation before the next major ' \
           'Octokit version update.'
         )
         remove_repository_from_app_installation(installation, repo, options)

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -18,11 +18,11 @@ module Octokit
       #   client.subscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
       def subscribe(topic, callback, secret = nil)
         options = {
-          "hub.callback": callback,
-          "hub.mode": 'subscribe',
-          "hub.topic": topic
+          'hub.callback': callback,
+          'hub.mode': 'subscribe',
+          'hub.topic': topic
         }
-        options.merge!("hub.secret": secret) unless secret.nil?
+        options.merge!('hub.secret': secret) unless secret.nil?
 
         response = pub_sub_hubbub_request(options)
 
@@ -40,9 +40,9 @@ module Octokit
       #   client.unsubscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
       def unsubscribe(topic, callback)
         options = {
-          "hub.callback": callback,
-          "hub.mode": 'unsubscribe',
-          "hub.topic": topic
+          'hub.callback': callback,
+          'hub.mode': 'unsubscribe',
+          'hub.topic': topic
         }
         response = pub_sub_hubbub_request(options)
 
@@ -91,7 +91,7 @@ module Octokit
         conn = Faraday.new(url: @api_endpoint) do |http|
           http.headers[:user_agent] = user_agent
           if basic_authenticated?
-            http.request *FARADAY_BASIC_AUTH_KEYS, @login, @password
+            http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
           elsif token_authenticated?
             http.request :authorization, 'token', @access_token
           end

data/lib/octokit/client/repositories.rb

@@ -13,9 +13,7 @@ module Octokit
       # @return [Boolean]
       def repository?(repo, options = {})
         !!repository(repo, options)
-      rescue Octokit::InvalidRepository
-        false
-      rescue Octokit::NotFound
+      rescue Octokit::InvalidRepository, Octokit::NotFound
         false
       end
 

data/lib/octokit/client/reviews.rb

@@ -161,7 +161,7 @@ module Octokit
         # TODO(5.0): remove deprecated behavior
         if reviewers.is_a?(Array)
           octokit_warn(
-            'Deprecated: Octokit::Client#request_pull_request_review '\
+            'Deprecated: Octokit::Client#request_pull_request_review ' \
             "no longer takes a separate :reviewers argument.\n" \
             'Please update your call to pass :reviewers and :team_reviewers as part of the options hash.'
           )
@@ -194,7 +194,7 @@ module Octokit
         # TODO(5.0): remove deprecated behavior
         if !reviewers.empty? && !options.empty?
           octokit_warn(
-            'Deprecated: Octokit::Client#delete_pull_request_review_request '\
+            'Deprecated: Octokit::Client#delete_pull_request_review_request ' \
             "no longer takes a separate :reviewers argument.\n" \
             'Please update your call to pass :reviewers and :team_reviewers as part of the options hash.'
           )

data/lib/octokit/client/search.rb

@@ -64,6 +64,20 @@ module Octokit
       end
       alias search_repos search_repositories
 
+      # Search topics
+      #
+      # @param query [String] Search term and qualifiers
+      # @param options [Hash] Sort and pagination options
+      # @option options [String] :sort Sort field
+      # @option options [String] :order Sort order (asc or desc)
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
+      # @return [Sawyer::Resource] Search results object
+      # @see https://developer.github.com/v3/search/#search-topics
+      def search_topics(query, options = {})
+        search 'search/topics', query, options
+      end
+
       # Search users
       #
       # @param query [String] Search term and qualifiers

data/lib/octokit/client.rb

@@ -14,6 +14,7 @@ require 'octokit/organization'
 require 'octokit/preview'
 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'
@@ -93,6 +94,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
@@ -252,7 +254,7 @@ module Octokit
       conn_opts[:ssl] = { verify_mode: @ssl_verify_mode } if @ssl_verify_mode
       conn = Faraday.new(conn_opts) do |http|
         if basic_authenticated?
-          http.request *FARADAY_BASIC_AUTH_KEYS, @login, @password
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
           http.request :authorization, 'token', @access_token
         elsif bearer_authenticated?

data/lib/octokit/configurable.rb

@@ -134,9 +134,7 @@ module Octokit
     end
 
     def login
-      @login ||= begin
-        user.login if token_authenticated?
-      end
+      @login ||= (user.login if token_authenticated?)
     end
 
     def netrc?
@@ -146,7 +144,7 @@ module Octokit
     private
 
     def options
-      Hash[Octokit::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }]
+      Octokit::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }.to_h
     end
 
     def fetch_client_id_and_secret(overrides = {})

data/lib/octokit/connection.rb

@@ -107,13 +107,13 @@ module Octokit
         http.headers[:content_type] = 'application/json'
         http.headers[:user_agent] = user_agent
         if basic_authenticated?
-          http.request *FARADAY_BASIC_AUTH_KEYS, @login, @password
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
           http.request :authorization, 'token', @access_token
         elsif bearer_authenticated?
           http.request :authorization, 'Bearer', @bearer_token
         elsif application_authenticated?
-          http.request *FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret)
         end
       end
     end
@@ -201,7 +201,7 @@ module Octokit
       end
       query = options.delete(:query)
       opts = { query: options }
-      opts[:query].merge!(query) if query&.is_a?(Hash)
+      opts[:query].merge!(query) if query.is_a?(Hash)
       opts[:headers] = headers unless headers.empty?
 
       opts

data/lib/octokit/default.rb

@@ -35,8 +35,7 @@ module Octokit
       # so we use it only when it's available.
       if defined?(Faraday::Request::Retry)
         builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
-      end
-      if defined?(Faraday::Retry::Middleware)
+      elsif defined?(Faraday::Retry::Middleware)
         builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError]
       end
 
@@ -50,55 +49,55 @@ module Octokit
       # Configuration options
       # @return [Hash]
       def options
-        Hash[Octokit::Configurable.keys.map { |key| [key, send(key)] }]
+        Octokit::Configurable.keys.map { |key| [key, send(key)] }.to_h
       end
 
       # Default access token from ENV
       # @return [String]
       def access_token
-        ENV['OCTOKIT_ACCESS_TOKEN']
+        ENV.fetch('OCTOKIT_ACCESS_TOKEN', nil)
       end
 
       # Default API endpoint from ENV or {API_ENDPOINT}
       # @return [String]
       def api_endpoint
-        ENV['OCTOKIT_API_ENDPOINT'] || API_ENDPOINT
+        ENV.fetch('OCTOKIT_API_ENDPOINT') { API_ENDPOINT }
       end
 
       # Default pagination preference from ENV
       # @return [String]
       def auto_paginate
-        ENV['OCTOKIT_AUTO_PAGINATE']
+        ENV.fetch('OCTOKIT_AUTO_PAGINATE', nil)
       end
 
       # Default bearer token from ENV
       # @return [String]
       def bearer_token
-        ENV['OCTOKIT_BEARER_TOKEN']
+        ENV.fetch('OCTOKIT_BEARER_TOKEN', nil)
       end
 
       # Default OAuth app key from ENV
       # @return [String]
       def client_id
-        ENV['OCTOKIT_CLIENT_ID']
+        ENV.fetch('OCTOKIT_CLIENT_ID', nil)
       end
 
       # Default OAuth app secret from ENV
       # @return [String]
       def client_secret
-        ENV['OCTOKIT_SECRET']
+        ENV.fetch('OCTOKIT_SECRET', nil)
       end
 
       # Default management console password from ENV
       # @return [String]
       def management_console_password
-        ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD']
+        ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD', nil)
       end
 
       # Default management console endpoint from ENV
       # @return [String]
       def management_console_endpoint
-        ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT']
+        ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT', nil)
       end
 
       # Default options for Faraday::Connection
@@ -115,13 +114,13 @@ module Octokit
       # Default media type from ENV or {MEDIA_TYPE}
       # @return [String]
       def default_media_type
-        ENV['OCTOKIT_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
+        ENV.fetch('OCTOKIT_DEFAULT_MEDIA_TYPE') { MEDIA_TYPE }
       end
 
       # Default GitHub username for Basic Auth from ENV
       # @return [String]
       def login
-        ENV['OCTOKIT_LOGIN']
+        ENV.fetch('OCTOKIT_LOGIN', nil)
       end
 
       # Default middleware stack for Faraday::Connection
@@ -134,13 +133,13 @@ module Octokit
       # Default GitHub password for Basic Auth from ENV
       # @return [String]
       def password
-        ENV['OCTOKIT_PASSWORD']
+        ENV.fetch('OCTOKIT_PASSWORD', nil)
       end
 
       # Default pagination page size from ENV
       # @return [Integer] Page size
       def per_page
-        page_size = ENV['OCTOKIT_PER_PAGE']
+        page_size = ENV.fetch('OCTOKIT_PER_PAGE', nil)
 
         page_size&.to_i
       end
@@ -148,7 +147,7 @@ module Octokit
       # Default proxy server URI for Faraday connection from ENV
       # @return [String]
       def proxy
-        ENV['OCTOKIT_PROXY']
+        ENV.fetch('OCTOKIT_PROXY', nil)
       end
 
       # Default SSL verify mode from ENV
@@ -163,25 +162,25 @@ module Octokit
       # Default User-Agent header string from ENV or {USER_AGENT}
       # @return [String]
       def user_agent
-        ENV['OCTOKIT_USER_AGENT'] || USER_AGENT
+        ENV.fetch('OCTOKIT_USER_AGENT') { USER_AGENT }
       end
 
       # Default web endpoint from ENV or {WEB_ENDPOINT}
       # @return [String]
       def web_endpoint
-        ENV['OCTOKIT_WEB_ENDPOINT'] || WEB_ENDPOINT
+        ENV.fetch('OCTOKIT_WEB_ENDPOINT') { WEB_ENDPOINT }
       end
 
       # Default behavior for reading .netrc file
       # @return [Boolean]
       def netrc
-        ENV['OCTOKIT_NETRC'] || false
+        ENV.fetch('OCTOKIT_NETRC', false)
       end
 
       # Default path for .netrc file
       # @return [String]
       def netrc_file
-        ENV['OCTOKIT_NETRC_FILE'] || File.join(ENV['HOME'].to_s, '.netrc')
+        ENV.fetch('OCTOKIT_NETRC_FILE') { File.join(Dir.home.to_s, '.netrc') }
       end
     end
   end

data/lib/octokit/error.rb

@@ -4,6 +4,7 @@ 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
     #
@@ -57,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
@@ -68,27 +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
-        Octokit::TooManyRequests
-      elsif body =~ /exceeded a secondary rate limit/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 blobs up to [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
@@ -97,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
@@ -107,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
@@ -120,7 +127,7 @@ module Octokit
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
-      if data&.is_a?(Hash)
+      if data.is_a?(Hash)
         data[:errors] || []
       else
         []
@@ -196,7 +203,7 @@ module Octokit
       return nil if @response.nil?
 
       message = +"#{@response[:method].to_s.upcase} "
-      message << redact_url(@response[:url].to_s.dup) + ': '
+      message << "#{redact_url(@response[:url].to_s.dup)}: "
       message << "#{@response[:status]} - "
       message << response_message.to_s unless response_message.nil?
       message << response_error.to_s unless response_error.nil?

data/lib/octokit/middleware/follow_redirects.rb

@@ -127,7 +127,7 @@ module Octokit
       # risk double-escaping.
       def safe_escape(uri)
         uri.to_s.gsub(URI_UNSAFE) do |match|
-          '%' + match.unpack('H2' * match.bytesize).join('%').upcase
+          "%#{match.unpack('H2' * match.bytesize).join('%').upcase}"
         end
       end
     end

data/lib/octokit/rate_limit.rb

@@ -20,7 +20,7 @@ module Octokit
     # @return [RateLimit]
     def self.from_response(response)
       info = new
-      if response&.respond_to?(:headers) && !response.headers.nil?
+      if 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)

data/lib/octokit/repository.rb

@@ -5,6 +5,7 @@ module Octokit
   # URLs and to generate URLs
   class Repository
     attr_accessor :owner, :name, :id
+
     NAME_WITH_OWNER_PATTERN = %r{\A[\w.-]+/[\w.-]+\z}i.freeze
 
     # Instantiate from a GitHub repository URL

data/lib/octokit/version.rb

@@ -3,11 +3,11 @@
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 4
+  MAJOR = 5
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 25
+  MINOR = 1
 
   # Current patch level.
   # @return [Integer]

data/octokit.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   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.version = Octokit::VERSION.dup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.25.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - lib/octokit/authentication.rb
 - lib/octokit/client.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
@@ -175,14 +176,14 @@ 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
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API