Skip to content

Implement missing review request api #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 26, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions doc/pull_request/review_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Pull Requests / Review Requests API
[Back to the "Pull Requests API"](../pull_requests.md) | [Back to the navigation](../README.md)

The Pull Request Review API is currently available for developers to preview.
To access the API during the preview period, you must provide a custom media type in the Accept header:

```php
$client->api('pull_request')->reviewRequests()->configure();
```

### List all review requests

```php
$reviewRequests = $client->api('pull_request')->reviewRequests()->all('twbs', 'bootstrap', 12);
```

### Create a review request

```php
$client->api('pull_request')->reviewRequests()->create('twbs', 'bootstrap', 12, array('user1', 'user2'));
```

### Remove a review request

```php
$client->api('pull_request')->reviewRequests()->remove('twbs', 'bootstrap', 12, array('user1', 'user2'));
```
6 changes: 6 additions & 0 deletions lib/Github/Api/PullRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Github\Api\PullRequest\Comments;
use Github\Api\PullRequest\Review;
use Github\Api\PullRequest\ReviewRequest;
use Github\Exception\MissingArgumentException;

/**
Expand Down Expand Up @@ -71,6 +72,11 @@ public function reviews()
return new Review($this->client);
}

public function reviewRequests()
{
return new ReviewRequest($this->client);
}

/**
* Create a pull request.
*
Expand Down
10 changes: 10 additions & 0 deletions lib/Github/Api/PullRequest/Review.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Github\Api\PullRequest;

use Github\Api\AbstractApi;
use Github\Api\AcceptHeaderTrait;
use Github\Exception\InvalidArgumentException;
use Github\Exception\MissingArgumentException;

Expand All @@ -14,6 +15,15 @@
*/
class Review extends AbstractApi
{
use AcceptHeaderTrait;

public function configure()
{
$this->acceptHeaderValue = 'application/vnd.github.black-cat-preview+json';

return $this;
}

/**
* Get a listing of a pull request's reviews by the username, repository and pull request number.
*
Expand Down
66 changes: 66 additions & 0 deletions lib/Github/Api/PullRequest/ReviewRequest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?php

namespace Github\Api\PullRequest;

use Github\Api\AbstractApi;
use Github\Api\AcceptHeaderTrait;

/**
* @link https://developer.github.com/v3/pulls/review_requests/
*/
class ReviewRequest extends AbstractApi
{
use AcceptHeaderTrait;

public function configure()
{
$this->acceptHeaderValue = 'application/vnd.github.black-cat-preview+json';

return $this;
}

/**
* @link https://developer.github.com/v3/pulls/review_requests/#list-review-requests
*
* @param string $username
* @param string $repository
* @param int $pullRequest
* @param array $params
*
* @return array
*/
public function all($username, $repository, $pullRequest, array $params = [])
{
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/'.$pullRequest.'/requested_reviewers', $params);
}

/**
* @link https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
*
* @param string $username
* @param string $repository
* @param int $pullRequest
* @param array $reviewers
*
* @return string
*/
public function create($username, $repository, $pullRequest, array $reviewers)
{
return $this->post('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/'.$pullRequest.'/requested_reviewers', ['reviewers' => $reviewers]);
}

/**
* @link https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request
*
* @param string $username
* @param string $repository
* @param int $pullRequest
* @param array $reviewers
*
* @return string
*/
public function remove($username, $repository, $pullRequest, array $reviewers)
{
return $this->delete('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/'.$pullRequest.'/requested_reviewers', ['reviewers' => $reviewers]);
}
}
65 changes: 65 additions & 0 deletions test/Github/Tests/Api/PullRequest/ReviewRequestTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<?php

namespace Github\Tests\Api\PullRequest;

use Github\Api\PullRequest\ReviewRequest;
use Github\Tests\Api\TestCase;

class ReviewRequestTest extends TestCase
{
/**
* @test
*/
public function shouldGetAllReviewRequestsForAPullRequest()
{
$expectedValue = [
['id' => 80],
['id' => 81],
];

$api = $this->getApiMock();
$api
->expects($this->once())
->method('get')
->with('/repos/octocat/Hello-World/pulls/12/requested_reviewers')
->willReturn($expectedValue);

$this->assertSame($expectedValue, $api->all('octocat', 'Hello-World', 12));
}

/**
* @test
*/
public function shouldCreateReviewRequest()
{
$api = $this->getApiMock();
$api->expects($this->once())
->method('post')
->with('/repos/octocat/Hello-World/pulls/12/requested_reviewers', ['reviewers' => ['testuser']])
;

$api->create('octocat', 'Hello-World', 12, ['testuser']);
}

/**
* @test
*/
public function shouldDeleteReviewRequest()
{
$api = $this->getApiMock();
$api->expects($this->once())
->method('delete')
->with('/repos/octocat/Hello-World/pulls/12/requested_reviewers', ['reviewers' => ['testuser']])
;

$api->remove('octocat', 'Hello-World', 12, ['testuser']);
}

/**
* @return string
*/
protected function getApiClass()
{
return ReviewRequest::class;
}
}