GitHub API

A short intro to the GitHub API.
I created this slides for the GIT MeetUp in Berlin in Dezember 2013.

Transcript

1. GitHub API VersionEye
2. http://developer.github.com/
3. Use Cases • Login • Fetching Repositories / Files • Crawling Licenses / Change logs and more • Fetching commit dates from tags (release dates)
4. Authentication • Application Authentication • User Authentication (OAuth - user token)
5. Rate Limit • 50 per Hour for unauthenticated requests • 5000 per Hour for authenticated requests
6. Example: Fetching a user
7. url = "https://api.github.com/user"
8. Don’t do that! ! Use Octokit!
9. https://www.versioneye.com/ruby/octokit/2.6.3 Octokit - Ruby client for the GitHub API
10. client = Octokit::Client.new( :access_token => token ) client.user.to_json
12. TESTING
13. https://www.versioneye.com/ruby/vcr/2.8.0 VCR
15. Prepare for failure!
16. Exceptions • GitHub API can be down • Tokens can be revoked • Rate limit can exceed faster then you think • The API can change
17. Q / A @RobertReiz