octokit 4.22.0 → 9.2.0

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
@@ -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
 
@@ -28,7 +26,7 @@ module Octokit
       def repository(repo, options = {})
         get Repository.path(repo), options
       end
-      alias :repo :repository
+      alias repo repository
 
       # Edit a repository
       #
@@ -47,15 +45,12 @@ module Octokit
       # @return [Sawyer::Resource] Repository information
       def edit_repository(repo, options = {})
         repo = Repository.new(repo)
-        if options.include? :is_template
-          options = ensure_api_media_type(:template_repositories, options)
-        end
         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 +66,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,10 +154,7 @@ module Octokit
       def create_repository(name, options = {})
         opts = options.dup
         organization = opts.delete :organization
-        opts.merge! :name => name
-        if opts.include? :is_template
-          opts = ensure_api_media_type(:template_repositories, opts)
-        end
+        opts.merge! name: name
 
         if organization.nil?
           post 'user/repos', opts
@@ -170,8 +162,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 +175,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
       #
@@ -195,10 +187,9 @@ module Octokit
       # @param options [Array<Integer>] :team_ids ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
       # @return [Sawyer::Resource] Repository info for the transferred repository
       def transfer_repository(repo, new_owner, options = {})
-        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 +201,10 @@ 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 = ensure_api_media_type(:template_repositories, options)
+        options.merge! name: name
         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 +212,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 +221,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 +238,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 +248,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 +264,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 +285,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 +320,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 +345,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 +362,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 +374,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 +386,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 +406,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
       #
@@ -431,8 +421,7 @@ module Octokit
       # @example List topics for octokit/octokit.rb
       #   client.topics('octokit/octokit.rb')
       def topics(repo, options = {})
-        opts = ensure_api_media_type(:topics, options)
-        paginate "#{Repository.path repo}/topics", opts
+        paginate "#{Repository.path repo}/topics", options
       end
 
       # Replace all topics for a repository
@@ -448,8 +437,7 @@ module Octokit
       # @example Clear all topics for octokit/octokit.rb
       #   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", options.merge(names: names)
       end
 
       # List contributors to a repo
@@ -470,7 +458,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 +508,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.
       #
@@ -576,9 +564,9 @@ module Octokit
       # @example Get branch 'master` from octokit/octokit.rb
       #   Octokit.branch("octokit/octokit.rb", "master")
       def branch(repo, branch, options = {})
-        get "#{Repository.path repo}/branches/#{branch}", options
+        get "#{Repository.path repo}/branches/#{CGI.escape(branch)}", options
       end
-      alias :get_branch :branch
+      alias get_branch branch
 
       # Lock a single branch from a repository
       #
@@ -601,10 +589,9 @@ module Octokit
       # @example
       #   @client.protect_branch('octokit/octokit.rb', 'master', foo)
       def protect_branch(repo, branch, options = {})
-        opts = ensure_api_media_type(:branch_protection, options)
-        opts[:restrictions] ||= nil
-        opts[:required_status_checks] ||= nil
-        put "#{Repository.path repo}/branches/#{branch}/protection", opts
+        options[:restrictions] ||= nil
+        options[:required_status_checks] ||= nil
+        put "#{Repository.path repo}/branches/#{branch}/protection", options
       end
 
       # Get branch protection summary
@@ -617,12 +604,9 @@ module Octokit
       # @example
       #   @client.branch_protection('octokit/octokit.rb', 'master')
       def branch_protection(repo, branch, options = {})
-        opts = ensure_api_media_type(:branch_protection, options)
-        begin
-          get "#{Repository.path repo}/branches/#{branch}/protection", opts
-        rescue Octokit::BranchNotProtected
-          nil
-        end
+        get "#{Repository.path repo}/branches/#{branch}/protection", options
+      rescue Octokit::BranchNotProtected
+        nil
       end
 
       # Unlock a single branch from a repository
@@ -636,8 +620,7 @@ module Octokit
       # @example
       #   @client.unprotect_branch('octokit/octokit.rb', 'master')
       def unprotect_branch(repo, branch, options = {})
-        opts = ensure_api_media_type(:branch_protection, options)
-        boolean_from_response :delete, "#{Repository.path repo}/branches/#{branch}/protection", opts
+        boolean_from_response :delete, "#{Repository.path repo}/branches/#{branch}/protection", options
       end
 
       # Rename a single branch from a repository
@@ -653,7 +636,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 +657,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.
       #
@@ -763,8 +746,7 @@ module Octokit
       # @example
       #   @client.vulnerability_alerts_enabled?("octokit/octokit.rb")
       def vulnerability_alerts_enabled?(repo, options = {})
-        opts = ensure_api_media_type(:vulnerability_alerts, options)
-        boolean_from_response(:get, "#{Repository.path repo}/vulnerability-alerts", opts)
+        boolean_from_response(:get, "#{Repository.path repo}/vulnerability-alerts", options)
       end
 
       # Enable vulnerability alerts for a repository
@@ -777,8 +759,7 @@ module Octokit
       # @example Enable vulnerability alerts for a repository
       #   @client.enable_vulnerability_alerts("octokit/octokit.rb")
       def enable_vulnerability_alerts(repo, options = {})
-        opts = ensure_api_media_type(:vulnerability_alerts, options)
-        boolean_from_response(:put, "#{Repository.path repo}/vulnerability-alerts", opts)
+        boolean_from_response(:put, "#{Repository.path repo}/vulnerability-alerts", options)
       end
 
       # Disable vulnerability alerts for a repository
@@ -791,8 +772,50 @@ module Octokit
       # @example Disable vulnerability alerts for a repository
       #   @client.disable_vulnerability_alerts("octokit/octokit.rb")
       def disable_vulnerability_alerts(repo, options = {})
-        opts = ensure_api_media_type(:vulnerability_alerts, options)
-        boolean_from_response(:delete, "#{Repository.path repo}/vulnerability-alerts", opts)
+        boolean_from_response(:delete, "#{Repository.path repo}/vulnerability-alerts", options)
+      end
+
+      # Check to see if automated security fixes are enabled for a repository
+      #
+      # The authenticated user must have admin access to the repository.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Boolean] True if automated security fixes are enabled, false otherwise.
+      # @see https://docs.github.com/en/rest/reference/repos#check-if-automated-security-fixes-are-enabled-for-a-repository
+      #
+      # @example
+      #   @client.automated_security_fixes_enabled?("octokit/octokit.rb")
+      def automated_security_fixes_enabled?(repo, options = {})
+        response = get "#{Repository.path repo}/automated-security-fixes", options
+        return response[:enabled] if @last_response.status == 200
+
+        false
+      end
+
+      # Enable automated security fixes for a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      #
+      # @return [Boolean] True if vulnerability alerts enabled, false otherwise.
+      # @see https://docs.github.com/en/rest/reference/repos#automated-security-fixes
+      # @example Enable automated security fixes for a repository
+      #   @client.enable_automated_security_fixes("octokit/octokit.rb")
+      def enable_automated_security_fixes(repo, options = {})
+        boolean_from_response(:put, "#{Repository.path repo}/automated-security-fixes", options)
+      end
+
+      # Disable automated security fixes for a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      #
+      # @return [Boolean] True if vulnerability alerts disabled, false otherwise.
+      # @see https://docs.github.com/en/rest/reference/repos#automated-security-fixes
+      # @example Disable  automated security fixes for a repository
+      #   @client.disable_automated_security_fixes("octokit/octokit.rb")
+      def disable_automated_security_fixes(repo, options = {})
+        boolean_from_response(:delete, "#{Repository.path repo}/automated-security-fixes", options)
       end
     end
   end

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
@@ -151,7 +151,7 @@ module Octokit
       # @param number [Integer] Number ID of the pull request
       # @param reviewers [Hash] :reviewers [Array<String>] An array of user logins
       # @param options [Hash] :team_reviewers [Array<String>] An array of team slugs
-      # @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
+      # @see https://developer.github.com/v3/pulls/review_requests/#request-reviewers-for-a-pull-request
       #
       # @example
       #   @client.request_pull_request_review('octokit/octokit.rb', 2, reviewers: ['soudy'])
@@ -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
@@ -31,8 +31,7 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @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
@@ -45,8 +44,9 @@ module Octokit
       # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-issues-and-pull-requests
+      # @see https://docs.github.com/en/rest/search#limitations-on-query-length
       def search_issues(query, options = {})
-        search "search/issues", query, options
+        search 'search/issues', query, options
       end
 
       # Search repositories
@@ -60,9 +60,23 @@ 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
+
+      # 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
-      alias :search_repos :search_repositories
 
       # Search users
       #
@@ -75,13 +89,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,37 +1,47 @@
+# 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
-      STATUS_ROOT = 'https://status.github.com/api.json'
+      SUMMARY_ROOT    = 'https://www.githubstatus.com/api/v2/summary.json'
+      STATUS_ROOT     = 'https://www.githubstatus.com/api/v2/status.json'
+      COMPONENTS_ROOT = 'https://www.githubstatus.com/api/v2/components.json'
+
+      # Returns a summary with the current status and the last status messages.
+      #
+      # @return [<Sawyer::Resource>] GitHub status summary
+      # @see https://www.githubstatus.com/api#summory
+      def github_status_summary
+        get(SUMMARY_ROOT)
+      end
 
       # Returns the current system status
       #
       # @return [Sawyer::Resource] GitHub status
-      # @see https://status.github.com/api#api-current-status
+      # @see https://www.githubstatus.com/api#status
       def github_status
-        get(STATUS_ROOT).rels[:status].get.data
+        get(STATUS_ROOT)
       end
 
       # Returns the last human communication, status, and timestamp.
       #
       # @return [Sawyer::Resource] GitHub status last message
-      # @see https://status.github.com/api#api-last-message
+      # @see https://www.githubstatus.com/api/#components
       def github_status_last_message
-        get(STATUS_ROOT).rels[:last_message].get.data
+        get(COMPONENTS_ROOT).components.first
       end
 
       # Returns the most recent human communications with status and timestamp.
       #
       # @return [Array<Sawyer::Resource>] GitHub status messages
-      # @see https://status.github.com/api#api-recent-messages
+      # @see https://www.githubstatus.com/api#components
       def github_status_messages
-        get(STATUS_ROOT).rels[:messages].get.data
+        get(COMPONENTS_ROOT).components
       end
     end
   end