Skip to content

Add configure() support for issues #532

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.

Sign up for GitHub

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 6 commits into from
Mar 27, 2017
Merged

Add configure() support for issues #532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
962beba
Add configure() support for issues
bobeagan Mar 3, 2017
8380ce4
add more configure methods to address missing custom media types
bobeagan Mar 6, 2017
a45ce63
switch order of configure values for PullRequest and PullRequest/Comm…
bobeagan Mar 23, 2017
debf2b3
Merge branch 'master' into patch-2
bobeagan Mar 27, 2017
07cb9e4
update configure() to be chainable per #544
bobeagan Mar 27, 2017
f210737
revert existing bodyTypes that were defaulting to "full" instead of "…
bobeagan Mar 27, 2017
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
22 changes: 22 additions & 0 deletions lib/Github/Api/Gist/Comments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,35 @@
namespace Github\Api\Gist;

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

/**
* @link https://developer.github.com/v3/gists/comments/
* @author Kayla Daniels <[email protected]>
*/
class Comments extends AbstractApi
{
use AcceptHeaderTrait;

/**
* Configure the body type.
*
* @link https://developer.github.com/v3/gists/comments/#custom-media-types
* @param string|null $bodyType
*
* @return self
*/
public function configure($bodyType = null)
{
if (!in_array($bodyType, array('text', 'html', 'full'))) {
$bodyType = 'raw';
}

$this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s+json', $this->client->getApiVersion(), $bodyType);

return $this;
}

/**
* Get all comments for a gist.
*
Expand Down
21 changes: 21 additions & 0 deletions lib/Github/Api/Gists.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,27 @@
*/
class Gists extends AbstractApi
{
use AcceptHeaderTrait;

/**
* Configure the body type.
*
* @link https://developer.github.com/v3/gists/#custom-media-types
* @param string|null $bodyType
*
* @return self
*/
public function configure($bodyType = null)
{
if (!in_array($bodyType, array('base64'))) {
$bodyType = 'raw';
}

$this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s', $this->client->getApiVersion(), $bodyType);

return $this;
}

public function all($type = null)
{
if (!in_array($type, array('public', 'starred'))) {
Expand Down
21 changes: 21 additions & 0 deletions lib/Github/Api/Issue.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,27 @@
*/
class Issue extends AbstractApi
{
use AcceptHeaderTrait;

/**
* Configure the body type.
*
* @link https://developer.github.com/v3/issues/#custom-media-types
* @param string|null $bodyType
*
* @return self
*/
public function configure($bodyType = null)
{
if (!in_array($bodyType, array('text', 'html', 'full'))) {
$bodyType = 'raw';
}

$this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s+json', $this->client->getApiVersion(), $bodyType);

return $this;
}

/**
* List issues by username, repo and state.
*
Expand Down
30 changes: 30 additions & 0 deletions lib/Github/Api/PullRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,36 @@
*/
class PullRequest extends AbstractApi
{
use AcceptHeaderTrait;

/**
* Configure the body type.
*
* @link https://developer.github.com/v3/pulls/#custom-media-types
* @param string|null $bodyType
* @param string|null $apiVersion
*
* @return self
*/
public function configure($bodyType = null, $apiVersion = null)
{
if (!in_array($apiVersion, array('polaris-preview'))) {
$apiVersion = $this->client->getApiVersion();
}

if (!in_array($bodyType, array('text', 'html', 'full', 'diff', 'patch'))) {
$bodyType = 'raw';
}

if (!in_array($bodyType, array('diff', 'patch'))) {
$bodyType .= '+json';
}

$this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s', $this->client->getApiVersion(), $bodyType);

return $this;
}

/**
* Get a listing of a project's pull requests by the username, repository and (optionally) state.
*
Expand Down
27 changes: 27 additions & 0 deletions lib/Github/Api/PullRequest/Comments.php
View file
Open in desktop
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\MissingArgumentException;

/**
Expand All @@ -11,6 +12,32 @@
*/
class Comments extends AbstractApi
{
use AcceptHeaderTrait;

/**
* Configure the body type.
*
* @link https://developer.github.com/v3/pulls/comments/#custom-media-types
* @param string|null $bodyType
* @param string|null @apiVersion
*
* @return self
*/
public function configure($bodyType = null, $apiVersion = null)
{
if (!in_array($apiVersion, array('squirrel-girl-preview'))) {
$apiVersion = $this->client->getApiVersion();
}

if (!in_array($bodyType, array('text', 'html', 'full'))) {
$bodyType = 'raw';
}

$this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s+json', $apiVersion, $bodyType);

return $this;
}

public function all($username, $repository, $pullRequest = null)
{
if (null !== $pullRequest) {
Expand Down
22 changes: 6 additions & 16 deletions lib/Github/Api/Repository/Comments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,20 @@ class Comments extends AbstractApi
use AcceptHeaderTrait;

/**
* Configure the body type.
*
* @link https://developer.github.com/v3/repos/comments/#custom-media-types
* @param string|null $bodyType
*
* @return self
*/
public function configure($bodyType = null)
{
switch ($bodyType) {
case 'raw':
$header = sprintf('Accept: application/vnd.github.%s.raw+json', $this->client->getApiVersion());
break;

case 'text':
$header = sprintf('Accept: application/vnd.github.%s.text+json', $this->client->getApiVersion());
break;

case 'html':
$header = sprintf('Accept: application/vnd.github.%s.html+json', $this->client->getApiVersion());
break;

default:
$header = sprintf('Accept: application/vnd.github.%s.full+json', $this->client->getApiVersion());
if (!in_array($bodyType, array('raw', 'text', 'html'))) {
$bodyType = 'full';
}

$this->acceptHeaderValue = $header;
$this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s+json', $this->client->getApiVersion(), $bodyType);

return $this;
}
Expand Down
22 changes: 22 additions & 0 deletions lib/Github/Api/Repository/Contents.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Github\Api\Repository;

use Github\Api\AbstractApi;
use Github\Api\AcceptHeaderTrait;
use Github\Exception\InvalidArgumentException;
use Github\Exception\ErrorException;
use Github\Exception\MissingArgumentException;
Expand All @@ -14,6 +15,27 @@
*/
class Contents extends AbstractApi
{
use AcceptHeaderTrait;

/**
* Configure the body type.
*
* @link https://developer.github.com/v3/repo/contents/#custom-media-types
* @param string|null $bodyType
*
* @return self
*/
public function configure($bodyType = null)
{
if (!in_array($bodyType, array('html', 'object'))) {
$bodyType = 'raw';
}

$this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s', $this->client->getApiVersion(), $bodyType);

return $this;
}

/**
* Get content of README file in a repository.
*
Expand Down