octokit 4.14.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da3e4a3c93344024b60cb7d3c5e13bc90742576c6e43dc3e438f3e16819cdc9f
-  data.tar.gz: 9a47ad957027e32a4f74ca93250476ae46627d961b6bd349cf62a632da04477f
+  metadata.gz: acde45338bbfff0aac4a04d4e9867b5345f1b1123e58fdc80d0c69d01a1f0877
+  data.tar.gz: 65324c811d6edbfb510ef41a2ffbe54cc3197d64cfc018e1997858e8d59a5e20
 SHA512:
-  metadata.gz: 22921fbc5478cbdcbe17f033b7a63666dc69ff63b1b2fda1f47f37eb2967cd055539c1935a5a767d46e24ed427c2d64457c6057141f77caa3bfdf2ebcd6bd179
-  data.tar.gz: 1bc0add3fdff8b42dc752c3886f95ba51e8ffd234ff3f0091b7dc7a22dbfd8286b0df2d043646a859cdc0bb2837663b6259339c82a0602296dc9cb305b68ab4a
+  metadata.gz: dc30ba3288f921516c9aa78f27389c91840522aedb97e3a0c1fb21d672b69586d7096b12affc25a7cd859906da8fe6376a9b5244ca667a5977aad400ec65eff0
+  data.tar.gz: cdd80e10b58cfa64d2ed18d0376c762ce478b6efddb41e1581f529c3c1d265a0fb67c337398a7e9beee307045b6468732d7d11db2b5b54797734dac917e6029b

data/CONTRIBUTING.md

@@ -1,21 +1,24 @@
 ## Submitting a Pull Request
 
-0. Check out Hacking on Octokit in the README guide for
+0. Read our [Code of Conduct](CODE_OF_CONDUCT.md).
+1. Check out Hacking on Octokit in the README guide for
    bootstrapping the project for local development.
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add specs for your unimplemented feature or bug fix.
-4. Run `script/test`. If your specs pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `script/test`. If your specs fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
+2. [Fork the repository.][fork]
+3. [Create a topic branch.][branch]
+4. Add specs for your unimplemented feature or bug fix.
+5. Run `script/test`. If your specs pass, return to step 3.
+6. Implement your feature or bug fix.
+7. Run `script/test`. If your specs fail, return to step 5.
+8. Run `open coverage/index.html`. If your changes are not completely covered
    by your tests, return to step 4.
-8. Add documentation for your feature or bug fix.
-9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
+9. Add documentation for your feature or bug fix.
+10. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
    back to step 8.
-10. Add, commit, and push your changes. For documentation-only fixes, please
+11. Add, commit, and push your changes. For documentation-only fixes, please
     add "[ci skip]" to your commit message to avoid needless CI builds.
-11. [Submit a pull request.][pr]
+12. [Submit a pull request.][pr]
+
+Please abide by
 
 [fork]: https://help.github.com/articles/fork-a-repo
 [branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/

data/README.md

@@ -41,7 +41,8 @@ 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. [Running and writing new tests](#running-and-writing-new-tests)
+    1. [Code of Conduction](#code_of_conduct)
+    2. [Running and writing new tests](#running-and-writing-new-tests)
 15. [Supported Ruby Versions](#supported-ruby-versions)
 16. [Versioning](#versioning)
 17. [Making Repeating Requests](#making-repeating-requests)
@@ -63,7 +64,7 @@ client.readme 'al3x/sovereign', :accept => 'application/vnd.github.html'
 ```
 
 [wrappers]: http://wynnnetherland.com/journal/what-makes-a-good-api-wrapper
-[github-api]: http://developer.github.com
+[github-api]: https://developer.github.com/v3/
 
 ## Quick start
 
@@ -289,7 +290,7 @@ link relations](#hypermedia-agent).
 
 ```ruby
 issues = client.issues 'rails/rails'
-issues.concat client.last_response.rels[:next].get.data
+issues.concat client.get(client.last_response.rels[:next].href)
 ```
 
 ### Auto pagination
@@ -653,6 +654,12 @@ to run a Ruby console to poke on Octokit, you can crank one up with:
 Using the scripts in `./scripts` instead of `bundle exec rspec`, `bundle
 console`, etc.  ensures your dependencies are up-to-date.
 
+### Code of Conduct
+
+We want both the Octokit.rb and larger Octokit communities to be an open
+and welcoming environments. Please read and follow both in spirit and
+letter [Code of Conduct](CODE_OF_CONDUCT.md).
+
 ### Running and writing new tests
 
 Octokit uses [VCR][] for recording and playing back API fixtures during test
@@ -752,7 +759,7 @@ The changes made between versions can be seen on the [project releases page][rel
 [releases]: https://github.com/octokit/octokit.rb/releases
 
 ## Making Repeating Requests
-In most cases it would be best to use a [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests. 
+In most cases it would be best to use a [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests.
 
 ```ruby
 Octopoller.poll(timeout: 15.seconds) do

data/lib/octokit/client.rb

@@ -15,6 +15,7 @@ require 'octokit/client/authorizations'
 require 'octokit/client/checks'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
+require 'octokit/client/commit_pulls'
 require 'octokit/client/community_profile'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
@@ -73,6 +74,7 @@ module Octokit
     include Octokit::Client::Checks
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
+    include Octokit::Client::CommitPulls
     include Octokit::Client::CommunityProfile
     include Octokit::Client::Contents
     include Octokit::Client::Deployments

data/lib/octokit/client/apps.rb

@@ -204,6 +204,19 @@ module Octokit
           data.repositories.concat last_response.data.repositories
         end
       end
+
+      # Delete an installation and uninstall a GitHub App
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#delete-an-installation
+      #
+      # @return [Boolean] Success
+      def delete_installation(installation, options = {})
+        opts = ensure_api_media_type(:uninstall_github_app, options)
+        boolean_from_response :delete, "app/installations/#{installation}", opts
+      end
     end
   end
 end

data/lib/octokit/client/commit_pulls.rb

@@ -0,0 +1,20 @@
+module Octokit
+  class Client
+
+    # Methods for the Commit Pulls API
+    #
+    # @see https://developer.github.com/v3/repos/comments/
+    module CommitPulls
+
+      # List pulls for a single commit
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit whose pulls will be fetched
+      # @return [Array]  List of commit pulls
+      # @see https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit
+      def commit_pulls(repo, sha, options = {})
+        paginate "#{Repository.path repo}/commits/#{sha}/pulls", options
+      end
+    end
+  end
+end

data/lib/octokit/client/issues.rb

@@ -81,6 +81,7 @@ module Octokit
       # @param body [String] An optional concise description
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
+      # @option options [Array<String>] :assignees User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Sawyer::Resource] Your newly created issue
@@ -120,6 +121,7 @@ module Octokit
       # @param number [Integer] Number ID of the issue
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
+      # @option options [Array<String>] :assignees User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
       # @return [Sawyer::Resource] The updated Issue
@@ -136,6 +138,7 @@ module Octokit
       # @param number [Integer] Number ID of the issue
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
+      # @option options [Array<String>] :assignees User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
       # @return [Sawyer::Resource] The updated Issue
@@ -179,6 +182,7 @@ module Octokit
       #   @param body [String] Updated body of the issue
       #   @param options [Hash] A customizable set of options.
       #   @option options [String] :assignee User login.
+      #   @option options [Array<String>] :assignees User login.
       #   @option options [Integer] :milestone Milestone number.
       #   @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
@@ -190,6 +194,7 @@ module Octokit
       #   @option options [String] :title Updated title for the issue
       #   @option options [String] :body Updated body of the issue
       #   @option options [String] :assignee User login.
+      #   @option options [Array<String>] :assignees User login.
       #   @option options [Integer] :milestone Milestone number.
       # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
       #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
@@ -332,7 +337,7 @@ module Octokit
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param number [Integer] Issue number
-      # @param assignees [Array] Assignees to be added
+      # @param assignees [Array<String>] Assignees to be added
       # @return [Sawyer::Resource] Issue
       # @see https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue
       # @example Add assignees "pengwynn" and "joeyw" to Issue #23 on octokit/octokit.rb
@@ -345,7 +350,7 @@ module Octokit
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param number [Integer] Issue number
-      # @param assignees [Array] Assignees to be removed
+      # @param assignees [Array<String>] Assignees to be removed
       # @param options [Hash] Header params for request
       # @return [Sawyer::Resource] Issue
       # @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue

data/lib/octokit/client/organizations.rb

@@ -324,6 +324,20 @@ module Octokit
         get "teams/#{team_id}", options
       end
 
+      # Get team by name and org
+      #
+      # Requires authenticated organization member.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param team_slug [String] Team slug.
+      # @return [Sawyer::Resource] Hash representing team.
+      # @see https://developer.github.com/v3/teams/#get-team-by-name
+      # @example
+      #   @client.team("github", "justice-league")
+      def team_by_name(org, team_slug, options = {})
+        get "#{Organization.path(org)}/teams/#{team_slug}", options
+      end
+
       # List child teams
       #
       # Requires authenticated organization member.

data/lib/octokit/client/pull_requests.rb

@@ -11,7 +11,7 @@ module Octokit
       # @overload pull_requests(repo, options)
       #   @param repo [Integer, String, Hash, Repository] A GitHub repository
       #   @param options [Hash] Method options
-      #   @option options [String] :state `open` or `closed`.
+      #   @option options [String] :state `open` or `closed` or `all`.
       # @return [Array<Sawyer::Resource>] Array of pulls
       # @see https://developer.github.com/v3/pulls/#list-pull-requests
       # @example

data/lib/octokit/client/refs.rb

@@ -83,7 +83,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] The list of references updated
       # @see https://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
-      #   Octokit.update_ref("octocat/Hello-World","sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      #   Octokit.update_branch("octocat/Hello-World","sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
       def update_branch(repo, branch, sha, force = true, options = {})
         update_ref repo, "heads/#{branch}", sha, force, options
       end

data/lib/octokit/client/repositories.rb

@@ -41,11 +41,15 @@ module Octokit
       # @option options [String] :private `true` makes the repository private, and `false` makes it public.
       # @option options [String] :has_issues `true` enables issues for this repo, `false` disables issues.
       # @option options [String] :has_wiki `true` enables wiki for this repo, `false` disables wiki.
+      # @option options [Boolean] :is_template `true` makes the repository a template, `false` makes it not a template.
       # @option options [String] :has_downloads `true` enables downloads for this repo, `false` disables downloads.
       # @option options [String] :default_branch Update the default branch for this repository.
       # @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
@@ -144,6 +148,7 @@ module Octokit
       # @option options [String] :private `true` makes the repository private, and `false` makes it public.
       # @option options [String] :has_issues `true` enables issues for this repo, `false` disables issues.
       # @option options [String] :has_wiki `true` enables wiki for this repo, `false` disables wiki.
+      # @option options [Boolean] :is_template `true` makes this repo available as a template repository, `false` to prevent it.
       # @option options [String] :has_downloads `true` enables downloads for this repo, `false` disables downloads.
       # @option options [String] :organization Short name for the org under which to create the repo.
       # @option options [Integer] :team_id The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.
@@ -155,6 +160,9 @@ module Octokit
         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
 
         if organization.nil?
           post 'user/repos', opts
@@ -192,6 +200,22 @@ module Octokit
       end
       alias :transfer_repo :transfer_repository
 
+      # Create a repository for a user or organization generated from a template repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub template repository
+      # @param name [String] Name of the new repo
+      # @option options [String] :owner Organization or user who the new repository will belong to.
+      # @option options [String] :description Description of the repo
+      # @option options [String] :private `true` makes the repository private, and `false` makes it public.
+      # @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)
+        post "#{Repository.path repo}/generate", options
+      end
+      alias :create_repo_from_template :create_repository_from_template
+
       # Hide a public repository
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

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/error.rb

@@ -63,6 +63,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 +73,10 @@ 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
       else
         Octokit::Forbidden
       end
@@ -231,6 +237,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 +257,14 @@ 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 404 HTTP status code
   class NotFound < ClientError; 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,9 +4,10 @@ module Octokit
   module Preview
 
     PREVIEW_TYPES = {
-      :branch_protection      => 'application/vnd.github.loki-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,
       :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,
@@ -21,6 +22,9 @@ 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,
     }
 
     def ensure_api_media_type(type, options)

data/lib/octokit/version.rb

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

data/octokit.gemspec

@@ -6,6 +6,7 @@ require 'octokit/version'
 Gem::Specification.new do |spec|
   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.14.0
+  version: 4.15.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,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
@@ -75,6 +89,7 @@ files:
 - lib/octokit/client/authorizations.rb
 - lib/octokit/client/checks.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
@@ -160,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API