jimbojsb/github-repo-events

A standalone client for parsing the Github Repo Events API

Github Repo Events

This library will allow you to poll the Github events API rather than using a web hook., _(*1)

Usage

Basic usage on a public repo, _(*2)

$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo");
foreach ($eventsStream as $event) {
    // do stuff with events
}

Add an API key for increased quota or access to private repos, _(*3)

$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo", "githubApiKey");
foreach ($eventsStream as $event) {
    // do stuff with events
}

Use ETags to avoid quota hits, _(*4)

// costs from quota
$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo", "githubApiKey");
foreach ($eventsStream as $event) {
    // do stuff with events
}

$etag = $eventStream->getEtag();

// does not cost from quota, assuming the stream has no new events
$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo", "githubApiKey");
$eventStream->setEtag($etag);
foreach ($eventsStream as $event) {
    // do stuff with events
}