octokit 4.19.0 → 4.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9801b25dfdd07e517b87bdc1404ffa64fd12496b66af8bb8bc4af57f6f33483f
-  data.tar.gz: b082dcc32f514846b53da5aaafe7666020c9de8d590dafb6e93743767a70573b
+  metadata.gz: 66d0ffe1bcb61d7c4661b0eed991cf4d8bc84c8d0460fe508f064bfc42e08bdf
+  data.tar.gz: fd2d7fb934734c88577d07c719ebdba6b8585738fb8e329a05b35e010b6b6b51
 SHA512:
-  metadata.gz: 16595560313f6346448710adf2a0d641fe62521089ff017aff1c2f1dc6dd1d5dc06d8397e552a098cf1a6ada91edfa111863d9c4491df86d3d38d3143531a7b5
-  data.tar.gz: 7dc816349c9050b31e0c0d09a7e1e25b6d455d59f6ae817db2f46b16900104bcdff15d3f280352e7bcb0ca195060824094ebe09ea022c3e46b52c8f559c0cc5b
+  metadata.gz: 795b13dc5aa33251042cb0a216e547c9f39fc063ee7ae0f0c009a50838459cb9da52bdd3dcb3883207173bd1fb19c922d86fd74380c8aa02cf51807f8c3420b0
+  data.tar.gz: ebe0c7d8d8290aa2a3ad6b55b27d7bd23eff2c0b4f479654aeac2eb5b760cd00174fea8ffcc3ebb5a7bfb4375690fb9096aa74c282780b260a480e23d1a06752

data/README.md

@@ -41,7 +41,7 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
     1. [Debugging](#debugging)
     2. [Caching](#caching)
 14. [Hacking on Octokit.rb](#hacking-on-octokitrb)
-    1. [Code of Conduction](#code_of_conduct)
+    1. [Code of Conduct](#code-of-conduct)
     2. [Running and writing new tests](#running-and-writing-new-tests)
 15. [Supported Ruby Versions](#supported-ruby-versions)
 16. [Versioning](#versioning)

data/lib/octokit/client/apps.rb

@@ -12,8 +12,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] App information
       def app(options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "app", opts
+        get "app", options
       end
 
       # Find all installations that belong to an App
@@ -24,8 +23,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] the total_count and an array of installations
       def find_app_installations(options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate "app/installations", opts
+        paginate "app/installations", options
       end
       alias find_installations find_app_installations
 
@@ -47,8 +45,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] the total_count and an array of installations
       def find_user_installations(options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate("user/installations", opts) do |data, last_response|
+        paginate("user/installations", options) do |data, last_response|
           data.installations.concat last_response.data.installations
         end
       end
@@ -61,8 +58,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] Installation information
       def installation(id, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "app/installations/#{id}", opts
+        get "app/installations/#{id}", options
       end
 
       # Create a new installation token
@@ -74,8 +70,7 @@ module Octokit
       #
       # @return [<Sawyer::Resource>] An installation token
       def create_app_installation_access_token(installation, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        post "app/installations/#{installation}/access_tokens", opts
+        post "app/installations/#{installation}/access_tokens", options
       end
       alias create_installation_access_token create_app_installation_access_token
 
@@ -98,8 +93,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] Installation information
       def find_organization_installation(organization, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "#{Organization.path(organization)}/installation", opts
+        get "#{Organization.path(organization)}/installation", options
       end
 
       # Enables an app to find the repository's installation information.
@@ -111,8 +105,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] Installation information
       def find_repository_installation(repo, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "#{Repository.path(repo)}/installation", opts
+        get "#{Repository.path(repo)}/installation", options
       end
 
       # Enables an app to find the user's installation information.
@@ -124,8 +117,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] Installation information
       def find_user_installation(user, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        get "#{User.path(user)}/installation", opts
+        get "#{User.path(user)}/installation", options
       end
 
       # List repositories that are accessible to the authenticated installation
@@ -136,8 +128,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] the total_count and an array of repositories
       def list_app_installation_repositories(options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate("installation/repositories", opts) do |data, last_response|
+        paginate("installation/repositories", options) do |data, last_response|
           data.repositories.concat last_response.data.repositories
         end
       end
@@ -163,8 +154,7 @@ module Octokit
       #
       # @return [Boolean] Success
       def add_repository_to_app_installation(installation, repo, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        boolean_from_response :put, "user/installations/#{installation}/repositories/#{repo}", opts
+        boolean_from_response :put, "user/installations/#{installation}/repositories/#{repo}", options
       end
       alias add_repo_to_installation add_repository_to_app_installation
 
@@ -188,8 +178,7 @@ module Octokit
       #
       # @return [Boolean] Success
       def remove_repository_from_app_installation(installation, repo, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        boolean_from_response :delete, "user/installations/#{installation}/repositories/#{repo}", opts
+        boolean_from_response :delete, "user/installations/#{installation}/repositories/#{repo}", options
       end
       alias remove_repo_from_installation remove_repository_from_app_installation
 
@@ -212,8 +201,7 @@ module Octokit
       #
       # @return [Sawyer::Resource] the total_count and an array of repositories
       def find_installation_repositories_for_user(installation, options = {})
-        opts = ensure_api_media_type(:integrations, options)
-        paginate("user/installations/#{installation}/repositories", opts) do |data, last_response|
+        paginate("user/installations/#{installation}/repositories", options) do |data, last_response|
           data.repositories.concat last_response.data.repositories
         end
       end

data/lib/octokit/client/contents.rb

@@ -16,6 +16,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/contents/#get-the-readme
       # @example Get the readme file for a repo
       #   Octokit.readme("octokit/octokit.rb")
+      # @example Get the readme file for a particular branch of the repo
+      #   Octokit.readme("octokit/octokit.rb", :query => {:ref => 'some-other-branch'})
       def readme(repo, options={})
         get "#{Repository.path repo}/readme", options
       end
@@ -29,6 +31,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/contents/#get-contents
       # @example List the contents of lib/octokit.rb
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
+      # @example Lists the contents of lib /octokit.rb on a particular branch
+      #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb', :query => {:ref => 'some-other-branch'})
       def contents(repo, options={})
         options = options.dup
         repo_path = options.delete :path

data/lib/octokit/client/deployments.rb

@@ -43,6 +43,16 @@ module Octokit
         post("#{Repository.path repo}/deployments", options)
       end
 
+      # Delete a Deployment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param deployment_id [Integer, String, Repository, Hash] A GitHub repository
+      # @return [No Content]
+      # @see https://developer.github.com/v3/repos/deployments/#delete-a-deployment
+      def delete_deployment(repo, deployment_id, options = {})
+        delete("#{Repository.path repo}/deployments/#{deployment_id}", options)
+      end
+
       # List all statuses for a Deployment
       #
       # @param deployment_url [String] A URL for a deployment resource

data/lib/octokit/client/organizations.rb

@@ -236,7 +236,7 @@ module Octokit
       # @example
       #   @client.outside_collaborators('github')
       def outside_collaborators(org, options={})
-        get "#{Organization.path org}/outside_collaborators", options
+        paginate "#{Organization.path org}/outside_collaborators", options
       end
 
       # Remove outside collaborator from an organization

data/lib/octokit/client/repositories.rb

@@ -733,6 +733,49 @@ module Octokit
       def dispatch_event(repo, event_type, options = {})
         boolean_from_response :post, "#{Repository.path repo}/dispatches", options.merge({ event_type: event_type })
       end
+
+      # Check to see if vulnerability alerts 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 vulnerability alerts are enabled, false otherwise.
+      # @see https://docs.github.com/en/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
+      #
+      # @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)
+      end
+
+      # Enable vulnerability alerts 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#enable-vulnerability-alerts
+      # @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)
+      end
+
+      # Disable vulnerability alerts 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#disable-vulnerability-alerts
+      # @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)
+      end
     end
   end
 end

data/lib/octokit/error.rb

@@ -21,7 +21,7 @@ module Octokit
                   when 406      then Octokit::NotAcceptable
                   when 409      then Octokit::Conflict
                   when 415      then Octokit::UnsupportedMediaType
-                  when 422      then Octokit::UnprocessableEntity
+                  when 422      then error_for_422(body)
                   when 451      then Octokit::UnavailableForLegalReasons
                   when 400..499 then Octokit::ClientError
                   when 500      then Octokit::InternalServerError
@@ -84,7 +84,7 @@ module Octokit
         Octokit::BillingIssue
       elsif body =~ /Resource protected by organization SAML enforcement/i
         Octokit::SAMLProtected
-      elsif body =~ /suspended your access/i
+      elsif body =~ /suspended your access|This installation has been suspended/i
         Octokit::InstallationSuspended
       else
         Octokit::Forbidden
@@ -101,6 +101,16 @@ module Octokit
       end
     end
 
+    # Return most appropriate error for 422 HTTP status code
+    # @private
+    def self.error_for_422(body)
+      if body =~ /PullRequestReviewComment/i && body =~ /(commit_id|end_commit_oid) is not part of the pull request/i
+        Octokit::CommitIsNotPartOfPullRequest
+      else
+        Octokit::UnprocessableEntity
+      end
+    end
+
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
@@ -300,6 +310,10 @@ module Octokit
   # Raised when GitHub returns a 422 HTTP status code
   class UnprocessableEntity < ClientError; end
 
+  # Raised when GitHub returns a 422 HTTP status code
+  # and body matches 'PullRequestReviewComment' and 'commit_id (or end_commit_oid) is not part of the pull request'
+  class CommitIsNotPartOfPullRequest < UnprocessableEntity; end
+
   # Raised when GitHub returns a 451 HTTP status code
   class UnavailableForLegalReasons < ClientError; end
 

data/lib/octokit/preview.rb

@@ -20,7 +20,6 @@ module Octokit
       :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze,
       :projects               => 'application/vnd.github.inertia-preview+json'.freeze,
       :traffic                => 'application/vnd.github.spiderman-preview'.freeze,
-      :integrations           => 'application/vnd.github.machine-man-preview+json'.freeze,
       :topics                 => 'application/vnd.github.mercy-preview+json'.freeze,
       :community_profile      => 'application/vnd.github.black-panther-preview+json'.freeze,
       :strict_validation      => 'application/vnd.github.speedy-preview+json'.freeze,
@@ -28,6 +27,7 @@ module Octokit
       :template_repositories  => 'application/vnd.github.baptiste-preview+json'.freeze,
       :uninstall_github_app   => 'application/vnd.github.gambit-preview+json'.freeze,
       :project_card_events    => 'application/vnd.github.starfox-preview+json'.freeze,
+      :vulnerability_alerts   => 'application/vnd.github.dorian-preview+json'.freeze,
     }
 
     def ensure_api_media_type(type, options)

data/lib/octokit/response/feed_parser.rb

@@ -7,8 +7,6 @@ module Octokit
     # Parses RSS and Atom feed responses.
     class FeedParser < Faraday::Response::Middleware
 
-      private
-
       def on_complete(env)
         if env[:response_headers]["content-type"] =~ /(\batom|\brss)/
           require 'rss'

data/lib/octokit/response/raise_error.rb

@@ -9,8 +9,6 @@ module Octokit
     # HTTP status codes returned by the API
     class RaiseError < Faraday::Response::Middleware
 
-      private
-
       def on_complete(response)
         if error = Octokit::Error.from_response(response)
           raise error

data/lib/octokit/version.rb

@@ -5,7 +5,7 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 19
+  MINOR = 20
 
   # Current patch level.
   # @return [Integer]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.19.0
+  version: 4.20.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler