octokit 4.24.0 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1799b946b7c31e79fac5c7119b602d1722151236d02e732a664870a8227f218e
-  data.tar.gz: 21496697905a025d01e370816a828ddb7ac4201a9ec845ec0d1290d77c44f858
+  metadata.gz: 4fb998f706df43131e06c214bd4db92440fe39efa77569b1e883f0a31a8fa8f4
+  data.tar.gz: 9ae3da4441db278a0a143b6d6cd38734beb6060ecc8339b002c483156da6069a
 SHA512:
-  metadata.gz: 0ad2e6793ef84011dd8e290d18773a0c8c5f24e3a584ccdc24d64696382cd6bfca146cd07f6fe7e8b1ee40b9f564a4a2298453bd0c548374c01c7b9e47150bd7
-  data.tar.gz: 9ef11f4b675a4b08d7d5fafbbccad82b2c1f05488c89604c59af6488222e44e55952a286166e8a3f9658523c3707b6ce35c8942d83dbcbbfae8a6f0b360e8940
+  metadata.gz: d01307c7c2a1ab08c1867ffcdbd26633c83844834345637acbde2dc794b02cf219181e3d90031beda91169812483a1637b3c2cf7af5028a01b03ce7b58d95785
+  data.tar.gz: 30da625ea0b0d89b1cc000ffee759fb3f8a4289940190281899a397c15dce692ebf3dced181b2a9e863ea7a118b7f23fefe491da8f1af0650c3e6d8856edd479

data/Rakefile

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :test => :spec
-task :default => :spec
+task test: :spec
+task default: :spec
 
 namespace :doc do
   begin
@@ -14,7 +16,7 @@ namespace :doc do
       task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
       task.options = [
         '--output-dir', 'doc/yard',
-        '--markup', 'markdown',
+        '--markup', 'markdown'
       ]
     end
   rescue LoadError

data/lib/ext/sawyer/relation.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'sawyer'
 
 patch = Module.new do
-  def href(options=nil)
+  def href(options = nil)
     # Temporary workaround for: https://github.com/octokit/octokit.rb/issues/727
-    name.to_s == "ssh" ? @href : super
+    name.to_s == 'ssh' ? @href : super
   end
 end
 

data/lib/octokit/arguments.rb

@@ -1,5 +1,6 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Extracts options from method arguments
   # @private
   class Arguments < Array
@@ -9,6 +10,5 @@ module Octokit
       @options = args.last.is_a?(::Hash) ? args.pop : {}
       super(args)
     end
-
   end
 end

data/lib/octokit/authentication.rb

@@ -1,12 +1,12 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Authentication methods for {Octokit::Client}
   module Authentication
-
     # In Faraday 2.x, the authorization middleware uses new interface
     FARADAY_BASIC_AUTH_KEYS =
       if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
-        [:authorization, :basic]
+        %i[authorization basic]
       else
         [:basic_auth]
       end
@@ -74,8 +74,7 @@ module Octokit
         self.password = creds.shift
       end
     rescue LoadError
-      octokit_warn "Please install netrc gem for .netrc support"
+      octokit_warn 'Please install netrc gem for .netrc support'
     end
-
   end
 end

data/lib/octokit/client/actions_secrets.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Actions Secrets API
     #
     # @see https://developer.github.com/v3/actions/secrets/
     module ActionsSecrets
-
       # Get public key for secrets encryption
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -15,7 +15,6 @@ module Octokit
         get "#{Repository.path repo}/actions/secrets/public-key"
       end
 
-
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

data/lib/octokit/client/actions_workflow_runs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
     module ActionsWorkflowRuns

data/lib/octokit/client/actions_workflows.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
     # Methods for the Actions Workflows API
     #
     # @see https://developer.github.com/v3/actions/workflows
     module ActionsWorkflows
-
       # Get the workflows in a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository

data/lib/octokit/client/apps.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Apps API
     module Apps
-
       # Get the authenticated App
       #
       # @param options [Hash] A customizable set of options
@@ -12,7 +12,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] App information
       def app(options = {})
-        get "app", options
+        get 'app', options
       end
 
       # Find all installations that belong to an App
@@ -23,16 +23,16 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] the total_count and an array of installations
       def find_app_installations(options = {})
-        paginate "app/installations", options
+        paginate 'app/installations', options
       end
       alias find_installations find_app_installations
 
       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 "\
-          "Octokit version update."
+          '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)
       end
@@ -45,7 +45,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] the total_count and an array of installations
       def find_user_installations(options = {})
-        paginate("user/installations", options) do |data, last_response|
+        paginate('user/installations', options) do |data, last_response|
           data.installations.concat last_response.data.installations
         end
       end
@@ -76,10 +76,10 @@ 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 "\
-          "Octokit version update."
+          '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)
       end
@@ -128,7 +128,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] the total_count and an array of repositories
       def list_app_installation_repositories(options = {})
-        paginate("installation/repositories", options) do |data, last_response|
+        paginate('installation/repositories', options) do |data, last_response|
           data.repositories.concat last_response.data.repositories
         end
       end
@@ -136,10 +136,10 @@ 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 "\
-          "Octokit version update."
+          '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)
       end
@@ -160,10 +160,10 @@ 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 "\
-          "Octokit version update."
+          '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)
       end
@@ -184,10 +184,10 @@ 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 "\
-          "Octokit version update."
+          '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)
       end

data/lib/octokit/client/authorizations.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 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.
@@ -64,16 +64,18 @@ module Octokit
         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
+          unless client_id && client_secret
+            raise ArgumentError, 'Client ID and Secret required for idempotent authorizations'
+          end
 
           # 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)
+            put "authorizations/clients/#{client_id}/#{fingerprint}", options.merge(client_secret: client_secret)
           else
-            put "authorizations/clients/#{client_id}", options.merge(:client_secret => client_secret)
+            put "authorizations/clients/#{client_id}", options.merge(client_secret: client_secret)
           end
 
         else
@@ -126,18 +128,18 @@ module Octokit
       # @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?
+        options = options.dup
+        raise ArgumentError, 'Access token required' if token.nil?
 
-        auth = { "Authorization" => "token #{token}" }
+        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
+        agent.call(:get, 'user', headers: headers)
+             .headers['X-OAuth-Scopes']
+             .to_s
+             .split(',')
+             .map(&:strip)
+             .sort
       end
 
       # Revoke all tokens for an app
@@ -146,8 +148,8 @@ module Octokit
       #
       # @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.")
+      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
 
@@ -165,8 +167,9 @@ module Octokit
       def authorize_url(app_id = client_id, options = {})
         opts = options.dup
         if app_id.to_s.empty?
-          raise Octokit::ApplicationCredentialsRequired, "client_id required"
+          raise Octokit::ApplicationCredentialsRequired, 'client_id required'
         end
+
         authorize_url = opts.delete(:endpoint) || Octokit.web_endpoint
         authorize_url << "login/oauth/authorize?client_id=#{app_id}"
 

data/lib/octokit/client/checks.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Checks API
     #
     # @see https://developer.github.com/v3/checks/
     module Checks
-
       # Methods for Check Runs
       #
       # @see https://developer.github.com/v3/checks/runs/
@@ -65,7 +65,7 @@ module Octokit
           data.total_count += last_response.data.total_count
         end
       end
-      alias :list_check_runs_for_ref :check_runs_for_ref
+      alias list_check_runs_for_ref check_runs_for_ref
 
       # List check runs in a check suite
       #
@@ -89,7 +89,7 @@ module Octokit
           data.total_count += last_response.data.total_count
         end
       end
-      alias :list_check_runs_for_check_suite :check_runs_for_check_suite
+      alias list_check_runs_for_check_suite check_runs_for_check_suite
 
       # Get a single check run
       #
@@ -151,7 +151,7 @@ module Octokit
           data.total_count += last_response.data.total_count
         end
       end
-      alias :list_check_suites_for_ref :check_suites_for_ref
+      alias list_check_suites_for_ref check_suites_for_ref
 
       # Set preferences for check suites on a repository
       #

data/lib/octokit/client/commit_branches.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Branches for HEAD API
     #
     # @see https://developer.github.com/v3/repos/commits/
     module CommitBranches
-
       # List branches for a single HEAD commit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

data/lib/octokit/client/commit_comments.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Comments API
     #
     # @see https://developer.github.com/v3/repos/comments/
     module CommitComments
-
       # List all commit comments
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -53,12 +53,12 @@ module Octokit
       #   comment.path # => "README.md"
       #   comment.line # => 10
       #   comment.position # => 1
-      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options = {})
+      def create_commit_comment(repo, sha, body, path = nil, line = nil, position = nil, options = {})
         params = {
-          :body => body,
-          :path => path,
-          :line => line,
-          :position => position
+          body: body,
+          path: path,
+          line: line,
+          position: position
         }
         post "#{Repository.path repo}/commits/#{sha}/comments", options.merge(params)
       end
@@ -76,7 +76,7 @@ module Octokit
       #   comment.body # => "Updated commit comment"
       def update_commit_comment(repo, id, body, options = {})
         params = {
-          :body => body
+          body: body
         }
         patch "#{Repository.path repo}/comments/#{id}", options.merge(params)
       end

data/lib/octokit/client/commit_pulls.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Pulls API
     #
     # @see https://developer.github.com/v3/repos/comments/
     module CommitPulls
-
       # List pulls for a single commit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

data/lib/octokit/client/commits.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module Octokit
   class Client
-
     # Methods for the Commits API
     #
     # @see https://developer.github.com/v3/repos/commits/
     module Commits
-
       # List commits
       #
       # @overload commits(repo, sha_or_branch, options = {})
@@ -23,12 +23,10 @@ module Octokit
       def commits(*args)
         arguments = Octokit::RepoArguments.new(args)
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          arguments.options[:sha] = sha_or_branch
-        end
+        arguments.options[:sha] = sha_or_branch if sha_or_branch
         paginate "#{Repository.new(arguments.repo).path}/commits", arguments.options
       end
-      alias :list_commits :commits
+      alias list_commits commits
 
       # Get commits after a specified date
       #
@@ -48,13 +46,11 @@ module Octokit
       #   Octokit.commits_since('octokit/octokit.rb', '2012-10-01')
       def commits_since(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
-        params.merge!(:since => iso8601(date))
+        params.merge!(since: iso8601(date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -74,13 +70,11 @@ module Octokit
       #   Octokit.commits_before('octokit/octokit.rb', '2012-10-01')
       def commits_before(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
-        params.merge!(:until => iso8601(date))
+        params.merge!(until: iso8601(date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -100,14 +94,12 @@ module Octokit
       #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01')
       def commits_on(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
         end_date = date + 1
-        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        params.merge!(since: iso8601(date), until: iso8601(end_date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -129,16 +121,16 @@ module Octokit
       #   Octokit.commits_between('octokit/octokit.rb', '2012-10-01', '2012-11-01')
       def commits_between(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date       = parse_date(arguments.shift)
-        end_date   = parse_date(arguments.shift)
-        raise ArgumentError, "Start date #{date} does not precede #{end_date}" if date > end_date
+        date = parse_date(arguments.shift)
+        end_date = parse_date(arguments.shift)
+        if date > end_date
+          raise ArgumentError, "Start date #{date} does not precede #{end_date}"
+        end
 
         params = arguments.options
-        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        params.merge!(since: iso8601(date), until: iso8601(end_date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -181,8 +173,8 @@ module Octokit
       #   commit.tree.sha # => "827efc6d56897b048c772eb4087f854f46256132"
       #   commit.message # => "My commit message"
       #   commit.committer # => { "name" => "Wynn Netherland", "email" => "wynn@github.com", ... }
-      def create_commit(repo, message, tree, parents=nil, options = {})
-        params = { :message => message, :tree => tree }
+      def create_commit(repo, message, tree, parents = nil, options = {})
+        params = { message: message, tree: tree }
         params[:parents] = [parents].flatten if parents
         post "#{Repository.path repo}/git/commits", options.merge(params)
       end
@@ -213,8 +205,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/merging/#perform-a-merge
       def merge(repo, base, head, options = {})
         params = {
-          :base => base,
-          :head => head
+          base: base,
+          head: head
         }.merge(options)
         post "#{Repository.path repo}/merges", params
       end
@@ -225,7 +217,7 @@ module Octokit
         if date.respond_to?(:iso8601)
           date.iso8601
         else
-          date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+          date.strftime('%Y-%m-%dT%H:%M:%S%Z')
         end
       end
 

data/lib/octokit/client/community_profile.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Community Profile API
     #
     # @see https://developer.github.com/v3/repos/community/
     module CommunityProfile
-
       # Get community profile metrics for a repository
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository