# GithubAPI
[][travis] [][gemnasium] [][codeclimate]
[travis]: http://travis-ci.org/peter-murach/github
[gemnasium]: https://gemnasium.com/peter-murach/github
[codeclimate]: https://codeclimate.com/github/peter-murach/github
[Wiki](https://github.com/peter-murach/github/wiki) | [RDocs](http://rubydoc.info/github/peter-murach/github/master/frames)
A Ruby wrapper for the GitHub REST API v3.
Supports all the API methods(nearly 200). It's build in a modular way, that is, you can either instantiate the whole api wrapper Github.new or use parts of it e.i. Github::Repos.new if working solely with repositories is your main concern.
## Important!!
Since version 0.5 the way the gem queries the GitHub api underwent important changes. It closely mirros the Github api hierarchy e.i. if you want to create a download resource, lookup the github api spec and issue the request as in `github.repos.downloads.create`
## Installation
Install the gem by issuing
```ruby
gem install github_api
```
or put it in your Gemfile and run `bundle install`
```ruby
gem "github_api"
```
## Usage
Create a new client instance
```ruby
github = Github.new
```
At this stage you can also supply various configuration parameters, such as `:user`,`:repo`, `:org`, `:oauth_token`, `:basic_auth`, `:endpoint` which are used throughout the API. These can be passed directly as hash options:
```ruby
github = Github.new oauth_token: 'token'
```
Alternatively, you can configure the Github settings by passing a block, for instance, with custom enteprise endpoint like
```ruby
github = Github.new do |config|
config.endpoint = 'https://github.company.com/api/v3'
config.oauth_token = 'token'
config.adapter = :net_http
end
```
You can authenticate either using OAuth authentication convenience methods(see section OAuth) or through basic authentication by passing your login and password credentials
```ruby
github = Github.new login:'peter-murach', password:'...'
```
or use convenience method:
```ruby
github = Github.new basic_auth: 'login:password'
```
You can interact with GitHub interface, for example repositories, by issuing following calls that correspond directly to the GitHub API hierarchy
```ruby
github.repos.commits.all 'user-name', 'repo-name'
github.repos.hooks.create 'user-name', 'repo-name', name: "web", active: true
github.repos.keys.get 'user-name', 'repo-name'
```
The code base is modular and allows for you to work specifically with a given part of GitHub API e.g. blobs
```ruby
blobs = Github::GitData::Blobs.new
blobs.create 'peter-murach', 'github', content: 'Blob content'
```
The response is of type [Hashie::Mash] and allows to traverse all the json response attributes like method calls e.i.
```ruby
repos = Github::Repos.new :user => 'peter-murach', :repo => 'github'
repos.branches do |branch|
puts branch.name
end
```
## Inputs
Some API methods apart from required parameters such as username, repository name
or organisation name, allow you to switch the way the data is returned to you, for instance
```ruby
github = Github.new
github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea'
# => gets a tree
github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea',
recursive: true # => gets a whole tree recursively
```
by passing a block you can iterate over the file tree
```ruby
github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea',
recursive: true do |file|
puts file.path
end
```
## Advanced Configuration
The `github_api` gem will use the default middleware stack which is exposed by calling `stack` on client instance. However, this stack can be freely modified with methods such as `insert`, `insert_after`, `delete` and `swap`. For instance to add your `CustomMiddleware` do
```ruby
github = Github.new do |config|
config.stack.insert_after Github::Response::Helpers, CustomMiddleware
end
```
Furthermore, you can build your entire custom stack and specify other connection options such as `adapter`
```ruby
github = Github.new do |config|
config.adapter :excon
config.stack do |builder|
builder.use Github::Response::Helpers
builder.use Github::Response::Jsonize
end
end
```
## API
Main API methods are grouped into the following classes that can be instantiated on their own
```ruby
Github - full API access
Github::Gists Github::GitData Github::Repos Github::Search
Github::Orgs Github::Issues Github::Authorizations
Github::PullRequests Github::Users Github::Events
```
Some parts of GitHub API v3 require you to be autheticated, for instance the following are examples of APIs only for the authenticated user
```ruby
Github::Users::Emails
Github::Users::Keys
```
All method calls form ruby like sentences and allow for intuitive api navigation, for instance
```ruby
github = Github.new :oauth_token => '...'
github.users.followers.following 'wycats' # => returns users that 'wycats' is following
github.users.followers.following 'wycats' # => returns true if following, otherwise false
```
For specification on all available methods go to http://developer.github.com/v3/ or
read the rdoc, all methods are documented there with examples of usage.
Alternatively, you can find out supported methods by calling `actions` on a class instance in your `irb`:
```ruby
>> Github::Repos.actions >> github.issues.actions
--- ---
|--> all |--> all
|--> branches |--> comments
|--> collaborators |--> create
|--> commits |--> edit
|--> contribs |--> events
|--> contributors |--> find
|--> create |--> get
|--> downloads |--> labels
|--> edit |--> list
|--> find |--> list_repo
|--> forks |--> list_repository
|--> get |--> milestones
|--> hooks ...
...
```
## OAuth
In order to authenticate the user through OAuth2 on GitHub you need to
* visit https://github.com/settings/applications/new and register your app
You will need to be logged in to initially register the application.
* authorize your credentials https://github.com/login/oauth/authorize
You can use convenience methods to help you achieve this that come with this gem:
```ruby
github = Github.new :client_id => '...', :client_secret => '...'
github.authorize_url :redirect_uri => 'http://localhost', :scope => 'repo'
# => "https://github.com/login/oauth/authorize?scope=repo&response_type=code&client_id='...'&redirect_uri=http%3A%2F%2Flocalhost"
```
After you get your authorization code, call to receive your access_token
```ruby
token = github.get_token( authorization_code )
```
Once you have your access token, configure your github instance following instructions under Configuration.
### Authorizations API
Alternatively you can use OAuth Authorizations API. For instance, to create access token through GitHub API do following
```ruby
github = Github.new basic_auth: 'login:password'
github.oauth.create 'scopes' => ['repo']
```
You can add more than one scope from the `user`, `public_repo`, `repo`, `gist` or leave the scopes parameter out, in which case, the default read-only access will be assumed(includes public user profile info, public repo info, and gists).
## MIME Types
Issues, PullRequests and few other API leverage custom mime types which are :json, :blob, :raw, :text, :html, :full. By default :raw is used.
In order to pass a mime type with your request do
```ruby
github = Github.new
github.pull_requests.list 'peter-murach', 'github', :mime_type => :full
```
Your header will contain 'Accept: "application/vnd.github-pull.full+json"' which in turn returns raw, text and html representations in response body.
## Configuration
Certain methods require authentication. To get your GitHub OAuth v2 credentials,
register an app at https://github.com/settings/applications/
You will need to be logged in to register the application.
```ruby
Github.configure do |config|
config.oauth_token = YOUR_OAUTH_ACCESS_TOKEN
config.basic_auth = 'login:password'
end
or
Github.new(:oauth_token => YOUR_OAUTH_TOKEN)
Github.new(:basic_auth => 'login:password')
```
All parameters can be overwirtten as per method call. By passing parameters hash...
By default no caching will be performed. In order to set the cache do... If no cache type is provided a default memoization is done.
## Pagination
Any request that returns multiple items will be paginated to 30 items by default. You can specify custom `page` and `per_page` query parameters to alter default behavior. For instance:
```ruby
res = Github::Repos.new.repos user: 'wycats', per_page: 10, page: 5
```
Then you can query pagination information included in the link header by:
```ruby
res.links.first # Shows the URL of the first page of results.
res.links.next # Shows the URL of the immediate next page of results.
res.links.prev # Shows the URL of the immediate previous page of results.
res.links.last # Shows the URL of the last page of results.
```
In order to iterate through the entire result set page by page, you can use convenience methods:
```ruby
res.each_page do |page|
page.each do |repo|
puts repo.name
end
end
```
or use `has_next_page?` and `next_page` like in the following:
```ruby
while res.has_next_page?
... process response ...
res.next_page
end
```
One can also navigate straight to specific page by:
```ruby
res.page 5 # Requests given page if it exists, nil otherwise
res.first_page
res.prev_page
res.next_page
res.last_page
```
## Response Message
Each response comes packaged with methods allowing for inspection of HTTP start line and headers. For example to check for rate limits and status code issue
```ruby
res = Github::Repos.new.branches 'peter-murach', 'github'
res.ratelimit_limit # "5000"
res.ratelimit_remainig # "4999"
res.status # "200"
res.content_type # "application/json; charset=utf-8"
```
## Examples
Some api methods require input parameters, these are added simply as a hash properties, for instance
```ruby
issues = Github::Issues.new user:'peter-murach', repo: 'github-api'
issues.milestones.list state: 'open', sort: 'due_date', direction: 'asc'
```
Other methods may require inputs as an array of strings
```ruby
users = Github::Users.new oauth_token: 'token'
users.emails.add 'email1', 'email2', ..., 'emailn' # => Adds emails to the authenticated user
```
If a method returns a collection, you can iterator over it by supplying a block parameter,
```ruby
events = Github::Events.new
events.public do |event|
puts event.actor.login
end
```
Query requests instead of http responses return boolean values
```ruby
github = Github.new
github.orgs.members.public_member? 'github', 'technoweenie' # => true
```
## Rails Example
A Rails controller that allows a user to authorize their GitHub account and then perform request.
```ruby
class GithubController < ApplicationController
def authorize
github = Github.new :client_id => '...', :client_secret => '...'
address = github.authorize_url :redirect_uri => 'http://...', :scope => 'repo'
redirect_to address
end
def callback
authorization_code = params[:code]
token = github.get_token authorization_code
access_token = token.token
end
end
```
## Testing
The test suite is split into two groups `live` and `mock`.
The `live` tests are the ones in `features` folder and they simply exercise the GitHub API by making live requests and then being cached with VCR in directory named `features\cassettes`. For details on how to get setup please navigate to `features` folder.
The `mock` tests are in `spec` directory and their primary concern is to test the gem internals without the hindrance of external calls.
## Development
Questions or problems? Please post them on the [issue tracker](https://github.com/peter-murach/github/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.
## Copyright
Copyright (c) 2011-2012 Piotr Murach. See LICENSE.txt for further details.