octokit 4.6.0 → 4.21.0

data/lib/octokit/error.rb

@@ -1,7 +1,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
     #
@@ -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
@@ -34,9 +34,16 @@ module Octokit
       end
     end
 
+     def build_error_context
+       if RATE_LIMITED_ERRORS.include?(self.class)
+         @context = Octokit::RateLimit.from_response(@response)
+       end
+     end
+
     def initialize(response=nil)
       @response = response
       super(build_error_message)
+      build_error_context
     end
 
     # Documentation URL returned by the API for some errors
@@ -63,6 +70,8 @@ module Octokit
         Octokit::TooManyRequests
       elsif body =~ /login attempts exceeded/i
         Octokit::TooManyLoginAttempts
+      elsif body =~ /returns blobs up to [0-9]+ MB/i
+        Octokit::TooLargeContent
       elsif body =~ /abuse/i
         Octokit::AbuseDetected
       elsif body =~ /repository access blocked/i
@@ -71,6 +80,12 @@ module Octokit
         Octokit::UnverifiedEmail
       elsif body =~ /account was suspended/i
         Octokit::AccountSuspended
+      elsif body =~ /billing issue/i
+        Octokit::BillingIssue
+      elsif body =~ /Resource protected by organization SAML enforcement/i
+        Octokit::SAMLProtected
+      elsif body =~ /suspended your access|This installation has been suspended/i
+        Octokit::InstallationSuspended
       else
         Octokit::Forbidden
       end
@@ -86,6 +101,18 @@ 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
+      elsif body =~ /Path diff too large/i
+        Octokit::PathDiffTooLarge
+      else
+        Octokit::UnprocessableEntity
+      end
+    end
+
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
@@ -103,6 +130,20 @@ module Octokit
       @response[:status]
     end
 
+    # Headers returned by the GitHub server.
+    #
+    # @return [Hash]
+    def response_headers
+      @response[:response_headers]
+    end
+
+    # Body returned by the GitHub server.
+    #
+    # @return [String]
+    def response_body
+      @response[:body]
+    end
+
     private
 
     def data
@@ -138,8 +179,12 @@ module Octokit
       return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
 
       summary = "\nError summary:\n"
-      summary << data[:errors].map do |hash|
-        hash.map { |k,v| "  #{k}: #{v}" }
+      summary << data[:errors].map do |error|
+        if error.is_a? Hash
+          error.map { |k,v| "  #{k}: #{v}" }
+        else
+          "  #{error}"
+        end
       end.join("\n")
 
       summary
@@ -213,6 +258,10 @@ module Octokit
   # and body matches 'login attempts exceeded'
   class TooManyLoginAttempts < Forbidden; end
 
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'returns blobs up to [0-9]+ MB'
+  class TooLargeContent < Forbidden; end
+
   # Raised when GitHub returns a 403 HTTP status code
   # and body matches 'abuse'
   class AbuseDetected < Forbidden; end
@@ -229,6 +278,18 @@ module Octokit
   # and body matches 'account was suspended'
   class AccountSuspended < Forbidden; end
 
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'billing issue'
+  class BillingIssue < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'Resource protected by organization SAML enforcement'
+  class SAMLProtected < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'suspended your access'
+  class InstallationSuspended < Forbidden; end
+
   # Raised when GitHub returns a 404 HTTP status code
   class NotFound < ClientError; end
 
@@ -251,6 +312,14 @@ 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 422 HTTP status code and body matches 'Path diff too large'.
+  # It could occur when attempting to post review comments on a "too large" file.
+  class PathDiffTooLarge < UnprocessableEntity; end
+
   # Raised when GitHub returns a 451 HTTP status code
   class UnavailableForLegalReasons < ClientError; end
 
@@ -279,4 +348,5 @@ module Octokit
   # Raised when a repository is created with an invalid format
   class InvalidRepository < ArgumentError; end
 
+  RATE_LIMITED_ERRORS = [Octokit::TooManyRequests, Octokit::AbuseDetected]
 end

data/lib/octokit/gist.rb

@@ -15,7 +15,7 @@ module Octokit
 
     def initialize(gist)
       case gist
-      when Fixnum, String
+      when Integer, String
         @id = gist.to_s
       end
     end

data/lib/octokit/middleware/follow_redirects.rb

@@ -11,7 +11,7 @@ module Octokit
   module Middleware
 
     # Public: Exception thrown when the maximum amount of requests is exceeded.
-    class RedirectLimitReached < Faraday::Error::ClientError
+    class RedirectLimitReached < Faraday::ClientError
       attr_reader :response
 
       def initialize(response)
@@ -49,7 +49,7 @@ module Octokit
       # Public: Initialize the middleware.
       #
       # options - An options Hash (default: {}):
-      #           :limit               - A Fixnum redirect limit (default: 3).
+      #           :limit               - A Integer redirect limit (default: 3).
       def initialize(app, options = {})
         super(app)
         @options = options

data/lib/octokit/preview.rb

@@ -4,16 +4,27 @@ module Octokit
   module Preview
 
     PREVIEW_TYPES = {
-      :branch_protection      => 'application/vnd.github.loki-preview+json'.freeze,
+      :applications_api       => 'application/vnd.github.doctor-strange-preview+json'.freeze,
+      :branch_protection      => 'application/vnd.github.luke-cage-preview+json'.freeze,
+      :commit_search          => 'application/vnd.github.cloak-preview+json'.freeze,
+      :commit_pulls           => 'application/vnd.github.groot-preview+json'.freeze,
+      :commit_branches        => 'application/vnd.github.groot-preview+json'.freeze,
       :migrations             => 'application/vnd.github.wyandotte-preview+json'.freeze,
       :licenses               => 'application/vnd.github.drax-preview+json'.freeze,
       :source_imports         => 'application/vnd.github.barred-rock-preview'.freeze,
       :reactions              => 'application/vnd.github.squirrel-girl-preview'.freeze,
-      :repository_invitations => 'application/vnd.github.swamp-thing-preview+json'.freeze,
+      :transfer_repository    => 'application/vnd.github.nightshade-preview+json'.freeze,
       :issue_timelines        => 'application/vnd.github.mockingbird-preview+json'.freeze,
+      :nested_teams           => 'application/vnd.github.hellcat-preview+json'.freeze,
       :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze,
       :projects               => 'application/vnd.github.inertia-preview+json'.freeze,
-      :traffic                => 'application/vnd.github.spiderman-preview'.freeze
+      :traffic                => 'application/vnd.github.spiderman-preview'.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,
+      :template_repositories  => 'application/vnd.github.baptiste-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/rate_limit.rb

@@ -3,13 +3,13 @@ module Octokit
   # Class for API Rate Limit info
   #
   # @!attribute [w] limit
-  #   @return [Fixnum] Max tries per rate limit period
+  #   @return [Integer] Max tries per rate limit period
   # @!attribute [w] remaining
-  #   @return [Fixnum] Remaining tries per rate limit period
+  #   @return [Integer] Remaining tries per rate limit period
   # @!attribute [w] resets_at
   #   @return [Time] Indicates when rate limit resets
   # @!attribute [w] resets_in
-  #   @return [Fixnum] Number of seconds when rate limit resets
+  #   @return [Integer] Number of seconds when rate limit resets
   #
   # @see https://developer.github.com/v3/#rate-limiting
   class RateLimit < Struct.new(:limit, :remaining, :resets_at, :resets_in)
@@ -20,7 +20,7 @@ module Octokit
     # @return [RateLimit]
     def self.from_response(response)
       info = new
-      if response && !response.headers.nil?
+      if response && 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

@@ -28,13 +28,13 @@ module Octokit
         @owner = repo.owner
         @name = repo.name
       when Hash
-        @name = repo[:repo] ||= repo[:name]
-        @owner = repo[:owner] ||= repo[:user] ||= repo[:username]
+        @name = repo[:repo] || repo[:name]
+        @owner = repo[:owner] || repo[:user] || repo[:username]
       else
-        raise_invalid_repository!
+        raise_invalid_repository!(repo)
       end
       if @owner && @name
-        validate_owner_and_name!
+        validate_owner_and_name!(repo)
       end
     end
 
@@ -80,14 +80,16 @@ module Octokit
 
     private
 
-      def validate_owner_and_name!
+      def validate_owner_and_name!(repo)
         if @owner.include?('/') || @name.include?('/') || !url.match(URI::ABS_URI)
-          raise_invalid_repository!
+          raise_invalid_repository!(repo)
         end
       end
 
-      def raise_invalid_repository!
-        raise Octokit::InvalidRepository, "Invalid Repository. Use user/repo format."
+      def raise_invalid_repository!(repo)
+        msg = "#{repo.inspect} is invalid as a repository identifier. " +
+              "Use the user/repo (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys."
+        raise Octokit::InvalidRepository, msg
       end
   end
 end

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 = 6
+  MINOR = 21
 
   # Current patch level.
   # @return [Integer]

data/octokit.gemspec

@@ -4,8 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'octokit/version'
 
 Gem::Specification.new do |spec|
-  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'bundler', '>= 1', '< 3'
   spec.add_dependency 'sawyer', '>= 0.5.3', '~> 0.8.0'
+  spec.add_dependency 'faraday', '>= 0.9'
   spec.authors = ["Wynn Netherland", "Erik Michaels-Ober", "Clint Shryock"]
   spec.description = %q{Simple wrapper for the GitHub API}
   spec.email = ['wynn.netherland@gmail.com', 'sferik@gmail.com', 'clint@ctshryock.com']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.21.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,22 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com
@@ -60,13 +80,22 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- lib/ext/sawyer/relation.rb
 - lib/octokit.rb
 - lib/octokit/arguments.rb
 - lib/octokit/authentication.rb
 - lib/octokit/client.rb
+- lib/octokit/client/actions_secrets.rb
+- lib/octokit/client/actions_workflow_runs.rb
+- lib/octokit/client/actions_workflows.rb
+- lib/octokit/client/apps.rb
 - lib/octokit/client/authorizations.rb
+- lib/octokit/client/checks.rb
+- lib/octokit/client/commit_branches.rb
 - lib/octokit/client/commit_comments.rb
+- lib/octokit/client/commit_pulls.rb
 - lib/octokit/client/commits.rb
+- lib/octokit/client/community_profile.rb
 - lib/octokit/client/contents.rb
 - lib/octokit/client/deployments.rb
 - lib/octokit/client/downloads.rb
@@ -81,9 +110,11 @@ files:
 - lib/octokit/client/legacy_search.rb
 - lib/octokit/client/licenses.rb
 - lib/octokit/client/markdown.rb
+- lib/octokit/client/marketplace.rb
 - lib/octokit/client/meta.rb
 - lib/octokit/client/milestones.rb
 - lib/octokit/client/notifications.rb
+- lib/octokit/client/oauth_applications.rb
 - lib/octokit/client/objects.rb
 - lib/octokit/client/organizations.rb
 - lib/octokit/client/pages.rb
@@ -96,6 +127,7 @@ files:
 - lib/octokit/client/releases.rb
 - lib/octokit/client/repositories.rb
 - lib/octokit/client/repository_invitations.rb
+- lib/octokit/client/reviews.rb
 - lib/octokit/client/say.rb
 - lib/octokit/client/search.rb
 - lib/octokit/client/service_status.rb
@@ -148,10 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API
 test_files: []
-has_rdoc: