-
-
Notifications
You must be signed in to change notification settings - Fork 599
Fixed the API calls for watching and unwatching a repo #183
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
Closed
Closed
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ad98746
Fixed the API calls for watching and unwatching a repo
aaronbloomfield 6e0cbd6
Merge remote-tracking branch 'upstream/master' into watch-fix
aaronbloomfield 9e51aa4
Added subscribe() and unsubscribe() to match the new watching API, an…
aaronbloomfield 95abfba
watch() and unwatch() are now proxies for subscribe() and unsubscribe()
aaronbloomfield 96e9648
Updated the documentation for subscribe() and unsubscribe()
aaronbloomfield 8086bb0
Updated the deprecated documentation lines for watch() and unwatch()
aaronbloomfield File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,61 +5,89 @@ | |
use Github\Api\AbstractApi; | ||
|
||
/** | ||
* @link http://developer.github.com/v3/repos/watching/ | ||
* @link https://developer.github.com/v3/activity/watching/ | ||
* @author Joseph Bielawski <[email protected]> | ||
*/ | ||
class Watchers extends AbstractApi | ||
{ | ||
/** | ||
* List repositories watched by the authenticated user | ||
* @link http://developer.github.com/v3/repos/watching/ | ||
* @link https://developer.github.com/v3/activity/watching/ | ||
* | ||
* @param integer $page | ||
* @return array | ||
*/ | ||
public function all($page = 1) | ||
{ | ||
return $this->get('user/watched', array( | ||
return $this->get('user/subscriptions', array( | ||
'page' => $page | ||
)); | ||
} | ||
|
||
/** | ||
* Check that the authenticated user watches a repository | ||
* @link http://developer.github.com/v3/repos/watching/ | ||
* @link https://developer.github.com/v3/activity/watching/ | ||
* | ||
* @param string $username the user who owns the repo | ||
* @param string $repository the name of the repo | ||
* @return array | ||
*/ | ||
public function check($username, $repository) | ||
{ | ||
return $this->get('user/watched/'.rawurlencode($username).'/'.rawurlencode($repository)); | ||
return $this->get('user/subscriptions/'.rawurlencode($username).'/'.rawurlencode($repository)); | ||
} | ||
|
||
/** | ||
* Make the authenticated user watch a repository | ||
* @link http://developer.github.com/v3/repos/watching/ | ||
* @deprecated The new command is subscribe(), not watch() | ||
* @link https://developer.github.com/v3/activity/watching/ | ||
* | ||
* @param string $username the user who owns the repo | ||
* @param string $repository the name of the repo | ||
* @return array | ||
*/ | ||
public function watch($username, $repository) | ||
{ | ||
return $this->put('user/watched/'.rawurlencode($username).'/'.rawurlencode($repository)); | ||
return $this->subscribe($username, $repository); | ||
} | ||
|
||
/** | ||
* Make the authenticated user unwatch a repository | ||
* @link http://developer.github.com/v3/repos/watching/ | ||
* @deprecated The new command is unsubscribe(), not unwatch() | ||
* @link https://developer.github.com/v3/activity/watching/ | ||
* | ||
* @param string $username the user who owns the repo | ||
* @param string $repository the name of the repo | ||
* @return array | ||
*/ | ||
public function unwatch($username, $repository) | ||
{ | ||
return $this->delete('user/watched/'.rawurlencode($username).'/'.rawurlencode($repository)); | ||
return $this->unsubscribe($username, $repository); | ||
} | ||
|
||
/** | ||
* Make the authenticated user subscribe to a repository | ||
* @link https://developer.github.com/v3/activity/watching/ | ||
* | ||
* @param string $username the user who owns the repo | ||
* @param string $repository the name of the repo | ||
* @return array | ||
*/ | ||
public function subscribe($username, $repository) | ||
{ | ||
return $this->put('user/subscriptions/'.rawurlencode($username).'/'.rawurlencode($repository)); | ||
} | ||
|
||
/** | ||
* Make the authenticated user unsubscribe from a repository | ||
* @link https://developer.github.com/v3/activity/watching/ | ||
* | ||
* @param string $username the user who owns the repo | ||
* @param string $repository the name of the repo | ||
* @return array | ||
*/ | ||
public function unsubscribe($username, $repository) | ||
{ | ||
return $this->delete('user/subscriptions/'.rawurlencode($username).'/'.rawurlencode($repository)); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be better to write it as
@deprecated use unsubscribe() instead
, to match common deprecation messages