octokit 4.9.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b938b8240c566e33d75ff8a0d65c797f652e0ec
-  data.tar.gz: 9b9dc7920741ba14a93c6dd9be7cf26b750453bf
+  metadata.gz: a460f667b29d977f38ccdc7c2c57d2460c599c70
+  data.tar.gz: edcff602f1d864efef9472b3245cc6f8f87fc09d
 SHA512:
-  metadata.gz: 0b72eef6e4954f798f45dfb49f990805b06411ac8f9cff2affe66738d6803f98d2e666d18248bb5742bbf1625aafd2cfd3989991642dc5af697569e19566df32
-  data.tar.gz: d026883962480255da7515279a57423b5c43e38b2743553727ec132e10dc1156d53688a6634f99d820cebc858d221b07f8cf8940a4eacc6017c3d45b04d968c4
+  metadata.gz: 22491d526fdcaf97d1f5d910cac626ecbf19acc6729e43746743b4394bc46a7b923db762874400fdcecb65cdbe2ea6e7487ce3c66f5656d45c9409755a10dc2f
+  data.tar.gz: eedcea418fbc75dea800de3700d5dd48a62f1b2f47702b470ca1b1c4c3d564f8a4f2e5f58b8754f27a11aac64e0f8ddd5eea0e576ed2a046812d38ef532a73df

data/README.md

@@ -54,11 +54,12 @@ Most methods have positional arguments for required input and an options hash
 for optional parameters, headers, or other options:
 
 ```ruby
+client = Octokit::Client.new
+
 # Fetch a README with Accept header for HTML format
-Octokit.readme 'al3x/sovereign', :accept => 'application/vnd.github.html'
+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
 
@@ -74,24 +75,15 @@ Install via Rubygems
 
 ### Making requests
 
-[API methods][] are available as module methods (consuming module-level
-configuration) or as client instance methods.
+[API methods][] are available as client instance methods.
 
 ```ruby
 # Provide authentication credentials
-Octokit.configure do |c|
-  c.login = 'defunkt'
-  c.password = 'c0d3b4ssssss!'
-end
+client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
 
-# Fetch the current user
-Octokit.user
-```
-or
+# Set access_token instead of login and password if you use personal access token
+# client = Octokit::Client.new(:access_token => '[personal_access_token]!')
 
-```ruby
-# Provide authentication credentials
-client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
 # Fetch the current user
 client.user
 ```
@@ -108,7 +100,6 @@ When passing additional parameters to GET based request use the following syntax
  # Example: Get contents of a repository by ref
  # https://api.github.com/repos/octokit/octokit.rb/contents/path/to/file.rb?ref=some-other-branch
  client.contents('octokit/octokit.rb', path: 'path/to/file.rb', query: {ref: 'some-other-branch'})
-
 ```
 
 [API methods]: http://octokit.github.io/octokit.rb/method_list.html
@@ -119,8 +110,10 @@ Most methods return a `Resource` object which provides dot notation and `[]`
 access for fields returned in the API response.
 
 ```ruby
+client = Octokit::Client.new
+
 # Fetch a user
-user = Octokit.user 'jbarnette'
+user = client.user 'jbarnette'
 puts user.name
 # => "John Barnette"
 puts user.fields
@@ -141,8 +134,8 @@ need access to the raw HTTP response headers. You can access the last HTTP
 response with `Client#last_response`:
 
 ```ruby
-user      = Octokit.user 'andrewpthorp'
-response  = Octokit.last_response
+user      = client.user 'andrewpthorp'
+response  = client.last_response
 etag      = response.headers[:etag]
 ```
 
@@ -157,9 +150,7 @@ Using your GitHub username and password is the easiest way to get started
 making authenticated requests:
 
 ```ruby
-client = Octokit::Client.new \
-  :login    => 'defunkt',
-  :password => 'c0d3b4ssssss!'
+client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
 
 user = client.user
 user.login
@@ -194,9 +185,7 @@ You can [create access tokens through your GitHub Account Settings](https://help
 or with a basic authenticated Octokit client:
 
 ```ruby
-client = Octokit::Client.new \
-  :login    => 'defunkt',
-  :password => 'c0d3b4ssssss!'
+client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
 
 client.create_authorization(:scopes => ["user"], :note => "Name of token")
 # => <your new oauth token>
@@ -282,7 +271,7 @@ user = client.user 'defunkt'
 Default results from the GitHub API are 30, if you wish to add more you must do so during Octokit configuration.
 
 ```ruby
-  Octokit::Client.new(access_token: "<your 40 char token>", per_page: 100)
+Octokit::Client.new(access_token: "<your 40 char token>", per_page: 100)
 ```
 
 ## Pagination
@@ -293,8 +282,8 @@ previous, and last pages for you in the `Link` response header as [Hypermedia
 link relations](#hypermedia-agent).
 
 ```ruby
-issues = Octokit.issues 'rails/rails'
-issues.concat Octokit.last_response.rels[:next].get.data
+issues = client.issues 'rails/rails'
+issues.concat client.last_response.rels[:next].get.data
 ```
 
 ### Auto pagination
@@ -304,13 +293,21 @@ enabled, calls for paginated resources will fetch and concatenate the results
 from every page into a single array:
 
 ```ruby
-Octokit.auto_paginate = true
-issues = Octokit.issues 'rails/rails'
+client.auto_paginate = true
+issues = client.issues 'rails/rails'
 issues.length
 
 # => 702
 ```
 
+You can also enable auto pagination for all Octokit client instances:
+
+```ruby
+Octokit.configure do |c|
+  c.auto_paginate = true
+end
+```
+
 **Note:** While Octokit auto pagination will set the page size to the maximum
 `100`, and seek to not overstep your rate limit, you probably want to use a
 custom pattern for traversing large lists.
@@ -329,6 +326,7 @@ To interact with the "regular" GitHub.com APIs in GitHub Enterprise, simply conf
 Octokit.configure do |c|
   c.api_endpoint = "https://<hostname>/api/v3/"
 end
+
 client = Octokit::Client.new(:access_token => "<your 40 char token>")
 ```
 
@@ -337,16 +335,18 @@ client = Octokit::Client.new(:access_token => "<your 40 char token>")
 The GitHub Enterprise Admin APIs are under a different client: `EnterpriseAdminClient`. You'll need to have an administrator account in order to use these APIs.
 
 ``` ruby
-admin_client = Octokit::EnterpriseAdminClient.new \
-                          :access_token => "<your 40 char token>",
-                          :api_endpoint => "https://<hostname>/api/v3/"
+admin_client = Octokit::EnterpriseAdminClient.new(
+  :access_token => "<your 40 char token>",
+  :api_endpoint => "https://<hostname>/api/v3/"
+)
 
 # or
 Octokit.configure do |c|
   c.api_endpoint = "https://<hostname>/api/v3/"
   c.access_token = "<your 40 char token>"
 end
-admin_client = Octokit.enterprise_admin_client
+
+admin_client = Octokit.enterprise_admin_client.new
 ```
 
 ### Interacting with the GitHub Enterprise Management Console APIs
@@ -354,15 +354,18 @@ admin_client = Octokit.enterprise_admin_client
 The GitHub Enterprise Management Console APIs are also under a separate client: `EnterpriseManagementConsoleClient`. In order to use it, you'll need to provide both your management console password as well as the endpoint to your management console. This is different than the API endpoint provided above.
 
 ``` ruby
-management_console_client = Octokit::EnterpriseManagementConsoleClient.new \
-                          :management_console_password => "secret",
-                          :management_console_endpoint = "https://hostname:8633"
+management_console_client = Octokit::EnterpriseManagementConsoleClient.new(
+  :management_console_password => "secret",
+  :management_console_endpoint = "https://hostname:8633"
+)
+
 # or
 Octokit.configure do |c|
   c.management_console_endpoint = "https://hostname:8633"
   c.management_console_password = "secret"
 end
-management_console_client = Octokit.enterprise_management_console_client
+
+management_console_client = Octokit.enterprise_management_console_client.new
 ```
 
 ### SSL Connection Errors
@@ -410,7 +413,7 @@ Octokit's default.
 
 ```ruby
 # Given $OCTOKIT_API_ENDPOINT is "http://api.github.dev"
-Octokit.api_endpoint
+client.api_endpoint
 
 # => "http://api.github.dev"
 ```
@@ -430,7 +433,7 @@ Resources returned by Octokit methods contain not only data but hypermedia
 link relations:
 
 ```ruby
-user = Octokit.user 'technoweenie'
+user = client.user 'technoweenie'
 
 # Get the repos rel, returned from the API
 # as repos_url in the resource
@@ -451,7 +454,7 @@ You might notice many link relations have variable placeholders. Octokit
 supports [URI Templates][uri-templates] for parameterized URI expansion:
 
 ```ruby
-repo = Octokit.repo 'pengwynn/pingwynn'
+repo = client.repo 'pengwynn/pingwynn'
 rel = repo.rels[:issues]
 # => #<Sawyer::Relation: issues: get https://api.github.com/repos/pengwynn/pingwynn/issues{/number}>
 
@@ -468,7 +471,7 @@ If you want to use Octokit as a pure hypermedia API client, you can start at
 the API root and follow link relations from there:
 
 ```ruby
-root = Octokit.root
+root = client.root
 root.rels[:repository].get :uri => {:owner => "octokit", :repo => "octokit.rb" }
 root.rels[:user_repositories].get :uri => { :user => "octokit" },
                                   :query => { :type => "owner" }
@@ -508,7 +511,7 @@ Octokit.default_media_type = "application/vnd.github.beta+json"
 or per-request
 
 ```ruby
-Octokit.emails(:accept => "application/vnd.github.beta+json")
+client.emails(:accept => "application/vnd.github.beta+json")
 ```
 
 The long-deprecated `Octokit::Client#create_download` method has been removed.
@@ -549,6 +552,7 @@ traffic:
 
 ```ruby
 stack = Faraday::RackBuilder.new do |builder|
+  builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
   builder.use Octokit::Middleware::FollowRedirects
   builder.use Octokit::Response::RaiseError
   builder.use Octokit::Response::FeedParser
@@ -556,7 +560,9 @@ stack = Faraday::RackBuilder.new do |builder|
   builder.adapter Faraday.default_adapter
 end
 Octokit.middleware = stack
-Octokit.user 'pengwynn'
+
+client = Octokit::Client.new
+client.user 'pengwynn'
 ```
 ```
 I, [2013-08-22T15:54:38.583300 #88227]  INFO -- : get https://api.github.com/users/pengwynn
@@ -681,6 +687,7 @@ implementations:
 * Ruby 2.2
 * Ruby 2.3
 * Ruby 2.4
+* Ruby 2.5
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 

data/lib/octokit/client/authorizations.rb

@@ -231,11 +231,11 @@ module Octokit
         if app_id.to_s.empty?
           raise Octokit::ApplicationCredentialsRequired.new "client_id required"
         end
-        authorize_url = options.delete(:endpoint) || Octokit.web_endpoint
+        authorize_url = opts.delete(:endpoint) || Octokit.web_endpoint
         authorize_url << "login/oauth/authorize?client_id=#{app_id}"
 
         require 'cgi'
-        options.each do |key, value|
+        opts.each do |key, value|
           authorize_url << "&#{key}=#{CGI.escape value}"
         end
 

data/lib/octokit/client/issues.rb

@@ -335,6 +335,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 options [Hash] Header params for request
       # @return [Sawyer::Resource] Issue
       # @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue
       # @example Remove assignees "pengwynn" and "joeyw" from Issue #23 on octokit/octokit.rb

data/lib/octokit/client/marketplace.rb

@@ -14,8 +14,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] A list of plans
       def list_plans(options = {})
-        opts = ensure_api_media_type(:marketplace, options)
-        paginate "/marketplace_listing/plans", opts
+        paginate "/marketplace_listing/plans", options
       end
 
       # List all GitHub accounts on a specific plan
@@ -27,8 +26,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] A list of accounts
       def list_accounts_for_plan(plan_id, options = {})
-        opts = ensure_api_media_type(:marketplace, options)
-        paginate "/marketplace_listing/plans/#{plan_id}/accounts", opts
+        paginate "/marketplace_listing/plans/#{plan_id}/accounts", options
       end
 
       # Get the plan associated with a given GitHub account
@@ -40,8 +38,7 @@ module Octokit
       #
       # @return <Sawyer::Resource> Account with plan details, or nil
       def plan_for_account(account_id, options = {})
-        opts = ensure_api_media_type(:marketplace, options)
-        get "/marketplace_listing/accounts/#{account_id}", opts
+        get "/marketplace_listing/accounts/#{account_id}", options
       end
 
       # Get user's Marketplace purchases
@@ -52,8 +49,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] A list of Marketplace purchases
       def marketplace_purchases(options = {})
-        opts = ensure_api_media_type(:marketplace, options)
-        get "/user/marketplace_purchases", opts
+        get "/user/marketplace_purchases", options
       end
     end
   end

data/lib/octokit/client/pull_requests.rb

@@ -27,6 +27,8 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of the pull request to fetch
       # @return [Sawyer::Resource] Pull request info
+      # @example
+      #   Octokit.pull_request('rails/rails', 42, :state => 'closed')      
       def pull_request(repo, number, options = {})
         get "#{Repository.path repo}/pulls/#{number}", options
       end

data/lib/octokit/client/repositories.rb

@@ -380,6 +380,39 @@ module Octokit
       alias :repo_teams :repository_teams
       alias :teams :repository_teams
 
+      # List all topics for a repository
+      #
+      # Requires authenticated client for private repos.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Sawyer::Resource] representing the topics for given repo
+      # @see https://developer.github.com/v3/repos/#list-all-topics-for-a-repository
+      # @example List topics for octokit/octokit.rb
+      #   Octokit.topics('octokit/octokit.rb')
+      # @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
+      end
+
+      # Replace all topics for a repository
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Repository, Hash] A Github repository
+      # @param names [Array] An array of topics to add to the repository.
+      # @return [Sawyer::Resource] representing the replaced topics for given repo
+      # @see https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository
+      # @example Replace topics for octokit/octokit.rb
+      #   client.replace_all_topics('octokit/octokit.rb', ['octocat', 'atom', 'electron', 'API'])
+      # @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)
+      end
+
       # List contributors to a repo
       #
       # Requires authenticated client for private repos.

data/lib/octokit/client/repository_invitations.rb

@@ -15,7 +15,6 @@ module Octokit
       # @return [Sawyer::Resource] The repository invitation
       # @see https://developer.github.com/v3/repos/invitations/#invite-a-user-to-a-repository
       def invite_user_to_repository(repo, user, options = {})
-        options = ensure_api_media_type(:repository_invitations, options)
         put "#{Repository.path repo}/collaborators/#{user}", options
       end
       alias invite_user_to_repo invite_user_to_repository
@@ -28,7 +27,6 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of invitations
       # @see https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository
       def repository_invitations(repo, options = {})
-        options = ensure_api_media_type(:repository_invitations, options)
         paginate "#{Repository.path repo}/invitations", options
       end
       alias repo_invitations repository_invitations
@@ -42,7 +40,6 @@ module Octokit
       # @return [Boolean] True if the invitation was successfully deleted
       # @see https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation
       def delete_repository_invitation(repo, invitation_id, options = {})
-        options = ensure_api_media_type(:repository_invitations, options)
         boolean_from_response :delete, "#{Repository.path repo}/invitations/#{invitation_id}", options
       end
       alias delete_repo_invitation delete_repository_invitation
@@ -56,7 +53,6 @@ module Octokit
       # @return [Sawyer::Resource] The updated repository invitation
       # @see https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation
       def update_repository_invitation(repo, invitation_id, options = {})
-        options = ensure_api_media_type(:repository_invitations, options)
         patch "#{Repository.path repo}/invitations/#{invitation_id}", options
       end
       alias update_repo_invitation update_repository_invitation
@@ -68,7 +64,6 @@ 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 = {})
-        options = ensure_api_media_type(:repository_invitations, options)
         paginate "/user/repository_invitations", options
       end
       alias user_repo_invitations user_repository_invitations
@@ -81,7 +76,6 @@ module Octokit
       # @return [Boolean] True if the acceptance of the invitation was successful
       # @see https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation
       def accept_repository_invitation(invitation_id, options = {})
-        options = ensure_api_media_type(:repository_invitations, options)
         patch "/user/repository_invitations/#{invitation_id}", options
       end
       alias accept_repo_invitation accept_repository_invitation
@@ -94,7 +88,6 @@ module Octokit
       # @return [Boolean] True if the acceptance of the invitation was successful
       # @see https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation
       def decline_repository_invitation(invitation_id, options = {})
-        options = ensure_api_media_type(:repository_invitations, options)
         boolean_from_response :delete, "/user/repository_invitations/#{invitation_id}", options
       end
       alias decline_invitation decline_repository_invitation

data/lib/octokit/client/reviews.rb

@@ -9,21 +9,21 @@ module Octokit
       # List reviews on a pull request
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param id [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @see https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request
       #
       # @example
       #   @client.pull_request_reviews('octokit/octokit.rb', 2)
       #
       # @return [Array<Sawyer::Resource>] Array of Hashes representing the reviews
-      def pull_request_reviews(repo, id, options = {})
-        paginate "#{Repository.path repo}/pulls/#{id}/reviews", options
+      def pull_request_reviews(repo, number, options = {})
+        paginate "#{Repository.path repo}/pulls/#{number}/reviews", options
       end
 
       # Get a single review
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param number [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @param review [Integer] The id of the review
       # @see https://developer.github.com/v3/pulls/reviews/#get-a-single-review
       #
@@ -38,7 +38,7 @@ module Octokit
       # Delete a pending review
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param number [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @param review [Integer] The id of the review
       # @see https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review
       #
@@ -53,7 +53,7 @@ module Octokit
       # Get comments for a single review
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param number [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @param review [Integer] The id of the review
       # @see https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review
       #
@@ -68,7 +68,7 @@ module Octokit
       # Create a pull request review
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param id [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @param options [Hash] Method options
       # @option options [String] :event The review action (event) to perform;
       #   can be one of APPROVE, REQUEST_CHANGES, or COMMENT.
@@ -89,14 +89,14 @@ module Octokit
       #   @client.create_pull_request_review('octokit/octokit.rb', 844, options)
       #
       # @return [Sawyer::Resource>] Hash respresenting the review
-      def create_pull_request_review(repo, id, options = {})
-        post "#{Repository.path repo}/pulls/#{id}/reviews", options
+      def create_pull_request_review(repo, number, options = {})
+        post "#{Repository.path repo}/pulls/#{number}/reviews", options
       end
 
       # Submit a pull request review
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param number [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @param review [Integer] The id of the review
       # @param event [String] The review action (event) to perform; can be one of
       #                       APPROVE, REQUEST_CHANGES, or COMMENT.
@@ -117,7 +117,7 @@ module Octokit
       # Dismiss a pull request review
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param number [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @param review [Integer] The id of the review
       # @param message [String] The message for the pull request review dismissal
       # @see https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review
@@ -134,31 +134,75 @@ module Octokit
       # List review requests
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param id [Integer] The id of the pull request
+      # @param number [Integer] Number ID of the pull request
       # @see https://developer.github.com/v3/pulls/review_requests/#list-review-requests
       #
       # @example
       #   @client.pull_request_review_requests('octokit/octokit.rb', 2)
       #
       # @return [Array<Sawyer::Resource>] Array of Hashes representing the review requests
-      def pull_request_review_requests(repo, id, options = {})
-        paginate "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
+      def pull_request_review_requests(repo, number, options = {})
+        paginate "#{Repository.path repo}/pulls/#{number}/requested_reviewers", options
       end
 
       # Create a review request
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @param id [Integer] The id of the pull request
-      # @param reviewers [Array<String>] An array of user logins that will be requested
+      # @param number [Integer] Number ID of the pull request
+      # @param options [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
       #
       # @example
-      #   @client.request_pull_request_review('octokit/octokit.rb', 2, ['soudy'])
+      #   @client.request_pull_request_review('octokit/octokit.rb', 2, reviewers: ['soudy'])
       #
       # @return [Sawyer::Resource>] Hash respresenting the pull request
-      def request_pull_request_review(repo, id, reviewers, options = {})
-        options = options.merge(reviewers: reviewers)
-        post "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
+      def request_pull_request_review(repo, number, reviewers = {}, options = {})
+        # TODO(5.0): remove deprecated behavior
+        if reviewers.is_a?(Array)
+          octokit_warn(
+            "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."
+          )
+          options = options.merge(reviewers: reviewers)
+        else
+          options = options.merge(reviewers)
+        end
+
+        post "#{Repository.path repo}/pulls/#{number}/requested_reviewers", options
+      end
+
+      # Delete a review request
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @param options [Hash] :reviewers [Array] An array of user logins
+      # @param options [Hash] :team_reviewers [Array] An array of team slugs
+      #
+      # @see https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request
+      #
+      # @example
+      #   options = {
+      #     "reviewers" => [ "octocat", "hubot", "other_user" ],
+      #     "team_reviewers" => [ "justice-league" ]
+      #   }
+      #   @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 = {})
+        # TODO(5.0): remove deprecated behavior
+        if !reviewers.empty? && !options.empty?
+          octokit_warn(
+            "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."
+          )
+        end
+        # For backwards compatibility, this endpoint can be called with a separate reviewers hash.
+        # If not called with a separate hash, then 'reviewers' is, in fact, 'options'.
+        options = options.merge(reviewers)
+        delete "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
       end
     end
   end

data/lib/octokit/client/stats.rb

@@ -96,6 +96,7 @@ module Octokit
         loop do
           data = get("#{Repository.path repo}/stats/#{metric}", options)
           return data if last_response.status == 200
+          return [] if last_response.status == 204
           return nil unless retry_timeout
           return nil if Time.now >= timeout
           sleep retry_wait if retry_wait

data/lib/octokit/client/statuses.rb

@@ -13,7 +13,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of statuses
       # @see https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref
       def statuses(repo, sha, options = {})
-        get "#{Repository.path repo}/statuses/#{sha}", options
+        paginate "#{Repository.path repo}/statuses/#{sha}", options
       end
       alias :list_statuses :statuses
 

data/lib/octokit/default.rb

@@ -25,6 +25,7 @@ module Octokit
 
     # Default Faraday middleware stack
     MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
       builder.use Octokit::Middleware::FollowRedirects
       builder.use Octokit::Response::RaiseError
       builder.use Octokit::Response::FeedParser
@@ -143,7 +144,7 @@ module Octokit
         # 0 is OpenSSL::SSL::VERIFY_NONE
         # 1 is OpenSSL::SSL::SSL_VERIFY_PEER
         # the standard default for SSL is SSL_VERIFY_PEER which requires a server certificate check on the client
-        ENV['OCTOKIT_SSL_VERIFY_MODE'] || 1 
+        ENV.fetch('OCTOKIT_SSL_VERIFY_MODE', 1).to_i
       end
 
       # Default User-Agent header string from ENV or {USER_AGENT}

data/lib/octokit/enterprise_admin_client/admin_stats.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise Admin Stats API
     #
-    # @see https://developer.github.com/v3/enterprise/admin_stats/
+    # @see https://developer.github.com/v3/enterprise-admin/admin_stats/
     module AdminStats
 
       # Get all available stats

data/lib/octokit/enterprise_admin_client/license.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise License API
     #
-    # @see https://developer.github.com/v3/enterprise/license/
+    # @see https://developer.github.com/v3/enterprise-admin/license/
     module License
 
       # Get information about the Enterprise license

data/lib/octokit/enterprise_admin_client/orgs.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise Orgs API
     #
-    # @see https://developer.github.com/v3/enterprise/orgs/
+    # @see https://developer.github.com/v3/enterprise-admin/orgs/
     module Orgs
 
       # Create a new organization on the instance.
@@ -13,7 +13,7 @@ module Octokit
       # @param options [Hash] A set of options.
       # @option options [String] :profile_name The organization's display name.
       # @return [nil]
-      # @see https://developer.github.com/v3/enterprise/orgs/#create-an-organization
+      # @see https://developer.github.com/v3/enterprise-admin/orgs/#create-an-organization
       # @example
       #   @admin_client.create_organization('SuchAGreatOrg', 'gjtorikian')
       def create_organization(login, admin, options = {})

data/lib/octokit/enterprise_admin_client/search_indexing.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise Search Indexing API
     #
-    # @see https://developer.github.com/v3/enterprise/search_indexing/
+    # @see https://developer.github.com/v3/enterprise-admin/search_indexing/
     module SearchIndexing
 
       # Queue a User or Organization to be indexed

data/lib/octokit/enterprise_admin_client/users.rb

@@ -3,13 +3,13 @@ module Octokit
 
     # Methods for the Enterprise User Administration API
     #
-    # @see https://developer.github.com/v3/users/administration/
+    # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/
     module Users
       # Create a new user.
       #
       # @param login [String] The user's username.
       # @param email [String] The user's email address.
-      # @see https://developer.github.com/v3/users/administration/#create-a-new-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users#create-a-new-user
       # @example
       #   @admin_client.create_user('foobar', 'notreal@foo.bar')
       def create_user(login, email, options = {})
@@ -22,7 +22,7 @@ module Octokit
       #
       # @param user [String] Username of the user to promote.
       # @return [Boolean] True if promote was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#promote-an-ordinary-user-to-a-site-administrator
       # @example
       #   @admin_client.promote('holman')
       def promote(user, options = {})
@@ -33,7 +33,7 @@ module Octokit
       #
       # @param user [String] Username of the user to demote.
       # @return [Boolean] True if demote was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#demote-a-site-administrator-to-an-ordinary-user
       # @example
       #   @admin_client.demote('holman')
       def demote(user, options = {})
@@ -44,7 +44,7 @@ module Octokit
       #
       # @param old_login [String] The user's old username.
       # @param new_login [String] The user's new username.
-      # @see https://developer.github.com/v3/users/administration/#rename-an-existing-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#rename-an-existing-user
       # @example
       #   @admin_client.rename_user('foobar', 'foofoobar')
       def rename_user(old_login, new_login, options = {})
@@ -55,7 +55,7 @@ module Octokit
       # Deletes a user.
       #
       # @param username [String] The username to delete.
-      # @see https://developer.github.com/v3/users/administration/#delete-a-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-user
       # @example
       #   @admin_client.delete_key(1)
       def delete_user(username, options = {})
@@ -66,7 +66,7 @@ module Octokit
       #
       # @param user [String] Username of the user to suspend.
       # @return [Boolean] True if suspend was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#suspend-a-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#suspend-a-user
       # @example
       #   @admin_client.suspend('holman')
       def suspend(user, options = {})
@@ -77,7 +77,7 @@ module Octokit
       #
       # @param user [String] Username of the user to unsuspend.
       # @return [Boolean] True if unsuspend was successful, false otherwise.
-      # @see https://developer.github.com/v3/users/administration/#unsuspend-a-user
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#unsuspend-a-user
       # @example
       #   @admin_client.unsuspend('holman')
       def unsuspend(user, options = {})
@@ -88,7 +88,7 @@ module Octokit
       #
       # @param login [String] The user to create a token for.
       # @param options [Array<String>] :scopes The scopes to apply.
-      # @see https://developer.github.com/v3/users/administration/#create-an-impersonation-oauth-token
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token
       # @example
       #   @admin_client.create_impersonation_token('foobar', {:scopes => ['repo:write']})
       def create_impersonation_token(login, options = {})
@@ -98,7 +98,7 @@ module Octokit
       # Deletes an impersonation OAuth token.
       #
       # @param login [String] The user whose token should be deleted.
-      # @see https://developer.github.com/v3/users/administration/#delete-an-impersonation-oauth-token
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token
       # @example
       #   @admin_client.delete_impersonation_token('foobar')
       def delete_impersonation_token(login, options = {})
@@ -107,7 +107,7 @@ module Octokit
 
       # Lists all the public SSH keys.
       #
-      # @see https://developer.github.com/v3/users/administration/#list-all-public-keys
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#list-all-public-keys
       # @example
       #   @admin_client.list_all_keys
       def list_all_keys(options = {})
@@ -117,7 +117,7 @@ module Octokit
       # Deletes a public SSH keys.
       #
       # @param id [Number] The ID of the key to delete.
-      # @see https://developer.github.com/v3/users/administration/#delete-a-public-key
+      # @see https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-public-key
       # @example
       #   @admin_client.delete_key(1)
       def delete_key(id, options = {})

data/lib/octokit/enterprise_management_console_client.rb

@@ -10,7 +10,7 @@ module Octokit
   #
   # @see Octokit::Client Use Octokit::Client for regular API use for GitHub
   #   and GitHub Enterprise.
-  # @see https://developer.github.com/v3/enterprise/management_console/
+  # @see https://developer.github.com/v3/enterprise-admin/management_console/
   class EnterpriseManagementConsoleClient
 
     include Octokit::Configurable

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Enterprise Management Console API
     #
-    # @see https://developer.github.com/v3/enterprise/management_console
+    # @see https://developer.github.com/v3/enterprise-admin/management_console/
     module ManagementConsole
 
       # Uploads a license for the first time

data/lib/octokit/preview.rb

@@ -10,14 +10,12 @@ module Octokit
       :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,
       :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,
       :integrations           => 'application/vnd.github.machine-man-preview+json'.freeze,
-      :marketplace            => 'application/vnd.github.valkyrie-preview+json'.freeze,
       :topics                 => 'application/vnd.github.mercy-preview+json'.freeze
     }
 

data/lib/octokit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.10.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API