Merge pull request #1047 from octokit/rework-request-review

Rework request review

lib/octokit/client/reviews.rb

@@ -149,37 +149,59 @@ def pull_request_review_requests(repo, number, options = {})
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number ID of the pull request
-      # @param reviewers [Array<String>] An array of user logins that will be requested
+      # @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, number, reviewers, options = {})
-        options = options.merge(reviewers: reviewers)
+      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 reviewers [Hash] A hash including "reviewers" which is an array of user
-      #                         logins and "team_reviewers" which is an array of team slug
+      # @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
-      #   reviewers = {
+      #   options = {
       #     "reviewers" => [ "octocat", "hubot", "other_user" ],
       #     "team_reviewers" => [ "justice-league" ]
       #   }
-      #   @client.delete_request_pull_request_review('octokit/octokit.rb', 2, reviewers)
+      #   @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 = {})
-        # "reviewers" has to be an array otherwise "422 - Invalid request"
-        options = options.merge(reviewers: reviewers.values.flatten)
+      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

spec/cassettes/Octokit_Client_Reviews/_pull_request_review/returns_a_single_pull_request_review.json

@@ -1 +1 @@
-{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/octokit/octokit.rb/pulls/825/reviews/6505518","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.9.0"],"Content-Type":["application/json"],"Authorization":["token <<ACCESS_TOKEN>>"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Date":["Wed, 06 Jun 2018 21:38:13 GMT"],"Content-Type":["application/json; charset=utf-8"],"Transfer-Encoding":["chunked"],"Server":["GitHub.com"],"Status":["200 OK"],"X-Ratelimit-Limit":["5000"],"X-Ratelimit-Remaining":["4838"],"X-Ratelimit-Reset":["1528322739"],"Cache-Control":["private, max-age=60, s-maxage=60"],"Vary":["Accept, Authorization, Cookie, X-GitHub-OTP","Accept-Encoding"],"Etag":["W/\"55a01215e2e381d19700df19b809e5cf\""],"X-Oauth-Scopes":["admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user, write:discussion"],"X-Accepted-Oauth-Scopes":[""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Frame-Options":["deny"],"X-Content-Type-Options":["nosniff"],"X-Xss-Protection":["1; mode=block"],"Referrer-Policy":["origin-when-cross-origin, strict-origin-when-cross-origin"],"Content-Security-Policy":["default-src 'none'"],"X-Runtime-Rack":["0.125355"],"X-Github-Request-Id":["C8FC:7AC2:96A022:AC80E8:5B185445"]},"body":{"encoding":"ASCII-8BIT","base64_string":"eyJpZCI6NjUwNTUxOCwibm9kZV9pZCI6Ik1ERTNPbEIxYkd4U1pYRjFaWE4w\nVW1WMmFXVjNOalV3TlRVeE9BPT0iLCJ1c2VyIjp7ImxvZ2luIjoidGFyZWJ5\ndGUiLCJpZCI6NTY0MTEzLCJub2RlX2lkIjoiTURRNlZYTmxjalUyTkRFeE13\nPT0iLCJhdmF0YXJfdXJsIjoiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2Vy\nY29udGVudC5jb20vdS81NjQxMTM/dj00IiwiZ3JhdmF0YXJfaWQiOiIiLCJ1\ncmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3RhcmVieXRlIiwi\naHRtbF91cmwiOiJodHRwczovL2dpdGh1Yi5jb20vdGFyZWJ5dGUiLCJmb2xs\nb3dlcnNfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy90YXJl\nYnl0ZS9mb2xsb3dlcnMiLCJmb2xsb3dpbmdfdXJsIjoiaHR0cHM6Ly9hcGku\nZ2l0aHViLmNvbS91c2Vycy90YXJlYnl0ZS9mb2xsb3dpbmd7L290aGVyX3Vz\nZXJ9IiwiZ2lzdHNfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vy\ncy90YXJlYnl0ZS9naXN0c3svZ2lzdF9pZH0iLCJzdGFycmVkX3VybCI6Imh0\ndHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMvdGFyZWJ5dGUvc3RhcnJlZHsv\nb3duZXJ9ey9yZXBvfSIsInN1YnNjcmlwdGlvbnNfdXJsIjoiaHR0cHM6Ly9h\ncGkuZ2l0aHViLmNvbS91c2Vycy90YXJlYnl0ZS9zdWJzY3JpcHRpb25zIiwi\nb3JnYW5pemF0aW9uc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3RhcmVieXRlL29yZ3MiLCJyZXBvc191cmwiOiJodHRwczovL2FwaS5n\naXRodWIuY29tL3VzZXJzL3RhcmVieXRlL3JlcG9zIiwiZXZlbnRzX3VybCI6\nImh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMvdGFyZWJ5dGUvZXZlbnRz\ney9wcml2YWN5fSIsInJlY2VpdmVkX2V2ZW50c191cmwiOiJodHRwczovL2Fw\naS5naXRodWIuY29tL3VzZXJzL3RhcmVieXRlL3JlY2VpdmVkX2V2ZW50cyIs\nInR5cGUiOiJVc2VyIiwic2l0ZV9hZG1pbiI6dHJ1ZX0sImJvZHkiOiLwn6SY\nIFxuIiwic3RhdGUiOiJBUFBST1ZFRCIsImh0bWxfdXJsIjoiaHR0cHM6Ly9n\naXRodWIuY29tL29jdG9raXQvb2N0b2tpdC5yYi9wdWxsLzgyNSNwdWxscmVx\ndWVzdHJldmlldy02NTA1NTE4IiwicHVsbF9yZXF1ZXN0X3VybCI6Imh0dHBz\nOi8vYXBpLmdpdGh1Yi5jb20vcmVwb3Mvb2N0b2tpdC9vY3Rva2l0LnJiL3B1\nbGxzLzgyNSIsImF1dGhvcl9hc3NvY2lhdGlvbiI6Ik1FTUJFUiIsIl9saW5r\ncyI6eyJodG1sIjp7ImhyZWYiOiJodHRwczovL2dpdGh1Yi5jb20vb2N0b2tp\ndC9vY3Rva2l0LnJiL3B1bGwvODI1I3B1bGxyZXF1ZXN0cmV2aWV3LTY1MDU1\nMTgifSwicHVsbF9yZXF1ZXN0Ijp7ImhyZWYiOiJodHRwczovL2FwaS5naXRo\ndWIuY29tL3JlcG9zL29jdG9raXQvb2N0b2tpdC5yYi9wdWxscy84MjUifX0s\nInN1Ym1pdHRlZF9hdCI6IjIwMTYtMTAtMzFUMTk6MTQ6MDJaIiwiY29tbWl0\nX2lkIjoiMWI3NDFjOGNmZDdiNTQwMjY3OGFkM2IyNTQzM2ZlOGIyOTI3YmUw\nNCJ9\n"},"http_version":null},"recorded_at":"Wed, 06 Jun 2018 21:38:13 GMT"}],"recorded_with":"VCR 3.0.3"}
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/octokit/octokit.rb/pulls/825/reviews/6505518","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.9.0"],"Content-Type":["application/json"],"Authorization":["token <<ACCESS_TOKEN>>"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Server":["GitHub.com"],"Date":["Tue, 07 Aug 2018 15:08:20 GMT"],"Content-Type":["application/json; charset=utf-8"],"Transfer-Encoding":["chunked"],"Status":["200 OK"],"X-Ratelimit-Limit":["5000"],"X-Ratelimit-Remaining":["4882"],"X-Ratelimit-Reset":["1533657311"],"Cache-Control":["private, max-age=60, s-maxage=60"],"Vary":["Accept, Authorization, Cookie, X-GitHub-OTP"],"Etag":["W/\"dee43dabab8f3849da2886edc330e859\""],"X-Oauth-Scopes":["admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user"],"X-Accepted-Oauth-Scopes":[""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Frame-Options":["deny"],"X-Content-Type-Options":["nosniff"],"X-Xss-Protection":["1; mode=block"],"Referrer-Policy":["origin-when-cross-origin, strict-origin-when-cross-origin"],"Content-Security-Policy":["default-src 'none'"],"X-Runtime-Rack":["0.147006"],"X-Github-Request-Id":["EC88:202C:26308DB:4690D54:5B69B5E4"]},"body":{"encoding":"ASCII-8BIT","base64_string":"eyJpZCI6NjUwNTUxOCwibm9kZV9pZCI6Ik1ERTNPbEIxYkd4U1pYRjFaWE4w\nVW1WMmFXVjNOalV3TlRVeE9BPT0iLCJ1c2VyIjp7ImxvZ2luIjoiPEdJVEhV\nQl9MT0dJTj4iLCJpZCI6NTY0MTEzLCJub2RlX2lkIjoiTURRNlZYTmxjalUy\nTkRFeE13PT0iLCJhdmF0YXJfdXJsIjoiaHR0cHM6Ly9hdmF0YXJzMi5naXRo\ndWJ1c2VyY29udGVudC5jb20vdS81NjQxMTM/dj00IiwiZ3JhdmF0YXJfaWQi\nOiIiLCJ1cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzLzxHSVRI\nVUJfTE9HSU4+IiwiaHRtbF91cmwiOiJodHRwczovL2dpdGh1Yi5jb20vPEdJ\nVEhVQl9MT0dJTj4iLCJmb2xsb3dlcnNfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0\naHViLmNvbS91c2Vycy88R0lUSFVCX0xPR0lOPi9mb2xsb3dlcnMiLCJmb2xs\nb3dpbmdfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy88R0lU\nSFVCX0xPR0lOPi9mb2xsb3dpbmd7L290aGVyX3VzZXJ9IiwiZ2lzdHNfdXJs\nIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy88R0lUSFVCX0xPR0lO\nPi9naXN0c3svZ2lzdF9pZH0iLCJzdGFycmVkX3VybCI6Imh0dHBzOi8vYXBp\nLmdpdGh1Yi5jb20vdXNlcnMvPEdJVEhVQl9MT0dJTj4vc3RhcnJlZHsvb3du\nZXJ9ey9yZXBvfSIsInN1YnNjcmlwdGlvbnNfdXJsIjoiaHR0cHM6Ly9hcGku\nZ2l0aHViLmNvbS91c2Vycy88R0lUSFVCX0xPR0lOPi9zdWJzY3JpcHRpb25z\nIiwib3JnYW5pemF0aW9uc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29t\nL3VzZXJzLzxHSVRIVUJfTE9HSU4+L29yZ3MiLCJyZXBvc191cmwiOiJodHRw\nczovL2FwaS5naXRodWIuY29tL3VzZXJzLzxHSVRIVUJfTE9HSU4+L3JlcG9z\nIiwiZXZlbnRzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMv\nPEdJVEhVQl9MT0dJTj4vZXZlbnRzey9wcml2YWN5fSIsInJlY2VpdmVkX2V2\nZW50c191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzLzxHSVRI\nVUJfTE9HSU4+L3JlY2VpdmVkX2V2ZW50cyIsInR5cGUiOiJVc2VyIiwic2l0\nZV9hZG1pbiI6dHJ1ZX0sImJvZHkiOiLwn6SYIFxuIiwic3RhdGUiOiJBUFBS\nT1ZFRCIsImh0bWxfdXJsIjoiaHR0cHM6Ly9naXRodWIuY29tL29jdG9raXQv\nb2N0b2tpdC5yYi9wdWxsLzgyNSNwdWxscmVxdWVzdHJldmlldy02NTA1NTE4\nIiwicHVsbF9yZXF1ZXN0X3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20v\ncmVwb3Mvb2N0b2tpdC9vY3Rva2l0LnJiL3B1bGxzLzgyNSIsImF1dGhvcl9h\nc3NvY2lhdGlvbiI6Ik1FTUJFUiIsIl9saW5rcyI6eyJodG1sIjp7ImhyZWYi\nOiJodHRwczovL2dpdGh1Yi5jb20vb2N0b2tpdC9vY3Rva2l0LnJiL3B1bGwv\nODI1I3B1bGxyZXF1ZXN0cmV2aWV3LTY1MDU1MTgifSwicHVsbF9yZXF1ZXN0\nIjp7ImhyZWYiOiJodHRwczovL2FwaS5naXRodWIuY29tL3JlcG9zL29jdG9r\naXQvb2N0b2tpdC5yYi9wdWxscy84MjUifX0sInN1Ym1pdHRlZF9hdCI6IjIw\nMTYtMTAtMzFUMTk6MTQ6MDJaIiwiY29tbWl0X2lkIjoiMWI3NDFjOGNmZDdi\nNTQwMjY3OGFkM2IyNTQzM2ZlOGIyOTI3YmUwNCJ9\n"},"http_version":null},"recorded_at":"Tue, 07 Aug 2018 15:08:20 GMT"}],"recorded_with":"VCR 3.0.3"}

spec/cassettes/Octokit_Client_Reviews/_pull_request_review_comments/returns_all_comments_for_a_single_review.json

@@ -1 +1 @@
-{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/octokit/octokit.rb/pulls/825/reviews/6505518/comments","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.9.0"],"Content-Type":["application/json"],"Authorization":["token <<ACCESS_TOKEN>>"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Date":["Wed, 06 Jun 2018 21:<GITHUB_TEST_INTEGRATION_INSTALLATION>:38 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["2"],"Server":["GitHub.com"],"Status":["200 OK"],"X-Ratelimit-Limit":["5000"],"X-Ratelimit-Remaining":["4887"],"X-Ratelimit-Reset":["1528322739"],"Cache-Control":["private, max-age=60, s-maxage=60"],"Vary":["Accept, Authorization, Cookie, X-GitHub-OTP","Accept-Encoding"],"Etag":["\"8f4a8adc80dcd5a50c93ab0d3c152c7c\""],"X-Oauth-Scopes":["admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user, write:discussion"],"X-Accepted-Oauth-Scopes":[""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Frame-Options":["deny"],"X-Content-Type-Options":["nosniff"],"X-Xss-Protection":["1; mode=block"],"Referrer-Policy":["origin-when-cross-origin, strict-origin-when-cross-origin"],"Content-Security-Policy":["default-src 'none'"],"X-Runtime-Rack":["0.082699"],"X-Github-Request-Id":["C8C5:7AC4:1202ECD:14DBFFC:5B185<GITHUB_TEST_INTEGRATION>2"]},"body":{"encoding":"UTF-8","base64_string":"W10=\n"},"http_version":null},"recorded_at":"Wed, 06 Jun 2018 21:37:38 GMT"}],"recorded_with":"VCR 3.0.3"}
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/octokit/octokit.rb/pulls/825/reviews/6505518/comments","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.9.0"],"Content-Type":["application/json"],"Authorization":["token <<ACCESS_TOKEN>>"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Server":["GitHub.com"],"Date":["Tue, 07 Aug 2018 15:08:20 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["2"],"Status":["200 OK"],"X-Ratelimit-Limit":["5000"],"X-Ratelimit-Remaining":["4883"],"X-Ratelimit-Reset":["1533657311"],"Cache-Control":["private, max-age=60, s-maxage=60"],"Vary":["Accept, Authorization, Cookie, X-GitHub-OTP"],"Etag":["\"34eb689bdcfe4f33014e7ef8facada5e\""],"X-Oauth-Scopes":["admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user"],"X-Accepted-Oauth-Scopes":[""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Frame-Options":["deny"],"X-Content-Type-Options":["nosniff"],"X-Xss-Protection":["1; mode=block"],"Referrer-Policy":["origin-when-cross-origin, strict-origin-when-cross-origin"],"Content-Security-Policy":["default-src 'none'"],"X-Runtime-Rack":["0.144084"],"X-Github-Request-Id":["EC87:202B:F2B948:235597C:5B69B5E4"]},"body":{"encoding":"UTF-8","base64_string":"W10=\n"},"http_version":null},"recorded_at":"Tue, 07 Aug 2018 15:08:20 GMT"}],"recorded_with":"VCR 3.0.3"}