octokit 4.24.0 → 5.0.0

data/lib/octokit/client/releases.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Releases API
     #
     # @see https://developer.github.com/v3/repos/releases/
     module Releases
-
       # List releases for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -14,7 +14,7 @@ module Octokit
       def releases(repo, options = {})
         paginate "#{Repository.path repo}/releases", options
       end
-      alias :list_releases :releases
+      alias list_releases releases
 
       # Create a release
       #
@@ -28,7 +28,7 @@ module Octokit
       # @return [Sawyer::Resource] The release
       # @see https://developer.github.com/v3/repos/releases/#create-a-release
       def create_release(repo, tag_name, options = {})
-        opts = options.merge(:tag_name => tag_name)
+        opts = options.merge(tag_name: tag_name)
         post "#{Repository.path repo}/releases", opts
       end
 
@@ -55,7 +55,7 @@ module Octokit
       def update_release(url, options = {})
         patch url, options
       end
-      alias :edit_release :update_release
+      alias edit_release update_release
 
       # Delete a release
       #
@@ -84,17 +84,18 @@ module Octokit
       # @return [Sawyer::Resource] The release asset
       # @see https://developer.github.com/v3/repos/releases/#upload-a-release-asset
       def upload_asset(release_url, path_or_file, options = {})
-        file = path_or_file.respond_to?(:read) ? path_or_file : File.new(path_or_file, "rb")
+        file = path_or_file.respond_to?(:read) ? path_or_file : File.new(path_or_file, 'rb')
         options[:content_type] ||= content_type_from_file(file)
-        raise Octokit::MissingContentType.new if options[:content_type].nil?
+        raise Octokit::MissingContentType if options[:content_type].nil?
+
         unless name = options[:name]
           name = File.basename(file.path)
         end
-        upload_url = release(release_url).rels[:upload].href_template.expand(:name => name)
+        upload_url = release(release_url).rels[:upload].href_template.expand(name: name)
 
         request :post, upload_url, file.read, parse_query_and_convenience_headers(options)
       ensure
-        file.close if file
+        file&.close
       end
 
       # Get a single release asset
@@ -117,7 +118,7 @@ module Octokit
       def update_release_asset(asset_url, options = {})
         patch(asset_url, options)
       end
-      alias :edit_release_asset :update_release_asset
+      alias edit_release_asset update_release_asset
 
       # Delete a release asset
       #
@@ -155,10 +156,9 @@ module Octokit
           mime_type.content_type
         end
       rescue LoadError
-        msg = "Please pass content_type or install mime-types gem to guess content type from file"
-        raise Octokit::MissingContentType.new(msg)
+        msg = 'Please pass content_type or install mime-types gem to guess content type from file'
+        raise Octokit::MissingContentType, msg
       end
-
     end
   end
 end

data/lib/octokit/client/repositories.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Repositories API
     #
     # @see https://developer.github.com/v3/repos/
     module Repositories
-
       # Check if a repository exists
       #
       # @see https://developer.github.com/v3/repos/#get
@@ -28,7 +28,7 @@ module Octokit
       def repository(repo, options = {})
         get Repository.path(repo), options
       end
-      alias :repo :repository
+      alias repo repository
 
       # Edit a repository
       #
@@ -53,9 +53,9 @@ module Octokit
         options[:name] ||= repo.name
         patch "repos/#{repo}", options
       end
-      alias :edit :edit_repository
-      alias :update_repository :edit_repository
-      alias :update :edit_repository
+      alias edit edit_repository
+      alias update_repository edit_repository
+      alias update edit_repository
 
       # List user repositories
       #
@@ -71,12 +71,12 @@ module Octokit
       # @param user [Integer, String] Optional GitHub user login or id for which
       #   to list repos.
       # @return [Array<Sawyer::Resource>] List of repositories
-      def repositories(user=nil, options = {})
+      def repositories(user = nil, options = {})
         paginate "#{User.path user}/repos", options
       end
-      alias :list_repositories :repositories
-      alias :list_repos :repositories
-      alias :repos :repositories
+      alias list_repositories repositories
+      alias list_repos repositories
+      alias repos repositories
 
       # List all repositories
       #
@@ -159,7 +159,7 @@ module Octokit
       def create_repository(name, options = {})
         opts = options.dup
         organization = opts.delete :organization
-        opts.merge! :name => name
+        opts.merge! name: name
         if opts.include? :is_template
           opts = ensure_api_media_type(:template_repositories, opts)
         end
@@ -170,8 +170,8 @@ module Octokit
           post "#{Organization.path organization}/repos", opts
         end
       end
-      alias :create_repo :create_repository
-      alias :create :create_repository
+      alias create_repo create_repository
+      alias create create_repository
 
       # Delete repository
       #
@@ -183,7 +183,7 @@ module Octokit
       def delete_repository(repo, options = {})
         boolean_from_response :delete, Repository.path(repo), options
       end
-      alias :delete_repo :delete_repository
+      alias delete_repo delete_repository
 
       # Transfer repository
       #
@@ -198,7 +198,7 @@ module Octokit
         options = ensure_api_media_type(:transfer_repository, options)
         post "#{Repository.path repo}/transfer", options.merge({ new_owner: new_owner })
       end
-      alias :transfer_repo :transfer_repository
+      alias transfer_repo transfer_repository
 
       # Create a repository for a user or organization generated from a template repository
       #
@@ -210,11 +210,11 @@ module Octokit
       # @option options [Boolean] :include_all_branches `true` copies all branches from the template repository, `false` (default) makes it only copy the master branch.
       # @return [Sawyer::Resource] Repository info for the new repository
       def create_repository_from_template(repo, name, options = {})
-        options.merge! :name => name
+        options.merge! name: name
         options = ensure_api_media_type(:template_repositories, options)
         post "#{Repository.path repo}/generate", options
       end
-      alias :create_repo_from_template :create_repository_from_template
+      alias create_repo_from_template create_repository_from_template
 
       # Hide a public repository
       #
@@ -222,7 +222,7 @@ module Octokit
       # @return [Sawyer::Resource] Updated repository info
       def set_private(repo, options = {})
         # GitHub Api for setting private updated to use private attr, rather than public
-        update_repository repo, options.merge({ :private => true })
+        update_repository repo, options.merge({ private: true })
       end
 
       # Unhide a private repository
@@ -231,7 +231,7 @@ module Octokit
       # @return [Sawyer::Resource] Updated repository info
       def set_public(repo, options = {})
         # GitHub Api for setting private updated to use private attr, rather than public
-        update_repository repo, options.merge({ :private => false })
+        update_repository repo, options.merge({ private: false })
       end
 
       # Get deploy keys on a repo
@@ -248,7 +248,7 @@ module Octokit
       def deploy_keys(repo, options = {})
         paginate "#{Repository.path repo}/keys", options
       end
-      alias :list_deploy_keys :deploy_keys
+      alias list_deploy_keys deploy_keys
 
       # Get a single deploy key for a repo
       #
@@ -258,7 +258,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/keys/#get-a-deploy-key
       # @example
       #   @client.deploy_key('octokit/octokit.rb', 8675309)
-      def deploy_key(repo, id, options={})
+      def deploy_key(repo, id, options = {})
         get "#{Repository.path repo}/keys/#{id}", options
       end
 
@@ -274,7 +274,7 @@ module Octokit
       # @example
       #    @client.add_deploy_key('octokit/octokit.rb', 'Staging server', 'ssh-rsa AAA...')
       def add_deploy_key(repo, title, key, options = {})
-        post "#{Repository.path repo}/keys", options.merge(:title => title, :key => key)
+        post "#{Repository.path repo}/keys", options.merge(title: title, key: key)
       end
 
       # Edit a deploy key
@@ -295,7 +295,7 @@ module Octokit
       def edit_deploy_key(repo, id, options)
         patch "#{Repository.path repo}/keys/#{id}", options
       end
-      alias :update_deploy_key :edit_deploy_key
+      alias update_deploy_key edit_deploy_key
 
       # Remove deploy key from a repo
       #
@@ -330,7 +330,7 @@ module Octokit
       def collaborators(repo, options = {})
         paginate "#{Repository.path repo}/collaborators", options
       end
-      alias :collabs :collaborators
+      alias collabs collaborators
 
       # Add collaborator to repo
       #
@@ -355,7 +355,7 @@ module Octokit
       def add_collaborator(repo, collaborator, options = {})
         boolean_from_response :put, "#{Repository.path repo}/collaborators/#{collaborator}", options
       end
-      alias :add_collab :add_collaborator
+      alias add_collab add_collaborator
 
       # Remove collaborator from repo.
       #
@@ -372,7 +372,7 @@ module Octokit
       def remove_collaborator(repo, collaborator, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/collaborators/#{collaborator}", options
       end
-      alias :remove_collab :remove_collaborator
+      alias remove_collab remove_collaborator
 
       # Checks if a user is a collaborator for a repo.
       #
@@ -384,7 +384,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator
       # @example
       #   @client.collaborator?('octokit/octokit.rb', 'holman')
-      def collaborator?(repo, collaborator, options={})
+      def collaborator?(repo, collaborator, options = {})
         boolean_from_response :get, "#{Repository.path repo}/collaborators/#{collaborator}", options
       end
 
@@ -396,7 +396,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level
       # @example
       #   @client.permission_level('octokit/octokit.rb', 'lizzhale')
-      def permission_level(repo, collaborator, options={})
+      def permission_level(repo, collaborator, options = {})
         get "#{Repository.path repo}/collaborators/#{collaborator}/permission", options
       end
 
@@ -416,8 +416,8 @@ module Octokit
       def repository_teams(repo, options = {})
         paginate "#{Repository.path repo}/teams", options
       end
-      alias :repo_teams :repository_teams
-      alias :teams :repository_teams
+      alias repo_teams repository_teams
+      alias teams repository_teams
 
       # List all topics for a repository
       #
@@ -449,7 +449,7 @@ module Octokit
       #   client.replace_all_topics('octokit/octokit.rb', [])
       def replace_all_topics(repo, names, options = {})
         opts = ensure_api_media_type(:topics, options)
-        put "#{Repository.path repo}/topics", opts.merge(:names => names)
+        put "#{Repository.path repo}/topics", opts.merge(names: names)
       end
 
       # List contributors to a repo
@@ -470,7 +470,7 @@ module Octokit
         options[:anon] = 1 if anon.to_s[/1|true/]
         paginate "#{Repository.path repo}/contributors", options
       end
-      alias :contribs :contributors
+      alias contribs contributors
 
       # List stargazers of a repo
       #
@@ -520,7 +520,7 @@ module Octokit
       def forks(repo, options = {})
         paginate "#{Repository.path repo}/forks", options
       end
-      alias :network :forks
+      alias network forks
 
       # List languages of code in the repo.
       #
@@ -578,7 +578,7 @@ module Octokit
       def branch(repo, branch, options = {})
         get "#{Repository.path repo}/branches/#{branch}", options
       end
-      alias :get_branch :branch
+      alias get_branch branch
 
       # Lock a single branch from a repository
       #
@@ -653,7 +653,7 @@ module Octokit
       #   @client.rename_branch('octokit/octokit.rb', 'master', 'main')
       def rename_branch(repo, branch, new_name, options = {})
         params = {
-          new_name: new_name,
+          new_name: new_name
         }
         post "#{Repository.path repo}/branches/#{branch}/rename", params.merge(options)
       end
@@ -674,7 +674,7 @@ module Octokit
       def repository_assignees(repo, options = {})
         paginate "#{Repository.path repo}/assignees", options
       end
-      alias :repo_assignees :repository_assignees
+      alias repo_assignees repository_assignees
 
       # Check to see if a particular user is an assignee for a repository.
       #

data/lib/octokit/client/repository_invitations.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Repository Invitations API
     #
     # @see https://developer.github.com/v3/repos/invitations/
     module RepositoryInvitations
-
       # Invite a user to a repository
       #
       # Requires authenticated client
@@ -64,7 +64,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] The users repository invitations
       # @see https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations
       def user_repository_invitations(options = {})
-        paginate "/user/repository_invitations", options
+        paginate '/user/repository_invitations', options
       end
       alias user_repo_invitations user_repository_invitations
 

data/lib/octokit/client/reviews.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Reviews API
     #
     # @see https://developer.github.com/v3/pulls/reviews/
     module Reviews
-
       # List reviews on a pull request
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -161,9 +161,9 @@ 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."
+            'Please update your call to pass :reviewers and :team_reviewers as part of the options hash.'
           )
           options = options.merge(reviewers: reviewers)
         else
@@ -190,13 +190,13 @@ module Octokit
       #   @client.delete_pull_request_review_request('octokit/octokit.rb', 2, options)
       #
       # @return [Sawyer::Resource>] Hash representing the pull request
-      def delete_pull_request_review_request(repo, id, reviewers={}, options = {})
+      def delete_pull_request_review_request(repo, id, reviewers = {}, options = {})
         # 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."
+            'Please update your call to pass :reviewers and :team_reviewers as part of the options hash.'
           )
         end
         # For backwards compatibility, this endpoint can be called with a separate reviewers hash.

data/lib/octokit/client/say.rb

@@ -1,19 +1,18 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the unpublished Octocat API
     module Say
-
       # Return a nifty ASCII Octocat with GitHub wisdom
       # or your own
       #
       # @return [String]
       def say(text = nil, options = {})
         options[:s] = text if text
-        get "octocat", options
+        get 'octocat', options
       end
-      alias :octocat :say
-
+      alias octocat say
     end
   end
 end

data/lib/octokit/client/search.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Search API
     #
     # @see https://developer.github.com/v3/search/
     module Search
-
       # Search code
       #
       # @param query [String] Search term and qualifiers
@@ -17,7 +17,7 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-code
       def search_code(query, options = {})
-        search "search/code", query, options
+        search 'search/code', query, options
       end
 
       # Search commits
@@ -32,7 +32,7 @@ module Octokit
       # @see https://developer.github.com/v3/search/#search-commits
       def search_commits(query, options = {})
         options = ensure_api_media_type(:commit_search, options)
-        search "search/commits", query, options
+        search 'search/commits', query, options
       end
 
       # Search issues
@@ -46,7 +46,7 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-issues-and-pull-requests
       def search_issues(query, options = {})
-        search "search/issues", query, options
+        search 'search/issues', query, options
       end
 
       # Search repositories
@@ -60,9 +60,9 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-repositories
       def search_repositories(query, options = {})
-        search "search/repositories", query, options
+        search 'search/repositories', query, options
       end
-      alias :search_repos :search_repositories
+      alias search_repos search_repositories
 
       # Search users
       #
@@ -75,13 +75,13 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-users
       def search_users(query, options = {})
-        search "search/users", query, options
+        search 'search/users', query, options
       end
 
       private
 
       def search(path, query, options = {})
-        opts = options.merge(:q => query)
+        opts = options.merge(q: query)
         paginate(path, opts) do |data, last_response|
           data.items.concat last_response.data.items
         end

data/lib/octokit/client/service_status.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the GitHub Status API
     #
     # @see https://status.github.com/api
     module ServiceStatus
-
       # Root for status API
       # @private
       SUMMARY_ROOT    = 'https://www.githubstatus.com/api/v2/summary.json'

data/lib/octokit/client/source_import.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Source Import API
     #
     # @see https://developer.github.com/v3/migration/source_imports
     module SourceImport
-
       # Start a source import to a GitHub repository using GitHub Importer.
       #
       # @overload start_source_import(repo, vcs, vcs_url, options = {})
@@ -39,10 +39,10 @@ module Octokit
         vcs_url = arguments.pop
         vcs = arguments.pop
         if vcs
-          octokit_warn "Octokit#start_source_import vcs parameter is now an option, please update your call before the next major Octokit version update."
-          arguments.options.merge!(:vcs => vcs)
+          octokit_warn 'Octokit#start_source_import vcs parameter is now an option, please update your call before the next major Octokit version update.'
+          arguments.options.merge!(vcs: vcs)
         end
-        options = ensure_api_media_type(:source_imports, arguments.options.merge(:vcs_url => vcs_url))
+        options = ensure_api_media_type(:source_imports, arguments.options.merge(vcs_url: vcs_url))
         put "#{Repository.path arguments.repo}/import", options
       end
 
@@ -153,7 +153,7 @@ module Octokit
       # @example
       #   @client.opt_in_source_import_lfs("octokit/octokit.rb", "opt_in")
       def set_source_import_lfs_preference(repo, use_lfs, options = {})
-        options = ensure_api_media_type(:source_imports, options.merge(:use_lfs => use_lfs))
+        options = ensure_api_media_type(:source_imports, options.merge(use_lfs: use_lfs))
         patch "#{Repository.path repo}/import/lfs", options
       end
     end

data/lib/octokit/client/stats.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Repository Statistics API
     #
     # @see https://developer.github.com/v3/repos/statistics/
     module Stats
-
       # Get contributors list with additions, deletions, and commit counts
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -16,9 +16,9 @@ module Octokit
       # @example Get contributor stats for octokit
       #   @client.contributors_stats('octokit/octokit.rb')
       def contributors_stats(repo, options = {})
-        get_stats(repo, "contributors", options)
+        get_stats(repo, 'contributors', options)
       end
-      alias :contributor_stats :contributors_stats
+      alias contributor_stats contributors_stats
 
       # Get the last year of commit activity data
       #
@@ -31,7 +31,7 @@ module Octokit
       # @example Get commit activity for octokit
       #   @client.commit_activity_stats('octokit/octokit.rb')
       def commit_activity_stats(repo, options = {})
-        get_stats(repo, "commit_activity", options)
+        get_stats(repo, 'commit_activity', options)
       end
 
       # Get the number of additions and deletions per week
@@ -45,7 +45,7 @@ module Octokit
       # @example Get code frequency stats for octokit
       #   @client.code_frequency_stats('octokit/octokit.rb')
       def code_frequency_stats(repo, options = {})
-        get_stats(repo, "code_frequency", options)
+        get_stats(repo, 'code_frequency', options)
       end
 
       # Get the weekly commit count for the repo owner and everyone else
@@ -61,7 +61,7 @@ module Octokit
       # @example Get weekly commit counts for octokit
       #   @client.participation_stats("octokit/octokit.rb")
       def participation_stats(repo, options = {})
-        get_stats(repo, "participation", options)
+        get_stats(repo, 'participation', options)
       end
 
       # Get the number of commits per hour in each day
@@ -75,9 +75,9 @@ module Octokit
       # @example Get octokit punch card
       #   @octokit.punch_card_stats
       def punch_card_stats(repo, options = {})
-        get_stats(repo, "punch_card", options)
+        get_stats(repo, 'punch_card', options)
       end
-      alias :punch_card :punch_card_stats
+      alias punch_card punch_card_stats
 
       private
 
@@ -99,6 +99,7 @@ module Octokit
           return [] if last_response.status == 204
           return nil unless retry_timeout
           return nil if Time.now >= timeout
+
           sleep retry_wait if retry_wait
         end
       end

data/lib/octokit/client/statuses.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Statuses API
     #
     # @see https://developer.github.com/v3/repos/statuses/
     module Statuses
-
       # List all statuses for a given commit
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -15,7 +15,7 @@ module Octokit
       def statuses(repo, sha, options = {})
         paginate "#{Repository.path repo}/statuses/#{sha}", options
       end
-      alias :list_statuses :statuses
+      alias list_statuses statuses
 
       # Get the combined status for a ref
       #
@@ -26,7 +26,7 @@ module Octokit
       def combined_status(repo, ref, options = {})
         get "#{Repository.path repo}/commits/#{ref}/status", options
       end
-      alias :status :combined_status
+      alias status combined_status
 
       # Create status for a commit
       #
@@ -39,7 +39,7 @@ module Octokit
       # @return [Sawyer::Resource] A status
       # @see https://developer.github.com/v3/repos/statuses/#create-a-status
       def create_status(repo, sha, state, options = {})
-        options = options.merge(:state => state)
+        options = options.merge(state: state)
         post "#{Repository.path repo}/statuses/#{sha}", options
       end
     end