octokit 4.13.0 → 4.19.0

data/lib/octokit/client/repository_invitations.rb

@@ -13,7 +13,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param user [String] User GitHub username to add
       # @return [Sawyer::Resource] The repository invitation
-      # @see https://developer.github.com/v3/repos/invitations/#invite-a-user-to-a-repository
+      # @see https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator
       def invite_user_to_repository(repo, user, options = {})
         put "#{Repository.path repo}/collaborators/#{user}", options
       end

data/lib/octokit/client/reviews.rb

@@ -204,6 +204,24 @@ module Octokit
         options = options.merge(reviewers)
         delete "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
       end
+
+      # Update a review request comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number ID of the pull request
+      # @param review [Integer] The id of the review
+      # @param body [String] body text of the pull request review.
+      # @param options [Hash] Method options
+      # @see https://developer.github.com/v3/pulls/reviews/#update-a-pull-request-review
+      #
+      # @example
+      #   @client.update_pull_request_review('octokit/octokit.rb', 825, 6505518, 'This is close to perfect! Please address the suggested inline change. And add more about this.')
+      #
+      # @return [Sawyer::Resource] Hash representing the review comment
+      def update_pull_request_review(repo, number, review, body, options = {})
+        options[:body] = body
+        put "#{Repository.path repo}/pulls/#{number}/reviews/#{review}", options
+      end
     end
   end
 end

data/lib/octokit/client/search.rb

@@ -44,7 +44,7 @@ module Octokit
       # @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-issues
+      # @see https://developer.github.com/v3/search/#search-issues-and-pull-requests
       def search_issues(query, options = {})
         search "search/issues", query, options
       end

data/lib/octokit/client/users.rb

@@ -340,6 +340,92 @@ module Octokit
       end
       alias :watched :subscriptions
 
+      # Initiates the generation of a migration archive.
+      #
+      # Requires authenticated user.
+      #
+      # @param repositories [Array<String>] :repositories Repositories for the organization.
+      # @option options [Boolean, optional] :lock_repositories Indicates whether repositories should be locked during migration
+      # @option options [Boolean, optional] :exclude_attachments Exclude attachments fro the migration data
+      # @return [Sawyer::Resource] Hash representing the new migration.
+      # @example
+      #   @client.start_migration(['octocat/hello-world'])
+      # @see https://docs.github.com/en/rest/reference/migrations#start-a-user-migration
+      def start_user_migration(repositories, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        options[:repositories] = repositories
+        post "user/migrations", options
+      end
+
+      # Lists the most recent migrations.
+      #
+      # Requires authenticated user.
+      #
+      # @return [Array<Sawyer::Resource>] Array of migration resources.
+      # @see https://docs.github.com/en/rest/reference/migrations#list-user-migrations
+      def user_migrations(options = {})
+        options = ensure_api_media_type(:migrations, options)
+        paginate "user/migrations", options
+      end
+
+      # Fetches the status of a migration.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#get-a-user-migration-status
+      def user_migration_status(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        get "user/migrations/#{id}", options
+      end
+
+      # Fetches the URL to a migration archive.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#download-a-user-migration-archive
+      def user_migration_archive_url(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        url = "user/migrations/#{id}/archive"
+
+        response = client_without_redirects(options).get(url)
+        response.headers['location']
+      end
+
+      # Deletes a previous migration archive.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#delete-a-user-migration-archive
+      def delete_user_migration_archive(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        delete "user/migrations/#{id}/archive", options
+      end
+
+      # List repositories for a user migration.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @see https://docs.github.com/en/rest/reference/migrations#list-repositories-for-a-user-migration
+      def user_migration_repositories(id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        get "user/migrations/#{id}/repositories", options
+      end
+
+      # Unlock a user repository which has been locked by a migration.
+      #
+      # Requires authenticated user.
+      #
+      # @param id [Integer] ID number of the migration.
+      # @param repo [String] Name of the repository.
+      # @see https://docs.github.com/en/rest/reference/migrations#unlock-a-user-repository
+      def unlock_user_repository(id, repo, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        delete "user/migrations/#{id}/repos/#{repo}/lock", options
+      end
     end
 
     private

data/lib/octokit/connection.rb

@@ -113,7 +113,7 @@ module Octokit
         elsif bearer_authenticated?
           http.authorization 'Bearer', @bearer_token
         elsif application_authenticated?
-          http.params = http.params.merge application_authentication
+          http.basic_auth(@client_id, @client_secret)
         end
       end
     end
@@ -155,6 +155,9 @@ module Octokit
 
       @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
       response.data
+    rescue Octokit::Error => error
+      @last_response = nil
+      raise error
     end
 
     # Executes the request, checking if it was successful
@@ -162,7 +165,7 @@ module Octokit
     # @return [Boolean] True on success, false otherwise
     def boolean_from_response(method, path, options = {})
       request(method, path, options)
-      @last_response.status == 204
+      [201, 202, 204].include? @last_response.status
     rescue Octokit::NotFound
       false
     end
@@ -175,7 +178,15 @@ module Octokit
       conn_opts = @connection_options
       conn_opts[:builder] = @middleware if @middleware
       conn_opts[:proxy] = @proxy if @proxy
-      conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      if conn_opts[:ssl].nil?
+        conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      else
+        verify = @connection_options[:ssl][:verify]
+        conn_opts[:ssl] = {
+          :verify => verify,
+          :verify_mode => verify == false ? 0 : @ssl_verify_mode
+        }
+      end
       opts[:faraday] = Faraday.new(conn_opts)
 
       opts

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
     #
@@ -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/i
+        Octokit::InstallationSuspended
       else
         Octokit::Forbidden
       end
@@ -231,6 +246,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
@@ -247,6 +266,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
 
@@ -297,4 +328,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/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)

data/lib/octokit/preview.rb

@@ -4,8 +4,12 @@ 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,
+      :checks                 => 'application/vnd.github.antiope-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,
@@ -20,6 +24,10 @@ module Octokit
       :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,
+      :drafts                 => 'application/vnd.github.shadow-cat-preview'.freeze,
+      :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,
     }
 
     def ensure_api_media_type(type, options)

data/lib/octokit/rate_limit.rb

@@ -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

@@ -88,7 +88,7 @@ module Octokit
 
       def raise_invalid_repository!(repo)
         msg = "#{repo.inspect} is invalid as a repository identifier. " +
-              "Use the repo/user (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys."
+              "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

data/lib/octokit/version.rb

@@ -5,7 +5,7 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 13
+  MINOR = 19
 
   # 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.13.0
+  version: 4.19.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,22 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2020-10-20 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
@@ -65,9 +85,15 @@ files:
 - 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
@@ -88,6 +114,7 @@ files:
 - 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
@@ -153,8 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API